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

barrier: Remove leftover semaphore remnants

Browse Source 
Remove various incorrect references to "lock" and "obtain" and to an
option set which is not part of the barrier interface.

It looks like the barrier documentation was started based on a copy of
the semaphore documentation and these things are surviving remnants.

Also remove an unfinished sentence in the barrier wait description,
since the intended information is already provided in the under the NOTE
label.
This commit is contained in:
Martin Erik Werner 2019-09-04 22:47:00 +02:00 committed by Joel Sherrill
parent 5d72d63ca1
commit 473b4a56c5
1 changed files with 7 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
c-user/barrier_manager.rst
View File

@ -324,8 +324,7 @@ NOTES:
.. _rtems_barrier_wait: .. _rtems_barrier_wait:
.. index:: obtain a barrier .. index:: wait at a barrier
.. index:: lock a barrier
.. index:: rtems_barrier_wait .. index:: rtems_barrier_wait
BARRIER_WAIT - Wait at a barrier BARRIER_WAIT - Wait at a barrier
@ -356,14 +355,11 @@ DIRECTIVE STATUS CODES:
DESCRIPTION: DESCRIPTION:
This directive acquires the barrier specified by ``id``. The This directive waits at the barrier specified by ``id``. The timeout
``RTEMS_WAIT`` and ``RTEMS_NO_WAIT`` components of the options parameter parameter specifies the maximum interval the calling task is willing to be
indicate whether the calling task wants to wait for the barrier to become blocked waiting for the barrier. If it is set to ``RTEMS_NO_TIMEOUT``,
available or return immediately if the barrier is not currently available. then the calling task will wait forever. If the barrier is available or
With either ``RTEMS_WAIT`` or ``RTEMS_NO_WAIT``, if the current barrier the ``RTEMS_NO_WAIT`` option component is set, then timeout is ignored.
count is positive, then it is decremented by one and the barrier is
successfully acquired by returning immediately with a successful return
code.
Conceptually, the calling task should always be thought of as blocking when Conceptually, the calling task should always be thought of as blocking when
it makes this call and being unblocked when the barrier is released. If it makes this call and being unblocked when the barrier is released. If
@ -372,24 +368,7 @@ DESCRIPTION:
callers will block except for the one which is the Nth task which trips the callers will block except for the one which is the Nth task which trips the
automatic release condition. automatic release condition.
The timeout parameter specifies the maximum interval the calling task is
willing to be blocked waiting for the barrier. If it is set to
``RTEMS_NO_TIMEOUT``, then the calling task will wait forever. If the
barrier is available or the ``RTEMS_NO_WAIT`` option component is set, then
timeout is ignored.
NOTES: NOTES:
The following barrier acquisition option constants are defined by RTEMS:
.. list-table::
:class: rtems-table
* - ``RTEMS_WAIT``
- task will wait for barrier (default)
* - ``RTEMS_NO_WAIT``
- task should not wait
A clock tick is required to support the timeout functionality of this A clock tick is required to support the timeout functionality of this
directive. directive.
@ -399,7 +378,6 @@ NOTES:
.. _rtems_barrier_release: .. _rtems_barrier_release:
.. index:: wait at a barrier
.. index:: release a barrier .. index:: release a barrier
.. index:: rtems_barrier_release .. index:: rtems_barrier_release
@ -425,9 +403,7 @@ DIRECTIVE STATUS CODES:
DESCRIPTION: DESCRIPTION:
This directive releases the barrier specified by id. All tasks waiting at This directive releases the barrier specified by id. All tasks waiting at
the barrier will be unblocked. If the running task's preemption mode is the barrier will be unblocked.
enabled and one of the unblocked tasks has a higher priority than the
running task.
NOTES: NOTES:
The calling task may be preempted if it causes a higher priority task to be The calling task may be preempted if it causes a higher priority task to be