[rtems-central commit] spec: Review Event Manager API
Sebastian Huber
sebh at rtems.org
Mon Nov 9 12:43:48 UTC 2020
Module: rtems-central
Branch: master
Commit: bb2a12422331de2f122ab94d4dfb465fb58ad6dc
Changeset: http://git.rtems.org/rtems-central/commit/?id=bb2a12422331de2f122ab94d4dfb465fb58ad6dc
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Mon Nov 9 13:16:40 2020 +0100
spec: Review Event Manager API
---
spec/rtems/event/if/all-events.yml | 13 ++++++++++---
spec/rtems/event/if/event-00.yml | 3 ++-
spec/rtems/event/if/event-01.yml | 3 ++-
spec/rtems/event/if/event-02.yml | 3 ++-
spec/rtems/event/if/event-03.yml | 3 ++-
spec/rtems/event/if/event-04.yml | 3 ++-
spec/rtems/event/if/event-05.yml | 3 ++-
spec/rtems/event/if/event-06.yml | 3 ++-
spec/rtems/event/if/event-07.yml | 3 ++-
spec/rtems/event/if/event-08.yml | 3 ++-
spec/rtems/event/if/event-09.yml | 3 ++-
spec/rtems/event/if/event-10.yml | 3 ++-
spec/rtems/event/if/event-11.yml | 3 ++-
spec/rtems/event/if/event-12.yml | 3 ++-
spec/rtems/event/if/event-13.yml | 3 ++-
spec/rtems/event/if/event-14.yml | 3 ++-
spec/rtems/event/if/event-15.yml | 3 ++-
spec/rtems/event/if/event-16.yml | 3 ++-
spec/rtems/event/if/event-17.yml | 3 ++-
spec/rtems/event/if/event-18.yml | 3 ++-
spec/rtems/event/if/event-19.yml | 3 ++-
spec/rtems/event/if/event-20.yml | 3 ++-
spec/rtems/event/if/event-21.yml | 3 ++-
spec/rtems/event/if/event-22.yml | 3 ++-
spec/rtems/event/if/event-23.yml | 3 ++-
spec/rtems/event/if/event-24.yml | 3 ++-
spec/rtems/event/if/event-25.yml | 3 ++-
spec/rtems/event/if/event-26.yml | 3 ++-
spec/rtems/event/if/event-27.yml | 3 ++-
spec/rtems/event/if/event-28.yml | 3 ++-
spec/rtems/event/if/event-29.yml | 3 ++-
spec/rtems/event/if/event-30.yml | 3 ++-
spec/rtems/event/if/event-31.yml | 3 ++-
spec/rtems/event/if/header.yml | 3 ++-
spec/rtems/event/if/pending-events.yml | 4 ++--
spec/rtems/event/if/receive.yml | 19 +++++++++----------
spec/rtems/event/if/send.yml | 8 ++++----
spec/rtems/event/if/set.yml | 4 ++--
spec/rtems/event/if/system-network-close.yml | 3 ++-
spec/rtems/event/if/system-network-sbwait.yml | 3 ++-
spec/rtems/event/if/system-network-sosleep.yml | 3 ++-
spec/rtems/event/if/system-receive.yml | 2 +-
spec/rtems/event/if/system-send.yml | 2 +-
spec/rtems/event/if/system-server-resume.yml | 4 ++--
spec/rtems/event/if/system-server.yml | 4 ++--
spec/rtems/event/if/system-transient.yml | 5 ++---
spec/rtems/event/if/transient-send.yml | 2 +-
47 files changed, 108 insertions(+), 67 deletions(-)
diff --git a/spec/rtems/event/if/all-events.yml b/spec/rtems/event/if/all-events.yml
index 5e25da5..1502abf 100644
--- a/spec/rtems/event/if/all-events.yml
+++ b/spec/rtems/event/if/all-events.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant contains all events in an event set.
+ This event set constant represents all events of an event set.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -8,8 +8,15 @@ definition:
default: '0xffffffff'
variants: []
description: |
- The value of this constant is identical to ${event-00:/name} | ... |
- ${event-31:/name}.
+ This event set constant is equal to the bitwise or of ${event-00:/name},
+ ${event-01:/name}, ${event-02:/name}, ${event-03:/name}, ${event-04:/name},
+ ${event-05:/name}, ${event-06:/name}, ${event-07:/name}, ${event-08:/name},
+ ${event-09:/name}, ${event-10:/name}, ${event-11:/name}, ${event-12:/name},
+ ${event-13:/name}, ${event-14:/name}, ${event-15:/name}, ${event-16:/name},
+ ${event-17:/name}, ${event-18:/name}, ${event-19:/name}, ${event-20:/name},
+ ${event-21:/name}, ${event-22:/name}, ${event-23:/name}, ${event-24:/name},
+ ${event-25:/name}, ${event-26:/name}, ${event-27:/name}, ${event-28:/name},
+ ${event-29:/name}, ${event-30:/name}, and ${event-31:/name}.
enabled-by: true
index-entries: []
interface-type: define
diff --git a/spec/rtems/event/if/event-00.yml b/spec/rtems/event/if/event-00.yml
index c9741c1..b1a4b9d 100644
--- a/spec/rtems/event/if/event-00.yml
+++ b/spec/rtems/event/if/event-00.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 0.
+ This event set constant represents the bit in the event set associated with
+ event 0.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-01.yml b/spec/rtems/event/if/event-01.yml
index caf2b7d..8cd4258 100644
--- a/spec/rtems/event/if/event-01.yml
+++ b/spec/rtems/event/if/event-01.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 1.
+ This event set constant represents the bit in the event set associated with
+ event 1.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-02.yml b/spec/rtems/event/if/event-02.yml
index cdb571c..4d1a270 100644
--- a/spec/rtems/event/if/event-02.yml
+++ b/spec/rtems/event/if/event-02.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 2.
+ This event set constant represents the bit in the event set associated with
+ event 2.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-03.yml b/spec/rtems/event/if/event-03.yml
index e855a76..fcbc7e0 100644
--- a/spec/rtems/event/if/event-03.yml
+++ b/spec/rtems/event/if/event-03.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 3.
+ This event set constant represents the bit in the event set associated with
+ event 3.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-04.yml b/spec/rtems/event/if/event-04.yml
index b2052d9..cc1acae 100644
--- a/spec/rtems/event/if/event-04.yml
+++ b/spec/rtems/event/if/event-04.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 4.
+ This event set constant represents the bit in the event set associated with
+ event 4.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-05.yml b/spec/rtems/event/if/event-05.yml
index 0ade60e..ac7522b 100644
--- a/spec/rtems/event/if/event-05.yml
+++ b/spec/rtems/event/if/event-05.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 5.
+ This event set constant represents the bit in the event set associated with
+ event 5.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-06.yml b/spec/rtems/event/if/event-06.yml
index 8713875..dd9c8b6 100644
--- a/spec/rtems/event/if/event-06.yml
+++ b/spec/rtems/event/if/event-06.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 6.
+ This event set constant represents the bit in the event set associated with
+ event 6.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-07.yml b/spec/rtems/event/if/event-07.yml
index 987aa57..30922b9 100644
--- a/spec/rtems/event/if/event-07.yml
+++ b/spec/rtems/event/if/event-07.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 7.
+ This event set constant represents the bit in the event set associated with
+ event 7.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-08.yml b/spec/rtems/event/if/event-08.yml
index 673c724..e81665d 100644
--- a/spec/rtems/event/if/event-08.yml
+++ b/spec/rtems/event/if/event-08.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 8.
+ This event set constant represents the bit in the event set associated with
+ event 8.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-09.yml b/spec/rtems/event/if/event-09.yml
index 0300e7c..d523db9 100644
--- a/spec/rtems/event/if/event-09.yml
+++ b/spec/rtems/event/if/event-09.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 9.
+ This event set constant represents the bit in the event set associated with
+ event 9.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-10.yml b/spec/rtems/event/if/event-10.yml
index 8ca6090..894949c 100644
--- a/spec/rtems/event/if/event-10.yml
+++ b/spec/rtems/event/if/event-10.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 10.
+ This event set constant represents the bit in the event set associated with
+ event 10.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-11.yml b/spec/rtems/event/if/event-11.yml
index 63b049b..86b9b42 100644
--- a/spec/rtems/event/if/event-11.yml
+++ b/spec/rtems/event/if/event-11.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 11.
+ This event set constant represents the bit in the event set associated with
+ event 11.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-12.yml b/spec/rtems/event/if/event-12.yml
index f40dc6d..de8ab42 100644
--- a/spec/rtems/event/if/event-12.yml
+++ b/spec/rtems/event/if/event-12.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 12.
+ This event set constant represents the bit in the event set associated with
+ event 12.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-13.yml b/spec/rtems/event/if/event-13.yml
index b77164b..e60d5a5 100644
--- a/spec/rtems/event/if/event-13.yml
+++ b/spec/rtems/event/if/event-13.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 13.
+ This event set constant represents the bit in the event set associated with
+ event 13.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-14.yml b/spec/rtems/event/if/event-14.yml
index 074b828..e872092 100644
--- a/spec/rtems/event/if/event-14.yml
+++ b/spec/rtems/event/if/event-14.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 14.
+ This event set constant represents the bit in the event set associated with
+ event 14.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-15.yml b/spec/rtems/event/if/event-15.yml
index abf957d..0e3639c 100644
--- a/spec/rtems/event/if/event-15.yml
+++ b/spec/rtems/event/if/event-15.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 15.
+ This event set constant represents the bit in the event set associated with
+ event 15.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-16.yml b/spec/rtems/event/if/event-16.yml
index 195ee6c..911cade 100644
--- a/spec/rtems/event/if/event-16.yml
+++ b/spec/rtems/event/if/event-16.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 16.
+ This event set constant represents the bit in the event set associated with
+ event 16.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-17.yml b/spec/rtems/event/if/event-17.yml
index 09b0cb4..648e2aa 100644
--- a/spec/rtems/event/if/event-17.yml
+++ b/spec/rtems/event/if/event-17.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 17.
+ This event set constant represents the bit in the event set associated with
+ event 17.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-18.yml b/spec/rtems/event/if/event-18.yml
index d38a163..4437f1c 100644
--- a/spec/rtems/event/if/event-18.yml
+++ b/spec/rtems/event/if/event-18.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 18.
+ This event set constant represents the bit in the event set associated with
+ event 18.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-19.yml b/spec/rtems/event/if/event-19.yml
index 39c4756..612c04d 100644
--- a/spec/rtems/event/if/event-19.yml
+++ b/spec/rtems/event/if/event-19.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 19.
+ This event set constant represents the bit in the event set associated with
+ event 19.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-20.yml b/spec/rtems/event/if/event-20.yml
index a22faae..2fa30bc 100644
--- a/spec/rtems/event/if/event-20.yml
+++ b/spec/rtems/event/if/event-20.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 20.
+ This event set constant represents the bit in the event set associated with
+ event 20.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-21.yml b/spec/rtems/event/if/event-21.yml
index 7e02e1e..f77da8f 100644
--- a/spec/rtems/event/if/event-21.yml
+++ b/spec/rtems/event/if/event-21.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 21.
+ This event set constant represents the bit in the event set associated with
+ event 21.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-22.yml b/spec/rtems/event/if/event-22.yml
index 9c4e086..5bbf6b7 100644
--- a/spec/rtems/event/if/event-22.yml
+++ b/spec/rtems/event/if/event-22.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 22.
+ This event set constant represents the bit in the event set associated with
+ event 22.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-23.yml b/spec/rtems/event/if/event-23.yml
index f386ce4..65cc3c3 100644
--- a/spec/rtems/event/if/event-23.yml
+++ b/spec/rtems/event/if/event-23.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 23.
+ This event set constant represents the bit in the event set associated with
+ event 23.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-24.yml b/spec/rtems/event/if/event-24.yml
index fb686e1..0433dc9 100644
--- a/spec/rtems/event/if/event-24.yml
+++ b/spec/rtems/event/if/event-24.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 24.
+ This event set constant represents the bit in the event set associated with
+ event 24.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-25.yml b/spec/rtems/event/if/event-25.yml
index 940d6e5..8813874 100644
--- a/spec/rtems/event/if/event-25.yml
+++ b/spec/rtems/event/if/event-25.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 25.
+ This event set constant represents the bit in the event set associated with
+ event 25.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-26.yml b/spec/rtems/event/if/event-26.yml
index 2f59a20..c674f3f 100644
--- a/spec/rtems/event/if/event-26.yml
+++ b/spec/rtems/event/if/event-26.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 26.
+ This event set constant represents the bit in the event set associated with
+ event 26.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-27.yml b/spec/rtems/event/if/event-27.yml
index 1568f89..ce376be 100644
--- a/spec/rtems/event/if/event-27.yml
+++ b/spec/rtems/event/if/event-27.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 27.
+ This event set constant represents the bit in the event set associated with
+ event 27.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-28.yml b/spec/rtems/event/if/event-28.yml
index 16fb765..add07a8 100644
--- a/spec/rtems/event/if/event-28.yml
+++ b/spec/rtems/event/if/event-28.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 28.
+ This event set constant represents the bit in the event set associated with
+ event 28.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-29.yml b/spec/rtems/event/if/event-29.yml
index 413b5e2..189b028 100644
--- a/spec/rtems/event/if/event-29.yml
+++ b/spec/rtems/event/if/event-29.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 29.
+ This event set constant represents the bit in the event set associated with
+ event 29.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-30.yml b/spec/rtems/event/if/event-30.yml
index 3d07a30..3b8c00c 100644
--- a/spec/rtems/event/if/event-30.yml
+++ b/spec/rtems/event/if/event-30.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 30.
+ This event set constant represents the bit in the event set associated with
+ event 30.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/event-31.yml b/spec/rtems/event/if/event-31.yml
index dae67ab..03c616c 100644
--- a/spec/rtems/event/if/event-31.yml
+++ b/spec/rtems/event/if/event-31.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant defines the bit in the event set associated with event 31.
+ This event set constant represents the bit in the event set associated with
+ event 31.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/header.yml b/spec/rtems/event/if/header.yml
index 103949a..b7d0daa 100644
--- a/spec/rtems/event/if/header.yml
+++ b/spec/rtems/event/if/header.yml
@@ -1,5 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: This header file defines the Event Manager API.
+brief: |
+ This header file provides the Event Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/rtems/event/if/pending-events.yml b/spec/rtems/event/if/pending-events.yml
index 9360894..65b3735 100644
--- a/spec/rtems/event/if/pending-events.yml
+++ b/spec/rtems/event/if/pending-events.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant can be used to get the set of pending events in
- ${receive:/name}.
+ This event set constant indicates that ${receive:/name} shall return the set
+ of pending events.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/receive.yml b/spec/rtems/event/if/receive.yml
index a3c1fd9..2d6d683 100644
--- a/spec/rtems/event/if/receive.yml
+++ b/spec/rtems/event/if/receive.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Receives or gets an event set.
+ Receives or gets an event set from the calling task.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -29,7 +29,7 @@ description: |
in this case. The directive returns immediately and does not block.
To **receive events** you have to define an input event condition and some
- options. The option set specified in ``${.:/params[1]/name}`` defines
+ options. The **option set** specified in ``${.:/params[1]/name}`` defines
* if the task will wait or poll for the events, and
@@ -75,17 +75,16 @@ notes: |
Any pending events that do not correspond to any of the events specified in
``${.:/params[0]/name}`` will be left pending.
- To receive all events use the constant ${all-events:/name} for the
- ``${.:/params[0]/name}`` parameter. This constant is identical to
- ${event-00:/name} | ... | ${event-31:/name} and should not be confused with
- the option ${../../option/if/event-all:/name}.
+ To receive all events use the event set constant ${all-events:/name} for the
+ ``${.:/params[0]/name}`` parameter. Do not confuse this event set constant
+ with the directive option ${../../option/if/event-all:/name}.
A task can **receive all of the pending events** by calling the directive
with a value of ${all-events:/name} for the ``${.:/params[0]/name}``
- parameter and ${../../option/if/no-wait:/name} |
- ${../../option/if/event-any:/name} for the ``${.:/params[1]/name}``
- parameter. The pending events are returned to the calling task and the event
- set of the task is cleared. If no events are pending then the
+ parameter and the bitwise or of the ${../../option/if/no-wait:/name} and
+ ${../../option/if/event-any:/name} options for the ``${.:/params[1]/name}``
+ parameter. The pending events are returned and the event set of the task is
+ cleared. If no events are pending then the
${../../status/if/unsatisfied:/name} status code will be returned.
params:
- description: |
diff --git a/spec/rtems/event/if/send.yml b/spec/rtems/event/if/send.yml
index b12b948..8a852b5 100644
--- a/spec/rtems/event/if/send.yml
+++ b/spec/rtems/event/if/send.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Sends an event set to a task.
+ Sends the event set to the task.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -14,9 +14,9 @@ definition:
return: ${../../status/if/code:/name}
variants: []
description: |
- This directive sends an event set, ``${.:/params[1]/name}``, to the task
- specified by ``${.:/params[0]/name}``. Based upon the state of the target
- task, one of the following situations applies:
+ This directive sends the event set, ``${.:/params[1]/name}``, to the target
+ task identified by ``${.:/params[0]/name}``. Based upon the state of the
+ target task, one of the following situations applies:
* The target task is blocked waiting for events, then
diff --git a/spec/rtems/event/if/set.yml b/spec/rtems/event/if/set.yml
index ccea35f..6615dfd 100644
--- a/spec/rtems/event/if/set.yml
+++ b/spec/rtems/event/if/set.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This integer type can hold an event set of up to 32 events represented as a
- bit field.
+ This integer type represents a bit field which can hold exactly 32 individual
+ events.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-network-close.yml b/spec/rtems/event/if/system-network-close.yml
index 3941589..3fdc45c 100644
--- a/spec/rtems/event/if/system-network-close.yml
+++ b/spec/rtems/event/if/system-network-close.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event for a network socket close.
+ This event set constant represents the reserved system event for a network
+ socket close.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-network-sbwait.yml b/spec/rtems/event/if/system-network-sbwait.yml
index b20d79d..61f2826 100644
--- a/spec/rtems/event/if/system-network-sbwait.yml
+++ b/spec/rtems/event/if/system-network-sbwait.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event for a network socket buffer wait usage.
+ This event set constant represents the reserved system event for a network
+ socket buffer wait usage.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-network-sosleep.yml b/spec/rtems/event/if/system-network-sosleep.yml
index f5d7e5c..8f48b11 100644
--- a/spec/rtems/event/if/system-network-sosleep.yml
+++ b/spec/rtems/event/if/system-network-sosleep.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event for a network socket sleep usage.
+ This event set constant represents the reserved system event for a network
+ socket sleep.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-receive.yml b/spec/rtems/event/if/system-receive.yml
index c43e159..941357d 100644
--- a/spec/rtems/event/if/system-receive.yml
+++ b/spec/rtems/event/if/system-receive.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Receives or gets a system event set.
+ Receives or gets a system event set from the executing task.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-send.yml b/spec/rtems/event/if/system-send.yml
index 95aa13a..5221a4a 100644
--- a/spec/rtems/event/if/system-send.yml
+++ b/spec/rtems/event/if/system-send.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Sends a system event set to a task.
+ Sends the system event set to the task.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-server-resume.yml b/spec/rtems/event/if/system-server-resume.yml
index 8df1152..2cb0864 100644
--- a/spec/rtems/event/if/system-server-resume.yml
+++ b/spec/rtems/event/if/system-server-resume.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event to resume a server thread, for example the
- timer or interrupt server.
+ This event set constant represents the reserved system event to resume a
+ server thread, for example the timer or interrupt server.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-server.yml b/spec/rtems/event/if/system-server.yml
index db3d663..09bfa6b 100644
--- a/spec/rtems/event/if/system-server.yml
+++ b/spec/rtems/event/if/system-server.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event for server thread usage, for example the
- timer or interrupt server.
+ This event set constant represents the reserved system event for server
+ thread usage, for example the timer or interrupt server.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/event/if/system-transient.yml b/spec/rtems/event/if/system-transient.yml
index 0c736fd..7e4395e 100644
--- a/spec/rtems/event/if/system-transient.yml
+++ b/spec/rtems/event/if/system-transient.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is a reserved system event for transient usage.
+ This event set constant represents the reserved system event for transient
+ usage.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -14,8 +15,6 @@ interface-type: define
links:
- role: interface-placement
uid: header
-- role: interface-ingroup
- uid: group
name: RTEMS_EVENT_SYSTEM_TRANSIENT
notes: null
type: interface
diff --git a/spec/rtems/event/if/transient-send.yml b/spec/rtems/event/if/transient-send.yml
index bc372aa..24e27e9 100644
--- a/spec/rtems/event/if/transient-send.yml
+++ b/spec/rtems/event/if/transient-send.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Sends the transient event to the specified task.
+ Sends the transient event to the task.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
More information about the vc
mailing list