AManagedTaskEx_vtbl.h

Go to the documentation of this file.

 
#ifndef INCLUDE_SERVICES_AMANAGEDTASKEX_VTBL_H_
#define INCLUDE_SERVICES_AMANAGEDTASKEX_VTBL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "services/AManagedTask_vtbl.h"
 
 
typedef struct _AManagedTaskEx_vtbl AManagedTaskEx_vtbl;
 
struct _AManagedTaskEx_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);
  sys_error_code_t (*ForceExecuteStep)(AManagedTaskEx *_this, EPowerMode eActivePowerMode);
  sys_error_code_t (*OnEnterPowerMode)(AManagedTaskEx *_this, const EPowerMode eActivePowerMode, const EPowerMode eNewPowerMode);
};
 
typedef struct _AMTStatusEx {
  uint8_t nIsWaitingNoTimeout : 1;
  uint8_t nPowerModeClass: 2;
 
  uint8_t nUnused: 4;
  uint8_t nReserved : 1;
} AMTStatusEx;
 
struct _AManagedTaskEx {
  const AManagedTaskEx_vtbl *vptr;
 
  TX_THREAD m_xTaskHandle;
 
  struct _AManagedTaskEx *m_pNext;
 
  const pExecuteStepFunc_t *m_pfPMState2FuncMap;
 
  const EPowerMode *m_pPMState2PMStateMap;
 
  AMTStatus m_xStatus;
 
  AMTStatusEx m_xStatusEx;
};
 
extern EPowerMode SysGetPowerMode(void);
 
// Inline functions definition
// ***************************
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTExForceExecuteStep(AManagedTaskEx *_this, EPowerMode eActivePowerMode) {
  assert_param(_this != NULL);
    EPowerMode eObjeActivePowerMode = eActivePowerMode;
 
    if (_this->m_pPMState2PMStateMap != NULL) {
      /* remap the PM states. */
      eObjeActivePowerMode = _this->m_pPMState2PMStateMap[(uint8_t)eActivePowerMode];
    }
 
  return _this->vptr->ForceExecuteStep(_this, eObjeActivePowerMode);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTExOnEnterPowerMode(AManagedTaskEx *_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->OnEnterPowerMode(_this, eObjeActivePowerMode, eObjNewPowerMode);
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTInitEx(AManagedTaskEx *_this) {
 
  _this->m_pNext = NULL;
  _this->m_pfPMState2FuncMap = NULL;
  _this->m_pPMState2PMStateMap = 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 = 1; // this identifies the task as an AManagedTaskEx.
  _this->m_xStatusEx.nIsWaitingNoTimeout = 0;
  _this->m_xStatusEx.nPowerModeClass = E_PM_CLASS_0;
  _this->m_xStatusEx.nUnused = 0;
  _this->m_xStatusEx.nReserved = 0;
 
  return SYS_NO_ERROR_CODE;
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTExSetInactiveState(AManagedTaskEx *_this, boolean_t bBlockedSuspended) {
  assert_param(_this);
 
  _this->m_xStatusEx.nIsWaitingNoTimeout = (uint8_t)bBlockedSuspended;
 
  return SYS_NO_ERROR_CODE;
}
 
SYS_DEFINE_STATIC_INLINE
boolean_t AMTExIsTaskInactive(AManagedTaskEx *_this){
  assert_param(_this);
 
  return (boolean_t)_this->m_xStatusEx.nIsWaitingNoTimeout;
}
 
SYS_DEFINE_STATIC_INLINE
sys_error_code_t AMTExSetPMClass(AManagedTaskEx *_this, EPMClass eNewPMClass) {
  assert_param(_this);
 
  _this->m_xStatusEx.nPowerModeClass = (uint8_t)eNewPMClass;
 
  return SYS_NO_ERROR_CODE;
}
 
SYS_DEFINE_STATIC_INLINE
EPMClass AMTExGetPMClass(AManagedTaskEx *_this) {
  assert_param(_this);
 
  return (EPMClass)_this->m_xStatusEx.nPowerModeClass;
}
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* INCLUDE_SERVICES_AMANAGEDTASKEX_VTBL_H_ */