Working mailbox implementation

This commit is contained in:
Anthony Rabine 2023-07-16 22:48:03 +02:00
parent e552978acf
commit ac469109ca
4 changed files with 174 additions and 109 deletions

View file

@ -31,7 +31,7 @@ add_library(
pico_generate_pio_header(${PROJECT_NAME} ${CMAKE_CURRENT_LIST_DIR}/pico_i2s.pio)
pico_generate_pio_header(${PROJECT_NAME} ${CMAKE_CURRENT_LIST_DIR}/i2s.pio)
target_link_libraries(${PROJECT_NAME} INTERFACE pico_stdlib hardware_exception)
target_link_libraries(${PROJECT_NAME} INTERFACE pico_stdlib hardware_exception cmsis_core)
target_include_directories(${PROJECT_NAME} INTERFACE ${CMAKE_CURRENT_LIST_DIR})
target_sources(${PROJECT_NAME} INTERFACE

View file

@ -75,6 +75,7 @@ ost_event_t ev_queue[10];
qor_tcb_t tcb1;
qor_tcb_t tcb2;
qor_tcb_t idle;
void UserTask_0(void *args)
{
@ -111,6 +112,10 @@ void UserTask_0(void *args)
void UserTask_1(void *args)
{
static ost_event_t wake_up;
wake_up.ev = 34;
while (1)
{
for (int i = 0; i < 65500; i++)
@ -124,8 +129,20 @@ void UserTask_1(void *args)
for (int j = 0; j < 100; j++)
;
}
qor_mbox_notify(&b, (void **)&wake_up, 1);
}
}
void IdleTaskFunction(void *args)
{
while (1)
{
// Instrumentation, power saving, os functions won't work here
__asm volatile("wfi");
}
}
/*
void UserTask_2(void)
{
@ -168,11 +185,11 @@ int main()
// ost_audio_play("out2.wav");
OS_Init(THREADFREQ);
qor_create_thread(&tcb1, UserTask_0, 1, "UserTask_0");
qor_create_thread(&tcb2, UserTask_1, 2, "UserTask_1");
qor_create_thread(&tcb1, UserTask_0, 2, "UserTask_0");
qor_create_thread(&tcb2, UserTask_1, 1, "UserTask_1");
// OS_Thread_Create(UserTask_2, OS_SCHEDL_PRIO_MAIN_THREAD, "UserTask_2");
// OS_Thread_Create(OnboardUserButton_Task, OS_SCHEDL_PRIO_EVENT_THREAD, "OnboardUserButton_Task");
qor_start();
qor_start(&idle, IdleTaskFunction);
for (;;)
{

View file

@ -15,8 +15,18 @@
#include "qor.h"
#include <stdlib.h>
// Raspberry Pico SDK
#include "pico/stdlib.h"
#include "hardware/uart.h"
#include "hardware/spi.h"
#include "hardware/dma.h"
#include "hardware/irq.h"
#include "hardware/pio.h"
#include "hardware/clocks.h"
#include "pico.h"
#include "pico/critical_section.h"
#include "hardware/exception.h"
#include "RP2040.h"
// ===========================================================================================================
// ARM GENERIC
@ -37,23 +47,6 @@ void qor_sleep_ms(uint8_t svc, uint32_t ms)
__wfi;
}
static inline void __set_PRIMASK(uint32_t priMask)
{
__asm volatile("MSR primask, %0"
:
: "r"(priMask)
: "memory");
}
static inline uint32_t __get_PRIMASK(void)
{
uint32_t result;
__asm volatile("MRS %0, primask"
: "=r"(result));
return (result);
}
static inline uint32_t qor_enter_critical(void)
{
uint32_t primask = __get_PRIMASK();
@ -103,6 +96,44 @@ static const bool qor_inside_interrupt(void)
return xReturn;
}
// ===========================================================================================================
// RASPBERRY PICO
// ===========================================================================================================
static volatile uint32_t timer_period;
#define ALARM_NUM 0
#define ALARM_IRQ TIMER_IRQ_0
//-----------------------------------------------------------------------------
static void alarm_irq(void)
{
// Clear the alarm irq
hw_clear_bits(&timer_hw->intr, 1u << ALARM_NUM);
}
//-----------------------------------------------------------------------------
static void timer_init(uint32_t delay_us)
{
// Enable the interrupt for our alarm (the timer outputs 4 alarm irqs)
hw_set_bits(&timer_hw->inte, 1u << ALARM_NUM);
// Set irq handler for alarm irq
irq_set_exclusive_handler(ALARM_IRQ, alarm_irq);
// Enable the alarm irq
irq_set_enabled(ALARM_IRQ, true);
// Enable interrupt in block and at processor
// Alarm is only 32 bits so if trying to delay more
// than that need to be careful and keep track of the upper
// bits
uint64_t target = timer_hw->timerawl + delay_us;
// Write the lower 32 bits of the target time to the alarm which
// will arm it
timer_hw->alarm[ALARM_NUM] = (uint32_t)target;
}
// ===========================================================================================================
// GLOBAL AND STATIC VARIABLES
// ===========================================================================================================
@ -112,6 +143,8 @@ static uint32_t Stacks[MAXNUMTHREADS][STACKSIZE];
/* Pointer to the currently running thread */
qor_tcb_t *RunPt = NULL;
static qor_tcb_t *TcbHead = NULL;
static qor_tcb_t *IdleTcb = NULL;
static thread_func_t IdleTask = NULL;
/* The variable ActiveTCBsCount tracks the number of TCBs in use by the OS */
static uint32_t ActiveTCBsCount = 0;
@ -162,7 +195,6 @@ void qor_create_thread(qor_tcb_t *tcb, thread_func_t task, uint8_t priority, con
tcb->name = name;
tcb->next = NULL;
tcb->mbox = NULL;
tcb->message = NULL;
tcb->wait_next = NULL;
tcb->sp = qor_initialize_stack(&Stacks[ActiveTCBsCount][STACKSIZE], task, (void *)name);
@ -186,11 +218,20 @@ void qor_create_thread(qor_tcb_t *tcb, thread_func_t task, uint8_t priority, con
enable_irq();
}
void qor_start(void)
bool qor_start(qor_tcb_t *idle_tcb, thread_func_t idle_task)
{
assert_or_panic(ActiveTCBsCount > 0);
if ((idle_task == NULL) || (idle_tcb == NULL))
{
return false;
}
qor_create_thread(idle_tcb, idle_task, 0, "IdleTask");
// FIXME: use the scheduler to find the best first thread to start
IdleTcb = idle_tcb;
IdleTask = idle_task;
RunPt = TcbHead;
/* Prevent the timer's ISR from firing before OSAsm_Start is called */
disable_irq();
@ -199,33 +240,55 @@ void qor_start(void)
/* This statement should not be reached */
ost_hal_panic();
return true;
}
void qor_scheduler(void)
{
/*
La stratégie est la suivante:
- On va circuler parmi tous les TCB (liste chaînée)
- On va retenir le TCB dont la priorité est la plus élevée parmi les actifs
- On va retenir le TCB dont la priorité est la plus élevée parmi les endormis
- On va élir le TCB actif trouvé, sinon l'endormi, et finalement la tâche idle si aucune autre tâche n'est éligible
*/
uint32_t max_priority = 0;
qor_tcb_t *best_active = NULL;
qor_tcb_t *best_sleeping = NULL;
qor_tcb_t *t = TcbHead;
/* Search for highest priority thread not sleeping or blocked */
uint32_t max_priority = RunPt->priority;
qor_tcb_t *best_pt = RunPt;
while (t != NULL)
{
if ((t->priority > max_priority) &&
(t->wait_time == 0) &&
(t->state == qor_tcb_state_active))
(t->wait_time == 0))
{
best_pt = t;
max_priority = t->priority;
if (t->state == qor_tcb_state_active)
{
best_active = t;
}
else
{
best_sleeping = t;
}
}
t = t->next;
}
RunPt = best_pt;
}
void OS_Thread_Suspend(void)
if (best_active != NULL)
{
// SchedlTimer_ResetCounter();
RunPt = best_active;
}
else if (best_sleeping != NULL)
{
RunPt = best_sleeping;
}
else
{
RunPt = IdleTcb;
}
}
void qor_sleep(uint32_t sleep_duration_ms)
@ -273,9 +336,6 @@ void OS_Thread_Kill(void)
// MAILBOX IMPLEMENTATION
// ===========================================================================================================
#define qor_mbox_tSendNormal 0x0
#define qor_mbox_tSendFront 0x1
void qor_mbox_init(qor_mbox_t *mbox, void **msgBuffer, uint32_t maxCount)
{
mbox->msgBuffer = msgBuffer;
@ -289,50 +349,36 @@ uint32_t qor_mbox_wait(qor_mbox_t *mbox, void **msg, uint32_t waitTicks)
{
uint32_t status = qor_enter_critical();
// No any data, block on that resource
if (mbox->count == 0)
{
if (waitTicks > 0)
{
// No any data, block on that resource
RunPt->mbox = mbox;
RunPt->state = qor_tcb_state_wait_mbox;
RunPt->state = qor_tcb_state_sleep;
RunPt->wait_time = waitTicks;
mbox->head = RunPt;
qor_exit_critical(status);
qor_svc_call(); // call scheduler
qor_svc_call(); // call scheduler, wait for message
}
else
{
qor_exit_critical(status);
return QOR_MBOX_ERROR;
}
}
status = qor_enter_critical();
if ((RunPt->wait_time >= 0) && (RunPt->message != NULL))
--mbox->count;
*msg = mbox->msgBuffer[mbox->read++];
if (mbox->read >= mbox->maxCount)
{
*msg = RunPt->message;
mbox->read = 0;
}
qor_exit_critical(status);
return QOR_MBOX_OK;
}
else
{
qor_exit_critical(status);
return QOR_MBOX_ERROR;
}
}
else
{
return QOR_MBOX_ERROR;
}
}
else
{
if ((RunPt->message != NULL))
{
*msg = RunPt->message;
qor_exit_critical(status);
return QOR_MBOX_OK;
}
else
{
qor_exit_critical(status);
return QOR_MBOX_ERROR;
}
}
}
/*
uint32_t qor_mbox_get(qor_mbox_t *mbox, void **msg)
@ -357,27 +403,19 @@ uint32_t qor_mbox_get(qor_mbox_t *mbox, void **msg)
}
*/
/*
#define QOR_MBOX_OPTION_SEND_FRONT 1
#define QOR_MBOX_OPTION_SEND_BACK 2
uint32_t qor_mbox_notify(qor_mbox_t *mbox, void *msg, uint32_t notifyOption)
{
uint32_t status = qor_enter_critical();
if (tEventWaitCount(&mbox->event) > 0)
{
tTask *task = tEventWakeUp(&mbox->event, (void *)msg, tErrorNoError);
if (task->prio < currentTask->prio)
{
tTaskSched();
}
}
else
{
if (mbox->count >= mbox->maxCount)
{
qor_exit_critical(status);
return tErrorResourceFull;
return QOR_MBOX_FULL;
}
if (notifyOption & qor_mbox_tSendFront)
if (notifyOption == QOR_MBOX_OPTION_SEND_FRONT)
{
if (mbox->read <= 0)
{
@ -398,11 +436,18 @@ uint32_t qor_mbox_notify(qor_mbox_t *mbox, void *msg, uint32_t notifyOption)
}
}
mbox->count++;
// We warn all waiting threads that a new message is available
qor_tcb_t *t = mbox->head;
if (t != NULL)
{
t->wait_time = 0;
}
qor_exit_critical(status);
return tErrorNoError;
qor_svc_call(); // call scheduler
return QOR_MBOX_OK;
}
*/
void qor_mbox_flush(qor_mbox_t *mbox)
{

View file

@ -1,6 +1,9 @@
#ifndef QOR_H
#define QOR_H
#include <stdint.h>
#include <stdbool.h>
extern void ost_hal_panic();
/**
@ -13,8 +16,6 @@ extern void ost_hal_panic();
* exposes the functions for interacting with it.
*/
#include <stdint.h>
#define MAXNUMTHREADS 10 /* Maximum number of threads, allocated at compile time */
#define STACKSIZE 100 /* Number of 32-bit words in each TCB's stack */
#define THREADFREQ 1 /* Maximum time-slice, in Hz, before the scheduler is run */
@ -42,7 +43,6 @@ typedef void (*thread_func_t)(void *args);
typedef enum
{
qor_tcb_state_active,
qor_tcb_state_wait_mbox,
qor_tcb_state_sleep
} qor_tcb_state_t;
@ -62,7 +62,6 @@ typedef struct TCB
qor_tcb_state_t state; /* TCB active or free */
uint32_t wait_time; //!< Timeout for mbox maiting or sleep
qor_mbox_t *mbox; /* Pointer to mailbox on which the thread is blocked, NULL if not blocked */
void *message; //<! Actually the message transmitted
uint8_t priority; /* Thread priority, 0 is highest, 255 is lowest */
const char *name; /* Descriptive name to facilitate debugging */
@ -76,9 +75,7 @@ void qor_create_thread(qor_tcb_t *tcb, thread_func_t task, uint8_t priority, con
void qor_switch_context();
void qor_start(void);
void OS_Thread_Suspend(void);
bool qor_start(qor_tcb_t *idle_tcb, thread_func_t idle_task);
void qor_sleep(uint32_t sleep_duration_ms);
@ -110,8 +107,14 @@ typedef struct
#define QOR_MBOX_OK 1
#define QOR_MBOX_ERROR 2
#define QOR_MBOX_FULL 3
void qor_mbox_init(qor_mbox_t *mbox, void **msgBuffer, uint32_t maxCount);
uint32_t qor_mbox_wait(qor_mbox_t *mbox, void **msg, uint32_t waitTicks);
#define QOR_MBOX_OPTION_SEND_FRONT 1
#define QOR_MBOX_OPTION_SEND_BACK 2
uint32_t qor_mbox_notify(qor_mbox_t *mbox, void *msg, uint32_t notifyOption);
#endif // QOR_H