AManagedTask_vtbl.h

Go to the documentation of this file.

 
#ifndef INCLUDE_SERVICES_AMANAGEDTASKVTBL_H_
#define INCLUDE_SERVICES_AMANAGEDTASKVTBL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "services/eloom_sysbase.h"
/* MISRA messages linked to FreeRTOS include are ignored */
/*cstat -MISRAC2012-* */
#include "tx_api.h"
/*cstat +MISRAC2012-* */
 
typedef struct _AManagedTask_vtbl AManagedTask_vtbl;
 
struct _AManagedTask_vtbl {
  sys_error_code_t (*HardwareInit)(AManagedTask *_this, void *pParams);
  sys_error_code_t (*OnCreateTask)(AManagedTask *_this, tx_entry_function_t *pvTaskCode, CHAR **pcName, VOID **pvStackStart, ULONG *pnStackSize, UINT *pnPriority, UINT *pnPreemptThreshold, ULONG *pnTimeSlice, ULONG *pnAutoStart, ULONG *pnParams);
  sys_error_code_t (*DoEnterPowerMode)(AManagedTask *_this, const EPowerMode eActivePowerMode, const EPowerMode eNewPowerMode);
  sys_error_code_t (*HandleError)(AManagedTask *_this, SysEvent xError);
  sys_error_code_t (*OnEnterTaskControlLoop)(AManagedTask *_this);
};
 
typedef struct _AMTStatus {
  uint8_t nDelayPowerModeSwitch: 1;
 
  uint8_t nPowerModeSwitchPending: 1;
 
  uint8_t nPowerModeSwitchDone: 1;
 
  uint8_t nIsTaskStillRunning: 1;
 
  uint8_t nErrorCount: 2;
 
  uint8_t nAutoStart: 1;
 
  uint8_t nReserved : 1;
} AMTStatus;
 
struct _AManagedTask {
  const AManagedTask_vtbl *vptr;
 
  TX_THREAD m_xTaskHandle;
 
  struct _AManagedTask *m_pNext;
 
  const pExecuteStepFunc_t *m_pfPMState2FuncMap;
 
  const EPowerMode *m_pPMState2PMStateMap;
 
  AMTStatus m_xStatus;
};
 
extern EPowerMode SysGetPowerMode(void);
 
 
// Inline functions definition
// ***************************
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTHardwareInit(AManagedTask *_this, void *pParams) {
  return _this->vptr->HardwareInit(_this, pParams);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTOnCreateTask(AManagedTask *_this, tx_entry_function_t *pvTaskCode, CHAR **pcName,
    VOID **pvStackStart, ULONG *pnStackSize,
    UINT *pnPriority, UINT *pnPreemptThreshold,
    ULONG *pnTimeSlice, ULONG *pnAutoStart,
    ULONG *pnParams) {
  return _this->vptr->OnCreateTask(_this, pvTaskCode, pcName, pvStackStart, pnStackSize, pnPriority, pnPreemptThreshold, pnTimeSlice, pnAutoStart, pnParams);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTDoEnterPowerMode(AManagedTask *_this, const EPowerMode eActivePowerMode, const EPowerMode eNewPowerMode) {
  assert_param(_this != NULL);
  EPowerMode eObjeActivePowerMode = eActivePowerMode;
  EPowerMode eObjNewPowerMode = eNewPowerMode;
 
  if (_this->m_pPMState2PMStateMap != NULL) {
    /* remap the PM states. */
    eObjeActivePowerMode = _this->m_pPMState2PMStateMap[(uint8_t)eActivePowerMode];
    eObjNewPowerMode = _this->m_pPMState2PMStateMap[(uint8_t)eNewPowerMode];
  }
 
  return _this->vptr->DoEnterPowerMode(_this, eObjeActivePowerMode, eObjNewPowerMode);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTHandleError(AManagedTask *_this, SysEvent xError) {
  return _this->vptr->HandleError(_this, xError);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTOnEnterTaskControlLoop(AManagedTask *_this) {
  return _this->vptr->OnEnterTaskControlLoop(_this);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTInit(AManagedTask *_this) {
  _this->m_pNext = NULL;
  _this->m_pfPMState2FuncMap = NULL;
  _this->m_pPMState2PMStateMap = NULL;
  _this->m_xStatus.nDelayPowerModeSwitch = 1;
  _this->m_xStatus.nPowerModeSwitchPending = 0;
  _this->m_xStatus.nPowerModeSwitchDone = 0;
  _this->m_xStatus.nIsTaskStillRunning = 0;
  _this->m_xStatus.nErrorCount = 0;
  _this->m_xStatus.nAutoStart = 0;
  _this->m_xStatus.nReserved = 0;
 
  return SYS_NO_ERROR_CODE;
}
 
SYS_DEFINE_STATIC_INLINE
EPowerMode AMTGetSystemPowerMode() {
  return SysGetPowerMode();
}
 
SYS_DEFINE_STATIC_INLINE
EPowerMode AMTGetTaskPowerMode(AManagedTask *_this) {
  assert_param(_this != NULL);
 
  EPowerMode eTaskPowrMode = (_this->m_pPMState2PMStateMap != NULL) ?
      _this->m_pPMState2PMStateMap[(uint8_t)SysGetPowerMode()] :
      SysGetPowerMode();
 
  return eTaskPowrMode;
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTNotifyIsStillRunning(AManagedTask *_this, sys_error_code_t nStepError) {
 
  if (SYS_IS_ERROR_CODE(nStepError) && (_this->m_xStatus.nErrorCount < MT_MAX_ERROR_COUNT)) {
    _this->m_xStatus.nErrorCount++;
  }
  if (_this->m_xStatus.nErrorCount < MT_ALLOWED_ERROR_COUNT) {
    _this->m_xStatus.nIsTaskStillRunning = 1;
  }
 
  return SYS_NO_ERROR_CODE;
}
 
SYS_DEFINE_STATIC_INLINE
void AMTResetAEDCounter(AManagedTask *_this) {
  UNUSED(_this);
  SysResetAEDCounter();
}
 
SYS_DEFINE_STATIC_INLINE
boolean_t AMTIsPowerModeSwitchPending(AManagedTask *_this) {
  assert_param(_this != NULL);
 
  return (boolean_t)_this->m_xStatus.nPowerModeSwitchPending;
}
 
SYS_DEFINE_STATIC_INLINE
void AMTReportErrOnStepExecution(AManagedTask *_this, sys_error_code_t nStepError) {
  UNUSED(nStepError);
 
  if (_this->m_xStatus.nErrorCount < MT_ALLOWED_ERROR_COUNT) {
    _this->m_xStatus.nErrorCount++;
  }
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTSetPMStateRemapFunc(AManagedTask *_this, const EPowerMode *pPMState2PMStateMap) {
    assert_param(_this != NULL);
 
    _this->m_pPMState2PMStateMap = pPMState2PMStateMap;
 
    return SYS_NO_ERROR_CODE;
}
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* INCLUDE_SERVICES_AMANAGEDTASKVTBL_H_ */