Specialization of CAN driver for LPC17xx and LPC40xx CAN. More...

#include <Lpc17xx40xxCan.hxx>

Inheritance diagram for LpcCan:

Public Member Functions
	LpcCan (const char name, LPC_CAN_T base)
	Constructor.

	~LpcCan ()
	Destructor.

Public Member Functions inherited from Can
int	available ()

int	availableForWrite ()

int	read (struct can_frame *frame)
	Read a frame if there is one available.

int	write (const struct can_frame *frame)
	Send a frame if there is space available.

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

virtual	~Device ()
	Destructor.

Static Public Member Functions
static void	interrupt_handler ()
	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	tx_msg () override
	function to try and transmit a message

void	interrupt_handler (uint32_t status)
	handle an interrupt.

	LpcCan ()
	Default constructor.

	DISALLOW_COPY_AND_ASSIGN (LpcCan)

Private Attributes
LPC_CAN_T *	base
	base address of this device

Static Private Attributes
static unsigned int	intCount = 0
	one interrupt vector is shared between two CAN controllers, so we need to keep track of the number of controllers in use.

static LpcCan *	instances [2] = {NULL}
	Instance pointers help us get context from the interrupt handler(s)

Additional Inherited Members
Static Public Attributes inherited from Can
static unsigned	numReceivedPackets_ {0}

static unsigned	numTransmittedPackets_ {0}

Protected Member Functions inherited from Can
	Can (const char *ignored)
	Constructor.

	~Can ()
	Destructor.

	Can (const char *name, size_t tx_buffer_size=config_can_tx_buffer_size(), size_t rx_buffer_size=config_can_rx_buffer_size())
	Constructor.

	~Can ()
	Destructor.

bool	has_tx_buffer_space () OVERRIDE

bool	has_rx_buffer_data () OVERRIDE

void	flush_buffers () OVERRIDE
	called after disable

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.

Protected Member Functions inherited from Atomic
void	lock ()

void	unlock ()

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

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

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.

	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

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 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 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.

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.

Protected Attributes inherited from Can
DeviceBuffer< struct can_frame > *	txBuf
	transmit buffer

DeviceBuffer< struct can_frame > *	rxBuf
	receive buffer

unsigned int	overrunCount
	overrun count

unsigned int	busOffCount
	bus-off count

unsigned int	softErrorCount
	soft error count

Protected Attributes inherited from NonBlockNode
Notifiable *	readableNotify_
	This will be notified if the device has data avilable for read.

Notifiable *	writableNotify_
	This will be notified if the device has buffer avilable for write.

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 CAN driver for LPC17xx and LPC40xx CAN.

Definition at line 57 of file Lpc17xx40xxCan.hxx.

Constructor & Destructor Documentation

◆ LpcCan()

LpcCan::LpcCan	(	const char *	name,
		LPC_CAN_T *	base
	)

Constructor.

Parameters

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

Definition at line 49 of file Lpc17xx40xxCan.cxx.

◆ ~LpcCan()

LpcCan::~LpcCan ( )

inline

Destructor.

Definition at line 68 of file Lpc17xx40xxCan.hxx.

Member Function Documentation

◆ disable()

void LpcCan::disable ( )

overrideprivatevirtual

function to disable device

Disable use of the device.

Implements Can.

Definition at line 104 of file Lpc17xx40xxCan.cxx.

◆ enable()

void LpcCan::enable ( )

overrideprivatevirtual

function to enable device

Enable use of the device.

Implements Can.

Definition at line 77 of file Lpc17xx40xxCan.cxx.

◆ interrupt_handler() [1/2]

static void LpcCan::interrupt_handler ( )

inlinestatic

Translate an interrupt handler into C++ object context.

Definition at line 74 of file Lpc17xx40xxCan.hxx.

◆ interrupt_handler() [2/2]

void LpcCan::interrupt_handler ( uint32_t status )

private

handle an interrupt.

Common interrupt handler for all CAN devices.

Parameters

status interrupt source status

Todo:: (Stuart Baker) remove notify logic once we switch over to select()

Todo:: (Stuart Baker) remove notify logic once we switch over to select()

Definition at line 167 of file Lpc17xx40xxCan.cxx.

◆ tx_msg()

void LpcCan::tx_msg ( )

overrideprivatevirtual

function to try and transmit a message

Implements Can.

Definition at line 117 of file Lpc17xx40xxCan.cxx.

Member Data Documentation

◆ base

LPC_CAN_T* LpcCan::base

private

base address of this device

Definition at line 99 of file Lpc17xx40xxCan.hxx.

◆ instances

LpcCan * LpcCan::instances = {NULL}

staticprivate

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

Definition at line 42 of file Lpc17xx40xxCan.hxx.

◆ intCount

unsigned int LpcCan::intCount = 0

staticprivate

one interrupt vector is shared between two CAN controllers, so we need to keep track of the number of controllers in use.

Definition at line 104 of file Lpc17xx40xxCan.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

◆ LpcCan()

◆ ~LpcCan()

Member Function Documentation

◆ disable()

◆ enable()

◆ interrupt_handler() [1/2]

◆ interrupt_handler() [2/2]

◆ tx_msg()

Member Data Documentation

◆ base

◆ instances

◆ intCount