hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

usb: phy: phy: Fix-up a whole bunch of formatting issues 

Kerneldoc expects arg descriptions to be in the format '@.*: '.  If either
the '@' or the ':' is omitted then kerneldoc complains that the description
is missing.  Add the missing ':'s here.

Also provide a new description for 'event'.

Fixes the following kernel build W=1 warnings:

 drivers/usb/phy/phy.c:106: warning: Function parameter or member 'work' not described in 'usb_phy_notify_charger_work'
 drivers/usb/phy/phy.c:172: warning: Function parameter or member 'nb' not described in 'usb_phy_get_charger_type'
 drivers/usb/phy/phy.c:172: warning: Function parameter or member 'state' not described in 'usb_phy_get_charger_type'
 drivers/usb/phy/phy.c:172: warning: Function parameter or member 'data' not described in 'usb_phy_get_charger_type'
 drivers/usb/phy/phy.c:194: warning: Function parameter or member 'usb_phy' not described in 'usb_phy_set_charger_current'
 drivers/usb/phy/phy.c:194: warning: Function parameter or member 'mA' not described in 'usb_phy_set_charger_current'
 drivers/usb/phy/phy.c:244: warning: Function parameter or member 'usb_phy' not described in 'usb_phy_get_charger_current'
 drivers/usb/phy/phy.c:244: warning: Function parameter or member 'min' not described in 'usb_phy_get_charger_current'
 drivers/usb/phy/phy.c:244: warning: Function parameter or member 'max' not described in 'usb_phy_get_charger_current'
 drivers/usb/phy/phy.c:281: warning: Function parameter or member 'usb_phy' not described in 'usb_phy_set_charger_state'
 drivers/usb/phy/phy.c:281: warning: Function parameter or member 'state' not described in 'usb_phy_set_charger_state'
 drivers/usb/phy/phy.c:427: warning: Function parameter or member 'dev' not described in 'devm_usb_get_phy'
 drivers/usb/phy/phy.c:427: warning: Function parameter or member 'type' not described in 'devm_usb_get_phy'
 drivers/usb/phy/phy.c:456: warning: Function parameter or member 'type' not described in 'usb_get_phy'
 drivers/usb/phy/phy.c:500: warning: Function parameter or member 'dev' not described in 'devm_usb_get_phy_by_node'
 drivers/usb/phy/phy.c:500: warning: Function parameter or member 'node' not described in 'devm_usb_get_phy_by_node'
 drivers/usb/phy/phy.c:500: warning: Function parameter or member 'nb' not described in 'devm_usb_get_phy_by_node'
 drivers/usb/phy/phy.c:558: warning: Function parameter or member 'dev' not described in 'devm_usb_get_phy_by_phandle'
 drivers/usb/phy/phy.c:558: warning: Function parameter or member 'phandle' not described in 'devm_usb_get_phy_by_phandle'
 drivers/usb/phy/phy.c:558: warning: Function parameter or member 'index' not described in 'devm_usb_get_phy_by_phandle'
 drivers/usb/phy/phy.c:590: warning: Function parameter or member 'dev' not described in 'devm_usb_put_phy'
 drivers/usb/phy/phy.c:590: warning: Function parameter or member 'phy' not described in 'devm_usb_put_phy'
 drivers/usb/phy/phy.c:627: warning: Function parameter or member 'type' not described in 'usb_add_phy'
 drivers/usb/phy/phy.c:721: warning: Function parameter or member 'event' not described in 'usb_phy_set_event'

Cc: Felipe Balbi <balbi@kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200702144625.2533530-2-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Lee Jones 2020-07-02 15:45:56 +01:00 committed by Greg Kroah-Hartman
parent c8d141ce1b
commit 529427b928
1 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
drivers/usb/phy/phy.c
View File

@ -88,7 +88,7 @@ static void usb_phy_set_default_current(struct usb_phy *usb_phy)
/** /**
* usb_phy_notify_charger_work - notify the USB charger state * usb_phy_notify_charger_work - notify the USB charger state
* @work - the charger work to notify the USB charger state * @work: the charger work to notify the USB charger state
* *
* This work can be issued when USB charger state has been changed or * This work can be issued when USB charger state has been changed or
* USB charger current has been changed, then we can notify the current * USB charger current has been changed, then we can notify the current
@ -160,9 +160,9 @@ static void __usb_phy_get_charger_type(struct usb_phy *usb_phy)
/** /**
* usb_phy_get_charger_type - get charger type from extcon subsystem * usb_phy_get_charger_type - get charger type from extcon subsystem
* @nb -the notifier block to determine charger type * @nb: the notifier block to determine charger type
* @state - the cable state * @state: the cable state
* @data - private data * @data: private data
* *
* Determin the charger type from extcon subsystem which also means the * Determin the charger type from extcon subsystem which also means the
* charger state has been chaned, then we should notify this event. * charger state has been chaned, then we should notify this event.
@ -178,8 +178,8 @@ static int usb_phy_get_charger_type(struct notifier_block *nb,
/** /**
* usb_phy_set_charger_current - set the USB charger current * usb_phy_set_charger_current - set the USB charger current
* @usb_phy - the USB phy to be used * @usb_phy: the USB phy to be used
* @mA - the current need to be set * @mA: the current need to be set
* *
* Usually we only change the charger default current when USB finished the * Usually we only change the charger default current when USB finished the
* enumeration as one SDP charger. As one SDP charger, usb_phy_set_power() * enumeration as one SDP charger. As one SDP charger, usb_phy_set_power()
@ -231,9 +231,9 @@ EXPORT_SYMBOL_GPL(usb_phy_set_charger_current);
/** /**
* usb_phy_get_charger_current - get the USB charger current * usb_phy_get_charger_current - get the USB charger current
* @usb_phy - the USB phy to be used * @usb_phy: the USB phy to be used
* @min - the minimum current * @min: the minimum current
* @max - the maximum current * @max: the maximum current
* *
* Usually we will notify the maximum current to power user, but for some * Usually we will notify the maximum current to power user, but for some
* special case, power user also need the minimum current value. Then the * special case, power user also need the minimum current value. Then the
@ -269,8 +269,8 @@ EXPORT_SYMBOL_GPL(usb_phy_get_charger_current);
/** /**
* usb_phy_set_charger_state - set the USB charger state * usb_phy_set_charger_state - set the USB charger state
* @usb_phy - the USB phy to be used * @usb_phy: the USB phy to be used
* @state - the new state need to be set for charger * @state: the new state need to be set for charger
* *
* The usb phy driver can issue this function when the usb phy driver * The usb phy driver can issue this function when the usb phy driver
* detected the charger state has been changed, in this case the charger * detected the charger state has been changed, in this case the charger
@ -414,8 +414,8 @@ static int usb_add_extcon(struct usb_phy *x)
/** /**
* devm_usb_get_phy - find the USB PHY * devm_usb_get_phy - find the USB PHY
* @dev - device that requests this phy * @dev: device that requests this phy
* @type - the type of the phy the controller requires * @type: the type of the phy the controller requires
* *
* Gets the phy using usb_get_phy(), and associates a device with it using * Gets the phy using usb_get_phy(), and associates a device with it using
* devres. On driver detach, release function is invoked on the devres data, * devres. On driver detach, release function is invoked on the devres data,
@ -444,7 +444,7 @@ EXPORT_SYMBOL_GPL(devm_usb_get_phy);
/** /**
* usb_get_phy - find the USB PHY * usb_get_phy - find the USB PHY
* @type - the type of the phy the controller requires * @type: the type of the phy the controller requires
* *
* Returns the phy driver, after getting a refcount to it; or * Returns the phy driver, after getting a refcount to it; or
* -ENODEV if there is no such phy. The caller is responsible for * -ENODEV if there is no such phy. The caller is responsible for
@ -480,9 +480,9 @@ EXPORT_SYMBOL_GPL(usb_get_phy);
/** /**
* devm_usb_get_phy_by_node - find the USB PHY by device_node * devm_usb_get_phy_by_node - find the USB PHY by device_node
* @dev - device that requests this phy * @dev: device that requests this phy
* @node - the device_node for the phy device. * @node: the device_node for the phy device.
* @nb - a notifier_block to register with the phy. * @nb: a notifier_block to register with the phy.
* *
* Returns the phy driver associated with the given device_node, * Returns the phy driver associated with the given device_node,
* after getting a refcount to it, -ENODEV if there is no such phy or * after getting a refcount to it, -ENODEV if there is no such phy or
@ -540,9 +540,9 @@ EXPORT_SYMBOL_GPL(devm_usb_get_phy_by_node);
/** /**
* devm_usb_get_phy_by_phandle - find the USB PHY by phandle * devm_usb_get_phy_by_phandle - find the USB PHY by phandle
* @dev - device that requests this phy * @dev: device that requests this phy
* @phandle - name of the property holding the phy phandle value * @phandle: name of the property holding the phy phandle value
* @index - the index of the phy * @index: the index of the phy
* *
* Returns the phy driver associated with the given phandle value, * Returns the phy driver associated with the given phandle value,
* after getting a refcount to it, -ENODEV if there is no such phy or * after getting a refcount to it, -ENODEV if there is no such phy or
@ -578,8 +578,8 @@ EXPORT_SYMBOL_GPL(devm_usb_get_phy_by_phandle);
/** /**
* devm_usb_put_phy - release the USB PHY * devm_usb_put_phy - release the USB PHY
* @dev - device that wants to release this phy * @dev: device that wants to release this phy
* @phy - the phy returned by devm_usb_get_phy() * @phy: the phy returned by devm_usb_get_phy()
* *
* destroys the devres associated with this phy and invokes usb_put_phy * destroys the devres associated with this phy and invokes usb_put_phy
* to release the phy. * to release the phy.
@ -615,9 +615,9 @@ void usb_put_phy(struct usb_phy *x)
EXPORT_SYMBOL_GPL(usb_put_phy); EXPORT_SYMBOL_GPL(usb_put_phy);
/** /**
* usb_add_phy - declare the USB PHY * usb_add_phy: declare the USB PHY
* @x: the USB phy to be used; or NULL * @x: the USB phy to be used; or NULL
* @type - the type of this PHY * @type: the type of this PHY
* *
* This call is exclusively for use by phy drivers, which * This call is exclusively for use by phy drivers, which
* coordinate the activities of drivers for host and peripheral * coordinate the activities of drivers for host and peripheral
@ -714,6 +714,7 @@ EXPORT_SYMBOL_GPL(usb_remove_phy);
/** /**
* usb_phy_set_event - set event to phy event * usb_phy_set_event - set event to phy event
* @x: the phy returned by usb_get_phy(); * @x: the phy returned by usb_get_phy();
* @event: event to set
* *
* This sets event to phy event * This sets event to phy event
*/ */