USB-C VBUS API

USB-C VBUS API. More...

Data Structures
struct	usbc_vbus_driver_api

Functions
static bool	usbc_vbus_check_level (const struct device *dev, enum tc_vbus_level level)
	Checks if VBUS is at a particular level.
static int	usbc_vbus_measure (const struct device *dev, int *meas)
	Reads and returns VBUS measured in mV.
static int	usbc_vbus_discharge (const struct device *dev, bool enable)
	Controls a pin that discharges VBUS.
static int	usbc_vbus_enable (const struct device *dev, bool enable)
	Controls a pin that enables VBUS measurements.

Detailed Description

USB-C VBUS API.

Since

3.3

Version

0.1.0

Function Documentation

usbc_vbus_check_level()

bool usbc_vbus_check_level ( const struct device * dev, enum tc_vbus_level level )

inlinestatic

#include <zephyr/drivers/usb_c/usbc_vbus.h>

Checks if VBUS is at a particular level.

Parameters

dev	Runtime device structure
level	The level voltage to check against

Return values

true	if VBUS is at the level voltage
false	if VBUS is not at that level voltage

usbc_vbus_discharge()

int usbc_vbus_discharge ( const struct device * dev, bool enable )

inlinestatic

#include <zephyr/drivers/usb_c/usbc_vbus.h>

Controls a pin that discharges VBUS.

Parameters

dev	Runtime device structure
enable	Discharge VBUS when true

Return values

0	on success
-EIO	on failure
-ENOENT	if discharge pin isn't defined

usbc_vbus_enable()

int usbc_vbus_enable ( const struct device * dev, bool enable )

inlinestatic

#include <zephyr/drivers/usb_c/usbc_vbus.h>

Controls a pin that enables VBUS measurements.

Parameters

dev	Runtime device structure
enable	enable VBUS measurements when true

Return values

0	on success
-EIO	on failure
-ENOENT	if enable pin isn't defined

usbc_vbus_measure()

int usbc_vbus_measure ( const struct device * dev, int * meas )

inlinestatic

#include <zephyr/drivers/usb_c/usbc_vbus.h>

Reads and returns VBUS measured in mV.

Parameters

dev	Runtime device structure
meas	pointer where the measured VBUS voltage is stored

Return values

0	on success
-EIO	on failure