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 #if HAS_TASK_QUEUE
  21 #include <ao_list.h>
  22 #endif
  23
  24 /* An AltOS task */
  25 struct ao_task {
  26         __xdata void *wchan;            /* current wait channel (NULL if running) */
  27         uint16_t alarm;                 /* abort ao_sleep time */
  28         ao_arch_task_members            /* any architecture-specific fields */
  29         uint8_t task_id;                /* unique id */
  30         __code char *name;              /* task name */
  31 #if HAS_TASK_QUEUE
  32         struct ao_list  queue;
  33         struct ao_list  alarm_queue;
  34 #endif
  35         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  36 #if HAS_SAMPLE_PROFILE
  37         uint32_t ticks;
  38         uint32_t yields;
  39         uint16_t start;
  40         uint16_t max_run;
  41 #endif
  42 };
  43
  44 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  45 #define AO_NO_TASK              0       /* no task id */
  46
  47 extern __xdata struct ao_task * __xdata ao_tasks[AO_NUM_TASKS];
  48 extern __data uint8_t ao_num_tasks;
  49 extern __xdata struct ao_task *__data ao_cur_task;
  50 extern __data uint8_t ao_task_minimize_latency; /* Reduce IRQ latency */
  51
  52 /*
  53  ao_task.c
  54  */
  55
  56 /* Suspend the current task until wchan is awoken.
  57  * returns:
  58  *  0 on normal wake
  59  *  1 on alarm
  60  */
  61 uint8_t
  62 ao_sleep(__xdata void *wchan);
  63
  64 /* Wake all tasks sleeping on wchan */
  65 void
  66 ao_wakeup(__xdata void *wchan);
  67
  68 /* set an alarm to go off in 'delay' ticks */
  69 void
  70 ao_alarm(uint16_t delay);
  71
  72 /* Clear any pending alarm */
  73 void
  74 ao_clear_alarm(void);
  75
  76 /* Yield the processor to another task */
  77 void
  78 ao_yield(void) ao_arch_naked_declare;
  79
  80 /* Add a task to the run queue */
  81 void
  82 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
  83
  84 #if HAS_TASK_QUEUE
  85 /* Called on timer interrupt to check alarms */
  86 extern uint16_t ao_task_alarm_tick;
  87 void
  88 ao_task_check_alarm(uint16_t tick);
  89 #endif
  90
  91 /* Terminate the current task */
  92 void
  93 ao_exit(void);
  94
  95 /* Dump task info to console */
  96 void
  97 ao_task_info(void);
  98
  99 /* Start the scheduler. This will not return */
 100 void
 101 ao_start_scheduler(void);
 102
 103 #if HAS_TASK_QUEUE
 104 void
 105 ao_task_init(void);
 106 #else
 107 #define ao_task_init()
 108 #endif
 109
 110 #endif