Generate <rtems/rtems/mp.h>

1 files changed, 59 insertions, 34 deletions

diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 0ddeaf7d53..964b7052c3 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -1,67 +1,92 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicMP
+ * @ingroup RTEMSAPIClassicMP
  *
- * This include file contains all the constants and structures associated
- * with the Multiprocessing Manager.
+ * @brief This header file defines the Multiprocessing 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.
  *
- * 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.
+ * 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 was automatically generated.  Do not edit it manually.
+ * Please have a look at
+ *
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
+ *
+ * for information how to maintain and re-generate this file.
  */
 
 #ifndef _RTEMS_RTEMS_MP_H
 #define _RTEMS_RTEMS_MP_H
 
-#include <rtems/score/mppkt.h>
+#include <rtems/score/mpci.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 /**
- *  @defgroup ClassicMP Multiprocessing
+ * @defgroup RTEMSAPIClassicMP Multiprocessing Manager
  *
- *  @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIClassic
  *
- *  This encapsulates functionality related to the distributed
- *  Multiprocessing support in the Classic API.
+ * @brief The Multiprocessing Manager provides support for heterogeneous
+ *   multiprocessing systems based on message passing in a network of
+ *   multiprocessing nodes.
  */
-/**@{*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
 
 /**
- * @brief An MPCI must support packets of at least this size.
+ * @ingroup RTEMSAPIClassicMP
+ *
+ * @brief %
+ *
+ * %
  */
-#define RTEMS_MINIMUM_PACKET_SIZE  MP_PACKET_MINIMUM_PACKET_SIZE
+void rtems_multiprocessing_announce( void );
 
 /**
- * @brief Defines the count of @c uint32_t numbers in a packet which must be
- * converted to native format in a heterogeneous system.
+ * @ingroup RTEMSAPIClassicMP
  *
- * In packets longer than this value, some of the extra data may be a user
- * message buffer which is not automatically endian swapped.
+ * @brief %
  */
-#define RTEMS_MINIMUN_HETERO_CONVERSION  MP_PACKET_MINIMUN_HETERO_CONVERSION
+#define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION
 
 /**
- *  @brief RTEMS Multiprocessing Announce
+ * @ingroup RTEMSAPIClassicMP
  *
- *  This routine implements the MULTIPROCESSING_ANNOUNCE directive.
- *  It is invoked by the MPCI layer to indicate that an MPCI packet
- *  has been received.
+ * @brief %
  */
-void rtems_multiprocessing_announce ( void );
+#define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE
 
 #ifdef __cplusplus
 }
 #endif
 
-/**@}*/
-
-#endif
-/*  end of include file */
+#endif /* _RTEMS_RTEMS_MP_H */