iot_pwm.h File Reference

This file contains all the PWM HAL API definitions. More...

Go to the source code of this file.

Data Structures
struct	IotPwmConfig_t
	PWM configuration type. More...

Macros
#define	IOT_PWM_SUCCESS   ( 0 )
	Return values used by PWM driver.
#define	IOT_PWM_INVALID_VALUE   ( 1 )
#define	IOT_PWM_NOT_CONFIGURED   ( 2 )
#define	IOT_PWM_FUNCTION_NOT_SUPPORTED   ( 3 )

Typedefs
typedef struct IotPwmDescriptor *	IotPwmHandle_t
	IotPwmHandle_t type is the PWM handle returned by calling iot_pwm_open() this is initialized in open and returned to caller. Caller must pass this pointer to the rest of the APIs.

Functions
IotPwmHandle_t	iot_pwm_open (int32_t lPwmInstance)
	iot_pwm_open is used to initialize the PWM driver instance. this API will configure PWM and may reset the PWM hardware.
int32_t	iot_pwm_set_config (IotPwmHandle_t const pxPwmHandle, const IotPwmConfig_t xConfig)
	iot_pwm_set_config sets up the PWM frequency and duty cycle to generate the PWM pulses required.
IotPwmConfig_t *	iot_pwm_get_config (IotPwmHandle_t const pxPwmHandle)
	iot_pwm_get_config returns the current PWM configuration
int32_t	iot_pwm_start (IotPwmHandle_t const pxPwmHandle)
	Start the PWM hardware. PWM configuration must be set before PWM is started. PWM signal availability on the configured output based on the PWMChannel configured in iot_pwm_set_config().
int32_t	iot_pwm_stop (IotPwmHandle_t const pxPwmHandle)
	Stop the PWM hardware.
int32_t	iot_pwm_close (IotPwmHandle_t const pxPwmHandle)
	iot_pwm_close de-initializes the PWM.

Detailed Description

This file contains all the PWM HAL API definitions.