Commit 44684f61 authored by Takashi Iwai's avatar Takashi Iwai

ALSA: x86: Simplify comments

It's a stand-alone small driver code, and we don't have to describe
too much formalized comments in kernel-doc style for local functions
at all.
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 36ed3466
...@@ -609,11 +609,7 @@ static int had_register_chmap_ctls(struct snd_intelhad *intelhaddata, ...@@ -609,11 +609,7 @@ static int had_register_chmap_ctls(struct snd_intelhad *intelhaddata,
} }
/* /*
* snd_intelhad_prog_dip - to initialize Data Island Packets registers * Initialize Data Island Packets registers
*
* @substream:substream for which the prepare function is called
* @intelhaddata:substream private data
*
* This function is called in the prepare callback * This function is called in the prepare callback
*/ */
static void snd_intelhad_prog_dip(struct snd_pcm_substream *substream, static void snd_intelhad_prog_dip(struct snd_pcm_substream *substream,
...@@ -666,10 +662,7 @@ static void snd_intelhad_prog_dip(struct snd_pcm_substream *substream, ...@@ -666,10 +662,7 @@ static void snd_intelhad_prog_dip(struct snd_pcm_substream *substream,
} }
/* /*
* snd_intelhad_prog_buffer - programs buffer address and length registers * Programs buffer address and length registers
* @substream: substream for which the prepare function is called
* @intelhaddata: substream private data
*
* This function programs ring buffer address and length into registers. * This function programs ring buffer address and length into registers.
*/ */
static int snd_intelhad_prog_buffer(struct snd_pcm_substream *substream, static int snd_intelhad_prog_buffer(struct snd_pcm_substream *substream,
...@@ -824,7 +817,7 @@ static int had_calculate_maud_value(u32 aud_samp_freq, u32 link_rate) ...@@ -824,7 +817,7 @@ static int had_calculate_maud_value(u32 aud_samp_freq, u32 link_rate)
} }
/* /*
* snd_intelhad_prog_cts - Program HDMI audio CTS value * Program HDMI audio CTS value
* *
* @aud_samp_freq: sampling frequency of audio data * @aud_samp_freq: sampling frequency of audio data
* @tmds: sampling frequency of the display data * @tmds: sampling frequency of the display data
...@@ -896,7 +889,7 @@ static int had_calculate_n_value(u32 aud_samp_freq) ...@@ -896,7 +889,7 @@ static int had_calculate_n_value(u32 aud_samp_freq)
} }
/* /*
* snd_intelhad_prog_n - Program HDMI audio N value * Program HDMI audio N value
* *
* @aud_samp_freq: sampling frequency of audio data * @aud_samp_freq: sampling frequency of audio data
* @n_param: N value, depends on aud_samp_freq * @n_param: N value, depends on aud_samp_freq
...@@ -962,10 +955,7 @@ static void snd_intelhad_handle_underrun(struct snd_intelhad *intelhaddata) ...@@ -962,10 +955,7 @@ static void snd_intelhad_handle_underrun(struct snd_intelhad *intelhaddata)
} }
/* /*
* snd_intelhad_open - stream initializations are done here * ALSA PCM open callback
* @substream:substream for which the stream function is called
*
* This function is called whenever a PCM stream is opened
*/ */
static int snd_intelhad_open(struct snd_pcm_substream *substream) static int snd_intelhad_open(struct snd_pcm_substream *substream)
{ {
...@@ -1017,10 +1007,7 @@ static int snd_intelhad_open(struct snd_pcm_substream *substream) ...@@ -1017,10 +1007,7 @@ static int snd_intelhad_open(struct snd_pcm_substream *substream)
} }
/* /*
* snd_intelhad_close - to free parameteres when stream is stopped * ALSA PCM close callback
* @substream: substream for which the function is called
*
* This function is called by ALSA framework when stream is stopped
*/ */
static int snd_intelhad_close(struct snd_pcm_substream *substream) static int snd_intelhad_close(struct snd_pcm_substream *substream)
{ {
...@@ -1051,12 +1038,7 @@ static int snd_intelhad_close(struct snd_pcm_substream *substream) ...@@ -1051,12 +1038,7 @@ static int snd_intelhad_close(struct snd_pcm_substream *substream)
} }
/* /*
* snd_intelhad_hw_params - to setup the hardware parameters * ALSA PCM hw_params callback
* like allocating the buffers
* @substream: substream for which the function is called
* @hw_params: hardware parameters
*
* This function is called by ALSA framework when hardware params are set
*/ */
static int snd_intelhad_hw_params(struct snd_pcm_substream *substream, static int snd_intelhad_hw_params(struct snd_pcm_substream *substream,
struct snd_pcm_hw_params *hw_params) struct snd_pcm_hw_params *hw_params)
...@@ -1090,11 +1072,7 @@ static int snd_intelhad_hw_params(struct snd_pcm_substream *substream, ...@@ -1090,11 +1072,7 @@ static int snd_intelhad_hw_params(struct snd_pcm_substream *substream,
} }
/* /*
* snd_intelhad_hw_free - to release the resources allocated during * ALSA PCM hw_free callback
* hardware params setup
* @substream: substream for which the function is called
*
* This function is called by ALSA framework before close callback.
*/ */
static int snd_intelhad_hw_free(struct snd_pcm_substream *substream) static int snd_intelhad_hw_free(struct snd_pcm_substream *substream)
{ {
...@@ -1113,11 +1091,7 @@ static int snd_intelhad_hw_free(struct snd_pcm_substream *substream) ...@@ -1113,11 +1091,7 @@ static int snd_intelhad_hw_free(struct snd_pcm_substream *substream)
} }
/* /*
* snd_intelhad_pcm_trigger - stream activities are handled here * ALSA PCM trigger callback
* @substream: substream for which the stream function is called
* @cmd: the stream commamd thats requested from upper layer
*
* This function is called whenever an a stream activity is invoked
*/ */
static int snd_intelhad_pcm_trigger(struct snd_pcm_substream *substream, static int snd_intelhad_pcm_trigger(struct snd_pcm_substream *substream,
int cmd) int cmd)
...@@ -1172,10 +1146,7 @@ static int snd_intelhad_pcm_trigger(struct snd_pcm_substream *substream, ...@@ -1172,10 +1146,7 @@ static int snd_intelhad_pcm_trigger(struct snd_pcm_substream *substream,
} }
/* /*
* snd_intelhad_pcm_prepare - internal preparation before starting a stream * ALSA PCM prepare callback
* @substream: substream for which the function is called
*
* This function is called when a stream is started for internal preparation.
*/ */
static int snd_intelhad_pcm_prepare(struct snd_pcm_substream *substream) static int snd_intelhad_pcm_prepare(struct snd_pcm_substream *substream)
{ {
...@@ -1243,14 +1214,10 @@ static int snd_intelhad_pcm_prepare(struct snd_pcm_substream *substream) ...@@ -1243,14 +1214,10 @@ static int snd_intelhad_pcm_prepare(struct snd_pcm_substream *substream)
} }
/* /*
* snd_intelhad_pcm_pointer- to send the current buffer pointerprocessed by hw * ALSA PCM pointer callback
* @substream: substream for which the function is called
*
* This function is called by ALSA framework to get the current hw buffer ptr
* when a period is elapsed
*/ */
static snd_pcm_uframes_t snd_intelhad_pcm_pointer( static snd_pcm_uframes_t
struct snd_pcm_substream *substream) snd_intelhad_pcm_pointer(struct snd_pcm_substream *substream)
{ {
struct snd_intelhad *intelhaddata; struct snd_intelhad *intelhaddata;
u32 bytes_rendered = 0; u32 bytes_rendered = 0;
...@@ -1299,12 +1266,7 @@ static snd_pcm_uframes_t snd_intelhad_pcm_pointer( ...@@ -1299,12 +1266,7 @@ static snd_pcm_uframes_t snd_intelhad_pcm_pointer(
} }
/* /*
* snd_intelhad_pcm_mmap- mmaps a kernel buffer to user space for copying data * ALSA PCM mmap callback
* @substream: substream for which the function is called
* @vma: struct instance of memory VMM memory area
*
* This function is called by OS when a user space component
* tries to get mmap memory from driver
*/ */
static int snd_intelhad_pcm_mmap(struct snd_pcm_substream *substream, static int snd_intelhad_pcm_mmap(struct snd_pcm_substream *substream,
struct vm_area_struct *vma) struct vm_area_struct *vma)
......
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