C:/Users/Keith/source/repos/piccolo_os_plus/piccolo_os.h

Go to the documentation of this file.

 
#ifndef PICCOLO_OS_H
#define PICCOLO_OS_H
#include "hardware/sync.h"
#include "pico/stdlib.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define PICCOLO_OS_STACK_SIZE 1024
 
#define PICCOLO_OS_THREAD_PSP 0xFFFFFFFD
 
#define PICCOLO_OS_TIME_SLICE 1000
#define PICCOLO_OS_MAX_IDLE 700
 
#define PICCOLO_OS_NO_IDLE_FOR_SIGNALS true
 
#define PICCOLO_OS_MULTICORE true
 
#define PICCOLO_OS_MAX_SIGNAL 10
 
#define PICCOLO_SPIN_LOCK_ID PICO_SPINLOCK_ID_OS1
 
// \cond force_doxygen_to_list
typedef /*\endcond**/
struct piccolo_os_task_t {
    volatile uint32_t task_flags;               
    struct piccolo_os_task_t *next_task;        
    struct piccolo_os_task_t *prev_task;        
    struct piccolo_os_task_t *task_sending_to;  
    absolute_time_t wakeup;                     
    volatile uint32_t signal_in;                
    volatile uint32_t signal_out;               
    uint32_t signal_limit;                      
    uint32_t *stack_ptr;                        
    uint32_t __attribute__((aligned(8))) stack[PICCOLO_OS_STACK_SIZE];       
}  piccolo_os_task_t;
 
struct {
  piccolo_os_task_t* task_list_head;   
  piccolo_os_task_t* task_list_tail;   
  volatile piccolo_os_task_t* this_task[2];     
  volatile piccolo_os_task_t *current_task;     
  piccolo_os_task_t *zombies;          
   piccolo_os_task_t *garbage_man;              
  spin_lock_t *piccolo_lock;                    
} typedef piccolo_os_internals_t;
 
// Define Task Flag values
enum piccolo_task_flag_values
{
    PICCOLO_TASK_RUNNING    = 0x1,      
    PICCOLO_TASK_ZOMBIE     = 0x2,      
    PICCOLO_TASK_SLEEPING   = 0x4,      
    PICCOLO_TASK_GET_SIGNAL_BLOCKED     = 0x8,  
    PICCOLO_TASK_SEND_SIGNAL_BLOCKED    = 0x10, 
    PICCOLO_TASK_BLOCKING = (PICCOLO_TASK_SLEEPING | PICCOLO_TASK_GET_SIGNAL_BLOCKED | PICCOLO_TASK_SEND_SIGNAL_BLOCKED) \
};
 
void piccolo_init();
void piccolo_start();
 
piccolo_os_task_t* piccolo_create_task(void (*pointer_to_task_function)(void));
void piccolo_end_task();
 
 
 
__force_inline static void piccolo_yield(void) {
    __asm volatile ("nop" );
    __asm volatile ("svc 0");
    __asm volatile ("nop" );
    return;
}
 
void piccolo_syscall(void);
void piccolo_sleep(uint32_t sleep_time_ms);
void piccolo_sleep_until(absolute_time_t until);
 
 
piccolo_os_task_t* piccolo_get_task_id();
int32_t piccolo_send_signal(piccolo_os_task_t* toTask);
int32_t piccolo_send_signal_blocking(piccolo_os_task_t* toTask);
int32_t piccolo_send_signal_blocking_timeout(piccolo_os_task_t* toTask,uint32_t timeout_ms);
int32_t piccolo_get_signal();
int32_t piccolo_get_signal_blocking();
int32_t piccolo_get_signal_blocking_timeout(uint32_t timeout_ms);
int32_t piccolo_get_signal_all();
int32_t piccolo_get_signal_all_blocking();
int32_t piccolo_get_signal_all_blocking_timeout(uint32_t timeout_ms);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif