algorithm_cfg.h File Reference

Headers for the configuration of the algorithm module. More...

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

Include dependency graph for algorithm_cfg.h:

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

Go to the source code of this file.

Data Structures
struct	ALGO_TASKS_s

Macros
#define	ALGO_TICK_ms   (100u)

Typedefs
typedef STD_RETURN_TYPE_e	ALGO_INITIALIZATION_FUNCTION_f(void)
typedef void	ALGO_COMPUTATION_FUNCTION_f(void)

Enumerations
enum	ALGO_STATE_e {   ALGO_UNINITIALIZED , ALGO_READY , ALGO_RUNNING , ALGO_BLOCKED ,   ALGO_FAILED_INIT , ALGO_REINIT_REQUESTED }

Functions
void	ALGO_MarkAsDone (uint32_t algorithmIndex)
	Mark the current algorithm as done (will reset to ALGO_READY if possible) More...
void	ALGO_MarkAsReinit (uint32_t algorithmIndex)
	mark a algorithm as requiring a reinitialization. More...

Variables
ALGO_TASKS_s	algo_algorithms []
const uint16_t	algo_length

Detailed Description

Headers for the configuration of the algorithm module.

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

2017-12-18 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

ALGO

Definition in file algorithm_cfg.h.

Typedef Documentation

ALGO_COMPUTATION_FUNCTION_f

typedef void ALGO_COMPUTATION_FUNCTION_f(void)

function type for the computation function of an algorithm

Definition at line 80 of file algorithm_cfg.h.

ALGO_INITIALIZATION_FUNCTION_f

typedef STD_RETURN_TYPE_e ALGO_INITIALIZATION_FUNCTION_f(void)

function type for the initialization function of an algorithm

Returns

STD_OK if the initialization has passed

Definition at line 75 of file algorithm_cfg.h.

Enumeration Type Documentation

ALGO_STATE_e

enum ALGO_STATE_e

states that an algorithm can take

Enumerator
ALGO_UNINITIALIZED	This is the default value indicating that initialization has not run yet
ALGO_READY	This indicates that the algorithm is ready to be run on next time slot
ALGO_RUNNING	This indicates that the algorithm is currently running. Note that it may not spend more than ALGO_TASKS_s::maxCalculationDuration_ms in this state.
ALGO_BLOCKED	This indicates that the algorithm has violated its maximum calculation duration.
ALGO_FAILED_INIT	This indicates a failed initialization.
ALGO_REINIT_REQUESTED	This indicates that a reinitialization of the algorithm has been requested.

Definition at line 83 of file algorithm_cfg.h.

Function Documentation

ALGO_MarkAsDone()

void ALGO_MarkAsDone

(

uint32_t

algorithmIndex

)

Mark the current algorithm as done (will reset to ALGO_READY if possible)

Parameters

[in]

algorithmIndex

index entry of the algorithm

Definition at line 82 of file algorithm_cfg.c.

ALGO_MarkAsReinit()

void ALGO_MarkAsReinit

(

uint32_t

algorithmIndex

)

mark a algorithm as requiring a reinitialization.

Parameters

[in]

algorithmIndex

index entry of the algorithm

Definition at line 93 of file algorithm_cfg.c.

Here is the call graph for this function:

Variable Documentation

algo_algorithms

ALGO_TASKS_s algo_algorithms[]

extern

Array with pointer to the different algorithms

array of algorithms that should be executed

Definition at line 70 of file algorithm_cfg.c.

algo_length

const uint16_t algo_length

extern

number of executed algorithms

Definition at line 74 of file algorithm_cfg.c.