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

#include "services/AManagedTask.h"

Include dependency graph for AManagedTaskEx.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct _AManagedTaskEx	AManagedTaskEx

typedef enum _EPMClass	EPMClass

Enumerations
enum	_EPMClass { E_PM_CLASS_0 = 0 , E_PM_CLASS_1 = 1 , E_PM_CLASS_2 = 2 }

Functions
static sys_error_code_t	AMTInitEx (AManagedTaskEx *_this)

static sys_error_code_t	AMTExForceExecuteStep (AManagedTaskEx *_this, EPowerMode eActivePowerMode)

static sys_error_code_t	AMTExOnEnterPowerMode (AManagedTaskEx *_this, const EPowerMode eActivePowerMode, const EPowerMode eNewPowerMode)

static sys_error_code_t	AMTExSetInactiveState (AManagedTaskEx *_this, boolean_t bBlockedSuspended)

static boolean_t	AMTExIsTaskInactive (AManagedTaskEx *_this)

static sys_error_code_t	AMTExSetPMClass (AManagedTaskEx *_this, EPMClass eNewPMClass)

static EPMClass	AMTExGetPMClass (AManagedTaskEx *_this)

VOID	AMTExRun (ULONG nParam)

Detailed Description

This file declare the Managed task Interface.

Author: STMicroelectronics - ST-Korea - MCD Team

Version: 3.0.0

Date: Jul 30, 2018

Attention

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Typedef Documentation

◆ AManagedTaskEx

typedef struct _AManagedTaskEx AManagedTaskEx

Create type name for _AManagedTaskEx.

◆ EPMClass

typedef enum _EPMClass EPMClass

Power mode classes. An AManagedTaskEx can belong to only one power mode class. An AManagedTask belong, by default, to E_PM_CLASS_0.

Enumeration Type Documentation

◆ _EPMClass

enum _EPMClass

Power mode classes. An AManagedTaskEx can belong to only one power mode class. An AManagedTask belong, by default, to E_PM_CLASS_0.

Enumerator
E_PM_CLASS_0	E_PM_CLASS_0 - this class is for backward compatibility. A managed task belonging to this class execute the power mode switch as in eLooM v2.
E_PM_CLASS_1	E_PM_CLASS_1 - a managed task belonging to this class is delayed during a PM transaction until all task belonging to E_PM_CLASS_0 did the transaction.
E_PM_CLASS_2	E_PM_CLASS_2 - a managed task belonging to this class is delayed during a PM transaction until all task belonging to E_PM_CLASS_0 and E_PM_CLASS_1 did the transaction.

Function Documentation

◆ AMTExForceExecuteStep()

static sys_error_code_t AMTExForceExecuteStep	(	AManagedTaskEx *	_this,
		EPowerMode	eActivePowerMode
	)

inlinestatic

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.

◆ AMTExGetPMClass()

static EPMClass AMTExGetPMClass ( AManagedTaskEx * _this )

inlinestatic

Get the Power Mode Class of the managed task.

Parameters

_this [IN] specifies a pointer to the object.

Returns: the Power Mode Class of the managed task

◆ AMTExIsTaskInactive()

static boolean_t AMTExIsTaskInactive ( AManagedTaskEx * _this )

inlinestatic

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.

◆ AMTExOnEnterPowerMode()

static sys_error_code_t AMTExOnEnterPowerMode	(	AManagedTaskEx *	_this,
		const EPowerMode	eActivePowerMode,
		const EPowerMode	eNewPowerMode
	)

inlinestatic

Task specific function called by the framework just before the system starts the sequence to enter a new specific power mode. Trough this function the system gives a task the option for an early preparation for the transaction in the power mode state machine. This function is executed in the INIT task execution flow. Note that this is different from the AMTDoEnterPowerMode() and a task shall assume that a step in the current power mode is still possible after executing this function.

Parameters

_this	[IN] specifies a task object pointer.
eActivePowerMode	[IN] specifies the current power mode of the system.
eNewPowerMode	[IN] specifies the new power mode that is to be activated by the system.

Returns: SYS_NO_ERROR_CODE if success, a task specific error code otherwise that stops the power mode switch.

◆ AMTExRun()

VOID AMTExRun ( ULONG nParam )

This is the default control loop of a managed task.

Parameters

nParams [IN] specify a pointer to the task object: AManagedTaskEx pTask = (AManagedTaskEx)pParams;

◆ AMTExSetInactiveState()

static sys_error_code_t AMTExSetInactiveState	(	AManagedTaskEx *	_this,
		boolean_t	bBlockedSuspended
	)

inlinestatic

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.

◆ AMTExSetPMClass()

static sys_error_code_t AMTExSetPMClass	(	AManagedTaskEx *	_this,
		EPMClass	eNewPMClass
	)

inlinestatic

Set the PM class for the managed task. During a PM transaction, all tasks belonging to E_PM_CLASS_0 will execute the DoEnterPowerMode() before the managed tasks belonging to E_PM_CLASS_1. The application, for example, can use the AMTExOnEnterPowerMode() function in order to dynamically set the PM Class for the application task. In this way it is possible to control the of the task executing the transaction during a power mode switch.

Parameters

_this	[IN] specifies a pointer to the object.
eNewPMClass	[IN] specifies the new PM class for the task.

Returns: SYS_NO_ERROR_CODE

◆ AMTInitEx()

static sys_error_code_t AMTInitEx ( AManagedTaskEx * _this )

inlinestatic

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

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ AManagedTaskEx

◆ EPMClass

Enumeration Type Documentation

◆ _EPMClass

Function Documentation

◆ AMTExForceExecuteStep()

◆ AMTExGetPMClass()

◆ AMTExIsTaskInactive()

◆ AMTExOnEnterPowerMode()

◆ AMTExRun()

◆ AMTExSetInactiveState()

◆ AMTExSetPMClass()

◆ AMTInitEx()