summaryrefslogtreecommitdiff
path: root/spec/if/rtems/message
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-22 08:36:47 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-03 10:22:46 +0200
commitaf77e87a0bf21f4fef8074cc3b9133f85e0613ac (patch)
tree54083f648da224b14c37558f608809bf29c0e959 /spec/if/rtems/message
parent6bad1930ac62e0bcdada77d967b17c078b0af568 (diff)
spec: Add /if/rtems/message/*
Diffstat (limited to 'spec/if/rtems/message')
-rw-r--r--spec/if/rtems/message/broadcast.yml42
-rw-r--r--spec/if/rtems/message/create.yml46
-rw-r--r--spec/if/rtems/message/delete.yml30
-rw-r--r--spec/if/rtems/message/flush.yml34
-rw-r--r--spec/if/rtems/message/get-number-pending.yml34
-rw-r--r--spec/if/rtems/message/header.yml11
-rw-r--r--spec/if/rtems/message/ident.yml38
-rw-r--r--spec/if/rtems/message/receive.yml46
-rw-r--r--spec/if/rtems/message/send.yml38
-rw-r--r--spec/if/rtems/message/urgent.yml38
10 files changed, 357 insertions, 0 deletions
diff --git a/spec/if/rtems/message/broadcast.yml b/spec/if/rtems/message/broadcast.yml
new file mode 100644
index 00000000..bd4ddee7
--- /dev/null
+++ b/spec/if/rtems/message/broadcast.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/id:/name} ${.:/params[0]/name}
+ - const void *${.:/params[1]/name}
+ - ${/if/c/size_t:/name} ${.:/params[2]/name}
+ - ${/if/c/uint32_t:/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/message
+name: rtems_message_queue_broadcast
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: buffer
+- description: '%'
+ dir: null
+ name: size
+- description: '%'
+ dir: null
+ name: count
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/create.yml b/spec/if/rtems/message/create.yml
new file mode 100644
index 00000000..a6bfcc58
--- /dev/null
+++ b/spec/if/rtems/message/create.yml
@@ -0,0 +1,46 @@
+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}
+ - ${/if/c/uint32_t:/name} ${.:/params[1]/name}
+ - ${/if/c/size_t:/name} ${.:/params[2]/name}
+ - ${../attr/attribute:/name} ${.:/params[3]/name}
+ - ${../types/id:/name} *${.:/params[4]/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/message
+name: rtems_message_queue_create
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: name
+- description: '%'
+ dir: null
+ name: count
+- description: '%'
+ dir: null
+ name: max_message_size
+- description: '%'
+ dir: null
+ name: attribute_set
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/delete.yml b/spec/if/rtems/message/delete.yml
new file mode 100644
index 00000000..6c326c65
--- /dev/null
+++ b/spec/if/rtems/message/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/message
+name: rtems_message_queue_delete
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/flush.yml b/spec/if/rtems/message/flush.yml
new file mode 100644
index 00000000..99bfab6f
--- /dev/null
+++ b/spec/if/rtems/message/flush.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/message
+name: rtems_message_queue_flush
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: count
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/get-number-pending.yml b/spec/if/rtems/message/get-number-pending.yml
new file mode 100644
index 00000000..ff03156d
--- /dev/null
+++ b/spec/if/rtems/message/get-number-pending.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/message
+name: rtems_message_queue_get_number_pending
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: count
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/header.yml b/spec/if/rtems/message/header.yml
new file mode 100644
index 00000000..7b11b999
--- /dev/null
+++ b/spec/if/rtems/message/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/message.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/if/rtems/message/ident.yml b/spec/if/rtems/message/ident.yml
new file mode 100644
index 00000000..56c6d917
--- /dev/null
+++ b/spec/if/rtems/message/ident.yml
@@ -0,0 +1,38 @@
+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}
+ - ${/if/c/uint32_t:/name} ${.:/params[1]/name}
+ - ${../types/id:/name} *${.:/params[2]/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/message
+name: rtems_message_queue_ident
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: name
+- description: '%'
+ dir: null
+ name: node
+- description: '%'
+ dir: null
+ name: id
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/receive.yml b/spec/if/rtems/message/receive.yml
new file mode 100644
index 00000000..af841ad1
--- /dev/null
+++ b/spec/if/rtems/message/receive.yml
@@ -0,0 +1,46 @@
+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}
+ - void *${.:/params[1]/name}
+ - ${/if/c/size_t:/name} *${.:/params[2]/name}
+ - ${../options/option:/name} ${.:/params[3]/name}
+ - ${../types/interval:/name} ${.:/params[4]/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/message
+name: rtems_message_queue_receive
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: buffer
+- description: '%'
+ dir: null
+ name: size
+- description: '%'
+ dir: null
+ name: option_set
+- description: '%'
+ dir: null
+ name: timeout
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/send.yml b/spec/if/rtems/message/send.yml
new file mode 100644
index 00000000..9c8bca44
--- /dev/null
+++ b/spec/if/rtems/message/send.yml
@@ -0,0 +1,38 @@
+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}
+ - const void *${.:/params[1]/name}
+ - ${/if/c/size_t:/name} ${.:/params[2]/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/message
+name: rtems_message_queue_send
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: buffer
+- description: '%'
+ dir: null
+ name: size
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/if/rtems/message/urgent.yml b/spec/if/rtems/message/urgent.yml
new file mode 100644
index 00000000..03ee5ca4
--- /dev/null
+++ b/spec/if/rtems/message/urgent.yml
@@ -0,0 +1,38 @@
+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}
+ - const void *${.:/params[1]/name}
+ - ${/if/c/size_t:/name} ${.:/params[2]/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/message
+name: rtems_message_queue_urgent
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: id
+- description: '%'
+ dir: null
+ name: buffer
+- description: '%'
+ dir: null
+ name: size
+return:
+ return: null
+ return-values: []
+type: interface