Generate <rtems/rtems/part.h>

1 files changed, 90 insertions, 81 deletions

diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 5a6484329f..d0c87df211 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -1,22 +1,53 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicPart
+ * @ingroup RTEMSAPIClassicPart
  *
- * @brief Classic Partition Manager API
+ * @brief This header file defines the Partition Manager API.
+ */
+
+/*
+ * 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.
  */
 
-/* COPYRIGHT (c) 1989-2008.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * This file was automatically generated.  Do not edit it manually.
+ * Please have a look at
  *
- * 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.
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
+ *
+ * for information how to maintain and re-generate this file.
  */
 
 #ifndef _RTEMS_RTEMS_PART_H
 #define _RTEMS_RTEMS_PART_H
 
+#include <stddef.h>
+#include <stdint.h>
 #include <rtems/rtems/attr.h>
 #include <rtems/rtems/status.h>
 #include <rtems/rtems/types.h>
@@ -26,112 +57,90 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup ClassicPart Partitions
+ * @defgroup RTEMSAPIClassicPart Partition Manager
  *
- *  @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIClassic
  *
- *  This encapsulates functionality related to the
- *  Classic API Partition Manager.
+ * @brief The Partition Manager provides facilities to dynamically allocate
+ *   memory in fixed-size units.
  */
-/**@{*/
 
 /**
- *  @brief RTEMS Partition Create
+ * @ingroup RTEMSAPIClassicPart
+ *
+ * @brief %
+ *
+ * @param name %
  *
- *  Partition Manager
+ * @param starting_address %
  *
- *  This routine implements the rtems_partition_create directive.  The
- *  partition will have the name name.  The memory area managed by
- *  the partition is of length bytes and starts at starting_address.
- *  The memory area will be divided into as many buffers of
- *  buffer_size bytes as possible.   The attribute_set determines if
- *  the partition is global or local.  It returns the id of the
- *  created partition in ID.
+ * @param length %
+ *
+ * @param buffer_size %
+ *
+ * @param attribute_set %
+ *
+ * @param id %
  */
 rtems_status_code rtems_partition_create(
-  rtems_name       name,
-  void            *starting_address,
-  uintptr_t        length,
-  size_t           buffer_size,
-  rtems_attribute  attribute_set,
-  rtems_id        *id
+  rtems_name      name,
+  void           *starting_address,
+  uintptr_t       length,
+  size_t          buffer_size,
+  rtems_attribute attribute_set,
+  rtems_id       *id
 );
 
 /**
- * @brief RTEMS Partition Ident
- *
- * This routine implements the rtems_partition_ident directive.
- * This directive returns the partition ID associated with name.
- * If more than one partition is named name, then the partition
- * to which the ID belongs is arbitrary. node indicates the
- * extent of the search for the ID of the partition named name.
- * The search can be limited to a particular node or allowed to
- * encompass all nodes.
- *
- * @param[in] name is the user defined partition name
- * @param[in] node is(are) the node(s) to be searched
- * @param[in] id is the pointer to partition id
- *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
- * 		*id filled in with the partition id
+ * @ingroup RTEMSAPIClassicPart
+ *
+ * @brief %
+ *
+ * @param id %
  */
-rtems_status_code rtems_partition_ident(
-  rtems_name  name,
-  uint32_t    node,
-  rtems_id   *id
-);
+rtems_status_code rtems_partition_delete( rtems_id id );
 
 /**
- * @brief RTEMS Delete Partition
+ * @ingroup RTEMSAPIClassicPart
  *
- * This routine implements the rtems_partition_delete directive. The
- * partition indicated by ID is deleted, provided that none of its buffers
- * are still allocated.
+ * @brief %
  *
- * @param[in] id is the partition id
+ * @param id %
  *
- * @retval This method returns RTEMS_SUCCESSFUL if there was not an
- *         error. Otherwise, a status code is returned indicating the
- *         source of the error.
+ * @param buffer %
  */
-rtems_status_code rtems_partition_delete(
-  rtems_id id
-);
+rtems_status_code rtems_partition_get_buffer( rtems_id id, void **buffer );
 
 /**
- * @brief RTEMS Get Partition Buffer
+ * @ingroup RTEMSAPIClassicPart
  *
- * This routine implements the rtems_partition_get_buffer directive. It
- * attempts to allocate a buffer from the partition associated with ID.
- * If a buffer is allocated, its address is returned in buffer.
+ * @brief %
  *
- * @param[in] id is the partition id
- * @param[out] buffer is the pointer to buffer address
+ * @param name %
  *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ * @param node %
+ *
+ * @param id %
  */
-rtems_status_code rtems_partition_get_buffer(
-  rtems_id   id,
-  void     **buffer
+rtems_status_code rtems_partition_ident(
+  rtems_name name,
+  uint32_t   node,
+  rtems_id  *id
 );
 
 /**
- *  @brief rtems_partition_return_buffer
+ * @ingroup RTEMSAPIClassicPart
  *
- *  This routine implements the rtems_partition_return_buffer directive.  It
- *  frees the buffer to the partition associated with ID.  The buffer must
- *  have been previously allocated from the same partition.
+ * @brief %
+ *
+ * @param id %
+ *
+ * @param buffer %
  */
-rtems_status_code rtems_partition_return_buffer(
-  rtems_id  id,
-  void     *buffer
-);
-
-/**@}*/
+rtems_status_code rtems_partition_return_buffer( rtems_id id, void *buffer );
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_PART_H */