Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
usbc_ppc.h
Go to the documentation of this file.
1/*
2 * Copyright 2023 Google LLC
3 * SPDX-License-Identifier: Apache-2.0
4 */
5
12#ifndef ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_
13#define ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_
14
22#include <zephyr/types.h>
23#include <zephyr/device.h>
24#include <errno.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
56
57typedef void (*usbc_ppc_event_cb_t)(const struct device *dev, void *data, enum usbc_ppc_event ev);
58
60__subsystem struct usbc_ppc_driver_api {
61 int (*is_dead_battery_mode)(const struct device *dev);
62 int (*exit_dead_battery_mode)(const struct device *dev);
63 int (*is_vbus_source)(const struct device *dev);
64 int (*is_vbus_sink)(const struct device *dev);
65 int (*set_snk_ctrl)(const struct device *dev, bool enable);
66 int (*set_src_ctrl)(const struct device *dev, bool enable);
67 int (*set_vbus_discharge)(const struct device *dev, bool enable);
68 int (*is_vbus_present)(const struct device *dev);
69 int (*set_event_handler)(const struct device *dev, usbc_ppc_event_cb_t handler, void *data);
70 int (*dump_regs)(const struct device *dev);
71};
72
73/*
74 * API functions
75 */
76
86static inline int ppc_is_dead_battery_mode(const struct device *dev)
87{
88 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
89
90 if (api->is_dead_battery_mode == NULL) {
91 return -ENOSYS;
92 }
93
94 return api->is_dead_battery_mode(dev);
95}
96
109static inline int ppc_exit_dead_battery_mode(const struct device *dev)
110{
111 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
112
113 if (api->exit_dead_battery_mode == NULL) {
114 return -ENOSYS;
115 }
116
117 return api->exit_dead_battery_mode(dev);
118}
119
129static inline int ppc_is_vbus_source(const struct device *dev)
130{
131 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
132
133 if (api->is_vbus_source == NULL) {
134 return -ENOSYS;
135 }
136
137 return api->is_vbus_source(dev);
138}
139
149static inline int ppc_is_vbus_sink(const struct device *dev)
150{
151 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
152
153 if (api->is_vbus_sink == NULL) {
154 return -ENOSYS;
155 }
156
157 return api->is_vbus_sink(dev);
158}
159
169static inline int ppc_set_snk_ctrl(const struct device *dev, bool enable)
170{
171 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
172
173 if (api->set_snk_ctrl == NULL) {
174 return -ENOSYS;
175 }
176
177 return api->set_snk_ctrl(dev, enable);
178}
179
189static inline int ppc_set_src_ctrl(const struct device *dev, bool enable)
190{
191 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
192
193 if (api->set_src_ctrl == NULL) {
194 return -ENOSYS;
195 }
196
197 return api->set_src_ctrl(dev, enable);
198}
199
209static inline int ppc_set_vbus_discharge(const struct device *dev, bool enable)
210{
211 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
212
213 if (api->set_vbus_discharge == NULL) {
214 return -ENOSYS;
215 }
216
217 return api->set_vbus_discharge(dev, enable);
218}
219
229static inline int ppc_is_vbus_present(const struct device *dev)
230{
231 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
232
233 if (api->is_vbus_present == NULL) {
234 return -ENOSYS;
235 }
236
237 return api->is_vbus_present(dev);
238}
239
249static inline int ppc_set_event_handler(const struct device *dev,
250 usbc_ppc_event_cb_t handler, void *data)
251{
252 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
253
254 if (api->set_event_handler == NULL) {
255 return -ENOSYS;
256 }
257
258 return api->set_event_handler(dev, handler, data);
259}
260
269static inline int ppc_dump_regs(const struct device *dev)
270{
271 const struct usbc_ppc_driver_api *api = (const struct usbc_ppc_driver_api *)dev->api;
272
273 if (api->dump_regs == NULL) {
274 return -ENOSYS;
275 }
276
277 return api->dump_regs(dev);
278}
279
280#ifdef __cplusplus
281}
282#endif
283
288#endif /* ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_ */
System error numbers.
#define ENOSYS
Function not implemented.
Definition errno.h:82
static int ppc_set_event_handler(const struct device *dev, usbc_ppc_event_cb_t handler, void *data)
Set the callback used to notify about PPC events.
Definition usbc_ppc.h:249
usbc_ppc_event
Type of event being notified by Power Path Controller.
Definition usbc_ppc.h:31
static int ppc_is_dead_battery_mode(const struct device *dev)
Check if PPC is in the dead battery mode.
Definition usbc_ppc.h:86
void(* usbc_ppc_event_cb_t)(const struct device *dev, void *data, enum usbc_ppc_event ev)
Definition usbc_ppc.h:57
static int ppc_is_vbus_source(const struct device *dev)
Check if the PPC is sourcing the VBUS.
Definition usbc_ppc.h:129
static int ppc_exit_dead_battery_mode(const struct device *dev)
Request the PPC to exit from the dead battery mode Return from this call doesn't mean that the PPC is...
Definition usbc_ppc.h:109
static int ppc_is_vbus_present(const struct device *dev)
Check if VBUS is present.
Definition usbc_ppc.h:229
static int ppc_set_src_ctrl(const struct device *dev, bool enable)
Set the state of VBUS sourcing.
Definition usbc_ppc.h:189
static int ppc_set_snk_ctrl(const struct device *dev, bool enable)
Set the state of VBUS sinking.
Definition usbc_ppc.h:169
static int ppc_set_vbus_discharge(const struct device *dev, bool enable)
Set the state of VBUS discharging.
Definition usbc_ppc.h:209
static int ppc_dump_regs(const struct device *dev)
Print the values or PPC registers.
Definition usbc_ppc.h:269
static int ppc_is_vbus_sink(const struct device *dev)
Check if the PPC is sinking the VBUS.
Definition usbc_ppc.h:149
@ USBC_PPC_EVENT_SRC_REVERSE_CURRENT
Reverse current detected while being in a source role.
Definition usbc_ppc.h:38
@ USBC_PPC_EVENT_SRC_OVERCURRENT
Overcurrent detected while being in a source role.
Definition usbc_ppc.h:40
@ USBC_PPC_EVENT_SRC_OVERVOLTAGE
Overvoltage detected while being in a source role.
Definition usbc_ppc.h:36
@ USBC_PPC_EVENT_SNK_REVERSE_CURRENT
Reverse current detected while being in a sink role.
Definition usbc_ppc.h:50
@ USBC_PPC_EVENT_SNK_OVERVOLTAGE
Overvoltage detected while being in a sink role.
Definition usbc_ppc.h:54
@ USBC_PPC_EVENT_DEAD_BATTERY_ERROR
Exit from dead-battery mode failed.
Definition usbc_ppc.h:33
@ USBC_PPC_EVENT_SNK_SHORT
VBUS short detected while being in a sink role.
Definition usbc_ppc.h:52
@ USBC_PPC_EVENT_BOTH_SNKSRC_ENABLED
Sink and source paths enabled simultaneously.
Definition usbc_ppc.h:47
@ USBC_PPC_EVENT_OVER_TEMPERATURE
Chip over temperature detected
Definition usbc_ppc.h:45
@ USBC_PPC_EVENT_SRC_SHORT
VBUS short detected while being in a source role.
Definition usbc_ppc.h:42
#define NULL
Definition iar_missing_defs.h:20
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
void * data
Address of the device instance private data.
Definition device.h:520
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
Structure with pointers to the functions implemented by driver.
Definition usbc_ppc.h:60
int(* set_vbus_discharge)(const struct device *dev, bool enable)
Definition usbc_ppc.h:67
int(* set_src_ctrl)(const struct device *dev, bool enable)
Definition usbc_ppc.h:66
int(* exit_dead_battery_mode)(const struct device *dev)
Definition usbc_ppc.h:62
int(* is_dead_battery_mode)(const struct device *dev)
Definition usbc_ppc.h:61
int(* is_vbus_present)(const struct device *dev)
Definition usbc_ppc.h:68
int(* set_event_handler)(const struct device *dev, usbc_ppc_event_cb_t handler, void *data)
Definition usbc_ppc.h:69
int(* is_vbus_sink)(const struct device *dev)
Definition usbc_ppc.h:64
int(* is_vbus_source)(const struct device *dev)
Definition usbc_ppc.h:63
int(* dump_regs)(const struct device *dev)
Definition usbc_ppc.h:70
int(* set_snk_ctrl)(const struct device *dev, bool enable)
Definition usbc_ppc.h:65