Functions
void	serial_init (serial_t *obj, PinName tx, PinName rx)
	Initialize the serial peripheral. More...

void	serial_free (serial_t *obj)
	Release the serial peripheral, not currently invoked. More...

void	serial_baud (serial_t *obj, int baudrate)
	Configure the baud rate. More...

void	serial_format (serial_t *obj, int data_bits, SerialParity parity, int stop_bits)
	Configure the format. More...

void	serial_irq_handler (serial_t *obj, uart_irq_handler handler, uint32_t id)
	The serial interrupt handler registration. More...

void	serial_irq_set (serial_t *obj, SerialIrq irq, uint32_t enable)
	Configure serial interrupt. More...

int	serial_getc (serial_t *obj)
	Get character. More...

void	serial_putc (serial_t *obj, int c)
	Send a character. More...

int	serial_readable (serial_t *obj)
	Check if the serial peripheral is readable. More...

int	serial_writable (serial_t *obj)
	Check if the serial peripheral is writable. More...

void	serial_clear (serial_t *obj)
	Clear the serial peripheral. More...

void	serial_break_set (serial_t *obj)
	Set the break. More...

void	serial_break_clear (serial_t *obj)
	Clear the break. More...

void	serial_pinout_tx (PinName tx)
	Configure the TX pin for UART function. More...

void	serial_set_flow_control (serial_t *obj, FlowControl type, PinName rxflow, PinName txflow)
	Configure the serial for the flow control. More...

const PinMap *	serial_tx_pinmap (void)
	Get the pins that support Serial TX. More...

const PinMap *	serial_rx_pinmap (void)
	Get the pins that support Serial RX. More...

const PinMap *	serial_cts_pinmap (void)
	Get the pins that support Serial CTS. More...

const PinMap *	serial_rts_pinmap (void)
	Get the pins that support Serial RTS. More...

Detailed Description

Function Documentation

void serial_baud	(	serial_t *	obj,
		int	baudrate
	)

Configure the baud rate.

Parameters

obj	The serial object
baudrate	The baud rate to be configured

void serial_break_clear ( serial_t * obj )

Clear the break.

Parameters

obj	The serial object

void serial_break_set ( serial_t * obj )

Set the break.

Parameters

obj	The serial object

void serial_clear ( serial_t * obj )

Clear the serial peripheral.

Parameters

obj	The serial object

const PinMap* serial_cts_pinmap ( void )

Get the pins that support Serial CTS.

Return a PinMap array of pins that support Serial CTS. The array is terminated with {NC, NC, 0}.

Returns: PinMap array

void serial_format	(	serial_t *	obj,
		int	data_bits,
		SerialParity	parity,
		int	stop_bits
	)

Configure the format.

Set the number of bits, parity and the number of stop bits

Parameters

obj	The serial object
data_bits	The number of data bits
parity	The parity
stop_bits	The number of stop bits

void serial_free ( serial_t * obj )

Release the serial peripheral, not currently invoked.

It requires further resource management.

Parameters

obj	The serial object

int serial_getc ( serial_t * obj )

Get character.

This is a blocking call, waiting for a character

Parameters

obj	The serial object

void serial_init	(	serial_t *	obj,
		PinName	tx,
		PinName	rx
	)

Initialize the serial peripheral.

It sets the default parameters for serial peripheral, and configures its specifieds pins.

Parameters

obj	The serial object
tx	The TX pin name
rx	The RX pin name

void serial_irq_handler	(	serial_t *	obj,
		uart_irq_handler	handler,
		uint32_t	id
	)

The serial interrupt handler registration.

Parameters

obj	The serial object
handler	The interrupt handler which will be invoked when the interrupt fires
id	The SerialBase object

void serial_irq_set	(	serial_t *	obj,
		SerialIrq	irq,
		uint32_t	enable
	)

Configure serial interrupt.

This function is used for word-approach

Parameters

obj	The serial object
irq	The serial IRQ type (RX or TX)
enable	Set to non-zero to enable events, or zero to disable them

void serial_pinout_tx ( PinName tx )

Configure the TX pin for UART function.

Parameters

tx	The pin name used for TX

void serial_putc	(	serial_t *	obj,
		int	c
	)

Send a character.

This is a blocking call, waiting for a peripheral to be available for writing

Parameters

obj	The serial object
c	The character to be sent

int serial_readable ( serial_t * obj )

Check if the serial peripheral is readable.

Parameters

obj	The serial object

Returns: Non-zero value if a character can be read, 0 if nothing to read

const PinMap* serial_rts_pinmap ( void )

Get the pins that support Serial RTS.

Return a PinMap array of pins that support Serial RTS. The array is terminated with {NC, NC, 0}.

Returns: PinMap array

const PinMap* serial_rx_pinmap ( void )

Get the pins that support Serial RX.

Return a PinMap array of pins that support Serial RX. The array is terminated with {NC, NC, 0}.

Returns: PinMap array

void serial_set_flow_control	(	serial_t *	obj,
		FlowControl	type,
		PinName	rxflow,
		PinName	txflow
	)

Configure the serial for the flow control.

It sets flow control in the hardware if a serial peripheral supports it, otherwise software emulation is used.

Parameters

obj	The serial object
type	The type of the flow control. Look at the available FlowControl types.
rxflow	The TX pin name
txflow	The RX pin name

const PinMap* serial_tx_pinmap ( void )

Get the pins that support Serial TX.

Return a PinMap array of pins that support Serial TX. The array is terminated with {NC, NC, 0}.

Returns: PinMap array

int serial_writable ( serial_t * obj )

Check if the serial peripheral is writable.

Parameters

obj	The serial object

Returns: Non-zero value if a character can be written, 0 otherwise.

Functions

Detailed Description

Function Documentation

Important Information for this Arm website