Changeset db9964f1 in rtems for doc/user/conf.t


Ignore:
Timestamp:
Nov 24, 2010, 3:52:21 PM (9 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
95ec9e98
Parents:
0faa9dad
Message:

2010-11-24 Gedare Bloom <giddyup44@…>

PR 1647/cpukit

  • user/conf.t, user/schedule.t: Update documentation to reflect refactoring of SuperCore? to add Scheduler and ability for user to configure a scheduler.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    r0faa9dad rdb9964f1  
    2525the length of each clock tick, the maximum number of each RTEMS
    2626object that can be created, the application initialization tasks,
     27the task scheduling algorithm to be used,
    2728and the device drivers in the application.  This information
    2829is placed in data structures that are given to RTEMS at
     
    393394@c
    394395@c
     396@subsection Scheduler Algorithm Configuration
     397This section defines the configuration parameters related to selecting
     398a scheduling algorithm for an application.  Regardless of whether
     399@code{CONFIGURE_SCHEDULER_POLICY} is defined, if none of the other
     400configuration parameters are set, then @code{rtems/confdefs.h} will define
     401@code{CONFIGURE_SCHEDULER_PRIORITY} and will (re)define
     402@code{CONFIGURE_SCHEDULER_POLICY} as @code{_Scheduler_Priority}. That is,
     403@code{CONFIGURE_SCHEDULER_PRIORITY} is the default scheduling algorithm.
     404
     405@itemize @bullet
     406@findex CONFIGURE_SCHEDULER_POLICY
     407@item @code{CONFIGURE_SCHEDULER_POLICY} is defined to specify which
     408scheduling algorithm an application will use.  If it is undefined,
     409then @code{rtems/confdefs.h} will define it based on the definition
     410of the following configuration parameters.
     411Valid values for this configuration parameter are:
     412@code{_Scheduler_USER},
     413@code{_Scheduler_Priority}.
     414
     415@findex CONFIGURE_SCHEDULER_USER
     416@item @code{CONFIGURE_SCHEDULER_USER} is defined if the application
     417provides its own scheduling algorithm. If @code{CONFIGURE_SCHEDULER_USER} is
     418defined then @code{CONFIGURE_SCHEDULER_ENTRY_USER} must be defined with the
     419name of the application's initialization function.  If both
     420configuration parameters are defined and @code{CONFIGURE_SCHEDULER_POLICY}
     421is undefined, then @code{CONFIGURE_SCHEDULER_POLICY} will be be defined as
     422@code{_Scheduler_USER}.
     423
     424@findex CONFIGURE_SCHEDULER_ALL
     425@item @code{CONFIGURE_SCHEDULER_ALL} is defined if the application
     426chooses to include all of the RTEMS-provided schedulers. 
     427@code{CONFIGURE_SCHEDULER_ALL} will define all of the following configuration
     428parameters and will use @code{CONFIGURE_SCHEDULER_POLICY} to select the
     429algorithm to use. If @code{CONFIGURE_SCHEDULER_POLICY} is not defined, then
     430@code{rtems/confdefs.h} will define it as @code{_Scheduler_Priority}.
     431
     432@findex CONFIGURE_SCHEDULER_PRIORITY
     433@item @code{CONFIGURE_SCHEDULER_PRIORITY} is defined if the application
     434will use the Priority Scheduling algorithm.
     435If none of the previous configuration parameters are defined by the
     436application, then @code{rtems/confdefs.h} will define
     437@code{CONFIGURE_SCHEDULER_POLICY} as @code{_Scheduler_PRIORITY}.
     438
     439@end itemize
     440
     441@c
     442@c
     443@c
    395444@subsection Device Driver Table
    396445
     
    817866  uint32_t                        microseconds_per_tick;
    818867  uint32_t                        ticks_per_timeslice;
     868  uint32_t                        scheduler_policy;
    819869  void                          (*idle_task)( void );
    820870  uint32_t                        idle_task_stack_size;
     
    875925an RTEMS application, the value for this field corresponds
    876926to the setting of the macro @code{CONFIGURE_TICKS_PER_TIMESLICE}.
     927
     928@item scheduler_policy
     929is the algorithm to use for task scheduling.
     930When using the @code{rtems/confdefs.h} mechanism for configuring
     931an RTEMS application, the value for this field corresponds
     932to the setting of the macro @code{CONFIGURE_SCHEDULER_POLICY}.
    877933
    878934@item idle_task
Note: See TracChangeset for help on using the changeset viewer.