Linux PCI subsystem development
 help / color / mirror / Atom feed
From: "Alexandre Courbot" <acourbot@nvidia.com>
To: "Gary Guo" <gary@garyguo.net>
Cc: "Danilo Krummrich" <dakr@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Tamir Duberstein" <tamird@kernel.org>,
	"Onur Özkan" <work@onurozkan.dev>,
	"David Airlie" <airlied@gmail.com>,
	"Simona Vetter" <simona@ffwll.ch>,
	"Bjorn Helgaas" <bhelgaas@google.com>,
	"Krzysztof Wilczyński" <kwilczynski@kernel.org>,
	driver-core@lists.linux.dev, rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org, nova-gpu@lists.linux.dev,
	dri-devel@lists.freedesktop.org, linux-pci@vger.kernel.org
Subject: Re: [PATCH v3 06/16] rust: io: register: allow explicit base type specification
Date: Thu, 27 Aug 2026 16:17:12 +0900	[thread overview]
Message-ID: <DKZJJBS1UJVH.1HXS6MF69RT6R@nvidia.com> (raw)
In-Reply-To: <20260819-typed_register-v3-6-3699a75fadf1@garyguo.net>

On Wed Aug 19, 2026 at 8:09 PM JST, Gary Guo wrote:
> Currently registers work for all untyped I/O regions, which is not ideal.
> It allows registers defined for device A to work for another device B and
> there is no safeguarding at all.
>
> All users of the `register!` macro know what type it will be operating on,
> and that type is consistent across the driver. Therefore, add a `base`
> parameter to `register!`.
>
> Currently this parameter is unused in the generated code; it will be used
> when all users of `register!` is converted to gain the parameter.
>
> Signed-off-by: Gary Guo <gary@garyguo.net>

While trying to confirm Sashiko's doctest warning I stumbled upon this warning:

    warning: field `base` is never read
      --> ../rust/macros/io/register.rs:143:5
        |
    142 | pub(crate) struct RegDef {
        |                   ------ field in this struct
    143 |     base: Option<Type>,
        |     ^^^^
        |
        = note: `#[warn(dead_code)]` (part of `#[warn(unused)]`) on by default

... and a few rustdoc ones (introduced before this patch I believe):

    warning: unresolved link to `transmutable`
      --> rust/kernel/mem.rs:83:25
      |
    83 | /// - [`Self`] must be [transmutable] from [`Self::Repr`].
      |                         ^^^^^^^^^^^^ no item named `transmutable` in scope
      |
      = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
      = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

    warning: unresolved link to `Self::Repr`
      --> rust/kernel/mem.rs:83:46
      |
    83 | /// - [`Self`] must be [transmutable] from [`Self::Repr`].
      |                                              ^^^^^^^^^^ the trait `AsReprMut` has no associated item named `Repr`

    warning: unresolved link to `Self::Repr`
      --> rust/kernel/mem.rs:84:19
      |
    84 | /// - Note that [`Self::Repr`] must be [transmutable] from `Self` as well, however that is a
      |                   ^^^^^^^^^^ the trait `AsReprMut` has no associated item named `Repr`

    warning: unresolved link to `transmutable`
      --> rust/kernel/mem.rs:84:41
      |
    84 | /// - Note that [`Self::Repr`] must be [transmutable] from `Self` as well, however that is a
      |                                         ^^^^^^^^^^^^ no item named `transmutable` in scope
      |
      = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

    warning: 4 warnings emitted

<...>
> diff --git a/rust/macros/io/register.rs b/rust/macros/io/register.rs
> index 8af12caa964b..2fb48e1be82d 100644
> --- a/rust/macros/io/register.rs
> +++ b/rust/macros/io/register.rs
> @@ -27,6 +27,7 @@
>  };
>  
>  mod kw {
> +    syn::custom_keyword!(base);
>      syn::custom_keyword!(stride);
>  }
>  
> @@ -139,16 +140,26 @@ fn parse(input: syn::parse::ParseStream<'_>) -> Result<Self> {
>  }
>  
>  pub(crate) struct RegDef {
> +    base: Option<Type>,
>      regs: Vec<Reg>,
>  }
>  
>  impl Parse for RegDef {
>      fn parse(input: syn::parse::ParseStream<'_>) -> Result<Self> {
> +        let base = if input.peek(kw::base) {

Here as well Sashiko's finding looks accurate, albeit probably not
serious. The proposed fix is cheap though.

  parent reply	other threads:[~2026-08-27  7:17 UTC|newest]

Thread overview: 57+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-19 11:09 [PATCH v3 00/16] rust: io: support register projections and remove relative registers Gary Guo
2026-08-19 11:09 ` [PATCH v3 01/16] rust: io: register: reimplement as proc macro Gary Guo
2026-08-19 11:17   ` sashiko-bot
2026-08-27  6:16   ` Alexandre Courbot
2026-08-27 14:23     ` Gary Guo
2026-08-19 11:09 ` [PATCH v3 02/16] rust: mem: add `transmute` with deferred size check Gary Guo
2026-08-19 11:16   ` sashiko-bot
2026-08-27  6:24   ` Alexandre Courbot
2026-08-27 14:26     ` Gary Guo
2026-08-19 11:09 ` [PATCH v3 03/16] rust: mem: add `AsRepr` and `AsReprMut` Gary Guo
2026-08-19 11:19   ` sashiko-bot
2026-08-26 11:25   ` Alexandre Courbot
2026-08-26 11:50     ` Gary Guo
2026-08-26 13:30       ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 04/16] rust: io: perform conversions using `AsRepr` Gary Guo
2026-08-19 11:19   ` sashiko-bot
2026-08-27  6:53   ` Alexandre Courbot
2026-08-27 14:21     ` Gary Guo
2026-08-27 14:39       ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 05/16] rust: io: support register projections Gary Guo
2026-08-19 11:16   ` sashiko-bot
2026-08-27  7:01   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 06/16] rust: io: register: allow explicit base type specification Gary Guo
2026-08-19 11:22   ` sashiko-bot
2026-08-27  7:17   ` Alexandre Courbot [this message]
2026-08-19 11:09 ` [PATCH v3 07/16] gpu: nova-core: specify base type for registers Gary Guo
2026-08-19 11:19   ` sashiko-bot
2026-08-27 11:20   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 08/16] drm/tyr: " Gary Guo
2026-08-19 11:17   ` sashiko-bot
2026-08-19 11:09 ` [PATCH v3 09/16] samples: rust: pci: " Gary Guo
2026-08-19 11:14   ` sashiko-bot
2026-08-27 11:29   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 10/16] rust: io: register: make register have a typed base Gary Guo
2026-08-19 11:18   ` sashiko-bot
2026-08-27 13:42   ` Alexandre Courbot
2026-08-27 14:32     ` Gary Guo
2026-08-28  0:01       ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 11/16] rust: io: register: support fixed offset register without bitfield Gary Guo
2026-08-19 11:17   ` sashiko-bot
2026-08-28  0:38   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 12/16] gpu: nova-core: use projection for PFALCON and PFALCON2 registers Gary Guo
2026-08-19 11:17   ` sashiko-bot
2026-08-28  1:04   ` Alexandre Courbot
2026-08-28  1:24     ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 13/16] gpu: nova-core: convert hshub0 from relative register to projection Gary Guo
2026-08-19 11:23   ` sashiko-bot
2026-08-28  1:29   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 14/16] rust: io: register: remove relative registers Gary Guo
2026-08-19 11:23   ` sashiko-bot
2026-08-28  1:33   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 15/16] rust: io: register: remove `Register` trait and cleanup macro Gary Guo
2026-08-19 11:21   ` sashiko-bot
2026-08-28  2:07   ` Alexandre Courbot
2026-08-19 11:09 ` [PATCH v3 16/16] rust: io: register: unify handling of register with/without bitfields Gary Guo
2026-08-19 11:26   ` sashiko-bot
2026-08-28  2:07   ` Alexandre Courbot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DKZJJBS1UJVH.1HXS6MF69RT6R@nvidia.com \
    --to=acourbot@nvidia.com \
    --cc=a.hindborg@kernel.org \
    --cc=airlied@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=bhelgaas@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=driver-core@lists.linux.dev \
    --cc=gary@garyguo.net \
    --cc=kwilczynski@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=nova-gpu@lists.linux.dev \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=simona@ffwll.ch \
    --cc=tamird@kernel.org \
    --cc=tmgross@umich.edu \
    --cc=work@onurozkan.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox