Commit a11e9b16 authored by Takashi Iwai's avatar Takashi Iwai

ALSA: hda - Correct kerneldoc comments

Complete the missing parameters and fix anything wrong there.
Just comment changes.
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 00dad6cf
...@@ -464,8 +464,12 @@ EXPORT_SYMBOL_GPL(snd_hda_get_input_pin_attr); ...@@ -464,8 +464,12 @@ EXPORT_SYMBOL_GPL(snd_hda_get_input_pin_attr);
/** /**
* hda_get_input_pin_label - Give a label for the given input pin * hda_get_input_pin_label - Give a label for the given input pin
* @codec: the HDA codec
* @item: ping config item to refer
* @pin: the pin NID
* @check_location: flag to add the jack location prefix
* *
* When check_location is true, the function checks the pin location * When @check_location is true, the function checks the pin location
* for mic and line-in pins, and set an appropriate prefix like "Front", * for mic and line-in pins, and set an appropriate prefix like "Front",
* "Rear", "Internal". * "Rear", "Internal".
*/ */
...@@ -550,6 +554,9 @@ static int check_mic_location_need(struct hda_codec *codec, ...@@ -550,6 +554,9 @@ static int check_mic_location_need(struct hda_codec *codec,
/** /**
* hda_get_autocfg_input_label - Get a label for the given input * hda_get_autocfg_input_label - Get a label for the given input
* @codec: the HDA codec
* @cfg: the parsed pin configuration
* @input: the input index number
* *
* Get a label for the given input pin defined by the autocfg item. * Get a label for the given input pin defined by the autocfg item.
* Unlike hda_get_input_pin_label(), this function checks all inputs * Unlike hda_get_input_pin_label(), this function checks all inputs
...@@ -677,6 +684,12 @@ static int fill_audio_out_name(struct hda_codec *codec, hda_nid_t nid, ...@@ -677,6 +684,12 @@ static int fill_audio_out_name(struct hda_codec *codec, hda_nid_t nid,
/** /**
* snd_hda_get_pin_label - Get a label for the given I/O pin * snd_hda_get_pin_label - Get a label for the given I/O pin
* @codec: the HDA codec
* @nid: pin NID
* @cfg: the parsed pin configuration
* @label: the string buffer to store
* @maxlen: the max length of string buffer (including termination)
* @indexp: the pointer to return the index number (for multiple ctls)
* *
* Get a label for the given pin. This function works for both input and * Get a label for the given pin. This function works for both input and
* output pins. When @cfg is given as non-NULL, the function tries to get * output pins. When @cfg is given as non-NULL, the function tries to get
......
This diff is collapsed.
...@@ -371,7 +371,7 @@ int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid, ...@@ -371,7 +371,7 @@ int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
return ret; return ret;
} }
/** /*
* SNDRV_PCM_RATE_* and AC_PAR_PCM values don't match, print correct rates with * SNDRV_PCM_RATE_* and AC_PAR_PCM values don't match, print correct rates with
* hdmi-specific routine. * hdmi-specific routine.
*/ */
......
...@@ -57,6 +57,8 @@ static u32 read_pin_sense(struct hda_codec *codec, hda_nid_t nid) ...@@ -57,6 +57,8 @@ static u32 read_pin_sense(struct hda_codec *codec, hda_nid_t nid)
/** /**
* snd_hda_jack_tbl_get - query the jack-table entry for the given NID * snd_hda_jack_tbl_get - query the jack-table entry for the given NID
* @codec: the HDA codec
* @nid: pin NID to refer to
*/ */
struct hda_jack_tbl * struct hda_jack_tbl *
snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid) snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid)
...@@ -75,6 +77,8 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get); ...@@ -75,6 +77,8 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get);
/** /**
* snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag * snd_hda_jack_tbl_get_from_tag - query the jack-table entry for the given tag
* @codec: the HDA codec
* @tag: tag value to refer to
*/ */
struct hda_jack_tbl * struct hda_jack_tbl *
snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag) snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec, unsigned char tag)
...@@ -93,6 +97,8 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get_from_tag); ...@@ -93,6 +97,8 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_tbl_get_from_tag);
/** /**
* snd_hda_jack_tbl_new - create a jack-table entry for the given NID * snd_hda_jack_tbl_new - create a jack-table entry for the given NID
* @codec: the HDA codec
* @nid: pin NID to assign
*/ */
static struct hda_jack_tbl * static struct hda_jack_tbl *
snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid) snd_hda_jack_tbl_new(struct hda_codec *codec, hda_nid_t nid)
...@@ -162,6 +168,7 @@ static void jack_detect_update(struct hda_codec *codec, ...@@ -162,6 +168,7 @@ static void jack_detect_update(struct hda_codec *codec,
/** /**
* snd_hda_set_dirty_all - Mark all the cached as dirty * snd_hda_set_dirty_all - Mark all the cached as dirty
* @codec: the HDA codec
* *
* This function sets the dirty flag to all entries of jack table. * This function sets the dirty flag to all entries of jack table.
* It's called from the resume path in hda_codec.c. * It's called from the resume path in hda_codec.c.
...@@ -218,6 +225,9 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_detect_state); ...@@ -218,6 +225,9 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_detect_state);
/** /**
* snd_hda_jack_detect_enable - enable the jack-detection * snd_hda_jack_detect_enable - enable the jack-detection
* @codec: the HDA codec
* @nid: pin NID to enable
* @func: callback function to register
* *
* In the case of error, the return value will be a pointer embedded with * In the case of error, the return value will be a pointer embedded with
* errno. Check and handle the return value appropriately with standard * errno. Check and handle the return value appropriately with standard
...@@ -266,6 +276,9 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable); ...@@ -266,6 +276,9 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_detect_enable);
/** /**
* snd_hda_jack_set_gating_jack - Set gating jack. * snd_hda_jack_set_gating_jack - Set gating jack.
* @codec: the HDA codec
* @gated_nid: gated pin NID
* @gating_nid: gating pin NID
* *
* Indicates the gated jack is only valid when the gating jack is plugged. * Indicates the gated jack is only valid when the gating jack is plugged.
*/ */
...@@ -287,6 +300,7 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_set_gating_jack); ...@@ -287,6 +300,7 @@ EXPORT_SYMBOL_GPL(snd_hda_jack_set_gating_jack);
/** /**
* snd_hda_jack_report_sync - sync the states of all jacks and report if changed * snd_hda_jack_report_sync - sync the states of all jacks and report if changed
* @codec: the HDA codec
*/ */
void snd_hda_jack_report_sync(struct hda_codec *codec) void snd_hda_jack_report_sync(struct hda_codec *codec)
{ {
...@@ -349,6 +363,11 @@ static void hda_free_jack_priv(struct snd_jack *jack) ...@@ -349,6 +363,11 @@ static void hda_free_jack_priv(struct snd_jack *jack)
/** /**
* snd_hda_jack_add_kctl - Add a kctl for the given pin * snd_hda_jack_add_kctl - Add a kctl for the given pin
* @codec: the HDA codec
* @nid: pin NID to assign
* @name: string name for the jack
* @idx: index number for the jack
* @phantom_jack: flag to deal as a phantom jack
* *
* This assigns a jack-detection kctl to the given pin. The kcontrol * This assigns a jack-detection kctl to the given pin. The kcontrol
* will have the given name and index. * will have the given name and index.
...@@ -456,6 +475,8 @@ static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid, ...@@ -456,6 +475,8 @@ static int add_jack_kctl(struct hda_codec *codec, hda_nid_t nid,
/** /**
* snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg * snd_hda_jack_add_kctls - Add kctls for all pins included in the given pincfg
* @codec: the HDA codec
* @cfg: pin config table to parse
*/ */
int snd_hda_jack_add_kctls(struct hda_codec *codec, int snd_hda_jack_add_kctls(struct hda_codec *codec,
const struct auto_pin_cfg *cfg) const struct auto_pin_cfg *cfg)
......
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