arm-pl011.h File Reference

ARM PL011 Support Package. More...

#include <rtems/termiostypes.h>
#include <dev/serial/arm-pl011-regs.h>
#include <bspopts.h>

Go to the source code of this file.

Data Structures
struct	arm_pl011_uart
struct	arm_pl011_context

Functions
bool	arm_pl011_probe (rtems_termios_device_context *base)
	Initialize pl011 registers.
void	arm_pl011_write_polled (rtems_termios_device_context *base, char c)
	Write a char using polling mode.
int	arm_pl011_read_polled (rtems_termios_device_context *base)
	Read a char using polling mode.
volatile arm_pl011_uart *	arm_pl011_get_regs (rtems_termios_device_context *base)
	Get register base address.
int	arm_pl011_compute_baudrate_params (uint32_t *ibrd, uint32_t *fbrd, const uint32_t baudrate, const uint32_t clock, const unsigned short max_error)
	Compute baudrate params.

Variables
const rtems_termios_device_handler	arm_pl011_fns

Detailed Description

ARM PL011 Support Package.

Function Documentation

arm_pl011_compute_baudrate_params()

int arm_pl011_compute_baudrate_params	(	uint32_t *	ibrd,
		uint32_t *	fbrd,
		const uint32_t	baudrate,
		const uint32_t	clock,
		const unsigned short	max_error
	)

Compute baudrate params.

Parameters

ibrd	The integer part of the baud rate divisor value.
fbrd	The fractional part of the baud rate divisor value.
baudrate	Termios device context.
clock	The UART reference clock frequency.
max_error	Maximum error.

Return values

0	Success.
1	The error is too large.
2	ibrd is invalid.

arm_pl011_get_regs()

volatile arm_pl011_uart * arm_pl011_get_regs

(

rtems_termios_device_context *

base

)

Get register base address.

Parameters

base	Termios device context.

Return values

Register

base address.

arm_pl011_probe()

bool arm_pl011_probe

(

rtems_termios_device_context *

base

)

Initialize pl011 registers.

Parameters

base	Termios device context.

Return values

true	Successfully initialized pl011 registers.

arm_pl011_read_polled()

int arm_pl011_read_polled

(

rtems_termios_device_context *

base

)

Read a char using polling mode.

Parameters

base	Termios device context.

Return values

Character	read.
-1	rxfifo is empty.

arm_pl011_write_polled()

void arm_pl011_write_polled	(	rtems_termios_device_context *	base,
		char	c
	)

Write a char using polling mode.

Parameters

base	Termios device context.
c	Character to be written.