Regulator Driver Backend API

Data Structures
struct	regulator_parent_driver_api
	Driver Operations Regulator Parent driver operations More...
struct	regulator_driver_api
	Driver Operations Regulator driver operations More...

Typedefs
typedef int(*	regulator_dvs_state_set_t) (const struct device *dev, regulator_dvs_state_t state)
	Set a DVS state.
typedef int(*	regulator_ship_mode_t) (const struct device *dev)
	Enter ship mode.
typedef int(*	regulator_enable_t) (const struct device *dev)
	Enable a regulator.
typedef int(*	regulator_disable_t) (const struct device *dev)
	Disable a regulator.
typedef unsigned int(*	regulator_count_voltages_t) (const struct device *dev)
	Obtain the number of supported voltage levels.
typedef int(*	regulator_list_voltage_t) (const struct device *dev, unsigned int idx, int32_t *volt_uv)
	Obtain the value of a voltage given an index.
typedef int(*	regulator_set_voltage_t) (const struct device *dev, int32_t min_uv, int32_t max_uv)
	Set the output voltage.
typedef int(*	regulator_get_voltage_t) (const struct device *dev, int32_t *volt_uv)
	Obtain output voltage.
typedef unsigned int(*	regulator_count_current_limits_t) (const struct device *dev)
	Obtain the number of supported current limit levels.
typedef int(*	regulator_list_current_limit_t) (const struct device *dev, unsigned int idx, int32_t *current_ua)
	Obtain the value of a current limit given an index.
typedef int(*	regulator_set_current_limit_t) (const struct device *dev, int32_t min_ua, int32_t max_ua)
	Set output current limit.
typedef int(*	regulator_get_current_limit_t) (const struct device *dev, int32_t *curr_ua)
	Get output current limit.
typedef int(*	regulator_set_mode_t) (const struct device *dev, regulator_mode_t mode)
	Set mode.
typedef int(*	regulator_get_mode_t) (const struct device *dev, regulator_mode_t *mode)
	Get mode.
typedef int(*	regulator_set_active_discharge_t) (const struct device *dev, bool active_discharge)
	Set active discharge setting.
typedef int(*	regulator_get_active_discharge_t) (const struct device *dev, bool *active_discharge)
	Get active discharge setting.
typedef int(*	regulator_get_error_flags_t) (const struct device *dev, regulator_error_flags_t *flags)
	Get active error flags.
typedef int(*	regulator_set_callback_t) (const struct device *dev, regulator_callback_t cb, const void *const user_data)
	Set event handler function.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Regulator driver.

Typedef Documentation

regulator_count_current_limits_t

typedef unsigned int(* regulator_count_current_limits_t) (const struct device *dev)

#include <zephyr/drivers/regulator.h>

Obtain the number of supported current limit levels.

See regulator_count_current_limits() for argument description.

regulator_count_voltages_t

typedef unsigned int(* regulator_count_voltages_t) (const struct device *dev)

#include <zephyr/drivers/regulator.h>

Obtain the number of supported voltage levels.

See regulator_count_voltages() for argument description.

regulator_disable_t

typedef int(* regulator_disable_t) (const struct device *dev)

#include <zephyr/drivers/regulator.h>

Disable a regulator.

See regulator_disable() for argument description.

regulator_dvs_state_set_t

typedef int(* regulator_dvs_state_set_t) (const struct device *dev, regulator_dvs_state_t state)

#include <zephyr/drivers/regulator.h>

Set a DVS state.

See regulator_parent_dvs_state_set() for argument description.

regulator_enable_t

typedef int(* regulator_enable_t) (const struct device *dev)

#include <zephyr/drivers/regulator.h>

Enable a regulator.

See regulator_enable() for argument description.

regulator_get_active_discharge_t

typedef int(* regulator_get_active_discharge_t) (const struct device *dev, bool *active_discharge)

#include <zephyr/drivers/regulator.h>

Get active discharge setting.

See regulator_get_active_discharge() for argument description.

regulator_get_current_limit_t

typedef int(* regulator_get_current_limit_t) (const struct device *dev, int32_t *curr_ua)

#include <zephyr/drivers/regulator.h>

Get output current limit.

See regulator_get_current_limit() for argument description.

regulator_get_error_flags_t

typedef int(* regulator_get_error_flags_t) (const struct device *dev, regulator_error_flags_t *flags)

#include <zephyr/drivers/regulator.h>

Get active error flags.

See regulator_get_error_flags() for argument description.

regulator_get_mode_t

typedef int(* regulator_get_mode_t) (const struct device *dev, regulator_mode_t *mode)

#include <zephyr/drivers/regulator.h>

Get mode.

See regulator_get_mode() for argument description.

regulator_get_voltage_t

typedef int(* regulator_get_voltage_t) (const struct device *dev, int32_t *volt_uv)

#include <zephyr/drivers/regulator.h>

Obtain output voltage.

See regulator_get_voltage() for argument description.

regulator_list_current_limit_t

typedef int(* regulator_list_current_limit_t) (const struct device *dev, unsigned int idx, int32_t *current_ua)

#include <zephyr/drivers/regulator.h>

Obtain the value of a current limit given an index.

See regulator_list_current_limit() for argument description.

regulator_list_voltage_t

typedef int(* regulator_list_voltage_t) (const struct device *dev, unsigned int idx, int32_t *volt_uv)

#include <zephyr/drivers/regulator.h>

Obtain the value of a voltage given an index.

See regulator_list_voltage() for argument description.

regulator_set_active_discharge_t

typedef int(* regulator_set_active_discharge_t) (const struct device *dev, bool active_discharge)

#include <zephyr/drivers/regulator.h>

Set active discharge setting.

See regulator_set_active_discharge() for argument description.

regulator_set_callback_t

typedef int(* regulator_set_callback_t) (const struct device *dev, regulator_callback_t cb, const void *const user_data)

#include <zephyr/drivers/regulator.h>

Set event handler function.

See regulator_set_callback() for argument description.

regulator_set_current_limit_t

typedef int(* regulator_set_current_limit_t) (const struct device *dev, int32_t min_ua, int32_t max_ua)

#include <zephyr/drivers/regulator.h>

Set output current limit.

See regulator_set_current_limit() for argument description.

regulator_set_mode_t

typedef int(* regulator_set_mode_t) (const struct device *dev, regulator_mode_t mode)

#include <zephyr/drivers/regulator.h>

Set mode.

See regulator_set_mode() for argument description.

regulator_set_voltage_t

typedef int(* regulator_set_voltage_t) (const struct device *dev, int32_t min_uv, int32_t max_uv)

#include <zephyr/drivers/regulator.h>

Set the output voltage.

See regulator_set_voltage() for argument description.

regulator_ship_mode_t

typedef int(* regulator_ship_mode_t) (const struct device *dev)

#include <zephyr/drivers/regulator.h>

Enter ship mode.

See regulator_parent_ship_mode() for argument description.