summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt
diff options
context:
space:
mode:
Diffstat (limited to 'digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt')
-rw-r--r--digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt b/digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt
new file mode 100644
index 00000000..0a4f4928
--- /dev/null
+++ b/digital/avr/modules/usb/lufa/LUFA/SchedulerOverview.txt
@@ -0,0 +1,31 @@
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \page Page_SchedulerOverview LUFA Scheduler Overview
+ *
+ * The LUFA library comes with a small, basic round-robbin scheduler which allows for small "tasks" to be executed
+ * continuously in sequence, and enabled/disabled at runtime. Unlike a conventional, complex RTOS scheduler, the
+ * LUFA scheduler is very simple in design and operation and is essentially a loop conditionally executing a series
+ * of functions.
+ *
+ * Each LUFA scheduler task should be written similar to an ISR; it should execute quickly (so that no one task
+ * hogs the processor, preventing another from running before some sort of timeout is exceeded). Unlike normal RTOS
+ * tasks, each LUFA scheduler task is a regular function, and thus must be designed to be called, and designed to
+ * return to the calling scheduler function repeatedly. Data which must be preserved between task calls should be
+ * declared as global or (prefferably) as a static local variable inside the task.
+ *
+ * The scheduler consists of a task list, listing all the tasks which can be executed by the scheduler. Once started,
+ * each task is then called one after another, unless the task is stopped by another running task or interrupt.
+ *
+ *
+ * If desired, the LUFA scheduler <b>does not need to be used</b> in a LUFA powered application. A more conventional
+ * approach to application design can be used, or a proper scheduling RTOS inserted in the place of the LUFA scheduler.
+ * In the case of the former the USB task must be run manually repeatedly to maintain USB communications, and in the
+ * case of the latter a proper RTOS task must be set up to do the same.
+ *
+ *
+ * For more information on the LUFA scheduler, see the Scheduler.h file documentation.
+ */