//#############################################################################
//
// FILE:   ctrl_states.h
//
// TITLE:  C28x InstaSPIN controller (CTRL) state library
//
//#############################################################################
// $TI Release: MotorControl SDK v3.00.00.00 $
// $Release Date: Fri Mar 27 13:04:39 CDT 2020 $
// $Copyright:
// Copyright (C) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 
//   Redistributions of source code must retain the above copyright
//   notice, this list of conditions and the following disclaimer.
// 
//   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.
// 
//   Neither the name of Texas Instruments Incorporated 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
// OWNER 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.
// $
//#############################################################################

#ifndef CTRL_STATES_H
#define CTRL_STATES_H

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//*****************************************************************************
//
//! \addtogroup CTRL_STATES
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
//! \brief Enumeration for the controller states
//!
//*****************************************************************************
#ifdef CLA
typedef enum
{
    CTRL_STATE_ERROR = 0,           //!< the controller error state
    CTRL_STATE_IDLE = 1,            //!< the controller idle state
    CTRL_STATE_OFFLINE = 2,         //!< the controller offline state
    CTRL_STATE_ONLINE = 3,          //!< the controller online state
    CTRL_NUMSTATES = 4,             //!< the number of controller states
    CTRL_RESERVED = 0x10000         //!< reserved to force 32 bit data
} CTRL_State_e;
#else
typedef enum
{
    CTRL_STATE_ERROR = 0,           //!< the controller error state
    CTRL_STATE_IDLE = 1,            //!< the controller idle state
    CTRL_STATE_OFFLINE = 2,         //!< the controller offline state
    CTRL_STATE_ONLINE = 3,          //!< the controller online state
    CTRL_NUMSTATES = 4              //!< the number of controller states
//    CTRL_RESERVED = 0x10000         //!< reserved to force 32 bit data
} CTRL_State_e;
#endif

//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

#endif // CTRL_STATES_H

