TaskP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023, 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_dpl_TaskP__include
#define ti_dpl_TaskP__include

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

#if defined(__GNUC__)
    #define TaskP_STRUCT_SIZE (340)
#else
    #define TaskP_STRUCT_SIZE (104)
#endif

#define TaskP_DEFAULT_STACK_SIZE (512)

typedef union TaskP_Struct
{
    uint32_t dummy; 
    uint8_t data[TaskP_STRUCT_SIZE];
} TaskP_Struct;

typedef enum
{
    TaskP_State_RUNNING,
    TaskP_State_READY,
    TaskP_State_BLOCKED,
    TaskP_State_DELETED,
    TaskP_State_INACTIVE,
    TaskP_State_INVALID
} TaskP_State;

typedef TaskP_Struct *TaskP_Handle;

typedef struct
{
    char *name;
    void *arg;
    int priority;
    size_t stackSize;
    void *stack;
} TaskP_Params;

typedef void (*TaskP_Function)(void *);

extern TaskP_Handle TaskP_create(TaskP_Function fxn, const TaskP_Params *params);

extern void TaskP_delete(TaskP_Handle task);

extern TaskP_Handle TaskP_construct(TaskP_Struct *obj, TaskP_Function fxn, const TaskP_Params *params);

extern void TaskP_destruct(TaskP_Struct *obj);

extern TaskP_State TaskP_getState(TaskP_Handle task);

extern TaskP_Handle TaskP_getCurrentTask(void);

extern uintptr_t TaskP_disableScheduler(void);

extern void TaskP_restoreScheduler(uintptr_t key);

extern void TaskP_yield(void);

extern void TaskP_Params_init(TaskP_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_TaskP__include */