system/EcuM/EcuM.c

   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 #include "EcuM.h"\r
  17 #include "Modules.h"\r
  18 #include "string.h"\r
  19 #include "Os.h"\r
  20 #include "EcuM_Internals.h"\r
  21 #include "EcuM_Cbk.h"\r
  22 #include "Mcu.h"\r
  23 #include "Det.h"\r
  24 #include "irq.h"\r
  25 #if     (ECUM_INCLUDE_NVRAM_MGR == STD_ON)\r
  26 #include "Nvm.h"\r
  27 #endif\r
  28 \r
  29 EcuM_GobalType internal_data;\r
  30 \r
  31 void EcuM_Init( void )\r
  32 {\r
  33         internal_data.current_state = ECUM_STATE_STARTUP_ONE;\r
  34 \r
  35         // Initialize drivers that are needed to determine PostBuild configuration\r
  36         EcuM_AL_DriverInitZero();\r
  37 \r
  38         // Initialize the OS\r
  39         InitOS();\r
  40 \r
  41         // Enable interrupts\r
  42         Irq_Init();\r
  43 \r
  44 \r
  45         // Determine PostBuild configuration\r
  46         internal_data.config = EcuM_DeterminePbConfiguration();\r
  47 \r
  48         // Check consistency of PB configuration\r
  49         // TODO\r
  50 \r
  51         // Initialize drivers needed before the OS-starts\r
  52         EcuM_AL_DriverInitOne(internal_data.config);\r
  53 \r
  54         // Determine the reset/wakeup reason\r
  55         // TODO Mcu_ResetType type = Mcu_GetResetReason();\r
  56 \r
  57         // Set default shutdown target\r
  58         internal_data.shutdown_target = internal_data.config->EcuMDefaultShutdownTarget;\r
  59         internal_data.shutdown_mode = internal_data.config->EcuMDefaultShutdownMode;\r
  60 \r
  61         // Set default application mode\r
  62         internal_data.app_mode = internal_data.config->EcuMDefaultAppMode;\r
  63 #if defined(USE_COMM)\r
  64         internal_data.run_comm_requests = 0;\r
  65 #endif\r
  66         internal_data.run_requests = 0;\r
  67         internal_data.postrun_requests = 0;\r
  68 \r
  69         internal_data.initiated = TRUE;\r
  70 \r
  71         // Start this baby up\r
  72         StartOS(internal_data.app_mode);\r
  73 }\r
  74 \r
  75 void EcuM_StartupTwo()\r
  76 {\r
  77 #if     (ECUM_INCLUDE_NVRAM_MGR == STD_ON)\r
  78         extern CounterType Os_Arc_OsTickCounter;\r
  79         TickType tickTimerStart, tickTimer, tickTimerElapsed;\r
  80         StatusType tickTimerStatus;\r
  81         static NvM_RequestResultType readAllResult;\r
  82 #endif\r
  83 \r
  84         internal_data.current_state = ECUM_STATE_STARTUP_TWO;\r
  85 \r
  86         // Initialize the BSW scheduler\r
  87         // TODO SchM_Init();\r
  88 \r
  89         // Initialize drivers that don't need NVRAM data\r
  90         EcuM_AL_DriverInitTwo(internal_data.config);\r
  91 \r
  92 #if     (ECUM_INCLUDE_NVRAM_MGR == STD_ON)\r
  93         // Start timer to wait for NVM job to complete\r
  94         tickTimerStatus = GetCounterValue(Os_Arc_OsTickCounter , &tickTimerStart);\r
  95         if (tickTimerStatus != E_OK) {\r
  96                 // TODO: Generate error?\r
  97         }\r
  98 #endif\r
  99 \r
 100         // Prepare the system to startup RTE\r
 101         // TODO EcuM_OnRTEStartup();\r
 102 #if defined(USE_RTE)\r
 103         Rte_Start();\r
 104 #endif\r
 105 \r
 106 #if 1\r
 107 #if     (ECUM_INCLUDE_NVRAM_MGR == STD_ON)\r
 108         // Wait for the NVM job (NvmReadAll) to terminate\r
 109         do {\r
 110                 NvM_GetErrorStatus(0, &readAllResult);  // Read the multiblock status\r
 111                 tickTimer = tickTimerStart;     // Save this because the GetElapsedCounterValue() will destroy it.\r
 112                 tickTimerStatus =  GetElapsedCounterValue(Os_Arc_OsTickCounter, &tickTimer, &tickTimerElapsed);\r
 113                 if (tickTimerStatus != E_OK) {\r
 114                         // TODO: Generate error?\r
 115                 }\r
 116         } while( (readAllResult == NVM_REQ_PENDING) && (tickTimerElapsed < internal_data.config->EcuMNvramReadAllTimeout) );\r
 117 #endif\r
 118 #else\r
 119 #if     (ECUM_INCLUDE_NVRAM_MGR == STD_ON)\r
 120         // Wait for the NVM job (NvmReadAll) to terminate\r
 121         do {\r
 122                 NvM_GetErrorStatus(0, &readAllResult);  // Read the multiblock status\r
 123         } while( (readAllResult == NVM_REQ_PENDING) && ((Os_SysTickGetElapsedValue(timer)) < internal_data.config->EcuMNvramReadAllTimeout) );\r
 124 #endif\r
 125 #endif\r
 126 \r
 127         // Initialize drivers that need NVRAM data\r
 128         EcuM_AL_DriverInitThree(internal_data.config);\r
 129 \r
 130         // Indicate mode change to RTE\r
 131         // TODO\r
 132 \r
 133         // If coming from startup sequence, enter Run mode\r
 134 //      if (internal_data.current_state == ECUM_STATE_STARTUP_TWO)\r
 135                 EcuM_enter_run_mode();\r
 136 \r
 137 }\r
 138 \r
 139 // Typically called from OS shutdown hook\r
 140 void EcuM_Shutdown()\r
 141 {\r
 142         internal_data.current_state = ECUM_STATE_GO_OFF_TWO;\r
 143 \r
 144         // Let the last drivers do a nice shutdown\r
 145         EcuM_OnGoOffTwo();\r
 146 \r
 147         if (internal_data.shutdown_target == ECUM_STATE_OFF)\r
 148         {\r
 149                 EcuM_AL_SwitchOff();\r
 150         }\r
 151         else\r
 152         {\r
 153 #if (MCU_PERFORM_RESET_API == STD_ON)\r
 154                 Mcu_PerformReset();\r
 155 #else\r
 156                 for(;;);\r
 157 #endif\r
 158         }\r
 159 }\r
 160 \r
 161 Std_ReturnType EcuM_GetState(EcuM_StateType* state)\r
 162 {\r
 163         VALIDATE_RV(state != NULL, ECUM_GETSTATE_ID, ECUM_E_NULL_POINTER, E_NOT_OK);\r
 164 \r
 165         *state = internal_data.current_state;\r
 166 \r
 167         return E_OK;\r
 168 }\r
 169 \r
 170 Std_ReturnType EcuM_SelectApplicationMode(AppModeType appMode)\r
 171 {\r
 172         VALIDATE_RV(internal_data.initiated, ECUM_SELECTAPPMODE_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 173 \r
 174         // TODO Save this application mode for next startup\r
 175 \r
 176         return E_NOT_OK;\r
 177 }\r
 178 \r
 179 Std_ReturnType EcuM_GetApplicationMode(AppModeType* appMode)\r
 180 {\r
 181         VALIDATE_RV(internal_data.initiated, ECUM_GETAPPMODE_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 182         VALIDATE_RV(appMode != NULL, ECUM_GETAPPMODE_ID, ECUM_E_NULL_POINTER, E_NOT_OK);\r
 183 \r
 184         *appMode = internal_data.app_mode;\r
 185 \r
 186         return E_OK;\r
 187 }\r
 188 \r
 189 Std_ReturnType EcuM_SelectBootTarget(EcuM_BootTargetType target)\r
 190 {\r
 191         VALIDATE_RV(internal_data.initiated, ECUM_SELECT_BOOTARGET_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 192 \r
 193         // TODO Do something great here\r
 194 \r
 195         return E_NOT_OK;\r
 196 }\r
 197 \r
 198 Std_ReturnType EcuM_GetBootTarget(EcuM_BootTargetType* target)\r
 199 {\r
 200         VALIDATE_RV(internal_data.initiated, ECUM_GET_BOOTARGET_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 201         VALIDATE_RV(target != NULL, ECUM_GET_BOOTARGET_ID, ECUM_E_NULL_POINTER, E_NOT_OK);\r
 202 \r
 203         // TODO Return selected boot target here\r
 204 \r
 205         return E_NOT_OK;\r
 206 }\r
 207 \r
 208 \r
 209 Std_ReturnType EcuM_SelectShutdownTarget(EcuM_StateType target, uint8 mode)\r
 210 {\r
 211         VALIDATE_RV(internal_data.initiated, ECUM_SELECTSHUTDOWNTARGET_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 212         VALIDATE_RV((target == ECUM_STATE_OFF) || (target == ECUM_STATE_RESET) || (target == ECUM_STATE_SLEEP), ECUM_SELECTSHUTDOWNTARGET_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 213 \r
 214         internal_data.shutdown_target = target;\r
 215         internal_data.shutdown_mode = mode;\r
 216 \r
 217         return E_OK;\r
 218 }\r
 219 \r
 220 \r
 221 Std_ReturnType EcuM_GetShutdownTarget(EcuM_StateType *shutdownTarget, uint8 *sleepMode)\r
 222 {\r
 223         VALIDATE_RV(internal_data.initiated, ECUM_GETSHUTDOWNTARGET_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 224 \r
 225         *shutdownTarget = internal_data.shutdown_target;\r
 226         *sleepMode = internal_data.shutdown_mode;\r
 227 \r
 228         return E_OK;\r
 229 }\r
 230 \r
 231 \r
 232 Std_ReturnType EcuM_RequestRUN(EcuM_UserType user)\r
 233 {\r
 234         VALIDATE_RV(internal_data.initiated, ECUM_REQUESTRUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 235         VALIDATE_RV(user < ECUM_USER_ENDMARK, ECUM_REQUESTRUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 236 \r
 237         internal_data.run_requests |= (uint32)1 << user;\r
 238 \r
 239         return E_OK;\r
 240 }\r
 241 \r
 242 Std_ReturnType EcuM_ReleaseRUN(EcuM_UserType user)\r
 243 {\r
 244         VALIDATE_RV(internal_data.initiated, ECUM_RELEASERUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 245         VALIDATE_RV(user < ECUM_USER_ENDMARK, ECUM_RELEASERUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 246 \r
 247         internal_data.run_requests &= ~((uint32)1 << user);\r
 248 \r
 249         return E_OK;\r
 250 }\r
 251 \r
 252 #if defined(USE_COMM)\r
 253 Std_ReturnType EcuM_ComM_RequestRUN(NetworkHandleType user)\r
 254 {\r
 255         VALIDATE_RV(internal_data.initiated, ECUM_COMM_REQUESTRUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 256         VALIDATE_RV(user < 32, ECUM_COMM_REQUESTRUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 257 \r
 258         internal_data.run_comm_requests |= (uint32)1 << user;\r
 259 \r
 260         return E_OK;\r
 261 }\r
 262 \r
 263 Std_ReturnType EcuM_ComM_ReleaseRUN(NetworkHandleType user)\r
 264 {\r
 265         VALIDATE_RV(internal_data.initiated, ECUM_COMM_RELEASERUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 266         VALIDATE_RV(user < 32, ECUM_COMM_RELEASERUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 267 \r
 268         internal_data.run_comm_requests &= ~((uint32)1 << user);\r
 269 \r
 270         return E_OK;\r
 271 }\r
 272 \r
 273 boolean EcuM_ComM_HasRequestedRUN(NetworkHandleType user)\r
 274 {\r
 275         VALIDATE_RV(internal_data.initiated, ECUM_COMM_HASREQUESTEDRUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 276         VALIDATE_RV(user < 32, ECUM_COMM_HASREQUESTEDRUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 277 \r
 278         return (internal_data.run_comm_requests &((uint32)1 << user)) != 0;\r
 279 }\r
 280 #endif\r
 281 \r
 282 Std_ReturnType EcuM_RequestPOST_RUN(EcuM_UserType user)\r
 283 {\r
 284         VALIDATE_RV(internal_data.initiated, ECUM_REQUESTPOSTRUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 285         VALIDATE_RV(user < ECUM_USER_ENDMARK, ECUM_REQUESTPOSTRUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 286 \r
 287         internal_data.postrun_requests |= (uint32)1 << user;\r
 288 \r
 289         return E_OK;\r
 290 }\r
 291 \r
 292 Std_ReturnType EcuM_ReleasePOST_RUN(EcuM_UserType user)\r
 293 {\r
 294         VALIDATE_RV(internal_data.initiated, ECUM_RELEASEPOSTRUN_ID, ECUM_E_NOT_INITIATED, E_NOT_OK);\r
 295         VALIDATE_RV(user < ECUM_USER_ENDMARK, ECUM_RELEASEPOSTRUN_ID, ECUM_E_INVALID_PAR, E_NOT_OK);\r
 296 \r
 297         internal_data.postrun_requests &= ~((uint32)1 << user);\r
 298 \r
 299         return E_OK;\r
 300 }\r
 301 \r