truck-code
Classes | Macros | Functions
can_man.h File Reference
#include "das_clt.h"
#include "sja1000.h"
#include <sys/iomsg.h>
#include <sys/iofunc.h>
#include "utils/common.h"
#include "utils/buffer.h"
Include dependency graph for can_man.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  can_msg_t
 
struct  can_filter_t
 
struct  can_dev_handle_t
 
struct  can_info_t
 
struct  can_err_count_t
 
struct  can_ocb_t
 
class  CANDeviceManager
 
struct  can_attr_t
 

Macros

#define MAX_MSG_BUF   1000
 
#define PATH_CAN_ID(j)
 
#define PATH_CAN_PRIORITY(j)   (((j) >> 26) & 0x7)
 
#define PATH_CAN_PF(j)   (((j) >> 16) & 0xff)
 
#define PATH_CAN_PS(j)   (((j) >> 8) & 0xff)
 
#define PATH_CAN_SA(j)   ((j) & 0xff)
 
#define IS_EXTENDED_FRAME(MSG)   ((MSG).id & 0x80000000)
 
#define SET_EXTENDED_FRAME(MSG)   ((MSG).id |= 0x80000000)
 
#define CAN_ID(MSG)   ((MSG).id & ~0x80000000)
 
#define DEFAULT_CONFIG   "realtime.ini"
 
#define DEFAULT_DEVICE   "/dev/can1"
 
#define INI_IRQ_ENTRY   "Irq"
 
#define INI_PORT_ENTRY   "Port"
 
#define INI_EXT_ENTRY   "Ext"
 
#define DEFAULT_IRQ   0
 
#define DEFAULT_PORT   0x210
 
#define DEFAULT_QSIZE   150
 
#define IOFUNC_OCB_T   can_ocb_t
 
#define IOFUNC_ATTR_T   can_attr_t
 

Functions

int can_dev_arm (resmgr_context_t *ctp, iofunc_ocb_t *io_ocb, sigevent event)
 
void pulse_init (dispatch_t *dpp, IOFUNC_ATTR_T *pattr)
 
int io_devctl (resmgr_context_t *ctp, io_devctl_t *msg, RESMGR_OCB_T *io_ocb)
 
int io_open (resmgr_context_t *ctp, io_open_t *msg, RESMGR_HANDLE_T *handle, void *extra)
 

Detailed Description

can_man.h

Structures, definitions, and prototypes for the CAN driver.

Author
Abdul Rahman Kreidieh
Version
1.0.0
Date
February 19, 2019

Macro Definition Documentation

◆ CAN_ID

#define CAN_ID (   MSG)    ((MSG).id & ~0x80000000)

Get CAN identity number.

◆ DEFAULT_CONFIG

#define DEFAULT_CONFIG   "realtime.ini"

Path to the default configuration file.

This is used when initializing the CAN connection. A typical configuration file is text, and might contain lines like:

[first_section_name]
MoreData=TRUE
AnotherVariable=1.2345

[windows_section]
ScreenSaveActive=1
DoubleClickSpeed=452

[last_section]
MoreData=FALSE

◆ DEFAULT_DEVICE

#define DEFAULT_DEVICE   "/dev/can1"

Directory of the CAN device connection.

◆ DEFAULT_IRQ

#define DEFAULT_IRQ   0

Default Interrupt Request Line. By default, set to no interrupt.

◆ DEFAULT_PORT

#define DEFAULT_PORT   0x210

Default address of the CAN adapter.

◆ DEFAULT_QSIZE

#define DEFAULT_QSIZE   150

Default size of the buffers for the input and output buffers, stored under attr.in_buff and attr.out_buff, respectively.

◆ INI_EXT_ENTRY

#define INI_EXT_ENTRY   "Ext"

TODO

◆ INI_IRQ_ENTRY

#define INI_IRQ_ENTRY   "Irq"

TODO

◆ INI_PORT_ENTRY

#define INI_PORT_ENTRY   "Port"

TODO

◆ IS_EXTENDED_FRAME

#define IS_EXTENDED_FRAME (   MSG)    ((MSG).id & 0x80000000)

Checks if identifier is 29 or 11 bit.

◆ MAX_MSG_BUF

#define MAX_MSG_BUF   1000

Largest number of element allows in the CAN Rx buffers

◆ PATH_CAN_ID

#define PATH_CAN_ID (   j)
Value:
((((j)->priority & 0x7) << 26) | \
(((j)->reserved & 0x1) << 25) | \
(((j)->data_page & 0x1) << 24) | \
(((j)->pdu_format & 0xff) << 16) | \
(((j)->pdu_specific & 0xff) << 8) | \
(((j)->src_address & 0xff)))

Get pdu identifier.

◆ PATH_CAN_PF

#define PATH_CAN_PF (   j)    (((j) >> 16) & 0xff)

Get pdu format value.

◆ PATH_CAN_PRIORITY

#define PATH_CAN_PRIORITY (   j)    (((j) >> 26) & 0x7)

Get priority value.

◆ PATH_CAN_PS

#define PATH_CAN_PS (   j)    (((j) >> 8) & 0xff)

Get pdu specific value.

◆ PATH_CAN_SA

#define PATH_CAN_SA (   j)    ((j) & 0xff)

Get source address value

◆ SET_EXTENDED_FRAME

#define SET_EXTENDED_FRAME (   MSG)    ((MSG).id |= 0x80000000)

Set the 29 bit identifier.

Function Documentation

◆ can_dev_arm()

int can_dev_arm ( resmgr_context_t *  ctp,
iofunc_ocb_t *  io_ocb,
sigevent  event 
)

Arm the CAN device manager.

Attach the hardware interrupt, and save the event to be used to notify the client in the ocb structure.

Parameters
ctpA pointer to a resmgr_context_t structure that the resource-manager library uses to pass context information between functions.
io_ocbOpen control block (usually embedded within file system ocb)
eventCAN signal event structure, used to receive and process pulses
Returns
0 for success, or -1 if an error occurs

◆ io_devctl()

int io_devctl ( resmgr_context_t *  ctp,
io_devctl_t *  msg,
RESMGR_OCB_T *  io_ocb 
)

Handler for _IO_DEVCTL CAN messages.

This is used to initialize resource manager function tables with CAN specific function for devctl. It is responsible for handling the DCMD_* functionality.

Parameters
ctpA pointer to a resmgr_context_t structure that the resource-manager library uses to pass context information between functions.
msgA pointer to the io_open_t structure that contains the message that the resource manager received. For more information, see the documentation for iofunc_open().
io_ocbA pointer to the iofunc_ocb_t structure for the Open Control Block that was created when the client opened the resource.
Returns
EOK - Successful completion.
EINVAL - An attempt to set the flags for a resource that is synchronized, with no mount structure defined, or no synchronized I/O defined.
ENOTTY - An unsupported device control message was decoded.

◆ io_open()

int io_open ( resmgr_context_t *  ctp,
io_open_t *  msg,
RESMGR_HANDLE_T *  handle,
void *  extra 
)

Handler for _IO_CONNECT of CAN messages.

This is used to initialize resource manager function tables with CAN specific function for open().

Parameters
ctpA pointer to a resmgr_context_t structure that the resource-manager library uses to pass context information between functions.
msgA pointer to the io_open_t structure that contains the message that the resource manager received. For more information, see the documentation for iofunc_open().
handleA pointer to the iofunc_attr_t structure that defines the characteristics of the device that the resource manager is controlling.
extraExtra information from the library. If you're calling iofunc_open_default() from a resource manager's open() function (see resmgr_connect_funcs_t), simply pass the extra argument that's passed to open().
Returns
EOK - Successful completion.
ENOSPC - There's insufficient memory to allocate the OCB.
ENOMEM - There's insufficient memory to allocate an internal data structure required by resmgr_open_bind().

◆ pulse_init()

void pulse_init ( dispatch_t *  dpp,
IOFUNC_ATTR_T *  pattr 
)

Attach pulses and interrupt events.

Attach pulse to be sent by interrupt handler to event that will connected to the interrupt by InterruptAttachEvent in can_dev->arm.

Parameters
dppThe dispatch handle, as returned by dispatch_create().
pattrpointer to information per device manager
Generated by   doxygen 1.8.13