TaskP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  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 TASKP_H
#define TASKP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#if defined(__ARM_ARCH_7R__)
#include <kernel/dpl/MpuP_armv7.h>
#endif
 
typedef void (*TaskP_FxnMain)(void *args);
 
#define TaskP_PRIORITY_LOWEST       (0u)
 
#define TaskP_PRIORITY_HIGHEST      (31u)
 
#define TaskP_LOAD_UPDATE_WINDOW_MSEC   (500u)
 
 
typedef struct {
 
    const char  *name;     
    uint64_t runTime;   
    uint64_t totalTime; 
    uint32_t cpuLoad;   
} TaskP_Load;
 
#ifdef INCLUDE_FREERTOS_FAT
#define TaskP_OBJECT_SIZE_MAX       (172u) /* Minimum requirement for FreeRTOS FATFS to work */
#elif MPU_FREERTOS
 
#define TaskP_OBJECT_SIZE_MAX       (4568u) 
#else
#define TaskP_OBJECT_SIZE_MAX       (160u)
#endif 
 
typedef struct TaskP_Object_ {
 
    /* uintptr_t translates to uint64_t for A53 and uint32_t for R5 and M4 */
    /* This accounts for the 64bit pointer in A53 and 32bit pointer in R5 and M4 */
    uintptr_t rsv[TaskP_OBJECT_SIZE_MAX/sizeof(uint32_t)]; 
} TaskP_Object;
 
typedef struct TaskP_Params_ {
 
    const char   *name;         
    uint32_t      stackSize;    
    uint8_t      *stack;        
    uint32_t      priority;     
    void         *args;         
    TaskP_FxnMain taskMain;     
    uintptr_t     coreAffinity; 
} TaskP_Params;
 
#if defined(__ARM_ARCH_7R__)
 
typedef struct TaskP_MpuRegionConfig_ {
    uint32_t baseAddr;      
    uint32_t sizeBytes;     
    MpuP_RegionAttrs attrs; 
} TaskP_MpuRegionConfig;
 
typedef struct TaskP_ParamsRestricted_ {
    TaskP_Params          params;           
    TaskP_MpuRegionConfig regionConfig[7U]; 
    // TODO: Replace with below after TaskP refactor to include FreeRTOS headers and structs directly.
    // TaskP_MpuRegionConfig regionConfig[portNUM_CONFIGURABLE_REGIONS]; /**< MPU region configurations */
} TaskP_ParamsRestricted;
#endif
 
void TaskP_Params_init(TaskP_Params *params);
 
int32_t TaskP_construct(TaskP_Object *obj, const TaskP_Params *params);
 
#if defined(__ARM_ARCH_7R__)
 
void TaskP_ParamsRestricted_init(TaskP_ParamsRestricted *params);
 
int32_t TaskP_constructRestricted(TaskP_Object *obj, const TaskP_ParamsRestricted *params);
#endif
 
void TaskP_destruct(TaskP_Object *obj);
 
 
void* TaskP_getHndl(TaskP_Object *obj);
 
void TaskP_yield(void);
 
void TaskP_exit(void);
 
void TaskP_loadGet(TaskP_Object *obj, TaskP_Load *taskLoad);
 
void TaskP_loadUpdateAll(void);
 
void TaskP_loadResetAll(void);
 
 
uint32_t TaskP_loadGetTotalCpuLoad(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* TASKP_H */