| Message ID | 20250304173555.2496-4-dakr@kernel.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Initial Nova Core series | expand |
On Tue, Mar 04, 2025 at 06:34:50PM +0100, Danilo Krummrich wrote: > Analogous to the `module!` macro `module_firmware!` adds additional > firmware path strings to the .modinfo section. > > In contrast to `module!`, where path strings need to be string literals, > path strings can be composed with the `firmware::ModInfoBuilder`. > > Some drivers require a lot of firmware files (such as nova-core) and > hence benefit from more flexibility composing firmware path strings. > > Signed-off-by: Danilo Krummrich <dakr@kernel.org> > --- > rust/kernel/firmware.rs | 79 +++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 79 insertions(+) > > diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs > index 6e6972d94597..5d1ac8287171 100644 > --- a/rust/kernel/firmware.rs > +++ b/rust/kernel/firmware.rs > @@ -116,6 +116,85 @@ unsafe impl Send for Firmware {} > // be used from any thread. > unsafe impl Sync for Firmware {} > > +/// Create firmware .modinfo entries. > +/// > +/// This macro is the counterpart of the C macro `MODULE_FIRMWARE()`, but instead of taking a > +/// simple string literals, which is already covered by the `firmware` field of > +/// [`crate::prelude::module!`], it allows the caller to pass a builder type (e.g. > +/// [`ModInfoBuilder`]) which can create the firmware modinfo strings in a more flexible way. > +/// > +/// Drivers should extend the [`ModInfoBuilder`] with their own driver specific builder type. > +/// > +/// The `builder` argument must be a type which implements the following function. > +/// > +/// `const fn create(module_name: &'static CStr) -> ModInfoBuilder` > +/// > +/// `create` should pass the `module_name` to the [`ModInfoBuilder`] and, with the help of > +/// it construct the corresponding firmware modinfo. > +/// > +/// Typically, such contracts would be enforced by a trait, however traits do not (yet) support > +/// const functions. > +/// > +/// # Example > +/// > +/// ``` > +/// # mod module_firmware_test { > +/// # use kernel::firmware; > +/// # use kernel::prelude::*; > +/// # > +/// # struct MyModule; > +/// # > +/// # impl kernel::Module for MyModule { > +/// # fn init(_module: &'static ThisModule) -> Result<Self> { > +/// # Ok(Self) > +/// # } > +/// # } > +/// # > +/// # > +/// struct Builder<const N: usize>; > +/// > +/// impl<const N: usize> Builder<N> { > +/// const fn create(module_name: &'static kernel::str::CStr) -> firmware::ModInfoBuilder<N> { > +/// firmware::ModInfoBuilder::new(module_name) > +/// .prepare() > +/// .push("vendor/foo.bin") > +/// .prepare() > +/// .push("vendor/bar.bin") > +/// } > +/// } > +/// > +/// module! { > +/// type: MyModule, > +/// name: "module_firmware_test", > +/// author: "Rust for Linux", > +/// description: "module_firmware! test module", > +/// license: "GPL", > +/// } > +/// > +/// kernel::module_firmware!(Builder); > +/// # } > +/// ``` > +#[macro_export] > +macro_rules! module_firmware { > + ($($builder:tt)*) => { > + > + #[cfg(not(MODULE))] > + const fn __module_name() -> &'static kernel::str::CStr { > + <LocalModule as kernel::ModuleMetadata>::NAME > + } > + > + #[cfg(MODULE)] > + const fn __module_name() -> &'static kernel::str::CStr { > + kernel::c_str!("") > + } > + > + #[link_section = ".modinfo"] > + #[used] > + static __MODULE_FIRMWARE: [u8; $($builder)*::create(__module_name()).build_length()] = > + $($builder)*::create(__module_name()).build(); > + }; > +} > + > /// Builder for firmware module info. > /// > /// [`ModInfoBuilder`] is a helper component to flexibly compose firmware paths strings for the > -- > 2.48.1 > > Acked-by: Jarkko Sakkinen <jarkko@kernel.org> BR, Jarkko
diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs index 6e6972d94597..5d1ac8287171 100644 --- a/rust/kernel/firmware.rs +++ b/rust/kernel/firmware.rs @@ -116,6 +116,85 @@ unsafe impl Send for Firmware {} // be used from any thread. unsafe impl Sync for Firmware {} +/// Create firmware .modinfo entries. +/// +/// This macro is the counterpart of the C macro `MODULE_FIRMWARE()`, but instead of taking a +/// simple string literals, which is already covered by the `firmware` field of +/// [`crate::prelude::module!`], it allows the caller to pass a builder type (e.g. +/// [`ModInfoBuilder`]) which can create the firmware modinfo strings in a more flexible way. +/// +/// Drivers should extend the [`ModInfoBuilder`] with their own driver specific builder type. +/// +/// The `builder` argument must be a type which implements the following function. +/// +/// `const fn create(module_name: &'static CStr) -> ModInfoBuilder` +/// +/// `create` should pass the `module_name` to the [`ModInfoBuilder`] and, with the help of +/// it construct the corresponding firmware modinfo. +/// +/// Typically, such contracts would be enforced by a trait, however traits do not (yet) support +/// const functions. +/// +/// # Example +/// +/// ``` +/// # mod module_firmware_test { +/// # use kernel::firmware; +/// # use kernel::prelude::*; +/// # +/// # struct MyModule; +/// # +/// # impl kernel::Module for MyModule { +/// # fn init(_module: &'static ThisModule) -> Result<Self> { +/// # Ok(Self) +/// # } +/// # } +/// # +/// # +/// struct Builder<const N: usize>; +/// +/// impl<const N: usize> Builder<N> { +/// const fn create(module_name: &'static kernel::str::CStr) -> firmware::ModInfoBuilder<N> { +/// firmware::ModInfoBuilder::new(module_name) +/// .prepare() +/// .push("vendor/foo.bin") +/// .prepare() +/// .push("vendor/bar.bin") +/// } +/// } +/// +/// module! { +/// type: MyModule, +/// name: "module_firmware_test", +/// author: "Rust for Linux", +/// description: "module_firmware! test module", +/// license: "GPL", +/// } +/// +/// kernel::module_firmware!(Builder); +/// # } +/// ``` +#[macro_export] +macro_rules! module_firmware { + ($($builder:tt)*) => { + + #[cfg(not(MODULE))] + const fn __module_name() -> &'static kernel::str::CStr { + <LocalModule as kernel::ModuleMetadata>::NAME + } + + #[cfg(MODULE)] + const fn __module_name() -> &'static kernel::str::CStr { + kernel::c_str!("") + } + + #[link_section = ".modinfo"] + #[used] + static __MODULE_FIRMWARE: [u8; $($builder)*::create(__module_name()).build_length()] = + $($builder)*::create(__module_name()).build(); + }; +} + /// Builder for firmware module info. /// /// [`ModInfoBuilder`] is a helper component to flexibly compose firmware paths strings for the
Analogous to the `module!` macro `module_firmware!` adds additional firmware path strings to the .modinfo section. In contrast to `module!`, where path strings need to be string literals, path strings can be composed with the `firmware::ModInfoBuilder`. Some drivers require a lot of firmware files (such as nova-core) and hence benefit from more flexibility composing firmware path strings. Signed-off-by: Danilo Krummrich <dakr@kernel.org> --- rust/kernel/firmware.rs | 79 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+)