Add kernel-doc for scsi_add_device() since it is exported.
This allows it to be part of the SCSI driver-api docbook.
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
CC: "James E.J. Bottomley" <James.Bottomley@xxxxxxxxxxxxxxxxxxxxx>
CC: "Martin K. Petersen" <martin.petersen@xxxxxxxxxx>
---
drivers/scsi/scsi_scan.c | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
--- linux-next-20241212.orig/drivers/scsi/scsi_scan.c
+++ linux-next-20241212/drivers/scsi/scsi_scan.c
@@ -1634,6 +1634,24 @@ struct scsi_device *__scsi_add_device(st
}
EXPORT_SYMBOL(__scsi_add_device);
+/**
+ * scsi_add_device - creates a new SCSI (LU) instance
+ * @host: the &Scsi_Host instance where the device is located
+ * @channel: target channel number (rarely other than %0)
+ * @target: target id number
+ * @lun: LUN of target device
+ *
+ * Probe for a specific LUN and add it if found.
+ *
+ * Notes: This call is usually performed internally during a scsi
+ * 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 sdev_init() and sdev_configure() callbacks
+ * into the LLD.
+ *
+ * Return: %0 on success or negative error code on failure
+ */
int scsi_add_device(struct Scsi_Host *host, uint channel,
uint target, u64 lun)
{
@@ -2025,6 +2043,8 @@ static void do_scan_async(void *_data, a
/**
* scsi_scan_host - scan the given adapter
* @shost: adapter to scan
+ *
+ * Notes: Should be called after scsi_add_host()
**/
void scsi_scan_host(struct Scsi_Host *shost)
{
