2bd852307f
commit 19843452dca40e28d6d3f4793d998b681d505c7f upstream. Remove argument `params` from the `module` macro example, because the macro does not currently support module parameters since it was not sent with the initial merge. Signed-off-by: Aswin Unnikrishnan <aswinunni01@gmail.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Cc: stable@vger.kernel.org Fixes: 1fbde52bde73 ("rust: add `macros` crate") Link: https://lore.kernel.org/r/20240419215015.157258-1-aswinunni01@gmail.com [ Reworded slightly. ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
61 lines
1.8 KiB
Rust
61 lines
1.8 KiB
Rust
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
//! Crate for all kernel procedural macros.
|
|
|
|
mod helpers;
|
|
mod module;
|
|
|
|
use proc_macro::TokenStream;
|
|
|
|
/// Declares a kernel module.
|
|
///
|
|
/// The `type` argument should be a type which implements the [`Module`]
|
|
/// trait. Also accepts various forms of kernel metadata.
|
|
///
|
|
/// C header: [`include/linux/moduleparam.h`](../../../include/linux/moduleparam.h)
|
|
///
|
|
/// [`Module`]: ../kernel/trait.Module.html
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```ignore
|
|
/// use kernel::prelude::*;
|
|
///
|
|
/// module!{
|
|
/// type: MyModule,
|
|
/// name: b"my_kernel_module",
|
|
/// author: b"Rust for Linux Contributors",
|
|
/// description: b"My very own kernel module!",
|
|
/// license: b"GPL",
|
|
/// }
|
|
///
|
|
/// struct MyModule;
|
|
///
|
|
/// impl kernel::Module for MyModule {
|
|
/// fn init() -> Result<Self> {
|
|
/// // If the parameter is writeable, then the kparam lock must be
|
|
/// // taken to read the parameter:
|
|
/// {
|
|
/// let lock = THIS_MODULE.kernel_param_lock();
|
|
/// pr_info!("i32 param is: {}\n", writeable_i32.read(&lock));
|
|
/// }
|
|
/// // If the parameter is read only, it can be read without locking
|
|
/// // the kernel parameters:
|
|
/// pr_info!("i32 param is: {}\n", my_i32.read());
|
|
/// Ok(Self)
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// # Supported argument types
|
|
/// - `type`: type which implements the [`Module`] trait (required).
|
|
/// - `name`: byte array of the name of the kernel module (required).
|
|
/// - `author`: byte array of the author of the kernel module.
|
|
/// - `description`: byte array of the description of the kernel module.
|
|
/// - `license`: byte array of the license of the kernel module (required).
|
|
/// - `alias`: byte array of alias name of the kernel module.
|
|
#[proc_macro]
|
|
pub fn module(ts: TokenStream) -> TokenStream {
|
|
module::module(ts)
|
|
}
|