rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 02:57:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Generate semaphore manager documentation

Browse Source 
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
This commit is contained in:
Sebastian Huber 2020-09-29 16:44:14 +02:00
parent 698580033b
commit fd56f7e469
2 changed files with 888 additions and 493 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1171
c-user/semaphore/directives.rst
View File

File diff suppressed because it is too large Load Diff

52
c-user/semaphore/introduction.rst
View File

@ -1,25 +1,55 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org
.. Generated from spec:/rtems/sem/if/group
.. _SemaphoreManagerIntroduction:
Introduction Introduction
============ ============
The semaphore manager utilizes standard Dijkstra .. The following list was generated from:
counting semaphores to provide synchronization and mutual .. spec:/rtems/sem/if/create
exclusion capabilities. The directives provided by the .. spec:/rtems/sem/if/ident
semaphore manager are: .. spec:/rtems/sem/if/delete
.. spec:/rtems/sem/if/obtain
.. spec:/rtems/sem/if/release
.. spec:/rtems/sem/if/flush
.. spec:/rtems/sem/if/set-priority
- :ref:`rtems_semaphore_create` The Semaphore Manager utilizes standard Dijkstra counting semaphores to provide
synchronization and mutual exclusion capabilities. The directives provided by
the Semaphore Manager are:
- :ref:`rtems_semaphore_ident` * :ref:`InterfaceRtemsSemaphoreCreate` - Creates a semaphore.
- :ref:`rtems_semaphore_delete` * :ref:`InterfaceRtemsSemaphoreIdent` - Identifies a semaphore by the object
name.
- :ref:`rtems_semaphore_obtain` * :ref:`InterfaceRtemsSemaphoreDelete` - Deletes the semaphore.
- :ref:`rtems_semaphore_release` * :ref:`InterfaceRtemsSemaphoreObtain` - Obtains the semaphore.
- :ref:`rtems_semaphore_flush` * :ref:`InterfaceRtemsSemaphoreRelease` - Releases the semaphore.
- :ref:`rtems_semaphore_set_priority` * :ref:`InterfaceRtemsSemaphoreFlush` - Flushes the semaphore.
* :ref:`InterfaceRtemsSemaphoreSetPriority` - Sets the priority by scheduler
for the semaphore.