VLCB SDK
An opinionated SDK for VLCB protocol
Loading...
Searching...
No Matches
can.h File Reference
#include <inttypes.h>
#include <stdbool.h>
#include <stdint.h>
#include "vlcb_defs.h"
Include dependency graph for common/inc/vlcb/common/can.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define VLCB_CAN_PRIO_DEFAULT   VLCB_CAN_PRIO_NORMAL
 

Typedefs

typedef uint8_t VlcbCanId
 
typedef uint8_t VlcbCanPriority
 

Enumerations

enum  VlcbCanPriority {
  VLCB_CAN_PRIO_SELF_ENUM = 0x0 , VLCB_CAN_PRIO_HIGH = 0x4 , VLCB_CAN_PRIO_ABOVE = 0x5 , VLCB_CAN_PRIO_NORMAL = 0x6 ,
  VLCB_CAN_PRIO_LOW = 0x7 , VLCB_CAN_PRIO_LOWEST = 0xF
}
 

Functions

int vlcb_defs_NewCanId (uint8_t value, VlcbCanId *const id)
 
bool vlcb_defs_IsCanIdValid (VlcbCanId id)
 
bool vlcb_defs_IsCanPriorityValid (VlcbCanPriority prio)
 
VlcbCanPriority vlcb_defs_CanPriorityFromOpcode (VlcbOpCode opc)
 
int vlcb_defs_CanPriorityFromByte (uint8_t val, VlcbCanPriority *const prio)
 

Macro Definition Documentation

◆ VLCB_CAN_PRIO_DEFAULT

#define VLCB_CAN_PRIO_DEFAULT   VLCB_CAN_PRIO_NORMAL

Definition at line 24 of file common/inc/vlcb/common/can.h.

Typedef Documentation

◆ VlcbCanId

typedef uint8_t VlcbCanId

Definition at line 9 of file common/inc/vlcb/common/can.h.

◆ VlcbCanPriority

typedef uint8_t VlcbCanPriority

Definition at line 14 of file common/inc/vlcb/common/can.h.

Enumeration Type Documentation

◆ VlcbCanPriority

Enumerator
VLCB_CAN_PRIO_SELF_ENUM 
VLCB_CAN_PRIO_HIGH 
VLCB_CAN_PRIO_ABOVE 
VLCB_CAN_PRIO_NORMAL 
VLCB_CAN_PRIO_LOW 
VLCB_CAN_PRIO_LOWEST 

Definition at line 15 of file common/inc/vlcb/common/can.h.

Function Documentation

◆ vlcb_defs_CanPriorityFromByte()

int vlcb_defs_CanPriorityFromByte ( uint8_t val,
VlcbCanPriority *const prio )

Definition at line 6 of file can_prio_from_byte.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ vlcb_defs_CanPriorityFromOpcode()

VlcbCanPriority vlcb_defs_CanPriorityFromOpcode ( VlcbOpCode opc)

Definition at line 5 of file can_prio_from_opc.c.

Here is the caller graph for this function:

◆ vlcb_defs_IsCanIdValid()

bool vlcb_defs_IsCanIdValid ( VlcbCanId id)

Definition at line 5 of file can_id_is_valid.c.

Here is the caller graph for this function:

◆ vlcb_defs_IsCanPriorityValid()

bool vlcb_defs_IsCanPriorityValid ( VlcbCanPriority prio)

Definition at line 5 of file can_is_prio_valid.c.

Here is the caller graph for this function:

◆ vlcb_defs_NewCanId()

int vlcb_defs_NewCanId ( uint8_t value,
VlcbCanId *const id )

Definition at line 6 of file can_id_new.c.

Here is the call graph for this function:
Here is the caller graph for this function: