dev_boost_opstates.h

/* 
 * File:   dev_boost_opstates.h
 * Author: M91406
 * Comments: Boost converter operation states header file
 * Revision history: 
 *   10/09/20   1.0  initial version
 */

// This is a guard condition so that contents of this file are not included
// more than once.  
#ifndef BOOST_CONVERTER_OPERATION_STATES_H
#define BOOST_CONVERTER_OPERATION_STATES_H

#include <xc.h> // include processor files - each processor file is guarded.  
#include <stdint.h> // include standard integer data types
#include <stdbool.h> // include standard boolean data types

/*******************************************************************************
 * @var volatile uint16_t(*BoostConverterStateMachine[])(volatile struct BOOST_CONVERTER_s *boostInstance) 
 * @ingroup lib-layer-boost-state-machine-properties-variables
 * @brief   Function pointer array defining the state machine execution sequence    
 * @details
 * The function pointer list BoostConverterStateMachine[] is providing 
 * access to a list of state functions. Each function mapped into this array 
 * as function pointer represents a self-contained, independent sub-state. 
 * The main state machine will call functions from this list in order of their
 * index within the array, starting from '0'. While this list is executed, the 
 * calling main state is transparent by passing through the return value of the 
 * most recent sub-state. Once all sub-states have been executed, the calling main 
 * state will return the COMPLETE flag, allowing the main state machine to move on.
 * 
 * Each function needs to be called by handing over a parameter of type
 * 
 * - struct BOOST_CONVERTER_s 
 * 
 * Each function returns of type unsigned integer:
 * 
 * - 0 = BOOST_OPSRET_ERROR
 * - 1 = BOOST_OPSRET_COMPLETE
 * - 2 = BOOST_OPSRET_REPEAT
 * 
 **********************************************************************************/

extern volatile uint16_t (*BoostConverterStateMachine[])
            (volatile struct BOOST_CONVERTER_s *boostInstance); 

/*******************************************************************************
 * @var     volatile uint16_t BoostStateList_size
 * @ingroup lib-layer-boost-state-machine-properties-variables 
 * @brief   Boost converter state machine function pointer array size   
 *********************************************************************************/

extern volatile uint16_t BoostStateList_size; 


#endif  /* BOOST_CONVERTER_OPERATION_STATES_H */

// END OF FILE