Commit 6af1d9bd authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen

scsi: isci: phy: Fix a few different kernel-doc related issues

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

 drivers/scsi/isci/phy.c:354: warning: Function parameter or member 'iphy' not described in 'phy_get_non_dummy_port'
 drivers/scsi/isci/phy.c:354: warning: expecting prototype for If the phy is(). Prototype was for phy_get_non_dummy_port() instead
 drivers/scsi/isci/phy.c:364: warning: wrong kernel-doc identifier on line:
 drivers/scsi/isci/phy.c:401: warning: wrong kernel-doc identifier on line:
 drivers/scsi/isci/phy.c:611: warning: Function parameter or member 'iphy' not described in 'sci_phy_complete_link_training'
 drivers/scsi/isci/phy.c:611: warning: Excess function parameter 'sci_phy' description in 'sci_phy_complete_link_training'
 drivers/scsi/isci/phy.c:1170: warning: Cannot understand  *
 drivers/scsi/isci/phy.c:1222: warning: Cannot understand  *
 drivers/scsi/isci/phy.c:1432: warning: Function parameter or member 'sas_phy' not described in 'isci_phy_control'
 drivers/scsi/isci/phy.c:1432: warning: Excess function parameter 'phy' description in 'isci_phy_control'

Link: https://lore.kernel.org/r/20210317091230.2912389-17-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 2efd8631
...@@ -361,11 +361,9 @@ struct isci_port *phy_get_non_dummy_port(struct isci_phy *iphy) ...@@ -361,11 +361,9 @@ struct isci_port *phy_get_non_dummy_port(struct isci_phy *iphy)
} }
/** /**
* This method will assign a port to the phy object. * sci_phy_set_port() - This method will assign a port to the phy object.
* @out]: iphy This parameter specifies the phy for which to assign a port * @out]: iphy This parameter specifies the phy for which to assign a port
* object. * object.
*
*
*/ */
void sci_phy_set_port( void sci_phy_set_port(
struct isci_phy *iphy, struct isci_phy *iphy,
...@@ -398,11 +396,11 @@ enum sci_status sci_phy_initialize(struct isci_phy *iphy, ...@@ -398,11 +396,11 @@ enum sci_status sci_phy_initialize(struct isci_phy *iphy,
} }
/** /**
* This method assigns the direct attached device ID for this phy. * sci_phy_setup_transport() - This method assigns the direct attached device ID for this phy.
* *
* @iphy The phy for which the direct attached device id is to * @iphy: The phy for which the direct attached device id is to
* be assigned. * be assigned.
* @device_id The direct attached device ID to assign to the phy. * @device_id: The direct attached device ID to assign to the phy.
* This will either be the RNi for the device or an invalid RNi if there * This will either be the RNi for the device or an invalid RNi if there
* is no current device assigned to the phy. * is no current device assigned to the phy.
*/ */
...@@ -597,7 +595,7 @@ static void sci_phy_start_sata_link_training(struct isci_phy *iphy) ...@@ -597,7 +595,7 @@ static void sci_phy_start_sata_link_training(struct isci_phy *iphy)
/** /**
* sci_phy_complete_link_training - perform processing common to * sci_phy_complete_link_training - perform processing common to
* all protocols upon completion of link training. * all protocols upon completion of link training.
* @sci_phy: This parameter specifies the phy object for which link training * @iphy: This parameter specifies the phy object for which link training
* has completed. * has completed.
* @max_link_rate: This parameter specifies the maximum link rate to be * @max_link_rate: This parameter specifies the maximum link rate to be
* associated with this phy. * associated with this phy.
...@@ -1167,8 +1165,8 @@ static void sci_phy_starting_final_substate_enter(struct sci_base_state_machine ...@@ -1167,8 +1165,8 @@ static void sci_phy_starting_final_substate_enter(struct sci_base_state_machine
} }
/** /**
* * scu_link_layer_stop_protocol_engine()
* @sci_phy: This is the struct isci_phy object to stop. * @iphy: This is the struct isci_phy object to stop.
* *
* This method will stop the struct isci_phy object. This does not reset the * This method will stop the struct isci_phy object. This does not reset the
* protocol engine it just suspends it and places it in a state where it will * protocol engine it just suspends it and places it in a state where it will
...@@ -1219,7 +1217,8 @@ static void scu_link_layer_start_oob(struct isci_phy *iphy) ...@@ -1219,7 +1217,8 @@ static void scu_link_layer_start_oob(struct isci_phy *iphy)
} }
/** /**
* * scu_link_layer_tx_hard_reset()
* @iphy: This is the struct isci_phy object to stop.
* *
* This method will transmit a hard reset request on the specified phy. The SCU * This method will transmit a hard reset request on the specified phy. The SCU
* hardware requires that we reset the OOB state machine and set the hard reset * hardware requires that we reset the OOB state machine and set the hard reset
...@@ -1420,7 +1419,7 @@ void isci_phy_init(struct isci_phy *iphy, struct isci_host *ihost, int index) ...@@ -1420,7 +1419,7 @@ void isci_phy_init(struct isci_phy *iphy, struct isci_host *ihost, int index)
/** /**
* isci_phy_control() - This function is one of the SAS Domain Template * isci_phy_control() - This function is one of the SAS Domain Template
* functions. This is a phy management function. * functions. This is a phy management function.
* @phy: This parameter specifies the sphy being controlled. * @sas_phy: This parameter specifies the sphy being controlled.
* @func: This parameter specifies the phy control function being invoked. * @func: This parameter specifies the phy control function being invoked.
* @buf: This parameter is specific to the phy function being invoked. * @buf: This parameter is specific to the phy function being invoked.
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment