rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-24 02:42:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cleanups.

Browse Source
This commit is contained in:
Chris Johns 2016-01-27 09:38:16 +11:00 committed by Amar Takhar
parent 66220bcbd7
commit 1a72a9806f
6 changed files with 729 additions and 721 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
c_user/interrupt_manager.rst
View File

@ -266,14 +266,14 @@ INTERRUPT_CATCH - Establish an ISR
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
ISR established successfully
``RTEMS_INVALID_NUMBER`` * - ``RTEMS_SUCCESSFUL``
illegal vector number - ISR established successfully
* - ``RTEMS_INVALID_NUMBER``
``RTEMS_INVALID_ADDRESS`` - illegal vector number
illegal ISR entry point or invalid ``old_isr_handler`` * - ``RTEMS_INVALID_ADDRESS``
- illegal ISR entry point or invalid ``old_isr_handler``
**DESCRIPTION:** **DESCRIPTION:**

6
c_user/key_concepts.rst
View File

@ -262,8 +262,8 @@ large.
The rate monotonic scheduling algorithm is a hard real-time scheduling The rate monotonic scheduling algorithm is a hard real-time scheduling
methodology. This methodology provides rules which allows one to guarantee methodology. This methodology provides rules which allows one to guarantee
that a set of independent periodic tasks will always meet their deadlines - that a set of independent periodic tasks will always meet their deadlines even
even under transient overload conditions. The rate monotonic manager provides under transient overload conditions. The rate monotonic manager provides
directives built upon the Clock Manager's interval timer support routines. directives built upon the Clock Manager's interval timer support routines.
Interval timing is not sufficient for the many applications which require that Interval timing is not sufficient for the many applications which require that
@ -274,7 +274,7 @@ request to delay until midnight on New Year's Eve before lowering the ball at
Times Square. The data type ``rtems_time_of_day`` is used to specify calendar Times Square. The data type ``rtems_time_of_day`` is used to specify calendar
time in RTEMS services. See `Time and Date Data Structures`_ time in RTEMS services. See `Time and Date Data Structures`_
... index:: rtems_time_of_day .. index:: rtems_time_of_day
Obviously, the directives which use intervals or wall time cannot operate Obviously, the directives which use intervals or wall time cannot operate
without some external mechanism which provides a periodic clock tick. This without some external mechanism which provides a periodic clock tick. This

122
c_user/rate_monotonic_manager.rst
View File

@ -479,14 +479,14 @@ monotonic period will be returned. The following table details the
relationship between the period's status and the directive status code returned relationship between the period's status and the directive status code returned
by the ``rtems_rate_monotonic_period`` directive: by the ``rtems_rate_monotonic_period`` directive:
``RTEMS_SUCCESSFUL`` .. list-table::
period is running
``RTEMS_TIMEOUT`` * - ``RTEMS_SUCCESSFUL``
period has expired - period is running
* - ``RTEMS_TIMEOUT``
``RTEMS_NOT_DEFINED`` - period has expired
period has never been initiated * - ``RTEMS_NOT_DEFINED``
- period has never been initiated
Obtaining the status of a rate monotonic period does not alter the state or Obtaining the status of a rate monotonic period does not alter the state or
length of that period. length of that period.
@ -655,14 +655,14 @@ RATE_MONOTONIC_CREATE - Create a rate monotonic period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
rate monotonic period created successfully
``RTEMS_INVALID_NAME`` * - ``RTEMS_SUCCESSFUL``
invalid period name - rate monotonic period created successfully
* - ``RTEMS_INVALID_NAME``
``RTEMS_TOO_MANY`` - invalid period name
too many periods created * - ``RTEMS_TOO_MANY``
- too many periods created
**DESCRIPTION:** **DESCRIPTION:**
@ -696,11 +696,12 @@ RATE_MONOTONIC_IDENT - Get ID of a period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period identified successfully
``RTEMS_INVALID_NAME`` * - ``RTEMS_SUCCESSFUL``
period name not found - period identified successfully
* - ``RTEMS_INVALID_NAME``
- period name not found
**DESCRIPTION:** **DESCRIPTION:**
@ -732,14 +733,14 @@ RATE_MONOTONIC_CANCEL - Cancel a period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period canceled successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period canceled successfully
* - ``RTEMS_INVALID_ID``
``RTEMS_NOT_OWNER_OF_RESOURCE`` - invalid rate monotonic period id
rate monotonic period not created by calling task * - ``RTEMS_NOT_OWNER_OF_RESOURCE``
- rate monotonic period not created by calling task
**DESCRIPTION:** **DESCRIPTION:**
@ -771,11 +772,12 @@ RATE_MONOTONIC_DELETE - Delete a rate monotonic period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period deleted successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period deleted successfully
* - ``RTEMS_INVALID_ID``
- invalid rate monotonic period id
**DESCRIPTION:** **DESCRIPTION:**
@ -811,21 +813,18 @@ RATE_MONOTONIC_PERIOD - Conclude current/Start next period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period initiated successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period initiated successfully
* - ``RTEMS_INVALID_ID``
``RTEMS_NOT_OWNER_OF_RESOURCE`` - invalid rate monotonic period id
period not created by calling task * - ``RTEMS_NOT_OWNER_OF_RESOURCE``
- period not created by calling task
``RTEMS_NOT_DEFINED`` * - ``RTEMS_NOT_DEFINED``
period has never been initiated (only possible when period is set to - period has never been initiated (only possible when period is set to PERIOD_STATUS)
PERIOD_STATUS) * - ``RTEMS_TIMEOUT``
- period has expired
``RTEMS_TIMEOUT``
period has expired
**DESCRIPTION:** **DESCRIPTION:**
@ -863,14 +862,14 @@ RATE_MONOTONIC_GET_STATUS - Obtain status from a period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period initiated successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period initiated successfully
* - ``RTEMS_INVALID_ID``
``RTEMS_INVALID_ADDRESS`` - invalid rate monotonic period id
invalid address of status * - ``RTEMS_INVALID_ADDRESS``
- invalid address of status
**DESCRIPTION:** **DESCRIPTION:**
@ -926,14 +925,14 @@ RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period initiated successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period initiated successfully
* - ``RTEMS_INVALID_ID``
``RTEMS_INVALID_ADDRESS`` - invalid rate monotonic period id
invalid address of statistics * - ``RTEMS_INVALID_ADDRESS``
- invalid address of statistics
**DESCRIPTION:** **DESCRIPTION:**
@ -993,11 +992,12 @@ RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
period initiated successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid rate monotonic period id - period initiated successfully
* - ``RTEMS_INVALID_ID``
- invalid rate monotonic period id
**DESCRIPTION:** **DESCRIPTION:**

2
c_user/rtems_data_types.rst
View File

@ -100,7 +100,6 @@ alphabetical order:
.. index:: rtems_fatal_extension .. index:: rtems_fatal_extension
``rtems_fatal_extension`` ``rtems_fatal_extension``
The entry point for a fatal error user extension handler routine. The entry point for a fatal error user extension handler routine.
.. index:: rtems_id .. index:: rtems_id
@ -117,7 +116,6 @@ alphabetical order:
.. index:: rtems_interrupt_level .. index:: rtems_interrupt_level
``rtems_interrupt_level`` ``rtems_interrupt_level``
The data structure used with the ``rtems_interrupt_disable``, The data structure used with the ``rtems_interrupt_disable``,
``rtems_interrupt_enable``, and ``rtems_interrupt_flash`` routines. This ``rtems_interrupt_enable``, and ``rtems_interrupt_flash`` routines. This
data type is CPU dependent and usually corresponds to the contents of the data type is CPU dependent and usually corresponds to the contents of the

1126
c_user/semaphore_manager.rst
View File

File diff suppressed because it is too large Load Diff

180
c_user/timer_manager.rst
View File

@ -206,17 +206,16 @@ TIMER_CREATE - Create a timer
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer created successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``id`` is NULL - timer created successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_NAME`` - ``id`` is NULL
invalid timer name * - ``RTEMS_INVALID_NAME``
- invalid timer name
``RTEMS_TOO_MANY`` * - ``RTEMS_TOO_MANY``
too many timers created - too many timers created
**DESCRIPTION:** **DESCRIPTION:**
@ -248,14 +247,14 @@ TIMER_IDENT - Get ID of a timer
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer identified successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``id`` is NULL - timer identified successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_NAME`` - ``id`` is NULL
timer name not found * - ``RTEMS_INVALID_NAME``
- timer name not found
**DESCRIPTION:** **DESCRIPTION:**
@ -287,11 +286,12 @@ TIMER_CANCEL - Cancel a timer
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer canceled successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid timer id - timer canceled successfully
* - ``RTEMS_INVALID_ID``
- invalid timer id
**DESCRIPTION:** **DESCRIPTION:**
@ -321,11 +321,12 @@ TIMER_DELETE - Delete a timer
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer deleted successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid timer id - timer deleted successfully
* - ``RTEMS_INVALID_ID``
- invalid timer id
**DESCRIPTION:** **DESCRIPTION:**
@ -360,17 +361,16 @@ TIMER_FIRE_AFTER - Fire timer after interval
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer initiated successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``routine`` is NULL - timer initiated successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_ID`` - ``routine`` is NULL
invalid timer id * - ``RTEMS_INVALID_ID``
- invalid timer id
``RTEMS_INVALID_NUMBER`` * - ``RTEMS_INVALID_NUMBER``
invalid interval - invalid interval
**DESCRIPTION:** **DESCRIPTION:**
@ -404,23 +404,20 @@ TIMER_FIRE_WHEN - Fire timer when specified
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer initiated successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``routine`` is NULL - timer initiated successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_ADDRESS`` - ``routine`` is NULL
``wall_time`` is NULL * - ``RTEMS_INVALID_ADDRESS``
- ``wall_time`` is NULL
``RTEMS_INVALID_ID`` * - ``RTEMS_INVALID_ID``
invalid timer id - invalid timer id
* - ``RTEMS_NOT_DEFINED``
``RTEMS_NOT_DEFINED`` - system date and time is not set
system date and time is not set * - ``RTEMS_INVALID_CLOCK``
- invalid time of day
``RTEMS_INVALID_CLOCK``
invalid time of day
**DESCRIPTION:** **DESCRIPTION:**
@ -454,11 +451,12 @@ TIMER_INITIATE_SERVER - Initiate server for task-based timers
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
Timer Server initiated successfully
``RTEMS_TOO_MANY`` * - ``RTEMS_SUCCESSFUL``
too many tasks created - Timer Server initiated successfully
* - ``RTEMS_TOO_MANY``
- too many tasks created
**DESCRIPTION:** **DESCRIPTION:**
@ -498,20 +496,18 @@ TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer initiated successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``routine`` is NULL - timer initiated successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_ID`` - ``routine`` is NULL
invalid timer id * - ``RTEMS_INVALID_ID``
- invalid timer id
``RTEMS_INVALID_NUMBER`` * - ``RTEMS_INVALID_NUMBER``
invalid interval - invalid interval
* - ``RTEMS_INCORRECT_STATE``
``RTEMS_INCORRECT_STATE`` - Timer Server not initiated
Timer Server not initiated
**DESCRIPTION:** **DESCRIPTION:**
@ -548,26 +544,22 @@ TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer initiated successfully
``RTEMS_INVALID_ADDRESS`` * - ``RTEMS_SUCCESSFUL``
``routine`` is NULL - timer initiated successfully
* - ``RTEMS_INVALID_ADDRESS``
``RTEMS_INVALID_ADDRESS`` - ``routine`` is NULL
``wall_time`` is NULL * - ``RTEMS_INVALID_ADDRESS``
- ``wall_time`` is NULL
``RTEMS_INVALID_ID`` * - ``RTEMS_INVALID_ID``
invalid timer id - invalid timer id
* - ``RTEMS_NOT_DEFINED``
``RTEMS_NOT_DEFINED`` - system date and time is not set
system date and time is not set * - ``RTEMS_INVALID_CLOCK``
- invalid time of day
``RTEMS_INVALID_CLOCK`` * - ``RTEMS_INCORRECT_STATE``
invalid time of day - Timer Server not initiated
``RTEMS_INCORRECT_STATE``
Timer Server not initiated
**DESCRIPTION:** **DESCRIPTION:**
@ -601,14 +593,14 @@ TIMER_RESET - Reset an interval timer
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**
``RTEMS_SUCCESSFUL`` .. list-table::
timer reset successfully
``RTEMS_INVALID_ID`` * - ``RTEMS_SUCCESSFUL``
invalid timer id - timer reset successfully
* - ``RTEMS_INVALID_ID``
``RTEMS_NOT_DEFINED`` - invalid timer id
attempted to reset a when or newly created timer * - ``RTEMS_NOT_DEFINED``
- attempted to reset a when or newly created timer
**DESCRIPTION:** **DESCRIPTION:**