foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
can_cbs_rx_misc.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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_misc.c
44  * @author foxBMS Team
45  * @date 2021-04-20 (date of creation)
46  * @updated 2021-07-29 (date of last update)
47  * @ingroup DRIVER
48  * @prefix CAN
49  *
50  * @brief CAN driver Rx callback implementation
51  * @details CAN Rx callback for miscellanous messages
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "can_cbs.h"
56 #include "can_helper.h"
57 #include "diag.h"
58 
59 /*========== Macros and Definitions =========================================*/
60 
61 /*========== Static Constant and Variable Definitions =======================*/
62 
63 /*========== Extern Constant and Variable Definitions =======================*/
64 
65 /*========== Static Function Prototypes =====================================*/
66 
67 /*========== Static Function Implementations ================================*/
68 
69 /*========== Extern Function Implementations ================================*/
70 extern uint32_t CAN_RxSwReset(
71  uint32_t id,
72  uint8_t dlc,
73  CAN_ENDIANNESS_e endianness,
74  uint8_t *pCanData,
75  uint8_t *pMuxId,
76  const CAN_SHIM_s *const kpkCanShim) {
77  /* pMuxId is not used here, therefore has to be NULL_PTR */
78  FAS_ASSERT(pMuxId == NULL_PTR);
79  /* This handler is only implemented for little endian */
80  FAS_ASSERT(endianness == CAN_LITTLE_ENDIAN);
81 
82  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
83  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
84  FAS_ASSERT(pCanData != NULL_PTR);
85  FAS_ASSERT(kpkCanShim != NULL_PTR);
86  return 0;
87 }
88 
89 extern uint32_t CAN_RxDebug(
90  uint32_t id,
91  uint8_t dlc,
92  CAN_ENDIANNESS_e endianness,
93  uint8_t *pCanData,
94  uint8_t *pMuxId,
95  const CAN_SHIM_s *const kpkCanShim) {
96  /* pMuxId is not used here, therefore has to be NULL_PTR */
97  FAS_ASSERT(pMuxId == NULL_PTR);
98 
99  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
100  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
101  FAS_ASSERT(pCanData != NULL_PTR);
102  FAS_ASSERT(kpkCanShim != NULL_PTR);
103 
104  uint64_t message = 0;
105  uint64_t signalData = 0;
106 
107  CAN_RxGetMessageDataFromCanData(&message, pCanData, endianness);
108 
109  uint64_t bitStart = 0;
110  uint8_t bitLength = 8;
111  CAN_RxGetSignalDataFromMessageData(message, bitStart, bitLength, &signalData, endianness);
112 
113  switch ((uint8_t)signalData) {
114  case 0xAA:
115  for (uint8_t s = 0u; s < BS_NR_OF_STRINGS; s++) {
117  }
118  break;
119  default:
120  /* no relevant message received -- nothing to do */
121  break;
122  }
123  return 0;
124 }
125 
126 extern uint32_t CAN_RxSwVersion(
127  uint32_t id,
128  uint8_t dlc,
129  CAN_ENDIANNESS_e endianness,
130  uint8_t *pCanData,
131  uint8_t *pMuxId,
132  const CAN_SHIM_s *const kpkCanShim) {
133  /* pMuxId is not used here, therefore has to be NULL_PTR */
134  FAS_ASSERT(pMuxId == NULL_PTR);
135  /* This handler is only implemented for little endian */
136  FAS_ASSERT(endianness == CAN_LITTLE_ENDIAN);
137 
138  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
139  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
140  FAS_ASSERT(pCanData != NULL_PTR);
141  FAS_ASSERT(kpkCanShim != NULL_PTR);
142  return 0;
143 }
144 
145 /*========== Externalized Static Function Implementations (Unit Test) =======*/
146 #ifdef UNITY_UNIT_TEST
147 
148 #endif
#define BS_NR_OF_STRINGS
CAN callbacks header.
uint32_t CAN_RxSwVersion(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW version
uint32_t CAN_RxSwReset(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW reset
uint32_t CAN_RxDebug(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for debug messages
@ CAN_LITTLE_ENDIAN
Definition: can_cfg.h:289
#define CAN_MAX_11BIT_ID
Definition: can_cfg.h:68
enum CAN_ENDIANNESS CAN_ENDIANNESS_e
#define CAN_MAX_DLC
Definition: can_cfg.h:70
void CAN_RxGetMessageDataFromCanData(uint64_t *pMessage, const uint8_t *const kpkCanData, CAN_ENDIANNESS_e endianness)
Copy CAN data from 8 bytes to a 64-bit variable.
Definition: can_helper.c:288
void CAN_RxGetSignalDataFromMessageData(uint64_t message, uint64_t bitStart, uint8_t bitLength, uint64_t *pCanSignal, CAN_ENDIANNESS_e endianness)
Gets CAN signal data from a 64-bit variable. This function is used to get signal data from a 64-bit C...
Definition: can_helper.c:248
Headers for the helper functions for the CAN module.
DIAG_RETURNTYPE_e DIAG_Handler(DIAG_ID_e diag_id, DIAG_EVENT_e event, DIAG_IMPACT_LEVEL_e impact, uint32_t data)
DIAG_Handler provides generic error handling, based on diagnosis group.
Definition: diag.c:226
Diagnosis driver header.
@ DIAG_STRING
Definition: diag_cfg.h:248
@ DIAG_EVENT_OK
Definition: diag_cfg.h:234
@ DIAG_ID_DEEP_DISCHARGE_DETECTED
Definition: diag_cfg.h:208
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66