Re: [PATCH v3 2/2] rust: platform: add irq accessors

[Danilo Krummrich <dakr@kernel.org>]

On Mon, Jun 02, 2025 at 11:56:28AM -0300, Daniel Almeida wrote:
> Hi Danilo,
> 
> […]
> 
> >> +
> >> +    /// Same as [`Self::irq_by_name`] but does not print an error message if an IRQ
> >> +    /// cannot be obtained.
> >> +    pub fn optional_irq_by_name(&self, name: &CStr) -> Result<u32> {
> >> +        // SAFETY: `self.as_raw` returns a valid pointer to a `struct platform_device`.
> >> +        let res = unsafe {
> >> +            bindings::platform_get_irq_byname_optional(self.as_raw(), name.as_char_ptr())
> >> +        };
> >> +
> >> +        if res < 0 {
> >> +            return Err(Error::from_errno(res));
> >> +        }
> >> +
> >> +        Ok(res as u32)
> >> +    }
> > 
> > I don't like the indirection of claiming a u32 representing the IRQ number from
> > a bus device and stuffing it into an irq::Registration.
> > 
> > It would be better we we'd make it impossible (or at least harder) for a driver
> > to pass the wrong number to irq::Registration.
> > 
> > I see two options:
> > 
> >  1) Make the platform::Device accessors themselves return an
> >     irq::Registration.
> > 
> >  2) Make the platform::Device accessors return some kind of transparent cookie,
> >     that drivers can't create themselves that can be fed into the
> >     irq::Registration.
> > 
> > My preference would be 1) if there's no major ergonomic issue with that.
> 
> Isn’t 1 way more cluttered?

I don't think so, your irq::Registration::register() function needs a reference
to the registering device anyways.

And given that, now that I think about it, it even has to be this way.

Otherwise, I could provide irq::Registration::register() an IRQ number that does
not belong to the bus device that is passed into irq::Registration::register().

So, irq::Registration::register() even needs to be unsafe, with the safety
requirement that the IRQ number must belong to the corresponding device and
should be wrapped by bus device abstractions providing the safe driver API.

> That's because the accessors would have to forward all of the arguments (i.e.:
> currently 4) to register().

It's only the additional arguments below, which you can also wrap in an
irq::Args structure to keep things cleaner. :)

+        flags: Flags,
+        name: &'static CStr,
+        handler: T,