foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
can.h File Reference

Header for the driver for the CAN module. More...

#include "general.h"
#include "can_cfg.h"
#include "HL_can.h"
Include dependency graph for can.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CAN_RX_BUFFER
 
struct  CAN_STATE
 

Macros

#define CAN0_NODE   (canREG1)
 
#define CAN_NR_OF_TX_MESSAGE_BOX   (32U)
 
#define CAN0_RX_BUFFER_LENGTH   (32U)
 
#define CAN_TICK_MS   (10U)
 

Typedefs

typedef struct CAN_RX_BUFFER CAN_RX_BUFFER_s
 
typedef struct CAN_STATE CAN_STATE_s
 

Functions

STD_RETURN_TYPE_e CAN_DataSend (canBASE_t *pNode, uint32_t id, uint8 *pData)
 Sends over CAN the data passed in parameters. This function goes over the messageboxes and marks the ones that should be sent. More...
 
void CAN_MainFunction (void)
 Calls the functions to drive the CAN interface. Makes the CAN timing checks and sends the periodic messages. More...
 
void CAN_ReadRxBuffer (void)
 Checks the data received per CAN. A receive buffer is used because CAN frames are received in an interrupt routine. The TMS570LC4357 does not allow nested interrupts, so interrupts are deactivated during receive. Calls to the database do not work when interrupts are disabled. Receive callbacks are made within this function: as it is not called during an interrupt routine, calls to the database can be made. More...
 
void CAN_Initialize (void)
 Enables the CAN transceiver.. This function sets th pins to enable the CAN transceiver. It must be called before using the CAN interface. More...
 
void CAN_EnablePeriodic (bool command)
 Enables periodic sending per CAN. This is used to prevent sending uninitialized data per CAN (e.g., before the first LTC measurement cycle was completed). More...
 
bool CAN_IsCurrentSensorPresent (uint8_t stringNumber)
 set flag for presence of current sensor. More...
 
bool CAN_IsCurrentSensorCcPresent (uint8_t stringNumber)
 get flag if CC message from current sensor is received. More...
 
bool CAN_IsCurrentSensorEcPresent (uint8_t stringNumber)
 get flag if EC message from current sensor is received More...
 
STD_RETURN_TYPE_e CAN_TransmitBootMessage (void)
 Transmit startup boot message. More...
 

Detailed Description

Header for the driver for the CAN module.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2019-12-04 (date of creation)
Updated
2021-07-23 (date of last update)
Prefix
CAN

Provides the interfaces for initialization, receive and transmit handling

Definition in file can.h.

Macro Definition Documentation

◆ CAN0_NODE

#define CAN0_NODE   (canREG1)

register on which the CAN interface is connected

Definition at line 70 of file can.h.

◆ CAN0_RX_BUFFER_LENGTH

#define CAN0_RX_BUFFER_LENGTH   (32U)

length of the RX buffer

Definition at line 78 of file can.h.

◆ CAN_NR_OF_TX_MESSAGE_BOX

#define CAN_NR_OF_TX_MESSAGE_BOX   (32U)

Half of the 64 messageboxes are defined for TX This is used to determined in the CAN interrupt routine if TX or RX case

Definition at line 75 of file can.h.

◆ CAN_TICK_MS

#define CAN_TICK_MS   (10U)

Task time slot where the CAN TX function is called. Repetition time of periodic CAN messages must be multiple of this (e.g., 1u, 10u or 100u)

Definition at line 83 of file can.h.

Typedef Documentation

◆ CAN_RX_BUFFER_s

Buffer containing all the CAN RX elements

◆ CAN_STATE_s

typedef struct CAN_STATE CAN_STATE_s

This structure contains variables relevant for the CAN signal module.

Function Documentation

◆ CAN_DataSend()

STD_RETURN_TYPE_e CAN_DataSend ( canBASE_t *  pNode,
uint32_t  id,
uint8 *  pData 
)

Sends over CAN the data passed in parameters. This function goes over the messageboxes and marks the ones that should be sent.

Parameters
[in,out]pNodeCAN interface to use
[in]idID of message to send
[out]pDatadata to send (8 bytes)
Returns
STD_OK if a message box was free to send, STD_NOT_OK otherwise

Parse all TX message boxes until we find a free one, then use it to send the CAN message. In the HAL, message box numbers start from 1, not 0.

Definition at line 211 of file can.c.

◆ CAN_EnablePeriodic()

void CAN_EnablePeriodic ( bool  command)

Enables periodic sending per CAN. This is used to prevent sending uninitialized data per CAN (e.g., before the first LTC measurement cycle was completed).

Enables periodic sending per CAN. This is used to prevent sending uninitialized data per CAN (e.g., before the first LTC measurement cycle was completed).

Definition at line 374 of file can.c.

◆ CAN_Initialize()

void CAN_Initialize ( void  )

Enables the CAN transceiver.. This function sets th pins to enable the CAN transceiver. It must be called before using the CAN interface.

Definition at line 207 of file can.c.

Here is the call graph for this function:

◆ CAN_IsCurrentSensorCcPresent()

bool CAN_IsCurrentSensorCcPresent ( uint8_t  stringNumber)

get flag if CC message from current sensor is received.

Parameters
stringNumberaddressed string
Returns
true if CC message is being received, false otherwise

Definition at line 425 of file can.c.

◆ CAN_IsCurrentSensorEcPresent()

bool CAN_IsCurrentSensorEcPresent ( uint8_t  stringNumber)

get flag if EC message from current sensor is received

Parameters
stringNumberaddressed string
Returns
true if EC message is being received, false otherwise

Definition at line 430 of file can.c.

◆ CAN_IsCurrentSensorPresent()

bool CAN_IsCurrentSensorPresent ( uint8_t  stringNumber)

set flag for presence of current sensor.

Returns
retval true if a current sensor is present, false otherwise

Definition at line 420 of file can.c.

◆ CAN_MainFunction()

void CAN_MainFunction ( void  )

Calls the functions to drive the CAN interface. Makes the CAN timing checks and sends the periodic messages.

Definition at line 237 of file can.c.

Here is the call graph for this function:

◆ CAN_ReadRxBuffer()

void CAN_ReadRxBuffer ( void  )

Checks the data received per CAN. A receive buffer is used because CAN frames are received in an interrupt routine. The TMS570LC4357 does not allow nested interrupts, so interrupts are deactivated during receive. Calls to the database do not work when interrupts are disabled. Receive callbacks are made within this function: as it is not called during an interrupt routine, calls to the database can be made.

Definition at line 349 of file can.c.

◆ CAN_TransmitBootMessage()

STD_RETURN_TYPE_e CAN_TransmitBootMessage ( void  )

Transmit startup boot message.

Returns
STD_OK if transmission successful, otherweise STD_NOT_OK

Definition at line 481 of file can.c.

Here is the call graph for this function: