Partial commit: Rename references to Drivers/AT90USBXXX to Drivers/Peripheral.

[pub/USBasp.git] / LUFA / Scheduler / Scheduler.h

diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h
index 39f94ef..904380c 100644 (file)
--- a/LUFA/Scheduler/Scheduler.h
+++ b/LUFA/Scheduler/Scheduler.h
@@ -30,10 +30,10 @@
 \r
 /** \file\r
  *\r
- *  Simple round-robbin cooperative scheduler for use in basic projects where non realtime tasks need\r
+ *  Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need\r
  *  to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group.\r
  *\r
- *  For a task to yield it must return, thus each task should have persistant data marked with the static attribute.\r
+ *  For a task to yield it must return, thus each task should have persistent data marked with the static attribute.\r
  *\r
  *  Usage Example:\r
  *  \code\r
@@ -65,6 +65,13 @@
  *  \endcode\r
  */\r
  \r
+/** @defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h\r
+ *\r
+ *  Simple round-robbin task scheduler. See Scheduler.h description for more details.\r
+ *\r
+ *  @{\r
+ */\r
+ \r
 #ifndef __SCHEDULER_H__\r
 #define __SCHEDULER_H__\r
 \r
@@ -107,7 +114,7 @@
                         *      }\r
                         *  \endcode\r
                         */\r
-                       #define TASK_LIST                         extern TaskEntry_t Scheduler_TaskList[]; TaskEntry_t Scheduler_TaskList[] = \r
+                       #define TASK_LIST                         TaskEntry_t Scheduler_TaskList[] = \r
                        \r
                        /** Constant, giving the maximum delay in scheduler ticks which can be stored in a variable of type\r
                         *  SchedulerDelayCounter_t.\r
@@ -120,16 +127,23 @@
                        /** Task status mode constant, for passing to Scheduler_SetTaskMode() or Scheduler_SetGroupTaskMode(). */\r
                        #define TASK_STOP                         false\r
                        \r
-                       /** Starts the scheduler in its infinite loop, executing running tasks. This should be placed at the end\r
-                        *  of the user application's main() function, as it can never return to the calling function.\r
-                        */\r
-                       #define Scheduler_Start()                 Scheduler_GoSchedule(TOTAL_TASKS);\r
-                       \r
-                       /** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself\r
-                        *  is started. This must be exeucted before any scheduler function calls other than Scheduler_Start(),\r
-                        *  and can be ommitted if no such functions could be called before the scheduler is started.\r
-                        */\r
-                       #define Scheduler_Init()                  Scheduler_InitScheduler(TOTAL_TASKS);\r
+               /* Psuedo-Functions: */\r
+                       #if defined(__DOXYGEN__)\r
+                               /** Starts the scheduler in its infinite loop, executing running tasks. This should be placed at the end\r
+                                *  of the user application's main() function, as it can never return to the calling function.\r
+                                */\r
+                               void Scheduler_Start(void);\r
+                               \r
+                               /** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself\r
+                                *  is started. This must be executed before any scheduler function calls other than Scheduler_Start(),\r
+                                *  and can be omitted if no such functions could be called before the scheduler is started.\r
+                                */\r
+                               void Scheduler_Init(void);\r
+                       #else\r
+                               #define Scheduler_Start()                 Scheduler_GoSchedule(TOTAL_TASKS);\r
+                               \r
+                               #define Scheduler_Init()                  Scheduler_InitScheduler(TOTAL_TASKS);\r
+                       #endif\r
 \r
                /* Type Defines: */\r
                        /** Type define for a pointer to a scheduler task. */\r
@@ -175,7 +189,7 @@
                         *  \param DelayCounter  Counter which is storing the starting tick count for a given delay.\r
                         */\r
                        static inline void Scheduler_ResetDelay(SchedulerDelayCounter_t* const DelayCounter)\r
-                                                               ATTR_NON_NULL_PTR_ARG(1);\r
+                                                               ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
                        static inline void Scheduler_ResetDelay(SchedulerDelayCounter_t* const DelayCounter)\r
                        {\r
                                ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
@@ -194,7 +208,7 @@
                         *\r
                         *  Usage Example:\r
                         *  \code\r
-                        *      static SchedulerDelayCounter_t DelayCounter = 10000; // Force immediate run on startup\r
+                        *      static SchedulerDelayCounter_t DelayCounter = 10000; // Force immediate run on start-up\r
                         *                               \r
                         *      // Task runs every 10000 ticks, 10 seconds for this demo\r
                         *      if (Scheduler_HasDelayElapsed(10000, &DelayCounter))\r
@@ -229,12 +243,13 @@
                        #define MAX_DELAYCTR_COUNT                0xFFFF\r
 \r
                /* Inline Functions: */\r
+                       static inline void Scheduler_InitScheduler(const uint8_t TotalTasks) ATTR_ALWAYS_INLINE;\r
                        static inline void Scheduler_InitScheduler(const uint8_t TotalTasks)\r
                        {\r
                                Scheduler_TotalTasks = TotalTasks;\r
                        }\r
                \r
-                       static inline void Scheduler_GoSchedule(const uint8_t TotalTasks) ATTR_NO_RETURN;\r
+                       static inline void Scheduler_GoSchedule(const uint8_t TotalTasks) ATTR_NO_RETURN ATTR_ALWAYS_INLINE;\r
                        static inline void Scheduler_GoSchedule(const uint8_t TotalTasks)\r
                        {\r
                                Scheduler_InitScheduler(TotalTasks);\r
@@ -260,3 +275,5 @@
                #endif\r
                \r
 #endif\r
+\r
+/** @} */\r