Serial_port_uart

Overview

Data Structures
struct	serial_spi_master_config_t
	spi master user configure structure. More...
struct	serial_spi_slave_config_t
	spi slave user configure structure. More...
struct	serial_spi_transfer_t
	spi transfer structure More...

Macros
#define	SERIAL_PORT_SPI_MASTER_HANDLE_SIZE   (HAL_SPI_MASTER_HANDLE_SIZE)
	serial port uart handle size
#define	SERIAL_USE_CONFIGURE_STRUCTURE   (0U)
	Enable or disable the confgure structure pointer.
#define	SERIAL_PORT_UART_HANDLE_SIZE   (HAL_UART_HANDLE_SIZE)
	serial port uart handle size
#define	SERIAL_USE_CONFIGURE_STRUCTURE   (0U)
	Enable or disable the confgure structure pointer.

Enumerations
enum	serial_spi_clock_polarity_t {   kSerial_SpiClockPolarityActiveHigh = 0x0U,   kSerial_SpiClockPolarityActiveLow }
	spi clock polarity configuration. More...
enum	serial_spi_clock_phase_t {   kSerial_SpiClockPhaseFirstEdge = 0x0U,   kSerial_SpiClockPhaseSecondEdge }
	spi clock phase configuration. More...
enum	serial_spi_shift_direction_t {   kSerial_SpiMsbFirst = 0x0U,   kSerial_SpiLsbFirst }
	spi data shifter direction options. More...
enum	serial_port_uart_parity_mode_t {   kSerialManager_UartParityDisabled = 0x0U,   kSerialManager_UartParityEven = 0x2U,   kSerialManager_UartParityOdd = 0x3U }
	serial port uart parity mode More...
enum	serial_port_uart_stop_bit_count_t {   kSerialManager_UartOneStopBit = 0U,   kSerialManager_UartTwoStopBit = 1U }
	serial port uart stop bit count More...

---

Data Structure Documentation

struct serial_spi_master_config_t

Data Fields
uint32_t	srcClock_Hz
	Clock source for spi in Hz.
uint32_t	baudRate_Bps
	Baud Rate for spi in Hz.
serial_spi_clock_polarity_t	polarity
	Clock polarity.
serial_spi_clock_phase_t	phase
	Clock phase.
serial_spi_shift_direction_t	direction
	MSB or LSB.
uint8_t	instance
	Instance of the spi.
bool	enableMaster
	Enable spi at initialization time.
uint32_t	configFlags
	Transfer config Flags.

struct serial_spi_slave_config_t

Data Fields
hal_spi_clock_polarity_t	polarity
	Clock polarity.
hal_spi_clock_phase_t	phase
	Clock phase.
hal_spi_shift_direction_t	direction
	MSB or LSB.
uint8_t	instance
	Instance of the spi.
bool	enableSlave
	Enable spi at initialization time.
uint32_t	configFlags
	Transfer config Flags.

struct serial_spi_transfer_t

Data Fields
uint8_t *	txData
	Send buffer.
uint8_t *	rxData
	Receive buffer.
size_t	dataSize
	Transfer bytes.
uint32_t	flags
	spi control flag. More...

Field Documentation

uint32_t serial_spi_transfer_t::flags

Enumeration Type Documentation

enum serial_spi_clock_polarity_t

Enumerator
kSerial_SpiClockPolarityActiveHigh	Active-high spi clock (idles low).
kSerial_SpiClockPolarityActiveLow	Active-low spi clock (idles high).

enum serial_spi_clock_phase_t

Enumerator
kSerial_SpiClockPhaseFirstEdge	First edge on SPSCK occurs at the middle of the first cycle of a data transfer.
kSerial_SpiClockPhaseSecondEdge	First edge on SPSCK occurs at the start of the first cycle of a data transfer.

enum serial_spi_shift_direction_t

Enumerator
kSerial_SpiMsbFirst	Data transfers start with most significant bit.
kSerial_SpiLsbFirst	Data transfers start with least significant bit.

enum serial_port_uart_parity_mode_t

Enumerator
kSerialManager_UartParityDisabled	Parity disabled.
kSerialManager_UartParityEven	Parity even enabled.
kSerialManager_UartParityOdd	Parity odd enabled.

enum serial_port_uart_stop_bit_count_t

Enumerator
kSerialManager_UartOneStopBit	One stop bit.
kSerialManager_UartTwoStopBit	Two stop bits.