Commit 6e57188f authored by Keyon Jie's avatar Keyon Jie Committed by Takashi Iwai
Browse files

ALSA: hda: Update kernel-doc function parameter descriptions 



Make W=1 throws a lot of warnings, with multiple misalignments between
function params and their descriptions.

Signed-off-by: default avatarKeyon Jie <yang.jie@linux.intel.com>
Signed-off-by: default avatarPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20200113205638.27338-1-pierre-louis.bossart@linux.intel.com


Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 1a462be5

sound/hda/ext/hdac_ext_bus.c

+6 −5
Original line number Diff line number Diff line
@@ -19,10 +19,10 @@ MODULE_LICENSE("GPL v2"); 


/**

 * snd_hdac_ext_bus_init - initialize a HD-audio extended bus

 * @ebus: the pointer to extended bus object

 * @bus: the pointer to HDAC bus object

 * @dev: device pointer

 * @ops: bus verb operators

 * default ops

 * @ext_ops: operators used for ASoC HDA codec drivers

 *

 * Returns 0 if successful, or a negative error code.

 */
@@ -51,7 +51,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_init); 


/**

 * snd_hdac_ext_bus_exit - clean up a HD-audio extended bus

 * @ebus: the pointer to extended bus object

 * @bus: the pointer to HDAC bus object

 */

void snd_hdac_ext_bus_exit(struct hdac_bus *bus)

{
@@ -67,8 +67,9 @@ static void default_release(struct device *dev) 


/**

 * snd_hdac_ext_bus_device_init - initialize the HDA extended codec base device

 * @ebus: hdac extended bus to attach to

 * @bus: hdac bus to attach to

 * @addr: codec address

 * @hdev: hdac device to init

 *

 * Returns zero for success or a negative error code.

 */
@@ -114,7 +115,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_device_exit); 
/**

 * snd_hdac_ext_bus_device_remove - remove HD-audio extended codec base devices

 *

 * @ebus: HD-audio extended bus

 * @bus: the pointer to HDAC bus object

 */

void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus)

{

sound/hda/ext/hdac_ext_controller.c

+7 −7
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ 


/**

 * snd_hdac_ext_bus_ppcap_enable - enable/disable processing pipe capability

 * @ebus: HD-audio extended core bus

 * @bus: the pointer to HDAC bus object

 * @enable: flag to turn on/off the capability

 */

void snd_hdac_ext_bus_ppcap_enable(struct hdac_bus *bus, bool enable)
@@ -50,7 +50,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_ppcap_enable); 


/**

 * snd_hdac_ext_bus_ppcap_int_enable - ppcap interrupt enable/disable

 * @ebus: HD-audio extended core bus

 * @bus: the pointer to HDAC bus object

 * @enable: flag to enable/disable interrupt

 */

void snd_hdac_ext_bus_ppcap_int_enable(struct hdac_bus *bus, bool enable)
@@ -77,7 +77,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_ppcap_int_enable); 


/**

 * snd_hdac_ext_bus_get_ml_capabilities - get multilink capability

 * @ebus: HD-audio extended core bus

 * @bus: the pointer to HDAC bus object

 *

 * This will parse all links and read the mlink capabilities and add them

 * in hlink_list of extended hdac bus
@@ -117,7 +117,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_get_ml_capabilities); 
/**

 * snd_hdac_link_free_all- free hdac extended link objects

 *

 * @ebus: HD-audio ext core bus

 * @bus: the pointer to HDAC bus object

 */



void snd_hdac_link_free_all(struct hdac_bus *bus)
@@ -134,7 +134,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_link_free_all); 


/**

 * snd_hdac_ext_bus_get_link_index - get link based on codec name

 * @ebus: HD-audio extended core bus

 * @bus: the pointer to HDAC bus object

 * @codec_name: codec name

 */

struct hdac_ext_link *snd_hdac_ext_bus_get_link(struct hdac_bus *bus,
@@ -211,7 +211,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_link_power_down); 


/**

 * snd_hdac_ext_bus_link_power_up_all -power up all hda link

 * @ebus: HD-audio extended bus

 * @bus: the pointer to HDAC bus object

 */

int snd_hdac_ext_bus_link_power_up_all(struct hdac_bus *bus)

{
@@ -232,7 +232,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_link_power_up_all); 


/**

 * snd_hdac_ext_bus_link_power_down_all -power down all hda link

 * @ebus: HD-audio extended bus

 * @bus: the pointer to HDAC bus object

 */

int snd_hdac_ext_bus_link_power_down_all(struct hdac_bus *bus)

{

sound/hda/ext/hdac_ext_stream.c

+0 −1
Original line number Diff line number Diff line
@@ -530,7 +530,6 @@ EXPORT_SYMBOL_GPL(snd_hdac_ext_stream_set_dpibr); 


/**

 * snd_hdac_ext_stream_set_lpib - sets the lpib value of a stream

 * @bus: HD-audio core bus

 * @stream: hdac_ext_stream

 * @value: lpib value to set

 */

sound/hda/hdac_bus.c

+3 −0
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ static const struct hdac_bus_ops default_ops = { 
/**

 * snd_hdac_bus_init - initialize a HD-audio bas bus

 * @bus: the pointer to bus object

 * @dev: device pointer

 * @ops: bus verb operators

 *

 * Returns 0 if successful, or a negative error code.
@@ -64,6 +65,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_bus_exit); 
/**

 * snd_hdac_bus_exec_verb - execute a HD-audio verb on the given bus

 * @bus: bus object

 * @addr: the HDAC device address

 * @cmd: HD-audio encoded verb

 * @res: pointer to store the response, NULL if performing asynchronously

 *
@@ -84,6 +86,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_bus_exec_verb); 
/**

 * snd_hdac_bus_exec_verb_unlocked - unlocked version

 * @bus: bus object

 * @addr: the HDAC device address

 * @cmd: HD-audio encoded verb

 * @res: pointer to store the response, NULL if performing asynchronously

 *

sound/hda/hdac_component.c

+1 −0
Original line number Diff line number Diff line
@@ -262,6 +262,7 @@ EXPORT_SYMBOL_GPL(snd_hdac_acomp_register_notifier); 
/**

 * snd_hdac_acomp_init - Initialize audio component

 * @bus: HDA core bus

 * @aops: audio component ops

 * @match_master: match function for finding components

 * @extra_size: Extra bytes to allocate

 *

CRA Git | Maintained and supported by SUSTech CRA and CCSE