Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

scsi: isci: port: Fix a bunch of kernel-doc issues

Fixes the following W=1 kernel build warning(s):

drivers/scsi/isci/port.c:130: warning: Function parameter or member 'iport' not described in 'sci_port_get_properties'
drivers/scsi/isci/port.c:130: warning: Function parameter or member 'prop' not described in 'sci_port_get_properties'
drivers/scsi/isci/port.c:130: warning: Excess function parameter 'port' description in 'sci_port_get_properties'
drivers/scsi/isci/port.c:130: warning: Excess function parameter 'properties' description in 'sci_port_get_properties'
drivers/scsi/isci/port.c:243: warning: Function parameter or member 'isci_phy' not described in 'isci_port_link_down'
drivers/scsi/isci/port.c:243: warning: Function parameter or member 'isci_port' not described in 'isci_port_link_down'
drivers/scsi/isci/port.c:243: warning: Excess function parameter 'phy' description in 'isci_port_link_down'
drivers/scsi/isci/port.c:243: warning: Excess function parameter 'port' description in 'isci_port_link_down'
drivers/scsi/isci/port.c:318: warning: Function parameter or member 'isci_port' not described in 'isci_port_hard_reset_complete'
drivers/scsi/isci/port.c:318: warning: Excess function parameter 'port' description in 'isci_port_hard_reset_complete'
drivers/scsi/isci/port.c:398: warning: Cannot understand *
drivers/scsi/isci/port.c:544: warning: Function parameter or member 'iport' not described in 'sci_port_construct_dummy_rnc'
drivers/scsi/isci/port.c:544: warning: Excess function parameter 'sci_port' description in 'sci_port_construct_dummy_rnc'
drivers/scsi/isci/port.c:692: warning: Function parameter or member 'iport' not described in 'sci_port_general_link_up_handler'
drivers/scsi/isci/port.c:692: warning: Function parameter or member 'iphy' not described in 'sci_port_general_link_up_handler'
drivers/scsi/isci/port.c:692: warning: Excess function parameter 'sci_port' description in 'sci_port_general_link_up_handler'
drivers/scsi/isci/port.c:692: warning: Excess function parameter 'sci_phy' description in 'sci_port_general_link_up_handler'
drivers/scsi/isci/port.c:719: warning: wrong kernel-doc identifier on line:
drivers/scsi/isci/port.c:756: warning: Function parameter or member 'iport' not described in 'sci_port_link_detected'
drivers/scsi/isci/port.c:756: warning: Function parameter or member 'iphy' not described in 'sci_port_link_detected'
drivers/scsi/isci/port.c:756: warning: expecting prototype for if the(). Prototype was for sci_port_link_detected() instead
drivers/scsi/isci/port.c:821: warning: wrong kernel-doc identifier on line:
drivers/scsi/isci/port.c:885: warning: Function parameter or member 'iport' not described in 'sci_port_post_dummy_request'
drivers/scsi/isci/port.c:885: warning: Excess function parameter 'sci_port' description in 'sci_port_post_dummy_request'
drivers/scsi/isci/port.c:909: warning: Function parameter or member 'iport' not described in 'sci_port_abort_dummy_request'
drivers/scsi/isci/port.c:909: warning: expecting prototype for This will alow the hardware to(). Prototype was for sci_port_abort_dummy_request() instead
drivers/scsi/isci/port.c:926: warning: Cannot understand *
drivers/scsi/isci/port.c:1017: warning: Cannot understand *
drivers/scsi/isci/port.c:1199: warning: Function parameter or member 'iport' not described in 'sci_port_add_phy'
drivers/scsi/isci/port.c:1199: warning: Function parameter or member 'iphy' not described in 'sci_port_add_phy'
drivers/scsi/isci/port.c:1199: warning: Excess function parameter 'sci_port' description in 'sci_port_add_phy'
drivers/scsi/isci/port.c:1199: warning: Excess function parameter 'sci_phy' description in 'sci_port_add_phy'
drivers/scsi/isci/port.c:1270: warning: Function parameter or member 'iport' not described in 'sci_port_remove_phy'
drivers/scsi/isci/port.c:1270: warning: Function parameter or member 'iphy' not described in 'sci_port_remove_phy'
drivers/scsi/isci/port.c:1270: warning: Excess function parameter 'sci_port' description in 'sci_port_remove_phy'
drivers/scsi/isci/port.c:1270: warning: Excess function parameter 'sci_phy' description in 'sci_port_remove_phy'

[mkp: fixed typo alow->allow]

Link: https://lore.kernel.org/r/20210317091230.2912389-29-lee.jones@linaro.org
Cc: Artur Paszkiewicz <artur.paszkiewicz@intel.com>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

authored by

Lee Jones and committed by
Martin K. Petersen
7292a8b0 a8604e44

+31 -29
+31 -29
drivers/scsi/isci/port.c
··· 115 115 /** 116 116 * sci_port_get_properties() - This method simply returns the properties 117 117 * regarding the port, such as: physical index, protocols, sas address, etc. 118 - * @port: this parameter specifies the port for which to retrieve the physical 118 + * @iport: this parameter specifies the port for which to retrieve the physical 119 119 * index. 120 - * @properties: This parameter specifies the properties structure into which to 120 + * @prop: This parameter specifies the properties structure into which to 121 121 * copy the requested information. 122 122 * 123 123 * Indicate if the user specified a valid port. SCI_SUCCESS This value is ··· 233 233 * isci_port_link_down() - This function is called by the sci core when a link 234 234 * becomes inactive. 235 235 * @isci_host: This parameter specifies the isci host object. 236 - * @phy: This parameter specifies the isci phy with the active link. 237 - * @port: This parameter specifies the isci port with the active link. 236 + * @isci_phy: This parameter specifies the isci phy with the active link. 237 + * @isci_port: This parameter specifies the isci port with the active link. 238 238 * 239 239 */ 240 240 static void isci_port_link_down(struct isci_host *isci_host, ··· 308 308 /** 309 309 * isci_port_hard_reset_complete() - This function is called by the sci core 310 310 * when the hard reset complete notification has been received. 311 - * @port: This parameter specifies the sci port with the active link. 311 + * @isci_port: This parameter specifies the sci port with the active link. 312 312 * @completion_status: This parameter specifies the core status for the reset 313 313 * process. 314 314 * ··· 395 395 } 396 396 397 397 /** 398 - * 399 - * @sci_port: This is the port object for which to determine if the phy mask 398 + * sci_port_is_phy_mask_valid() 399 + * @iport: This is the port object for which to determine if the phy mask 400 400 * can be supported. 401 + * @phy_mask: Phy mask belonging to this port 401 402 * 402 403 * This method will return a true value if the port's phy mask can be supported 403 404 * by the SCU. The following is a list of valid PHY mask configurations for ··· 534 533 /** 535 534 * sci_port_construct_dummy_rnc() - create dummy rnc for si workaround 536 535 * 537 - * @sci_port: logical port on which we need to create the remote node context 536 + * @iport: logical port on which we need to create the remote node context 538 537 * @rni: remote node index for this remote node context. 539 538 * 540 539 * This routine will construct a dummy remote node context data structure ··· 678 677 679 678 /** 680 679 * sci_port_general_link_up_handler - phy can be assigned to port? 681 - * @sci_port: sci_port object for which has a phy that has gone link up. 682 - * @sci_phy: This is the struct isci_phy object that has gone link up. 680 + * @iport: sci_port object for which has a phy that has gone link up. 681 + * @iphy: This is the struct isci_phy object that has gone link up. 683 682 * @flags: PF_RESUME, PF_NOTIFY to sci_port_activate_phy 684 683 * 685 684 * Determine if this phy can be assigned to this port . If the phy is ··· 717 716 718 717 719 718 /** 719 + * sci_port_is_wide() 720 720 * This method returns false if the port only has a single phy object assigned. 721 721 * If there are no phys or more than one phy then the method will return 722 722 * true. 723 - * @sci_port: The port for which the wide port condition is to be checked. 723 + * @iport: The port for which the wide port condition is to be checked. 724 724 * 725 725 * bool true Is returned if this is a wide ported port. false Is returned if 726 726 * this is a narrow port. ··· 741 739 } 742 740 743 741 /** 742 + * sci_port_link_detected() 744 743 * This method is called by the PHY object when the link is detected. if the 745 744 * port wants the PHY to continue on to the link up state then the port 746 745 * layer must return true. If the port object returns false the phy object 747 746 * must halt its attempt to go link up. 748 - * @sci_port: The port associated with the phy object. 749 - * @sci_phy: The phy object that is trying to go link up. 747 + * @iport: The port associated with the phy object. 748 + * @iphy: The phy object that is trying to go link up. 750 749 * 751 750 * true if the phy object can continue to the link up condition. true Is 752 751 * returned if this phy can continue to the ready state. false Is returned if ··· 820 817 821 818 /* --------------------------------------------------------------------------- */ 822 819 823 - /** 820 + /* 824 821 * This function updates the hardwares VIIT entry for this port. 825 - * 826 - * 827 822 */ 828 823 static void sci_port_update_viit_entry(struct isci_port *iport) 829 824 { ··· 875 874 876 875 /** 877 876 * sci_port_post_dummy_request() - post dummy/workaround request 878 - * @sci_port: port to post task 877 + * @iport: port to post task 879 878 * 880 879 * Prevent the hardware scheduler from posting new requests to the front 881 880 * of the scheduler queue causing a starvation problem for currently ··· 900 899 } 901 900 902 901 /** 903 - * This routine will abort the dummy request. This will alow the hardware to 902 + * sci_port_abort_dummy_request() 903 + * This routine will abort the dummy request. This will allow the hardware to 904 904 * power down parts of the silicon to save power. 905 905 * 906 - * @sci_port: The port on which the task must be aborted. 906 + * @iport: The port on which the task must be aborted. 907 907 * 908 908 */ 909 909 static void sci_port_abort_dummy_request(struct isci_port *iport) ··· 925 923 } 926 924 927 925 /** 928 - * 929 - * @sci_port: This is the struct isci_port object to resume. 926 + * sci_port_resume_port_task_scheduler() 927 + * @iport: This is the struct isci_port object to resume. 930 928 * 931 929 * This method will resume the port task scheduler for this port object. none 932 930 */ ··· 1016 1014 } 1017 1015 1018 1016 /** 1019 - * 1020 - * @object: This is the object which is cast to a struct isci_port object. 1017 + * sci_port_ready_substate_operational_exit() 1018 + * @sm: This is the object which is cast to a struct isci_port object. 1021 1019 * 1022 1020 * This method will perform the actions required by the struct isci_port on 1023 1021 * exiting the SCI_PORT_SUB_OPERATIONAL. This function reports ··· 1188 1186 } 1189 1187 1190 1188 /** 1191 - * sci_port_add_phy() - 1192 - * @sci_port: This parameter specifies the port in which the phy will be added. 1193 - * @sci_phy: This parameter is the phy which is to be added to the port. 1189 + * sci_port_add_phy() 1190 + * @iport: This parameter specifies the port in which the phy will be added. 1191 + * @iphy: This parameter is the phy which is to be added to the port. 1194 1192 * 1195 1193 * This method will add a PHY to the selected port. This method returns an 1196 1194 * enum sci_status. SCI_SUCCESS the phy has been added to the port. Any other ··· 1259 1257 } 1260 1258 1261 1259 /** 1262 - * sci_port_remove_phy() - 1263 - * @sci_port: This parameter specifies the port in which the phy will be added. 1264 - * @sci_phy: This parameter is the phy which is to be added to the port. 1260 + * sci_port_remove_phy() 1261 + * @iport: This parameter specifies the port in which the phy will be added. 1262 + * @iphy: This parameter is the phy which is to be added to the port. 1265 1263 * 1266 1264 * This method will remove the PHY from the selected PORT. This method returns 1267 1265 * an enum sci_status. SCI_SUCCESS the phy has been removed from the port. Any