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
357
358
359
360
361
362
363
364
use core::ffi::CStr;
use core::fmt::Debug;
use core::slice;

#[repr(transparent)]
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct LogLevel(pub(crate) uacpi_sys::uacpi_log_level);

impl LogLevel {
    pub const DEBUG: LogLevel = LogLevel(uacpi_sys::UACPI_LOG_DEBUG);
    pub const TRACE: LogLevel = LogLevel(uacpi_sys::UACPI_LOG_TRACE);
    pub const INFO: LogLevel = LogLevel(uacpi_sys::UACPI_LOG_INFO);
    pub const WARN: LogLevel = LogLevel(uacpi_sys::UACPI_LOG_WARN);
    pub const ERROR: LogLevel = LogLevel(uacpi_sys::UACPI_LOG_ERROR);
}

#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub struct Handle(pub(crate) uacpi_sys::uacpi_handle);

impl Handle {
    /// Creates a new opaque kernel handle. Using 0 here is not allowed.
    pub fn new(handle: u64) -> Handle {
        assert_ne!(
            handle,
            0,
            "using 0 for success is not allowed, if you want an invalid handle use invalid() instead");
        Handle(handle as _)
    }

    /// Creates a new invalid kernel handle.
    pub fn invalid() -> Handle {
        Handle(0 as _)
    }

    pub fn as_u64(self) -> u64 {
        self.0 as _
    }
}

impl Debug for Handle {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{:#x}", self.as_u64())
    }
}

#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub struct PhysAddr(pub(crate) uacpi_sys::uacpi_phys_addr);

impl PhysAddr {
    pub fn new(phys_addr: u64) -> PhysAddr {
        PhysAddr(phys_addr as _)
    }

    pub fn as_u64(self) -> u64 {
        self.0
    }
}

#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone)]
pub struct ThreadId(pub(crate) uacpi_sys::uacpi_thread_id);

impl ThreadId {
    pub fn new(value: *mut core::ffi::c_void) -> Self {
        Self(value)
    }
}

#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone)]
pub struct CpuFlags(pub(crate) uacpi_sys::uacpi_cpu_flags);

impl CpuFlags {
    pub fn new(value: core::ffi::c_ulong) -> Self {
        Self(value)
    }
}

#[repr(C)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum InitLevel {
    Early = 0,
    SubsystemInitialized = 1,
    NamespaceLoaded = 2,
    NamespaceInitialized = 3,
}

impl From<uacpi_sys::uacpi_init_level> for InitLevel {
    fn from(level: uacpi_sys::uacpi_init_level) -> Self {
        match level {
            uacpi_sys::UACPI_INIT_LEVEL_EARLY => InitLevel::Early,
            uacpi_sys::UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED => InitLevel::SubsystemInitialized,
            uacpi_sys::UACPI_INIT_LEVEL_NAMESPACE_LOADED => InitLevel::NamespaceLoaded,
            uacpi_sys::UACPI_INIT_LEVEL_NAMESPACE_INITIALIZED => InitLevel::NamespaceInitialized,
            _ => panic!("Unknown uacpi_init_level value: {:#x}", level),
        }
    }
}

#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub struct IOAddr(pub(crate) uacpi_sys::uacpi_io_addr);

impl IOAddr {
    pub fn new(phys_addr: u64) -> IOAddr {
        IOAddr(phys_addr as _)
    }

    pub fn as_u64(self) -> u64 {
        self.0
    }
}

#[repr(transparent)]
#[derive(Clone, Copy)]
pub struct PCIAddress(pub(crate) uacpi_sys::uacpi_pci_address);

impl PCIAddress {
    pub fn segment(&self) -> u16 {
        self.0.segment
    }

    pub fn bus(&self) -> u8 {
        self.0.bus
    }

    pub fn device(&self) -> u8 {
        self.0.device
    }

    pub fn function(&self) -> u8 {
        self.0.function
    }
}

impl Debug for PCIAddress {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(
            f,
            "{:x}:{:x}:{:x}:{:x}",
            self.segment(),
            self.bus(),
            self.device(),
            self.function()
        )
    }
}

#[must_use]
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum Status {
    Ok = uacpi_sys::UACPI_STATUS_OK,
    MappingFailed = uacpi_sys::UACPI_STATUS_MAPPING_FAILED,
    OutOfMemory = uacpi_sys::UACPI_STATUS_OUT_OF_MEMORY,
    BadChecksum = uacpi_sys::UACPI_STATUS_BAD_CHECKSUM,
    InvalidSignature = uacpi_sys::UACPI_STATUS_INVALID_SIGNATURE,
    InvalidTableLenght = uacpi_sys::UACPI_STATUS_INVALID_TABLE_LENGTH,
    NotFound = uacpi_sys::UACPI_STATUS_NOT_FOUND,
    InvalidArgument = uacpi_sys::UACPI_STATUS_INVALID_ARGUMENT,
    Unimplemented = uacpi_sys::UACPI_STATUS_UNIMPLEMENTED,
    AlreadyExists = uacpi_sys::UACPI_STATUS_ALREADY_EXISTS,
    InternalError = uacpi_sys::UACPI_STATUS_INTERNAL_ERROR,
    TypeMismatch = uacpi_sys::UACPI_STATUS_TYPE_MISMATCH,
    InitLevelMismatch = uacpi_sys::UACPI_STATUS_INIT_LEVEL_MISMATCH,
    NamespaceNodeDangling = uacpi_sys::UACPI_STATUS_NAMESPACE_NODE_DANGLING,
    NoHandler = uacpi_sys::UACPI_STATUS_NO_HANDLER,
    NoResourceEndTag = uacpi_sys::UACPI_STATUS_NO_RESOURCE_END_TAG,
    CompiledOut = uacpi_sys::UACPI_STATUS_COMPILED_OUT,
    HardwareTimeout = uacpi_sys::UACPI_STATUS_HARDWARE_TIMEOUT,
    AmlUndefinedReference = uacpi_sys::UACPI_STATUS_AML_UNDEFINED_REFERENCE,
    AmlInvalidNamestring = uacpi_sys::UACPI_STATUS_AML_INVALID_NAMESTRING,
    AmlObjectAlreadyExists = uacpi_sys::UACPI_STATUS_AML_OBJECT_ALREADY_EXISTS,
    AmlInvalidOpcode = uacpi_sys::UACPI_STATUS_AML_INVALID_OPCODE,
    AmlIncompatibleObjectType = uacpi_sys::UACPI_STATUS_AML_INCOMPATIBLE_OBJECT_TYPE,
    AmlBadEncoding = uacpi_sys::UACPI_STATUS_AML_BAD_ENCODING,
    AmlOutOfBoundsIndex = uacpi_sys::UACPI_STATUS_AML_OUT_OF_BOUNDS_INDEX,
    AmlSyncLevelTooHigh = uacpi_sys::UACPI_STATUS_AML_SYNC_LEVEL_TOO_HIGH,
    AmlInvalidResource = uacpi_sys::UACPI_STATUS_AML_INVALID_RESOURCE,
    AmlLoopTimeout = uacpi_sys::UACPI_STATUS_AML_LOOP_TIMEOUT,
}

impl From<uacpi_sys::uacpi_status> for Status {
    fn from(status: uacpi_sys::uacpi_status) -> Self {
        match status {
            uacpi_sys::UACPI_STATUS_OK => Status::Ok,
            uacpi_sys::UACPI_STATUS_MAPPING_FAILED => Status::MappingFailed,
            uacpi_sys::UACPI_STATUS_OUT_OF_MEMORY => Status::OutOfMemory,
            uacpi_sys::UACPI_STATUS_BAD_CHECKSUM => Status::BadChecksum,
            uacpi_sys::UACPI_STATUS_INVALID_SIGNATURE => Status::InvalidSignature,
            uacpi_sys::UACPI_STATUS_INVALID_TABLE_LENGTH => Status::InvalidTableLenght,
            uacpi_sys::UACPI_STATUS_NOT_FOUND => Status::NotFound,
            uacpi_sys::UACPI_STATUS_INVALID_ARGUMENT => Status::InvalidArgument,
            uacpi_sys::UACPI_STATUS_UNIMPLEMENTED => Status::Unimplemented,
            uacpi_sys::UACPI_STATUS_ALREADY_EXISTS => Status::AlreadyExists,
            uacpi_sys::UACPI_STATUS_INTERNAL_ERROR => Status::InternalError,
            uacpi_sys::UACPI_STATUS_TYPE_MISMATCH => Status::TypeMismatch,
            uacpi_sys::UACPI_STATUS_INIT_LEVEL_MISMATCH => Status::InitLevelMismatch,
            uacpi_sys::UACPI_STATUS_NAMESPACE_NODE_DANGLING => {
                Status::NamespaceNodeDangling
            }
            uacpi_sys::UACPI_STATUS_NO_HANDLER => Status::NoHandler,
            uacpi_sys::UACPI_STATUS_NO_RESOURCE_END_TAG => Status::NoResourceEndTag,
            uacpi_sys::UACPI_STATUS_COMPILED_OUT => Status::CompiledOut,
            uacpi_sys::UACPI_STATUS_HARDWARE_TIMEOUT => Status::HardwareTimeout,
            uacpi_sys::UACPI_STATUS_AML_UNDEFINED_REFERENCE => {
                Status::AmlUndefinedReference
            }
            uacpi_sys::UACPI_STATUS_AML_INVALID_NAMESTRING => {
                Status::AmlInvalidNamestring
            }
            uacpi_sys::UACPI_STATUS_AML_OBJECT_ALREADY_EXISTS => {
                Status::AmlObjectAlreadyExists
            }
            uacpi_sys::UACPI_STATUS_AML_INVALID_OPCODE => Status::AmlInvalidOpcode,
            uacpi_sys::UACPI_STATUS_AML_INCOMPATIBLE_OBJECT_TYPE => {
                Status::AmlIncompatibleObjectType
            }
            uacpi_sys::UACPI_STATUS_AML_BAD_ENCODING => Status::AmlBadEncoding,
            uacpi_sys::UACPI_STATUS_AML_OUT_OF_BOUNDS_INDEX => {
                Status::AmlOutOfBoundsIndex
            }
            uacpi_sys::UACPI_STATUS_AML_SYNC_LEVEL_TOO_HIGH => {
                Status::AmlSyncLevelTooHigh
            }
            uacpi_sys::UACPI_STATUS_AML_INVALID_RESOURCE => Status::AmlInvalidResource,
            uacpi_sys::UACPI_STATUS_AML_LOOP_TIMEOUT => Status::AmlLoopTimeout,
            _ => panic!("Unknown uacpi_status value: {:#x}", status),
        }
    }
}

#[derive(Debug)]
pub enum FirmwareRequest {
    Breakpoint { context: Handle },
    Fatal { typ: u8, code: u32, arg: u64 },
}

impl From<uacpi_sys::uacpi_firmware_request> for FirmwareRequest {
    fn from(value: uacpi_sys::uacpi_firmware_request) -> Self {
        match value.type_ as u32 {
            uacpi_sys::UACPI_FIRMWARE_REQUEST_TYPE_BREAKPOINT => {
                FirmwareRequest::Breakpoint {
                    context: Handle(unsafe { value.__bindgen_anon_1.breakpoint.ctx }),
                }
            }
            uacpi_sys::UACPI_FIRMWARE_REQUEST_TYPE_FATAL => {
                FirmwareRequest::Fatal {
                    typ: unsafe { value.__bindgen_anon_1.fatal.type_ },
                    code: unsafe { value.__bindgen_anon_1.fatal.code },
                    arg: unsafe { value.__bindgen_anon_1.fatal.arg },
                }
            }
            _ => panic!("Unknown uacpi_firmware_request_type: {:#x}", value.type_),
        }
    }
}

#[repr(u32)]
#[derive(Debug)]
pub enum WorkType {
    GPEExecution = uacpi_sys::UACPI_WORK_GPE_EXECUTION,
    Notification = uacpi_sys::UACPI_WORK_NOTIFICATION,
}

impl From<uacpi_sys::uacpi_work_type> for WorkType {
    fn from(value: uacpi_sys::uacpi_work_type) -> Self {
        match value {
            uacpi_sys::UACPI_WORK_GPE_EXECUTION => Self::GPEExecution,
            uacpi_sys::UACPI_WORK_NOTIFICATION => Self::Notification,
            _ => panic!("Unknown uacpi_work_type: {:#x}", value),
        }
    }
}

#[repr(transparent)]
pub struct Object(pub(crate) *mut uacpi_sys::uacpi_object);

impl Object {
    fn new(t: uacpi_sys::uacpi_object_type) -> Option<Self> {
        let ptr = unsafe {
            uacpi_sys::uacpi_create_object(t)
        };
        if !ptr.is_null() {
            Some(Self(ptr))
        } else {
            None
        }
    }

    pub fn new_int(value: u64) -> Option<Self> {
        unsafe {
            let s = Self::new(
                uacpi_sys::UACPI_OBJECT_INTEGER
            )?;
            (*s.0).__bindgen_anon_1.integer = value;
            Some(s)
        }
    }

    pub fn get_int(&self) -> Option<u64> {
        unsafe {
            if (*self.0).type_ != uacpi_sys::UACPI_OBJECT_INTEGER as u8 {
                None
            } else {
                Some((*self.0).__bindgen_anon_1.integer)
            }
        }
    }

    pub fn get_buffer(&self) -> Option<&[u8]> {
        unsafe {
            if (*self.0).type_ != uacpi_sys::UACPI_OBJECT_BUFFER as u8 {
                None
            } else {
                let buffer = (*self.0).__bindgen_anon_1.buffer;
                let slice = slice::from_raw_parts(
                    (*buffer).__bindgen_anon_1.byte_data,
                    (*buffer).size
                );
                Some(slice)
            }
        }
    }

    pub fn get_string(&self) -> Option<&CStr> {
        unsafe {
            if (*self.0).type_ != uacpi_sys::UACPI_OBJECT_STRING as u8 {
                None
            } else {
                let buffer = (*self.0).__bindgen_anon_1.buffer;
                let slice = slice::from_raw_parts(
                    (*buffer).__bindgen_anon_1.byte_data,
                    (*buffer).size
                );
                Some(CStr::from_bytes_with_nul(slice).unwrap())
            }
        }
    }

    pub fn get_package(&self) -> Option<impl Iterator<Item=Self>> {
        unsafe {
            if (*self.0).type_ != uacpi_sys::UACPI_OBJECT_PACKAGE as u8 {
                None
            } else {
                let pkg = (*self.0).__bindgen_anon_1.package;
                Some(slice::from_raw_parts(
                    (*pkg).objects,
                    (*pkg).count,
                ).iter().map(|obj| Self(*obj)))
            }
        }
    }
}

impl Drop for Object {
    fn drop(&mut self) {
        unsafe {
            uacpi_sys::uacpi_object_unref(self.0);
        }
    }
}