diff options
-rw-r--r-- | spec/groups/api/classic/options.yml | 16 | ||||
-rw-r--r-- | spec/if/rtems/options/default-options.yml | 20 | ||||
-rw-r--r-- | spec/if/rtems/options/event-all.yml | 21 | ||||
-rw-r--r-- | spec/if/rtems/options/event-any.yml | 21 | ||||
-rw-r--r-- | spec/if/rtems/options/header.yml | 11 | ||||
-rw-r--r-- | spec/if/rtems/options/no-wait.yml | 22 | ||||
-rw-r--r-- | spec/if/rtems/options/option.yml | 20 | ||||
-rw-r--r-- | spec/if/rtems/options/wait.yml | 20 |
8 files changed, 151 insertions, 0 deletions
diff --git a/spec/groups/api/classic/options.yml b/spec/groups/api/classic/options.yml new file mode 100644 index 00000000..c42d680e --- /dev/null +++ b/spec/groups/api/classic/options.yml @@ -0,0 +1,16 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: API +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + This group contains the Classic API options. +enabled-by: true +identifier: RTEMSAPIClassicOptions +interface-type: group +links: +- role: interface-placement + uid: /if/rtems/options/header +- role: interface-ingroup + uid: /groups/api/classic +name: Options +type: interface diff --git a/spec/if/rtems/options/default-options.yml b/spec/if/rtems/options/default-options.yml new file mode 100644 index 00000000..94aa6c8b --- /dev/null +++ b/spec/if/rtems/options/default-options.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This option constant is the default option set. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/options +name: RTEMS_DEFAULT_OPTIONS +notes: null +type: interface diff --git a/spec/if/rtems/options/event-all.yml b/spec/if/rtems/options/event-all.yml new file mode 100644 index 00000000..2f603be0 --- /dev/null +++ b/spec/if/rtems/options/event-all.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This option constant indicates that the task wishes to wait until all events + of interest are available. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/options +name: RTEMS_EVENT_ALL +notes: null +type: interface diff --git a/spec/if/rtems/options/event-any.yml b/spec/if/rtems/options/event-any.yml new file mode 100644 index 00000000..2131cf88 --- /dev/null +++ b/spec/if/rtems/options/event-any.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This option constant indicates that the task wishes to wait until any events + of interest are available. +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: /groups/api/classic/options +name: RTEMS_EVENT_ANY +notes: null +type: interface diff --git a/spec/if/rtems/options/header.yml b/spec/if/rtems/options/header.yml new file mode 100644 index 00000000..7a697a16 --- /dev/null +++ b/spec/if/rtems/options/header.yml @@ -0,0 +1,11 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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/domains/api +path: rtems/rtems/options.h +prefix: cpukit/include +type: interface diff --git a/spec/if/rtems/options/no-wait.yml b/spec/if/rtems/options/no-wait.yml new file mode 100644 index 00000000..18f816ce --- /dev/null +++ b/spec/if/rtems/options/no-wait.yml @@ -0,0 +1,22 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This option constant indicates that the task is to not wait on the resource. +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 + If the resource is not available, then directives shall return immediately + with a status to indicate unsatisfied. +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/options +name: RTEMS_NO_WAIT +notes: null +type: interface diff --git a/spec/if/rtems/options/option.yml b/spec/if/rtems/options/option.yml new file mode 100644 index 00000000..6d7cb73b --- /dev/null +++ b/spec/if/rtems/options/option.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This type defines the control block used to manage option sets. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${/if/c/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/options +name: rtems_option +notes: null +type: interface diff --git a/spec/if/rtems/options/wait.yml b/spec/if/rtems/options/wait.yml new file mode 100644 index 00000000..b6123717 --- /dev/null +++ b/spec/if/rtems/options/wait.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This option constant indicates that the task is to wait on resource. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/options +name: RTEMS_WAIT +notes: null +type: interface |