scsi: mpi3mr: Fix some kernel-doc warnings in scsi_bsg_mpi3mr.h
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 24 Apr 2024 05:53:22 +0000 (22:53 -0700)
committerMartin K. Petersen <martin.petersen@oracle.com>
Thu, 25 Apr 2024 01:31:06 +0000 (21:31 -0400)
commitaca061774bc412c1415242f0d2579143dd642b46
tree3cd7002f7cb879e41f56d2caf6333c3f1a23f8f0
parentde37677ef17d2a90fe99ea8f492e5c221d5bb627
scsi: mpi3mr: Fix some kernel-doc warnings in scsi_bsg_mpi3mr.h

Correct the name of a struct in kernel-doc to match the actual function
name.

Add kernel-doc comments for 2 reserved fields to match comments for other
reserved fields.

Correct the kernel-doc comments for a nested struct to eliminate kernel-doc
warnings for them.

Warnings fixed here are:

scsi_bsg_mpi3mr.h:419: warning: expecting prototype for struct mpi3mr_bsg_buf_entry_list. Prototype was for struct mpi3mr_buf_entry_list instead

scsi_bsg_mpi3mr.h:435: warning: Function parameter or struct member 'rsvd2' not described in 'mpi3mr_bsg_mptcmd'
scsi_bsg_mpi3mr.h:456: warning: Function parameter or struct member 'rsvd3' not described in 'mpi3mr_bsg_packet'

scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'drvrcmd' description in 'mpi3mr_bsg_packet'
scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'mptcmd' description in 'mpi3mr_bsg_packet'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240424055322.1400-1-rdunlap@infradead.org
Cc: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
Cc: Martin K. Petersen <martin.petersen@oracle.com>
Cc: Sathya Prakash Veerichetty <sathya.prakash@broadcom.com>
Cc: Kashyap Desai <kashyap.desai@broadcom.com>
Cc: Sumit Saxena <sumit.saxena@broadcom.com>
Cc: Sreekanth Reddy <sreekanth.reddy@broadcom.com>
Cc: mpi3mr-linuxdrv.pdl@broadcom.com
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
include/uapi/scsi/scsi_bsg_mpi3mr.h