diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-22 08:36:47 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-03 10:22:45 +0200 |
commit | e27600eb6402b6d3b8bf6ba504cad4fb3d5877a2 (patch) | |
tree | 19428d1bc528cc9d16aacaa994148138d9a91309 | |
parent | spec: Add /if/rtems/sem/* (diff) | |
download | rtems-central-e27600eb6402b6d3b8bf6ba504cad4fb3d5877a2.tar.bz2 |
spec: Add /if/rtems/barrier/*
-rw-r--r-- | spec/groups/api/classic/barrier.yml | 18 | ||||
-rw-r--r-- | spec/if/rtems/barrier/create.yml | 42 | ||||
-rw-r--r-- | spec/if/rtems/barrier/delete.yml | 30 | ||||
-rw-r--r-- | spec/if/rtems/barrier/header.yml | 11 | ||||
-rw-r--r-- | spec/if/rtems/barrier/ident.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/barrier/release.yml | 34 | ||||
-rw-r--r-- | spec/if/rtems/barrier/wait.yml | 34 |
7 files changed, 203 insertions, 0 deletions
diff --git a/spec/groups/api/classic/barrier.yml b/spec/groups/api/classic/barrier.yml new file mode 100644 index 00000000..32df18e1 --- /dev/null +++ b/spec/groups/api/classic/barrier.yml @@ -0,0 +1,18 @@ +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) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + The barrier manager provides a unique synchronization capability which can be + used to have a set of tasks block and be unblocked as a set. +enabled-by: true +identifier: RTEMSAPIClassicBarrier +interface-type: group +links: +- role: interface-placement + uid: /if/rtems/barrier/header +- role: interface-ingroup + uid: /groups/api/classic +name: Barrier Manager +type: interface diff --git a/spec/if/rtems/barrier/create.yml b/spec/if/rtems/barrier/create.yml new file mode 100644 index 00000000..3b28b72a --- /dev/null +++ b/spec/if/rtems/barrier/create.yml @@ -0,0 +1,42 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +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: + - ${../types/name:/name} ${.:/params[0]/name} + - ${../attr/attribute:/name} ${.:/params[1]/name} + - ${/if/c/uint32_t:/name} ${.:/params[2]/name} + - ${../types/id:/name} *${.:/params[3]/name} + return: ${../status/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/barrier +name: rtems_barrier_create +notes: null +params: +- description: '%' + dir: null + name: name +- description: '%' + dir: null + name: attribute_set +- description: '%' + dir: null + name: maximum_waiters +- description: '%' + dir: null + name: id +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/barrier/delete.yml b/spec/if/rtems/barrier/delete.yml new file mode 100644 index 00000000..6a463999 --- /dev/null +++ b/spec/if/rtems/barrier/delete.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +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: + - ${../types/id:/name} ${.:/params[0]/name} + return: ${../status/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/barrier +name: rtems_barrier_delete +notes: null +params: +- description: '%' + dir: null + name: id +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/barrier/header.yml b/spec/if/rtems/barrier/header.yml new file mode 100644 index 00000000..4bc5040b --- /dev/null +++ b/spec/if/rtems/barrier/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/barrier.h +prefix: cpukit/include +type: interface diff --git a/spec/if/rtems/barrier/ident.yml b/spec/if/rtems/barrier/ident.yml new file mode 100644 index 00000000..b761f199 --- /dev/null +++ b/spec/if/rtems/barrier/ident.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +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: + - ${../types/name:/name} ${.:/params[0]/name} + - ${../types/id:/name} *${.:/params[1]/name} + return: ${../status/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/barrier +name: rtems_barrier_ident +notes: null +params: +- description: '%' + dir: null + name: name +- description: '%' + dir: null + name: id +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/barrier/release.yml b/spec/if/rtems/barrier/release.yml new file mode 100644 index 00000000..859663ae --- /dev/null +++ b/spec/if/rtems/barrier/release.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +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: + - ${../types/id:/name} ${.:/params[0]/name} + - ${/if/c/uint32_t:/name} *${.:/params[1]/name} + return: ${../status/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/barrier +name: rtems_barrier_release +notes: null +params: +- description: '%' + dir: null + name: id +- description: '%' + dir: null + name: released +return: + return: null + return-values: [] +type: interface diff --git a/spec/if/rtems/barrier/wait.yml b/spec/if/rtems/barrier/wait.yml new file mode 100644 index 00000000..db6afc05 --- /dev/null +++ b/spec/if/rtems/barrier/wait.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +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: + - ${../types/id:/name} ${.:/params[0]/name} + - ${../types/interval:/name} ${.:/params[1]/name} + return: ${../status/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/barrier +name: rtems_barrier_wait +notes: null +params: +- description: '%' + dir: null + name: id +- description: '%' + dir: null + name: timeout +return: + return: null + return-values: [] +type: interface |