diff options
Diffstat (limited to 'spec/rtems/event/if')
50 files changed, 1226 insertions, 0 deletions
diff --git a/spec/rtems/event/if/all-events.yml b/spec/rtems/event/if/all-events.yml new file mode 100644 index 00000000..792dbebe --- /dev/null +++ b/spec/rtems/event/if/all-events.yml @@ -0,0 +1,22 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This constant contains all events in 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) +definition: + default: '0xffffffff' + variants: [] +description: | + The value of this constant is identical to ${event-0:/name} | ... | + ${event-31:/name}. +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_ALL_EVENTS +notes: null +type: interface diff --git a/spec/rtems/event/if/event-0.yml b/spec/rtems/event/if/event-0.yml new file mode 100644 index 00000000..976e5d9b --- /dev/null +++ b/spec/rtems/event/if/event-0.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000001' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_0 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-1.yml b/spec/rtems/event/if/event-1.yml new file mode 100644 index 00000000..cf2a5760 --- /dev/null +++ b/spec/rtems/event/if/event-1.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000002' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_1 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-10.yml b/spec/rtems/event/if/event-10.yml new file mode 100644 index 00000000..f35de1f0 --- /dev/null +++ b/spec/rtems/event/if/event-10.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000400' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_10 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-11.yml b/spec/rtems/event/if/event-11.yml new file mode 100644 index 00000000..ee7d3c82 --- /dev/null +++ b/spec/rtems/event/if/event-11.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000800' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_11 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-12.yml b/spec/rtems/event/if/event-12.yml new file mode 100644 index 00000000..0b4fc7cf --- /dev/null +++ b/spec/rtems/event/if/event-12.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00001000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_12 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-13.yml b/spec/rtems/event/if/event-13.yml new file mode 100644 index 00000000..f4ff6634 --- /dev/null +++ b/spec/rtems/event/if/event-13.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00002000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_13 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-14.yml b/spec/rtems/event/if/event-14.yml new file mode 100644 index 00000000..fad4334d --- /dev/null +++ b/spec/rtems/event/if/event-14.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00004000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_14 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-15.yml b/spec/rtems/event/if/event-15.yml new file mode 100644 index 00000000..5176416c --- /dev/null +++ b/spec/rtems/event/if/event-15.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00008000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_15 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-16.yml b/spec/rtems/event/if/event-16.yml new file mode 100644 index 00000000..4f44a2ac --- /dev/null +++ b/spec/rtems/event/if/event-16.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00010000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_16 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-17.yml b/spec/rtems/event/if/event-17.yml new file mode 100644 index 00000000..24f153e9 --- /dev/null +++ b/spec/rtems/event/if/event-17.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00020000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_17 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-18.yml b/spec/rtems/event/if/event-18.yml new file mode 100644 index 00000000..dca01762 --- /dev/null +++ b/spec/rtems/event/if/event-18.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00040000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_18 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-19.yml b/spec/rtems/event/if/event-19.yml new file mode 100644 index 00000000..58f8be6f --- /dev/null +++ b/spec/rtems/event/if/event-19.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00080000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_19 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-2.yml b/spec/rtems/event/if/event-2.yml new file mode 100644 index 00000000..d9614ea6 --- /dev/null +++ b/spec/rtems/event/if/event-2.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000004' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_2 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-20.yml b/spec/rtems/event/if/event-20.yml new file mode 100644 index 00000000..5e6d0428 --- /dev/null +++ b/spec/rtems/event/if/event-20.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00100000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_20 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-21.yml b/spec/rtems/event/if/event-21.yml new file mode 100644 index 00000000..a43624da --- /dev/null +++ b/spec/rtems/event/if/event-21.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00200000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_21 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-22.yml b/spec/rtems/event/if/event-22.yml new file mode 100644 index 00000000..2e6fc3ef --- /dev/null +++ b/spec/rtems/event/if/event-22.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00400000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_22 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-23.yml b/spec/rtems/event/if/event-23.yml new file mode 100644 index 00000000..a4e27650 --- /dev/null +++ b/spec/rtems/event/if/event-23.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00800000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_23 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-24.yml b/spec/rtems/event/if/event-24.yml new file mode 100644 index 00000000..ec870df8 --- /dev/null +++ b/spec/rtems/event/if/event-24.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x01000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_24 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-25.yml b/spec/rtems/event/if/event-25.yml new file mode 100644 index 00000000..ff245093 --- /dev/null +++ b/spec/rtems/event/if/event-25.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x02000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_25 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-26.yml b/spec/rtems/event/if/event-26.yml new file mode 100644 index 00000000..ec8f6287 --- /dev/null +++ b/spec/rtems/event/if/event-26.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x04000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_26 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-27.yml b/spec/rtems/event/if/event-27.yml new file mode 100644 index 00000000..2bdfaf8a --- /dev/null +++ b/spec/rtems/event/if/event-27.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x08000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_27 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-28.yml b/spec/rtems/event/if/event-28.yml new file mode 100644 index 00000000..30086e05 --- /dev/null +++ b/spec/rtems/event/if/event-28.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x10000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_28 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-29.yml b/spec/rtems/event/if/event-29.yml new file mode 100644 index 00000000..25fbabb6 --- /dev/null +++ b/spec/rtems/event/if/event-29.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x20000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_29 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-3.yml b/spec/rtems/event/if/event-3.yml new file mode 100644 index 00000000..6f02ab05 --- /dev/null +++ b/spec/rtems/event/if/event-3.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000008' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_3 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-30.yml b/spec/rtems/event/if/event-30.yml new file mode 100644 index 00000000..cb99e510 --- /dev/null +++ b/spec/rtems/event/if/event-30.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x40000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_30 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-31.yml b/spec/rtems/event/if/event-31.yml new file mode 100644 index 00000000..ff909283 --- /dev/null +++ b/spec/rtems/event/if/event-31.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x80000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_31 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-4.yml b/spec/rtems/event/if/event-4.yml new file mode 100644 index 00000000..d2384a10 --- /dev/null +++ b/spec/rtems/event/if/event-4.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000010' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_4 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-5.yml b/spec/rtems/event/if/event-5.yml new file mode 100644 index 00000000..db3bbc30 --- /dev/null +++ b/spec/rtems/event/if/event-5.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000020' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_5 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-6.yml b/spec/rtems/event/if/event-6.yml new file mode 100644 index 00000000..0383167d --- /dev/null +++ b/spec/rtems/event/if/event-6.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000040' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_6 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-7.yml b/spec/rtems/event/if/event-7.yml new file mode 100644 index 00000000..56d1e2b2 --- /dev/null +++ b/spec/rtems/event/if/event-7.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000080' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_7 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-8.yml b/spec/rtems/event/if/event-8.yml new file mode 100644 index 00000000..0d2f2274 --- /dev/null +++ b/spec/rtems/event/if/event-8.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000100' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_8 +notes: null +type: interface diff --git a/spec/rtems/event/if/event-9.yml b/spec/rtems/event/if/event-9.yml new file mode 100644 index 00000000..94112830 --- /dev/null +++ b/spec/rtems/event/if/event-9.yml @@ -0,0 +1,20 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000200' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_EVENT_9 +notes: null +type: interface diff --git a/spec/rtems/event/if/group.yml b/spec/rtems/event/if/group.yml new file mode 100644 index 00000000..1c2fd904 --- /dev/null +++ b/spec/rtems/event/if/group.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + The Event Manager provides a high performance method of inter-task + communication and synchronization. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: null +enabled-by: true +identifier: RTEMSAPIClassicEvent +interface-type: group +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: ../../if/group +name: Event Manager +text: | + The Classic API shall provide an interface to the Event Manager. +type: interface diff --git a/spec/rtems/event/if/header.yml b/spec/rtems/event/if/header.yml new file mode 100644 index 00000000..44867cf7 --- /dev/null +++ b/spec/rtems/event/if/header.yml @@ -0,0 +1,12 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines the Event Manager API. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-type: header-file +links: +- role: interface-placement + uid: /if/domain +path: rtems/rtems/event.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/event/if/pending-events.yml b/spec/rtems/event/if/pending-events.yml new file mode 100644 index 00000000..50a7c724 --- /dev/null +++ b/spec/rtems/event/if/pending-events.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This constant used to get the set of pending events in ${receive:/name}. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_PENDING_EVENTS +notes: null +type: interface diff --git a/spec/rtems/event/if/receive.yml b/spec/rtems/event/if/receive.yml new file mode 100644 index 00000000..acd252ba --- /dev/null +++ b/spec/rtems/event/if/receive.yml @@ -0,0 +1,122 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Receives or gets 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) +definition: + default: + body: null + params: + - ${set:/name} ${.:/params[0]/name} + - ${../../option/if/option:/name} ${.:/params[1]/name} + - ${../../type/if/interval:/name} ${.:/params[2]/name} + - ${set:/name} *${.:/params[3]/name} + return: ${../../status/if/code:/name} + variants: [] +description: | + This directive can be used to + + * get the pending events of the calling task, or + + * receive events. + + To *get the pending events* use the constant ${pending-events:/name} for the + ``${.:/params[0]/name}`` parameter. The pending events are returned to the + calling task but the event set of the task is left unaltered. The + ``${.:/params[1]/name}`` and ``${.:params[2]/name}`` parameters are ignored + 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 + + * if the task will wait or poll for the events, and + + * if the task wants to receive all or any of the input events. + + The option set is built through a *bitwise or* of the option constants + described below. + + The task can *wait* or *poll* for the events. + + * Waiting for events is the default and can be emphasized through the use of + the ${../../option/if/wait:/name} option. The ``${.:/params[2]/name}`` + parameter defines how long the task is willing to wait. Use + ${../../type/if/no-timeout:/name} to wait potentially forever, otherwise set a + timeout interval in clock ticks. + + * Not waiting for events (polling) is selected by the + ${../../option/if/no-wait:/name} option. If this option is defined, then the + ``${.:/params[2]/name}`` parameter is ignored. + + The task can receive *all* or *any* of the input events specified in + ``${.:/params[0]/name}``. + + * Receiving all input events is the default and can be emphasized through the use + of the ${../../option/if/event-all:/name} option. + + * Receiving any of the input events is selected by the + ${../../option/if/event-any:/name} option. + + To receive all events use the constant ${all-events:/name} for the + ``${.:/params[0]/name}`` parameter. This constant is identical to + ${event-0:/name} | ... | ${event-31:/name} and should not be confused with + the option ${../../option/if/event-all:/name}. +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_event_receive +notes: | + This directive shall be called by a task. Calling this directive from + interrupt context is undefined behaviour. + + This directive only affects the events specified in ``${.:/params[0]/name}``. + Any pending events that do not correspond to any of the events specified in + ``${.:/params[0]/name}`` will be left pending. + + 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 ${../../status/if/unsatisfied:/name} status code will be returned. +params: +- description: | + is the event set of interest. Use ${pending-events:/name} to get the + pending events. + dir: null + name: event_in +- description: is the option set. + dir: null + name: option_set +- description: | + is the timeout in clock ticks if the ${../../option/if/wait:/name} option was + set. Use ${../../type/if/no-timeout:/name} to wait potentially forever. + dir: null + name: ticks +- description: | + is the pointer to an event set. The received or pending events are stored + in the referenced event set if the operation was successful. + dir: null + name: event_out +return: + return: null + return-values: + - description: | + The requested operation was successful. + value: ${../../status/if/successful:/name} + - description: | + The ``${.:/params[3]/name}`` parameter was ${/c/if/null:/name}. + value: ${../../status/if/invalid-address:/name} + - description: | + The events of interest were not immediately available. + value: ${../../status/if/unsatisfied:/name} + - description: | + The events of interest were not available within the specified timeout + interval. + value: ${../../status/if/timeout:/name} +type: interface diff --git a/spec/rtems/event/if/send.yml b/spec/rtems/event/if/send.yml new file mode 100644 index 00000000..240c30be --- /dev/null +++ b/spec/rtems/event/if/send.yml @@ -0,0 +1,74 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Sends an event set to a task. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: null + params: + - ${../../type/if/id:/name} ${.:/params[0]/name} + - ${set:/name} ${.:/params[1]/name} + 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: + + * The target task is blocked waiting for events, then + + * if the waiting task's input event condition is satisfied, then the task + is made ready for execution, or + + * otherwise, the event set is posted but left pending and the task remains + blocked. + + * The target task is not waiting for events, then the event set is posted and + left pending. +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_event_send +notes: | + Events can be sent by tasks or an ${/glossary/isr:/term}. + + Specifying ${../../task/if/self-define:/name} for ``${.:/params[0]/name}`` results + in the event set being sent to the calling task. + + The event set to send shall be built by a *bitwise or* of the desired events. + The set of valid events is ${event-0:/name} through ${event-31:/name}. If an + event is not explicitly specified in the set, then it is not present. + + Identical events sent to a task are not queued. In other words, the second, + and subsequent, posting of an event to a task before it can perform an + ${receive:/name} has no effect. + + The calling task will be preempted if it has preemption enabled and a higher + priority task is unblocked as the result of this directive. + + Sending an event set to a global task which does not reside on the local node + will generate a request telling the remote node to send the event set to the + appropriate task. +params: +- description: is the identifier of the target task to receive the event set. + dir: null + name: id +- description: is the event set to send. + dir: null + name: event_in +return: + return: null + return-values: + - description: | + The requested operation was successful. + value: ${../../status/if/successful:/name} + - description: | + There was no task with the specified identifier. + value: ${../../status/if/invalid-id:/name} +type: interface diff --git a/spec/rtems/event/if/set.yml b/spec/rtems/event/if/set.yml new file mode 100644 index 00000000..cbcff37d --- /dev/null +++ b/spec/rtems/event/if/set.yml @@ -0,0 +1,21 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${/c/if/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_event_set +notes: null +type: interface diff --git a/spec/rtems/event/if/system-network-close.yml b/spec/rtems/event/if/system-network-close.yml new file mode 100644 index 00000000..db5149de --- /dev/null +++ b/spec/rtems/event/if/system-network-close.yml @@ -0,0 +1,18 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is a 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) +definition: + default: ${event-26:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +name: RTEMS_EVENT_SYSTEM_NETWORK_CLOSE +notes: null +type: interface diff --git a/spec/rtems/event/if/system-network-sbwait.yml b/spec/rtems/event/if/system-network-sbwait.yml new file mode 100644 index 00000000..d1fe0b83 --- /dev/null +++ b/spec/rtems/event/if/system-network-sbwait.yml @@ -0,0 +1,18 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${event-24:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +name: RTEMS_EVENT_SYSTEM_NETWORK_SBWAIT +notes: null +type: interface diff --git a/spec/rtems/event/if/system-network-sosleep.yml b/spec/rtems/event/if/system-network-sosleep.yml new file mode 100644 index 00000000..483afb96 --- /dev/null +++ b/spec/rtems/event/if/system-network-sosleep.yml @@ -0,0 +1,18 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${event-25:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +name: RTEMS_EVENT_SYSTEM_NETWORK_SOSLEEP +notes: null +type: interface diff --git a/spec/rtems/event/if/system-receive.yml b/spec/rtems/event/if/system-receive.yml new file mode 100644 index 00000000..1cecddc4 --- /dev/null +++ b/spec/rtems/event/if/system-receive.yml @@ -0,0 +1,49 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Receives or gets a system event set. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: null + params: + - ${set:/name} ${.:/params[0]/name} + - ${../../option/if/option:/name} ${.:/params[1]/name} + - ${../../type/if/interval:/name} ${.:/params[2]/name} + - ${set:/name} *${.:/params[3]/name} + return: ${../../status/if/code:/name} + variants: [] +description: | + This directive performs the same actions as the ${receive:/name} directive + except that it operates with a different set of events for each task. +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +name: rtems_event_system_receive +notes: null +params: +- description: | + is the event set of interest. Use ${pending-events:/name} to get the + pending events. + dir: null + name: event_in +- description: is the option set. + dir: null + name: option_set +- description: | + is the timeout in clock ticks if the ${../../option/if/wait:/name} option was + set. Use ${../../type/if/no-timeout:/name} to wait potentially forever. + dir: null + name: ticks +- description: | + is the pointer to an event set. The received or pending events are stored + in the referenced event set if the operation was successful. + dir: null + name: event_out +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/event/if/system-send.yml b/spec/rtems/event/if/system-send.yml new file mode 100644 index 00000000..75c7fb53 --- /dev/null +++ b/spec/rtems/event/if/system-send.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Sends a system event set to a task. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: null + params: + - ${../../type/if/id:/name} ${.:/params[0]/name} + - ${set:/name} ${.:/params[1]/name} + return: ${../../status/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +name: rtems_event_system_send +notes: null +params: +- description: is the identifier of the target task to receive the event set. + dir: null + name: id +- description: is the event set to send. + dir: null + name: event_in +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/event/if/system-server-resume.yml b/spec/rtems/event/if/system-server-resume.yml new file mode 100644 index 00000000..83217d87 --- /dev/null +++ b/spec/rtems/event/if/system-server-resume.yml @@ -0,0 +1,19 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${event-29:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +name: RTEMS_EVENT_SYSTEM_SERVER_RESUME +notes: null +type: interface diff --git a/spec/rtems/event/if/system-server.yml b/spec/rtems/event/if/system-server.yml new file mode 100644 index 00000000..e628d449 --- /dev/null +++ b/spec/rtems/event/if/system-server.yml @@ -0,0 +1,19 @@ +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. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${event-30:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +name: RTEMS_EVENT_SYSTEM_SERVER +notes: null +type: interface diff --git a/spec/rtems/event/if/system-transient.yml b/spec/rtems/event/if/system-transient.yml new file mode 100644 index 00000000..a1b4b9e2 --- /dev/null +++ b/spec/rtems/event/if/system-transient.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is a 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) +definition: + default: ${event-31:/name} + variants: [] +description: null +enabled-by: true +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-clear.yml b/spec/rtems/event/if/transient-clear.yml new file mode 100644 index 00000000..de9bf474 --- /dev/null +++ b/spec/rtems/event/if/transient-clear.yml @@ -0,0 +1,32 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Clears the transient event. +copyrights: +- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: | + ${set:/name} event_out; + + (void) ${system-receive:/name}( + ${system-transient:/name}, + ${../../option/if/event-all:/name} | ${../../option/if/no-wait:/name}, + 0, + &event_out + ); + params: [] + return: void + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +name: rtems_event_transient_clear +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/event/if/transient-receive.yml b/spec/rtems/event/if/transient-receive.yml new file mode 100644 index 00000000..1c592d05 --- /dev/null +++ b/spec/rtems/event/if/transient-receive.yml @@ -0,0 +1,40 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Receives the transient event. +copyrights: +- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: | + ${set:/name} event_out; + + return ${system-receive:/name}( + ${system-transient:/name}, + ${../../option/if/event-all:/name} | ${.:/params[0]/name}, + ${.:/params[1]/name}, + &event_out + ); + params: + - ${../../option/if/option:/name} ${.:/params[0]/name} + - ${../../type/if/interval:/name} ${.:/params[1]/name} + return: ${../../status/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +name: rtems_event_transient_receive +notes: null +params: +- description: is the option set. + dir: null + name: option_set +- description: is the optional timeout in clock ticks. + dir: null + name: ticks +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/event/if/transient-send.yml b/spec/rtems/event/if/transient-send.yml new file mode 100644 index 00000000..1bfb6198 --- /dev/null +++ b/spec/rtems/event/if/transient-send.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Sends the transient event to the specified task. +copyrights: +- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: | + return ${system-send:/name}( ${.:/params[0]/name}, ${system-transient:/name} ); + params: + - ${../../type/if/id:/name} ${.:/params[0]/name} + return: ${../../status/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +name: rtems_event_transient_send +notes: null +params: +- description: is the identifier of the task to receive the transient event. + dir: null + name: id +return: + return: null + return-values: [] +type: interface |