Changeset f02e872 in rtems-docs


Ignore:
Timestamp:
Feb 17, 2016, 11:32:05 PM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
1762611
Parents:
080608f
git-author:
Chris Johns <chrisj@…> (02/17/16 23:32:05)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:26)
Message:

Fix the double quotes.

Location:
c_user
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • c_user/barrier_manager.rst

    r080608f rf02e872  
    5252tasks are released.  For example, if the automatic limit is ten tasks, then the
    5353first nine tasks calling the ``rtems_barrier_wait`` directive will block.  When
    54 the tenth task calls the``rtems_barrier_wait`` directive, the nine blocked
     54the tenth task calls the ``rtems_barrier_wait`` directive, the nine blocked
    5555tasks will be released and the tenth task returns to the caller without
    5656blocking.
     
    107107When a barrier is created, RTEMS generates a unique barrier ID and assigns it
    108108to the created barrier until it is deleted.  The barrier ID may be obtained by
    109 either of two methods.  First, as the result of an invocation of
    110 the``rtems_barrier_create`` directive, the barrier ID is stored in a user
    111 provided location.  Second, the barrier ID may be obtained later using the
     109either of two methods.  First, as the result of an invocation of the
     110``rtems_barrier_create`` directive, the barrier ID is stored in a user provided
     111location.  Second, the barrier ID may be obtained later using the
    112112``rtems_barrier_ident`` directive.  The barrier ID is used by other barrier
    113113manager directives to access this barrier.
  • c_user/clock_manager.rst

    r080608f rf02e872  
    147147frequency value, defined in microseconds, is a configuration parameter found in
    148148the Configuration Table.  RTEMS divides one million microseconds (one second)
    149 by the number of microseconds per tick to determine the number of calls to
    150 the``rtems_clock_tick`` directive per second.  The frequency of
     149by the number of microseconds per tick to determine the number of calls to the
     150``rtems_clock_tick`` directive per second.  The frequency of
    151151``rtems_clock_tick`` calls determines the resolution (granularity) for all time
    152152dependent RTEMS actions.  For example, calling ``rtems_clock_tick`` ten times
     
    172172seconds since the RTEMS epoch, the number of ticks since the executive was
    173173initialized, and the number of ticks per second.  The information returned by
    174 the``rtems_clock_get`` directive is dependent on the option selected by the
     174the ``rtems_clock_get`` directive is dependent on the option selected by the
    175175caller.  This is specified using one of the following constants associated with
    176176the enumerated type ``rtems_clock_get_options``:
     
    296296
    297297The ``option`` argument may taken on any value of the enumerated type
    298 ``rtems_clock_get_options``.  The data type expected for``time_buffer`` is
     298``rtems_clock_get_options``.  The data type expected for ``time_buffer`` is
    299299based on the value of ``option`` as indicated below:
    300300
  • c_user/configuring_a_system.rst

    r080608f rf02e872  
    8989error occurs and the system terminates.
    9090
    91 The file ``<rtems/confdefs.h>`` will calculate the value of
    92 the``work_space_size`` parameter of the Configuration Table. There are many
     91The file ``<rtems/confdefs.h>`` will calculate the value of the
     92``work_space_size`` parameter of the Configuration Table. There are many
    9393parameters the application developer can specify to help ``<rtems/confdefs.h>``
    9494in its calculations.  Correctly specifying the application requirements via
     
    19161916**NOTES:**
    19171917
    1918 In 4.9 and older, this configuration parameter was named``STACK_CHECKER_ON``.
     1918In 4.9 and older, this configuration parameter was named ``STACK_CHECKER_ON``.
    19191919
    19201920This increases the time required to create tasks as well as adding overhead to
     
    33223322- If defined, then the BSP specific ``BSP_IDLE_TASK_SIZE``.
    33233323
    3324 - If defined, then the application specified``CONFIGURE_IDLE_TASK_SIZE``.
     3324- If defined, then the application specified ``CONFIGURE_IDLE_TASK_SIZE``.
    33253325
    33263326.. COMMENT: XXX - add cross references to other related values.
  • c_user/dual_ports_memory_manager.rst

    r080608f rf02e872  
    6666methods.  First, as the result of an invocation of the``rtems_port_create``
    6767directive, the task ID is stored in a user provided location.  Second, the port
    68 ID may be obtained later using the``rtems_port_ident`` directive.  The port ID
     68ID may be obtained later using the ``rtems_port_ident`` directive.  The port ID
    6969is used by other dual-ported memory manager directives to access this port.
    7070
  • c_user/interrupt_manager.rst

    r080608f rf02e872  
    409409
    410410This directive is only available on uni-processor configurations.  The
    411 directives ``rtems_interrupt_local_disable``
    412 and``rtems_interrupt_local_enable`` is available on all configurations.
     411directives ``rtems_interrupt_local_disable`` and
     412``rtems_interrupt_local_enable`` is available on all configurations.
    413413
    414414.. _rtems_interrupt_local_disable:
  • c_user/key_concepts.rst

    r080608f rf02e872  
    4949light to blink might be called "LITE".  The ``rtems_build_name`` routine is
    5050provided to build an object name from four ASCII characters.  The following
    51 example illustrates this: .. code:: c
     51example illustrates this:
    5252
    5353.. code:: c
     
    6060would be difficult to assign meaningful ASCII names to each task.  A more
    6161convenient approach would be to name them the binary values one through
    62 one-hundred, respectively... index:: rtems_object_get_name
     62one-hundred, respectively.
     63
     64.. index:: rtems_object_get_name
    6365
    6466RTEMS provides a helper routine, ``rtems_object_get_name``, which can be used
  • c_user/multiprocessing.rst

    r080608f rf02e872  
    160160
    161161#. The MPCI layer on the originating node senses the arrival of a packet
    162    (typically via an interrupt), and calls the
    163    RTEMS``rtems_multiprocessing_announce`` directive.  This directive readies
    164    the Multiprocessing Server.
     162   (typically via an interrupt), and calls the RTEMS
     163   ``rtems_multiprocessing_announce`` directive.  This directive readies the
     164   Multiprocessing Server.
    165165
    166166#. The Multiprocessing Server calls the user-provided MPCI routine
  • c_user/semaphore_manager.rst

    r080608f rf02e872  
    232232parameter passed to the ``rtems_semaphore_create`` directive could be either
    233233``RTEMS_PRIORITY`` or ``RTEMS_LOCAL | RTEMS_PRIORITY``.  The attribute_set
    234 parameter can be set to``RTEMS_PRIORITY`` because ``RTEMS_LOCAL`` is the
     234parameter can be set to ``RTEMS_PRIORITY`` because ``RTEMS_LOCAL`` is the
    235235default for all created tasks.  If a similar semaphore were to be known
    236236globally, then the attribute_set parameter would be ``RTEMS_GLOBAL |
     
    299299it to the created semaphore until it is deleted.  The semaphore ID may be
    300300obtained by either of two methods.  First, as the result of an invocation of
    301 the``rtems_semaphore_create`` directive, the semaphore ID is stored in a user
    302 provided location.  Second, the semaphore ID may be obtained later using
    303 the``rtems_semaphore_ident`` directive.  The semaphore ID is used by other
     301the ``rtems_semaphore_create`` directive, the semaphore ID is stored in a user
     302provided location.  Second, the semaphore ID may be obtained later using the
     303``rtems_semaphore_ident`` directive.  The semaphore ID is used by other
    304304semaphore manager directives to access this semaphore.
    305305
     
    342342
    343343The ``rtems_semaphore_release`` directive is used to release the specified
    344 semaphore.  A simplified version of the``rtems_semaphore_release`` directive
     344semaphore.  A simplified version of the ``rtems_semaphore_release`` directive
    345345can be described as follows:
    346346
  • c_user/task_manager.rst

    r080608f rf02e872  
    282282hardware floating point on that processor.  In this case, all tasks are
    283283considered ``RTEMS_NO_FLOATING_POINT`` whether created as
    284 ``RTEMS_FLOATING_POINT`` or``RTEMS_NO_FLOATING_POINT`` tasks.  A floating point
    285 emulation software library must be utilized for floating point operations.
     284``RTEMS_FLOATING_POINT`` or ``RTEMS_NO_FLOATING_POINT`` tasks.  A floating
     285point emulation software library must be utilized for floating point
     286operations.
    286287
    287288On some processors, it is possible to disable the floating point unit
     
    368369This example demonstrates the attribute_set parameter needed to create a local
    369370task which utilizes the numeric coprocessor.  The attribute_set parameter could
    370 be ``RTEMS_FLOATING_POINT`` or``RTEMS_LOCAL | RTEMS_FLOATING_POINT``.  The
    371 attribute_set parameter can be set to``RTEMS_FLOATING_POINT`` because
     371be ``RTEMS_FLOATING_POINT`` or ``RTEMS_LOCAL | RTEMS_FLOATING_POINT``.  The
     372attribute_set parameter can be set to ``RTEMS_FLOATING_POINT`` because
    372373``RTEMS_LOCAL`` is the default for all created tasks.  If the task were global
    373374and used the numeric coprocessor, then the attribute_set parameter would be
     
    386387
    387388 * - ``RTEMS_PREEMPT``
    388    - is masked by``RTEMS_PREEMPT_MASK`` and enables preemption
     389   - is masked by ``RTEMS_PREEMPT_MASK`` and enables preemption
    389390 * - ``RTEMS_NO_PREEMPT``
    390    - is masked by``RTEMS_PREEMPT_MASK`` and disables preemption
     391   - is masked by ``RTEMS_PREEMPT_MASK`` and disables preemption
    391392 * - ``RTEMS_NO_TIMESLICE``
    392    - is masked by``RTEMS_TIMESLICE_MASK`` and disables timeslicing
     393   - is masked by ``RTEMS_TIMESLICE_MASK`` and disables timeslicing
    393394 * - ``RTEMS_TIMESLICE``
    394    - is masked by``RTEMS_TIMESLICE_MASK`` and enables timeslicing
     395   - is masked by ``RTEMS_TIMESLICE_MASK`` and enables timeslicing
    395396 * - ``RTEMS_ASR``
    396    - is masked by``RTEMS_ASR_MASK`` and enables ASR processing
     397   - is masked by ``RTEMS_ASR_MASK`` and enables ASR processing
    397398 * - ``RTEMS_NO_ASR``
    398    - is masked by``RTEMS_ASR_MASK`` and disables ASR processing
     399   - is masked by ``RTEMS_ASR_MASK`` and disables ASR processing
    399400 * - ``RTEMS_INTERRUPT_LEVEL(0)``
    400    - is masked by``RTEMS_INTERRUPT_MASK`` and enables all interrupts
     401   - is masked by ``RTEMS_INTERRUPT_MASK`` and enables all interrupts
    401402 * - ``RTEMS_INTERRUPT_LEVEL(n)``
    402    - is masked by``RTEMS_INTERRUPT_MASK`` and sets interrupts level n
     403   - is masked by ``RTEMS_INTERRUPT_MASK`` and sets interrupts level n
    403404
    404405Mode values are specifically designed to be mutually exclusive, therefore
     
    412413The following example demonstrates the mode and mask parameters used with the
    413414``rtems_task_mode`` directive to place a task at interrupt level 3 and make it
    414 non-preemptible.  The mode should be set to``RTEMS_INTERRUPT_LEVEL(3) |
     415non-preemptible.  The mode should be set to ``RTEMS_INTERRUPT_LEVEL(3) |
    415416RTEMS_NO_PREEMPT`` to indicate the desired preemption mode and interrupt level,
    416417while the mask parameter should be set to ``RTEMS_INTERRUPT_MASK |
     
    506507The ``rtems_task_set_priority`` directive is used to obtain or change the
    507508current priority of either the calling task or another task.  If the new
    508 priority requested is``RTEMS_CURRENT_PRIORITY`` or the task's actual priority,
     509priority requested is ``RTEMS_CURRENT_PRIORITY`` or the task's actual priority,
    509510then the current priority will be returned and the task's priority will remain
    510511unchanged.  If the task's priority is altered, then the task will be scheduled
     
    535536task which is created later in the application.
    536537
    537 Unexpired delay timers (i.e. those used by``rtems_task_wake_after``
    538 and``rtems_task_wake_when``) and timeout timers associated with the task are
     538Unexpired delay timers (i.e. those used by ``rtems_task_wake_after`` and
     539``rtems_task_wake_when``) and timeout timers associated with the task are
    539540automatically deleted, however, other resources dynamically allocated by the
    540541task are NOT automatically returned to RTEMS.  Therefore, before a task is
Note: See TracChangeset for help on using the changeset viewer.