Commit d453379b authored by Takashi Iwai's avatar Takashi Iwai Committed by Takashi Iwai

ALSA: Update description of snd_card_create() in documents

Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent bd7dd77c
...@@ -492,9 +492,9 @@ ...@@ -492,9 +492,9 @@
} }
/* (2) */ /* (2) */
card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0); err = snd_card_create(index[dev], id[dev], THIS_MODULE, 0, &card);
if (card == NULL) if (err < 0)
return -ENOMEM; return err;
/* (3) */ /* (3) */
err = snd_mychip_create(card, pci, &chip); err = snd_mychip_create(card, pci, &chip);
...@@ -590,8 +590,9 @@ ...@@ -590,8 +590,9 @@
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
struct snd_card *card; struct snd_card *card;
int err;
.... ....
card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0); err = snd_card_create(index[dev], id[dev], THIS_MODULE, 0, &card);
]]> ]]>
</programlisting> </programlisting>
</informalexample> </informalexample>
...@@ -809,26 +810,28 @@ ...@@ -809,26 +810,28 @@
<para> <para>
As mentioned above, to create a card instance, call As mentioned above, to create a card instance, call
<function>snd_card_new()</function>. <function>snd_card_create()</function>.
<informalexample> <informalexample>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
struct snd_card *card; struct snd_card *card;
card = snd_card_new(index, id, module, extra_size); int err;
err = snd_card_create(index, id, module, extra_size, &card);
]]> ]]>
</programlisting> </programlisting>
</informalexample> </informalexample>
</para> </para>
<para> <para>
The function takes four arguments, the card-index number, the The function takes five arguments, the card-index number, the
id string, the module pointer (usually id string, the module pointer (usually
<constant>THIS_MODULE</constant>), <constant>THIS_MODULE</constant>),
and the size of extra-data space. The last argument is used to the size of extra-data space, and the pointer to return the
card instance. The extra_size argument is used to
allocate card-&gt;private_data for the allocate card-&gt;private_data for the
chip-specific data. Note that these data chip-specific data. Note that these data
are allocated by <function>snd_card_new()</function>. are allocated by <function>snd_card_create()</function>.
</para> </para>
</section> </section>
...@@ -915,15 +918,16 @@ ...@@ -915,15 +918,16 @@
</para> </para>
<section id="card-management-chip-specific-snd-card-new"> <section id="card-management-chip-specific-snd-card-new">
<title>1. Allocating via <function>snd_card_new()</function>.</title> <title>1. Allocating via <function>snd_card_create()</function>.</title>
<para> <para>
As mentioned above, you can pass the extra-data-length As mentioned above, you can pass the extra-data-length
to the 4th argument of <function>snd_card_new()</function>, i.e. to the 4th argument of <function>snd_card_create()</function>, i.e.
<informalexample> <informalexample>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
card = snd_card_new(index[dev], id[dev], THIS_MODULE, sizeof(struct mychip)); err = snd_card_create(index[dev], id[dev], THIS_MODULE,
sizeof(struct mychip), &card);
]]> ]]>
</programlisting> </programlisting>
</informalexample> </informalexample>
...@@ -952,8 +956,8 @@ ...@@ -952,8 +956,8 @@
<para> <para>
After allocating a card instance via After allocating a card instance via
<function>snd_card_new()</function> (with <function>snd_card_create()</function> (with
<constant>NULL</constant> on the 4th arg), call <constant>0</constant> on the 4th arg), call
<function>kzalloc()</function>. <function>kzalloc()</function>.
<informalexample> <informalexample>
...@@ -961,7 +965,7 @@ ...@@ -961,7 +965,7 @@
<![CDATA[ <![CDATA[
struct snd_card *card; struct snd_card *card;
struct mychip *chip; struct mychip *chip;
card = snd_card_new(index[dev], id[dev], THIS_MODULE, NULL); err = snd_card_create(index[dev], id[dev], THIS_MODULE, 0, &card);
..... .....
chip = kzalloc(sizeof(*chip), GFP_KERNEL); chip = kzalloc(sizeof(*chip), GFP_KERNEL);
]]> ]]>
...@@ -5750,8 +5754,9 @@ struct _snd_pcm_runtime { ...@@ -5750,8 +5754,9 @@ struct _snd_pcm_runtime {
.... ....
struct snd_card *card; struct snd_card *card;
struct mychip *chip; struct mychip *chip;
int err;
.... ....
card = snd_card_new(index[dev], id[dev], THIS_MODULE, NULL); err = snd_card_create(index[dev], id[dev], THIS_MODULE, 0, &card);
.... ....
chip = kzalloc(sizeof(*chip), GFP_KERNEL); chip = kzalloc(sizeof(*chip), GFP_KERNEL);
.... ....
...@@ -5763,7 +5768,7 @@ struct _snd_pcm_runtime { ...@@ -5763,7 +5768,7 @@ struct _snd_pcm_runtime {
</informalexample> </informalexample>
When you created the chip data with When you created the chip data with
<function>snd_card_new()</function>, it's anyway accessible <function>snd_card_create()</function>, it's anyway accessible
via <structfield>private_data</structfield> field. via <structfield>private_data</structfield> field.
<informalexample> <informalexample>
...@@ -5775,9 +5780,10 @@ struct _snd_pcm_runtime { ...@@ -5775,9 +5780,10 @@ struct _snd_pcm_runtime {
.... ....
struct snd_card *card; struct snd_card *card;
struct mychip *chip; struct mychip *chip;
int err;
.... ....
card = snd_card_new(index[dev], id[dev], THIS_MODULE, err = snd_card_create(index[dev], id[dev], THIS_MODULE,
sizeof(struct mychip)); sizeof(struct mychip), &card);
.... ....
chip = card->private_data; chip = card->private_data;
.... ....
......
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