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