1 | /* SPDX-License-Identifier: BSD-2-Clause */ |
---|
2 | |
---|
3 | /** |
---|
4 | * @file |
---|
5 | * |
---|
6 | * @brief POSIX Timers Internal Support |
---|
7 | * |
---|
8 | * This include files defines the internal support for implementation of |
---|
9 | * POSIX Timers. |
---|
10 | */ |
---|
11 | |
---|
12 | /* |
---|
13 | * COPYRIGHT (c) 1989-2011. |
---|
14 | * On-Line Applications Research Corporation (OAR). |
---|
15 | * |
---|
16 | * Redistribution and use in source and binary forms, with or without |
---|
17 | * modification, are permitted provided that the following conditions |
---|
18 | * are met: |
---|
19 | * 1. Redistributions of source code must retain the above copyright |
---|
20 | * notice, this list of conditions and the following disclaimer. |
---|
21 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
22 | * notice, this list of conditions and the following disclaimer in the |
---|
23 | * documentation and/or other materials provided with the distribution. |
---|
24 | * |
---|
25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
28 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
29 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
30 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
31 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
32 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
33 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
34 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
35 | * POSSIBILITY OF SUCH DAMAGE. |
---|
36 | */ |
---|
37 | |
---|
38 | #ifndef _RTEMS_POSIX_TIMER_H |
---|
39 | #define _RTEMS_POSIX_TIMER_H |
---|
40 | |
---|
41 | #include <rtems/score/objectdata.h> |
---|
42 | #include <rtems/score/watchdog.h> |
---|
43 | |
---|
44 | #include <pthread.h> |
---|
45 | |
---|
46 | #ifdef __cplusplus |
---|
47 | extern "C" { |
---|
48 | #endif |
---|
49 | |
---|
50 | /** |
---|
51 | * @defgroup POSIX_INTERNAL_TIMERS POSIX Timer Private Support |
---|
52 | * |
---|
53 | * @ingroup POSIXAPI |
---|
54 | */ |
---|
55 | /**@{*/ |
---|
56 | |
---|
57 | /* |
---|
58 | * Data for a timer |
---|
59 | */ |
---|
60 | typedef struct { |
---|
61 | Objects_Control Object; |
---|
62 | Watchdog_Control Timer; /* Internal Timer */ |
---|
63 | pthread_t thread_id; /* Thread identifier */ |
---|
64 | char state; /* State of the timer */ |
---|
65 | struct sigevent inf; /* Information associated to the timer */ |
---|
66 | struct itimerspec timer_data; /* Timing data of the timer */ |
---|
67 | uint32_t ticks; /* Number of ticks of the initialization */ |
---|
68 | uint32_t overrun; /* Number of expirations of the timer */ |
---|
69 | struct timespec time; /* Time at which the timer was started */ |
---|
70 | clockid_t clock_type; /* The type of timer */ |
---|
71 | } POSIX_Timer_Control; |
---|
72 | |
---|
73 | /** |
---|
74 | * @brief The POSIX Timer objects information. |
---|
75 | */ |
---|
76 | extern Objects_Information _POSIX_Timer_Information; |
---|
77 | |
---|
78 | /** |
---|
79 | * @brief Macro to define the objects information for the POSIX Timer objects. |
---|
80 | * |
---|
81 | * This macro should only be used by <rtems/confdefs.h>. |
---|
82 | * |
---|
83 | * @param max The configured object maximum (the OBJECTS_UNLIMITED_OBJECTS flag |
---|
84 | * may be set). |
---|
85 | */ |
---|
86 | #define POSIX_TIMER_INFORMATION_DEFINE( max ) \ |
---|
87 | OBJECTS_INFORMATION_DEFINE( \ |
---|
88 | _POSIX_Timer, \ |
---|
89 | OBJECTS_POSIX_API, \ |
---|
90 | OBJECTS_POSIX_TIMERS, \ |
---|
91 | POSIX_Timer_Control, \ |
---|
92 | max, \ |
---|
93 | OBJECTS_NO_STRING_NAME, \ |
---|
94 | NULL \ |
---|
95 | ) |
---|
96 | |
---|
97 | /** |
---|
98 | * @brief Follow POSIX or FACE Technical Standard on timer_create |
---|
99 | * |
---|
100 | * POSIX allows for the creation of timers based on CLOCK_REALTIME. |
---|
101 | * This is viewed as a safety issue by the FACE Technical Standard |
---|
102 | * and required to return an error. These are conflicting behaviors. |
---|
103 | * This method is instanced by configuration when FACE conformant |
---|
104 | * behavior is desired by the application. |
---|
105 | * |
---|
106 | * @param[in] clock_id is the clock ID to validate |
---|
107 | * |
---|
108 | * @return 0 if @a clock_id is allowed for use. Otherwise an errno value. |
---|
109 | */ |
---|
110 | int _POSIX_Timer_Is_allowed( |
---|
111 | clockid_t clock_id |
---|
112 | ); |
---|
113 | |
---|
114 | |
---|
115 | /** @} */ |
---|
116 | |
---|
117 | #ifdef __cplusplus |
---|
118 | } |
---|
119 | #endif |
---|
120 | |
---|
121 | #endif |
---|
122 | /* end of include file */ |
---|