caffeine-hal 0.6.6
A Header-Defined Interface c library, it provides the hal layer for the Caffeine framework
Loading...
Searching...
No Matches
Data Structures | Typedefs | Enumerations | Functions
cfn_hal_can.h File Reference

CAN (Controller Area Network) Hardware Abstraction Layer. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures

struct  cfn_hal_can_msg_t
 CAN message structure. More...
 
struct  cfn_hal_can_config_t
 CAN configuration structure. More...
 
struct  cfn_hal_can_phy_t
 CAN hardware physical mapping. More...
 
struct  cfn_hal_can_filter_t
 CAN filter configuration. More...
 
struct  cfn_hal_can_api_s
 CAN Virtual Method Table (VMT). More...
 

Typedefs

typedef struct cfn_hal_can_s cfn_hal_can_t
 
typedef struct cfn_hal_can_api_s cfn_hal_can_api_t
 
typedef void(* cfn_hal_can_callback_t) (cfn_hal_can_t *driver, uint32_t event_mask, uint32_t error_mask, cfn_hal_can_msg_t *msg, void *user_arg)
 CAN callback signature.
 

Enumerations

enum  cfn_hal_can_event_t { CFN_HAL_CAN_EVENT_NONE = 0 , CFN_HAL_CAN_EVENT_TX_COMPLETE = CFN_HAL_BIT(0) , CFN_HAL_CAN_EVENT_RX_READY = CFN_HAL_BIT(1) }
 CAN nominal event flags. More...
 
enum  cfn_hal_can_error_t { CFN_HAL_CAN_ERROR_NONE = 0 , CFN_HAL_CAN_ERROR_BUS_OFF = CFN_HAL_BIT(0) , CFN_HAL_CAN_ERROR_GENERAL = CFN_HAL_BIT(1) }
 CAN exception error flags. More...
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_hal_can_api_s)
 
 CFN_HAL_CREATE_DRIVER_TYPE (can, cfn_hal_can_config_t, cfn_hal_can_api_t, cfn_hal_can_phy_t, cfn_hal_can_callback_t)
 
CFN_HAL_INLINE void cfn_hal_can_populate (cfn_hal_can_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_can_api_t *api, const cfn_hal_can_phy_t *phy, const cfn_hal_can_config_t *config, cfn_hal_can_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_validate (const cfn_hal_can_t *driver, const cfn_hal_can_config_t *config)
 Validates the CAN configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_init (cfn_hal_can_t *driver)
 Initializes the CAN driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_deinit (cfn_hal_can_t *driver)
 Deinitializes the CAN driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_set (cfn_hal_can_t *driver, const cfn_hal_can_config_t *config)
 Sets the CAN configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_get (cfn_hal_can_t *driver, cfn_hal_can_config_t *config)
 Gets the current CAN configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_callback_register (cfn_hal_can_t *driver, const cfn_hal_can_callback_t callback, void *user_arg)
 Registers a callback for CAN events and errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_power_state_set (cfn_hal_can_t *driver, cfn_hal_power_state_t state)
 Sets the CAN power state.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_enable (cfn_hal_can_t *driver, uint32_t event_mask)
 Enables one or more CAN nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_disable (cfn_hal_can_t *driver, uint32_t event_mask)
 Disables one or more CAN nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_get (cfn_hal_can_t *driver, uint32_t *event_mask)
 Retrieves the current CAN nominal event status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_enable (cfn_hal_can_t *driver, uint32_t error_mask)
 Enables one or more CAN exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_disable (cfn_hal_can_t *driver, uint32_t error_mask)
 Disables one or more CAN exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_get (cfn_hal_can_t *driver, uint32_t *error_mask)
 Retrieves the current CAN exception error status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_transmit (cfn_hal_can_t *driver, const cfn_hal_can_msg_t *msg, uint32_t timeout)
 Transmits a CAN message (blocking).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_receive (cfn_hal_can_t *driver, cfn_hal_can_msg_t *msg, uint32_t timeout)
 Receives a CAN message (blocking).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_add_filter (cfn_hal_can_t *driver, const cfn_hal_can_filter_t *filter)
 Adds a message filter to the CAN peripheral.
 
cfn_hal_error_code_t cfn_hal_can_construct (cfn_hal_can_t *driver, const cfn_hal_can_config_t *config, const cfn_hal_can_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_can_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_hal_can_destruct (cfn_hal_can_t *driver)
 

Detailed Description

CAN (Controller Area Network) Hardware Abstraction Layer.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

◆ cfn_hal_can_api_t

◆ cfn_hal_can_callback_t

typedef void(* cfn_hal_can_callback_t) (cfn_hal_can_t *driver, uint32_t event_mask, uint32_t error_mask, cfn_hal_can_msg_t *msg, void *user_arg)

CAN callback signature.

Parameters
driverPointer to the CAN driver instance.
event_maskMask of triggered nominal events.
error_maskMask of triggered exception errors.
msgPointer to the received message (only for RX_READY event).
user_argUser-defined argument passed during registration.

◆ cfn_hal_can_t

typedef struct cfn_hal_can_s cfn_hal_can_t

Enumeration Type Documentation

◆ cfn_hal_can_error_t

CAN exception error flags.

Enumerator
CFN_HAL_CAN_ERROR_NONE 
CFN_HAL_CAN_ERROR_BUS_OFF 

CAN bus-off state detected

CFN_HAL_CAN_ERROR_GENERAL 

General CAN hardware error

◆ cfn_hal_can_event_t

CAN nominal event flags.

Enumerator
CFN_HAL_CAN_EVENT_NONE 
CFN_HAL_CAN_EVENT_TX_COMPLETE 

Transmission complete

CFN_HAL_CAN_EVENT_RX_READY 

Message received and ready

Function Documentation

◆ cfn_hal_can_add_filter()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_add_filter ( cfn_hal_can_t driver,
const cfn_hal_can_filter_t filter 
)

Adds a message filter to the CAN peripheral.

Parameters
driverPointer to the CAN driver instance.
filterPointer to the filter configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_callback_register ( cfn_hal_can_t driver,
const cfn_hal_can_callback_t  callback,
void *  user_arg 
)

Registers a callback for CAN events and errors.

Parameters
driverPointer to the CAN driver instance.
callbackThe callback function to register.
user_argUser-defined argument passed to the callback.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_get ( cfn_hal_can_t driver,
cfn_hal_can_config_t config 
)

Gets the current CAN configuration.

Parameters
driverPointer to the CAN driver instance.
config[out] Pointer to store the configuration.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_set ( cfn_hal_can_t driver,
const cfn_hal_can_config_t config 
)

Sets the CAN configuration.

Parameters
driverPointer to the CAN driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_config_validate ( const cfn_hal_can_t driver,
const cfn_hal_can_config_t config 
)

Validates the CAN configuration.

Parameters
driverPointer to the CAN driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_construct()

cfn_hal_error_code_t cfn_hal_can_construct ( cfn_hal_can_t driver,
const cfn_hal_can_config_t config,
const cfn_hal_can_phy_t phy,
struct cfn_hal_clock_s *  clock,
void *  dependency,
cfn_hal_can_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_can_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_deinit ( cfn_hal_can_t driver)

Deinitializes the CAN driver.

Parameters
driverPointer to the CAN driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_destruct()

cfn_hal_error_code_t cfn_hal_can_destruct ( cfn_hal_can_t driver)

◆ cfn_hal_can_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_disable ( cfn_hal_can_t driver,
uint32_t  error_mask 
)

Disables one or more CAN exception errors.

Parameters
driverPointer to the CAN driver instance.
error_maskMask of errors to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_enable ( cfn_hal_can_t driver,
uint32_t  error_mask 
)

Enables one or more CAN exception errors.

Parameters
driverPointer to the CAN driver instance.
error_maskMask of errors to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_error_get ( cfn_hal_can_t driver,
uint32_t *  error_mask 
)

Retrieves the current CAN exception error status.

Parameters
driverPointer to the CAN driver instance.
error_mask[out] Pointer to store the error mask.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_disable ( cfn_hal_can_t driver,
uint32_t  event_mask 
)

Disables one or more CAN nominal events.

Parameters
driverPointer to the CAN driver instance.
event_maskMask of events to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_enable ( cfn_hal_can_t driver,
uint32_t  event_mask 
)

Enables one or more CAN nominal events.

Parameters
driverPointer to the CAN driver instance.
event_maskMask of events to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_event_get ( cfn_hal_can_t driver,
uint32_t *  event_mask 
)

Retrieves the current CAN nominal event status.

Parameters
driverPointer to the CAN driver instance.
event_mask[out] Pointer to store the event mask.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_init ( cfn_hal_can_t driver)

Initializes the CAN driver.

Parameters
driverPointer to the CAN driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_populate()

CFN_HAL_INLINE void cfn_hal_can_populate ( cfn_hal_can_t driver,
uint32_t  peripheral_id,
struct cfn_hal_clock_s *  clock,
void *  dependency,
const cfn_hal_can_api_t api,
const cfn_hal_can_phy_t phy,
const cfn_hal_can_config_t config,
cfn_hal_can_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_can_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_power_state_set ( cfn_hal_can_t driver,
cfn_hal_power_state_t  state 
)

Sets the CAN power state.

Parameters
driverPointer to the CAN driver instance.
stateTarget power state.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_receive()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_receive ( cfn_hal_can_t driver,
cfn_hal_can_msg_t msg,
uint32_t  timeout 
)

Receives a CAN message (blocking).

Parameters
driverPointer to the CAN driver instance.
msg[out] Pointer to the message structure to store received data.
timeoutTimeout duration in milliseconds.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_can_transmit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_can_transmit ( cfn_hal_can_t driver,
const cfn_hal_can_msg_t msg,
uint32_t  timeout 
)

Transmits a CAN message (blocking).

Parameters
driverPointer to the CAN driver instance.
msgPointer to the message structure to be transmitted.
timeoutTimeout duration in milliseconds.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE ( can  ,
cfn_hal_can_config_t  ,
cfn_hal_can_api_t  ,
cfn_hal_can_phy_t  ,
cfn_hal_can_callback_t   
)

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_hal_can_api_s  )