general.h File Reference

TODO. More...

#include "HL_sys_common.h"
#include "fassert.h"
#include "fstd_types.h"
#include <stdbool.h>
#include <stdint.h>

Include dependency graph for general.h:

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

Go to the source code of this file.

Macros
#define	LARGEST_PIN_NUMBER   (31u)
	largest pin number that exists in TMS570LC4357 More...
#define	SETBIT(register, bit)   ((register) |= (uint32)((uint32)1U << (bit)))
	sets a bit to 1u More...
#define	CLEARBIT(register, bit)   ((register) &= ~(uint32)((uint32)1U << (bit)))
	clears a bit to 0u More...
#define	must_check_return   __attribute__((warn_unused_result))
	Allows functions to generate warnings in GCC for unused returns. More...
#define	always_inline   __attribute__((always_inline))
#define	UNIT_TEST_WEAK_IMPL

Detailed Description

TODO.

Copyright

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

BSD 3-Clause License 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

2019-09-24 (date of creation)

Updated

2021-03-24 (date of last update)

Prefix

NONE

Definition in file general.h.

Macro Definition Documentation

always_inline

#define always_inline   __attribute__((always_inline))

This attribute tells the compiler that the function should always be inlined

Definition at line 98 of file general.h.

CLEARBIT

#define CLEARBIT	(		register,
			bit
	)		((register) &= ~(uint32)((uint32)1U << (bit)))

clears a bit to 0u

Parameters

[in,out]	register	register on which to clear the bit
[in]	bit	number of the bit that should be cleared to 0u

Definition at line 86 of file general.h.

LARGEST_PIN_NUMBER

#define LARGEST_PIN_NUMBER   (31u)

largest pin number that exists in TMS570LC4357

Checked in the datasheet spnu563a: The largest pin number that is used is 31.

Definition at line 73 of file general.h.

must_check_return

#define must_check_return   __attribute__((warn_unused_result))

Allows functions to generate warnings in GCC for unused returns.

This attribute allows to mark that a function return value must be used. The compiler will generate a warning when the return value of a function with this marker is not used in subsequent code.

Definition at line 95 of file general.h.

SETBIT

#define SETBIT	(		register,
			bit
	)		((register) |= (uint32)((uint32)1U << (bit)))

sets a bit to 1u

Parameters

[in,out]	register	register on which to set the bit
[in]	bit	number of the bit that should be set to 1u

Definition at line 80 of file general.h.

UNIT_TEST_WEAK_IMPL

#define UNIT_TEST_WEAK_IMPL

allow implementations to be weak for unit tests

Definition at line 104 of file general.h.