foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
can_cbs_rx.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file can_cbs_rx.h
44  * @author foxBMS Team
45  * @date 2021-04-20 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup DRIVER
49  * @prefix CANRX
50  *
51  * @brief CAN callbacks header
52  *
53  */
54 
55 #ifndef FOXBMS__CAN_CBS_RX_H_
56 #define FOXBMS__CAN_CBS_RX_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 #include "can_cfg.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /*========== Extern Function Prototypes =====================================*/
68 
69 /** RX callback functions @{ */
70 /**
71  * @brief can rx callback function for IMD info messages
72  * @param[in] message contains the message ID, DLC and endianness
73  * @param[in] kpkCanData payload of can frame
74  * @param[in] kpkCanShim shim to the database entries
75  */
76 extern uint32_t CANRX_ImdInfo(
77  CAN_MESSAGE_PROPERTIES_s message,
78  const uint8_t *const kpkCanData,
79  const CAN_SHIM_s *const kpkCanShim);
80 /**
81  * @brief can rx callback function for IMD response messages
82  * @param[in] message contains the message ID, DLC and endianness
83  * @param[in] kpkCanData payload of can frame
84  * @param[in] kpkCanShim shim to the database entries
85  */
86 extern uint32_t CANRX_ImdResponse(
87  CAN_MESSAGE_PROPERTIES_s message,
88  const uint8_t *const kpkCanData,
89  const CAN_SHIM_s *const kpkCanShim);
90 /**
91  * @brief can rx callback function for state requests
92  * @param[in] message contains the message ID, DLC and endianness
93  * @param[in] kpkCanData payload of can frame
94  * @param[in] kpkCanShim shim to the database entries
95  */
96 extern uint32_t CANRX_BmsStateRequest(
97  CAN_MESSAGE_PROPERTIES_s message,
98  const uint8_t *const kpkCanData,
99  const CAN_SHIM_s *const kpkCanShim);
100 /**
101  * @brief can rx callback function for SW reset
102  * @param[in] message contains the message ID, DLC and endianness
103  * @param[in] kpkCanData payload of can frame
104  * @param[in] kpkCanShim shim to the database entries
105  */
106 extern uint32_t CANRX_SoftwareReset(
107  CAN_MESSAGE_PROPERTIES_s message,
108  const uint8_t *const kpkCanData,
109  const CAN_SHIM_s *const kpkCanShim);
110 /**
111  * @brief can rx callback function for current sensor measurements
112  * @param[in] message contains the message ID, DLC and endianness
113  * @param[in] kpkCanData payload of can frame
114  * @param[in] kpkCanShim shim to the database entries
115  */
116 extern uint32_t CANRX_CurrentSensor(
117  CAN_MESSAGE_PROPERTIES_s message,
118  const uint8_t *const kpkCanData,
119  const CAN_SHIM_s *const kpkCanShim);
120 /**
121  * @brief can rx callback function for debug messages
122  * @param[in] message contains the message ID, DLC and endianness
123  * @param[in] kpkCanData payload of can frame
124  * @param[in] kpkCanShim shim to the database entries
125  */
126 extern uint32_t CANRX_Debug(
127  CAN_MESSAGE_PROPERTIES_s message,
128  const uint8_t *const kpkCanData,
129  const CAN_SHIM_s *const kpkCanShim);
130 /**
131  * @brief can rx callback function for SW version
132  * @param[in] message contains the message ID, DLC and endianness
133  * @param[in] kpkCanData payload of can frame
134  * @param[in] kpkCanShim shim to the database entries
135  */
136 extern uint32_t CANRX_SoftwareVersion(
137  CAN_MESSAGE_PROPERTIES_s message,
138  const uint8_t *const kpkCanData,
139  const CAN_SHIM_s *const kpkCanShim);
140 /** @} */
141 
142 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
143 #ifdef UNITY_UNIT_TEST
144 
145 #endif
146 
147 #endif /* FOXBMS__CAN_CBS_RX_H_ */
CANRX_ImdResponse
uint32_t CANRX_ImdResponse(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for IMD response messages
Definition: can_cbs_rx_imd.c:96
CANRX_SoftwareReset
uint32_t CANRX_SoftwareReset(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW reset
Definition: can_cbs_rx_misc.c:72
CANRX_SoftwareVersion
uint32_t CANRX_SoftwareVersion(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW version
Definition: can_cbs_rx_misc.c:116
CANRX_Debug
uint32_t CANRX_Debug(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for debug messages
Definition: can_cbs_rx_misc.c:85
CANRX_CurrentSensor
uint32_t CANRX_CurrentSensor(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for current sensor measurements
Definition: can_cbs_rx_current-sensor.c:80
CANRX_BmsStateRequest
uint32_t CANRX_BmsStateRequest(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for state requests
Definition: can_cbs_rx_state-request.c:186
CANRX_ImdInfo
uint32_t CANRX_ImdInfo(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for IMD info messages
Definition: can_cbs_rx_imd.c:72
can_cfg.h
Headers for the configuration for the CAN module.
general.h
General macros and definitions for the whole platform.
CAN_MESSAGE_PROPERTIES_s
Definition: can_cfg.h:178
CAN_SHIM_s
Definition: can_cfg.h:159