fstd_types.h File Reference

Definition of foxBMS standard types. More...

#include <stdint.h>

Include dependency graph for fstd_types.h:

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

Go to the source code of this file.

Macros
#define	NULL   ((void *)0u)
	NULL definition. More...
#define	NULL_PTR   ((void *)(0u))
	Null pointer. More...

Enumerations
enum	STD_RETURN_TYPE_e { STD_OK , STD_NOT_OK }
enum	STD_PIN_STATE_e { STD_PIN_LOW , STD_PIN_HIGH , STD_PIN_UNDEFINED }

Detailed Description

Definition of foxBMS standard types.

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

2015-12-20 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

STD

Definition in file fstd_types.h.

Macro Definition Documentation

NULL

#define NULL   ((void *)0u)

NULL definition.

This define describes a null. Use it to compare against null.

Definition at line 67 of file fstd_types.h.

NULL_PTR

#define NULL_PTR   ((void *)(0u))

Null pointer.

This define describes a null pointer. Use it to compare for null pointer access.

Definition at line 77 of file fstd_types.h.

Enumeration Type Documentation

STD_PIN_STATE_e

enum STD_PIN_STATE_e

enum for pin state

Enumerator
STD_PIN_LOW	electrical pin state: low
STD_PIN_HIGH	electrical pin state: high
STD_PIN_UNDEFINED	electrical pin state: undefined

Definition at line 88 of file fstd_types.h.

STD_RETURN_TYPE_e

enum STD_RETURN_TYPE_e

enum for standard return type

Enumerator
STD_OK	ok
STD_NOT_OK	not ok

Definition at line 82 of file fstd_types.h.