qnx/src/ipc3x_dev/ti/syslink/inc/knl/_ProcDefs.h

   1 /**
   2  *  @file   _ProcDefs.h
   3  *
   4  *  @brief      Internal definitions for the Processor interface.
   5  *
   6  *
   7  *  @ver        02.00.00.46_alpha1
   8  *
   9  *  ============================================================================
  10  *
  11  *  Copyright (c) 2008-2009, Texas Instruments Incorporated
  12  *
  13  *  Redistribution and use in source and binary forms, with or without
  14  *  modification, are permitted provided that the following conditions
  15  *  are met:
  16  *
  17  *  *  Redistributions of source code must retain the above copyright
  18  *     notice, this list of conditions and the following disclaimer.
  19  *
  20  *  *  Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *
  24  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  25  *     its contributors may be used to endorse or promote products derived
  26  *     from this software without specific prior written permission.
  27  *
  28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  29  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  30  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  32  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  33  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  34  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  35  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  36  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  37  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  38  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *  Contact information for paper mail:
  40  *  Texas Instruments
  41  *  Post Office Box 655303
  42  *  Dallas, Texas 75265
  43  *  Contact information:
  44  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
  45  *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
  46  *  ============================================================================
  47  *
  48  */
  49
  50
  51 #ifndef _ProcDefs_H_0x6a85
  52 #define _ProcDefs_H_0x6a85
  53
  54
  55 #if defined (__cplusplus)
  56 extern "C" {
  57 #endif
  58
  59
  60 /* =============================================================================
  61  *  Macros and types
  62  * =============================================================================
  63  */
  64 /* -----------------------------------------------------------------------------
  65  *  HAL Boot
  66  * -----------------------------------------------------------------------------
  67  */
  68 /*!
  69  *  @brief  Enumerations to indicate types of boot control commands supported
  70  *          for the slave processor.
  71  */
  72 typedef enum {
  73     Processor_BootCtrlCmd_SetEntryPoint     = 0u,
  74     /*!< Set entry point */
  75     Processor_BootCtrlCmd_SetBootComplete   = 1u,
  76     /*!< Indicate complete of boot sequence */
  77     Processor_BootCtrlCmd_ResetBootComplete = 2u,
  78     /*!< Reset the boot complete boot flag. */
  79     Processor_BootCtrlCmd_EndValue          = 3u
  80     /*!< End delimiter indicating start of invalid values for this enum */
  81 } Processor_BootCtrlCmd;
  82
  83 /* -----------------------------------------------------------------------------
  84  *  HAL Reset
  85  * -----------------------------------------------------------------------------
  86  */
  87 /*!
  88  *  @brief  Enumerations to indicate types of reset control commands supported
  89  *          for the slave processor.
  90  */
  91 typedef enum {
  92     Processor_ResetCtrlCmd_Reset        = 0u,
  93     /*!< Reset the slave processor. */
  94     Processor_ResetCtrlCmd_MMU_Reset    = 1u,
  95     /*!< Reset the slave processor MMU. */
  96     Processor_ResetCtrlCmd_Release      = 2u,
  97     /*!< Release the slave processor from reset. */
  98     Processor_ResetCtrlCmd_MMU_Release  = 3u,
  99     /*!< Release the slave processor MMU from reset. */
 100     Processor_ResetCtrlCmd_PeripheralUp = 4u,
 101     /*!< Configure the required peripherals. */
 102     Processor_ResetCtrlCmd_EndValue     = 5u
 103     /*!< End delimiter indicating start of invalid values for this enum */
 104 } Processor_ResetCtrlCmd ;
 105
 106 /* -----------------------------------------------------------------------------
 107  *  HAL MMU
 108  * -----------------------------------------------------------------------------
 109  */
 110 /*!
 111  *  @brief  Enumerations to indicate types of MMU control commands supported
 112  *          for the slave processor.
 113  */
 114 typedef enum {
 115     Processor_MmuCtrlCmd_Enable         = 0u,
 116     /*!< Enable slave MMU. */
 117     Processor_MmuCtrlCmd_Disable        = 1u,
 118     /*!< Disable slave MMU. */
 119     Processor_MmuCtrlCmd_AddEntry       = 2u,
 120     /*!< Add entry in the MMU table. */
 121     Processor_MmuCtrlCmd_DeleteEntry    = 3u,
 122     /*!< Delete entry from the MMU table. */
 123     Processor_MmuCtrlCmd_Register       = 5u,
 124     /*!< Register for an event notification */
 125     Processor_MmuCtrlCmd_UnRegister     = 6u,
 126     /*!< Un-Register for an event notification */
 127     Processor_MmuCtrlCmd_EndValue       = 7u
 128     /*!< End delimiter indicating start of invalid values for this enum */
 129 } Processor_MmuCtrlCmd ;
 130
 131 /* -----------------------------------------------------------------------------
 132  *  HAL PM
 133  * -----------------------------------------------------------------------------
 134  */
 135 /*!
 136  *  @brief  Enumerations to indicate types of PM control commands supported
 137  *          for the slave processor.
 138  */
 139 typedef enum {
 140     Processor_PmCtrlCmd_Suspend         = 0u,
 141     /*!< Suspend the remote proc. */
 142     Processor_PmCtrlCmd_Resume          = 1u,
 143     /*!< Resume the remote proc. */
 144     Processor_PmCtrlCmd_EndValue        = 2u
 145     /*!< End delimiter indicating start of invalid values for this enum */
 146 } Processor_PmCtrlCmd ;
 147
 148 #if defined (__cplusplus)
 149 }
 150 #endif /* defined (__cplusplus) */
 151
 152 #endif /* _ProcDefs_H_0x6a85 */