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