Generate <rtems/rtems/dpmem.h>

1 files changed, 90 insertions, 90 deletions

diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h
index edd080900a..b1b45e5978 100644
--- a/cpukit/include/rtems/rtems/dpmem.h
+++ b/cpukit/include/rtems/rtems/dpmem.h
@@ -1,148 +1,148 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicDPMEM
+ * @ingroup RTEMSAPIClassicDPMem
  *
- * @brief Classic Dual Ported Memory Manager API
+ * @brief This header file defines the Dual-Ported Memory 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_DPMEM_H
 #define _RTEMS_RTEMS_DPMEM_H
 
-#include <rtems/rtems/types.h>
+#include <stdint.h>
 #include <rtems/rtems/status.h>
+#include <rtems/rtems/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- *  @defgroup ClassicDPMEM Dual Ported Memory
+ * @defgroup RTEMSAPIClassicDPMem Dual-Ported Memory Manager
  *
- *  @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIClassic
  *
- *  This encapsulates functionality related to the
- *  Classic API Dual Ported Memory Manager.
+ * @brief The Dual-Ported Memory Manager provides a mechanism for converting
+ *   addresses between internal and external representations for multiple
+ *   dual-ported memory areas (DPMA).
  */
-/**@{*/
 
 /**
- * @brief Creates a port into a dual-ported memory area.
- *
- * This routine implements the rtems_port_create directive. The port
- * will have the name @a name. The port maps onto an area of dual ported
- * memory of length bytes which has internal_start and external_start
- * as the internal and external starting addresses, respectively.
- * It returns the id of the created port in ID.
- *
- * @param[in] name is the user defined port name
- * @param[in] internal_start is the internal start address of port
- * @param[in] external_start is the external start address of port
- * @param[in] length is the physical length in bytes
- * @param[out] id is the address of port id to set
- *
- * @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 id will
- *         be filled in with the port id.
+ * @ingroup RTEMSAPIClassicDPMem
+ *
+ * @brief %
+ *
+ * @param name %
+ *
+ * @param internal_start %
+ *
+ * @param external_start %
+ *
+ * @param length %
+ *
+ * @param id %
  */
 rtems_status_code rtems_port_create(
-  rtems_name    name,
-  void         *internal_start,
-  void         *external_start,
-  uint32_t      length,
-  rtems_id     *id
+  rtems_name name,
+  void      *internal_start,
+  void      *external_start,
+  uint32_t   length,
+  rtems_id  *id
 );
 
 /**
- * @brief RTEMS Port Name to Id
- *
- * This routine implements the rtems_port_ident directive. This directive
- * returns the port ID associated with name. If more than one port is
- * named name, then the port to which the ID belongs is arbitrary.
+ * @ingroup RTEMSAPIClassicDPMem
  *
- * @param[in] name is the user defined port name
- * @param[out] id is the pointer to port id
+ * @brief %
  *
- * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ * @param id %
  */
-rtems_status_code rtems_port_ident(
-  rtems_name    name,
-  rtems_id     *id
-);
+rtems_status_code rtems_port_delete( rtems_id id );
 
 /**
- * @brief RTEMS Delete Port
+ * @ingroup RTEMSAPIClassicDPMem
  *
- * This routine implements the rtems_port_delete directive. It deletes
- * the port associated with ID.
+ * @brief %
  *
- * @param[in] id is the dual-ported memory area 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 external %
+ *
+ * @param internal %
  */
-rtems_status_code rtems_port_delete(
-  rtems_id   id
+rtems_status_code rtems_port_external_to_internal(
+  rtems_id id,
+  void    *external,
+  void   **internal
 );
 
 /**
- * @brief RTEMS Port External to Internal
+ * @ingroup RTEMSAPIClassicDPMem
  *
- * This routine implements the rtems_port_external_to_internal directive.
- * It returns the internal port address which maps to the provided
- * external port address for the specified port ID. If the given external
- * address is an invalid dual-ported address, then the internal address is
- * set to the given external address.
+ * @brief %
  *
- * @param[in] id is the id of dp memory object
- * @param[in] external is the external address
- * @param[out] internal is the pointer of internal address to set
+ * @param name %
  *
- * @retval RTEMS_SUCCESSFUL
+ * @param id %
  */
-rtems_status_code rtems_port_external_to_internal(
-  rtems_id     id,
-  void        *external,
-  void       **internal
-);
+rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );
 
 /**
- * @brief RTEMS Port Internal to External
+ * @ingroup RTEMSAPIClassicDPMem
+ *
+ * @brief %
  *
- * This routine implements the Port_internal_to_external directive.
- * It returns the external port address which maps to the provided
- * internal port address for the specified port ID. If the given
- * internal address is an invalid dual-ported address, then the
- * external address is set to the given internal address.
+ * @param id %
  *
- * @param[in] id is the id of dual-ported memory object
- * @param[in] internal is the internal address to set
- * @param[in] external is the pointer to external address
+ * @param internal %
  *
- * @retval RTEMS_SUCCESSFUL and the external will be filled in
- * with the external addresses
+ * @param external %
  */
 rtems_status_code rtems_port_internal_to_external(
-  rtems_id     id,
-  void        *internal,
-  void       **external
+  rtems_id id,
+  void    *internal,
+  void   **external
 );
 
-/**@}*/
-
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_DPMEM_H */