From 0dd3a0e10f8b0ef7bfa4146cc4c3ac50f50357db Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 28 May 2020 13:47:28 +0200 Subject: rtems: Generate Change license to BSD-2-Clause according to file histories and documentation re-licensing agreement. Update #3899. Update #3993. --- cpukit/include/rtems/init.h | 101 +++++++++++++++++++++++++++++++++----------- 1 file changed, 76 insertions(+), 25 deletions(-) diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h index 552017f0de..b48197be55 100644 --- a/cpukit/include/rtems/init.h +++ b/cpukit/include/rtems/init.h @@ -1,60 +1,112 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * - * @brief Constants and Structures Associated - * with the Initialization Manager - * - * 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 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://www.rtems.org/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 the How-To + * section in the Software Requirements Engineering chapter of the + * RTEMS Software Engineering manual. The manual is provided as a part of + * a release. For development sources please refer to the online + * documentation at: + * + * https://docs.rtems.org */ +/* Generated from spec:/rtems/init/if/header */ + #ifndef _RTEMS_INIT_H #define _RTEMS_INIT_H -#include -#include -#include +#include +#include #ifdef __cplusplus extern "C" { #endif +/* Generated from spec:/rtems/init/if/group */ + /** + * @defgroup RTEMSAPIClassicInit Initialization and Shutdown + * + * @ingroup RTEMSAPIClassic + * + * @brief This group contains directives to initialize and shutdown the RTEMS + * executive. + */ + +/* Generated from spec:/rtems/init/if/initialize-executive */ + +/** + * @ingroup RTEMSAPIClassicInit + * * @brief Initializes the system and starts multitasking. * * Iterates through the system initialization linker set and invokes the * registered handlers. The final step is to start multitasking. * + * @par Notes + * @parblock * 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. + * @endparblock */ RTEMS_NO_RETURN void rtems_initialize_executive( void ); +/* Generated from spec:/rtems/init/if/shutdown-executive */ + /** - * @brief Shutdown the RTEMS environment. + * @ingroup RTEMSAPIClassicInit + * + * @brief Shuts down the RTEMS environment. + * + * @param result is the result code. * - * 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. + * + * @par Notes + * This directive does not return to the caller. */ RTEMS_NO_RETURN void rtems_shutdown_executive( uint32_t result ); @@ -62,5 +114,4 @@ RTEMS_NO_RETURN void rtems_shutdown_executive( uint32_t result ); } #endif -#endif -/* end of include file */ +#endif /* _RTEMS_INIT_H */ -- cgit v1.2.3