foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
can_cbs_tx_debug-unsupported-multiplexer-values.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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_tx_debug-unsupported-multiplexer-values.c
44  * @author foxBMS Team
45  * @date 2022-11-16 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVER
49  * @prefix CANTX
50  *
51  * @brief CAN
52  * @details CAN Tx callback for unsupported requests
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "general.h"
57 
59 
60 #include "can.h"
62 #include "can_helper.h"
63 
64 #include <stdint.h>
65 
66 /*========== Macros and Definitions =========================================*/
67 #define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MESSAGE_ID_START_BIT (0u)
68 #define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MESSAGE_ID_LENGTH (16u)
69 #define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MULTIPLEXER_VALUE_START_BIT (16u)
70 #define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MULTIPLEXER_VALUE_LENGTH (16u)
71 
72 /*========== Static Constant and Variable Definitions =======================*/
73 
74 /*========== Extern Constant and Variable Definitions =======================*/
75 
76 /*========== Static Function Prototypes =====================================*/
77 
78 /*========== Static Function Implementations ================================*/
79 
80 /*========== Extern Function Implementations ================================*/
81 
82 extern void CANTX_UnsupportedMultiplexerValue(uint32_t messageId, uint32_t multiplexerValue) {
83  /* AXIVION Routine Generic-MissingParameterAssert: messageId: parameter accept whole range */
84  /* AXIVION Routine Generic-MissingParameterAssert: multiplexerValue: parameter accept whole range */
85  uint8_t data[] = {GEN_REPEAT_U(0u, GEN_STRIP(CAN_MAX_DLC))};
86  uint64_t message = 0u;
88  &message,
91  messageId,
94  &message,
97  multiplexerValue,
100  (void)CAN_DataSend(
104  &data[0]);
105 }
106 
107 /*========== Externalized Static Function Implementations (Unit Test) =======*/
108 #ifdef UNITY_UNIT_TEST
109 #endif
STD_RETURN_TYPE_e CAN_DataSend(CAN_NODE_s *pNode, uint32_t id, CAN_IDENTIFIER_TYPE_e idType, uint8 *pData)
Sends over CAN the data passed in parameters. This function goes over the message boxes and marks the...
Definition: can.c:923
Header for the driver for the CAN module.
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MULTIPLEXER_VALUE_LENGTH
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MULTIPLEXER_VALUE_START_BIT
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MESSAGE_ID_LENGTH
void CANTX_UnsupportedMultiplexerValue(uint32_t messageId, uint32_t multiplexerValue)
Function to generically handle multiplexer values that are not supported in a message.
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_MESSAGE_SIGNAL_MESSAGE_ID_START_BIT
@ CAN_BIG_ENDIAN
Definition: can_cfg.h:158
#define CAN_NODE_DEBUG_MESSAGE
Definition: can_cfg.h:83
#define CAN_MAX_DLC
Definition: can_cfg.h:101
Header for the driver for the CAN module.
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_ID
#define CANTX_UNSUPPORTED_MULTIPLEXER_IDENTIFIER
void CAN_TxSetMessageDataWithSignalData(uint64_t *pMessage, uint64_t bitStart, uint8_t bitLength, uint64_t canSignal, CAN_ENDIANNESS_e endianness)
Puts CAN signal data in a 64-bit variable. This function is used to compose a 64-bit CAN message....
Definition: can_helper.c:173
void CAN_TxSetCanDataWithMessageData(uint64_t message, uint8_t *pCanData, CAN_ENDIANNESS_e endianness)
Copy CAN data from a 64-bit variable to 8 bytes. This function is used to copy a 64-bit CAN message t...
Definition: can_helper.c:212
Headers for the helper functions for the CAN module.
General macros and definitions for the whole platform.
#define GEN_REPEAT_U(x, n)
Macro that helps to generate a series of literals (for array initializers).
Definition: general.h:250
#define GEN_STRIP(x)
Definition: general.h:261