foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
version_cfg.h File Reference

Header file for the version information that is generated by the toolchain. More...

#include "general.h"
Include dependency graph for version_cfg.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VERSION
 

Macros

#define VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH   (128u)
 
#define VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH   (9u)
 
#define VERSION_INFORMATION   __attribute__((section(".versionInformation")))
 

Typedefs

typedef struct VERSION VERSION_s
 

Variables

const VERSION_s foxbmsVersionInfo
 

Detailed Description

Header file for the version information that is generated by the toolchain.

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
2021-07-14 (date of creation)
Updated
2021-07-15 (date of last update)
Prefix
NONE

Definition in file version_cfg.h.

Macro Definition Documentation

◆ VERSION_INFORMATION

#define VERSION_INFORMATION   __attribute__((section(".versionInformation")))

macro for an attribute that tells the linker script where to place the version information

Definition at line 74 of file version_cfg.h.

◆ VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH

#define VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH   (9u)

maximum length of the string VERSION_s::commitHash

Has to be in line with the value in f_ti_arm_cgt.py!

Definition at line 71 of file version_cfg.h.

◆ VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH

#define VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH   (128u)

maximum length of the string VERSION_s::gitRemote

Has to be in line with the value in f_ti_arm_cgt.py!

Definition at line 65 of file version_cfg.h.

Typedef Documentation

◆ VERSION_s

typedef struct VERSION VERSION_s

struct type that describes the version information of the system

Variable Documentation

◆ foxbmsVersionInfo

const VERSION_s foxbmsVersionInfo
extern

version information of the system