LEDComm  1.0
LEDCommConfig_t Struct Reference

LEDComm Driver configuration structure. More...

#include <ledcomm.h>

Collaboration diagram for LEDCommConfig_t:
Collaboration graph

Data Fields

ioportid_t anode_port
 The port where the LED anode is connected. More...
 
ioportmask_t anode_pad
 The pad where the LED anode is connected. More...
 
ioportid_t cathode_port
 The port where the LED cathode is connected. More...
 
ioportmask_t cathode_pad
 The pad where the LED cathode is connected. More...
 
uint32_t cathode_extmode
 The processor-specific EXT mode used to configure the extcfg table. More...
 
uint16_t threshold
 The highest number of elapsed HAL ticks that represents a 'shine' – try LEDCOMM_DEFAULT_THRESHOLD (3000) More...
 
uint8_t data_bits:1
 LEDCOMM_DATA_BITS8 or LEDCOMM_DATA_BITS7 More...
 
uint8_t parity:1
 LEDCOMM_PARITY or LEDCOMM_PARITY_NONE More...
 
uint8_t parity_type:2
 One of LEDCOMM_PARITY_EVEN, LEDCOMM_PARITY_ODD, LEDCOMM_PARITY_MARK or LEDCOMM_PARITY_SPACE. More...
 

Detailed Description

LEDComm Driver configuration structure.

An instance of this structure must be passed to lcommStart() in order to configure and start LEDComm driver operations.

Note
This structure has some content that is architecture dependent, each driver implementation defines its own version and the custom static initializers.

Definition at line 166 of file ledcomm.h.

Field Documentation

ioportid_t LEDCommConfig_t::anode_port

The port where the LED anode is connected.

Definition at line 167 of file ledcomm.h.

Referenced by ldStart().

ioportmask_t LEDCommConfig_t::anode_pad

The pad where the LED anode is connected.

Definition at line 168 of file ledcomm.h.

Referenced by ldStart().

ioportid_t LEDCommConfig_t::cathode_port

The port where the LED cathode is connected.

Definition at line 169 of file ledcomm.h.

Referenced by ldStart().

ioportmask_t LEDCommConfig_t::cathode_pad

The pad where the LED cathode is connected.

Definition at line 170 of file ledcomm.h.

Referenced by ldStart().

uint32_t LEDCommConfig_t::cathode_extmode

The processor-specific EXT mode used to configure the extcfg table.

Definition at line 171 of file ledcomm.h.

Referenced by ldStart().

uint16_t LEDCommConfig_t::threshold

The highest number of elapsed HAL ticks that represents a 'shine' – try LEDCOMM_DEFAULT_THRESHOLD (3000)

Definition at line 172 of file ledcomm.h.

Referenced by ldStart().

uint8_t LEDCommConfig_t::data_bits

LEDCOMM_DATA_BITS8 or LEDCOMM_DATA_BITS7

Definition at line 175 of file ledcomm.h.

Referenced by ldStart().

uint8_t LEDCommConfig_t::parity

LEDCOMM_PARITY or LEDCOMM_PARITY_NONE

Definition at line 176 of file ledcomm.h.

uint8_t LEDCommConfig_t::parity_type

One of LEDCOMM_PARITY_EVEN, LEDCOMM_PARITY_ODD, LEDCOMM_PARITY_MARK or LEDCOMM_PARITY_SPACE.

Definition at line 177 of file ledcomm.h.