bcan.h File Reference

#include <sys/ioctl.h>
#include <sys/types.h>
#include <cstdint>
#include <cstdlib>
#include "modules/drivers/canbus/can_client/hermes_can/bcan_defs.h"

Include dependency graph for bcan.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	BCAN_MAX_TX_MSG   256
#define	BCAN_MAX_RX_MSG   256
#define	BCAN_DEV_UNINIT   -1
#define	BCAN_DEV_OPEN   (1 << 0)
#define	BCAN_DEV_CLOSE   (1 << 1)
#define	BCAN_DEV_BAUD_SET   (1 << 2)
#define	BCAN_DEV_NORMAL   (1 << 3)
#define	BCAN_DEV_LOOPBACK   (1 << 4)
#define	BCAN_DEV_CONFIG   (1 << 5)
#define	BCAN_DEV_START   (1 << 6)
#define	BCAN_DEV_STOP   (1 << 7)
#define	BCAN_DEV_ACTIVE   (1 << 8)
#define	BCAN_DEV_RECVD   (1 << 9)

Typedefs
typedef uint64_t	bcan_hdl_t

Enumerations
enum	bcan_baudrate_val {   BCAN_BAUDRATE_1M, BCAN_BAUDRATE_500K, BCAN_BAUDRATE_250K, BCAN_BAUDRATE_150K,   BCAN_BAUDRATE_NUM }

Functions
const char *	bcan_get_libversion (void)
const char *	bcan_bld_info (void)
const char *	bcan_bld_info_short (void)
const char *	bcan_get_err_msg (int err_code)
int	bcan_open (uint32_t dev_index, uint32_t flags, uint64_t tx_to, uint64_t rx_to, bcan_hdl_t *hdl)
int	bcan_close (bcan_hdl_t hdl)
int	bcan_start (bcan_hdl_t hdl)
int	bcan_stop (bcan_hdl_t hdl)
int	bcan_set_loopback (bcan_hdl_t hdl)
int	bcan_unset_loopback (bcan_hdl_t hdl)
int	bcan_set_baudrate (bcan_hdl_t hdl, uint32_t rate)
int	bcan_get_baudrate (bcan_hdl_t hdl, uint32_t *rate)
int	bcan_recv (bcan_hdl_t hdl, bcan_msg_t *buf, uint32_t num_msg)
int	bcan_send (bcan_hdl_t hdl, bcan_msg_t *buf, uint32_t num_msg)
int	bcan_send_hi_pri (bcan_hdl_t hdl, bcan_msg_t *buf)
int	bcan_get_status (bcan_hdl_t hdl)
int	bcan_get_err_counter (bcan_hdl_t hdl, uint8_t *rx_err, uint8_t *tx_err)
int	bcan_id_add (bcan_hdl_t hdl, uint32_t id_start, uint32_t id_end)
int	bcan_id_add_all (bcan_hdl_t hdl)
int	bcan_id_remove (bcan_hdl_t hdl, uint32_t id_start, uint32_t id_end)
int	bcan_id_remove_all (bcan_hdl_t hdl)

Macro Definition Documentation

BCAN_DEV_ACTIVE

#define BCAN_DEV_ACTIVE   (1 << 8)

BCAN_DEV_BAUD_SET

#define BCAN_DEV_BAUD_SET   (1 << 2)

BCAN_DEV_CLOSE

#define BCAN_DEV_CLOSE   (1 << 1)

BCAN_DEV_CONFIG

#define BCAN_DEV_CONFIG   (1 << 5)

BCAN_DEV_LOOPBACK

#define BCAN_DEV_LOOPBACK   (1 << 4)

BCAN_DEV_NORMAL

#define BCAN_DEV_NORMAL   (1 << 3)

BCAN_DEV_OPEN

#define BCAN_DEV_OPEN   (1 << 0)

BCAN_DEV_RECVD

#define BCAN_DEV_RECVD   (1 << 9)

BCAN_DEV_START

#define BCAN_DEV_START   (1 << 6)

BCAN_DEV_STOP

#define BCAN_DEV_STOP   (1 << 7)

BCAN_DEV_UNINIT

#define BCAN_DEV_UNINIT   -1

BCAN_MAX_RX_MSG

#define BCAN_MAX_RX_MSG   256

BCAN_MAX_TX_MSG

#define BCAN_MAX_TX_MSG   256

Typedef Documentation

bcan_hdl_t

typedef uint64_t bcan_hdl_t

Enumeration Type Documentation

bcan_baudrate_val

enum bcan_baudrate_val

Enumerator
BCAN_BAUDRATE_1M
BCAN_BAUDRATE_500K
BCAN_BAUDRATE_250K
BCAN_BAUDRATE_150K
BCAN_BAUDRATE_NUM

Function Documentation

bcan_bld_info()

const char* bcan_bld_info

(

void

)

bcan_bld_info_short()

const char* bcan_bld_info_short

(

void

)

bcan_close()

int bcan_close

(

bcan_hdl_t

hdl

)

bcan_get_baudrate()

int bcan_get_baudrate	(	bcan_hdl_t	hdl,
		uint32_t *	rate
	)

bcan_get_err_counter()

int bcan_get_err_counter	(	bcan_hdl_t	hdl,
		uint8_t *	rx_err,
		uint8_t *	tx_err
	)

bcan_get_err_msg()

const char* bcan_get_err_msg

(

int

err_code

)

bcan_get_libversion()

const char* bcan_get_libversion

(

void

)

bcan_get_status()

int bcan_get_status

(

bcan_hdl_t

hdl

)

bcan_id_add()

int bcan_id_add	(	bcan_hdl_t	hdl,
		uint32_t	id_start,
		uint32_t	id_end
	)

bcan_id_add_all()

int bcan_id_add_all

(

bcan_hdl_t

hdl

)

bcan_id_remove()

int bcan_id_remove	(	bcan_hdl_t	hdl,
		uint32_t	id_start,
		uint32_t	id_end
	)

bcan_id_remove_all()

int bcan_id_remove_all

(

bcan_hdl_t

hdl

)

bcan_open()

int bcan_open	(	uint32_t	dev_index,
		uint32_t	flags,
		uint64_t	tx_to,
		uint64_t	rx_to,
		bcan_hdl_t *	hdl
	)

bcan_recv()

int bcan_recv	(	bcan_hdl_t	hdl,
		bcan_msg_t *	buf,
		uint32_t	num_msg
	)

bcan_send()

int bcan_send	(	bcan_hdl_t	hdl,
		bcan_msg_t *	buf,
		uint32_t	num_msg
	)

bcan_send_hi_pri()

int bcan_send_hi_pri	(	bcan_hdl_t	hdl,
		bcan_msg_t *	buf
	)

bcan_set_baudrate()

int bcan_set_baudrate	(	bcan_hdl_t	hdl,
		uint32_t	rate
	)

bcan_set_loopback()

int bcan_set_loopback

(

bcan_hdl_t

hdl

)

bcan_start()

int bcan_start

(

bcan_hdl_t

hdl

)

bcan_stop()

int bcan_stop

(

bcan_hdl_t

hdl

)

bcan_unset_loopback()

int bcan_unset_loopback

(

bcan_hdl_t

hdl

)