blob: fcd831ad2baa4d090a7ff4ae5d42be15c3713ecc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/**
* @file
*
* @ingroup RTEMSScoreOnce
*
* @brief This header file provides the interfaces of the
* @ref RTEMSScoreOnce.
*/
/*
* Copyright (c) 2014, 2019 embedded brains GmbH. All rights reserved.
*
* embedded brains GmbH
* Dornierstr. 4
* 82178 Puchheim
* Germany
* <rtems@embedded-brains.de>
*
* 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.
*/
#ifndef _RTEMS_ONCE_H
#define _RTEMS_ONCE_H
#include <rtems/score/thread.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup RTEMSScoreOnce Execute Once Support
*
* @ingroup RTEMSScore
*
* @brief This group contains the implementation to execute a routine only
* once.
*
* @{
*/
/**
* @brief Reacts according to the state of once_state.
*
* If once_state is ONCE_STATE_INIT, then the once state is set first to
* ONCE_STATE_RUNNING and after calling the init routine it is set to
* ONCE_STATE_COMPLETED. If once_state is ONCE_STATE_COMPLETED, nothing
* happens. If once_state is not either one, this method waits for the
* Once_Information_Mutex.
*
* @param once_state The once state.
* @param init_routine The initialization routine called if @a once_state is ONCE_STATE_INIT.
*
* @return This method always returns zero upon termination.
*/
int _Once( unsigned char *once_state, void ( *init_routine )( void ) );
/**
* @brief Locks the Once_Information_Mutex and returns the thread life state.
*
* @return The thread life state (THREAD_LIFE_PROTECTED).
*/
Thread_Life_state _Once_Lock( void );
/**
* @brief Unlocks the Once_Information_Mutex and sets the thread life
* protection to thread_life_state.
*
* @param thread_life_state The thread life state to set the thread life
* protection to.
*/
void _Once_Unlock( Thread_Life_state thread_life_state );
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _RTEMS_ONCE_H */
|
