Commit 20b98768 authored by Randy Dunlap's avatar Randy Dunlap Committed by Martin K. Petersen
Browse files

scsi: scsi_error: Add kernel-doc for exported functions 



Convert scsi_report_bus_reset() and scsi_report_device_reset() to
kernel-doc since they are exported. This allows them to be part of the
driver-api/scsi.rst docbook.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20241212205217.597844-2-rdunlap@infradead.org


CC: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
CC: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 29081c21

drivers/scsi/scsi_error.c

+13 −13
Original line number Diff line number Diff line
@@ -2363,14 +2363,14 @@ int scsi_error_handler(void *data) 
	return 0;

}



/*

 * Function:    scsi_report_bus_reset()

/**

 * scsi_report_bus_reset() - report bus reset observed

 *

 * Purpose:     Utility function used by low-level drivers to report that

 * Utility function used by low-level drivers to report that

 * they have observed a bus reset on the bus being handled.

 *

 * Arguments:   shost       - Host in question

 *		channel     - channel on which reset was observed.

 * @shost:      Host in question

 * @channel:    channel on which reset was observed.

 *

 * Returns:     Nothing

 *
@@ -2395,15 +2395,15 @@ void scsi_report_bus_reset(struct Scsi_Host *shost, int channel) 
}

EXPORT_SYMBOL(scsi_report_bus_reset);



/*

 * Function:    scsi_report_device_reset()

/**

 * scsi_report_device_reset() - report device reset observed

 *

 * Purpose:     Utility function used by low-level drivers to report that

 * Utility function used by low-level drivers to report that

 * they have observed a device reset on the device being handled.

 *

 * Arguments:   shost       - Host in question

 *		channel     - channel on which reset was observed

 *		target	    - target on which reset was observed

 * @shost:      Host in question

 * @channel:    channel on which reset was observed

 * @target:     target on which reset was observed

 *

 * Returns:     Nothing

 *