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