Specialization of Serial driver for LPC17xx and LPC40xx UART. More...

#include <Lpc17xx40xxUart.hxx>

Inheritance diagram for LpcUart:

Public Member Functions
	LpcUart (const char name, LPC_USART_T base, IRQn_Type interrupt)
	Constructor.

	~LpcUart ()
	Destructor.

Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

Static Public Member Functions
static void	interrupt_handler (unsigned index)
	Translate an interrupt handler into C++ object context.

Static Public Member Functions inherited from Device
static int	open (struct _reent reent, const char path, int flags, int mode)
	Open a file or device.

static int	close (struct _reent *reent, int fd)
	Close a file or device.

static int	stat (struct _reent reent, const char path, struct stat *stat)
	Get the status information of a file or device.

static int	select (int nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, long long timeout)
	POSIX select().

static void	select_clear ()
	Clears the current thread's select bits.

Static Public Member Functions inherited from FileIO
static ssize_t	read (struct _reent reent, int fd, void buf, size_t count)
	Read from a file or device.

static ssize_t	write (struct _reent reent, int fd, const void buf, size_t count)
	Write to a file or device.

static _off_t	lseek (struct _reent *reent, int fd, _off_t offset, int whence)
	Change the offset index of a file or device.

static int	fstat (struct _reent reent, int fd, struct stat stat)
	Get the status information of a file or device.

static int	ioctl (int fd, unsigned long int key, unsigned long data)
	Request and ioctl transaction.

static int	fcntl (int fd, int cmd, unsigned long data)
	Manipulate a file descriptor.

static bool	is_device (int fd)
	Test if the file descriptor belongs to a device.

Private Member Functions
void	enable () override
	function to enable device

void	disable () override
	function to disable device

void	interrupt_handler ()
	handle an interrupt.

void	tx_char () override
	Try and transmit a message.

	LpcUart ()
	Default constructor.

	DISALLOW_COPY_AND_ASSIGN (LpcUart)

Private Attributes
LPC_USART_T *	base
	base address of this device

IRQn_Type	interrupt
	interrupt of this device

Static Private Attributes
static LpcUart *	instances [4] = {NULL}
	Instance pointers help us get context from the interrupt handler(s)

Additional Inherited Members
Protected Member Functions inherited from Serial
	Serial (const char *name, size_t tx_buffer_size=config_serial_tx_buffer_size(), size_t rx_buffer_size=config_serial_rx_buffer_size())
	Constructor.

	~Serial ()
	Destructor.

ssize_t	read (File file, void buf, size_t count) OVERRIDE
	Read from a file or device.

ssize_t	write (File file, const void buf, size_t count) OVERRIDE
	Write to a file or device.

int	ioctl (File *file, unsigned long int key, unsigned long data) OVERRIDE
	Request an ioctl transaction.

bool	select (File *file, int mode) OVERRIDE
	Device select method.

void	flush_buffers () OVERRIDE
	Discards all pending buffers.

Protected Member Functions inherited from Node
	Node (const char *name)
	Constructor.

virtual	~Node ()
	Destructor.

int	open (File , const char , int, int) OVERRIDE
	Open method.

int	close (File *) OVERRIDE
	Close method.

virtual int	fstat (File file, struct stat stat) override
	Get the status information of a file or device.

Protected Member Functions inherited from FileIO
	FileIO (const char *name)
	Constructor.

virtual	~FileIO ()
	Destructor.

virtual off_t	lseek (File *f, off_t offset, int whence)
	Seek method.

virtual int	fcntl (File *file, int cmd, unsigned long data)
	Manipulate a file descriptor.

Static Protected Member Functions inherited from Device
static void	select_insert (SelectInfo *info)
	Add client to list of clients needing woken.

static void	select_wakeup (SelectInfo *info)
	Wakeup the list of clients needing woken.

static void	select_wakeup_from_isr (SelectInfo info, int woken)
	Wakeup the list of clients needing woken.

Static Protected Member Functions inherited from FileIO
static int	fd_alloc (void)
	Allocate a free file descriptor.

static void	fd_free (int fd)
	Free up a file descriptor.

static File *	file_lookup (int fd)
	Looks up a reference to a File corresponding to a given file descriptor.

static int	fd_lookup (File *file)
	Looks up a file descriptor corresponding to a given File reference.

Protected Attributes inherited from Serial
DeviceBuffer< uint8_t > *	txBuf
	transmit buffer

DeviceBuffer< uint8_t > *	rxBuf
	receive buffer

unsigned int	overrunCount
	overrun count

Protected Attributes inherited from Node
OSMutex	lock_
	protects internal structures.

mode_t	mode_
	File open mode, such as O_NONBLOCK.

unsigned int	references_
	number of open references

Protected Attributes inherited from FileIO
const char *	name
	device name

Static Protected Attributes inherited from FileIO
static const unsigned int	numOpenFiles = 20

static File	files []
	File descriptor pool.

static OSMutex	mutex
	mutual exclusion for fileio

Detailed Description

Specialization of Serial driver for LPC17xx and LPC40xx UART.

Definition at line 57 of file Lpc17xx40xxUart.hxx.

Constructor & Destructor Documentation

◆ LpcUart()

LpcUart::LpcUart	(	const char *	name,
		LPC_USART_T *	base,
		IRQn_Type	interrupt
	)

Constructor.

Parameters

name	name of this device instance in the file system
base	base address of this device
interrupt	interrupt number of this device

Definition at line 50 of file Lpc17xx40xxUart.cxx.

◆ ~LpcUart()

LpcUart::~LpcUart ( )

inline

Destructor.

Definition at line 69 of file Lpc17xx40xxUart.hxx.

Member Function Documentation

◆ disable()

void LpcUart::disable ( )

overrideprivatevirtual

function to disable device

Disable use of the device.

Implements Node.

Definition at line 103 of file Lpc17xx40xxUart.cxx.

◆ enable()

void LpcUart::enable ( )

overrideprivatevirtual

function to enable device

Enable use of the device.

Implements Node.

Definition at line 89 of file Lpc17xx40xxUart.cxx.

◆ interrupt_handler() [1/2]

void LpcUart::interrupt_handler ( )

private

handle an interrupt.

Common interrupt handler for all UART devices.

Todo:: (Stuart Baker) optimization opportunity by getting a write pointer to fill the fifo and then advance the buffer when finished

Todo:: (Stuart Baker) optimization opportunity by getting a read pointer to fill the fifo and then consume the buffer when finished.

Definition at line 129 of file Lpc17xx40xxUart.cxx.

◆ interrupt_handler() [2/2]

static void LpcUart::interrupt_handler ( unsigned index )

inlinestatic

Translate an interrupt handler into C++ object context.

Parameters

index UART index to translate

Definition at line 76 of file Lpc17xx40xxUart.hxx.

◆ tx_char()

void LpcUart::tx_char ( )

overrideprivatevirtual

Try and transmit a message.

Implements Serial.

Definition at line 113 of file Lpc17xx40xxUart.cxx.

Member Data Documentation

◆ base

LPC_USART_T* LpcUart::base

private

base address of this device

Definition at line 93 of file Lpc17xx40xxUart.hxx.

◆ instances

LpcUart * LpcUart::instances = {NULL}

staticprivate

Instance pointers help us get context from the interrupt handler(s)

Definition at line 42 of file Lpc17xx40xxUart.hxx.

◆ interrupt

IRQn_Type LpcUart::interrupt

private

interrupt of this device

Definition at line 94 of file Lpc17xx40xxUart.hxx.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LpcUart()

◆ ~LpcUart()

Member Function Documentation

◆ disable()

◆ enable()

◆ interrupt_handler() [1/2]

◆ interrupt_handler() [2/2]

◆ tx_char()

Member Data Documentation

◆ base

◆ instances

◆ interrupt