foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
can_cfg_tx_boot-message.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_cfg_tx_boot-message.h
44  * @author foxBMS Team
45  * @date 2022-07-01 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup SOME_GROUP
49  * @prefix CANTX
50  *
51  * @brief Header file of some software
52  *
53  */
54 
55 #ifndef FOXBMS__CAN_CFG_TX_BOOT_MESSAGE_H_
56 #define FOXBMS__CAN_CFG_TX_BOOT_MESSAGE_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Extern Constant and Variable Declarations ======================*/
64 
65 /*========== Extern Function Prototypes =====================================*/
66 /**
67  * @brief Transmit startup boot message
68  * @return #STD_OK if transmission successful, otherwise #STD_NOT_OK
69  */
70 extern STD_RETURN_TYPE_e CANTX_TransmitBootMessage(void);
71 
72 /**
73  * @brief Transmit chip id
74  * @return #STD_OK if transmission successful, otherwise #STD_NOT_OK
75  */
76 extern STD_RETURN_TYPE_e CANTX_TransmitDieId(void);
77 
78 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
79 
80 #endif /* FOXBMS__CAN_CFG_TX_BOOT_MESSAGE_H_ */
CANTX_TransmitDieId
STD_RETURN_TYPE_e CANTX_TransmitDieId(void)
Transmit chip id.
Definition: can_cfg_tx_boot-message.c:149
CANTX_TransmitBootMessage
STD_RETURN_TYPE_e CANTX_TransmitBootMessage(void)
Transmit startup boot message.
Definition: can_cfg_tx_boot-message.c:101
STD_RETURN_TYPE_e
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
general.h
General macros and definitions for the whole platform.