/home/travis/build/lis-epfl/MAVRIC_Library/hal/avr32/led.h File Reference

AT32UC3C UC3C_EK board LEDs support package. More...

#include <stdint.h>
#include <stdbool.h>

Include dependency graph for led.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
Identifiers of LEDs to Use with LED Functions
#define	LED0   0x01
#define	LED1   0x02
#define	LED2   0x04
#define	LED3   0x08
Functions
uint32_t	LED_Read_Display (void)
	Gets the last state of all LEDs set through the LED API.
void	LED_Display (uint32_t leds)
	Sets the state of all LEDs.
uint32_t	LED_Read_Display_Mask (uint32_t mask)
	Gets the last state of the specified LEDs set through the LED API.
void	LED_Display_Mask (uint32_t mask, uint32_t leds)
	Sets the state of the specified LEDs.
bool	LED_Test (uint32_t leds)
	Tests the last state of the specified LEDs set through the LED API.
void	LED_Off (uint32_t leds)
	Turns off the specified LEDs.
void	LED_On (uint32_t leds)
	Turns on the specified LEDs.
void	LED_Toggle (uint32_t leds)
	Toggles the specified LEDs.
uint32_t	LED_Read_Display_Field (uint32_t field)
	Gets as a bit-field the last state of the specified LEDs set through the LED API.
void	LED_Display_Field (uint32_t field, uint32_t leds)
	Sets as a bit-field the state of the specified LEDs.
uint8_t	LED_Get_Intensity (uint32_t led)
	Gets the intensity of the specified LED.
void	LED_Set_Intensity (uint32_t leds, uint8_t intensity)
	Sets the intensity of the specified LEDs.

---

Detailed Description

AT32UC3C UC3C_EK board LEDs support package.

This file contains definitions and services related to the LED features of the UC3C-EK board.

• Compiler: IAR EWAVR32 and GNU GCC for AVR32
• Supported devices: All AVR32 AT32UC3A devices can be used.
• AppNote:

Author:

Atmel Corporation: http://www.atmel.com
Support and FAQ: http://support.atmel.no/

---

Function Documentation

void LED_Display

(

uint32_t

leds

)

Sets the state of all LEDs.

Parameters:

leds	New state of all LEDs (1 bit per LED).

Note:

The pins of all LEDs are set to GPIO output mode.

void LED_Display_Field	(	uint32_t	field,
		uint32_t	leds
	)

Sets as a bit-field the state of the specified LEDs.

Parameters:

field	LEDs of which to set the state (1 bit per LED).
leds	New state of the specified LEDs (1 bit per LED, beginning with the first specified LED).

Note:

The pins of the specified LEDs are set to GPIO output mode.

Here is the call graph for this function:

void LED_Display_Mask	(	uint32_t	mask,
		uint32_t	leds
	)

Sets the state of the specified LEDs.

Parameters:

mask	LEDs of which to set the state (1 bit per LED).
leds	New state of the specified LEDs (1 bit per LED).

Note:

The pins of the specified LEDs are set to GPIO output mode.

Here is the caller graph for this function:

uint8_t LED_Get_Intensity

(

uint32_t

led

)

Gets the intensity of the specified LED.

Parameters:

led	LED of which to get the intensity (1 bit per LED; only the least significant set bit is used).

Returns:

Intensity of the specified LED (0x00 to 0xFF).

Warning:

The PWM channel of the specified LED is supposed to be used only by this module.

Note:

The GPIO pin configuration of all LEDs is left unchanged.

void LED_Off

(

uint32_t

leds

)

Turns off the specified LEDs.

Parameters:

leds	LEDs to turn off (1 bit per LED).

Note:

The pins of the specified LEDs are set to GPIO output mode.

Here is the caller graph for this function:

void LED_On

(

uint32_t

leds

)

Turns on the specified LEDs.

Parameters:

leds	LEDs to turn on (1 bit per LED).

Note:

The pins of the specified LEDs are set to GPIO output mode.

Here is the caller graph for this function:

uint32_t LED_Read_Display

(

void

)

Gets the last state of all LEDs set through the LED API.

Returns:

State of all LEDs (1 bit per LED).

Note:

The GPIO pin configuration of all LEDs is left unchanged.

uint32_t LED_Read_Display_Field

(

uint32_t

field

)

Gets as a bit-field the last state of the specified LEDs set through the LED API.

Parameters:

field

LEDs of which to get the state (1 bit per LED).

Returns:

State of the specified LEDs (1 bit per LED, beginning with the first specified LED).

Note:

The GPIO pin configuration of all LEDs is left unchanged.

uint32_t LED_Read_Display_Mask

(

uint32_t

mask

)

Gets the last state of the specified LEDs set through the LED API.

Parameters:

mask	LEDs of which to get the state (1 bit per LED).

Returns:

State of the specified LEDs (1 bit per LED).

Note:

The GPIO pin configuration of all LEDs is left unchanged.

void LED_Set_Intensity	(	uint32_t	leds,
		uint8_t	intensity
	)

Sets the intensity of the specified LEDs.

Parameters:

leds	LEDs of which to set the intensity (1 bit per LED).
intensity	New intensity of the specified LEDs (0x00 to 0xFF).

Warning:

The PWM channels of the specified LEDs are supposed to be used only by this module.

Note:

The pins of the specified LEDs are set to PWM output mode.

bool LED_Test

(

uint32_t

leds

)

Tests the last state of the specified LEDs set through the LED API.

Parameters:

leds	LEDs of which to test the state (1 bit per LED).

Returns:

true if at least one of the specified LEDs has a state on, else false.

Note:

The GPIO pin configuration of all LEDs is left unchanged.

void LED_Toggle

(

uint32_t

leds

)

Toggles the specified LEDs.

Parameters:

leds	LEDs to toggle (1 bit per LED).

Note:

The pins of the specified LEDs are set to GPIO output mode.

Here is the caller graph for this function: