foxBMS - Unit Tests  1.4.1
The foxBMS Unit Tests API Documentation
can_cfg_tx_boot-message.c File Reference

Driver for the CAN module. More...

#include "can_cfg_tx_boot-message.h"
#include "version_cfg.h"
#include "HL_het.h"
#include "HL_reg_system.h"
#include "can.h"
#include "can_cfg_tx-message-definitions.h"
#include "can_helper.h"
#include "database.h"
#include "foxmath.h"
#include "ftask.h"
Include dependency graph for can_cfg_tx_boot-message.c:

Go to the source code of this file.

Macros

#define CANTX_BOOT_MESSAGE_MAXIMUM_RELEASE_DISTANCE   (31u)
 
#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_VERSION_CONTROL   (0u)
 
#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DIRTY_FLAG   (1u)
 
#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_OVERFLOW_FLAG   (2u)
 
#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_COUNTER   (3u)
 

Functions

STD_RETURN_TYPE_e CANTX_TransmitBootMessage (void)
 Transmit startup boot message. More...
 
STD_RETURN_TYPE_e CANTX_TransmitDieId (void)
 Transmit chip id. More...
 

Detailed Description

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
2022-10-27 (date of last update)
Version
v1.4.1
Prefix
CANTX

Implementation of the CAN Interrupts, initialization, buffers, receive and transmit interfaces.

Definition in file can_cfg_tx_boot-message.c.

Macro Definition Documentation

◆ CANTX_BOOT_MESSAGE_BYTE_3_BIT_DIRTY_FLAG

#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DIRTY_FLAG   (1u)

bit position of boot message byte 3 dirty flag

Definition at line 83 of file can_cfg_tx_boot-message.c.

◆ CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_COUNTER

#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_COUNTER   (3u)

bit position of boot message byte 3 release distance counter

Definition at line 89 of file can_cfg_tx_boot-message.c.

◆ CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_OVERFLOW_FLAG

#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_DISTANCE_OVERFLOW_FLAG   (2u)

bit position of boot message byte 3 release distance overflow flag

Definition at line 86 of file can_cfg_tx_boot-message.c.

◆ CANTX_BOOT_MESSAGE_BYTE_3_BIT_VERSION_CONTROL

#define CANTX_BOOT_MESSAGE_BYTE_3_BIT_VERSION_CONTROL   (0u)

bit position of boot message byte 3 version control flag

Definition at line 80 of file can_cfg_tx_boot-message.c.

◆ CANTX_BOOT_MESSAGE_MAXIMUM_RELEASE_DISTANCE

#define CANTX_BOOT_MESSAGE_MAXIMUM_RELEASE_DISTANCE   (31u)

maximum distance from release that can be encoded in the boot message

Definition at line 74 of file can_cfg_tx_boot-message.c.

Function Documentation

◆ CANTX_TransmitBootMessage()

STD_RETURN_TYPE_e CANTX_TransmitBootMessage ( void  )

Transmit startup boot message.

Returns
STD_OK if transmission successful, otherwise STD_NOT_OK

Definition at line 101 of file can_cfg_tx_boot-message.c.

Here is the call graph for this function:

◆ CANTX_TransmitDieId()

STD_RETURN_TYPE_e CANTX_TransmitDieId ( void  )

Transmit chip id.

Returns
STD_OK if transmission successful, otherwise STD_NOT_OK

Definition at line 149 of file can_cfg_tx_boot-message.c.

Here is the call graph for this function: