Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
usbc_vbus.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 The Chromium OS Authors
3 * SPDX-License-Identifier: Apache-2.0
4 */
5
15
16#ifndef ZEPHYR_INCLUDE_DRIVERS_USB_C_USBC_VBUS_H_
17#define ZEPHYR_INCLUDE_DRIVERS_USB_C_USBC_VBUS_H_
18
27
28#include <zephyr/types.h>
29#include <zephyr/device.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
41
45__subsystem struct usbc_vbus_driver_api {
47 bool (*check_level)(const struct device *dev, enum tc_vbus_level level);
49 int (*measure)(const struct device *dev, int *vbus_meas);
51 int (*discharge)(const struct device *dev, bool enable);
53 int (*enable)(const struct device *dev, bool enable);
54};
55
57
67static inline bool usbc_vbus_check_level(const struct device *dev, enum tc_vbus_level level)
68{
69 return DEVICE_API_GET(usbc_vbus, dev)->check_level(dev, level);
70}
71
81static inline int usbc_vbus_measure(const struct device *dev, int *meas)
82{
83 return DEVICE_API_GET(usbc_vbus, dev)->measure(dev, meas);
84}
85
96static inline int usbc_vbus_discharge(const struct device *dev, bool enable)
97{
98 return DEVICE_API_GET(usbc_vbus, dev)->discharge(dev, enable);
99}
100
111static inline int usbc_vbus_enable(const struct device *dev, bool enable)
112{
113 return DEVICE_API_GET(usbc_vbus, dev)->enable(dev, enable);
114}
115
119
120#ifdef __cplusplus
121}
122#endif
123
124#endif /* ZEPHYR_INCLUDE_DRIVERS_USB_C_USBC_VBUS_H_ */
#define DEVICE_API_GET(_class, _dev)
Expands to the pointer of a device's API for a given class.
Definition device.h:1449
tc_vbus_level
VBUS level voltages.
Definition usbc_tc.h:343
static int usbc_vbus_measure(const struct device *dev, int *meas)
Reads and returns VBUS measured in mV.
Definition usbc_vbus.h:81
static bool usbc_vbus_check_level(const struct device *dev, enum tc_vbus_level level)
Checks if VBUS is at a particular level.
Definition usbc_vbus.h:67
static int usbc_vbus_enable(const struct device *dev, bool enable)
Controls a pin that enables VBUS measurements.
Definition usbc_vbus.h:111
static int usbc_vbus_discharge(const struct device *dev, bool enable)
Controls a pin that discharges VBUS.
Definition usbc_vbus.h:96
#define bool
Definition stdbool.h:13
Runtime device structure (in ROM) per driver instance.
Definition device.h:513
@def_driverbackendgroup{USB-C VBUS,usbc_vbus_api}
Definition usbc_vbus.h:45
int(* discharge)(const struct device *dev, bool enable)
@driver_ops_mandatory Controls a pin that discharges VBUS.
Definition usbc_vbus.h:51
int(* measure)(const struct device *dev, int *vbus_meas)
@driver_ops_mandatory Reads and returns VBUS measured in mV.
Definition usbc_vbus.h:49
int(* enable)(const struct device *dev, bool enable)
@driver_ops_mandatory Controls a pin that enables VBUS measurements.
Definition usbc_vbus.h:53
bool(* check_level)(const struct device *dev, enum tc_vbus_level level)
@driver_ops_mandatory Checks if VBUS is at a particular level.
Definition usbc_vbus.h:47
USB Type-C Cable and Connector API used for USB-C drivers.