git.gag.com Git - fw/altos/blob - src/core/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; version 2 of the License.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16  */
  17
  18 #ifndef _AO_TASK_H_
  19 #define _AO_TASK_H_
  20
  21 /* An AltOS task */
  22 struct ao_task {
  23         __xdata void *wchan;            /* current wait channel (NULL if running) */
  24         uint16_t alarm;                 /* abort ao_sleep time */
  25         ao_arch_task_members            /* any architecture-specific fields */
  26         uint8_t task_id;                /* unique id */
  27         __code char *name;              /* task name */
  28         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  29 #if HAS_SAMPLE_PROFILE
  30         uint32_t ticks;
  31         uint32_t yields;
  32         uint16_t start;
  33         uint16_t max_run;
  34 #endif
  35 };
  36
  37 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  38 #define AO_NO_TASK              0       /* no task id */
  39
  40 extern __xdata struct ao_task * __xdata ao_tasks[AO_NUM_TASKS];
  41 extern __data uint8_t ao_num_tasks;
  42 extern __data uint8_t ao_cur_task_index;
  43 extern __xdata struct ao_task *__data ao_cur_task;
  44
  45 /*
  46  ao_task.c
  47  */
  48
  49 /* Suspend the current task until wchan is awoken.
  50  * returns:
  51  *  0 on normal wake
  52  *  1 on alarm
  53  */
  54 uint8_t
  55 ao_sleep(__xdata void *wchan);
  56
  57 /* Wake all tasks sleeping on wchan */
  58 void
  59 ao_wakeup(__xdata void *wchan);
  60
  61 /* set an alarm to go off in 'delay' ticks */
  62 void
  63 ao_alarm(uint16_t delay);
  64
  65 /* Clear any pending alarm */
  66 void
  67 ao_clear_alarm(void);
  68
  69 /* Yield the processor to another task */
  70 void
  71 ao_yield(void) ao_arch_naked_declare;
  72
  73 /* Add a task to the run queue */
  74 void
  75 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
  76
  77 /* Terminate the current task */
  78 void
  79 ao_exit(void);
  80
  81 /* Dump task info to console */
  82 void
  83 ao_task_info(void);
  84
  85 /* Start the scheduler. This will not return */
  86 void
  87 ao_start_scheduler(void);
  88
  89 #endif