wut  v1.5.0
Wii U Toolchain
alarm.h
Go to the documentation of this file.
1 #pragma once
2 #include <wut.h>
3 #include "threadqueue.h"
4 #include "time.h"
5 #include "context.h"
6 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 typedef struct OSAlarm OSAlarm;
25 typedef struct OSAlarmLink OSAlarmLink;
26 typedef struct OSAlarmQueue OSAlarmQueue;
27 
28 typedef void (*OSAlarmCallback)(OSAlarm *, OSContext *);
29 
30 #define OS_ALARM_QUEUE_TAG 0x614C6D51u
31 
32 struct OSAlarmQueue
33 {
35  uint32_t tag;
36 
38  const char *name;
39  WUT_UNKNOWN_BYTES(4);
40 
41  OSThreadQueue threadQueue;
42  OSAlarm *head;
43  OSAlarm *tail;
44 };
45 WUT_CHECK_OFFSET(OSAlarmQueue, 0x00, tag);
46 WUT_CHECK_OFFSET(OSAlarmQueue, 0x04, name);
47 WUT_CHECK_OFFSET(OSAlarmQueue, 0x0c, threadQueue);
48 WUT_CHECK_OFFSET(OSAlarmQueue, 0x1c, head);
49 WUT_CHECK_OFFSET(OSAlarmQueue, 0x20, tail);
50 WUT_CHECK_SIZE(OSAlarmQueue, 0x24);
51 
52 struct OSAlarmLink
53 {
54  OSAlarm *prev;
55  OSAlarm *next;
56 };
57 WUT_CHECK_OFFSET(OSAlarmLink, 0x00, prev);
58 WUT_CHECK_OFFSET(OSAlarmLink, 0x04, next);
59 WUT_CHECK_SIZE(OSAlarmLink, 0x08);
60 
61 #define OS_ALARM_TAG 0x614C724Du
62 struct OSAlarm
63 {
65  uint32_t tag;
66 
68  const char *name;
69 
70  WUT_UNKNOWN_BYTES(4);
71 
73  OSAlarmCallback callback;
74 
76  uint32_t group;
77 
78  WUT_UNKNOWN_BYTES(4);
79 
81  OSTime nextFire;
82 
84  OSAlarmLink link;
85 
87  OSTime period;
88 
90  OSTime start;
91 
93  void *userData;
94 
96  uint32_t state;
97 
99  OSThreadQueue threadQueue;
100 
102  OSAlarmQueue *alarmQueue;
103 
105  OSContext *context;
106 };
107 WUT_CHECK_OFFSET(OSAlarm, 0x00, tag);
108 WUT_CHECK_OFFSET(OSAlarm, 0x04, name);
109 WUT_CHECK_OFFSET(OSAlarm, 0x0c, callback);
110 WUT_CHECK_OFFSET(OSAlarm, 0x10, group);
111 WUT_CHECK_OFFSET(OSAlarm, 0x18, nextFire);
112 WUT_CHECK_OFFSET(OSAlarm, 0x20, link);
113 WUT_CHECK_OFFSET(OSAlarm, 0x28, period);
114 WUT_CHECK_OFFSET(OSAlarm, 0x30, start);
115 WUT_CHECK_OFFSET(OSAlarm, 0x38, userData);
116 WUT_CHECK_OFFSET(OSAlarm, 0x3c, state);
117 WUT_CHECK_OFFSET(OSAlarm, 0x40, threadQueue);
118 WUT_CHECK_OFFSET(OSAlarm, 0x50, alarmQueue);
119 WUT_CHECK_OFFSET(OSAlarm, 0x54, context);
120 WUT_CHECK_SIZE(OSAlarm, 0x58);
121 
122 
126 BOOL
127 OSCancelAlarm(OSAlarm *alarm);
128 
129 
135 void
136 OSCancelAlarms(uint32_t group);
137 
138 
142 void
143 OSCreateAlarm(OSAlarm *alarm);
144 
145 
149 void
150 OSCreateAlarmEx(OSAlarm *alarm,
151  const char *name);
152 
153 
157 void *
158 OSGetAlarmUserData(OSAlarm *alarm);
159 
160 
164 void
165 OSInitAlarmQueue(OSAlarmQueue *queue);
166 
167 
171 void
172 OSInitAlarmQueueEx(OSAlarmQueue *queue,
173  const char *name);
174 
175 
183 BOOL
184 OSSetAlarm(OSAlarm *alarm,
185  OSTime time,
186  OSAlarmCallback callback);
187 
188 
197 BOOL
198 OSSetPeriodicAlarm(OSAlarm *alarm,
199  OSTime start,
200  OSTime interval,
201  OSAlarmCallback callback);
202 
203 
207 void
208 OSSetAlarmTag(OSAlarm *alarm,
209  uint32_t group);
210 
211 
215 void
216 OSSetAlarmUserData(OSAlarm *alarm,
217  void *data);
218 
219 
223 BOOL
224 OSWaitAlarm(OSAlarm *alarm);
225 
226 #ifdef __cplusplus
227 }
228 #endif
229 
OSAlarm::group
uint32_t group
Used with OSCancelAlarms for bulk cancellation of alarms.
Definition: alarm.h:76
OSAlarm::nextFire
OSTime nextFire
The time when the alarm will next be triggered.
Definition: alarm.h:78
OSAlarm::state
uint32_t state
The current state of the alarm, internal values.
Definition: alarm.h:96
OSAlarmQueue::tag
uint32_t tag
Should always be set to the value OS_ALARM_QUEUE_TAG.
Definition: alarm.h:35
OSAlarm::start
OSTime start
The time the alarm was started.
Definition: alarm.h:90
OSAlarmQueue::tail
OSAlarm * tail
Definition: alarm.h:43
OSAlarm::userData
void * userData
User data set with OSSetAlarmUserData and retrieved with OSGetAlarmUserData.
Definition: alarm.h:93
OSAlarm::link
OSAlarmLink link
Link used for when this OSAlarm object is inside an OSAlarmQueue.
Definition: alarm.h:84
OSAlarmLink::next
OSAlarm * next
Definition: alarm.h:55
OSAlarmQueue::threadQueue
OSThreadQueue threadQueue
Definition: alarm.h:39
OSAlarm::period
OSTime period
The period between alarm triggers, this is only set for periodic alarms.
Definition: alarm.h:87
OSAlarm::context
OSContext * context
The context the alarm was triggered on.
Definition: alarm.h:105
OSAlarm::callback
OSAlarmCallback callback
The callback to execute once the alarm is triggered.
Definition: alarm.h:70
OSAlarmQueue::head
OSAlarm * head
Definition: alarm.h:42
OSAlarmLink::prev
OSAlarm * prev
Definition: alarm.h:54
OSAlarmQueue::name
const char * name
Name set by OSInitAlarmQueueEx.
Definition: alarm.h:38
OSAlarm::alarmQueue
OSAlarmQueue * alarmQueue
The queue that this alarm is currently in.
Definition: alarm.h:102
OSSetPeriodicAlarm
BOOL OSSetPeriodicAlarm(OSAlarm *alarm, OSTime start, OSTime interval, OSAlarmCallback callback)
Set a repeated alarm to execute a callback every interval from start.
OSInitAlarmQueueEx
void OSInitAlarmQueueEx(OSAlarmQueue *queue, const char *name)
Initialise an alarm queue structure with a name.
OSCreateAlarmEx
void OSCreateAlarmEx(OSAlarm *alarm, const char *name)
Initialise an alarm structure with a name.
OSSetAlarmTag
void OSSetAlarmTag(OSAlarm *alarm, uint32_t group)
Set an alarm tag which is used in OSCancelAlarms for bulk cancellation.
OSSetAlarm
BOOL OSSetAlarm(OSAlarm *alarm, OSTime time, OSAlarmCallback callback)
Set a one shot alarm to perform a callback after a set amount of time.
OSCancelAlarms
void OSCancelAlarms(uint32_t group)
Cancel all alarms which have a matching tag set by OSSetAlarmTag.
OSCreateAlarm
void OSCreateAlarm(OSAlarm *alarm)
Initialise an alarm structure.
OSGetAlarmUserData
void * OSGetAlarmUserData(OSAlarm *alarm)
Return user data set by OSSetAlarmUserData.
OSSetAlarmUserData
void OSSetAlarmUserData(OSAlarm *alarm, void *data)
Set alarm user data which is returned by OSGetAlarmUserData.
OSInitAlarmQueue
void OSInitAlarmQueue(OSAlarmQueue *queue)
Initialise an alarm queue structure.
OSWaitAlarm
BOOL OSWaitAlarm(OSAlarm *alarm)
Sleep the current thread until the alarm has been triggered or cancelled.
OSAlarmCallback
void(* OSAlarmCallback)(OSAlarm *, OSContext *)
Definition: alarm.h:28
OSCancelAlarm
BOOL OSCancelAlarm(OSAlarm *alarm)
Cancel an alarm.
OSAlarm
Definition: alarm.h:63
OSAlarmLink
Definition: alarm.h:53
OSAlarmQueue
Definition: alarm.h:33
OSContext
Definition: context.h:28
OSThreadQueue
Definition: threadqueue.h:30
OSTime
int64_t OSTime
Definition: time.h:18
BOOL
int32_t BOOL
Definition: wut_types.h:7
Generated by doxygen 1.9.1