Driver Operations Regulator driver operations More...

#include <zephyr/drivers/regulator.h>

Data Fields
regulator_enable_t	enable
	OPT Enable a regulator.
regulator_disable_t	disable
	OPT Disable a regulator.
regulator_count_voltages_t	count_voltages
	OPT Obtain the number of supported voltage levels.
regulator_list_voltage_t	list_voltage
	OPT Obtain the value of a voltage given an index.
regulator_set_voltage_t	set_voltage
	OPT Set the output voltage.
regulator_get_voltage_t	get_voltage
	OPT Obtain output voltage.
regulator_count_current_limits_t	count_current_limits
	OPT Obtain the number of supported current limit levels.
regulator_list_current_limit_t	list_current_limit
	OPT Obtain the value of a current limit given an index.
regulator_set_current_limit_t	set_current_limit
	OPT Set output current limit.
regulator_get_current_limit_t	get_current_limit
	OPT Get output current limit.
regulator_set_mode_t	set_mode
	OPT Set mode.
regulator_get_mode_t	get_mode
	OPT Get mode.
regulator_set_active_discharge_t	set_active_discharge
	OPT Set active discharge setting.
regulator_get_active_discharge_t	get_active_discharge
	OPT Get active discharge setting.
regulator_get_error_flags_t	get_error_flags
	OPT Get active error flags.
regulator_set_callback_t	set_callback
	OPT Set event handler function.

Detailed Description

Driver Operations Regulator driver operations

This is the driver API structure any Regulator driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ count_current_limits

regulator_count_current_limits_t regulator_driver_api::count_current_limits

OPT Obtain the number of supported current limit levels.

◆ count_voltages

regulator_count_voltages_t regulator_driver_api::count_voltages

OPT Obtain the number of supported voltage levels.

◆ disable

regulator_disable_t regulator_driver_api::disable

OPT Disable a regulator.

◆ enable

regulator_enable_t regulator_driver_api::enable

OPT Enable a regulator.

◆ get_active_discharge

regulator_get_active_discharge_t regulator_driver_api::get_active_discharge

OPT Get active discharge setting.

◆ get_current_limit

regulator_get_current_limit_t regulator_driver_api::get_current_limit

OPT Get output current limit.

◆ get_error_flags

regulator_get_error_flags_t regulator_driver_api::get_error_flags

OPT Get active error flags.

◆ get_mode

regulator_get_mode_t regulator_driver_api::get_mode

OPT Get mode.

◆ get_voltage

regulator_get_voltage_t regulator_driver_api::get_voltage

OPT Obtain output voltage.

◆ list_current_limit

regulator_list_current_limit_t regulator_driver_api::list_current_limit

OPT Obtain the value of a current limit given an index.

◆ list_voltage

regulator_list_voltage_t regulator_driver_api::list_voltage

OPT Obtain the value of a voltage given an index.

◆ set_active_discharge

regulator_set_active_discharge_t regulator_driver_api::set_active_discharge

OPT Set active discharge setting.

◆ set_callback

regulator_set_callback_t regulator_driver_api::set_callback

OPT Set event handler function.

◆ set_current_limit

regulator_set_current_limit_t regulator_driver_api::set_current_limit

OPT Set output current limit.

◆ set_mode

regulator_set_mode_t regulator_driver_api::set_mode

OPT Set mode.

◆ set_voltage

regulator_set_voltage_t regulator_driver_api::set_voltage

OPT Set the output voltage.

The documentation for this struct was generated from the following file:

zephyr/drivers/regulator.h

Data Fields