Macro module

module!() { /* proc-macro */ }

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

Examples

use kernel::prelude::*;

module!{
    type: MyModule,
    name: "my_kernel_module",
    author: "Rust for Linux Contributors",
    description: "My very own kernel module!",
    license: "GPL",
    alias: ["alternate_module_name"],
}

struct MyModule(i32);

impl kernel::Module for MyModule {
    fn init(_module: &'static ThisModule) -> Result<Self> {
        let foo: i32 = 42;
        pr_info!("I contain:  {}\n", foo);
        Ok(Self(foo))
    }
}

Firmware

The following example shows how to declare a kernel module that needs to load binary firmware files. You need to specify the file names of the firmware in the firmware field. The information is embedded in the modinfo section of the kernel module. For example, a tool to build an initramfs uses this information to put the firmware files into the initramfs image.

use kernel::prelude::*;

module!{
    type: MyDeviceDriverModule,
    name: "my_device_driver_module",
    author: "Rust for Linux Contributors",
    description: "My device driver requires firmware",
    license: "GPL",
    firmware: ["my_device_firmware1.bin", "my_device_firmware2.bin"],
}

struct MyDeviceDriverModule;

impl kernel::Module for MyDeviceDriverModule {
    fn init(_module: &'static ThisModule) -> Result<Self> {
        Ok(Self)
    }
}

Supported argument types

• type: type which implements the Module trait (required).
• name: ASCII string literal of the name of the kernel module (required).
• author: string literal of the author of the kernel module.
• description: string literal of the description of the kernel module.
• license: ASCII string literal of the license of the kernel module (required).
• alias: array of ASCII string literals of the alias names of the kernel module.
• firmware: array of ASCII string literals of the firmware files of the kernel module.