Stm32Uart Class Reference

Specialization of Serial driver for STM32F0xx devices. More...

#include <Stm32Uart.hxx>

Inheritance diagram for Stm32Uart:

Public Member Functions
	Stm32Uart (const char *name, USART_TypeDef *base, IRQn_Type interrupt)
	Constructor.
	~Stm32Uart ()
	Destructor.
void	interrupt_handler ()
	handle an interrupt.
int	ioctl (File *file, unsigned long int key, unsigned long data) override
	Request an ioctl transaction.
Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.
virtual	~Device ()
	Destructor.

Protected Member Functions
void	enable () override
	function to enable device
void	disable () override
	function to disable device
void	tx_char () override
	Try and transmit a message.
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.
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.

Protected Attributes
IRQn_Type	interrupt
	interrupt of this device
UART_HandleTypeDef	uartHandle
	Handle to the UART setup.
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
static uint8_t	interrupt3_to_8EnableCnt = 0
	number of times interrupts have been enabled on these UART channels
static uint8_t	interrupt2_8EnableCnt = 0
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

Private Member Functions
	Stm32Uart ()
	Default constructor.
	DISALLOW_COPY_AND_ASSIGN (Stm32Uart)

Additional Inherited Members
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.
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.

Detailed Description

Specialization of Serial driver for STM32F0xx devices.

Definition at line 88 of file Stm32Uart.hxx.

Constructor & Destructor Documentation

Stm32Uart()

Stm32Uart::Stm32Uart	(	const char *	name,
		USART_TypeDef *	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 53 of file Stm32Uart.cxx.

~Stm32Uart()

Stm32Uart::~Stm32Uart ( )

inline

Destructor.

Definition at line 100 of file Stm32Uart.hxx.

Member Function Documentation

disable()

void Stm32Uart::disable ( )

overrideprotectedvirtual

function to disable device

Disable use of the device.

Implements Node.

Definition at line 122 of file Stm32Uart.cxx.

enable()

void Stm32Uart::enable ( )

overrideprotectedvirtual

function to enable device

Enable use of the device.

Implements Node.

Definition at line 74 of file Stm32Uart.cxx.

interrupt_handler()

void Stm32Uart::interrupt_handler

(

)

handle an interrupt.

Common interrupt handler for all UART devices.

Call this function from HwInit.cxx from void u(s)artN_interrupt_handler(void). If there are multiple instances on the same interrupt, call them all from the relevant interrupt handler.

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 192 of file Stm32Uart.cxx.

ioctl()

int Stm32Uart::ioctl ( File *  file, unsigned long int  key, unsigned long  data  )

overridevirtual

Request an ioctl transaction.

Supported ioctl is TCBAUDRATE from include/freertos/tc_ioctl.h

Reimplemented from Serial.

Definition at line 158 of file Stm32Uart.cxx.

tx_char()

void Stm32Uart::tx_char ( )

overrideprotectedvirtual

Try and transmit a message.

Implements Serial.

Definition at line 175 of file Stm32Uart.cxx.

Member Data Documentation

interrupt

IRQn_Type Stm32Uart::interrupt

protected

interrupt of this device

Definition at line 124 of file Stm32Uart.hxx.

interrupt2_8EnableCnt

uint8_t Stm32Uart::interrupt2_8EnableCnt = 0

staticprotected

Definition at line 131 of file Stm32Uart.hxx.

interrupt3_to_8EnableCnt

uint8_t Stm32Uart::interrupt3_to_8EnableCnt = 0

staticprotected

number of times interrupts have been enabled on these UART channels

Definition at line 130 of file Stm32Uart.hxx.

uartHandle

UART_HandleTypeDef Stm32Uart::uartHandle

protected

Handle to the UART setup.

Definition at line 127 of file Stm32Uart.hxx.

---

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

• Stm32Uart.hxx
• Stm32Uart.cxx