TaskP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_osal_TaskP__include
#define ti_osal_TaskP__include
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
typedef enum TaskP_Status_e
{
    TaskP_OK         = 0,
    TaskP_FAILURE    = (-(int32_t)1)
} TaskP_Status;
 
#define OS_TICKS_IN_MILLI_SEC   1 /* 1000us tick */
 
typedef  void *TaskP_Handle;
 
typedef unsigned long TaskP_Privilege_Mode;
 
typedef void ( * TaskP_Fxn )( void *arg0, void *arg1 );
 
typedef struct TaskP_Params_s
{
    const char *name;    
    int8_t priority;     
    /* Add padding members below to fix PORTING.STORAGE.STRUCT KW issue   */
    uint8_t padding1;    
    uint16_t padding2;   
    uint32_t stacksize;  
    void *pErrBlk;       
    void *arg0;          
    void *arg1;          
    void *stack;         
    void *userData;      
    TaskP_Privilege_Mode taskPrivilege; 
} TaskP_Params;
 
extern TaskP_Handle TaskP_create(TaskP_Fxn taskfxn,
                                 const TaskP_Params *params);
extern TaskP_Status TaskP_delete(TaskP_Handle *handle);
 
extern void TaskP_Params_init(TaskP_Params *params);
 
extern void TaskP_sleep(uint32_t timeout);
 
extern void TaskP_sleepInMsecs(uint32_t timeoutInMsecs);
 
extern void TaskP_setPrio(TaskP_Handle handle, uint32_t priority);
 
extern TaskP_Handle TaskP_self(void);
 
extern TaskP_Handle TaskP_selfmacro(void);
 
extern void TaskP_yield(void);
 
extern uint32_t TaskP_isTerminated(TaskP_Handle handle);
 
extern uint32_t TaskP_disable(void);
 
extern void TaskP_restore(uint32_t key);
 
extern uint32_t TaskP_getTaskStackHighWatermark(TaskP_Handle handle);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ti_osal_TaskP__include */
/* @} */