kernel/
of.rs

1// SPDX-License-Identifier: GPL-2.0
2
3//! Device Tree / Open Firmware abstractions.
4
5use crate::{
6    bindings,
7    device_id::{RawDeviceId, RawDeviceIdIndex},
8    prelude::*,
9};
10
11/// IdTable type for OF drivers.
12pub type IdTable<T> = &'static dyn kernel::device_id::IdTable<DeviceId, T>;
13
14/// An open firmware device id.
15#[repr(transparent)]
16#[derive(Clone, Copy)]
17pub struct DeviceId(bindings::of_device_id);
18
19// SAFETY: `DeviceId` is a `#[repr(transparent)]` wrapper of `struct of_device_id` and
20// does not add additional invariants, so it's safe to transmute to `RawType`.
21unsafe impl RawDeviceId for DeviceId {
22    type RawType = bindings::of_device_id;
23}
24
25// SAFETY: `DRIVER_DATA_OFFSET` is the offset to the `data` field.
26unsafe impl RawDeviceIdIndex for DeviceId {
27    const DRIVER_DATA_OFFSET: usize = core::mem::offset_of!(bindings::of_device_id, data);
28
29    fn index(&self) -> usize {
30        self.0.data as usize
31    }
32}
33
34impl DeviceId {
35    /// Create a new device id from an OF 'compatible' string.
36    pub const fn new(compatible: &'static CStr) -> Self {
37        let src = compatible.as_bytes_with_nul();
38        // Replace with `bindings::of_device_id::default()` once stabilized for `const`.
39        // SAFETY: FFI type is valid to be zero-initialized.
40        let mut of: bindings::of_device_id = unsafe { core::mem::zeroed() };
41
42        // TODO: Use `copy_from_slice` once stabilized for `const`.
43        let mut i = 0;
44        while i < src.len() {
45            of.compatible[i] = src[i];
46            i += 1;
47        }
48
49        Self(of)
50    }
51}
52
53/// Create an OF `IdTable` with an "alias" for modpost.
54#[macro_export]
55macro_rules! of_device_table {
56    ($table_name:ident, $module_table_name:ident, $id_info_type: ty, $table_data: expr) => {
57        const $table_name: $crate::device_id::IdArray<
58            $crate::of::DeviceId,
59            $id_info_type,
60            { $table_data.len() },
61        > = $crate::device_id::IdArray::new($table_data);
62
63        $crate::module_device_table!("of", $module_table_name, $table_name);
64    };
65}
kernel/of.rs

kernel/
of.rs
