[PATCH v2 00/10] Device / Driver and PCI Rust abstractions

Danilo Krummrich
2024-06-18T23:40:46Z

This patch series implements basic device / driver, PCI and devres Rust
abstractions.

This patch series is sent in the context of [1], and the corresponding patch
series [2], which contains some basic DRM Rust abstractions and a stub
implementation of the Nova GPU driver.

Nova is intended to be developed upstream, starting out with just a stub driver
to lift some initial required infrastructure upstream. A more detailed
explanation can be found in [1].

As mentioned above, a driver serving as example on how these abstractions are
used within a (DRM) driver can be found in [2].

Additionally, the device / driver bits can also be found in [3], all
abstractions required for Nova in [4] and Nova in [5].

This patch series is based on [6] (which has been merged in the driver-core tree
already), as well as two more patches:

- "rust: init: introduce Opaque::try_ffi_init" [7]
- "rust: introduce InPlaceModule" [8]

@Wedson, please let me know if you want to send the two separately or if you
want me to pick them up for this series.

Changes in v2:
==============
- statically initialize driver structures (Greg)
- move base device ID abstractions to a separate source file (Greg)
- remove `DeviceRemoval` trait in favor of using a `Devres` callback to
unregister drivers
- remove `device::Data`, we don't need this abstraction anymore now that we
`Devres` to revoke resources and registrations
- pass the module name to `Module::init` and `InPlaceModule::init` in a separate
patch
- rework of `Io` including compile time boundary checks (Miguel, Wedson)
- adjust PCI abstractions accordingly and implement a `module_pci_driver!` macro
- rework `pci::Bar` to support a const SIZE
- increase the total amount of Documentation, rephrase some safety comments and
commit messages for less ambiguity
- fix compilation issues with some documentation examples

[1] https://lore.kernel.org/dri-devel/Zfsj0_tb-0-tNrJy@cassiopeiae/T/#u
[2] https://lore.kernel.org/dri-devel/20240618233324.14217-1-dakr@redhat.com/
[3] https://github.com/Rust-for-Linux/linux/tree/staging/rust-device
[4] https://github.com/Rust-for-Linux/linux/tree/staging/dev
[5] https://gitlab.freedesktop.org/drm/nova/-/tree/nova-next
[6] https://lore.kernel.org/rust-for-linux/20240618154841.6716-1-dakr@redhat.com/
[7] https://github.com/Rust-for-Linux/linux/commit/9c49161db95f4eb4e55e62873b835fb6c1a0bb39
[8] https://github.com/Rust-for-Linux/linux/commit/e74d5d33dd2b9361e8cebae77227e3f924b50034

Danilo Krummrich (6):
rust: pass module name to `Module::init`
rust: implement generic driver registration
rust: add `io::Io` base type
rust: add devres abstraction
rust: pci: add basic PCI device / driver abstractions
rust: pci: implement I/O mappable `pci::Bar`

Wedson Almeida Filho (4):
rust: implement `IdArray`, `IdTable` and `RawDeviceId`
rust: add rcu abstraction
rust: add `Revocable` type
rust: add `dev_*` print macros.

rust/bindings/bindings_helper.h | 1 +
rust/helpers.c | 145 ++++++++++
rust/kernel/device.rs | 319 +++++++++++++++++++++-
rust/kernel/device_id.rs | 336 +++++++++++++++++++++++
rust/kernel/devres.rs | 168 ++++++++++++
rust/kernel/driver.rs | 128 +++++++++
rust/kernel/io.rs | 219 +++++++++++++++
rust/kernel/lib.rs | 22 +-
rust/kernel/net/phy.rs | 2 +-
rust/kernel/pci.rs | 467 ++++++++++++++++++++++++++++++++
rust/kernel/prelude.rs | 2 +
rust/kernel/revocable.rs | 209 ++++++++++++++
rust/kernel/sync.rs | 1 +
rust/kernel/sync/rcu.rs | 52 ++++
rust/macros/module.rs | 3 +-
samples/rust/rust_minimal.rs | 2 +-
samples/rust/rust_print.rs | 2 +-
17 files changed, 2069 insertions(+), 9 deletions(-)
create mode 100644 rust/kernel/device_id.rs
create mode 100644 rust/kernel/devres.rs
create mode 100644 rust/kernel/driver.rs
create mode 100644 rust/kernel/io.rs
create mode 100644 rust/kernel/pci.rs
create mode 100644 rust/kernel/revocable.rs
create mode 100644 rust/kernel/sync/rcu.rs

base-commit: e74d5d33dd2b9361e8cebae77227e3f924b50034
--
2.45.1