ZW_UserTask.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef _USER_TASK_API_H_
#define _USER_TASK_API_H_
 
#include <ZW_typedefs.h>
#include <ZW_application_transport_interface.h>
 
typedef struct {
  StaticTask_t*  taskBuffer;         
  uint8_t*       stackBuffer;        
  uint16_t       stackBufferLength;  
} ZW_UserTask_Buffer_t;
 
typedef enum {
  USERTASK_PRIORITY_BACKGROUND = 0, 
  USERTASK_PRIORITY_NORMAL,         
  USERTASK_PRIORITY_HIGHEST,        
} ZW_UserTask_Priority_t;
 
typedef struct {
  TaskFunction_t         pTaskFunc;      
  char*                  pTaskName;      
  void*                  pUserTaskParam; 
  ZW_UserTask_Priority_t priority;       
  ZW_UserTask_Buffer_t*  taskBuffer;     
} ZW_UserTask_t;
 
typedef enum {
  Code_Success = 0,           
  Code_Fail_Unknown,          
  Code_Fail_NoMemory,         
  Code_Fail_LimitReached,     
  Code_Fail_NotFound,         
  Code_Fail_Suspended,        
  Code_Fail_InvalidState,     
  Code_Fail_InvalidOperation, 
  Code_Fail_InvalidParameter, 
  Code_DependencyUnavailable, 
  Code_Fail_Busy,             
  Code_Fail_Timeout,          
  Code_Fail_Driver,           
  Code_Fail_NotImplemented,   
  Code_Fail_NotAllowed,       
} ReturnCode_t;
 
ReturnCode_t ZW_UserTask_Init(void);
 
ReturnCode_t ZW_UserTask_CreateTask(ZW_UserTask_t* task, TaskHandle_t* xHandle);
 
bool ZW_UserTask_ApplicationRegisterTask(  VOID_CALLBACKFUNC(appTaskFunc)(SApplicationHandles*),
                                           uint8_t iZwRxQueueTaskNotificationBitNumber,
                                           uint8_t iZwCommandStatusQueueTaskNotificationBitNumber,
                                           const SProtocolConfig_t * pProtocolConfig);
 
#endif // _USER_TASK_API_H_