public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Greg KH <gregkh@linuxfoundation.org>
To: Danilo Krummrich <dakr@kernel.org>
Cc: rafael@kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] driver-core: improve driver binding documentation
Date: Fri, 16 Jan 2026 12:18:08 +0100	[thread overview]
Message-ID: <2026011654-activism-encroach-3580@gregkh> (raw)
In-Reply-To: <20260115215718.6405-1-dakr@kernel.org>

On Thu, Jan 15, 2026 at 10:56:57PM +0100, Danilo Krummrich wrote:
> The driver binding documentation (still) mentions that "When a driver is
> attached to a device, the device is inserted into the driver's list of
> devices.".
> 
> While it is true that the driver-core keeps track of all the devices
> that are attached to a driver, this is purely for internal purposes
> (i.e. it is an implementation detail) and has no relevance for user
> facing documentation.
> 
> In fact, it is even misleading, since it could be read as if it were
> valid for driver implementations to keep track of all the devices bound
> to it.
> 
> Instead, drivers operate on a per-device basis, with a separate
> per-device instance created when the driver is bound to a device.
> 
> Hence, remove the mention of a driver's list of devices and instead add
> some documentation of the relationship between drivers and devices.
> 
> Signed-off-by: Danilo Krummrich <dakr@kernel.org>
> ---
>  Documentation/driver-api/driver-model/binding.rst | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/driver-api/driver-model/binding.rst b/Documentation/driver-api/driver-model/binding.rst
> index 7ea1d7a41e1d..d1d311a4011f 100644
> --- a/Documentation/driver-api/driver-model/binding.rst
> +++ b/Documentation/driver-api/driver-model/binding.rst
> @@ -53,9 +53,12 @@ class's register_dev callback.
>  Driver
>  ~~~~~~
>  
> -When a driver is attached to a device, the device is inserted into the
> -driver's list of devices.
> -
> +When a driver is attached to a device, the driver's probe() function is
> +called. Within probe(), the driver initializes the device and allocates
> +and initializes per-device data structures. This per-device state is
> +associated with the device object for as long as the driver remains bound
> +to it. Conceptually, this per-device data together with the binding to
> +the device can be thought of as an instance of the driver.
>  
>  sysfs
>  ~~~~~
> -- 
> 2.52.0
> 

Wow that was written a long time ago, thanks for updating it.

Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>


  reply	other threads:[~2026-01-16 11:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-15 21:56 [PATCH] driver-core: improve driver binding documentation Danilo Krummrich
2026-01-16 11:18 ` Greg KH [this message]
2026-01-16 18:15 ` Jonathan Corbet

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=2026011654-activism-encroach-3580@gregkh \
    --to=gregkh@linuxfoundation.org \
    --cc=corbet@lwn.net \
    --cc=dakr@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rafael@kernel.org \
    /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