rtems/score/onceimpl.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreOnce
0007  *
0008  * @brief This header file provides the interfaces of the
0009  *   @ref RTEMSScoreOnce.
0010  */
0011
0012 /*
0013  * Copyright (C) 2014, 2019 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_ONCE_H
0038 #define _RTEMS_ONCE_H
0039
0040 #include <rtems/score/thread.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif /* __cplusplus */
0045
0046 /**
0047  * @defgroup RTEMSScoreOnce Execute Once Support
0048  *
0049  * @ingroup RTEMSScore
0050  *
0051  * @brief This group contains the implementation to execute a routine only
0052  *   once.
0053  *
0054  * @{
0055  */
0056
0057 /**
0058  * @brief Reacts according to the state of once_state.
0059  *
0060  * If once_state is ONCE_STATE_INIT, then the once state is set first to
0061  * ONCE_STATE_RUNNING and after calling the init routine it is set to
0062  * ONCE_STATE_COMPLETED. If once_state is ONCE_STATE_COMPLETED, nothing
0063  * happens. If once_state is not either one, this method waits for the
0064  * Once_Information_Mutex.
0065  *
0066  * @param once_state The once state.
0067  * @param init_routine The initialization routine called if @a once_state is ONCE_STATE_INIT.
0068  *
0069  * @return This method always returns zero upon termination.
0070  */
0071 int _Once( unsigned char *once_state, void ( *init_routine )( void ) );
0072
0073 /** @} */
0074
0075 #ifdef __cplusplus
0076 }
0077 #endif /* __cplusplus */
0078
0079 #endif /* _RTEMS_ONCE_H */