taskManager.h File Reference

The header file describes the public stack Task Manager interface. More...

#include <inttypes.h>
#include <types.h>
#include <atomic.h>

Go to the source code of this file.

Enumerations
enum	SYS_TaskId_t {   MAC_PHY_HWD_TASK_ID = 1 << 0, HAL_TASK_ID = 1 << 1, MAC_HWI_TASK_ID = 1 << 2, NWK_TASK_ID = 1 << 3,   ZDO_TASK_ID = 1 << 4, APS_TASK_ID = 1 << 5, SSP_TASK_ID = 1 << 6, TC_TASK_ID = 1 << 7,   BSP_TASK_ID = 1 << 8, APL_TASK_ID = 1 << 9 }
	The list of task ID. More...
Functions
void	HAL_TaskHandler (void)
	This function is called for processing HAL task. Should be defined in HAL.
void	BSP_TaskHandler (void)
	This function is called for processing BSP task. Should be defined in BSP.
void	MAC_PHY_HWD_TaskHandler (void)
	This function is called for processing MAC_PHY_HWD task. Should be defined in MAC_PHY_HWD.
void	MAC_HWI_TaskHandler (void)
	This function is called for processing MAC_HWI task. Should be defined in MAC_HWI.
void	NWK_TaskHandler (void)
	This function is called for processing NWK task. Should be defined in NWK.
void	ZDO_TaskHandler (void)
	This function is called for processing ZDO task. Should be defined in ZDO.
void	APS_TaskHandler (void)
	This function is called for processing APS task. Should be defined in APS.
void	APL_TaskHandler (void)
void	SSP_TaskHandler (void)
	This function is called for processing SSP task. Should be defined in SSP.
void	TC_TaskHandler (void)
	This function is called for processing Trust Center task. Should be defined in Trust Center.
static void	SYS_PostTask (SYS_TaskId_t taskId)
	Posts task to the stack Task Manager.
bool	SYS_RunTask ()
	This function is called by an OS or from main() for processing the stack tasks.
Variables
volatile uint16_t	SYS_taskFlag

---

Detailed Description

The header file describes the public stack Task Manager interface.

The file describes public interface, task handlers and tasks IDs of Task Manager.

Definition in file taskManager.h.

---

Enumeration Type Documentation

enum SYS_TaskId_t

The list of task ID.

Enumerator:

MAC_PHY_HWD_TASK_ID
HAL_TASK_ID
MAC_HWI_TASK_ID
NWK_TASK_ID
ZDO_TASK_ID
APS_TASK_ID
SSP_TASK_ID
TC_TASK_ID
BSP_TASK_ID
APL_TASK_ID

Definition at line 22 of file taskManager.h.

---

Function Documentation

void APL_TaskHandler

(

void

)

This function is called for processing user application task. Should be defined in user application. Its very first call is intended just for setting parameters into the stack. For starting a network a new task should be posted.

void APS_TaskHandler

(

void

)

This function is called for processing APS task. Should be defined in APS.

void BSP_TaskHandler

(

void

)

This function is called for processing BSP task. Should be defined in BSP.

void HAL_TaskHandler

(

void

)

This function is called for processing HAL task. Should be defined in HAL.

void MAC_HWI_TaskHandler

(

void

)

This function is called for processing MAC_HWI task. Should be defined in MAC_HWI.

void MAC_PHY_HWD_TaskHandler

(

void

)

This function is called for processing MAC_PHY_HWD task. Should be defined in MAC_PHY_HWD.

void NWK_TaskHandler

(

void

)

This function is called for processing NWK task. Should be defined in NWK.

void SSP_TaskHandler

(

void

)

This function is called for processing SSP task. Should be defined in SSP.

static void SYS_PostTask

(

SYS_TaskId_t

taskId

)

[inline, static]

Posts task to the stack Task Manager.

IDs of the tasks are listed in the SYS_TaskId enum. Each task has its own priority and is called only if there is no any task with higher priority. A handler is called when respective task can be run. Each task has its own task handler. Correspondence between tasks and handlers is listed below:
HAL - HAL_TaskHandler()
BSP - BSP_TaskHandler()
MAC_PHY_HWD - MAC_PHY_HWD_TaskHandler()
MAC_HWI - MAC_HWI_TaskHandler()
NWK - NWK_TaskHandler()
ZDO - ZDO_TaskHandler()
APS - APS_TaskHandler()
APL - APL_TaskHandler()

Parameters:

[in]

taskId

- ID of the posted task

Definition at line 79 of file taskManager.h.

References SYS_taskFlag.

bool SYS_RunTask

(

)

This function is called by an OS or from main() for processing the stack tasks.

void TC_TaskHandler

(

void

)

This function is called for processing Trust Center task. Should be defined in Trust Center.

void ZDO_TaskHandler

(

void

)

This function is called for processing ZDO task. Should be defined in ZDO.

---

Variable Documentation

volatile uint16_t SYS_taskFlag

Referenced by SYS_PostTask().

---