can_cbs_tx_debug-response.h File Reference

Declarations for handling the transmit of debug response messages. More...

#include "fstd_types.h"
#include <stdint.h>

Include dependency graph for can_cbs_tx_debug-response.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	CANTX_DEBUG_RESPONSE_ACTIONS_e {   CANTX_DEBUG_RESPONSE_TRANSMIT_BMS_VERSION_INFO , CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_UNIQUE_DIE_ID , CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_LOT_NUMBER , CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_WAFER_INFORMATION ,   CANTX_DEBUG_RESPONSE_TRANSMIT_BOOT_MAGIC_START , CANTX_DEBUG_RESPONSE_TRANSMIT_BOOT_MAGIC_END , CANTX_DEBUG_RESPONSE_TRANSMIT_RTC_TIME , CANTX_DEBUG_RESPONSE_TRANSMIT_COMMIT_HASH }

Functions
STD_RETURN_TYPE_e	CANTX_DebugResponse (CANTX_DEBUG_RESPONSE_ACTIONS_e action)
	Handles Debug response message. More...

Detailed Description

Declarations for handling the transmit of debug response messages.

Copyright

© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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

2022-07-01 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

CANTX

This header declares the interface for transmitting debug response messages and everything else that is externally required to be able to use that interface.

Definition in file can_cbs_tx_debug-response.h.

Enumeration Type Documentation

CANTX_DEBUG_RESPONSE_ACTIONS_e

enum CANTX_DEBUG_RESPONSE_ACTIONS_e

defines which action is performed when CANTX_DebugResponse is called

Enumerator
CANTX_DEBUG_RESPONSE_TRANSMIT_BMS_VERSION_INFO
CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_UNIQUE_DIE_ID
CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_LOT_NUMBER
CANTX_DEBUG_RESPONSE_TRANSMIT_MCU_WAFER_INFORMATION
CANTX_DEBUG_RESPONSE_TRANSMIT_BOOT_MAGIC_START
CANTX_DEBUG_RESPONSE_TRANSMIT_BOOT_MAGIC_END
CANTX_DEBUG_RESPONSE_TRANSMIT_RTC_TIME
CANTX_DEBUG_RESPONSE_TRANSMIT_COMMIT_HASH

Definition at line 68 of file can_cbs_tx_debug-response.h.

Function Documentation

CANTX_DebugResponse()

STD_RETURN_TYPE_e CANTX_DebugResponse

(

CANTX_DEBUG_RESPONSE_ACTIONS_e

action

)

Handles Debug response message.

Parameters

action

type of information that should be sent

Returns

STD_OK if transmission successful, otherwise STD_NOT_OK

Definition at line 618 of file can_cbs_tx_debug-response.c.

Here is the call graph for this function: