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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
//! Suspend operations.
use pspsdk_macros::psp_stub;
use crate::sys::{
power::{PowerLockKind, PowerTick},
SceResult, SceSize,
};
#[psp_stub(libname = "sceSuspendForUser", flags = 0x4008, use_crate)]
unsafe extern "C" {
/// Locks power state of the device.
///
/// That means that device power off is delayed until the power lock is unlocked.
///
/// # Parameters
///
/// - `lock_kind`: The power processing lock kind.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// The power lock should always be unlocked ([`sceKernelPowerUnlock`]) after processing
/// whatever important thing you needed, because it blocks power off even with physical buttons.
///
/// This functions is not marked `unsafe`, because it is not memory unsafe operation.
#[nid(0xEADB1BD7)]
#[cfg(not(feature = "kernel"))]
pub safe fn sceKernelPowerLock(lock_kind: PowerLockKind) -> SceResult<()>;
/// Unlocks power state of the device.
///
/// # Parameters
///
/// - `lock_kind`: The power processing lock kind.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// Calling this function without calling [`sceKernelPowerLock`] can mess up cases of power lock
/// nesting.
///
/// This functions is not marked `unsafe`, because it is not memory unsafe operation.
#[nid(0x3AEE7261)]
#[cfg(not(feature = "kernel"))]
pub safe fn sceKernelPowerUnlock(lock_kind: PowerLockKind) -> SceResult<()>;
/// Locks and grants access to the device volatile memory (blocking).
///
/// If the volatile memory is currently being used by other processes, the process that called
/// this function will enter a wait state until the volatile stops being used.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
/// - `ptr`: A pointer to receive the head pointer of the volatile memory.
/// - `size`: A reference to receive the size of the volatile memory.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// The volatile memory is used by the PSP system for the utility library and to save eDRAM
/// during suspend/resume time and those will be blocked while this memory is being used by your
/// software. For that reason, it is best to unlock (with [`sceKernelVolatileMemUnlock`]) as
/// soon as you done with using that piece of memory.
///
/// If you need to use this memory for long periods and want to maintain such functionalities
/// working, you, theoretically, can [create] and [register] a power callback that handles
/// values of the `arg` parameter of [`CallbackFunction`] (namely [`PowerCallbackArg::Standby`]
/// and [`PowerCallbackArg::Suspending`] to unlock and [`PowerCallbackArg::ResumeComplete`] ro
/// lock again).
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
///
/// [create]: crate::sys::thread::sceKernelCreateCallback
/// [register]: crate::sys::power::scePowerRegisterCallback
/// [`CallbackFunction`]: crate::sys::thread::CallbackFunction
/// [`PowerCallbackArg::Standby`]: crate::sys::power::PowerCallbackArg::Standby
/// [`PowerCallbackArg::Suspending`]: crate::sys::power::PowerCallbackArg::Suspending
/// [`PowerCallbackArg::ResumeComplete`]: crate::sys::power::PowerCallbackArg::ResumeComplete
#[nid(0x3E0271D3)]
#[cfg(not(feature = "kernel"))]
pub unsafe fn sceKernelVolatileMemLock(
unk: u32, ptr: *mut *mut u8, size: &mut SceSize,
) -> SceResult<()>;
/// Locks and grants access to the device volatile memory (non-blocking).
///
/// If the volatile memory is currently being used by other processes, this function will return
/// a error.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
/// - `ptr`: A pointer to receive the head pointer of the volatile memory.
/// - `size`: A reference to receive the size of the volatile memory.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// Specifically [`SceError::POWER_CANNOT_LOCK_VMEM`] when volatile memory is in use by other
/// processes.
///
/// # Precautions
///
/// The volatile memory is used by the PSP system for the utility library and to save eDRAM
/// during suspend/resume time and those will be blocked while this memory is being used by your
/// software. For that reason, it is best to unlock (with [`sceKernelVolatileMemUnlock`]) as
/// soon as you done with using that piece of memory.
///
/// If you need to use this memory for long periods and want to maintain such functionalities
/// working, you, theoretically, can [create] and [register] a power callback that handles
/// values of the `arg` parameter of [`CallbackFunction`] (namely [`PowerCallbackArg::Standby`]
/// and [`PowerCallbackArg::Suspending`] to unlock and [`PowerCallbackArg::ResumeComplete`] to
/// lock again).
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
///
/// [create]: crate::sys::thread::sceKernelCreateCallback
/// [register]: crate::sys::power::scePowerRegisterCallback
/// [`CallbackFunction`]: crate::sys::thread::CallbackFunction
/// [`SceError::POWER_CANNOT_LOCK_VMEM`]: crate::sys::SceError::POWER_CANNOT_LOCK_VMEM
/// [`PowerCallbackArg::Standby`]: crate::sys::power::PowerCallbackArg::Standby
/// [`PowerCallbackArg::Suspending`]: crate::sys::power::PowerCallbackArg::Suspending
/// [`PowerCallbackArg::ResumeComplete`]: crate::sys::power::PowerCallbackArg::ResumeComplete
#[nid(0xA14F40B2)]
#[cfg(not(feature = "kernel"))]
pub unsafe fn sceKernelVolatileMemTryLock(
unk: u32, ptr: *mut *mut u8, size: &mut SceSize,
) -> SceResult<()>;
/// Unlock access to the device volatile memory.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Safety
///
/// Once unlocked, access to the volatile memory to given pointer is no longer valid.
///
/// # Precautions
///
/// This function should not be called without having a previous successful call to either
/// [`sceKernelVolatileMemLock`] or [`sceKernelVolatileMemTryLock`].
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
#[nid(0xA569E425)]
#[cfg(not(feature = "kernel"))]
pub unsafe fn sceKernelVolatileMemUnlock(unk: u32) -> SceResult<()>;
/// Configures the system to cancel the count of idle timers to prevent the system to enter in
/// power save state (entirely or partial).
///
/// # Parameters
///
/// - `tick_kind`: The configuration of what timer counts to cancel.
///
/// # Return Value
///
/// Always returns zero.
#[nid(0x090CCB3F)]
#[cfg(not(feature = "kernel"))]
pub safe fn sceKernelPowerTick(tick_kind: PowerTick) -> u32;
}
#[cfg(feature = "kernel")]
#[psp_stub(libname = "sceSuspendForKernel", flags = 0x0009, use_crate)]
unsafe extern "C" {
/// Locks power state of the device.
///
/// That means that device power off is delayed until the power lock is unlocked.
///
/// # Parameters
///
/// - `lock_kind`: The power processing lock kind.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// The power lock should always be unlocked ([`sceKernelPowerUnlock`]) after processing
/// whatever important thing you needed, because it blocks power off even with physical buttons.
///
/// This functions is not marked `unsafe`, because it is not memory unsafe operation.
#[nid(0xEADB1BD7)]
pub safe fn sceKernelPowerLock(lock_kind: PowerLockKind) -> SceResult<()>;
/// Unlocks power state of the device.
///
/// # Parameters
///
/// - `lock_kind`: The power processing lock kind.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// Calling this function without calling [`sceKernelPowerLock`] can mess up cases of power lock
/// nesting.
///
/// This functions is not marked `unsafe`, because it is not memory unsafe operation.
#[nid(0x3AEE7261)]
pub safe fn sceKernelPowerUnlock(lock_kind: PowerLockKind) -> SceResult<()>;
/// Locks and grants access to the device volatile memory (blocking).
///
/// If the volatile memory is currently being used by other processes, the process that called
/// this function will enter a wait state until the volatile stops being used.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
/// - `ptr`: A pointer to receive the head pointer of the volatile memory.
/// - `size`: A reference to receive the size of the volatile memory.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Precautions
///
/// The volatile memory is used by the PSP system for the utility library and to save eDRAM
/// during suspend/resume time and those will be blocked while this memory is being used by your
/// software. For that reason, it is best to unlock (with [`sceKernelVolatileMemUnlock`]) as
/// soon as you done with using that piece of memory.
///
/// If you need to use this memory for long periods and want to maintain such functionalities
/// working, you, theoretically, can [create] and [register] a power callback that handles
/// values of the `arg` parameter of [`CallbackFunction`] (namely [`PowerCallbackArg::Standby`]
/// and [`PowerCallbackArg::Suspending`] to unlock and [`PowerCallbackArg::ResumeComplete`] ro
/// lock again).
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
///
/// [create]: crate::sys::thread::sceKernelCreateCallback
/// [register]: crate::sys::power::scePowerRegisterCallback
/// [`CallbackFunction`]: crate::sys::thread::CallbackFunction
/// [`PowerCallbackArg::Standby`]: crate::sys::power::PowerCallbackArg::Standby
/// [`PowerCallbackArg::Suspending`]: crate::sys::power::PowerCallbackArg::Suspending
/// [`PowerCallbackArg::ResumeComplete`]: crate::sys::power::PowerCallbackArg::ResumeComplete
#[nid(0x3E0271D3)]
pub unsafe fn sceKernelVolatileMemLock(
unk: u32, ptr: *mut *mut u8, size: &mut SceSize,
) -> SceResult<()>;
/// Locks and grants access to the device volatile memory (non-blocking).
///
/// If the volatile memory is currently being used by other processes, this function will return
/// a error.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
/// - `ptr`: A pointer to receive the head pointer of the volatile memory.
/// - `size`: A reference to receive the size of the volatile memory.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// Specifically [`SceError::POWER_CANNOT_LOCK_VMEM`] when volatile memory is in use by other
/// processes.
///
/// # Precautions
///
/// The volatile memory is used by the PSP system for the utility library and to save eDRAM
/// during suspend/resume time and those will be blocked while this memory is being used by your
/// software. For that reason, it is best to unlock (with [`sceKernelVolatileMemUnlock`]) as
/// soon as you done with using that piece of memory.
///
/// If you need to use this memory for long periods and want to maintain such functionalities
/// working, you, theoretically, can [create] and [register] a power callback that handles
/// values of the `arg` parameter of [`CallbackFunction`] (namely [`PowerCallbackArg::Standby`]
/// and [`PowerCallbackArg::Suspending`] to unlock and [`PowerCallbackArg::ResumeComplete`] to
/// lock again).
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
///
/// [create]: crate::sys::thread::sceKernelCreateCallback
/// [register]: crate::sys::power::scePowerRegisterCallback
/// [`CallbackFunction`]: crate::sys::thread::CallbackFunction
/// [`SceError::POWER_CANNOT_LOCK_VMEM`]: crate::sys::SceError::POWER_CANNOT_LOCK_VMEM
/// [`PowerCallbackArg::Standby`]: crate::sys::power::PowerCallbackArg::Standby
/// [`PowerCallbackArg::Suspending`]: crate::sys::power::PowerCallbackArg::Suspending
/// [`PowerCallbackArg::ResumeComplete`]: crate::sys::power::PowerCallbackArg::ResumeComplete
#[nid(0xA14F40B2)]
pub unsafe fn sceKernelVolatileMemTryLock(
unk: u32, ptr: *mut *mut u8, size: &mut SceSize,
) -> SceResult<()>;
/// Unlock access to the device volatile memory.
///
/// # Parameters
///
/// - `unk`: Unknown. Always zero on reversed code.
///
/// # Return Value
///
/// `Ok` value on success, error value otherwise.
///
/// # Safety
///
/// Once unlocked, access to the volatile memory to given pointer is no longer valid.
///
/// # Precautions
///
/// This function should not be called without having a previous successful call to either
/// [`sceKernelVolatileMemLock`] or [`sceKernelVolatileMemTryLock`].
///
/// # Firmware Version
///
/// This API was introduced on PSP firmware version 1.50.
#[nid(0xA569E425)]
pub unsafe fn sceKernelVolatileMemUnlock(unk: u32) -> SceResult<()>;
/// Configures the system to cancel the count of idle timers to prevent the system to enter in
/// power save state (entirely or partial).
///
/// # Parameters
///
/// - `tick_kind`: The configuration of what timer counts to cancel.
///
/// # Return Value
///
/// Always returns zero.
#[nid(0x090CCB3F)]
pub safe fn sceKernelPowerTick(tick_kind: PowerTick) -> u32;
}