include/EcuM.h

   1 /* -------------------------------- Arctic Core ------------------------------\r
   2  * Arctic Core - the open source AUTOSAR platform http://arccore.com\r
   3  *\r
   4  * Copyright (C) 2009  ArcCore AB <contact@arccore.com>\r
   5  *\r
   6  * This source code is free software; you can redistribute it and/or modify it\r
   7  * under the terms of the GNU General Public License version 2 as published by the\r
   8  * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful, but\r
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License\r
  13  * for more details.\r
  14  * -------------------------------- Arctic Core ------------------------------*/\r
  15 \r
  16 /** @addtogroup EcuM ECU State Manager\r
  17  *  @{ */\r
  18 \r
  19 /** @file EcuM.h\r
  20  * API and type definitions for ECU State Manager.\r
  21  */\r
  22 \r
  23 #ifndef ECUM_H_\r
  24 #define ECUM_H_\r
  25 \r
  26 #include "Std_Types.h"\r
  27 #include <Os.h>\r
  28 #if defined(USE_COM)\r
  29 #include "ComStack_Types.h"\r
  30 #endif\r
  31 \r
  32 /** @name Error Codes */\r
  33 //@{\r
  34 #define ECUM_E_NOT_INITIATED (0x10)\r
  35 #define ECUM_E_SERVICE_DISABLED (0x11)\r
  36 #define ECUM_E_NULL_POINTER (0x12)\r
  37 #define ECUM_E_INVALID_PAR (0x13)\r
  38 #define ECUM_E_MULTIPLE_RUN_REQUESTS (0x14)\r
  39 #define ECUM_E_MISMATCHED_RUN_RELEASE (0x15)\r
  40 #define ECUM_E_STATE_PAR_OUT_OF_RANGE (0x16)\r
  41 #define ECUM_E_UNKNOWN_WAKEUP_SOURCE (0x17)\r
  42 #define ECUM_E_ARC_TIMERERROR (0x18)\r
  43 //@}\r
  44 \r
  45 /** @name Service id's */\r
  46 //@{\r
  47 #define ECUM_REQUESTRUN_ID (0x03)\r
  48 #define ECUM_RELEASERUN_ID (0x04)\r
  49 #define ECUM_SELECTSHUTDOWNTARGET_ID (0x06)\r
  50 #define ECUM_GETSTATE_ID (0x07)\r
  51 #define ECUM_GETSHUTDOWNTARGET_ID (0x09)\r
  52 #define ECUM_COMM_REQUESTRUN_ID (0x0e)\r
  53 #define ECUM_REQUESTPOSTRUN_ID (0x0a)\r
  54 #define ECUM_RELEASEPOSTRUN_ID (0x0b)\r
  55 #define ECUM_SELECTAPPMODE_ID (0x0f)\r
  56 #define ECUM_COMM_RELEASERUN_ID (0x10)\r
  57 #define ECUM_GETAPPMODE_ID (0x11)\r
  58 #define ECUM_SELECT_BOOTARGET_ID (0x12)\r
  59 #define ECUM_GET_BOOTARGET_ID (0x13)\r
  60 #define ECUM_MAINFUNCTION_ID (0x18)\r
  61 #define ECUM_COMM_HASREQUESTEDRUN_ID (0x1b)\r
  62 #define ECUM_ARC_STARTUPTWO_ID (0x20)\r
  63 \r
  64 /** Possible states */\r
  65 typedef enum {\r
  66         ECUM_STATE_APP_RUN = 0x32,\r
  67         ECUM_STATE_SHUTDOWN = 0x40,\r
  68         ECUM_STATE_WAKEUP = 0x20,\r
  69         ECUM_SUBSTATE_MASK = 0x0F,\r
  70         ECUM_STATE_WAKEUP_WAKESLEEP = 0x25,\r
  71         ECUM_STATE_WAKEUP_ONE = 0x21,\r
  72         ECUM_STATE_OFF = 0x80,\r
  73         ECUM_STATE_STARTUP = 0x10,\r
  74         ECUM_STATE_PREP_SHUTDOWN = 0x44,\r
  75         ECUM_STATE_RUN = 0x30,\r
  76         ECUM_STATE_STARTUP_TWO = 0x12,\r
  77         ECUM_STATE_WAKEUP_TTII = 0x26,\r
  78         ECUM_STATE_WAKEUP_VALIDATION = 0x22,\r
  79         ECUM_STATE_GO_SLEEP = 0x49,\r
  80         ECUM_STATE_STARTUP_ONE = 0x11,\r
  81         ECUM_STATE_WAKEUP_TWO = 0x24,\r
  82         ECUM_STATE_SLEEP = 0x50,\r
  83         ECUM_STATE_WAKEUP_REACTION = 0x23,\r
  84         ECUM_STATE_APP_POST_RUN = 0x33,\r
  85         ECUM_STATE_GO_OFF_TWO = 0x4e,\r
  86         ECUM_STATE_RESET = 0x90,\r
  87         ECUM_STATE_GO_OFF_ONE = 0x4d\r
  88 } EcuM_StateType;\r
  89 \r
  90 typedef uint8 EcuM_UserType;\r
  91 \r
  92 enum {\r
  93         /** Internal reset of µC (bit 2).\r
  94          *  The internal reset typically only resets the µC\r
  95          *  core but not peripherals or memory\r
  96          *  controllers. The exact behavior is hardware\r
  97          *  specific.\r
  98          *  This source may also indicate an unhandled\r
  99          *  exception. */\r
 100         ECUM_WKSOURCE_INTERNAL_RESET = 0x04,\r
 101 \r
 102         /** Reset by external watchdog (bit 4), if\r
 103          *  detection supported by hardware */\r
 104         ECUM_WKSOURCE_EXTERNAL_WDG = 0x10,\r
 105 \r
 106         /** Reset by internal watchdog (bit 3) */\r
 107         ECUM_WKSOURCE_INTERNAL_WDG = 0x08,\r
 108 \r
 109         /** Power cycle (bit 0) */\r
 110         ECUM_WKSOURCE_POWER = 0x01,\r
 111 \r
 112         /** ~0 to the power of 29 */\r
 113         ECUM_WKSOURCE_ALL_SOURCES = 0x3FFFFFFF,\r
 114 \r
 115         /** Hardware reset (bit 1).\r
 116          *  If hardware cannot distinguish between a\r
 117          *  power cycle and a reset reason, then this\r
 118          *  shall be the default wakeup source */\r
 119         ECUM_WKSOURCE_RESET = 0x02\r
 120 };\r
 121 \r
 122 typedef uint32 EcuM_WakeupSourceType;\r
 123 \r
 124 typedef enum\r
 125 {\r
 126         ECUM_WKSTATUS_NONE = 0,        /**< No pending wakeup event was detected */\r
 127         ECUM_WKSTATUS_PENDING = 1,     /**< The wakeup event was detected but not yet validated */\r
 128         ECUM_WKSTATUS_VALIDATED = 2,   /**< The wakeup event is valid */\r
 129         ECUM_WKSTATUS_EXPIRED = 3     /**< The wakeup event has not been validated and has expired therefore */\r
 130 } EcuM_WakeupStatusType;\r
 131 \r
 132 typedef enum\r
 133 {\r
 134         ECUM_WWKACT_RUN = 0,       /**< Initialization into RUN state */\r
 135         ECUM_WKACT_TTII = 2,       /**< Execute time triggered increased inoperation protocol and shutdown */\r
 136         ECUM_WKACT_SHUTDOWN = 3   /**< Immediate shutdown */\r
 137 } EcuM_WakeupReactionType;\r
 138 \r
 139 typedef enum\r
 140 {\r
 141         ECUM_BOOT_TARGET_APP = 0,          /**< The Ecu will boot into the application */\r
 142         ECUM_BOOT_TARGET_BOOTLOADER = 1   /**< The Ecu will boot into the bootloader */\r
 143 } EcuM_BootTargetType;\r
 144 \r
 145 \r
 146 #define ECUM_MODULE_ID                  MODULE_ID_ECUM\r
 147 #define ECUM_VENDOR_ID                  1\r
 148 \r
 149 #define ECUM_SW_MAJOR_VERSION   2\r
 150 #define ECUM_SW_MINOR_VERSION   0\r
 151 #define ECUM_SW_PATCH_VERSION   0\r
 152 \r
 153 #define ECUM_AR_MAJOR_VERSION   1\r
 154 #define ECUM_AR_MINOR_VERSION   2\r
 155 #define ECUM_AR_PATCH_VERSION   2\r
 156 \r
 157 #include "EcuM_Cfg.h"\r
 158 \r
 159 #if ( ECUM_VERSION_INFO_API == STD_ON)\r
 160 #define EcuM_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,ECUM)\r
 161 #endif\r
 162 \r
 163 void EcuM_Init( void );\r
 164 void EcuM_StartupTwo(void);\r
 165 void EcuM_Shutdown(void);\r
 166 \r
 167 Std_ReturnType EcuM_GetState(EcuM_StateType* state);\r
 168 \r
 169 Std_ReturnType EcuM_RequestRUN(EcuM_UserType user);\r
 170 Std_ReturnType EcuM_ReleaseRUN(EcuM_UserType user);\r
 171 \r
 172 Std_ReturnType EcuM_RequestPOST_RUN(EcuM_UserType user);\r
 173 Std_ReturnType EcuM_ReleasePOST_RUN(EcuM_UserType user);\r
 174 \r
 175 void EcuM_KillAllRUNRequests(void);\r
 176 \r
 177 #if defined(USE_COMM)\r
 178 Std_ReturnType EcuM_ComM_RequestRUN(NetworkHandleType channel);\r
 179 Std_ReturnType EcuM_ComM_ReleaseRUN(NetworkHandleType channel);\r
 180 boolean EcuM_ComM_HasRequestedRUN(NetworkHandleType channel);\r
 181 #endif\r
 182 \r
 183 Std_ReturnType EcuM_SelectShutdownTarget(EcuM_StateType shutdownTarget, uint8 sleepMode);\r
 184 Std_ReturnType EcuM_GetShutdownTarget(EcuM_StateType* shutdownTarget, uint8* sleepMode);\r
 185 Std_ReturnType EcuM_GetLastShutdownTarget(EcuM_StateType* shutdownTarget, uint8* sleepMode);\r
 186 \r
 187 EcuM_WakeupSourceType EcuM_GetPendingWakeupEvents(void);\r
 188 void EcuM_ClearWakeupEvent(EcuM_WakeupSourceType sources);\r
 189 EcuM_WakeupSourceType EcuM_GetValidatedWakeupEvents(void);\r
 190 EcuM_WakeupSourceType EcuM_GetExpiredWakeupEvents(void);\r
 191 EcuM_WakeupStatusType EcuM_GetStatusOfWakeupSource(EcuM_WakeupSourceType sources);\r
 192 \r
 193 Std_ReturnType EcuM_SelectApplicationMode(AppModeType appMode);\r
 194 Std_ReturnType EcuM_GetApplicationMode(AppModeType* appMode);\r
 195 \r
 196 Std_ReturnType EcuM_SelectBootTarget(EcuM_BootTargetType target);\r
 197 Std_ReturnType EcuM_GetBootTarget(EcuM_BootTargetType* target);\r
 198 \r
 199 void EcuM_MainFunction(void);\r
 200 \r
 201 #endif /*ECUM_H_*/\r
 202 /** @} */\r