regulator.h File Reference

This header file defines the Regulator API. More...

#include <stdlib.h>
#include <rtems.h>

Go to the source code of this file.

Data Structures
struct	rtems_regulator_attributes
	Attributes for Regulator Instance. More...
struct	rtems_regulator_statistics
	Statistics for Regulator Instance. More...

Typedefs
typedef bool(*	rtems_regulator_deliverer) (void *context, void *message, size_t length)
	Regulator Delivery Function Type.
typedef struct _Regulator_Control *	rtems_regulator_instance
	Regulator Instance.

Functions
rtems_status_code	rtems_regulator_create (rtems_regulator_attributes *attributes, rtems_regulator_instance **regulator)
	Create a regulator.
rtems_status_code	rtems_regulator_delete (rtems_regulator_instance *regulator, rtems_interval ticks)
	Delete a regulator.
rtems_status_code	rtems_regulator_obtain_buffer (rtems_regulator_instance *regulator, void **buffer)
	Obtain Buffer from Regulator.
rtems_status_code	rtems_regulator_release_buffer (rtems_regulator_instance *regulator, void *buffer)
	Release Previously Obtained Regulator Buffer.
rtems_status_code	rtems_regulator_send (rtems_regulator_instance *regulator, void *message, size_t length)
	Send to regulator instance.
rtems_status_code	rtems_regulator_get_statistics (rtems_regulator_instance *regulator, rtems_regulator_statistics *statistics)
	Obtain statistics for regulator instance.

Detailed Description

This header file defines the Regulator API.