Scope_Defines.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Scope_Defines.h
//! @brief      Scope defines header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Defines/Scope_Defines.h $
//!             $Revision: 2877 $
//!             $Date: 2021-10-18 23:04:26 +0500 (Mo, 18 Okt 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// 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 ANVILEX 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.
//------------------------------------------------------------------------------
  
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Trigger states
//------------------------------------------------------------------------------
 
#define SCOPE_TRIGGER_STATE_UNDEFINED ( (U32)0 ) // ANVILEX: Redefine
#define SCOPE_TRIGGER_STATE_IDLE      ( (U32)1 )
#define SCOPE_TRIGGER_STATE_WAIT      ( (U32)2 )
#define SCOPE_TRIGGER_STATE_TRIGGERED ( (U32)3 )
#define SCOPE_TRIGGER_STATE_READY     ( (U32)4 )
#define SCOPE_TRIGGER_STATE_FORCE     ( (U32)5 )
#define SCOPE_TRIGGER_STATE_ARM       ( (U32)6 )
 
#define SCOPE_TRIGGER_STATE_MINIMUM           SCOPE_TRIGGER_STATE_IDLE
#define SCOPE_TRIGGER_STATE_MAXIMUM           SCOPE_TRIGGER_STATE_ARM
#define SCOPE_TRIGGER_STATE_DEFAULT           SCOPE_TRIGGER_STATE_IDLE
 
//! @brief Signal recorder trigger state definition
typedef enum
{
  
  //! @brief Trigger state undefined
  trigger_state_Undefined = SCOPE_TRIGGER_STATE_UNDEFINED,
  
  //! @brief Trigger in idle state
  trigger_state_Idle      = SCOPE_TRIGGER_STATE_IDLE,
  
  //! @brief Trigger in wait state
  trigger_state_Wait      = SCOPE_TRIGGER_STATE_WAIT,
  
  //! @brief Trigger in triggered state
  trigger_state_Triggered = SCOPE_TRIGGER_STATE_TRIGGERED,
  
  //! @brief Trigger in ready state
  trigger_state_Ready     = SCOPE_TRIGGER_STATE_READY,
  
  //! @brief Trigger in force state
  trigger_state_Force     = SCOPE_TRIGGER_STATE_FORCE,
  
  //! @brief Trigger in arm state
  trigger_state_Arm       = SCOPE_TRIGGER_STATE_ARM
  
} TSignal_Recorder_Trigger_State;
 
//------------------------------------------------------------------------------
// Trigger modes
//------------------------------------------------------------------------------
 
#define SCOPE_TRIGGER_MODE_UNDEFINED          ( (U32)0 ) // ANVILEX: Redefine
#define SCOPE_TRIGGER_MODE_OFF                ( (U32)1 )
#define SCOPE_TRIGGER_MODE_MATCH              ( (U32)2 )
#define SCOPE_TRIGGER_MODE_RISING_EDGE        ( (U32)3 )
#define SCOPE_TRIGGER_MODE_FALLING_EDGE       ( (U32)4 )
#define SCOPE_TRIGGER_MODE_EDGE               ( (U32)5 )
#define SCOPE_TRIGGER_MODE_CHANGE             ( (U32)6 )
#define SCOPE_TRIGGER_MODE_BIT_PATTERN_SET    ( (U32)7 )
#define SCOPE_TRIGGER_MODE_BIT_PATTERN_CLEAR  ( (U32)8 )
 
#define SCOPE_TRIGGER_MODE_MINIMUM            SCOPE_TRIGGER_MODE_OFF
#define SCOPE_TRIGGER_MODE_MAXIMUM            SCOPE_TRIGGER_MODE_BIT_PATTERN_CLEAR
#define SCOPE_TRIGGER_MODE_DEFAULT            SCOPE_TRIGGER_MODE_OFF
 
//! @brief Signal recorder trigger mode definition
typedef enum
{
 
  //! @brief Trigger mode undefined
  trigger_mode_Undefined = SCOPE_TRIGGER_MODE_UNDEFINED,
  
  //! @brief Trigger disabled (manual)
  trigger_mode_Off = SCOPE_TRIGGER_MODE_OFF,                                
  
  //! @brief Trigger on value match
  trigger_mode_On_Match = SCOPE_TRIGGER_MODE_MATCH,                         
  
  //! @brief Trigger on the rising edge of the parameter
  trigger_mode_On_Rising_Edge = SCOPE_TRIGGER_MODE_RISING_EDGE,
  
  //! @brief Trigger on the falling edge of the parameter
  trigger_mode_On_Falling_Edge = SCOPE_TRIGGER_MODE_FALLING_EDGE,
  
  //! @brief Trigger on the rising or faling edge of the parameter
  trigger_mode_On_Edge = SCOPE_TRIGGER_MODE_EDGE,           
  
  //! @brief Trigger on the parameter change
  trigger_mode_On_Change = SCOPE_TRIGGER_MODE_CHANGE,                       
  
  //! @brief Trigger on bit pattern set
  trigger_mode_On_Bit_Pattern_Set = SCOPE_TRIGGER_MODE_BIT_PATTERN_SET,     
  
  //! @brief Trigger on bit pattern clear
  trigger_mode_On_Bit_Pattern_Clear = SCOPE_TRIGGER_MODE_BIT_PATTERN_CLEAR  
 
} TSignal_Recorder_Trigger_Mode;
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------