Changeset bb2a124 in rtems-central


Ignore:
Timestamp:
11/09/20 12:16:40 (21 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
b77b781
Parents:
d41d808
git-author:
Sebastian Huber <sebastian.huber@…> (11/09/20 12:16:40)
git-committer:
Sebastian Huber <sebastian.huber@…> (11/09/20 12:43:20)
Message:

spec: Review Event Manager API

Location:
spec/rtems/event/if
Files:
47 edited

Legend:

Unmodified
Added
Removed
  • spec/rtems/event/if/all-events.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant contains all events in an event set.
     3  This event set constant represents all events of an event set.
    44copyrights:
    55- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     
    99  variants: []
    1010description: |
    11   The value of this constant is identical to ${event-00:/name} | ... |
    12   ${event-31:/name}.
     11  This event set constant is equal to the bitwise or of ${event-00:/name},
     12  ${event-01:/name}, ${event-02:/name}, ${event-03:/name}, ${event-04:/name},
     13  ${event-05:/name}, ${event-06:/name}, ${event-07:/name}, ${event-08:/name},
     14  ${event-09:/name}, ${event-10:/name}, ${event-11:/name}, ${event-12:/name},
     15  ${event-13:/name}, ${event-14:/name}, ${event-15:/name}, ${event-16:/name},
     16  ${event-17:/name}, ${event-18:/name}, ${event-19:/name}, ${event-20:/name},
     17  ${event-21:/name}, ${event-22:/name}, ${event-23:/name}, ${event-24:/name},
     18  ${event-25:/name}, ${event-26:/name}, ${event-27:/name}, ${event-28:/name},
     19  ${event-29:/name}, ${event-30:/name}, and ${event-31:/name}.
    1320enabled-by: true
    1421index-entries: []
  • spec/rtems/event/if/event-00.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 0.
     3  This event set constant represents the bit in the event set associated with
     4  event 0.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-01.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 1.
     3  This event set constant represents the bit in the event set associated with
     4  event 1.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-02.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 2.
     3  This event set constant represents the bit in the event set associated with
     4  event 2.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-03.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 3.
     3  This event set constant represents the bit in the event set associated with
     4  event 3.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-04.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 4.
     3  This event set constant represents the bit in the event set associated with
     4  event 4.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-05.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 5.
     3  This event set constant represents the bit in the event set associated with
     4  event 5.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-06.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 6.
     3  This event set constant represents the bit in the event set associated with
     4  event 6.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-07.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 7.
     3  This event set constant represents the bit in the event set associated with
     4  event 7.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-08.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 8.
     3  This event set constant represents the bit in the event set associated with
     4  event 8.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-09.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 9.
     3  This event set constant represents the bit in the event set associated with
     4  event 9.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-10.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 10.
     3  This event set constant represents the bit in the event set associated with
     4  event 10.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-11.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 11.
     3  This event set constant represents the bit in the event set associated with
     4  event 11.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-12.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 12.
     3  This event set constant represents the bit in the event set associated with
     4  event 12.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-13.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 13.
     3  This event set constant represents the bit in the event set associated with
     4  event 13.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-14.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 14.
     3  This event set constant represents the bit in the event set associated with
     4  event 14.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-15.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 15.
     3  This event set constant represents the bit in the event set associated with
     4  event 15.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-16.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 16.
     3  This event set constant represents the bit in the event set associated with
     4  event 16.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-17.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 17.
     3  This event set constant represents the bit in the event set associated with
     4  event 17.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-18.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 18.
     3  This event set constant represents the bit in the event set associated with
     4  event 18.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-19.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 19.
     3  This event set constant represents the bit in the event set associated with
     4  event 19.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-20.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 20.
     3  This event set constant represents the bit in the event set associated with
     4  event 20.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-21.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 21.
     3  This event set constant represents the bit in the event set associated with
     4  event 21.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-22.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 22.
     3  This event set constant represents the bit in the event set associated with
     4  event 22.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-23.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 23.
     3  This event set constant represents the bit in the event set associated with
     4  event 23.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-24.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 24.
     3  This event set constant represents the bit in the event set associated with
     4  event 24.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-25.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 25.
     3  This event set constant represents the bit in the event set associated with
     4  event 25.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-26.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 26.
     3  This event set constant represents the bit in the event set associated with
     4  event 26.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-27.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 27.
     3  This event set constant represents the bit in the event set associated with
     4  event 27.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-28.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 28.
     3  This event set constant represents the bit in the event set associated with
     4  event 28.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-29.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 29.
     3  This event set constant represents the bit in the event set associated with
     4  event 29.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-30.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 30.
     3  This event set constant represents the bit in the event set associated with
     4  event 30.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/event-31.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant defines the bit in the event set associated with event 31.
     3  This event set constant represents the bit in the event set associated with
     4  event 31.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/header.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    2 brief: This header file defines the Event Manager API.
     2brief: |
     3  This header file provides the Event Manager API.
    34copyrights:
    45- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/pending-events.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This constant can be used to get the set of pending events in
    4   ${receive:/name}.
     3  This event set constant indicates that ${receive:/name} shall return the set
     4  of pending events.
    55copyrights:
    66- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/receive.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   Receives or gets an event set.
     3  Receives or gets an event set from the calling task.
    44copyrights:
    55- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     
    3030
    3131  To **receive events** you have to define an input event condition and some
    32   options.  The option set specified in ``${.:/params[1]/name}`` defines
     32  options.  The **option set** specified in ``${.:/params[1]/name}`` defines
    3333
    3434  * if the task will wait or poll for the events, and
     
    7676  ``${.:/params[0]/name}`` will be left pending.
    7777
    78   To receive all events use the constant ${all-events:/name} for the
    79   ``${.:/params[0]/name}`` parameter.  This constant is identical to
    80   ${event-00:/name} | ... | ${event-31:/name} and should not be confused with
    81   the option ${../../option/if/event-all:/name}.
     78  To receive all events use the event set constant ${all-events:/name} for the
     79  ``${.:/params[0]/name}`` parameter.  Do not confuse this event set constant
     80  with the directive option ${../../option/if/event-all:/name}.
    8281
    8382  A task can **receive all of the pending events** by calling the directive
    8483  with a value of ${all-events:/name} for the ``${.:/params[0]/name}``
    85   parameter and ${../../option/if/no-wait:/name} |
    86   ${../../option/if/event-any:/name} for the ``${.:/params[1]/name}``
    87   parameter.  The pending events are returned to the calling task and the event
    88   set of the task is cleared.  If no events are pending then the
     84  parameter and the bitwise or of the ${../../option/if/no-wait:/name} and
     85  ${../../option/if/event-any:/name} options for the ``${.:/params[1]/name}``
     86  parameter.  The pending events are returned and the event set of the task is
     87  cleared.  If no events are pending then the
    8988  ${../../status/if/unsatisfied:/name} status code will be returned.
    9089params:
  • spec/rtems/event/if/send.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   Sends an event set to a task.
     3  Sends the event set to the task.
    44copyrights:
    55- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     
    1515  variants: []
    1616description: |
    17   This directive sends an event set, ``${.:/params[1]/name}``, to the task
    18   specified by ``${.:/params[0]/name}``.  Based upon the state of the target
    19   task, one of the following situations applies:
     17  This directive sends the event set, ``${.:/params[1]/name}``, to the target
     18  task identified by ``${.:/params[0]/name}``.  Based upon the state of the
     19  target task, one of the following situations applies:
    2020
    2121  * The target task is blocked waiting for events, then
  • spec/rtems/event/if/set.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This integer type can hold an event set of up to 32 events represented as a
    4   bit field.
     3  This integer type represents a bit field which can hold exactly 32 individual
     4  events.
    55copyrights:
    66- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-network-close.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event for a network socket close.
     3  This event set constant represents the reserved system event for a network
     4  socket close.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-network-sbwait.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event for a network socket buffer wait usage.
     3  This event set constant represents the reserved system event for a network
     4  socket buffer wait usage.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-network-sosleep.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event for a network socket sleep usage.
     3  This event set constant represents the reserved system event for a network
     4  socket sleep.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-receive.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   Receives or gets a system event set.
     3  Receives or gets a system event set from the executing task.
    44copyrights:
    55- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-send.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   Sends a system event set to a task.
     3  Sends the system event set to the task.
    44copyrights:
    55- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-server-resume.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event to resume a server thread, for example the
    4   timer or interrupt server.
     3  This event set constant represents the reserved system event to resume a
     4  server thread, for example the timer or interrupt server.
    55copyrights:
    66- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-server.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event for server thread usage, for example the
    4   timer or interrupt server.
     3  This event set constant represents the reserved system event for server
     4  thread usage, for example the timer or interrupt server.
    55copyrights:
    66- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/rtems/event/if/system-transient.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   This is a reserved system event for transient usage.
     3  This event set constant represents the reserved system event for transient
     4  usage.
    45copyrights:
    56- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     
    1516- role: interface-placement
    1617  uid: header
    17 - role: interface-ingroup
    18   uid: group
    1918name: RTEMS_EVENT_SYSTEM_TRANSIENT
    2019notes: null
  • spec/rtems/event/if/transient-send.yml

    rd41d808 rbb2a124  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
    22brief: |
    3   Sends the transient event to the specified task.
     3  Sends the transient event to the task.
    44copyrights:
    55- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
Note: See TracChangeset for help on using the changeset viewer.