diff options
Diffstat (limited to 'spec/rtems/message/if/buffer.yml')
-rw-r--r-- | spec/rtems/message/if/buffer.yml | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/spec/rtems/message/if/buffer.yml b/spec/rtems/message/if/buffer.yml new file mode 100644 index 00000000..0ff6bd16 --- /dev/null +++ b/spec/rtems/message/if/buffer.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Defines a structure which can be used as a message queue buffer for messages + of the specified maximum size. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: | + struct { + ${/score/msgq/if/buffer:/name} _buffer; + char _message[ ${.:/params[0]/name} ]; + } + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_MESSAGE_QUEUE_BUFFER +notes: | + Use this macro to define the message buffer storage area for + ${construct:/name}. +params: +- description: | + is the maximum message size in bytes. + dir: null + name: _maximum_message_size +return: + return: null + return-values: [] +type: interface |