From: Bart Van Assche <bvanassche@acm.org>
To: "Martin K . Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org, Bart Van Assche <bvanassche@acm.org>,
Damien Le Moal <dlemoal@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH 4/4] scsi: core: Update .slave_configure() references in the documentation
Date: Mon, 30 Sep 2024 13:18:50 -0700 [thread overview]
Message-ID: <20240930201937.2020129-5-bvanassche@acm.org> (raw)
In-Reply-To: <20240930201937.2020129-1-bvanassche@acm.org>
Now that .slave_configure() support has been removed, change all references to
.slave_configure() into .device_configure() in the SCSI documentation.
Cc: Damien Le Moal <dlemoal@kernel.org>
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
Documentation/scsi/scsi_mid_low_api.rst | 31 +++++++++++++------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/Documentation/scsi/scsi_mid_low_api.rst b/Documentation/scsi/scsi_mid_low_api.rst
index 3507c10164b4..12c00e91cc0f 100644
--- a/Documentation/scsi/scsi_mid_low_api.rst
+++ b/Documentation/scsi/scsi_mid_low_api.rst
@@ -150,10 +150,10 @@ scsi devices of which only the first 2 respond::
scsi_scan_host() -------+
|
device_alloc()
- slave_configure() --> scsi_change_queue_depth()
+ device_configure() --> scsi_change_queue_depth()
|
device_alloc()
- slave_configure()
+ device_configure()
|
device_alloc() ***
device_destroy() ***
@@ -163,7 +163,7 @@ scsi devices of which only the first 2 respond::
respond, a device_alloc(), device_destroy() pair is called.
If the LLD wants to adjust the default queue settings, it can invoke
-scsi_change_queue_depth() in its slave_configure() routine.
+scsi_change_queue_depth() in its device_configure() routine.
When an HBA is being removed it could be as part of an orderly shutdown
associated with the LLD module being unloaded (e.g. with the "rmmod"
@@ -203,7 +203,7 @@ An LLD can use this sequence to make the mid level aware of a SCSI device::
scsi_add_device() ------+
|
device_alloc()
- slave_configure() [--> scsi_change_queue_depth()]
+ device_configure() [--> scsi_change_queue_depth()]
In a similar fashion, an LLD may become aware that a SCSI device has been
removed (unplugged) or the connection to it has been interrupted. Some
@@ -222,7 +222,7 @@ upper layers with this sequence::
It may be useful for an LLD to keep track of struct scsi_device instances
(a pointer is passed as the parameter to device_alloc() and
-slave_configure() callbacks). Such instances are "owned" by the mid-level.
+device_configure() callbacks). Such instances are "owned" by the mid-level.
struct scsi_device instances are freed after device_destroy().
@@ -331,7 +331,7 @@ Details::
* bus scan when an HBA is added (i.e. scsi_scan_host()). So it
* should only be called if the HBA becomes aware of a new scsi
* device (lu) after scsi_scan_host() has completed. If successful
- * this call can lead to device_alloc() and slave_configure() callbacks
+ * this call can lead to device_alloc() and device_configure() callbacks
* into the LLD.
*
* Defined in: drivers/scsi/scsi_scan.c
@@ -374,7 +374,7 @@ Details::
* Might block: no
*
* Notes: Can be invoked any time on a SCSI device controlled by this
- * LLD. [Specifically during and after slave_configure() and prior to
+ * LLD. [Specifically during and after device_configure() and prior to
* device_destroy().] Can safely be invoked from interrupt code.
*
* Defined in: drivers/scsi/scsi.c [see source code for more notes]
@@ -627,14 +627,15 @@ Interface functions are supplied (defined) by LLDs and their function
pointers are placed in an instance of struct scsi_host_template which
is passed to scsi_host_alloc() [or scsi_register() / init_this_scsi_driver()].
Some are mandatory. Interface functions should be declared static. The
-accepted convention is that driver "xyz" will declare its slave_configure()
+accepted convention is that driver "xyz" will declare its device_configure()
function as::
- static int xyz_slave_configure(struct scsi_device * sdev);
+ static int xyz_device_configure(struct scsi_device * sdev,
+ struct queue_limits *lim);
and so forth for all interface functions listed below.
-A pointer to this function should be placed in the 'slave_configure' member
+A pointer to this function should be placed in the 'device_configure' member
of a "struct scsi_host_template" instance. A pointer to such an instance
should be passed to the mid level's scsi_host_alloc() [or scsi_register() /
init_this_scsi_driver()].
@@ -658,7 +659,7 @@ Summary:
- proc_info - supports /proc/scsi/{driver_name}/{host_no}
- queuecommand - queue scsi command, invoke 'done' on completion
- device_alloc - prior to any commands being sent to a new device
- - slave_configure - driver fine tuning for given device after attach
+ - device_configure - driver fine tuning for given device after attach
- device_destroy - given device is about to be shut down
@@ -975,7 +976,7 @@ Details::
* prior to its initial scan. The corresponding scsi device may not
* exist but the mid level is just about to scan for it (i.e. send
* and INQUIRY command plus ...). If a device is found then
- * slave_configure() will be called while if a device is not found
+ * device_configure() will be called while if a device is not found
* device_destroy() is called.
* For more details see the include/scsi/scsi_host.h file.
*
@@ -985,7 +986,7 @@ Details::
/**
- * slave_configure - driver fine tuning for given device just after it
+ * device_configure - driver fine tuning for given device just after it
* has been first scanned (i.e. it responded to an
* INQUIRY)
* @sdp: device that has just been attached
@@ -1004,7 +1005,7 @@ Details::
*
* Optionally defined in: LLD
**/
- int slave_configure(struct scsi_device *sdp)
+ int device_configure(struct scsi_device *sdp, struct queue_limits *lim)
/**
@@ -1024,7 +1025,7 @@ Details::
* commands will be sent for this sdp instance. [However the device
* could be re-attached in the future in which case a new instance
* of struct scsi_device would be supplied by future device_alloc()
- * and slave_configure() calls.]
+ * and device_configure() calls.]
*
* Optionally defined in: LLD
**/
prev parent reply other threads:[~2024-09-30 20:22 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-30 20:18 [PATCH 0/4] Do not use "slave" in function names Bart Van Assche
2024-09-30 20:18 ` [PATCH 1/4] scsi: Rename .slave_alloc() and .slave_destroy() Bart Van Assche
2024-09-30 20:58 ` Matthew Wilcox
2024-09-30 21:10 ` Bart Van Assche
2024-10-01 0:10 ` Damien Le Moal
2024-10-02 20:23 ` Bart Van Assche
2024-10-02 22:26 ` Damien Le Moal
2024-10-01 3:26 ` Randy Dunlap
2024-10-01 4:43 ` Randy Dunlap
2024-10-01 20:15 ` Bart Van Assche
2024-09-30 20:18 ` [PATCH 2/4] scsi: Convert SCSI drivers to .device_configure() Bart Van Assche
2024-10-01 6:11 ` Leon Romanovsky
2024-10-02 9:02 ` Geoff Levand
2024-10-02 15:19 ` Khalid Aziz
2024-09-30 20:18 ` [PATCH 3/4] scsi: core: Remove .slave_configure() Bart Van Assche
2024-09-30 20:18 ` Bart Van Assche [this message]
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=20240930201937.2020129-5-bvanassche@acm.org \
--to=bvanassche@acm.org \
--cc=corbet@lwn.net \
--cc=dlemoal@kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
--cc=rdunlap@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.