rtems: Generate <rtems/rtems/message.h>

Change license to BSD-2-Clause according to file histories and
documentation re-licensing agreement.

Update #3899.
Update #3993.

1 files changed, 244 insertions, 187 deletions

diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 14083b8cd0..ffe7d0b717 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -1,22 +1,57 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicMessageQueue
- *
- * @brief Classic Message Queue Manager API
+ * @brief This header file defines the Message Manager API.
  */
 
-/* COPYRIGHT (c) 1989-2013.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * This file is part of the RTEMS quality process and was automatically
+ * generated.  If you find something that needs to be fixed or
+ * worded better please post a report or patch to an RTEMS mailing list
+ * or raise a bug report:
+ *
+ * https://docs.rtems.org/branches/master/user/support/bugs.html
  *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.org/license/LICENSE.
+ * For information on updating and regenerating please refer to:
+ *
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
  */
 
+/* Generated from spec:/rtems/message/if/header */
+
 #ifndef _RTEMS_RTEMS_MESSAGE_H
 #define _RTEMS_RTEMS_MESSAGE_H
 
+#include <stddef.h>
+#include <stdint.h>
 #include <rtems/rtems/attr.h>
 #include <rtems/rtems/options.h>
 #include <rtems/rtems/status.h>
@@ -27,17 +62,63 @@
 extern "C" {
 #endif
 
+/* Generated from spec:/rtems/message/if/group */
+
 /**
- *  @defgroup ClassicMessageQueue Message Queues
+ * @defgroup RTEMSAPIClassicMessage Message Manager
  *
- *  @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIClassic
  *
- *  This encapsulates functionality related to the Classic API Message Queue
- *  Manager.
+ * @brief The Message Manager provides communication and synchronization
+ *   capabilities using RTEMS message queues.
  */
-/**@{*/
+
+/* Generated from spec:/rtems/message/if/broadcast */
 
 /**
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
+ *
+ * @param id %
+ *
+ * @param buffer %
+ *
+ * @param size %
+ *
+ * @param count %
+ */
+rtems_status_code rtems_message_queue_broadcast(
+  rtems_id    id,
+  const void *buffer,
+  size_t      size,
+  uint32_t   *count
+);
+
+/* Generated from spec:/rtems/message/if/buffer */
+
+/**
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief Defines a structure which can be used as a message queue buffer for
+ *   messages of the specified maximum size.
+ *
+ * Use this macro to define the message buffer storage area for
+ * rtems_message_queue_construct().
+ *
+ * @param _maximum_message_size is the maximum message size in bytes.
+ */
+#define RTEMS_MESSAGE_QUEUE_BUFFER( _maximum_message_size ) \
+  struct { \
+    CORE_message_queue_Buffer _buffer; \
+    char _message[ _maximum_message_size ]; \
+  }
+
+/* Generated from spec:/rtems/message/if/config */
+
+/**
+ * @ingroup RTEMSAPIClassicMessage
+ *
  * @brief This structure defines the configuration of a message queue
  *   constructed by rtems_message_queue_construct().
  */
@@ -90,22 +171,11 @@ typedef struct {
   rtems_attribute attributes;
 } rtems_message_queue_config;
 
-/**
- * @brief Defines a structure which can be used as a message queue buffer for
- *   messages of the specified maximum size.
- *
- * Use this macro to define the message buffer storage area for
- * rtems_message_queue_construct().
- *
- * @param _maximum_message_size is the maximum message size in bytes.
- */
-#define RTEMS_MESSAGE_QUEUE_BUFFER( _maximum_message_size ) \
-  struct { \
-    CORE_message_queue_Buffer _buffer; \
-    char _message[ _maximum_message_size ]; \
-  }
+/* Generated from spec:/rtems/message/if/construct */
 
 /**
+ * @ingroup RTEMSAPIClassicMessage
+ *
  * @brief Constructs a message queue from the specified the message queue
  *   configuration.
  *
@@ -130,7 +200,7 @@ typedef struct {
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *
- * @retval ::RTEMS_INVALID_ADDRESS The id parameter was NULL.
+ * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
  *
  * @retval ::RTEMS_INVALID_NAME The message queue name in the configuration was
  *   invalid.
@@ -167,212 +237,199 @@ rtems_status_code rtems_message_queue_construct(
   rtems_id                         *id
 );
 
+/* Generated from spec:/rtems/message/if/create */
+
 /**
- * @brief RTEMS Create Message Queue
- *
- * This routine implements the rtems_message_queue_create directive. The
- * message queue will have the @a name. If the @a attribute_set indicates
- * that the message queue is to be limited in the number of messages
- * that can be outstanding, then @a count indicates the maximum number of
- * messages that will be held. It returns the id of the created
- * message queue in @a id.
- *
- * @param[in] name is the user defined queue name
- * @param[in] count is the maximum message and reserved buffer count
- * @param[in] max_message_size is the maximum size of each message
- * @param[in] attribute_set is the process method
- * @param[in] id is the pointer to queue
- *
- * @retval This method returns RTEMS_SUCCESSFUL if there was not an
- *         error. Otherwise, a status code is returned indicating the
- *         source of the error. If successful, the @a id will
- *         be filled in with the queue id.
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
+ *
+ * @param name %
+ *
+ * @param count %
+ *
+ * @param max_message_size %
+ *
+ * @param attribute_set %
+ *
+ * @param id %
  */
 rtems_status_code rtems_message_queue_create(
-  rtems_name       name,
-  uint32_t         count,
-  size_t           max_message_size,
-  rtems_attribute  attribute_set,
-  rtems_id        *id
+  rtems_name      name,
+  uint32_t        count,
+  size_t          max_message_size,
+  rtems_attribute attribute_set,
+  rtems_id       *id
 );
 
+/* Generated from spec:/rtems/message/if/delete */
+
 /**
- * @brief RTEMS Message Queue Name to Id
- *
- * This routine implements the rtems_message_queue_ident directive.
- * This directive returns the message queue ID associated with NAME.
- * If more than one message queue is named name, then the message
- * queue to which the ID belongs is arbitrary. node indicates the
- * extent of the search for the ID of the message queue named name.
- * The search can be limited to a particular node or allowed to
- * encompass all nodes.
- *
- * @param[in] name is the user defined message queue name
- * @param[in] node is the node(s) to be searched
- * @param[in] id is the pointer to message queue id
- *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
- * *id filled with the message queue id
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
+ *
+ * @param id %
  */
-rtems_status_code rtems_message_queue_ident(
-  rtems_name  name,
-  uint32_t    node,
-  rtems_id   *id
-);
+rtems_status_code rtems_message_queue_delete( rtems_id id );
+
+/* Generated from spec:/rtems/message/if/flush */
 
 /**
- * @brief RTEMS Delete Message Queue
+ * @ingroup RTEMSAPIClassicMessage
  *
- * This routine implements the rtems_message_queue_delete directive. The
- * message queue indicated by ID is deleted.
+ * @brief %
  *
- * @param[in] id is the queue id
+ * @param id %
  *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ * @param count %
  */
-rtems_status_code rtems_message_queue_delete(
-  rtems_id id
-);
+rtems_status_code rtems_message_queue_flush( rtems_id id, uint32_t *count );
 
-/**
- * @brief Sends a message to the message queue.
- *
- * This directive sends the message buffer to the message queue indicated by
- * ID.  If one or more tasks is blocked waiting to receive a message from this
- * message queue, then one will receive the message.  The task selected to
- * receive the message is based on the task queue discipline algorithm in use
- * by this particular message queue.  If no tasks are waiting, then the message
- * buffer will be placed at the rear of the chain of pending messages for this
- * message queue.
- *
- * @param id The message queue ID.
- * @param buffer The message content buffer.
- * @param size The size of the message.
- *
- * @retval RTEMS_SUCCESSFUL Successful operation.
- * @retval RTEMS_INVALID_ID Invalid message queue ID.
- * @retval RTEMS_INVALID_ADDRESS The message buffer pointer is @c NULL.
- * @retval RTEMS_INVALID_SIZE The message size is larger than the maximum
- *   message size of the message queue.
- * @retval RTEMS_TOO_MANY The new message would exceed the message queue limit
- *   for pending messages.
- */
-rtems_status_code rtems_message_queue_send(
-  rtems_id    id,
-  const void *buffer,
-  size_t      size
-);
+/* Generated from spec:/rtems/message/if/get-number-pending */
 
 /**
- * @brief RTEMS Urgent Message Queue
+ * @ingroup RTEMSAPIClassicMessage
  *
- * This routine implements the rtems_message_queue_urgent directive.
- * This directive has the same behavior as rtems_message_queue_send
- * except that if no tasks are waiting, the message buffer will
- * be placed at the FRONT of the chain of pending messages rather
- * than at the REAR.
+ * @brief %
  *
- * @param[in] id is the pointer to message queue
- * @param[in] buffer is the pointer to message buffer
- * @param[in] size is the size of message to send urgently
+ * @param id %
  *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ * @param count %
  */
-rtems_status_code rtems_message_queue_urgent(
-  rtems_id    id,
-  const void *buffer,
-  size_t      size
+rtems_status_code rtems_message_queue_get_number_pending(
+  rtems_id  id,
+  uint32_t *count
 );
 
+/* Generated from spec:/rtems/message/if/ident */
+
 /**
- * @brief RTEMS Broadcast Message Queue
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief Identifies a message queue object by the specified object name.
+ *
+ * This directive obtains the message queue identifier associated with the
+ * message queue name specified in ``name``.
+ *
+ * The node to search is specified in ``node``.  It shall be
+ *
+ * * a valid node number,
+ *
+ * * the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
+ *
+ * * the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
+ *
+ * * the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
+ *   local node.
+ *
+ * If the message queue name is not unique, then the message queue identifier
+ * will match the first message queue with that name in the search order.
+ * However, this message queue identifier is not guaranteed to correspond to
+ * the desired message queue.  The message queue identifier is used with other
+ * message related directives to access the message queue.
+ *
+ * If node is #RTEMS_SEARCH_ALL_NODES, all nodes are searched with the local
+ * node being searched first.  All other nodes are searched with the lowest
+ * numbered node searched first.
+ *
+ * If node is a valid node number which does not represent the local node, then
+ * only the message queues exported by the designated node are searched.
+ *
+ * This directive does not generate activity on remote nodes.  It accesses only
+ * the local copy of the global object table.
+ *
+ * @param name is the object name to look up.
+ *
+ * @param node is the node or node set to search for a matching object.
+ *
+ * @param[out] id is the pointer to an object identifier variable.  The object
+ *   identifier of an object with the specified name will be stored in this
+ *   variable, in case of a successful operation.
+ *
+ * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
+ *
+ * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
  *
- * This routine implements the rtems_message_queue_broadcast directive.
- * This directive sends the message buffer to all of the tasks blocked
- * waiting for a message on the message queue indicated by ID.
- * If no tasks are waiting, then the message buffer will not be queued.
+ * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was 0.
  *
- * @param[in] id is the pointer to message queue
- * @param[in] buffer is the pointer to message buffer
- * @param[in] size is the size of message to broadcast
- * @param[in] count pointer to area to store number of threads made ready
+ * @retval ::RTEMS_INVALID_NAME There was no object with the specified name on
+ *   the specified nodes.
  *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
- * 		*count filled in with number of threads made ready
+ * @retval ::RTEMS_INVALID_NODE In multiprocessing configurations, the
+ *   specified node was invalid.
  */
-rtems_status_code rtems_message_queue_broadcast(
-  rtems_id    id,
-  const void *buffer,
-  size_t      size,
-  uint32_t   *count
+rtems_status_code rtems_message_queue_ident(
+  rtems_name name,
+  uint32_t   node,
+  rtems_id  *id
 );
 
+/* Generated from spec:/rtems/message/if/receive */
+
 /**
- * @brief Receives a message from the message queue
- *
- * This directive is invoked when the calling task wishes to receive a message
- * from the message queue indicated by ID. The received message is to be placed
- * in the buffer. If no messages are outstanding and the option set indicates
- * that the task is willing to block, then the task will be blocked until a
- * message arrives or until, optionally, timeout clock ticks have passed.
- *
- * @param id The message queue ID.
- * @param[out] buffer The buffer for the message content.  The buffer must be
- *   large enough to store maximum size messages of this message queue.
- * @param[out] size The size of the message.
- * @param option_set The option set, e.g. RTEMS_NO_WAIT or RTEMS_WAIT.
- * @param timeout The number of ticks to wait if the RTEMS_WAIT is set.  Use
- *   RTEMS_NO_TIMEOUT to wait indefinitely.
- *
- * @retval RTEMS_SUCCESSFUL Successful operation.
- * @retval RTEMS_INVALID_ID Invalid message queue ID.
- * @retval RTEMS_INVALID_ADDRESS The message buffer pointer or the message size
- *   pointer is @c NULL.
- * @retval RTEMS_TIMEOUT A timeout occurred and no message was received.
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
+ *
+ * @param id %
+ *
+ * @param buffer %
+ *
+ * @param size %
+ *
+ * @param option_set %
+ *
+ * @param timeout %
  */
 rtems_status_code rtems_message_queue_receive(
-  rtems_id        id,
-  void           *buffer,
-  size_t         *size,
-  rtems_option    option_set,
-  rtems_interval  timeout
+  rtems_id       id,
+  void          *buffer,
+  size_t        *size,
+  rtems_option   option_set,
+  rtems_interval timeout
 );
 
+/* Generated from spec:/rtems/message/if/send */
+
 /**
- *  @brief rtems_message_queue_flush
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
  *
- *  This routine implements the rtems_message_queue_flush directive.
- *  This directive takes all outstanding messages for the message
- *  queue indicated by ID and returns them to the inactive message
- *  chain.  The number of messages flushed is returned in COUNT.
+ * @param id %
  *
- *  Message Queue Manager
+ * @param buffer %
+ *
+ * @param size %
  */
-rtems_status_code rtems_message_queue_flush(
-  rtems_id  id,
-  uint32_t *count
+rtems_status_code rtems_message_queue_send(
+  rtems_id    id,
+  const void *buffer,
+  size_t      size
 );
 
+/* Generated from spec:/rtems/message/if/urgent */
+
 /**
- *  @brief RTEMS Message Queue Get Number Pending
+ * @ingroup RTEMSAPIClassicMessage
+ *
+ * @brief %
  *
- *  Message Queue Manager
+ * @param id %
  *
- *  This routine implements the rtems_message_queue_get_number_pending
- *  directive.  This directive returns the number of pending
- *  messages for the message queue indicated by ID
- *  chain.  The number of messages pending is returned in COUNT.
+ * @param buffer %
+ *
+ * @param size %
  */
-rtems_status_code rtems_message_queue_get_number_pending(
-  rtems_id  id,
-  uint32_t *count
+rtems_status_code rtems_message_queue_urgent(
+  rtems_id    id,
+  const void *buffer,
+  size_t      size
 );
 
-/**@}*/
-
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_MESSAGE_H */