ODeV framework  v2
Typedefs | Functions
AManagedTaskEx.h File Reference

This file declare the Managed task Interface. More...

#include "AManagedTask.h"
+ Include dependency graph for AManagedTaskEx.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct _AManagedTaskEx AManagedTaskEx
 

Functions

sys_error_code_t AMTInitEx (AManagedTaskEx *this)
 
sys_error_code_t AMTExForceExecuteStep (AManagedTaskEx *this, EPowerMode eActivePowerMode)
 
sys_error_code_t AMTExSetInactiveState (AManagedTaskEx *this, boolean_t bBlockedSuspended)
 
boolean_t AMTExIsTaskInactive (AManagedTaskEx *this)
 

Detailed Description

This file declare the Managed task Interface.

Author
STMicroelectronics - ST-Korea - MCD Team
Version
2.0.0
Date
Jul 30, 2018

<DESCRIPTIOM>

Attention

© COPYRIGHT 2018 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

◆ AManagedTaskEx

Create type name for _AManagedTaskEx.

Function Documentation

◆ AMTExForceExecuteStep()

sys_error_code_t AMTExForceExecuteStep ( AManagedTaskEx this,
EPowerMode  eActivePowerMode 
)
inline

Called by the framework to force the step execution. During a step execution a task can be suspended waiting for an event or for other reason. The In this situation the INIT task cannot complete the power mode switch, so it calls this method in order to force the task to be ready for the power mode switch.

Parameters
this[IN] specifies a pointer to the object.
eActivePowerMode[IN] specifies the actual power mode
Returns
SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ AMTExIsTaskInactive()

boolean_t AMTExIsTaskInactive ( AManagedTaskEx this)
inline

Check if the a managed task is inactive. A managed task is inactive when:

  • it is in suspend state
  • it is in blocked state without a timeout

For more information about the task state see https://freertos.org/RTOS-task-states.html

Parameters
this[IN] specifies a pointer to the object.
Returns
TRUE if the task is in inactive state, FALSE otherwise.

◆ AMTExSetInactiveState()

sys_error_code_t AMTExSetInactiveState ( AManagedTaskEx this,
boolean_t  bBlockedSuspended 
)
inline

A task must use this method to notify the framework when it is entering the suspend state or when is blocking on a event without a timeout. This state is called "inactive". This information is used to the AED to resetting the system because it thinks that the task is not responding.

Parameters
this[IN] specifies a pointer to the object.
bBlockedSuspended[IN] TRUE if a the task is entering the inactive state, FALSE if a task is leaving the inactive state.
Returns
SYS_NO_ERROR_CODE if success, an error code otherwise.

◆ AMTInitEx()

sys_error_code_t AMTInitEx ( AManagedTaskEx this)
inline

Initialize a managed task structure. The application is responsible to allocate a managed task in memory. This method must be called after the allocation.

Parameters
this[IN] specifies a task object pointer.
Returns
SYS_NO_ERROR_CODE