Commit 29faa5ce authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen
Browse files

scsi: isci: port_config: Fix a bunch of doc-rot and demote abuses 

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

 drivers/scsi/isci/port_config.c:76: warning: Cannot understand  *
 drivers/scsi/isci/port_config.c:105: warning: Cannot understand  *
 drivers/scsi/isci/port_config.c:148: warning: Cannot understand  *
 drivers/scsi/isci/port_config.c:376: warning: Cannot understand  *
 drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'ihost' not described in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'port_agent' not described in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'iport' not described in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Function parameter or member 'iphy' not described in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'scic' description in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'sci_port' description in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:607: warning: Excess function parameter 'sci_phy' description in 'sci_apc_agent_link_up'
 drivers/scsi/isci/port_config.c:623: warning: Cannot understand  *
 drivers/scsi/isci/port_config.c:701: warning: Cannot understand  *

Link: https://lore.kernel.org/r/20210317091230.2912389-26-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: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent ad276048

drivers/scsi/isci/port_config.c

+19 −18
Original line number Diff line number Diff line
@@ -73,7 +73,7 @@ enum SCIC_SDS_APC_ACTIVITY { 
 * ****************************************************************************** */



/**

 *

 * sci_sas_address_compare()

 * @address_one: A SAS Address to be compared.

 * @address_two: A SAS Address to be compared.

 *
@@ -102,9 +102,9 @@ static s32 sci_sas_address_compare( 
}



/**

 *

 * @controller: The controller object used for the port search.

 * @phy: The phy object to match.

 * sci_port_configuration_agent_find_port()

 * @ihost: The controller object used for the port search.

 * @iphy: The phy object to match.

 *

 * This routine will find a matching port for the phy.  This means that the

 * port and phy both have the same broadcast sas address and same received sas
@@ -145,8 +145,8 @@ static struct isci_port *sci_port_configuration_agent_find_port( 
}



/**

 *

 * @controller: This is the controller object that contains the port agent

 * sci_port_configuration_agent_validate_ports()

 * @ihost: This is the controller object that contains the port agent

 * @port_agent: This is the port configuration agent for the controller.

 *

 * This routine will validate the port configuration is correct for the SCU
@@ -373,15 +373,16 @@ static void sci_mpc_agent_link_up(struct isci_host *ihost, 
}



/**

 *

 * @controller: This is the controller object that receives the link down

 * sci_mpc_agent_link_down()

 * @ihost: This is the controller object that receives the link down

 *    notification.

 * @port: This is the port object associated with the phy.  If the is no

 * @port_agent: This is the port configuration agent for the controller.

 * @iport: This is the port object associated with the phy.  If the is no

 *    associated port this is an NULL.  The port is an invalid

 *    handle only if the phy was never port of this port.  This happens when

 *    the phy is not broadcasting the same SAS address as the other phys in the

 *    assigned port.

 * @phy: This is the phy object which has gone link down.

 * @iphy: This is the phy object which has gone link down.

 *

 * This function handles the manual port configuration link down notifications.

 * Since all ports and phys are associated at initialization time we just turn
@@ -590,11 +591,12 @@ static void sci_apc_agent_configure_ports(struct isci_host *ihost, 


/**

 * sci_apc_agent_link_up - handle apc link up events

 * @scic: This is the controller object that receives the link up

 * @ihost: This is the controller object that receives the link up

 *    notification.

 * @sci_port: This is the port object associated with the phy.  If the is no

 * @port_agent: This is the port configuration agent for the controller.

 * @iport: This is the port object associated with the phy.  If the is no

 *    associated port this is an NULL.

 * @sci_phy: This is the phy object which has gone link up.

 * @iphy: This is the phy object which has gone link up.

 *

 * This method handles the automatic port configuration for link up

 * notifications. Is it possible to get a link down notification from a phy
@@ -620,9 +622,10 @@ static void sci_apc_agent_link_up(struct isci_host *ihost, 
}



/**

 *

 * @controller: This is the controller object that receives the link down

 * sci_apc_agent_link_down()

 * @ihost: This is the controller object that receives the link down

 *    notification.

 * @port_agent: This is the port configuration agent for the controller.

 * @iport: This is the port object associated with the phy.  If the is no

 *    associated port this is an NULL.

 * @iphy: This is the phy object which has gone link down.
@@ -697,9 +700,7 @@ static void apc_agent_timeout(struct timer_list *t) 
 * Public port configuration agent routines

 * ****************************************************************************** */



/**

 *

 *

/*

 * This method will construct the port configuration agent for operation. This

 * call is universal for both manual port configuration and automatic port

 * configuration modes.