can.c File Reference

CAN general purpose interface code. More...

#include <string.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <net/if.h>
#include "include/linux/can.h"
#include "include/linux/can/raw.h"
#include "bbbandroidHAL.h"

Macros
#define	PF_CAN   29
#define	AF_CAN   PF_CAN

Functions
int	canOpenSocket (const int socket_type, const int protocol)
int	canOpenRaw (const char *port)
unsigned char *	canReadBytes (const int fd, int *length)
int	canSendBytes (const int canFD, const int no_bytes, const uint8_t data[])
void	canClose (const int canFD)

Detailed Description

CAN general purpose interface code.

Author

Ankur Yadav (ankur.nosp@m.ayad.nosp@m.av@gm.nosp@m.ail..nosp@m.com)

Macro Definition Documentation

#define AF_CAN   PF_CAN

AF_CAN macro defination which was missing from can.h

#define PF_CAN   29

PF_CAN macro defination which was missing from can.h

Function Documentation

void canClose

(

const int

canFD

)

This function is used to close CAN file descriptor.

Parameters

canFD

a constant integer argument.

int canOpenRaw

(

const char *

port

)

This function takes port string as input and opens socket using canOpenSocket(), locates interface using ioctl() system call then binds the socket with CAN interface and returns the file descriptor.

Parameters

port	a constant character pointer argument.

See Also

canOpenSocket()

Returns

If successful then CAN file descriptor after opening socket is returned and if it fails then -1 is returned.

int canOpenSocket	(	const int	socket_type,
		const int	protocol
	)

This function takes socket_type and protocol as input and opens socket of that type and protocol and then returns file descriptor.

Parameters

socket_type	a constant integer argument.
protocol	a constant integer argument.

Returns

If successful then CAN file descriptor after opening socket is returned and if it fails then -1 is returned.

unsigned char* canReadBytes	(	const int	fd,
		int *	length
	)

This functions takes file descriptor and length of data to be read as input and returns the pointer to the array of data bytes read. If no data is read then NULL pointer is returned.

Parameters

fd	a constant integer argument.
length	a integer pointer argument.

Returns

The pointer to the array of data bytes read. If no data is read then NULL pointer is returned.

int canSendBytes	(	const int	canFD,
		const int	no_bytes,
		const uint8_t	data[]
	)

This function takes can file descriptor, number of bytes and array of data to be transferred as input and writes given number of bytes of data from data buffer.

Parameters

canFD	a constant integer argument.
no_bytes	a constant unsigned integer argument.
data	array of constant uint8_t argument.

Returns

number of bytes successfully written to CAN device.