usb: hosts: Remove in_interrupt() from comments

The usage of in_interrupt() in drivers is phased out for various reasons.

Various comments use !in_interrupt() to describe calling context for probe()
and remove() functions. That's wrong because the calling context has to be
preemptible task context, which is not what !in_interrupt() describes.

Cleanup the comments. While at it add the missing kernel doc argument
descriptors.

Signed-off-by: Ahmed S. Darwish <a.darwish@linutronix.de>
Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Acked-by: Krzysztof Kozlowski <krzk@kernel.org>
Acked-by: Alan Stern <stern@rowland.harvard.edu>
Cc: linux-usb@vger.kernel.org
Cc: linux-omap@vger.kernel.org
Cc: Kukjin Kim <kgene@kernel.org>
Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-samsung-soc@vger.kernel.org
Link: https://lore.kernel.org/r/20201019101110.439968251@linutronix.de
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Ahmed S. Darwish 2020-10-19 12:06:37 +02:00 committed by Greg Kroah-Hartman
parent 726c8277bc
commit 19220bac2c
6 changed files with 37 additions and 26 deletions

View File

@ -39,10 +39,10 @@ static struct hc_driver __read_mostly fsl_ehci_hc_driver;
/*
* fsl_ehci_drv_probe - initialize FSL-based HCDs
* @pdev: USB Host Controller being probed
* Context: !in_interrupt()
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller.
*
*/
static int fsl_ehci_drv_probe(struct platform_device *pdev)
{
@ -684,12 +684,11 @@ static const struct ehci_driver_overrides ehci_fsl_overrides __initconst = {
/**
* fsl_ehci_drv_remove - shutdown processing for FSL-based HCDs
* @pdev: USB Host Controller being removed
* Context: !in_interrupt()
*
* Context: task context, might sleep
*
* Reverses the effect of usb_hcd_fsl_probe().
*
*/
static int fsl_ehci_drv_remove(struct platform_device *pdev)
{
struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev);

View File

@ -147,12 +147,14 @@ err1:
/**
* usb_hcd_msp_probe - initialize PMC MSP-based HCDs
* Context: !in_interrupt()
* @driver: Pointer to hc driver instance
* @dev: USB controller to probe
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller, and
* then invokes the start() method for the HCD associated with it
* through the hotplug entry's driver_data.
*
*/
int usb_hcd_msp_probe(const struct hc_driver *driver,
struct platform_device *dev)
@ -223,8 +225,9 @@ err1:
/**
* usb_hcd_msp_remove - shutdown processing for PMC MSP-based HCDs
* @dev: USB Host Controller being removed
* Context: !in_interrupt()
* @hcd: USB Host Controller being removed
*
* Context: task context, might sleep
*
* Reverses the effect of usb_hcd_msp_probe(), first invoking
* the HCD's stop() method. It is always called from a thread

View File

@ -155,7 +155,10 @@ static struct regmap *at91_dt_syscon_sfr(void)
/*
* usb_hcd_at91_probe - initialize AT91-based HCDs
* Context: !in_interrupt()
* @driver: Pointer to hc driver instance
* @pdev: USB controller to probe
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller, and
* then invokes the start() method for the HCD associated with it
@ -246,12 +249,14 @@ static int usb_hcd_at91_probe(const struct hc_driver *driver,
/*
* usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
* Context: !in_interrupt()
* @hcd: USB controller to remove
* @pdev: Platform device required for cleanup
*
* Context: task context, might sleep
*
* Reverses the effect of usb_hcd_at91_probe(), first invoking
* the HCD's stop() method. It is always called from a thread
* context, "rmmod" or something similar.
*
*/
static void usb_hcd_at91_remove(struct usb_hcd *hcd,
struct platform_device *pdev)

View File

@ -285,7 +285,9 @@ static int ohci_omap_reset(struct usb_hcd *hcd)
/**
* ohci_hcd_omap_probe - initialize OMAP-based HCDs
* Context: !in_interrupt()
* @pdev: USB controller to probe
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller, and
* then invokes the start() method for the HCD associated with it
@ -399,8 +401,9 @@ err_put_hcd:
/**
* ohci_hcd_omap_remove - shutdown processing for OMAP-based HCDs
* @dev: USB Host Controller being removed
* Context: !in_interrupt()
* @pdev: USB Host Controller being removed
*
* Context: task context, might sleep
*
* Reverses the effect of ohci_hcd_omap_probe(), first invoking
* the HCD's stop() method. It is always called from a thread

View File

@ -410,12 +410,13 @@ static int ohci_pxa_of_init(struct platform_device *pdev)
/**
* ohci_hcd_pxa27x_probe - initialize pxa27x-based HCDs
* Context: !in_interrupt()
* @pdev: USB Host controller to probe
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller, and
* then invokes the start() method for the HCD associated with it
* through the hotplug entry's driver_data.
*
*/
static int ohci_hcd_pxa27x_probe(struct platform_device *pdev)
{
@ -509,13 +510,13 @@ static int ohci_hcd_pxa27x_probe(struct platform_device *pdev)
/**
* ohci_hcd_pxa27x_remove - shutdown processing for pxa27x-based HCDs
* @dev: USB Host Controller being removed
* Context: !in_interrupt()
* @pdev: USB Host Controller being removed
*
* Context: task context, might sleep
*
* Reverses the effect of ohci_hcd_pxa27x_probe(), first invoking
* the HCD's stop() method. It is always called from a thread
* context, normally "rmmod", "apmd", or something similar.
*
*/
static int ohci_hcd_pxa27x_remove(struct platform_device *pdev)
{

View File

@ -324,14 +324,13 @@ static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc)
/*
* ohci_hcd_s3c2410_remove - shutdown processing for HCD
* @dev: USB Host Controller being removed
* Context: !in_interrupt()
*
* Context: task context, might sleep
*
* Reverses the effect of ohci_hcd_3c2410_probe(), first invoking
* the HCD's stop() method. It is always called from a thread
* context, normally "rmmod", "apmd", or something similar.
*
*/
*/
static int
ohci_hcd_s3c2410_remove(struct platform_device *dev)
{
@ -345,12 +344,13 @@ ohci_hcd_s3c2410_remove(struct platform_device *dev)
/*
* ohci_hcd_s3c2410_probe - initialize S3C2410-based HCDs
* Context: !in_interrupt()
* @dev: USB Host Controller to be probed
*
* Context: task context, might sleep
*
* Allocates basic resources for this USB host controller, and
* then invokes the start() method for the HCD associated with it
* through the hotplug entry's driver_data.
*
*/
static int ohci_hcd_s3c2410_probe(struct platform_device *dev)
{