SRTOS/html/task_8h_source.html

#ifndef TASK_H_

#define TASK_H_


#include "fault.h"

#include "kernel_config.h"

#include "mcu_macros.h"

#include "system_funcs.h"

#include <stddef.h>

#include <stdint.h>

#include <stdlib.h>


typedef enum

{

  STATUS_SUCCESS = 0,

  STATUS_FAILURE = 1

} STATUS;


typedef struct

{

  uint32_t *sp;

  uint32_t priority;

  uint32_t id;

  uint32_t delayedUntil;

  uint32_t *stackFrameLowerBoundAddr;

} TCB;


typedef struct TaskNode TaskNode;


struct TaskNode

{

  TCB *taskTCB;

  TaskNode *next;

};


extern volatile uint32_t msTicks;


extern TaskNode *readyTasksList[MAX_PRIORITIES];


uint32_t *initTaskStackFrame (uint32_t taskStack[], void (*taskFunc) (void));


STATUS

createTask (uint32_t taskStack[], void (*taskFunc) (void),

            unsigned int priority, TCB *userAllocatedTCB,

            TaskNode *userAllocatedTaskNode);


void SysTick_Handler ();

void PendSV_Handler ();

void SVC_Handler ();

void setPendSVPending ();


void startScheduler ();


void taskDelay (uint32_t ticksToDelay);


uint32_t getCurTaskWordsAvailable ();


void handleStackOverflow ();


#endif

fault.h
Fault handling interface for SRTOS.

kernel_config.h
Core configuration parameters for SRTOS.

MAX_PRIORITIES
#define MAX_PRIORITIES
Number of unique task priority levels supported by the scheduler.
Definition kernel_config.h:27

mcu_macros.h
Memory-mapped register addresses and hardware access macros for the STM32F411VET6.

TCB
This struct is the Task Control Block (TCB), which is what stores a task's properties.
Definition task.h:31

TCB::priority
uint32_t priority
Definition task.h:33

TCB::delayedUntil
uint32_t delayedUntil
Definition task.h:35

TCB::sp
uint32_t * sp
Definition task.h:32

TCB::id
uint32_t id
Definition task.h:34

TCB::stackFrameLowerBoundAddr
uint32_t * stackFrameLowerBoundAddr
Definition task.h:36

TaskNode
Definition task.h:45

TaskNode::taskTCB
TCB * taskTCB
Definition task.h:46

TaskNode::next
TaskNode * next
Definition task.h:47

system_funcs.h
This header files contains kernel functions that help control system behvaior.

msTicks
volatile uint32_t msTicks
msTicks contains the amount of ticks that have occured since the scheduler started.
Definition task.c:10

readyTasksList
TaskNode * readyTasksList[MAX_PRIORITIES]
This is a list of linked lists that contain the ready tasks.
Definition task.c:12

taskDelay
void taskDelay(uint32_t ticksToDelay)
This function will delay a task's execution for ticksToDelay ms.
Definition task.c:237

initTaskStackFrame
uint32_t * initTaskStackFrame(uint32_t taskStack[], void(*taskFunc)(void))
Initializes a task's stack frame.
Definition task.c:46

startScheduler
void startScheduler()
Start the scheduler.
Definition task.c:218

STATUS
STATUS
This enum is used to indicate whether an operation was sucessful or not.
Definition task.h:22

STATUS_FAILURE
@ STATUS_FAILURE
Definition task.h:24

STATUS_SUCCESS
@ STATUS_SUCCESS
Definition task.h:23

PendSV_Handler
void PendSV_Handler()
This interrupt will be pended when a context switch is needed.
Definition task.c:166

SVC_Handler
void SVC_Handler()
This interrupt will be executed when the scheduler is started.
Definition task.c:203

SysTick_Handler
void SysTick_Handler()
This interrupt handler will be called every 1 ms, checking if any tasks need to be unblocked or block...
Definition task.c:115

getCurTaskWordsAvailable
uint32_t getCurTaskWordsAvailable()
This function will return the minimum number of words left on the stack.
Definition task.c:503

handleStackOverflow
void handleStackOverflow()
This function will be called when a stack overflow is detected. This function will only be called if ...

setPendSVPending
void setPendSVPending()
This function will be called when a context-switch is needed.
Definition task.c:231

createTask
STATUS createTask(uint32_t taskStack[], void(*taskFunc)(void), unsigned int priority, TCB *userAllocatedTCB, TaskNode *userAllocatedTaskNode)
Add a task to the scheduler's ready list.
Definition task.c:77