TivaCan Class Reference

Specialization of CAN driver for Tiva CAN. More...

#include <TivaDev.hxx>

Inheritance diagram for TivaCan:

Public Member Functions
	TivaCan (const char *name, unsigned long base, uint32_t interrupt)
	Constructor.
	~TivaCan ()
	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 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.

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
	TivaCan ()
	Default constructor.
	DISALLOW_COPY_AND_ASSIGN (TivaCan)

Private Attributes
unsigned long	base
	base address of this device
unsigned long	interrupt
	interrupt of this device
bool	txPending
	transmission currently pending
uint8_t	canState
	current state of the CAN-bus.

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

Definition at line 243 of file TivaDev.hxx.

Constructor & Destructor Documentation

TivaCan()

TivaCan::TivaCan	(	const char *	name,
		unsigned long	base,
		uint32_t	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 58 of file TivaCan.cxx.

~TivaCan()

TivaCan::~TivaCan ( )

inline

Destructor.

Definition at line 255 of file TivaDev.hxx.

Member Function Documentation

disable()

void TivaCan::disable ( )

overrideprivatevirtual

function to disable device

Disable use of the device.

Implements Can.

Definition at line 147 of file TivaCan.cxx.

enable()

void TivaCan::enable ( )

overrideprivatevirtual

function to enable device

Enable use of the device.

Implements Can.

Definition at line 133 of file TivaCan.cxx.

interrupt_handler()

void TivaCan::interrupt_handler

(

)

handle an interrupt.

Common interrupt handler for all CAN devices.

Todo:

(Stuart Baker) this should be made private

Todo:

(balazs.racz) make this a static variable in os.c

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 194 of file TivaCan.cxx.

ioctl()

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

overridevirtual

Request an ioctl transaction.

Parameters

file	file reference for this device
key	ioctl key
data	key data

Returns

>= 0 upon success, -errno upon failure

Reimplemented from NonBlockNode.

Definition at line 121 of file TivaCan.cxx.

tx_msg()

void TivaCan::tx_msg ( )

overrideprivatevirtual

function to try and transmit a message

Implements Can.

Definition at line 156 of file TivaCan.cxx.

Member Data Documentation

base

unsigned long TivaCan::base

private

base address of this device

Definition at line 276 of file TivaDev.hxx.

canState

uint8_t TivaCan::canState

private

current state of the CAN-bus.

Definition at line 279 of file TivaDev.hxx.

interrupt

unsigned long TivaCan::interrupt

private

interrupt of this device

Definition at line 277 of file TivaDev.hxx.

txPending

bool TivaCan::txPending

private

transmission currently pending

Definition at line 278 of file TivaDev.hxx.

---

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

• TivaDev.hxx
• TivaCan.cxx