LUFA/ManPages/SchedulerOverview.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_SchedulerOverview LUFA Scheduler Overview
   8  *
   9  *  <B>THE LUFA SCHEDULER IS NOW DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. EXISTING CODE SHOULD CONVERT
  10  *     TO STANDARD LOOPS AS SHOWN IN THE CURRENT LIBRARY DEMOS.</b>
  11  *
  12  *
  13  *  The LUFA library comes with a small, basic round-robbin scheduler which allows for small "tasks" to be executed
  14  *  continuously in sequence, and enabled/disabled at runtime. Unlike a conventional, complex RTOS scheduler, the
  15  *  LUFA scheduler is very simple in design and operation and is essentially a loop conditionally executing a series
  16  *  of functions.
  17  *
  18  *  Each LUFA scheduler task should be written similar to an ISR; it should execute quickly (so that no one task
  19  *  hogs the processor, preventing another from running before some sort of timeout is exceeded). Unlike normal RTOS
  20  *  tasks, each LUFA scheduler task is a regular function, and thus must be designed to be called, and designed to
  21  *  return to the calling scheduler function repeatedly. Data which must be preserved between task calls should be
  22  *  declared as global or (preferably) as a static local variable inside the task.
  23  *
  24  *  The scheduler consists of a task list, listing all the tasks which can be executed by the scheduler. Once started,
  25  *  each task is then called one after another, unless the task is stopped by another running task or interrupt.
  26  *
  27  *
  28  *  If desired, the LUFA scheduler <b>does not need to be used</b> in a LUFA powered application. A more conventional
  29  *  approach to application design can be used, or a proper scheduling RTOS inserted in the place of the LUFA scheduler.
  30  *  In the case of the former the USB task must be run manually repeatedly to maintain USB communications, and in the
  31  *  case of the latter a proper RTOS task must be set up to do the same.
  32  *
  33  *
  34  *  For more information on the LUFA scheduler, see the Scheduler.h file documentation.
  35  */