Kamcho Library 02.00.03  lib.kamcho.02.00.03.287
Data Structures | Typedefs | Functions
pwm_device.h File Reference
#include <stdint.h>
#include "hdf.h"

Go to the source code of this file.

Data Structures

struct  PWM_Device_t
 A structure to represent a PWM device. More...
 

Typedefs

typedef const struct PWM_Device_t PWM_Device_t
 A structure to represent a PWM device. More...
 

Functions

int32_t PWM_devSetPeriod (PWM_Device_t *dev, uint32_t period)
 Set period of a PWM driver. More...
 
int32_t PWM_devSetWidth (PWM_Device_t *dev, uint32_t width)
 Set width of a PWM driver. More...
 
int32_t PWM_devSetClockDivider (PWM_Device_t *dev, uint8_t div)
 Set pre-scaler of a PWM driver. More...
 
int32_t PWM_devInvertEnable (PWM_Device_t *dev)
 Enable PWM inverter. More...
 
int32_t PWM_devInvertDisable (PWM_Device_t *dev)
 Disable PWM inverter. More...
 
int32_t PWM_devEnable (PWM_Device_t *dev)
 Enable PWM driver. More...
 
int32_t PWM_devDisable (PWM_Device_t *dev)
 Disable PWM driver. More...
 
PWM_Device_tPWM_devRequest (const char *name)
 Request a PWM Device. More...
 

Detailed Description

This file is proprietary to Indie Semiconductor. All rights reserved. Reproduction or distribution, in whole or in part, is forbidden except by express written permission of Indie Semiconductor.

Typedef Documentation

typedef const struct PWM_Device_t PWM_Device_t

A structure to represent a PWM device.

Function Documentation

int32_t PWM_devDisable ( PWM_Device_t dev)

Disable PWM driver.

Parameters
devThe pointer to PWM_Device structure.
Returns
0 for success or error code upon a failure.
int32_t PWM_devEnable ( PWM_Device_t dev)

Enable PWM driver.

Parameters
devThe pointer to PWM_Device structure.
Returns
0 for success or error code upon a failure.
int32_t PWM_devInvertDisable ( PWM_Device_t dev)

Disable PWM inverter.

Parameters
devThe pointer to PWM_Device structure.
Returns
0 for success or error code upon a failure.
int32_t PWM_devInvertEnable ( PWM_Device_t dev)

Enable PWM inverter.

Parameters
devThe pointer to PWM_Device structure.
Returns
0 for success or error code upon a failure.
PWM_Device_t* PWM_devRequest ( const char *  name)

Request a PWM Device.

Parameters
nameThe name string of PWM device.
Returns
The pointer to the PWM device instance.
int32_t PWM_devSetClockDivider ( PWM_Device_t dev,
uint8_t  div 
)

Set pre-scaler of a PWM driver.

Parameters
devThe pointer to PWM_Device structure.
divthe setting for clock divider.
Returns
0 for success or error code upon a failure.
int32_t PWM_devSetPeriod ( PWM_Device_t dev,
uint32_t  period 
)

Set period of a PWM driver.

Parameters
devThe pointer to PWM_Device structure.
periodpercentage of PWM period
Returns
0 for success or error code upon a failure.
int32_t PWM_devSetWidth ( PWM_Device_t dev,
uint32_t  width 
)

Set width of a PWM driver.

Parameters
devThe pointer to PWM_Device structure.
widthpercentage of PWM width
Returns
0 for success or error code upon a failure.