led.h File Reference

AT32UC3C UC3C_EK board LEDs support package. More...

#include "compiler.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.

Macros
Identifiers of LEDs to Use with LED Functions
#define	LED0   0x01
#define	LED1   0x02
#define	LED2   0x04
#define	LED3   0x08

Functions
U32	LED_Read_Display (void)
	Gets the last state of all LEDs set through the LED API. More...
void	LED_Display (U32 leds)
	Sets the state of all LEDs. More...
U32	LED_Read_Display_Mask (U32 mask)
	Gets the last state of the specified LEDs set through the LED API. More...
void	LED_Display_Mask (U32 mask, U32 leds)
	Sets the state of the specified LEDs. More...
bool	LED_Test (U32 leds)
	Tests the last state of the specified LEDs set through the LED API. More...
void	LED_Off (U32 leds)
	Turns off the specified LEDs. More...
void	LED_On (U32 leds)
	Turns on the specified LEDs. More...
void	LED_Toggle (U32 leds)
	Toggles the specified LEDs. More...
U32	LED_Read_Display_Field (U32 field)
	Gets as a bit-field the last state of the specified LEDs set through the LED API. More...
void	LED_Display_Field (U32 field, U32 leds)
	Sets as a bit-field the state of the specified LEDs. More...
U8	LED_Get_Intensity (U32 led)
	Gets the intensity of the specified LED. More...
void	LED_Set_Intensity (U32 leds, U8 intensity)
	Sets the intensity of the specified LEDs. More...

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

(

U32

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	(	U32	field,
		U32	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	(	U32	mask,
		U32	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:

U8 LED_Get_Intensity

(

U32

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

(

U32

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.

void LED_On

(

U32

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.

U32 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.

U32 LED_Read_Display_Field

(

U32

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.

U32 LED_Read_Display_Mask

(

U32

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	(	U32	leds,
		U8	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

(

U32

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

(

U32

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.