Generate <rtems/init.h>

1 files changed, 59 insertions, 29 deletions

diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h
index 86b1408d64..7d1e312cc3 100644
--- a/cpukit/include/rtems/init.h
+++ b/cpukit/include/rtems/init.h
@@ -1,42 +1,70 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @brief Constants and Structures Associated
- * with the Initialization Manager
+ * @ingroup RTEMSAPIClassicInit
  *
- * This include file contains all the constants and structures associated
- * with the Initialization Manager.  This manager is responsible for
- * initializing RTEMS, creating and starting all configured initialization
- * tasks, invoking the initialization routine for each user-supplied device
- * driver, and initializing the optional multiprocessor layer.
+ * @brief This header file defines the Initialization Manager API.
+ */
+
+/*
+ * Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
  *
- * This manager provides directives to:
+ * 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.
  *
- *    + initialize the RTEMS executive
- *    + shutdown the RTEMS executive
+ * 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_INIT_H
 #define _RTEMS_INIT_H
 
-#include <rtems/rtems/types.h>
-#include <rtems/config.h>
-#include <rtems/rtems/intr.h>
+#include <stdint.h>
+#include <rtems/score/basedefs.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
+ * @defgroup RTEMSAPIClassicInit Initialization and Shutdown
+ *
+ * @ingroup RTEMSAPIClassic
+ *
+ * @brief This group contains directives to initialize and shutdown the RTEMS
+ *   executive.
+ */
+
+/**
+ * @ingroup RTEMSAPIClassicInit
+ *
  * @brief Initializes the system and starts multitasking.
  *
  * Iterates through the system initialization linker set and invokes the
@@ -44,26 +72,28 @@ extern "C" {
  *
  * This directive should be called by boot_card() only.
  *
- * This directive does not return.
+ * This directive does not return to the caller.  Errors in the initialization
+ * sequence are usually fatal and lead to a system termination.
  */
-void rtems_initialize_executive(void)
-  RTEMS_NO_RETURN;
+RTEMS_NO_RETURN void rtems_initialize_executive( void );
 
 /**
- * @brief Shutdown the RTEMS environment.
+ * @ingroup RTEMSAPIClassicInit
+ *
+ * @brief Shuts down the RTEMS environment.
  *
- * This routine implements the rtems_shutdown_executive directive.  The
- * invocation of this directive results in the RTEMS environment being
+ * The invocation of this directive results in the RTEMS environment being
  * shutdown and multitasking halted.  The system is terminated with a fatal
  * source of RTEMS_FATAL_SOURCE_EXIT and the specified result code.
+ *
+ * This directive does not return to the caller.
+ *
+ * @param result is the result code.
  */
-void rtems_shutdown_executive(
-  uint32_t   result
-) RTEMS_NO_RETURN;
+RTEMS_NO_RETURN void rtems_shutdown_executive( uint32_t result );
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_INIT_H */