Herzog Library 00.00.01  rel_libdev.herzog.00.00.01.10606
Data Structures | Typedefs | Functions
led_device.h File Reference
#include <stdint.h>
#include "hdf.h"

Go to the source code of this file.

Data Structures

struct  LED_Device_t
 A structure to represent LED device. More...
 

Typedefs

typedef const struct LED_Device_t LED_Device_t
 A structure to represent LED device. More...
 

Functions

int32_t LED_devInit (LED_Device_t *dev, uint8_t pos)
 Init LED mode for a pin. More...
 
int32_t LED_devDeInit (LED_Device_t *dev, uint8_t pos)
 DeInit LED mode for a pin. More...
 
int32_t LED_devOn (LED_Device_t *dev, uint8_t pos)
 Turn On a LED. More...
 
int32_t LED_devOff (LED_Device_t *dev, uint8_t pos)
 Turn off LED. More...
 
int32_t LED_devSetLightLevel (LED_Device_t *dev, uint8_t pos, uint8_t level)
 Set LED light level. More...
 
LED_Device_tLED_devRequest (const char *name)
 Request a LED 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 LED_Device_t LED_Device_t

A structure to represent LED device.

Function Documentation

int32_t LED_devDeInit ( LED_Device_t dev,
uint8_t  pos 
)

DeInit LED mode for a pin.

Parameters
devThe pointer to LED_Device
posThe pin position on LED port
Returns
0 for success or error code upon a failure
int32_t LED_devInit ( LED_Device_t dev,
uint8_t  pos 
)

Init LED mode for a pin.

Parameters
devThe pointer to LED_Device
posThe pin position on LED port
Returns
0 for success or error code upon a failure
int32_t LED_devOff ( LED_Device_t dev,
uint8_t  pos 
)

Turn off LED.

Parameters
devThe pointer to LED_Device
posThe pin position on LED port
Returns
0 fo success or error code upon a failure
int32_t LED_devOn ( LED_Device_t dev,
uint8_t  pos 
)

Turn On a LED.

Parameters
devThe pointer to LED_Device
posThe pin position on LED port
Returns
0 for success or error code upon a failure
LED_Device_t* LED_devRequest ( const char *  name)

Request a LED Device.

Parameters
nameThe name string of LED device.
Returns
The pointer to the LED device instance.
int32_t LED_devSetLightLevel ( LED_Device_t dev,
uint8_t  pos,
uint8_t  level 
)

Set LED light level.

Parameters
devThe pointer to LED_Device
posThe pin position on LED port
levelThe light level
Returns
0 fo success or error code upon a failure