Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 121246ae authored by Bart Van Assche's avatar Bart Van Assche Committed by Martin K. Petersen
Browse files

scsi: libsas: Fix kernel-doc headers 



Avoid that building with W=1 causes the kernel-doc tool to complain
about function arguments that have not been documented in the libsas
kernel-doc headers. Avoid that the short description starts with a
hyphen by changing "--" into "-" in the first line of the kernel-doc
headers.

Signed-off-by: default avatarBart Van Assche <bart.vanassche@wdc.com>
Cc: John Garry <john.garry@huawei.com>
Reviewed-by: default avatarJohn Garry <john.garry@huawei.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent cf8037f8

drivers/scsi/libsas/sas_ata.c

+1 −1
Original line number Diff line number Diff line
@@ -709,7 +709,7 @@ void sas_resume_sata(struct asd_sas_port *port) 
}



/**

 * sas_discover_sata -- discover an STP/SATA domain device

 * sas_discover_sata - discover an STP/SATA domain device

 * @dev: pointer to struct domain_device of interest

 *

 * Devices directly attached to a HA port, have no parents.  All other

drivers/scsi/libsas/sas_discover.c

+7 −6
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ void sas_init_dev(struct domain_device *dev) 
/* ---------- Domain device discovery ---------- */



/**

 * sas_get_port_device -- Discover devices which caused port creation

 * sas_get_port_device - Discover devices which caused port creation

 * @port: pointer to struct sas_port of interest

 *

 * Devices directly attached to a HA port, have no parent.  This is
@@ -278,8 +278,8 @@ static void sas_resume_devices(struct work_struct *work) 
}



/**

 * sas_discover_end_dev -- discover an end device (SSP, etc)

 * @end: pointer to domain device of interest

 * sas_discover_end_dev - discover an end device (SSP, etc)

 * @dev: pointer to domain device of interest

 *

 * See comment in sas_discover_sata().

 */
@@ -428,8 +428,8 @@ void sas_device_set_phy(struct domain_device *dev, struct sas_port *port) 
/* ---------- Discovery and Revalidation ---------- */



/**

 * sas_discover_domain -- discover the domain

 * @port: port to the domain of interest

 * sas_discover_domain - discover the domain

 * @work: work structure embedded in port domain device.

 *

 * NOTE: this process _must_ quit (return) as soon as any connection

 * errors are encountered.  Connection recovery is done elsewhere.
@@ -572,7 +572,8 @@ int sas_discover_event(struct asd_sas_port *port, enum discover_event ev) 
}



/**

 * sas_init_disc -- initialize the discovery struct in the port

 * sas_init_disc - initialize the discovery struct in the port

 * @disc: port discovery structure

 * @port: pointer to struct port

 *

 * Called when the ports are being initialized.

drivers/scsi/libsas/sas_expander.c

+15 −14
Original line number Diff line number Diff line
@@ -1170,9 +1170,9 @@ static int sas_check_level_subtractive_boundary(struct domain_device *dev) 
	return 0;

}

/**

 * sas_ex_discover_devices -- discover devices attached to this expander

 * dev: pointer to the expander domain device

 * single: if you want to do a single phy, else set to -1;

 * sas_ex_discover_devices - discover devices attached to this expander

 * @dev: pointer to the expander domain device

 * @single: if you want to do a single phy, else set to -1;

 *

 * Configure this expander for use with its devices and register the

 * devices of this expander.
@@ -1528,10 +1528,11 @@ static int sas_configure_phy(struct domain_device *dev, int phy_id, 
}



/**

 * sas_configure_parent -- configure routing table of parent

 * parent: parent expander

 * child: child expander

 * sas_addr: SAS port identifier of device directly attached to child

 * sas_configure_parent - configure routing table of parent

 * @parent: parent expander

 * @child: child expander

 * @sas_addr: SAS port identifier of device directly attached to child

 * @include: whether or not to include @child in the expander routing table

 */

static int sas_configure_parent(struct domain_device *parent,

				struct domain_device *child,
@@ -1570,9 +1571,9 @@ static int sas_configure_parent(struct domain_device *parent, 
}



/**

 * sas_configure_routing -- configure routing

 * dev: expander device

 * sas_addr: port identifier of device directly attached to the expander device

 * sas_configure_routing - configure routing

 * @dev: expander device

 * @sas_addr: port identifier of device directly attached to the expander device

 */

static int sas_configure_routing(struct domain_device *dev, u8 *sas_addr)

{
@@ -1589,8 +1590,8 @@ static int sas_disable_routing(struct domain_device *dev, u8 *sas_addr) 
}



/**

 * sas_discover_expander -- expander discovery

 * @ex: pointer to expander domain device

 * sas_discover_expander - expander discovery

 * @dev: pointer to expander domain device

 *

 * See comment in sas_discover_sata().

 */
@@ -2111,8 +2112,8 @@ static int sas_rediscover(struct domain_device *dev, const int phy_id) 
}



/**

 * sas_revalidate_domain -- revalidate the domain

 * @port: port to the domain of interest

 * sas_ex_revalidate_domain - revalidate the domain

 * @port_dev: port domain device.

 *

 * NOTE: this process _must_ quit (return) as soon as any connection

 * errors are encountered.  Connection recovery is done elsewhere.

drivers/scsi/libsas/sas_init.c

+1 −1
Original line number Diff line number Diff line
@@ -234,7 +234,7 @@ int sas_try_ata_reset(struct asd_sas_phy *asd_phy) 
	return -ENODEV;

}



/**

/*

 * transport_sas_phy_reset - reset a phy and permit libata to manage the link

 *

 * phy reset request via sysfs in host workqueue context so we know we

drivers/scsi/libsas/sas_port.c

+3 −2
Original line number Diff line number Diff line
@@ -84,7 +84,7 @@ static void sas_resume_port(struct asd_sas_phy *phy) 
}



/**

 * sas_form_port -- add this phy to a port

 * sas_form_port - add this phy to a port

 * @phy: the phy of interest

 *

 * This function adds this phy to an existing port, thus creating a wide
@@ -197,8 +197,9 @@ static void sas_form_port(struct asd_sas_phy *phy) 
}



/**

 * sas_deform_port -- remove this phy from the port it belongs to

 * sas_deform_port - remove this phy from the port it belongs to

 * @phy: the phy of interest

 * @gone: whether or not the PHY is gone

 *

 * This is called when the physical link to the other phy has been

 * lost (on this phy), in Event thread context. We cannot delay here.