device::nic::CAN Namespace Reference

Data Structures
class	avrCANARY
	The generic driver interface to the avrCAN hardware. More...
class	PAXCAN
	PAXCAN presents the generic CAN interface to the FAMOUSO middleware, against all algorithms regarding CAN transfers are implemented. More...
class	RxInterrupt
	The RxInterrupt enables receive interrupt service base infrastructur for devices that are not able to generate such interrupts. It defines a handler and the functionality for switching on/off of the interrupt. More...
class	SimulateInterruptViaThreadAdapter
	This class enable asynchronous notification by simulating an interrupt with a thread, that block on a resource. If the resource gets ready, it calls a delegate for serving the asynchronous action like an interrupt. More...
class	PeakDriver
	The generic driver interface to the PeakCAN hardware. More...
struct	PeakDriverBase
	PeakDriverBase defines the CAN message object structure and the access methods. More...
class	PeakDriverLinuxTrait
	PeakDriverLinuxTrait abstacts from the low-level Peak Linux driver API to a generic API, that is used from device::nic::can::PeakDriver. More...
class	PeakDriverWindowsTrait
	PeakDriverWindowsTrait abstacts from the low-level Peak Windows driver API to a generic API, that is used from device::nic::can::PeakDriver. More...
class	SocketCANDriver
	The generic driver interface to the SocketCAN hardware. More...
class	XenomaiRTCANDriver
	The generic driver interface to the XenomaiRTCAN hardware. More...
Typedefs
typedef SimulateInterruptViaThreadAdapter < PAXCAN< PeakDriver < PeakDriverTrait > > >	PeakCAN
	PeakCAN is a typedef to a configured PeakCANDriver with enabled interrupt support. It is autmatically adapted to the platform it is compiled for. Supported platforms are Linux and Windows.
typedef PeakDriverLinuxTrait	PeakDriverTrait
typedef SimulateInterruptViaThreadAdapter < PAXCAN< SocketCANDriver<> > >	SocketCAN
	SocketCAN is a typedef to a configured PAXCAN with SocketCANDriver and enabled interrupt support.
typedef SimulateInterruptViaThreadAdapter < PAXCAN< XenomaiRTCANDriver<> > >	XenomaiRTCAN
	XenomaiRTCAN is a typedef to a configured PAXCAN with XenomaiRTCANDriver and enabled interrupt support.
Functions
void	fireCANARYInterrupt ()
	CLP2 (PEAKOptions,"Peak CAN Driver","pcan,p","The device that is used and the baudrate in the form of device:baudrate""Values:\n"" Device: \tdevice that has to be used\n"" Baudrate: \tlegal values are\n"" 0 = 1 MBit/s\n"" 1 = 500 kBit/s\n"" 2 = 250 kBit/s\n"" 3 = 125 kBit/s\n"" 4 = 100 kBit/s\n"" 5 = 50 kBit/s\n"" 6 = 20 kBit/s\n"" 7 = 10 kBit/s\n"" 8 = 5 kBit/s\n""(e.g. /dev/pcan32:2 (default))", std::string, device,"/dev/pcan32", int, baudrate, 2)
	CLP1 (PEAKOptions,"Peak CAN Driver","pcan,p","The baudrate in the form of a value""Values:\n"" Baudrate: \tlegal values are\n"" 0 = 1 MBit/s\n"" 1 = 500 kBit/s\n"" 2 = 250 kBit/s\n"" 3 = 125 kBit/s\n"" 4 = 100 kBit/s\n"" 5 = 50 kBit/s\n"" 6 = 20 kBit/s\n"" 7 = 10 kBit/s\n"" 8 = 5 kBit/s\n""(e.g. 2 (default))", int, baudrate, 2)
	CLP1 (SocketCANOptions,"Socket CAN Driver","scan,s","The device that is used\n""(e.g. can0 (default))", std::string, device,"can0")
	CLP1 (XenomaiRTCANOptions,"XenomaiRT CAN Driver","scan,s","The device that is used\n""(e.g. rtcan0 (default))", std::string, device,"rtcan0")
void	fnc () __attribute__((constructor))
Variables
const uint16_t	baudrates []
	defines an array containing different baudrates supported by the PeakCAN devices. It is used, to allow setting of the baudrate of the device via commandline parameters

Typedef Documentation

typedef SimulateInterruptViaThreadAdapter<PAXCAN<PeakDriver<PeakDriverTrait> > > device::nic::CAN::PeakCAN

PeakCAN is a typedef to a configured PeakCANDriver with enabled interrupt support. It is autmatically adapted to the platform it is compiled for. Supported platforms are Linux and Windows.

typedef PeakDriverWindowsTrait device::nic::CAN::PeakDriverTrait

define a generic type from where the PeakDriver could be derived.

typedef SimulateInterruptViaThreadAdapter< PAXCAN < SocketCANDriver<> > > device::nic::CAN::SocketCAN

SocketCAN is a typedef to a configured PAXCAN with SocketCANDriver and enabled interrupt support.

typedef SimulateInterruptViaThreadAdapter< PAXCAN < XenomaiRTCANDriver<> > > device::nic::CAN::XenomaiRTCAN

XenomaiRTCAN is a typedef to a configured PAXCAN with XenomaiRTCANDriver and enabled interrupt support.

Function Documentation

device::nic::CAN::CLP1	(	XenomaiRTCANOptions	,
		"XenomaiRT CAN Driver"	,
		"	scan,
		s"	,
		"The device that is used\n""(e.g. rtcan0 (default))"	,
		std::string	,
		device	,
		"rtcan0"
	)

device::nic::CAN::CLP1	(	SocketCANOptions	,
		"Socket CAN Driver"	,
		"	scan,
		s"	,
		"The device that is used\n""(e.g. can0 (default))"	,
		std::string	,
		device	,
		"can0"
	)

device::nic::CAN::CLP1	(	PEAKOptions	,
		"Peak CAN Driver"	,
		"	pcan,
		p"
	)

device::nic::CAN::CLP2	(	PEAKOptions	,
		"Peak CAN Driver"	,
		"	pcan,
		p"
	)

void device::nic::CAN::fireCANARYInterrupt ( ) [inline]

void device::nic::CAN::fnc ( )

Variable Documentation

const uint16_t device::nic::CAN::baudrates[]

Initial value:

 { CAN_BAUD_1M,
                                           CAN_BAUD_500K,
                                           CAN_BAUD_250K,
                                           CAN_BAUD_125K,
                                           CAN_BAUD_100K,
                                           CAN_BAUD_50K,
                                           CAN_BAUD_20K,
                                           CAN_BAUD_10K,
                                           CAN_BAUD_5K
                                         }

defines an array containing different baudrates supported by the PeakCAN devices. It is used, to allow setting of the baudrate of the device via commandline parameters

Referenced by device::nic::CAN::PeakDriverWindowsTrait::init(), and device::nic::CAN::PeakDriverLinuxTrait::init().

FAMOUSO

Menu

device::nic::CAN Namespace Reference

Data Structures

Typedefs

Functions

Variables

Typedef Documentation

Function Documentation

Variable Documentation