git.gag.com Git - fw/altos/blob - src/kernel/ao_task.h

   1 /*
   2  * Copyright © 2012 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #ifndef _AO_TASK_H_
  20 #define _AO_TASK_H_
  21 #if HAS_TASK_QUEUE
  22 #include <ao_list.h>
  23 #endif
  24
  25 #ifndef HAS_TASK_INFO
  26 #define HAS_TASK_INFO 1
  27 #endif
  28
  29 /* arm stacks must be 32-bit aligned */
  30 #ifndef AO_STACK_ALIGNMENT
  31 #ifdef __arm__
  32 #define AO_STACK_ALIGNMENT __attribute__ ((aligned(4)))
  33 #else
  34 #define AO_STACK_ALIGNMENT
  35 #endif
  36 #endif
  37
  38 /* An AltOS task */
  39 struct ao_task {
  40         void *wchan;            /* current wait channel (NULL if running) */
  41         uint16_t alarm;                 /* abort ao_sleep time */
  42         ao_arch_task_members            /* any architecture-specific fields */
  43         uint8_t task_id;                /* unique id */
  44         const char *name;               /* task name */
  45 #ifdef NEWLIB
  46         int __errno;                    /* storage for errno in newlib libc */
  47 #endif
  48 #if HAS_TASK_QUEUE
  49         struct ao_list  queue;
  50         struct ao_list  alarm_queue;
  51 #endif
  52         uint8_t stack[AO_STACK_SIZE] AO_STACK_ALIGNMENT;        /* saved stack */
  53 #if HAS_SAMPLE_PROFILE
  54         uint32_t ticks;
  55         uint32_t yields;
  56         uint16_t start;
  57         uint16_t max_run;
  58 #endif
  59 };
  60
  61 #ifndef AO_NUM_TASKS
  62 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  63 #endif
  64
  65 #define AO_NO_TASK              0       /* no task id */
  66
  67 extern struct ao_task * ao_tasks[AO_NUM_TASKS];
  68 extern uint8_t ao_num_tasks;
  69 extern struct ao_task *ao_cur_task;
  70 extern uint8_t ao_task_minimize_latency;        /* Reduce IRQ latency */
  71
  72 #ifndef HAS_ARCH_VALIDATE_CUR_STACK
  73 #define ao_validate_cur_stack()
  74 #endif
  75
  76 /*
  77  ao_task.c
  78  */
  79
  80 /* Suspend the current task until wchan is awoken.
  81  * returns:
  82  *  0 on normal wake
  83  *  1 on alarm
  84  */
  85 uint8_t
  86 ao_sleep(void *wchan);
  87
  88 /* Suspend the current task until wchan is awoken or the timeout
  89  * expires. returns:
  90  *  0 on normal wake
  91  *  1 on alarm
  92  */
  93 uint8_t
  94 ao_sleep_for(void *wchan, uint16_t timeout);
  95
  96 /* Wake all tasks sleeping on wchan */
  97 void
  98 ao_wakeup(void *wchan);
  99
 100 #if 0
 101 /* set an alarm to go off in 'delay' ticks */
 102 void
 103 ao_alarm(uint16_t delay);
 104
 105 /* Clear any pending alarm */
 106 void
 107 ao_clear_alarm(void);
 108 #endif
 109
 110 /* Yield the processor to another task */
 111 void
 112 ao_yield(void) ao_arch_naked_declare;
 113
 114 /* Add a task to the run queue */
 115 void
 116 ao_add_task(struct ao_task * task, void (*start)(void), const char *name);
 117
 118 #if HAS_TASK_QUEUE
 119 /* Called on timer interrupt to check alarms */
 120 extern uint16_t ao_task_alarm_tick;
 121 void
 122 ao_task_check_alarm(uint16_t tick);
 123 #endif
 124
 125 /* Terminate the current task */
 126 void
 127 ao_exit(void);
 128
 129 /* Dump task info to console */
 130 void
 131 ao_task_info(void);
 132
 133 /* Start the scheduler. This will not return */
 134 void
 135 ao_start_scheduler(void) __attribute__((noreturn));
 136
 137 #if HAS_TASK_QUEUE
 138 void
 139 ao_task_init(void);
 140 #else
 141 #define ao_task_init()
 142 #endif
 143
 144 #endif