[PATCH v2 0/3] Documentation for Device / Driver infrastructure

Danilo Krummrich posted 3 patches 2 months, 2 weeks ago
rust/kernel/device.rs | 208 +++++++++++++++++++++++++++++++++++++-----
rust/kernel/driver.rs |  89 +++++++++++++++++-
2 files changed, 271 insertions(+), 26 deletions(-)
[PATCH v2 0/3] Documentation for Device / Driver infrastructure
Posted by Danilo Krummrich 2 months, 2 weeks ago
This patch series expands the documentation for the generic device and driver
infrastructure and provides a guideline on how to implement bus and class
specific devices as well as bus specific driver infrastructure, i.e. bus
abstractions. It also expands on the existing documentation of device context
types.

Changes in v2:
  - Remove redundant DeviceContext dereference hierarchy.
  - Separate links as suggested by Alice.
  - Add a note that the guarantee for a Device reference to have a certain
    DeviceContext comes from the specific scope the Device reference is valid
    in.
  - "structures" -> "types"

Danilo Krummrich (3):
  device: rust: expand documentation for DeviceContext
  device: rust: expand documentation for Device
  driver: rust: expand documentation for driver infrastructure

 rust/kernel/device.rs | 208 +++++++++++++++++++++++++++++++++++++-----
 rust/kernel/driver.rs |  89 +++++++++++++++++-
 2 files changed, 271 insertions(+), 26 deletions(-)


base-commit: 51a486feac0ca002bee6429f03da0a6c206d0dc5
-- 
2.50.0
Re: [PATCH v2 0/3] Documentation for Device / Driver infrastructure
Posted by Danilo Krummrich 1 month, 3 weeks ago
On Tue Jul 22, 2025 at 4:59 PM CEST, Danilo Krummrich wrote:

Applied to driver-core-linus, thanks!

> Danilo Krummrich (3):
>   device: rust: expand documentation for DeviceContext

    [ Fix two minor typos. - Danilo ]

>   device: rust: expand documentation for Device

    [ Add empty line after code blocks, "in" -> "within", remove unnecessary
      pin annotations in class device example. - Danilo ]

>   driver: rust: expand documentation for driver infrastructure