Commit | Line | Data |
---|---|---|
7ddedebb TI |
1 | ====================== |
2 | Writing an ALSA Driver | |
3 | ====================== | |
4 | ||
5 | :Author: Takashi Iwai <tiwai@suse.de> | |
7ddedebb TI |
6 | |
7 | Preface | |
8 | ======= | |
9 | ||
10 | This document describes how to write an `ALSA (Advanced Linux Sound | |
11 | Architecture) <http://www.alsa-project.org/>`__ driver. The document | |
12 | focuses mainly on PCI soundcards. In the case of other device types, the | |
13 | API might be different, too. However, at least the ALSA kernel API is | |
14 | consistent, and therefore it would be still a bit help for writing them. | |
15 | ||
16 | This document targets people who already have enough C language skills | |
17 | and have basic linux kernel programming knowledge. This document doesn't | |
18 | explain the general topic of linux kernel coding and doesn't cover | |
19 | low-level driver implementation details. It only describes the standard | |
20 | way to write a PCI sound driver on ALSA. | |
21 | ||
7ddedebb TI |
22 | File Tree Structure |
23 | =================== | |
24 | ||
25 | General | |
26 | ------- | |
27 | ||
4d421eeb | 28 | The file tree structure of ALSA driver is depicted below:: |
7ddedebb TI |
29 | |
30 | sound | |
31 | /core | |
32 | /oss | |
33 | /seq | |
34 | /oss | |
7ddedebb TI |
35 | /include |
36 | /drivers | |
37 | /mpu401 | |
38 | /opl3 | |
39 | /i2c | |
7ddedebb TI |
40 | /synth |
41 | /emux | |
42 | /pci | |
43 | /(cards) | |
44 | /isa | |
45 | /(cards) | |
46 | /arm | |
47 | /ppc | |
48 | /sparc | |
49 | /usb | |
50 | /pcmcia /(cards) | |
f90afe79 | 51 | /soc |
7ddedebb TI |
52 | /oss |
53 | ||
54 | ||
55 | core directory | |
56 | -------------- | |
57 | ||
58 | This directory contains the middle layer which is the heart of ALSA | |
59 | drivers. In this directory, the native ALSA modules are stored. The | |
60 | sub-directories contain different modules and are dependent upon the | |
61 | kernel config. | |
62 | ||
63 | core/oss | |
64 | ~~~~~~~~ | |
65 | ||
4d421eeb OB |
66 | The code for OSS PCM and mixer emulation modules is stored in this |
67 | directory. The OSS rawmidi emulation is included in the ALSA rawmidi | |
7ddedebb | 68 | code since it's quite small. The sequencer code is stored in |
4f8af077 | 69 | ``core/seq/oss`` directory (see `below <core/seq/oss_>`__). |
7ddedebb | 70 | |
7ddedebb TI |
71 | core/seq |
72 | ~~~~~~~~ | |
73 | ||
74 | This directory and its sub-directories are for the ALSA sequencer. This | |
75 | directory contains the sequencer core and primary sequencer modules such | |
4d421eeb | 76 | as snd-seq-midi, snd-seq-virmidi, etc. They are compiled only when |
7ddedebb TI |
77 | ``CONFIG_SND_SEQUENCER`` is set in the kernel config. |
78 | ||
79 | core/seq/oss | |
80 | ~~~~~~~~~~~~ | |
81 | ||
4d421eeb | 82 | This contains the OSS sequencer emulation code. |
7ddedebb | 83 | |
7ddedebb TI |
84 | include directory |
85 | ----------------- | |
86 | ||
87 | This is the place for the public header files of ALSA drivers, which are | |
4d421eeb | 88 | to be exported to user-space, or included by several files in different |
7ddedebb TI |
89 | directories. Basically, the private header files should not be placed in |
90 | this directory, but you may still find files there, due to historical | |
91 | reasons :) | |
92 | ||
93 | drivers directory | |
94 | ----------------- | |
95 | ||
96 | This directory contains code shared among different drivers on different | |
97 | architectures. They are hence supposed not to be architecture-specific. | |
4d421eeb | 98 | For example, the dummy PCM driver and the serial MIDI driver are found |
7ddedebb TI |
99 | in this directory. In the sub-directories, there is code for components |
100 | which are independent from bus and cpu architectures. | |
101 | ||
102 | drivers/mpu401 | |
103 | ~~~~~~~~~~~~~~ | |
104 | ||
105 | The MPU401 and MPU401-UART modules are stored here. | |
106 | ||
107 | drivers/opl3 and opl4 | |
108 | ~~~~~~~~~~~~~~~~~~~~~ | |
109 | ||
110 | The OPL3 and OPL4 FM-synth stuff is found here. | |
111 | ||
112 | i2c directory | |
113 | ------------- | |
114 | ||
115 | This contains the ALSA i2c components. | |
116 | ||
117 | Although there is a standard i2c layer on Linux, ALSA has its own i2c | |
118 | code for some cards, because the soundcard needs only a simple operation | |
119 | and the standard i2c API is too complicated for such a purpose. | |
120 | ||
7ddedebb TI |
121 | synth directory |
122 | --------------- | |
123 | ||
124 | This contains the synth middle-level modules. | |
125 | ||
126 | So far, there is only Emu8000/Emu10k1 synth driver under the | |
127 | ``synth/emux`` sub-directory. | |
128 | ||
129 | pci directory | |
130 | ------------- | |
131 | ||
132 | This directory and its sub-directories hold the top-level card modules | |
133 | for PCI soundcards and the code specific to the PCI BUS. | |
134 | ||
135 | The drivers compiled from a single file are stored directly in the pci | |
136 | directory, while the drivers with several source files are stored on | |
137 | their own sub-directory (e.g. emu10k1, ice1712). | |
138 | ||
139 | isa directory | |
140 | ------------- | |
141 | ||
142 | This directory and its sub-directories hold the top-level card modules | |
143 | for ISA soundcards. | |
144 | ||
145 | arm, ppc, and sparc directories | |
146 | ------------------------------- | |
147 | ||
148 | They are used for top-level card modules which are specific to one of | |
149 | these architectures. | |
150 | ||
151 | usb directory | |
152 | ------------- | |
153 | ||
4d421eeb OB |
154 | This directory contains the USB-audio driver. |
155 | The USB MIDI driver is integrated in the usb-audio driver. | |
7ddedebb TI |
156 | |
157 | pcmcia directory | |
158 | ---------------- | |
159 | ||
160 | The PCMCIA, especially PCCard drivers will go here. CardBus drivers will | |
161 | be in the pci directory, because their API is identical to that of | |
162 | standard PCI cards. | |
163 | ||
f90afe79 TI |
164 | soc directory |
165 | ------------- | |
166 | ||
167 | This directory contains the codes for ASoC (ALSA System on Chip) | |
168 | layer including ASoC core, codec and machine drivers. | |
169 | ||
7ddedebb TI |
170 | oss directory |
171 | ------------- | |
172 | ||
4d421eeb OB |
173 | This contains OSS/Lite code. |
174 | At the time of writing, all code has been removed except for dmasound | |
175 | on m68k. | |
f90afe79 | 176 | |
7ddedebb TI |
177 | |
178 | Basic Flow for PCI Drivers | |
179 | ========================== | |
180 | ||
181 | Outline | |
182 | ------- | |
183 | ||
184 | The minimum flow for PCI soundcards is as follows: | |
185 | ||
186 | - define the PCI ID table (see the section `PCI Entries`_). | |
187 | ||
188 | - create ``probe`` callback. | |
189 | ||
190 | - create ``remove`` callback. | |
191 | ||
68735902 | 192 | - create a struct pci_driver structure |
7ddedebb TI |
193 | containing the three pointers above. |
194 | ||
195 | - create an ``init`` function just calling the | |
196 | :c:func:`pci_register_driver()` to register the pci_driver | |
197 | table defined above. | |
198 | ||
199 | - create an ``exit`` function to call the | |
200 | :c:func:`pci_unregister_driver()` function. | |
201 | ||
202 | Full Code Example | |
203 | ----------------- | |
204 | ||
205 | The code example is shown below. Some parts are kept unimplemented at | |
206 | this moment but will be filled in the next sections. The numbers in the | |
207 | comment lines of the :c:func:`snd_mychip_probe()` function refer | |
208 | to details explained in the following section. | |
209 | ||
210 | :: | |
211 | ||
212 | #include <linux/init.h> | |
213 | #include <linux/pci.h> | |
214 | #include <linux/slab.h> | |
215 | #include <sound/core.h> | |
216 | #include <sound/initval.h> | |
217 | ||
218 | /* module parameters (see "Module Parameters") */ | |
219 | /* SNDRV_CARDS: maximum number of cards supported by this module */ | |
220 | static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; | |
221 | static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; | |
222 | static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; | |
223 | ||
224 | /* definition of the chip-specific record */ | |
225 | struct mychip { | |
226 | struct snd_card *card; | |
227 | /* the rest of the implementation will be in section | |
228 | * "PCI Resource Management" | |
229 | */ | |
230 | }; | |
231 | ||
232 | /* chip-specific destructor | |
233 | * (see "PCI Resource Management") | |
234 | */ | |
235 | static int snd_mychip_free(struct mychip *chip) | |
236 | { | |
237 | .... /* will be implemented later... */ | |
238 | } | |
239 | ||
240 | /* component-destructor | |
241 | * (see "Management of Cards and Components") | |
242 | */ | |
243 | static int snd_mychip_dev_free(struct snd_device *device) | |
244 | { | |
245 | return snd_mychip_free(device->device_data); | |
246 | } | |
247 | ||
248 | /* chip-specific constructor | |
249 | * (see "Management of Cards and Components") | |
250 | */ | |
251 | static int snd_mychip_create(struct snd_card *card, | |
252 | struct pci_dev *pci, | |
253 | struct mychip **rchip) | |
254 | { | |
255 | struct mychip *chip; | |
256 | int err; | |
e382d7fc | 257 | static const struct snd_device_ops ops = { |
7ddedebb TI |
258 | .dev_free = snd_mychip_dev_free, |
259 | }; | |
260 | ||
261 | *rchip = NULL; | |
262 | ||
263 | /* check PCI availability here | |
264 | * (see "PCI Resource Management") | |
265 | */ | |
266 | .... | |
267 | ||
268 | /* allocate a chip-specific data with zero filled */ | |
269 | chip = kzalloc(sizeof(*chip), GFP_KERNEL); | |
270 | if (chip == NULL) | |
271 | return -ENOMEM; | |
272 | ||
273 | chip->card = card; | |
274 | ||
275 | /* rest of initialization here; will be implemented | |
276 | * later, see "PCI Resource Management" | |
277 | */ | |
278 | .... | |
279 | ||
280 | err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops); | |
281 | if (err < 0) { | |
282 | snd_mychip_free(chip); | |
283 | return err; | |
284 | } | |
285 | ||
286 | *rchip = chip; | |
287 | return 0; | |
288 | } | |
289 | ||
290 | /* constructor -- see "Driver Constructor" sub-section */ | |
291 | static int snd_mychip_probe(struct pci_dev *pci, | |
292 | const struct pci_device_id *pci_id) | |
293 | { | |
294 | static int dev; | |
295 | struct snd_card *card; | |
296 | struct mychip *chip; | |
297 | int err; | |
298 | ||
299 | /* (1) */ | |
300 | if (dev >= SNDRV_CARDS) | |
301 | return -ENODEV; | |
302 | if (!enable[dev]) { | |
303 | dev++; | |
304 | return -ENOENT; | |
305 | } | |
306 | ||
307 | /* (2) */ | |
308 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
309 | 0, &card); | |
310 | if (err < 0) | |
311 | return err; | |
312 | ||
313 | /* (3) */ | |
314 | err = snd_mychip_create(card, pci, &chip); | |
f90afe79 TI |
315 | if (err < 0) |
316 | goto error; | |
7ddedebb TI |
317 | |
318 | /* (4) */ | |
319 | strcpy(card->driver, "My Chip"); | |
320 | strcpy(card->shortname, "My Own Chip 123"); | |
321 | sprintf(card->longname, "%s at 0x%lx irq %i", | |
4b81dad1 | 322 | card->shortname, chip->port, chip->irq); |
7ddedebb TI |
323 | |
324 | /* (5) */ | |
325 | .... /* implemented later */ | |
326 | ||
327 | /* (6) */ | |
328 | err = snd_card_register(card); | |
f90afe79 TI |
329 | if (err < 0) |
330 | goto error; | |
7ddedebb TI |
331 | |
332 | /* (7) */ | |
333 | pci_set_drvdata(pci, card); | |
334 | dev++; | |
335 | return 0; | |
f90afe79 TI |
336 | |
337 | error: | |
338 | snd_card_free(card); | |
4d421eeb | 339 | return err; |
7ddedebb TI |
340 | } |
341 | ||
342 | /* destructor -- see the "Destructor" sub-section */ | |
343 | static void snd_mychip_remove(struct pci_dev *pci) | |
344 | { | |
345 | snd_card_free(pci_get_drvdata(pci)); | |
7ddedebb TI |
346 | } |
347 | ||
348 | ||
349 | ||
350 | Driver Constructor | |
351 | ------------------ | |
352 | ||
353 | The real constructor of PCI drivers is the ``probe`` callback. The | |
354 | ``probe`` callback and other component-constructors which are called | |
355 | from the ``probe`` callback cannot be used with the ``__init`` prefix | |
356 | because any PCI device could be a hotplug device. | |
357 | ||
358 | In the ``probe`` callback, the following scheme is often used. | |
359 | ||
360 | 1) Check and increment the device index. | |
361 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
362 | ||
363 | :: | |
364 | ||
365 | static int dev; | |
366 | .... | |
367 | if (dev >= SNDRV_CARDS) | |
368 | return -ENODEV; | |
369 | if (!enable[dev]) { | |
370 | dev++; | |
371 | return -ENOENT; | |
372 | } | |
373 | ||
374 | ||
375 | where ``enable[dev]`` is the module option. | |
376 | ||
377 | Each time the ``probe`` callback is called, check the availability of | |
378 | the device. If not available, simply increment the device index and | |
4d421eeb | 379 | return. dev will be incremented also later (`step 7 |
4f8af077 | 380 | <7) Set the PCI driver data and return zero._>`__). |
7ddedebb TI |
381 | |
382 | 2) Create a card instance | |
383 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
384 | ||
385 | :: | |
386 | ||
387 | struct snd_card *card; | |
388 | int err; | |
389 | .... | |
390 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
391 | 0, &card); | |
392 | ||
393 | ||
394 | The details will be explained in the section `Management of Cards and | |
395 | Components`_. | |
396 | ||
397 | 3) Create a main component | |
398 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
399 | ||
4d421eeb | 400 | In this part, the PCI resources are allocated:: |
7ddedebb TI |
401 | |
402 | struct mychip *chip; | |
403 | .... | |
404 | err = snd_mychip_create(card, pci, &chip); | |
f90afe79 TI |
405 | if (err < 0) |
406 | goto error; | |
7ddedebb TI |
407 | |
408 | The details will be explained in the section `PCI Resource | |
409 | Management`_. | |
410 | ||
f90afe79 TI |
411 | When something goes wrong, the probe function needs to deal with the |
412 | error. In this example, we have a single error handling path placed | |
4d421eeb | 413 | at the end of the function:: |
f90afe79 TI |
414 | |
415 | error: | |
416 | snd_card_free(card); | |
4d421eeb | 417 | return err; |
f90afe79 TI |
418 | |
419 | Since each component can be properly freed, the single | |
420 | :c:func:`snd_card_free()` call should suffice in most cases. | |
421 | ||
422 | ||
7ddedebb TI |
423 | 4) Set the driver ID and name strings. |
424 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
425 | ||
426 | :: | |
427 | ||
428 | strcpy(card->driver, "My Chip"); | |
429 | strcpy(card->shortname, "My Own Chip 123"); | |
430 | sprintf(card->longname, "%s at 0x%lx irq %i", | |
4b81dad1 | 431 | card->shortname, chip->port, chip->irq); |
7ddedebb TI |
432 | |
433 | The driver field holds the minimal ID string of the chip. This is used | |
434 | by alsa-lib's configurator, so keep it simple but unique. Even the | |
435 | same driver can have different driver IDs to distinguish the | |
436 | functionality of each chip type. | |
437 | ||
438 | The shortname field is a string shown as more verbose name. The longname | |
439 | field contains the information shown in ``/proc/asound/cards``. | |
440 | ||
441 | 5) Create other components, such as mixer, MIDI, etc. | |
442 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
443 | ||
4f8af077 NP |
444 | Here you define the basic components such as `PCM <PCM Interface_>`__, |
445 | mixer (e.g. `AC97 <API for AC97 Codec_>`__), MIDI (e.g. | |
446 | `MPU-401 <MIDI (MPU401-UART) Interface_>`__), and other interfaces. | |
447 | Also, if you want a `proc file <Proc Interface_>`__, define it here, | |
7ddedebb TI |
448 | too. |
449 | ||
450 | 6) Register the card instance. | |
451 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
452 | ||
453 | :: | |
454 | ||
455 | err = snd_card_register(card); | |
f90afe79 TI |
456 | if (err < 0) |
457 | goto error; | |
7ddedebb TI |
458 | |
459 | Will be explained in the section `Management of Cards and | |
460 | Components`_, too. | |
461 | ||
462 | 7) Set the PCI driver data and return zero. | |
463 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
464 | ||
465 | :: | |
466 | ||
467 | pci_set_drvdata(pci, card); | |
468 | dev++; | |
469 | return 0; | |
470 | ||
471 | In the above, the card record is stored. This pointer is used in the | |
472 | remove callback and power-management callbacks, too. | |
473 | ||
474 | Destructor | |
475 | ---------- | |
476 | ||
4d421eeb OB |
477 | The destructor, the remove callback, simply releases the card instance. |
478 | Then the ALSA middle layer will release all the attached components | |
7ddedebb TI |
479 | automatically. |
480 | ||
4d421eeb | 481 | It would be typically just calling :c:func:`snd_card_free()`:: |
7ddedebb TI |
482 | |
483 | static void snd_mychip_remove(struct pci_dev *pci) | |
484 | { | |
485 | snd_card_free(pci_get_drvdata(pci)); | |
7ddedebb TI |
486 | } |
487 | ||
488 | ||
489 | The above code assumes that the card pointer is set to the PCI driver | |
490 | data. | |
491 | ||
492 | Header Files | |
493 | ------------ | |
494 | ||
495 | For the above example, at least the following include files are | |
4d421eeb | 496 | necessary:: |
7ddedebb TI |
497 | |
498 | #include <linux/init.h> | |
499 | #include <linux/pci.h> | |
500 | #include <linux/slab.h> | |
501 | #include <sound/core.h> | |
502 | #include <sound/initval.h> | |
503 | ||
504 | where the last one is necessary only when module options are defined | |
505 | in the source file. If the code is split into several files, the files | |
506 | without module options don't need them. | |
507 | ||
508 | In addition to these headers, you'll need ``<linux/interrupt.h>`` for | |
f90afe79 | 509 | interrupt handling, and ``<linux/io.h>`` for I/O access. If you use the |
7ddedebb TI |
510 | :c:func:`mdelay()` or :c:func:`udelay()` functions, you'll need |
511 | to include ``<linux/delay.h>`` too. | |
512 | ||
513 | The ALSA interfaces like the PCM and control APIs are defined in other | |
514 | ``<sound/xxx.h>`` header files. They have to be included after | |
515 | ``<sound/core.h>``. | |
516 | ||
517 | Management of Cards and Components | |
518 | ================================== | |
519 | ||
520 | Card Instance | |
521 | ------------- | |
522 | ||
523 | For each soundcard, a “card” record must be allocated. | |
524 | ||
525 | A card record is the headquarters of the soundcard. It manages the whole | |
526 | list of devices (components) on the soundcard, such as PCM, mixers, | |
527 | MIDI, synthesizer, and so on. Also, the card record holds the ID and the | |
528 | name strings of the card, manages the root of proc files, and controls | |
529 | the power-management states and hotplug disconnections. The component | |
530 | list on the card record is used to manage the correct release of | |
531 | resources at destruction. | |
532 | ||
533 | As mentioned above, to create a card instance, call | |
4d421eeb | 534 | :c:func:`snd_card_new()`:: |
7ddedebb TI |
535 | |
536 | struct snd_card *card; | |
537 | int err; | |
538 | err = snd_card_new(&pci->dev, index, id, module, extra_size, &card); | |
539 | ||
540 | ||
541 | The function takes six arguments: the parent device pointer, the | |
542 | card-index number, the id string, the module pointer (usually | |
543 | ``THIS_MODULE``), the size of extra-data space, and the pointer to | |
544 | return the card instance. The extra_size argument is used to allocate | |
545 | card->private_data for the chip-specific data. Note that these data are | |
546 | allocated by :c:func:`snd_card_new()`. | |
547 | ||
68735902 MCC |
548 | The first argument, the pointer of struct device, specifies the parent |
549 | device. For PCI devices, typically ``&pci->`` is passed there. | |
7ddedebb TI |
550 | |
551 | Components | |
552 | ---------- | |
553 | ||
554 | After the card is created, you can attach the components (devices) to | |
555 | the card instance. In an ALSA driver, a component is represented as a | |
68735902 | 556 | struct snd_device object. A component |
7ddedebb TI |
557 | can be a PCM instance, a control interface, a raw MIDI interface, etc. |
558 | Each such instance has one component entry. | |
559 | ||
4d421eeb OB |
560 | A component can be created via the :c:func:`snd_device_new()` |
561 | function:: | |
7ddedebb TI |
562 | |
563 | snd_device_new(card, SNDRV_DEV_XXX, chip, &ops); | |
564 | ||
565 | This takes the card pointer, the device-level (``SNDRV_DEV_XXX``), the | |
566 | data pointer, and the callback pointers (``&ops``). The device-level | |
567 | defines the type of components and the order of registration and | |
568 | de-registration. For most components, the device-level is already | |
569 | defined. For a user-defined component, you can use | |
570 | ``SNDRV_DEV_LOWLEVEL``. | |
571 | ||
572 | This function itself doesn't allocate the data space. The data must be | |
573 | allocated manually beforehand, and its pointer is passed as the | |
574 | argument. This pointer (``chip`` in the above example) is used as the | |
575 | identifier for the instance. | |
576 | ||
4d421eeb | 577 | Each pre-defined ALSA component such as AC97 and PCM calls |
7ddedebb TI |
578 | :c:func:`snd_device_new()` inside its constructor. The destructor |
579 | for each component is defined in the callback pointers. Hence, you don't | |
580 | need to take care of calling a destructor for such a component. | |
581 | ||
582 | If you wish to create your own component, you need to set the destructor | |
583 | function to the dev_free callback in the ``ops``, so that it can be | |
584 | released automatically via :c:func:`snd_card_free()`. The next | |
585 | example will show an implementation of chip-specific data. | |
586 | ||
587 | Chip-Specific Data | |
588 | ------------------ | |
589 | ||
590 | Chip-specific information, e.g. the I/O port address, its resource | |
4d421eeb | 591 | pointer, or the irq number, is stored in the chip-specific record:: |
7ddedebb TI |
592 | |
593 | struct mychip { | |
594 | .... | |
595 | }; | |
596 | ||
597 | ||
598 | In general, there are two ways of allocating the chip record. | |
599 | ||
600 | 1. Allocating via :c:func:`snd_card_new()`. | |
601 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
602 | ||
603 | As mentioned above, you can pass the extra-data-length to the 5th | |
4d421eeb | 604 | argument of :c:func:`snd_card_new()`, e.g.:: |
7ddedebb TI |
605 | |
606 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
607 | sizeof(struct mychip), &card); | |
608 | ||
68735902 | 609 | struct mychip is the type of the chip record. |
7ddedebb TI |
610 | |
611 | In return, the allocated record can be accessed as | |
612 | ||
613 | :: | |
614 | ||
615 | struct mychip *chip = card->private_data; | |
616 | ||
617 | With this method, you don't have to allocate twice. The record is | |
618 | released together with the card instance. | |
619 | ||
620 | 2. Allocating an extra device. | |
621 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
622 | ||
623 | After allocating a card instance via :c:func:`snd_card_new()` | |
4d421eeb | 624 | (with ``0`` on the 4th arg), call :c:func:`kzalloc()`:: |
7ddedebb TI |
625 | |
626 | struct snd_card *card; | |
627 | struct mychip *chip; | |
628 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
629 | 0, &card); | |
630 | ..... | |
631 | chip = kzalloc(sizeof(*chip), GFP_KERNEL); | |
632 | ||
633 | The chip record should have the field to hold the card pointer at least, | |
634 | ||
635 | :: | |
636 | ||
637 | struct mychip { | |
638 | struct snd_card *card; | |
639 | .... | |
640 | }; | |
641 | ||
642 | ||
4d421eeb | 643 | Then, set the card pointer in the returned chip instance:: |
7ddedebb TI |
644 | |
645 | chip->card = card; | |
646 | ||
647 | Next, initialize the fields, and register this chip record as a | |
4d421eeb | 648 | low-level device with a specified ``ops``:: |
7ddedebb | 649 | |
e382d7fc | 650 | static const struct snd_device_ops ops = { |
7ddedebb TI |
651 | .dev_free = snd_mychip_dev_free, |
652 | }; | |
653 | .... | |
654 | snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops); | |
655 | ||
656 | :c:func:`snd_mychip_dev_free()` is the device-destructor | |
4d421eeb | 657 | function, which will call the real destructor:: |
7ddedebb TI |
658 | |
659 | static int snd_mychip_dev_free(struct snd_device *device) | |
660 | { | |
661 | return snd_mychip_free(device->device_data); | |
662 | } | |
663 | ||
664 | where :c:func:`snd_mychip_free()` is the real destructor. | |
665 | ||
4d421eeb OB |
666 | The demerit of this method is the obviously larger amount of code. |
667 | The merit is, however, that you can trigger your own callback at | |
668 | registering and disconnecting the card via a setting in snd_device_ops. | |
669 | About registering and disconnecting the card, see the subsections | |
f90afe79 TI |
670 | below. |
671 | ||
672 | ||
7ddedebb TI |
673 | Registration and Release |
674 | ------------------------ | |
675 | ||
676 | After all components are assigned, register the card instance by calling | |
677 | :c:func:`snd_card_register()`. Access to the device files is | |
678 | enabled at this point. That is, before | |
679 | :c:func:`snd_card_register()` is called, the components are safely | |
680 | inaccessible from external side. If this call fails, exit the probe | |
681 | function after releasing the card via :c:func:`snd_card_free()`. | |
682 | ||
683 | For releasing the card instance, you can call simply | |
684 | :c:func:`snd_card_free()`. As mentioned earlier, all components | |
685 | are released automatically by this call. | |
686 | ||
687 | For a device which allows hotplugging, you can use | |
688 | :c:func:`snd_card_free_when_closed()`. This one will postpone | |
689 | the destruction until all devices are closed. | |
690 | ||
691 | PCI Resource Management | |
692 | ======================= | |
693 | ||
694 | Full Code Example | |
695 | ----------------- | |
696 | ||
697 | In this section, we'll complete the chip-specific constructor, | |
4d421eeb | 698 | destructor and PCI entries. Example code is shown first, below:: |
7ddedebb TI |
699 | |
700 | struct mychip { | |
701 | struct snd_card *card; | |
702 | struct pci_dev *pci; | |
703 | ||
704 | unsigned long port; | |
705 | int irq; | |
706 | }; | |
707 | ||
708 | static int snd_mychip_free(struct mychip *chip) | |
709 | { | |
710 | /* disable hardware here if any */ | |
711 | .... /* (not implemented in this document) */ | |
712 | ||
713 | /* release the irq */ | |
714 | if (chip->irq >= 0) | |
715 | free_irq(chip->irq, chip); | |
716 | /* release the I/O ports & memory */ | |
717 | pci_release_regions(chip->pci); | |
718 | /* disable the PCI entry */ | |
719 | pci_disable_device(chip->pci); | |
720 | /* release the data */ | |
721 | kfree(chip); | |
722 | return 0; | |
723 | } | |
724 | ||
725 | /* chip-specific constructor */ | |
726 | static int snd_mychip_create(struct snd_card *card, | |
727 | struct pci_dev *pci, | |
728 | struct mychip **rchip) | |
729 | { | |
730 | struct mychip *chip; | |
731 | int err; | |
e382d7fc | 732 | static const struct snd_device_ops ops = { |
7ddedebb TI |
733 | .dev_free = snd_mychip_dev_free, |
734 | }; | |
735 | ||
736 | *rchip = NULL; | |
737 | ||
738 | /* initialize the PCI entry */ | |
739 | err = pci_enable_device(pci); | |
740 | if (err < 0) | |
741 | return err; | |
742 | /* check PCI availability (28bit DMA) */ | |
743 | if (pci_set_dma_mask(pci, DMA_BIT_MASK(28)) < 0 || | |
744 | pci_set_consistent_dma_mask(pci, DMA_BIT_MASK(28)) < 0) { | |
745 | printk(KERN_ERR "error to set 28bit mask DMA\n"); | |
746 | pci_disable_device(pci); | |
747 | return -ENXIO; | |
748 | } | |
749 | ||
750 | chip = kzalloc(sizeof(*chip), GFP_KERNEL); | |
751 | if (chip == NULL) { | |
752 | pci_disable_device(pci); | |
753 | return -ENOMEM; | |
754 | } | |
755 | ||
756 | /* initialize the stuff */ | |
757 | chip->card = card; | |
758 | chip->pci = pci; | |
759 | chip->irq = -1; | |
760 | ||
761 | /* (1) PCI resource allocation */ | |
762 | err = pci_request_regions(pci, "My Chip"); | |
763 | if (err < 0) { | |
764 | kfree(chip); | |
765 | pci_disable_device(pci); | |
766 | return err; | |
767 | } | |
768 | chip->port = pci_resource_start(pci, 0); | |
769 | if (request_irq(pci->irq, snd_mychip_interrupt, | |
770 | IRQF_SHARED, KBUILD_MODNAME, chip)) { | |
771 | printk(KERN_ERR "cannot grab irq %d\n", pci->irq); | |
772 | snd_mychip_free(chip); | |
773 | return -EBUSY; | |
774 | } | |
775 | chip->irq = pci->irq; | |
94722e74 | 776 | card->sync_irq = chip->irq; |
7ddedebb TI |
777 | |
778 | /* (2) initialization of the chip hardware */ | |
779 | .... /* (not implemented in this document) */ | |
780 | ||
781 | err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops); | |
782 | if (err < 0) { | |
783 | snd_mychip_free(chip); | |
784 | return err; | |
785 | } | |
786 | ||
787 | *rchip = chip; | |
788 | return 0; | |
789 | } | |
790 | ||
791 | /* PCI IDs */ | |
792 | static struct pci_device_id snd_mychip_ids[] = { | |
793 | { PCI_VENDOR_ID_FOO, PCI_DEVICE_ID_BAR, | |
794 | PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0, }, | |
795 | .... | |
796 | { 0, } | |
797 | }; | |
798 | MODULE_DEVICE_TABLE(pci, snd_mychip_ids); | |
799 | ||
800 | /* pci_driver definition */ | |
801 | static struct pci_driver driver = { | |
802 | .name = KBUILD_MODNAME, | |
803 | .id_table = snd_mychip_ids, | |
804 | .probe = snd_mychip_probe, | |
805 | .remove = snd_mychip_remove, | |
806 | }; | |
807 | ||
808 | /* module initialization */ | |
809 | static int __init alsa_card_mychip_init(void) | |
810 | { | |
811 | return pci_register_driver(&driver); | |
812 | } | |
813 | ||
814 | /* module clean up */ | |
815 | static void __exit alsa_card_mychip_exit(void) | |
816 | { | |
817 | pci_unregister_driver(&driver); | |
818 | } | |
819 | ||
820 | module_init(alsa_card_mychip_init) | |
821 | module_exit(alsa_card_mychip_exit) | |
822 | ||
823 | EXPORT_NO_SYMBOLS; /* for old kernels only */ | |
824 | ||
825 | Some Hafta's | |
826 | ------------ | |
827 | ||
828 | The allocation of PCI resources is done in the ``probe`` function, and | |
829 | usually an extra :c:func:`xxx_create()` function is written for this | |
830 | purpose. | |
831 | ||
832 | In the case of PCI devices, you first have to call the | |
833 | :c:func:`pci_enable_device()` function before allocating | |
834 | resources. Also, you need to set the proper PCI DMA mask to limit the | |
835 | accessed I/O range. In some cases, you might need to call | |
836 | :c:func:`pci_set_master()` function, too. | |
837 | ||
4d421eeb | 838 | Suppose a 28bit mask, the code to be added would look like:: |
7ddedebb TI |
839 | |
840 | err = pci_enable_device(pci); | |
841 | if (err < 0) | |
842 | return err; | |
843 | if (pci_set_dma_mask(pci, DMA_BIT_MASK(28)) < 0 || | |
844 | pci_set_consistent_dma_mask(pci, DMA_BIT_MASK(28)) < 0) { | |
845 | printk(KERN_ERR "error to set 28bit mask DMA\n"); | |
846 | pci_disable_device(pci); | |
847 | return -ENXIO; | |
848 | } | |
849 | ||
850 | ||
851 | Resource Allocation | |
852 | ------------------- | |
853 | ||
854 | The allocation of I/O ports and irqs is done via standard kernel | |
f90afe79 TI |
855 | functions. These resources must be released in the destructor |
856 | function (see below). | |
7ddedebb TI |
857 | |
858 | Now assume that the PCI device has an I/O port with 8 bytes and an | |
68735902 | 859 | interrupt. Then struct mychip will have the |
4d421eeb | 860 | following fields:: |
7ddedebb TI |
861 | |
862 | struct mychip { | |
863 | struct snd_card *card; | |
864 | ||
865 | unsigned long port; | |
866 | int irq; | |
867 | }; | |
868 | ||
869 | ||
870 | For an I/O port (and also a memory region), you need to have the | |
871 | resource pointer for the standard resource management. For an irq, you | |
872 | have to keep only the irq number (integer). But you need to initialize | |
4d421eeb | 873 | this number to -1 before actual allocation, since irq 0 is valid. The |
7ddedebb TI |
874 | port address and its resource pointer can be initialized as null by |
875 | :c:func:`kzalloc()` automatically, so you don't have to take care of | |
876 | resetting them. | |
877 | ||
4d421eeb | 878 | The allocation of an I/O port is done like this:: |
7ddedebb TI |
879 | |
880 | err = pci_request_regions(pci, "My Chip"); | |
881 | if (err < 0) { | |
882 | kfree(chip); | |
883 | pci_disable_device(pci); | |
884 | return err; | |
885 | } | |
886 | chip->port = pci_resource_start(pci, 0); | |
887 | ||
888 | It will reserve the I/O port region of 8 bytes of the given PCI device. | |
889 | The returned value, ``chip->res_port``, is allocated via | |
890 | :c:func:`kmalloc()` by :c:func:`request_region()`. The pointer | |
891 | must be released via :c:func:`kfree()`, but there is a problem with | |
892 | this. This issue will be explained later. | |
893 | ||
4d421eeb | 894 | The allocation of an interrupt source is done like this:: |
7ddedebb TI |
895 | |
896 | if (request_irq(pci->irq, snd_mychip_interrupt, | |
897 | IRQF_SHARED, KBUILD_MODNAME, chip)) { | |
898 | printk(KERN_ERR "cannot grab irq %d\n", pci->irq); | |
899 | snd_mychip_free(chip); | |
900 | return -EBUSY; | |
901 | } | |
902 | chip->irq = pci->irq; | |
903 | ||
904 | where :c:func:`snd_mychip_interrupt()` is the interrupt handler | |
4f8af077 | 905 | defined `later <PCM Interrupt Handler_>`__. Note that |
7ddedebb TI |
906 | ``chip->irq`` should be defined only when :c:func:`request_irq()` |
907 | succeeded. | |
908 | ||
909 | On the PCI bus, interrupts can be shared. Thus, ``IRQF_SHARED`` is used | |
910 | as the interrupt flag of :c:func:`request_irq()`. | |
911 | ||
912 | The last argument of :c:func:`request_irq()` is the data pointer | |
913 | passed to the interrupt handler. Usually, the chip-specific record is | |
914 | used for that, but you can use what you like, too. | |
915 | ||
916 | I won't give details about the interrupt handler at this point, but at | |
917 | least its appearance can be explained now. The interrupt handler looks | |
4d421eeb | 918 | usually as follows:: |
7ddedebb TI |
919 | |
920 | static irqreturn_t snd_mychip_interrupt(int irq, void *dev_id) | |
921 | { | |
922 | struct mychip *chip = dev_id; | |
923 | .... | |
924 | return IRQ_HANDLED; | |
925 | } | |
926 | ||
94722e74 | 927 | After requesting the IRQ, you can passed it to ``card->sync_irq`` |
4d421eeb | 928 | field:: |
94722e74 TI |
929 | |
930 | card->irq = chip->irq; | |
931 | ||
4d421eeb OB |
932 | This allows the PCM core to automatically call |
933 | :c:func:`synchronize_irq()` at the right time, like before ``hw_free``. | |
94722e74 | 934 | See the later section `sync_stop callback`_ for details. |
7ddedebb TI |
935 | |
936 | Now let's write the corresponding destructor for the resources above. | |
937 | The role of destructor is simple: disable the hardware (if already | |
938 | activated) and release the resources. So far, we have no hardware part, | |
939 | so the disabling code is not written here. | |
940 | ||
941 | To release the resources, the “check-and-release” method is a safer way. | |
4d421eeb | 942 | For the interrupt, do like this:: |
7ddedebb TI |
943 | |
944 | if (chip->irq >= 0) | |
945 | free_irq(chip->irq, chip); | |
946 | ||
947 | Since the irq number can start from 0, you should initialize | |
948 | ``chip->irq`` with a negative value (e.g. -1), so that you can check | |
949 | the validity of the irq number as above. | |
950 | ||
951 | When you requested I/O ports or memory regions via | |
952 | :c:func:`pci_request_region()` or | |
953 | :c:func:`pci_request_regions()` like in this example, release the | |
954 | resource(s) using the corresponding function, | |
955 | :c:func:`pci_release_region()` or | |
4d421eeb | 956 | :c:func:`pci_release_regions()`:: |
7ddedebb TI |
957 | |
958 | pci_release_regions(chip->pci); | |
959 | ||
960 | When you requested manually via :c:func:`request_region()` or | |
961 | :c:func:`request_mem_region()`, you can release it via | |
962 | :c:func:`release_resource()`. Suppose that you keep the resource | |
963 | pointer returned from :c:func:`request_region()` in | |
4d421eeb | 964 | chip->res_port, the release procedure looks like:: |
7ddedebb TI |
965 | |
966 | release_and_free_resource(chip->res_port); | |
967 | ||
968 | Don't forget to call :c:func:`pci_disable_device()` before the | |
969 | end. | |
970 | ||
4d421eeb | 971 | And finally, release the chip-specific record:: |
7ddedebb TI |
972 | |
973 | kfree(chip); | |
974 | ||
4d421eeb | 975 | We didn't implement the hardware disabling part above. If you |
7ddedebb TI |
976 | need to do this, please note that the destructor may be called even |
977 | before the initialization of the chip is completed. It would be better | |
978 | to have a flag to skip hardware disabling if the hardware was not | |
979 | initialized yet. | |
980 | ||
981 | When the chip-data is assigned to the card using | |
4d421eeb OB |
982 | :c:func:`snd_device_new()` with ``SNDRV_DEV_LOWLELVEL``, its |
983 | destructor is called last. That is, it is assured that all other | |
7ddedebb TI |
984 | components like PCMs and controls have already been released. You don't |
985 | have to stop PCMs, etc. explicitly, but just call low-level hardware | |
986 | stopping. | |
987 | ||
988 | The management of a memory-mapped region is almost as same as the | |
4d421eeb | 989 | management of an I/O port. You'll need two fields as follows:: |
7ddedebb TI |
990 | |
991 | struct mychip { | |
992 | .... | |
993 | unsigned long iobase_phys; | |
994 | void __iomem *iobase_virt; | |
995 | }; | |
996 | ||
4d421eeb | 997 | and the allocation would look like below:: |
7ddedebb | 998 | |
f90afe79 TI |
999 | err = pci_request_regions(pci, "My Chip"); |
1000 | if (err < 0) { | |
7ddedebb TI |
1001 | kfree(chip); |
1002 | return err; | |
1003 | } | |
1004 | chip->iobase_phys = pci_resource_start(pci, 0); | |
4bdc0d67 | 1005 | chip->iobase_virt = ioremap(chip->iobase_phys, |
7ddedebb TI |
1006 | pci_resource_len(pci, 0)); |
1007 | ||
4d421eeb | 1008 | and the corresponding destructor would be:: |
7ddedebb TI |
1009 | |
1010 | static int snd_mychip_free(struct mychip *chip) | |
1011 | { | |
1012 | .... | |
1013 | if (chip->iobase_virt) | |
1014 | iounmap(chip->iobase_virt); | |
1015 | .... | |
1016 | pci_release_regions(chip->pci); | |
1017 | .... | |
1018 | } | |
1019 | ||
f90afe79 | 1020 | Of course, a modern way with :c:func:`pci_iomap()` will make things a |
4d421eeb | 1021 | bit easier, too:: |
f90afe79 TI |
1022 | |
1023 | err = pci_request_regions(pci, "My Chip"); | |
1024 | if (err < 0) { | |
1025 | kfree(chip); | |
1026 | return err; | |
1027 | } | |
1028 | chip->iobase_virt = pci_iomap(pci, 0, 0); | |
1029 | ||
1030 | which is paired with :c:func:`pci_iounmap()` at destructor. | |
1031 | ||
1032 | ||
7ddedebb TI |
1033 | PCI Entries |
1034 | ----------- | |
1035 | ||
1036 | So far, so good. Let's finish the missing PCI stuff. At first, we need a | |
68735902 | 1037 | struct pci_device_id table for |
7ddedebb TI |
1038 | this chipset. It's a table of PCI vendor/device ID number, and some |
1039 | masks. | |
1040 | ||
4d421eeb | 1041 | For example:: |
7ddedebb TI |
1042 | |
1043 | static struct pci_device_id snd_mychip_ids[] = { | |
1044 | { PCI_VENDOR_ID_FOO, PCI_DEVICE_ID_BAR, | |
1045 | PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0, }, | |
1046 | .... | |
1047 | { 0, } | |
1048 | }; | |
1049 | MODULE_DEVICE_TABLE(pci, snd_mychip_ids); | |
1050 | ||
68735902 MCC |
1051 | The first and second fields of the struct pci_device_id are the vendor |
1052 | and device IDs. If you have no reason to filter the matching devices, you can | |
1053 | leave the remaining fields as above. The last field of the | |
1054 | struct pci_device_id contains private data for this entry. You can specify | |
1055 | any value here, for example, to define specific operations for supported | |
1056 | device IDs. Such an example is found in the intel8x0 driver. | |
7ddedebb TI |
1057 | |
1058 | The last entry of this list is the terminator. You must specify this | |
1059 | all-zero entry. | |
1060 | ||
68735902 | 1061 | Then, prepare the struct pci_driver |
4d421eeb | 1062 | record:: |
7ddedebb TI |
1063 | |
1064 | static struct pci_driver driver = { | |
1065 | .name = KBUILD_MODNAME, | |
1066 | .id_table = snd_mychip_ids, | |
1067 | .probe = snd_mychip_probe, | |
1068 | .remove = snd_mychip_remove, | |
1069 | }; | |
1070 | ||
1071 | The ``probe`` and ``remove`` functions have already been defined in | |
1072 | the previous sections. The ``name`` field is the name string of this | |
4d421eeb | 1073 | device. Note that you must not use slashes (“/”) in this string. |
7ddedebb | 1074 | |
4d421eeb | 1075 | And at last, the module entries:: |
7ddedebb TI |
1076 | |
1077 | static int __init alsa_card_mychip_init(void) | |
1078 | { | |
1079 | return pci_register_driver(&driver); | |
1080 | } | |
1081 | ||
1082 | static void __exit alsa_card_mychip_exit(void) | |
1083 | { | |
1084 | pci_unregister_driver(&driver); | |
1085 | } | |
1086 | ||
1087 | module_init(alsa_card_mychip_init) | |
1088 | module_exit(alsa_card_mychip_exit) | |
1089 | ||
1090 | Note that these module entries are tagged with ``__init`` and ``__exit`` | |
1091 | prefixes. | |
1092 | ||
7ddedebb TI |
1093 | That's all! |
1094 | ||
1095 | PCM Interface | |
1096 | ============= | |
1097 | ||
1098 | General | |
1099 | ------- | |
1100 | ||
1101 | The PCM middle layer of ALSA is quite powerful and it is only necessary | |
1102 | for each driver to implement the low-level functions to access its | |
1103 | hardware. | |
1104 | ||
4d421eeb | 1105 | To access the PCM layer, you need to include ``<sound/pcm.h>`` |
7ddedebb | 1106 | first. In addition, ``<sound/pcm_params.h>`` might be needed if you |
4d421eeb | 1107 | access some functions related with hw_param. |
7ddedebb | 1108 | |
4d421eeb OB |
1109 | Each card device can have up to four PCM instances. A PCM instance |
1110 | corresponds to a PCM device file. The limitation of number of instances | |
1111 | comes only from the available bit size of Linux' device numbers. | |
1112 | Once 64bit device numbers are used, we'll have more PCM instances | |
7ddedebb TI |
1113 | available. |
1114 | ||
4d421eeb OB |
1115 | A PCM instance consists of PCM playback and capture streams, and each |
1116 | PCM stream consists of one or more PCM substreams. Some soundcards | |
7ddedebb TI |
1117 | support multiple playback functions. For example, emu10k1 has a PCM |
1118 | playback of 32 stereo substreams. In this case, at each open, a free | |
1119 | substream is (usually) automatically chosen and opened. Meanwhile, when | |
4d421eeb | 1120 | only one substream exists and it was already opened, a subsequent open |
7ddedebb TI |
1121 | will either block or error with ``EAGAIN`` according to the file open |
1122 | mode. But you don't have to care about such details in your driver. The | |
1123 | PCM middle layer will take care of such work. | |
1124 | ||
1125 | Full Code Example | |
1126 | ----------------- | |
1127 | ||
1128 | The example code below does not include any hardware access routines but | |
4d421eeb | 1129 | shows only the skeleton, how to build up the PCM interfaces:: |
7ddedebb TI |
1130 | |
1131 | #include <sound/pcm.h> | |
1132 | .... | |
1133 | ||
1134 | /* hardware definition */ | |
1135 | static struct snd_pcm_hardware snd_mychip_playback_hw = { | |
1136 | .info = (SNDRV_PCM_INFO_MMAP | | |
1137 | SNDRV_PCM_INFO_INTERLEAVED | | |
1138 | SNDRV_PCM_INFO_BLOCK_TRANSFER | | |
1139 | SNDRV_PCM_INFO_MMAP_VALID), | |
1140 | .formats = SNDRV_PCM_FMTBIT_S16_LE, | |
1141 | .rates = SNDRV_PCM_RATE_8000_48000, | |
1142 | .rate_min = 8000, | |
1143 | .rate_max = 48000, | |
1144 | .channels_min = 2, | |
1145 | .channels_max = 2, | |
1146 | .buffer_bytes_max = 32768, | |
1147 | .period_bytes_min = 4096, | |
1148 | .period_bytes_max = 32768, | |
1149 | .periods_min = 1, | |
1150 | .periods_max = 1024, | |
1151 | }; | |
1152 | ||
1153 | /* hardware definition */ | |
1154 | static struct snd_pcm_hardware snd_mychip_capture_hw = { | |
1155 | .info = (SNDRV_PCM_INFO_MMAP | | |
1156 | SNDRV_PCM_INFO_INTERLEAVED | | |
1157 | SNDRV_PCM_INFO_BLOCK_TRANSFER | | |
1158 | SNDRV_PCM_INFO_MMAP_VALID), | |
1159 | .formats = SNDRV_PCM_FMTBIT_S16_LE, | |
1160 | .rates = SNDRV_PCM_RATE_8000_48000, | |
1161 | .rate_min = 8000, | |
1162 | .rate_max = 48000, | |
1163 | .channels_min = 2, | |
1164 | .channels_max = 2, | |
1165 | .buffer_bytes_max = 32768, | |
1166 | .period_bytes_min = 4096, | |
1167 | .period_bytes_max = 32768, | |
1168 | .periods_min = 1, | |
1169 | .periods_max = 1024, | |
1170 | }; | |
1171 | ||
1172 | /* open callback */ | |
1173 | static int snd_mychip_playback_open(struct snd_pcm_substream *substream) | |
1174 | { | |
1175 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1176 | struct snd_pcm_runtime *runtime = substream->runtime; | |
1177 | ||
1178 | runtime->hw = snd_mychip_playback_hw; | |
1179 | /* more hardware-initialization will be done here */ | |
1180 | .... | |
1181 | return 0; | |
1182 | } | |
1183 | ||
1184 | /* close callback */ | |
1185 | static int snd_mychip_playback_close(struct snd_pcm_substream *substream) | |
1186 | { | |
1187 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1188 | /* the hardware-specific codes will be here */ | |
1189 | .... | |
1190 | return 0; | |
1191 | ||
1192 | } | |
1193 | ||
1194 | /* open callback */ | |
1195 | static int snd_mychip_capture_open(struct snd_pcm_substream *substream) | |
1196 | { | |
1197 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1198 | struct snd_pcm_runtime *runtime = substream->runtime; | |
1199 | ||
1200 | runtime->hw = snd_mychip_capture_hw; | |
1201 | /* more hardware-initialization will be done here */ | |
1202 | .... | |
1203 | return 0; | |
1204 | } | |
1205 | ||
1206 | /* close callback */ | |
1207 | static int snd_mychip_capture_close(struct snd_pcm_substream *substream) | |
1208 | { | |
1209 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1210 | /* the hardware-specific codes will be here */ | |
1211 | .... | |
1212 | return 0; | |
7ddedebb TI |
1213 | } |
1214 | ||
1215 | /* hw_params callback */ | |
1216 | static int snd_mychip_pcm_hw_params(struct snd_pcm_substream *substream, | |
1217 | struct snd_pcm_hw_params *hw_params) | |
1218 | { | |
72b4bcbf TI |
1219 | /* the hardware-specific codes will be here */ |
1220 | .... | |
1221 | return 0; | |
7ddedebb TI |
1222 | } |
1223 | ||
1224 | /* hw_free callback */ | |
1225 | static int snd_mychip_pcm_hw_free(struct snd_pcm_substream *substream) | |
1226 | { | |
72b4bcbf TI |
1227 | /* the hardware-specific codes will be here */ |
1228 | .... | |
1229 | return 0; | |
7ddedebb TI |
1230 | } |
1231 | ||
1232 | /* prepare callback */ | |
1233 | static int snd_mychip_pcm_prepare(struct snd_pcm_substream *substream) | |
1234 | { | |
1235 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1236 | struct snd_pcm_runtime *runtime = substream->runtime; | |
1237 | ||
1238 | /* set up the hardware with the current configuration | |
1239 | * for example... | |
1240 | */ | |
1241 | mychip_set_sample_format(chip, runtime->format); | |
1242 | mychip_set_sample_rate(chip, runtime->rate); | |
1243 | mychip_set_channels(chip, runtime->channels); | |
1244 | mychip_set_dma_setup(chip, runtime->dma_addr, | |
1245 | chip->buffer_size, | |
1246 | chip->period_size); | |
1247 | return 0; | |
1248 | } | |
1249 | ||
1250 | /* trigger callback */ | |
1251 | static int snd_mychip_pcm_trigger(struct snd_pcm_substream *substream, | |
1252 | int cmd) | |
1253 | { | |
1254 | switch (cmd) { | |
1255 | case SNDRV_PCM_TRIGGER_START: | |
1256 | /* do something to start the PCM engine */ | |
1257 | .... | |
1258 | break; | |
1259 | case SNDRV_PCM_TRIGGER_STOP: | |
1260 | /* do something to stop the PCM engine */ | |
1261 | .... | |
1262 | break; | |
1263 | default: | |
1264 | return -EINVAL; | |
1265 | } | |
1266 | } | |
1267 | ||
1268 | /* pointer callback */ | |
1269 | static snd_pcm_uframes_t | |
1270 | snd_mychip_pcm_pointer(struct snd_pcm_substream *substream) | |
1271 | { | |
1272 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1273 | unsigned int current_ptr; | |
1274 | ||
1275 | /* get the current hardware pointer */ | |
1276 | current_ptr = mychip_get_hw_pointer(chip); | |
1277 | return current_ptr; | |
1278 | } | |
1279 | ||
1280 | /* operators */ | |
1281 | static struct snd_pcm_ops snd_mychip_playback_ops = { | |
1282 | .open = snd_mychip_playback_open, | |
1283 | .close = snd_mychip_playback_close, | |
7ddedebb TI |
1284 | .hw_params = snd_mychip_pcm_hw_params, |
1285 | .hw_free = snd_mychip_pcm_hw_free, | |
1286 | .prepare = snd_mychip_pcm_prepare, | |
1287 | .trigger = snd_mychip_pcm_trigger, | |
1288 | .pointer = snd_mychip_pcm_pointer, | |
1289 | }; | |
1290 | ||
1291 | /* operators */ | |
1292 | static struct snd_pcm_ops snd_mychip_capture_ops = { | |
1293 | .open = snd_mychip_capture_open, | |
1294 | .close = snd_mychip_capture_close, | |
7ddedebb TI |
1295 | .hw_params = snd_mychip_pcm_hw_params, |
1296 | .hw_free = snd_mychip_pcm_hw_free, | |
1297 | .prepare = snd_mychip_pcm_prepare, | |
1298 | .trigger = snd_mychip_pcm_trigger, | |
1299 | .pointer = snd_mychip_pcm_pointer, | |
1300 | }; | |
1301 | ||
1302 | /* | |
1303 | * definitions of capture are omitted here... | |
1304 | */ | |
1305 | ||
1306 | /* create a pcm device */ | |
1307 | static int snd_mychip_new_pcm(struct mychip *chip) | |
1308 | { | |
1309 | struct snd_pcm *pcm; | |
1310 | int err; | |
1311 | ||
1312 | err = snd_pcm_new(chip->card, "My Chip", 0, 1, 1, &pcm); | |
1313 | if (err < 0) | |
1314 | return err; | |
1315 | pcm->private_data = chip; | |
1316 | strcpy(pcm->name, "My Chip"); | |
1317 | chip->pcm = pcm; | |
1318 | /* set operators */ | |
1319 | snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, | |
1320 | &snd_mychip_playback_ops); | |
1321 | snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, | |
1322 | &snd_mychip_capture_ops); | |
1323 | /* pre-allocation of buffers */ | |
1324 | /* NOTE: this may fail */ | |
72b4bcbf TI |
1325 | snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV, |
1326 | &chip->pci->dev, | |
1327 | 64*1024, 64*1024); | |
7ddedebb TI |
1328 | return 0; |
1329 | } | |
1330 | ||
1331 | ||
1332 | PCM Constructor | |
1333 | --------------- | |
1334 | ||
4d421eeb OB |
1335 | A PCM instance is allocated by the :c:func:`snd_pcm_new()` |
1336 | function. It would be better to create a constructor for the PCM, namely:: | |
7ddedebb TI |
1337 | |
1338 | static int snd_mychip_new_pcm(struct mychip *chip) | |
1339 | { | |
1340 | struct snd_pcm *pcm; | |
1341 | int err; | |
1342 | ||
1343 | err = snd_pcm_new(chip->card, "My Chip", 0, 1, 1, &pcm); | |
1344 | if (err < 0) | |
1345 | return err; | |
1346 | pcm->private_data = chip; | |
1347 | strcpy(pcm->name, "My Chip"); | |
1348 | chip->pcm = pcm; | |
4d421eeb | 1349 | ... |
7ddedebb TI |
1350 | return 0; |
1351 | } | |
1352 | ||
4d421eeb OB |
1353 | The :c:func:`snd_pcm_new()` function takes six arguments. The |
1354 | first argument is the card pointer to which this PCM is assigned, and | |
7ddedebb TI |
1355 | the second is the ID string. |
1356 | ||
1357 | The third argument (``index``, 0 in the above) is the index of this new | |
4d421eeb | 1358 | PCM. It begins from zero. If you create more than one PCM instances, |
7ddedebb TI |
1359 | specify the different numbers in this argument. For example, ``index = |
1360 | 1`` for the second PCM device. | |
1361 | ||
1362 | The fourth and fifth arguments are the number of substreams for playback | |
1363 | and capture, respectively. Here 1 is used for both arguments. When no | |
1364 | playback or capture substreams are available, pass 0 to the | |
1365 | corresponding argument. | |
1366 | ||
1367 | If a chip supports multiple playbacks or captures, you can specify more | |
1368 | numbers, but they must be handled properly in open/close, etc. | |
1369 | callbacks. When you need to know which substream you are referring to, | |
68735902 | 1370 | then it can be obtained from struct snd_pcm_substream data passed to each |
4d421eeb | 1371 | callback as follows:: |
7ddedebb TI |
1372 | |
1373 | struct snd_pcm_substream *substream; | |
1374 | int index = substream->number; | |
1375 | ||
1376 | ||
4d421eeb | 1377 | After the PCM is created, you need to set operators for each PCM stream:: |
7ddedebb TI |
1378 | |
1379 | snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, | |
1380 | &snd_mychip_playback_ops); | |
1381 | snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, | |
1382 | &snd_mychip_capture_ops); | |
1383 | ||
4d421eeb | 1384 | The operators are defined typically like this:: |
7ddedebb TI |
1385 | |
1386 | static struct snd_pcm_ops snd_mychip_playback_ops = { | |
1387 | .open = snd_mychip_pcm_open, | |
1388 | .close = snd_mychip_pcm_close, | |
7ddedebb TI |
1389 | .hw_params = snd_mychip_pcm_hw_params, |
1390 | .hw_free = snd_mychip_pcm_hw_free, | |
1391 | .prepare = snd_mychip_pcm_prepare, | |
1392 | .trigger = snd_mychip_pcm_trigger, | |
1393 | .pointer = snd_mychip_pcm_pointer, | |
1394 | }; | |
1395 | ||
1396 | All the callbacks are described in the Operators_ subsection. | |
1397 | ||
1398 | After setting the operators, you probably will want to pre-allocate the | |
72b4bcbf | 1399 | buffer and set up the managed allocation mode. |
4d421eeb | 1400 | For that, simply call the following:: |
7ddedebb | 1401 | |
72b4bcbf TI |
1402 | snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV, |
1403 | &chip->pci->dev, | |
1404 | 64*1024, 64*1024); | |
7ddedebb | 1405 | |
4d421eeb | 1406 | It will allocate a buffer up to 64kB by default. Buffer management |
7ddedebb TI |
1407 | details will be described in the later section `Buffer and Memory |
1408 | Management`_. | |
1409 | ||
4d421eeb | 1410 | Additionally, you can set some extra information for this PCM in |
7ddedebb TI |
1411 | ``pcm->info_flags``. The available values are defined as |
1412 | ``SNDRV_PCM_INFO_XXX`` in ``<sound/asound.h>``, which is used for the | |
1413 | hardware definition (described later). When your soundchip supports only | |
4d421eeb | 1414 | half-duplex, specify it like this:: |
7ddedebb TI |
1415 | |
1416 | pcm->info_flags = SNDRV_PCM_INFO_HALF_DUPLEX; | |
1417 | ||
1418 | ||
1419 | ... And the Destructor? | |
1420 | ----------------------- | |
1421 | ||
4d421eeb | 1422 | The destructor for a PCM instance is not always necessary. Since the PCM |
7ddedebb TI |
1423 | device will be released by the middle layer code automatically, you |
1424 | don't have to call the destructor explicitly. | |
1425 | ||
1426 | The destructor would be necessary if you created special records | |
1427 | internally and needed to release them. In such a case, set the | |
4d421eeb | 1428 | destructor function to ``pcm->private_free``:: |
7ddedebb TI |
1429 | |
1430 | static void mychip_pcm_free(struct snd_pcm *pcm) | |
1431 | { | |
1432 | struct mychip *chip = snd_pcm_chip(pcm); | |
1433 | /* free your own data */ | |
1434 | kfree(chip->my_private_pcm_data); | |
1435 | /* do what you like else */ | |
1436 | .... | |
1437 | } | |
1438 | ||
1439 | static int snd_mychip_new_pcm(struct mychip *chip) | |
1440 | { | |
1441 | struct snd_pcm *pcm; | |
1442 | .... | |
1443 | /* allocate your own data */ | |
1444 | chip->my_private_pcm_data = kmalloc(...); | |
1445 | /* set the destructor */ | |
1446 | pcm->private_data = chip; | |
1447 | pcm->private_free = mychip_pcm_free; | |
1448 | .... | |
1449 | } | |
1450 | ||
1451 | ||
1452 | ||
1453 | Runtime Pointer - The Chest of PCM Information | |
1454 | ---------------------------------------------- | |
1455 | ||
1456 | When the PCM substream is opened, a PCM runtime instance is allocated | |
1457 | and assigned to the substream. This pointer is accessible via | |
1458 | ``substream->runtime``. This runtime pointer holds most information you | |
4d421eeb | 1459 | need to control the PCM: a copy of hw_params and sw_params |
7ddedebb TI |
1460 | configurations, the buffer pointers, mmap records, spinlocks, etc. |
1461 | ||
1462 | The definition of runtime instance is found in ``<sound/pcm.h>``. Here | |
4d421eeb | 1463 | is the relevant part of this file:: |
7ddedebb TI |
1464 | |
1465 | struct _snd_pcm_runtime { | |
1466 | /* -- Status -- */ | |
1467 | struct snd_pcm_substream *trigger_master; | |
1468 | snd_timestamp_t trigger_tstamp; /* trigger timestamp */ | |
1469 | int overrange; | |
1470 | snd_pcm_uframes_t avail_max; | |
1471 | snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */ | |
1472 | snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/ | |
1473 | ||
1474 | /* -- HW params -- */ | |
1475 | snd_pcm_access_t access; /* access mode */ | |
1476 | snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */ | |
1477 | snd_pcm_subformat_t subformat; /* subformat */ | |
1478 | unsigned int rate; /* rate in Hz */ | |
1479 | unsigned int channels; /* channels */ | |
1480 | snd_pcm_uframes_t period_size; /* period size */ | |
1481 | unsigned int periods; /* periods */ | |
1482 | snd_pcm_uframes_t buffer_size; /* buffer size */ | |
1483 | unsigned int tick_time; /* tick time */ | |
1484 | snd_pcm_uframes_t min_align; /* Min alignment for the format */ | |
1485 | size_t byte_align; | |
1486 | unsigned int frame_bits; | |
1487 | unsigned int sample_bits; | |
1488 | unsigned int info; | |
1489 | unsigned int rate_num; | |
1490 | unsigned int rate_den; | |
1491 | ||
1492 | /* -- SW params -- */ | |
1493 | struct timespec tstamp_mode; /* mmap timestamp is updated */ | |
1494 | unsigned int period_step; | |
1495 | unsigned int sleep_min; /* min ticks to sleep */ | |
1496 | snd_pcm_uframes_t start_threshold; | |
9f656705 OB |
1497 | /* |
1498 | * The following two thresholds alleviate playback buffer underruns; when | |
1499 | * hw_avail drops below the threshold, the respective action is triggered: | |
1500 | */ | |
1501 | snd_pcm_uframes_t stop_threshold; /* - stop playback */ | |
1502 | snd_pcm_uframes_t silence_threshold; /* - pre-fill buffer with silence */ | |
1503 | snd_pcm_uframes_t silence_size; /* max size of silence pre-fill; when >= boundary, | |
1504 | * fill played area with silence immediately */ | |
7ddedebb TI |
1505 | snd_pcm_uframes_t boundary; /* pointers wrap point */ |
1506 | ||
9f656705 OB |
1507 | /* internal data of auto-silencer */ |
1508 | snd_pcm_uframes_t silence_start; /* starting pointer to silence area */ | |
1509 | snd_pcm_uframes_t silence_filled; /* size filled with silence */ | |
7ddedebb TI |
1510 | |
1511 | snd_pcm_sync_id_t sync; /* hardware synchronization ID */ | |
1512 | ||
1513 | /* -- mmap -- */ | |
1514 | volatile struct snd_pcm_mmap_status *status; | |
1515 | volatile struct snd_pcm_mmap_control *control; | |
1516 | atomic_t mmap_count; | |
1517 | ||
1518 | /* -- locking / scheduling -- */ | |
1519 | spinlock_t lock; | |
1520 | wait_queue_head_t sleep; | |
1521 | struct timer_list tick_timer; | |
1522 | struct fasync_struct *fasync; | |
1523 | ||
1524 | /* -- private section -- */ | |
1525 | void *private_data; | |
1526 | void (*private_free)(struct snd_pcm_runtime *runtime); | |
1527 | ||
1528 | /* -- hardware description -- */ | |
1529 | struct snd_pcm_hardware hw; | |
1530 | struct snd_pcm_hw_constraints hw_constraints; | |
1531 | ||
1532 | /* -- timer -- */ | |
1533 | unsigned int timer_resolution; /* timer resolution */ | |
1534 | ||
1535 | /* -- DMA -- */ | |
1536 | unsigned char *dma_area; /* DMA area */ | |
1537 | dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */ | |
1538 | size_t dma_bytes; /* size of DMA area */ | |
1539 | ||
1540 | struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */ | |
1541 | ||
1542 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) | |
1543 | /* -- OSS things -- */ | |
1544 | struct snd_pcm_oss_runtime oss; | |
1545 | #endif | |
1546 | }; | |
1547 | ||
1548 | ||
1549 | For the operators (callbacks) of each sound driver, most of these | |
1550 | records are supposed to be read-only. Only the PCM middle-layer changes | |
1551 | / updates them. The exceptions are the hardware description (hw) DMA | |
1552 | buffer information and the private data. Besides, if you use the | |
72b4bcbf | 1553 | standard managed buffer allocation mode, you don't need to set the |
7ddedebb TI |
1554 | DMA buffer information by yourself. |
1555 | ||
1556 | In the sections below, important records are explained. | |
1557 | ||
1558 | Hardware Description | |
1559 | ~~~~~~~~~~~~~~~~~~~~ | |
1560 | ||
68735902 MCC |
1561 | The hardware descriptor (struct snd_pcm_hardware) contains the definitions of |
1562 | the fundamental hardware configuration. Above all, you'll need to define this | |
4d421eeb OB |
1563 | in the `PCM open callback`_. Note that the runtime instance holds a copy of |
1564 | the descriptor, not a pointer to the existing descriptor. That is, | |
7ddedebb TI |
1565 | in the open callback, you can modify the copied descriptor |
1566 | (``runtime->hw``) as you need. For example, if the maximum number of | |
1567 | channels is 1 only on some chip models, you can still use the same | |
4d421eeb | 1568 | hardware descriptor and change the channels_max later:: |
7ddedebb TI |
1569 | |
1570 | struct snd_pcm_runtime *runtime = substream->runtime; | |
1571 | ... | |
1572 | runtime->hw = snd_mychip_playback_hw; /* common definition */ | |
1573 | if (chip->model == VERY_OLD_ONE) | |
1574 | runtime->hw.channels_max = 1; | |
1575 | ||
4d421eeb | 1576 | Typically, you'll have a hardware descriptor as below:: |
7ddedebb TI |
1577 | |
1578 | static struct snd_pcm_hardware snd_mychip_playback_hw = { | |
1579 | .info = (SNDRV_PCM_INFO_MMAP | | |
1580 | SNDRV_PCM_INFO_INTERLEAVED | | |
1581 | SNDRV_PCM_INFO_BLOCK_TRANSFER | | |
1582 | SNDRV_PCM_INFO_MMAP_VALID), | |
1583 | .formats = SNDRV_PCM_FMTBIT_S16_LE, | |
1584 | .rates = SNDRV_PCM_RATE_8000_48000, | |
1585 | .rate_min = 8000, | |
1586 | .rate_max = 48000, | |
1587 | .channels_min = 2, | |
1588 | .channels_max = 2, | |
1589 | .buffer_bytes_max = 32768, | |
1590 | .period_bytes_min = 4096, | |
1591 | .period_bytes_max = 32768, | |
1592 | .periods_min = 1, | |
1593 | .periods_max = 1024, | |
1594 | }; | |
1595 | ||
1596 | - The ``info`` field contains the type and capabilities of this | |
4d421eeb | 1597 | PCM. The bit flags are defined in ``<sound/asound.h>`` as |
7ddedebb | 1598 | ``SNDRV_PCM_INFO_XXX``. Here, at least, you have to specify whether |
4d421eeb | 1599 | mmap is supported and which interleaving formats are |
7ddedebb TI |
1600 | supported. When the hardware supports mmap, add the |
1601 | ``SNDRV_PCM_INFO_MMAP`` flag here. When the hardware supports the | |
4d421eeb | 1602 | interleaved or the non-interleaved formats, the |
7ddedebb TI |
1603 | ``SNDRV_PCM_INFO_INTERLEAVED`` or ``SNDRV_PCM_INFO_NONINTERLEAVED`` |
1604 | flag must be set, respectively. If both are supported, you can set | |
1605 | both, too. | |
1606 | ||
1607 | In the above example, ``MMAP_VALID`` and ``BLOCK_TRANSFER`` are | |
1608 | specified for the OSS mmap mode. Usually both are set. Of course, | |
4d421eeb | 1609 | ``MMAP_VALID`` is set only if mmap is really supported. |
7ddedebb TI |
1610 | |
1611 | The other possible flags are ``SNDRV_PCM_INFO_PAUSE`` and | |
4d421eeb | 1612 | ``SNDRV_PCM_INFO_RESUME``. The ``PAUSE`` bit means that the PCM |
7ddedebb | 1613 | supports the “pause” operation, while the ``RESUME`` bit means that |
4d421eeb | 1614 | the PCM supports the full “suspend/resume” operation. If the |
7ddedebb TI |
1615 | ``PAUSE`` flag is set, the ``trigger`` callback below must handle |
1616 | the corresponding (pause push/release) commands. The suspend/resume | |
1617 | trigger commands can be defined even without the ``RESUME`` | |
4d421eeb | 1618 | flag. See the `Power Management`_ section for details. |
7ddedebb TI |
1619 | |
1620 | When the PCM substreams can be synchronized (typically, | |
4d421eeb | 1621 | synchronized start/stop of a playback and a capture stream), you |
7ddedebb TI |
1622 | can give ``SNDRV_PCM_INFO_SYNC_START``, too. In this case, you'll |
1623 | need to check the linked-list of PCM substreams in the trigger | |
4d421eeb | 1624 | callback. This will be described in a later section. |
7ddedebb | 1625 | |
4d421eeb | 1626 | - The ``formats`` field contains the bit-flags of supported formats |
7ddedebb TI |
1627 | (``SNDRV_PCM_FMTBIT_XXX``). If the hardware supports more than one |
1628 | format, give all or'ed bits. In the example above, the signed 16bit | |
1629 | little-endian format is specified. | |
1630 | ||
4d421eeb | 1631 | - The ``rates`` field contains the bit-flags of supported rates |
7ddedebb | 1632 | (``SNDRV_PCM_RATE_XXX``). When the chip supports continuous rates, |
4d421eeb OB |
1633 | pass the ``CONTINUOUS`` bit additionally. The pre-defined rate bits |
1634 | are provided only for typical rates. If your chip supports | |
7ddedebb TI |
1635 | unconventional rates, you need to add the ``KNOT`` bit and set up |
1636 | the hardware constraint manually (explained later). | |
1637 | ||
1638 | - ``rate_min`` and ``rate_max`` define the minimum and maximum sample | |
1639 | rate. This should correspond somehow to ``rates`` bits. | |
1640 | ||
4d421eeb | 1641 | - ``channels_min`` and ``channels_max`` define, as you might have already |
7ddedebb TI |
1642 | expected, the minimum and maximum number of channels. |
1643 | ||
1644 | - ``buffer_bytes_max`` defines the maximum buffer size in | |
1645 | bytes. There is no ``buffer_bytes_min`` field, since it can be | |
1646 | calculated from the minimum period size and the minimum number of | |
372a0d78 MR |
1647 | periods. Meanwhile, ``period_bytes_min`` and ``period_bytes_max`` |
1648 | define the minimum and maximum size of the period in bytes. | |
1649 | ``periods_max`` and ``periods_min`` define the maximum and minimum | |
1650 | number of periods in the buffer. | |
7ddedebb TI |
1651 | |
1652 | The “period” is a term that corresponds to a fragment in the OSS | |
4d421eeb OB |
1653 | world. The period defines the point at which a PCM interrupt is |
1654 | generated. This point strongly depends on the hardware. Generally, | |
1655 | a smaller period size will give you more interrupts, which results | |
1656 | in being able to fill/drain the buffer more timely. In the case of | |
1657 | capture, this size defines the input latency. On the other hand, | |
1658 | the whole buffer size defines the output latency for the playback | |
1659 | direction. | |
7ddedebb TI |
1660 | |
1661 | - There is also a field ``fifo_size``. This specifies the size of the | |
4d421eeb | 1662 | hardware FIFO, but currently it is neither used by the drivers nor |
7ddedebb TI |
1663 | in the alsa-lib. So, you can ignore this field. |
1664 | ||
1665 | PCM Configurations | |
1666 | ~~~~~~~~~~~~~~~~~~ | |
1667 | ||
1668 | Ok, let's go back again to the PCM runtime records. The most | |
1669 | frequently referred records in the runtime instance are the PCM | |
1670 | configurations. The PCM configurations are stored in the runtime | |
1671 | instance after the application sends ``hw_params`` data via | |
1672 | alsa-lib. There are many fields copied from hw_params and sw_params | |
1673 | structs. For example, ``format`` holds the format type chosen by the | |
1674 | application. This field contains the enum value | |
1675 | ``SNDRV_PCM_FORMAT_XXX``. | |
1676 | ||
1677 | One thing to be noted is that the configured buffer and period sizes | |
1678 | are stored in “frames” in the runtime. In the ALSA world, ``1 frame = | |
1679 | channels \* samples-size``. For conversion between frames and bytes, | |
1680 | you can use the :c:func:`frames_to_bytes()` and | |
4d421eeb | 1681 | :c:func:`bytes_to_frames()` helper functions:: |
7ddedebb TI |
1682 | |
1683 | period_bytes = frames_to_bytes(runtime, runtime->period_size); | |
1684 | ||
1685 | Also, many software parameters (sw_params) are stored in frames, too. | |
4d421eeb OB |
1686 | Please check the type of the field. ``snd_pcm_uframes_t`` is for |
1687 | frames as unsigned integer while ``snd_pcm_sframes_t`` is for | |
7ddedebb TI |
1688 | frames as signed integer. |
1689 | ||
1690 | DMA Buffer Information | |
1691 | ~~~~~~~~~~~~~~~~~~~~~~ | |
1692 | ||
4d421eeb OB |
1693 | The DMA buffer is defined by the following four fields: ``dma_area``, |
1694 | ``dma_addr``, ``dma_bytes`` and ``dma_private``. ``dma_area`` | |
7ddedebb TI |
1695 | holds the buffer pointer (the logical address). You can call |
1696 | :c:func:`memcpy()` from/to this pointer. Meanwhile, ``dma_addr`` holds | |
1697 | the physical address of the buffer. This field is specified only when | |
4d421eeb OB |
1698 | the buffer is a linear buffer. ``dma_bytes`` holds the size of the |
1699 | buffer in bytes. ``dma_private`` is used for the ALSA DMA allocator. | |
7ddedebb | 1700 | |
72b4bcbf TI |
1701 | If you use either the managed buffer allocation mode or the standard |
1702 | API function :c:func:`snd_pcm_lib_malloc_pages()` for allocating the buffer, | |
7ddedebb TI |
1703 | these fields are set by the ALSA middle layer, and you should *not* |
1704 | change them by yourself. You can read them but not write them. On the | |
1705 | other hand, if you want to allocate the buffer by yourself, you'll | |
4d421eeb | 1706 | need to manage it in the hw_params callback. At least, ``dma_bytes`` is |
7ddedebb TI |
1707 | mandatory. ``dma_area`` is necessary when the buffer is mmapped. If |
1708 | your driver doesn't support mmap, this field is not | |
1709 | necessary. ``dma_addr`` is also optional. You can use dma_private as | |
1710 | you like, too. | |
1711 | ||
1712 | Running Status | |
1713 | ~~~~~~~~~~~~~~ | |
1714 | ||
1715 | The running status can be referred via ``runtime->status``. This is | |
4d421eeb | 1716 | a pointer to a struct snd_pcm_mmap_status record. |
68735902 | 1717 | For example, you can get the current |
7ddedebb TI |
1718 | DMA hardware pointer via ``runtime->status->hw_ptr``. |
1719 | ||
1720 | The DMA application pointer can be referred via ``runtime->control``, | |
4d421eeb OB |
1721 | which points to a struct snd_pcm_mmap_control record. |
1722 | However, accessing this value directly is not recommended. | |
7ddedebb TI |
1723 | |
1724 | Private Data | |
1725 | ~~~~~~~~~~~~ | |
1726 | ||
1727 | You can allocate a record for the substream and store it in | |
1728 | ``runtime->private_data``. Usually, this is done in the `PCM open | |
1729 | callback`_. Don't mix this with ``pcm->private_data``. The | |
1730 | ``pcm->private_data`` usually points to the chip instance assigned | |
4d421eeb OB |
1731 | statically at creation time of the PCM device, while |
1732 | ``runtime->private_data`` | |
1733 | points to a dynamic data structure created in the PCM open | |
1734 | callback:: | |
7ddedebb TI |
1735 | |
1736 | static int snd_xxx_open(struct snd_pcm_substream *substream) | |
1737 | { | |
1738 | struct my_pcm_data *data; | |
1739 | .... | |
1740 | data = kmalloc(sizeof(*data), GFP_KERNEL); | |
1741 | substream->runtime->private_data = data; | |
1742 | .... | |
1743 | } | |
1744 | ||
1745 | ||
1746 | The allocated object must be released in the `close callback`_. | |
1747 | ||
1748 | Operators | |
1749 | --------- | |
1750 | ||
4d421eeb | 1751 | OK, now let me give details about each PCM callback (``ops``). In |
7ddedebb TI |
1752 | general, every callback must return 0 if successful, or a negative |
1753 | error number such as ``-EINVAL``. To choose an appropriate error | |
1754 | number, it is advised to check what value other parts of the kernel | |
1755 | return when the same kind of request fails. | |
1756 | ||
4d421eeb | 1757 | Each callback function takes at least one argument containing a |
68735902 | 1758 | struct snd_pcm_substream pointer. To retrieve the chip |
7ddedebb | 1759 | record from the given substream instance, you can use the following |
4d421eeb | 1760 | macro:: |
7ddedebb | 1761 | |
4d421eeb | 1762 | int xxx(...) { |
7ddedebb TI |
1763 | struct mychip *chip = snd_pcm_substream_chip(substream); |
1764 | .... | |
1765 | } | |
1766 | ||
1767 | The macro reads ``substream->private_data``, which is a copy of | |
1768 | ``pcm->private_data``. You can override the former if you need to | |
1769 | assign different data records per PCM substream. For example, the | |
1770 | cmi8330 driver assigns different ``private_data`` for playback and | |
1771 | capture directions, because it uses two different codecs (SB- and | |
1772 | AD-compatible) for different directions. | |
1773 | ||
1774 | PCM open callback | |
1775 | ~~~~~~~~~~~~~~~~~ | |
1776 | ||
1777 | :: | |
1778 | ||
1779 | static int snd_xxx_open(struct snd_pcm_substream *substream); | |
1780 | ||
4d421eeb | 1781 | This is called when a PCM substream is opened. |
7ddedebb TI |
1782 | |
1783 | At least, here you have to initialize the ``runtime->hw`` | |
4d421eeb | 1784 | record. Typically, this is done like this:: |
7ddedebb TI |
1785 | |
1786 | static int snd_xxx_open(struct snd_pcm_substream *substream) | |
1787 | { | |
1788 | struct mychip *chip = snd_pcm_substream_chip(substream); | |
1789 | struct snd_pcm_runtime *runtime = substream->runtime; | |
1790 | ||
1791 | runtime->hw = snd_mychip_playback_hw; | |
1792 | return 0; | |
1793 | } | |
1794 | ||
1795 | where ``snd_mychip_playback_hw`` is the pre-defined hardware | |
1796 | description. | |
1797 | ||
4d421eeb | 1798 | You can allocate private data in this callback, as described in the |
7ddedebb TI |
1799 | `Private Data`_ section. |
1800 | ||
1801 | If the hardware configuration needs more constraints, set the hardware | |
1802 | constraints here, too. See Constraints_ for more details. | |
1803 | ||
1804 | close callback | |
1805 | ~~~~~~~~~~~~~~ | |
1806 | ||
1807 | :: | |
1808 | ||
1809 | static int snd_xxx_close(struct snd_pcm_substream *substream); | |
1810 | ||
1811 | ||
4d421eeb | 1812 | Obviously, this is called when a PCM substream is closed. |
7ddedebb | 1813 | |
4d421eeb OB |
1814 | Any private instance for a PCM substream allocated in the ``open`` |
1815 | callback will be released here:: | |
7ddedebb TI |
1816 | |
1817 | static int snd_xxx_close(struct snd_pcm_substream *substream) | |
1818 | { | |
1819 | .... | |
1820 | kfree(substream->runtime->private_data); | |
1821 | .... | |
1822 | } | |
1823 | ||
1824 | ioctl callback | |
1825 | ~~~~~~~~~~~~~~ | |
1826 | ||
4d421eeb OB |
1827 | This is used for any special call to PCM ioctls. But usually you can |
1828 | leave it NULL, then the PCM core calls the generic ioctl callback | |
1829 | function :c:func:`snd_pcm_lib_ioctl()`. If you need to deal with a | |
f6161f37 TI |
1830 | unique setup of channel info or reset procedure, you can pass your own |
1831 | callback function here. | |
7ddedebb TI |
1832 | |
1833 | hw_params callback | |
1834 | ~~~~~~~~~~~~~~~~~~~ | |
1835 | ||
1836 | :: | |
1837 | ||
1838 | static int snd_xxx_hw_params(struct snd_pcm_substream *substream, | |
1839 | struct snd_pcm_hw_params *hw_params); | |
1840 | ||
4d421eeb | 1841 | This is called when the hardware parameters (``hw_params``) are set up |
7ddedebb | 1842 | by the application, that is, once when the buffer size, the period |
4d421eeb | 1843 | size, the format, etc. are defined for the PCM substream. |
7ddedebb TI |
1844 | |
1845 | Many hardware setups should be done in this callback, including the | |
1846 | allocation of buffers. | |
1847 | ||
4d421eeb | 1848 | Parameters to be initialized are retrieved by the |
72b4bcbf TI |
1849 | :c:func:`params_xxx()` macros. |
1850 | ||
4d421eeb | 1851 | When you choose managed buffer allocation mode for the substream, |
72b4bcbf TI |
1852 | a buffer is already allocated before this callback gets |
1853 | called. Alternatively, you can call a helper function below for | |
4d421eeb | 1854 | allocating the buffer:: |
7ddedebb TI |
1855 | |
1856 | snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params)); | |
1857 | ||
1858 | :c:func:`snd_pcm_lib_malloc_pages()` is available only when the | |
1859 | DMA buffers have been pre-allocated. See the section `Buffer Types`_ | |
1860 | for more details. | |
1861 | ||
4d421eeb OB |
1862 | Note that this one and the ``prepare`` callback may be called multiple |
1863 | times per initialization. For example, the OSS emulation may call these | |
7ddedebb TI |
1864 | callbacks at each change via its ioctl. |
1865 | ||
1866 | Thus, you need to be careful not to allocate the same buffers many | |
1867 | times, which will lead to memory leaks! Calling the helper function | |
1868 | above many times is OK. It will release the previous buffer | |
1869 | automatically when it was already allocated. | |
1870 | ||
4d421eeb | 1871 | Another note is that this callback is non-atomic (schedulable) by |
7ddedebb TI |
1872 | default, i.e. when no ``nonatomic`` flag set. This is important, |
1873 | because the ``trigger`` callback is atomic (non-schedulable). That is, | |
4d421eeb | 1874 | mutexes or any schedule-related functions are not available in the |
7ddedebb TI |
1875 | ``trigger`` callback. Please see the subsection Atomicity_ for |
1876 | details. | |
1877 | ||
1878 | hw_free callback | |
1879 | ~~~~~~~~~~~~~~~~~ | |
1880 | ||
1881 | :: | |
1882 | ||
1883 | static int snd_xxx_hw_free(struct snd_pcm_substream *substream); | |
1884 | ||
1885 | This is called to release the resources allocated via | |
72b4bcbf | 1886 | ``hw_params``. |
7ddedebb TI |
1887 | |
1888 | This function is always called before the close callback is called. | |
1889 | Also, the callback may be called multiple times, too. Keep track | |
4d421eeb | 1890 | whether each resource was already released. |
7ddedebb | 1891 | |
4d421eeb | 1892 | When you have chosen managed buffer allocation mode for the PCM |
72b4bcbf TI |
1893 | substream, the allocated PCM buffer will be automatically released |
1894 | after this callback gets called. Otherwise you'll have to release the | |
1895 | buffer manually. Typically, when the buffer was allocated from the | |
1896 | pre-allocated pool, you can use the standard API function | |
4d421eeb | 1897 | :c:func:`snd_pcm_lib_malloc_pages()` like:: |
72b4bcbf TI |
1898 | |
1899 | snd_pcm_lib_free_pages(substream); | |
1900 | ||
7ddedebb TI |
1901 | prepare callback |
1902 | ~~~~~~~~~~~~~~~~ | |
1903 | ||
1904 | :: | |
1905 | ||
1906 | static int snd_xxx_prepare(struct snd_pcm_substream *substream); | |
1907 | ||
4d421eeb | 1908 | This callback is called when the PCM is “prepared”. You can set the |
7ddedebb TI |
1909 | format type, sample rate, etc. here. The difference from ``hw_params`` |
1910 | is that the ``prepare`` callback will be called each time | |
1911 | :c:func:`snd_pcm_prepare()` is called, i.e. when recovering after | |
1912 | underruns, etc. | |
1913 | ||
4d421eeb | 1914 | Note that this callback is non-atomic. You can use |
7ddedebb TI |
1915 | schedule-related functions safely in this callback. |
1916 | ||
1917 | In this and the following callbacks, you can refer to the values via | |
1918 | the runtime record, ``substream->runtime``. For example, to get the | |
1919 | current rate, format or channels, access to ``runtime->rate``, | |
1920 | ``runtime->format`` or ``runtime->channels``, respectively. The | |
1921 | physical address of the allocated buffer is set to | |
1922 | ``runtime->dma_area``. The buffer and period sizes are in | |
1923 | ``runtime->buffer_size`` and ``runtime->period_size``, respectively. | |
1924 | ||
1925 | Be careful that this callback will be called many times at each setup, | |
1926 | too. | |
1927 | ||
1928 | trigger callback | |
1929 | ~~~~~~~~~~~~~~~~ | |
1930 | ||
1931 | :: | |
1932 | ||
1933 | static int snd_xxx_trigger(struct snd_pcm_substream *substream, int cmd); | |
1934 | ||
4d421eeb | 1935 | This is called when the PCM is started, stopped or paused. |
7ddedebb | 1936 | |
4d421eeb OB |
1937 | The action is specified in the second argument, ``SNDRV_PCM_TRIGGER_XXX`` |
1938 | defined in ``<sound/pcm.h>``. At least, the ``START`` | |
1939 | and ``STOP`` commands must be defined in this callback:: | |
7ddedebb TI |
1940 | |
1941 | switch (cmd) { | |
1942 | case SNDRV_PCM_TRIGGER_START: | |
1943 | /* do something to start the PCM engine */ | |
1944 | break; | |
1945 | case SNDRV_PCM_TRIGGER_STOP: | |
1946 | /* do something to stop the PCM engine */ | |
1947 | break; | |
1948 | default: | |
1949 | return -EINVAL; | |
1950 | } | |
1951 | ||
4d421eeb | 1952 | When the PCM supports the pause operation (given in the info field of |
7ddedebb | 1953 | the hardware table), the ``PAUSE_PUSH`` and ``PAUSE_RELEASE`` commands |
4d421eeb OB |
1954 | must be handled here, too. The former is the command to pause the PCM, |
1955 | and the latter to restart the PCM again. | |
7ddedebb | 1956 | |
4d421eeb | 1957 | When the PCM supports the suspend/resume operation, regardless of full |
7ddedebb TI |
1958 | or partial suspend/resume support, the ``SUSPEND`` and ``RESUME`` |
1959 | commands must be handled, too. These commands are issued when the | |
1960 | power-management status is changed. Obviously, the ``SUSPEND`` and | |
4d421eeb | 1961 | ``RESUME`` commands suspend and resume the PCM substream, and usually, |
7ddedebb TI |
1962 | they are identical to the ``STOP`` and ``START`` commands, respectively. |
1963 | See the `Power Management`_ section for details. | |
1964 | ||
4d421eeb | 1965 | As mentioned, this callback is atomic by default unless the ``nonatomic`` |
7ddedebb TI |
1966 | flag set, and you cannot call functions which may sleep. The |
1967 | ``trigger`` callback should be as minimal as possible, just really | |
4d421eeb | 1968 | triggering the DMA. The other stuff should be initialized in |
7ddedebb TI |
1969 | ``hw_params`` and ``prepare`` callbacks properly beforehand. |
1970 | ||
94722e74 TI |
1971 | sync_stop callback |
1972 | ~~~~~~~~~~~~~~~~~~ | |
1973 | ||
1974 | :: | |
1975 | ||
1976 | static int snd_xxx_sync_stop(struct snd_pcm_substream *substream); | |
1977 | ||
1978 | This callback is optional, and NULL can be passed. It's called after | |
4d421eeb | 1979 | the PCM core stops the stream, before it changes the stream state via |
94722e74 TI |
1980 | ``prepare``, ``hw_params`` or ``hw_free``. |
1981 | Since the IRQ handler might be still pending, we need to wait until | |
1982 | the pending task finishes before moving to the next step; otherwise it | |
4d421eeb | 1983 | might lead to a crash due to resource conflicts or access to freed |
94722e74 TI |
1984 | resources. A typical behavior is to call a synchronization function |
1985 | like :c:func:`synchronize_irq()` here. | |
1986 | ||
4d421eeb | 1987 | For the majority of drivers that need only a call of |
94722e74 | 1988 | :c:func:`synchronize_irq()`, there is a simpler setup, too. |
4d421eeb OB |
1989 | While keeping the ``sync_stop`` PCM callback NULL, the driver can set |
1990 | the ``card->sync_irq`` field to the returned interrupt number after | |
1991 | requesting an IRQ, instead. Then PCM core will call | |
94722e74 TI |
1992 | :c:func:`synchronize_irq()` with the given IRQ appropriately. |
1993 | ||
4d421eeb | 1994 | If the IRQ handler is released by the card destructor, you don't need |
94722e74 TI |
1995 | to clear ``card->sync_irq``, as the card itself is being released. |
1996 | So, usually you'll need to add just a single line for assigning | |
1997 | ``card->sync_irq`` in the driver code unless the driver re-acquires | |
1998 | the IRQ. When the driver frees and re-acquires the IRQ dynamically | |
1999 | (e.g. for suspend/resume), it needs to clear and re-set | |
2000 | ``card->sync_irq`` again appropriately. | |
2001 | ||
7ddedebb TI |
2002 | pointer callback |
2003 | ~~~~~~~~~~~~~~~~ | |
2004 | ||
2005 | :: | |
2006 | ||
2007 | static snd_pcm_uframes_t snd_xxx_pointer(struct snd_pcm_substream *substream) | |
2008 | ||
2009 | This callback is called when the PCM middle layer inquires the current | |
4d421eeb | 2010 | hardware position in the buffer. The position must be returned in |
7ddedebb TI |
2011 | frames, ranging from 0 to ``buffer_size - 1``. |
2012 | ||
4d421eeb | 2013 | This is usually called from the buffer-update routine in the PCM |
7ddedebb | 2014 | middle layer, which is invoked when :c:func:`snd_pcm_period_elapsed()` |
4d421eeb | 2015 | is called by the interrupt routine. Then the PCM middle layer updates |
7ddedebb TI |
2016 | the position and calculates the available space, and wakes up the |
2017 | sleeping poll threads, etc. | |
2018 | ||
4d421eeb | 2019 | This callback is also atomic by default. |
7ddedebb | 2020 | |
f7a47817 TI |
2021 | copy_user, copy_kernel and fill_silence ops |
2022 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
7ddedebb TI |
2023 | |
2024 | These callbacks are not mandatory, and can be omitted in most cases. | |
2025 | These callbacks are used when the hardware buffer cannot be in the | |
4d421eeb | 2026 | normal memory space. Some chips have their own buffer in the hardware |
7ddedebb TI |
2027 | which is not mappable. In such a case, you have to transfer the data |
2028 | manually from the memory buffer to the hardware buffer. Or, if the | |
2029 | buffer is non-contiguous on both physical and virtual memory spaces, | |
2030 | these callbacks must be defined, too. | |
2031 | ||
2032 | If these two callbacks are defined, copy and set-silence operations | |
4d421eeb | 2033 | are done by them. The details will be described in the later section |
7ddedebb TI |
2034 | `Buffer and Memory Management`_. |
2035 | ||
2036 | ack callback | |
2037 | ~~~~~~~~~~~~ | |
2038 | ||
2039 | This callback is also not mandatory. This callback is called when the | |
2040 | ``appl_ptr`` is updated in read or write operations. Some drivers like | |
2041 | emu10k1-fx and cs46xx need to track the current ``appl_ptr`` for the | |
2042 | internal buffer, and this callback is useful only for such a purpose. | |
2043 | ||
f84af109 | 2044 | The callback function may return 0 or a negative error. When the |
4d421eeb | 2045 | return value is ``-EPIPE``, PCM core treats that as a buffer XRUN, |
f84af109 TI |
2046 | and changes the state to ``SNDRV_PCM_STATE_XRUN`` automatically. |
2047 | ||
4d421eeb | 2048 | This callback is atomic by default. |
7ddedebb TI |
2049 | |
2050 | page callback | |
2051 | ~~~~~~~~~~~~~ | |
2052 | ||
abffd8d0 TI |
2053 | This callback is optional too. The mmap calls this callback to get the |
2054 | page fault address. | |
2055 | ||
4d421eeb OB |
2056 | You need no special callback for the standard SG-buffer or vmalloc- |
2057 | buffer. Hence this callback should be rarely used. | |
7ddedebb | 2058 | |
4d421eeb OB |
2059 | mmap callback |
2060 | ~~~~~~~~~~~~~ | |
f90afe79 TI |
2061 | |
2062 | This is another optional callback for controlling mmap behavior. | |
4d421eeb OB |
2063 | When defined, the PCM core calls this callback when a page is |
2064 | memory-mapped, instead of using the standard helper. | |
f90afe79 TI |
2065 | If you need special handling (due to some architecture or |
2066 | device-specific issues), implement everything here as you like. | |
2067 | ||
2068 | ||
7ddedebb TI |
2069 | PCM Interrupt Handler |
2070 | --------------------- | |
2071 | ||
4d421eeb OB |
2072 | The remainder of the PCM stuff is the PCM interrupt handler. The role |
2073 | of the PCM | |
7ddedebb TI |
2074 | interrupt handler in the sound driver is to update the buffer position |
2075 | and to tell the PCM middle layer when the buffer position goes across | |
4d421eeb | 2076 | the specified period boundary. To inform about this, call the |
7ddedebb TI |
2077 | :c:func:`snd_pcm_period_elapsed()` function. |
2078 | ||
4d421eeb | 2079 | There are several ways sound chips can generate interrupts. |
7ddedebb TI |
2080 | |
2081 | Interrupts at the period (fragment) boundary | |
2082 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
2083 | ||
2084 | This is the most frequently found type: the hardware generates an | |
2085 | interrupt at each period boundary. In this case, you can call | |
2086 | :c:func:`snd_pcm_period_elapsed()` at each interrupt. | |
2087 | ||
2088 | :c:func:`snd_pcm_period_elapsed()` takes the substream pointer as | |
2089 | its argument. Thus, you need to keep the substream pointer accessible | |
2090 | from the chip instance. For example, define ``substream`` field in the | |
2091 | chip record to hold the current running substream pointer, and set the | |
2092 | pointer value at ``open`` callback (and reset at ``close`` callback). | |
2093 | ||
2094 | If you acquire a spinlock in the interrupt handler, and the lock is used | |
4d421eeb | 2095 | in other PCM callbacks, too, then you have to release the lock before |
7ddedebb | 2096 | calling :c:func:`snd_pcm_period_elapsed()`, because |
4d421eeb | 2097 | :c:func:`snd_pcm_period_elapsed()` calls other PCM callbacks |
7ddedebb TI |
2098 | inside. |
2099 | ||
4d421eeb | 2100 | Typical code would look like:: |
7ddedebb TI |
2101 | |
2102 | ||
2103 | static irqreturn_t snd_mychip_interrupt(int irq, void *dev_id) | |
2104 | { | |
2105 | struct mychip *chip = dev_id; | |
2106 | spin_lock(&chip->lock); | |
2107 | .... | |
2108 | if (pcm_irq_invoked(chip)) { | |
2109 | /* call updater, unlock before it */ | |
2110 | spin_unlock(&chip->lock); | |
2111 | snd_pcm_period_elapsed(chip->substream); | |
2112 | spin_lock(&chip->lock); | |
2113 | /* acknowledge the interrupt if necessary */ | |
2114 | } | |
2115 | .... | |
2116 | spin_unlock(&chip->lock); | |
2117 | return IRQ_HANDLED; | |
2118 | } | |
2119 | ||
03f62c9c TI |
2120 | Also, when the device can detect a buffer underrun/overrun, the driver |
2121 | can notify the XRUN status to the PCM core by calling | |
2122 | :c:func:`snd_pcm_stop_xrun()`. This function stops the stream and sets | |
2123 | the PCM state to ``SNDRV_PCM_STATE_XRUN``. Note that it must be called | |
2124 | outside the PCM stream lock, hence it can't be called from the atomic | |
2125 | callback. | |
7ddedebb TI |
2126 | |
2127 | ||
2128 | High frequency timer interrupts | |
2129 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
2130 | ||
2131 | This happens when the hardware doesn't generate interrupts at the period | |
2132 | boundary but issues timer interrupts at a fixed timer rate (e.g. es1968 | |
2133 | or ymfpci drivers). In this case, you need to check the current hardware | |
2134 | position and accumulate the processed sample length at each interrupt. | |
2135 | When the accumulated size exceeds the period size, call | |
2136 | :c:func:`snd_pcm_period_elapsed()` and reset the accumulator. | |
2137 | ||
4d421eeb | 2138 | Typical code would look as follows:: |
7ddedebb TI |
2139 | |
2140 | ||
2141 | static irqreturn_t snd_mychip_interrupt(int irq, void *dev_id) | |
2142 | { | |
2143 | struct mychip *chip = dev_id; | |
2144 | spin_lock(&chip->lock); | |
2145 | .... | |
2146 | if (pcm_irq_invoked(chip)) { | |
2147 | unsigned int last_ptr, size; | |
2148 | /* get the current hardware pointer (in frames) */ | |
2149 | last_ptr = get_hw_ptr(chip); | |
2150 | /* calculate the processed frames since the | |
2151 | * last update | |
2152 | */ | |
2153 | if (last_ptr < chip->last_ptr) | |
2154 | size = runtime->buffer_size + last_ptr | |
2155 | - chip->last_ptr; | |
2156 | else | |
2157 | size = last_ptr - chip->last_ptr; | |
2158 | /* remember the last updated point */ | |
2159 | chip->last_ptr = last_ptr; | |
2160 | /* accumulate the size */ | |
2161 | chip->size += size; | |
2162 | /* over the period boundary? */ | |
2163 | if (chip->size >= runtime->period_size) { | |
2164 | /* reset the accumulator */ | |
2165 | chip->size %= runtime->period_size; | |
2166 | /* call updater */ | |
2167 | spin_unlock(&chip->lock); | |
2168 | snd_pcm_period_elapsed(substream); | |
2169 | spin_lock(&chip->lock); | |
2170 | } | |
2171 | /* acknowledge the interrupt if necessary */ | |
2172 | } | |
2173 | .... | |
2174 | spin_unlock(&chip->lock); | |
2175 | return IRQ_HANDLED; | |
2176 | } | |
2177 | ||
2178 | ||
2179 | ||
2180 | On calling :c:func:`snd_pcm_period_elapsed()` | |
2181 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
2182 | ||
4d421eeb | 2183 | In both cases, even if more than one period has elapsed, you don't have |
7ddedebb | 2184 | to call :c:func:`snd_pcm_period_elapsed()` many times. Call only |
4d421eeb | 2185 | once. And the PCM layer will check the current hardware pointer and |
7ddedebb TI |
2186 | update to the latest status. |
2187 | ||
2188 | Atomicity | |
2189 | --------- | |
2190 | ||
2191 | One of the most important (and thus difficult to debug) problems in | |
2192 | kernel programming are race conditions. In the Linux kernel, they are | |
2193 | usually avoided via spin-locks, mutexes or semaphores. In general, if a | |
2194 | race condition can happen in an interrupt handler, it has to be managed | |
2195 | atomically, and you have to use a spinlock to protect the critical | |
4d421eeb | 2196 | section. If the critical section is not in interrupt handler code and if |
7ddedebb TI |
2197 | taking a relatively long time to execute is acceptable, you should use |
2198 | mutexes or semaphores instead. | |
2199 | ||
4d421eeb OB |
2200 | As already seen, some PCM callbacks are atomic and some are not. For |
2201 | example, the ``hw_params`` callback is non-atomic, while the ``trigger`` | |
7ddedebb | 2202 | callback is atomic. This means, the latter is called already in a |
03f62c9c TI |
2203 | spinlock held by the PCM middle layer, the PCM stream lock. Please |
2204 | take this atomicity into account when you choose a locking scheme in | |
2205 | the callbacks. | |
7ddedebb TI |
2206 | |
2207 | In the atomic callbacks, you cannot use functions which may call | |
2208 | :c:func:`schedule()` or go to :c:func:`sleep()`. Semaphores and | |
2209 | mutexes can sleep, and hence they cannot be used inside the atomic | |
2210 | callbacks (e.g. ``trigger`` callback). To implement some delay in such a | |
2211 | callback, please use :c:func:`udelay()` or :c:func:`mdelay()`. | |
2212 | ||
2213 | All three atomic callbacks (trigger, pointer, and ack) are called with | |
2214 | local interrupts disabled. | |
2215 | ||
4d421eeb OB |
2216 | However, it is possible to request all PCM operations to be non-atomic. |
2217 | This assumes that all call sites are in | |
7ddedebb TI |
2218 | non-atomic contexts. For example, the function |
2219 | :c:func:`snd_pcm_period_elapsed()` is called typically from the | |
2220 | interrupt handler. But, if you set up the driver to use a threaded | |
2221 | interrupt handler, this call can be in non-atomic context, too. In such | |
4d421eeb | 2222 | a case, you can set the ``nonatomic`` field of the struct snd_pcm object |
68735902 MCC |
2223 | after creating it. When this flag is set, mutex and rwsem are used internally |
2224 | in the PCM core instead of spin and rwlocks, so that you can call all PCM | |
2225 | functions safely in a non-atomic | |
7ddedebb TI |
2226 | context. |
2227 | ||
03f62c9c TI |
2228 | Also, in some cases, you might need to call |
2229 | :c:func:`snd_pcm_period_elapsed()` in the atomic context (e.g. the | |
2230 | period gets elapsed during ``ack`` or other callback). There is a | |
2231 | variant that can be called inside the PCM stream lock | |
2232 | :c:func:`snd_pcm_period_elapsed_under_stream_lock()` for that purpose, | |
2233 | too. | |
2234 | ||
7ddedebb TI |
2235 | Constraints |
2236 | ----------- | |
2237 | ||
4d421eeb OB |
2238 | Due to physical limitations, hardware is not infinitely configurable. |
2239 | These limitations are expressed by setting constraints. | |
7ddedebb | 2240 | |
4d421eeb | 2241 | For example, in order to restrict the sample rates to some supported |
7ddedebb | 2242 | values, use :c:func:`snd_pcm_hw_constraint_list()`. You need to |
4d421eeb | 2243 | call this function in the open callback:: |
7ddedebb TI |
2244 | |
2245 | static unsigned int rates[] = | |
2246 | {4000, 10000, 22050, 44100}; | |
2247 | static struct snd_pcm_hw_constraint_list constraints_rates = { | |
2248 | .count = ARRAY_SIZE(rates), | |
2249 | .list = rates, | |
2250 | .mask = 0, | |
2251 | }; | |
2252 | ||
2253 | static int snd_mychip_pcm_open(struct snd_pcm_substream *substream) | |
2254 | { | |
2255 | int err; | |
2256 | .... | |
2257 | err = snd_pcm_hw_constraint_list(substream->runtime, 0, | |
2258 | SNDRV_PCM_HW_PARAM_RATE, | |
2259 | &constraints_rates); | |
2260 | if (err < 0) | |
2261 | return err; | |
2262 | .... | |
2263 | } | |
2264 | ||
7ddedebb TI |
2265 | There are many different constraints. Look at ``sound/pcm.h`` for a |
2266 | complete list. You can even define your own constraint rules. For | |
2267 | example, let's suppose my_chip can manage a substream of 1 channel if | |
2268 | and only if the format is ``S16_LE``, otherwise it supports any format | |
4d421eeb OB |
2269 | specified in struct snd_pcm_hardware (or in any other |
2270 | constraint_list). You can build a rule like this:: | |
7ddedebb TI |
2271 | |
2272 | static int hw_rule_channels_by_format(struct snd_pcm_hw_params *params, | |
2273 | struct snd_pcm_hw_rule *rule) | |
2274 | { | |
2275 | struct snd_interval *c = hw_param_interval(params, | |
2276 | SNDRV_PCM_HW_PARAM_CHANNELS); | |
2277 | struct snd_mask *f = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT); | |
2278 | struct snd_interval ch; | |
2279 | ||
2280 | snd_interval_any(&ch); | |
2281 | if (f->bits[0] == SNDRV_PCM_FMTBIT_S16_LE) { | |
2282 | ch.min = ch.max = 1; | |
2283 | ch.integer = 1; | |
2284 | return snd_interval_refine(c, &ch); | |
2285 | } | |
2286 | return 0; | |
2287 | } | |
2288 | ||
2289 | ||
4d421eeb | 2290 | Then you need to call this function to add your rule:: |
7ddedebb TI |
2291 | |
2292 | snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS, | |
2293 | hw_rule_channels_by_format, NULL, | |
2294 | SNDRV_PCM_HW_PARAM_FORMAT, -1); | |
2295 | ||
2296 | The rule function is called when an application sets the PCM format, and | |
2297 | it refines the number of channels accordingly. But an application may | |
2298 | set the number of channels before setting the format. Thus you also need | |
4d421eeb | 2299 | to define the inverse rule:: |
7ddedebb TI |
2300 | |
2301 | static int hw_rule_format_by_channels(struct snd_pcm_hw_params *params, | |
2302 | struct snd_pcm_hw_rule *rule) | |
2303 | { | |
2304 | struct snd_interval *c = hw_param_interval(params, | |
2305 | SNDRV_PCM_HW_PARAM_CHANNELS); | |
2306 | struct snd_mask *f = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT); | |
2307 | struct snd_mask fmt; | |
2308 | ||
2309 | snd_mask_any(&fmt); /* Init the struct */ | |
2310 | if (c->min < 2) { | |
2311 | fmt.bits[0] &= SNDRV_PCM_FMTBIT_S16_LE; | |
2312 | return snd_mask_refine(f, &fmt); | |
2313 | } | |
2314 | return 0; | |
2315 | } | |
2316 | ||
2317 | ||
4d421eeb | 2318 | ... and in the open callback:: |
7ddedebb TI |
2319 | |
2320 | snd_pcm_hw_rule_add(substream->runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT, | |
2321 | hw_rule_format_by_channels, NULL, | |
2322 | SNDRV_PCM_HW_PARAM_CHANNELS, -1); | |
2323 | ||
f90afe79 | 2324 | One typical usage of the hw constraints is to align the buffer size |
4d421eeb | 2325 | with the period size. By default, ALSA PCM core doesn't enforce the |
f90afe79 TI |
2326 | buffer size to be aligned with the period size. For example, it'd be |
2327 | possible to have a combination like 256 period bytes with 999 buffer | |
2328 | bytes. | |
2329 | ||
2330 | Many device chips, however, require the buffer to be a multiple of | |
2331 | periods. In such a case, call | |
2332 | :c:func:`snd_pcm_hw_constraint_integer()` for | |
4d421eeb | 2333 | ``SNDRV_PCM_HW_PARAM_PERIODS``:: |
f90afe79 TI |
2334 | |
2335 | snd_pcm_hw_constraint_integer(substream->runtime, | |
2336 | SNDRV_PCM_HW_PARAM_PERIODS); | |
2337 | ||
2338 | This assures that the number of periods is integer, hence the buffer | |
2339 | size is aligned with the period size. | |
2340 | ||
4d421eeb | 2341 | The hw constraint is a very powerful mechanism to define the |
f90afe79 | 2342 | preferred PCM configuration, and there are relevant helpers. |
7ddedebb TI |
2343 | I won't give more details here, rather I would like to say, “Luke, use |
2344 | the source.” | |
2345 | ||
2346 | Control Interface | |
2347 | ================= | |
2348 | ||
2349 | General | |
2350 | ------- | |
2351 | ||
2352 | The control interface is used widely for many switches, sliders, etc. | |
2353 | which are accessed from user-space. Its most important use is the mixer | |
2354 | interface. In other words, since ALSA 0.9.x, all the mixer stuff is | |
2355 | implemented on the control kernel API. | |
2356 | ||
2357 | ALSA has a well-defined AC97 control module. If your chip supports only | |
2358 | the AC97 and nothing else, you can skip this section. | |
2359 | ||
2360 | The control API is defined in ``<sound/control.h>``. Include this file | |
2361 | if you want to add your own controls. | |
2362 | ||
2363 | Definition of Controls | |
2364 | ---------------------- | |
2365 | ||
2366 | To create a new control, you need to define the following three | |
2367 | callbacks: ``info``, ``get`` and ``put``. Then, define a | |
4d421eeb | 2368 | struct snd_kcontrol_new record, such as:: |
7ddedebb TI |
2369 | |
2370 | ||
2371 | static struct snd_kcontrol_new my_control = { | |
2372 | .iface = SNDRV_CTL_ELEM_IFACE_MIXER, | |
2373 | .name = "PCM Playback Switch", | |
2374 | .index = 0, | |
2375 | .access = SNDRV_CTL_ELEM_ACCESS_READWRITE, | |
2376 | .private_value = 0xffff, | |
2377 | .info = my_control_info, | |
2378 | .get = my_control_get, | |
2379 | .put = my_control_put | |
2380 | }; | |
2381 | ||
2382 | ||
2383 | The ``iface`` field specifies the control type, | |
2384 | ``SNDRV_CTL_ELEM_IFACE_XXX``, which is usually ``MIXER``. Use ``CARD`` | |
2385 | for global controls that are not logically part of the mixer. If the | |
2386 | control is closely associated with some specific device on the sound | |
2387 | card, use ``HWDEP``, ``PCM``, ``RAWMIDI``, ``TIMER``, or ``SEQUENCER``, | |
2388 | and specify the device number with the ``device`` and ``subdevice`` | |
2389 | fields. | |
2390 | ||
2391 | The ``name`` is the name identifier string. Since ALSA 0.9.x, the | |
2392 | control name is very important, because its role is classified from | |
2393 | its name. There are pre-defined standard control names. The details | |
2394 | are described in the `Control Names`_ subsection. | |
2395 | ||
2396 | The ``index`` field holds the index number of this control. If there | |
2397 | are several different controls with the same name, they can be | |
2398 | distinguished by the index number. This is the case when several | |
2399 | codecs exist on the card. If the index is zero, you can omit the | |
2400 | definition above. | |
2401 | ||
2402 | The ``access`` field contains the access type of this control. Give | |
2403 | the combination of bit masks, ``SNDRV_CTL_ELEM_ACCESS_XXX``, | |
2404 | there. The details will be explained in the `Access Flags`_ | |
2405 | subsection. | |
2406 | ||
2407 | The ``private_value`` field contains an arbitrary long integer value | |
2408 | for this record. When using the generic ``info``, ``get`` and ``put`` | |
2409 | callbacks, you can pass a value through this field. If several small | |
2410 | numbers are necessary, you can combine them in bitwise. Or, it's | |
4d421eeb | 2411 | possible to store a pointer (casted to unsigned long) of some record in |
7ddedebb TI |
2412 | this field, too. |
2413 | ||
2414 | The ``tlv`` field can be used to provide metadata about the control; | |
2415 | see the `Metadata`_ subsection. | |
2416 | ||
2417 | The other three are `Control Callbacks`_. | |
2418 | ||
2419 | Control Names | |
2420 | ------------- | |
2421 | ||
2422 | There are some standards to define the control names. A control is | |
2423 | usually defined from the three parts as “SOURCE DIRECTION FUNCTION”. | |
2424 | ||
2425 | The first, ``SOURCE``, specifies the source of the control, and is a | |
2426 | string such as “Master”, “PCM”, “CD” and “Line”. There are many | |
2427 | pre-defined sources. | |
2428 | ||
2429 | The second, ``DIRECTION``, is one of the following strings according to | |
2430 | the direction of the control: “Playback”, “Capture”, “Bypass Playback” | |
2431 | and “Bypass Capture”. Or, it can be omitted, meaning both playback and | |
2432 | capture directions. | |
2433 | ||
2434 | The third, ``FUNCTION``, is one of the following strings according to | |
2435 | the function of the control: “Switch”, “Volume” and “Route”. | |
2436 | ||
2437 | The example of control names are, thus, “Master Capture Switch” or “PCM | |
2438 | Playback Volume”. | |
2439 | ||
2440 | There are some exceptions: | |
2441 | ||
2442 | Global capture and playback | |
2443 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
2444 | ||
2445 | “Capture Source”, “Capture Switch” and “Capture Volume” are used for the | |
2446 | global capture (input) source, switch and volume. Similarly, “Playback | |
2447 | Switch” and “Playback Volume” are used for the global output gain switch | |
2448 | and volume. | |
2449 | ||
2450 | Tone-controls | |
2451 | ~~~~~~~~~~~~~ | |
2452 | ||
2453 | tone-control switch and volumes are specified like “Tone Control - XXX”, | |
2454 | e.g. “Tone Control - Switch”, “Tone Control - Bass”, “Tone Control - | |
2455 | Center”. | |
2456 | ||
2457 | 3D controls | |
2458 | ~~~~~~~~~~~ | |
2459 | ||
2460 | 3D-control switches and volumes are specified like “3D Control - XXX”, | |
2461 | e.g. “3D Control - Switch”, “3D Control - Center”, “3D Control - Space”. | |
2462 | ||
2463 | Mic boost | |
2464 | ~~~~~~~~~ | |
2465 | ||
2466 | Mic-boost switch is set as “Mic Boost” or “Mic Boost (6dB)”. | |
2467 | ||
2468 | More precise information can be found in | |
f495ae3c | 2469 | ``Documentation/sound/designs/control-names.rst``. |
7ddedebb TI |
2470 | |
2471 | Access Flags | |
2472 | ------------ | |
2473 | ||
2474 | The access flag is the bitmask which specifies the access type of the | |
2475 | given control. The default access type is | |
2476 | ``SNDRV_CTL_ELEM_ACCESS_READWRITE``, which means both read and write are | |
2477 | allowed to this control. When the access flag is omitted (i.e. = 0), it | |
4d421eeb | 2478 | is considered as ``READWRITE`` access by default. |
7ddedebb TI |
2479 | |
2480 | When the control is read-only, pass ``SNDRV_CTL_ELEM_ACCESS_READ`` | |
2481 | instead. In this case, you don't have to define the ``put`` callback. | |
2482 | Similarly, when the control is write-only (although it's a rare case), | |
2483 | you can use the ``WRITE`` flag instead, and you don't need the ``get`` | |
2484 | callback. | |
2485 | ||
2486 | If the control value changes frequently (e.g. the VU meter), | |
2487 | ``VOLATILE`` flag should be given. This means that the control may be | |
2488 | changed without `Change notification`_. Applications should poll such | |
2489 | a control constantly. | |
2490 | ||
4d421eeb OB |
2491 | When the control may be updated, but currently has no effect on anything, |
2492 | setting the ``INACTIVE`` flag may be appropriate. For example, PCM | |
2493 | controls should be inactive while no PCM device is open. | |
2494 | ||
2495 | There are ``LOCK`` and ``OWNER`` flags to change the write permissions. | |
7ddedebb TI |
2496 | |
2497 | Control Callbacks | |
2498 | ----------------- | |
2499 | ||
2500 | info callback | |
2501 | ~~~~~~~~~~~~~ | |
2502 | ||
2503 | The ``info`` callback is used to get detailed information on this | |
68735902 MCC |
2504 | control. This must store the values of the given |
2505 | struct snd_ctl_elem_info object. For example, | |
4d421eeb | 2506 | for a boolean control with a single element:: |
7ddedebb TI |
2507 | |
2508 | ||
2509 | static int snd_myctl_mono_info(struct snd_kcontrol *kcontrol, | |
2510 | struct snd_ctl_elem_info *uinfo) | |
2511 | { | |
2512 | uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN; | |
2513 | uinfo->count = 1; | |
2514 | uinfo->value.integer.min = 0; | |
2515 | uinfo->value.integer.max = 1; | |
2516 | return 0; | |
2517 | } | |
2518 | ||
2519 | ||
2520 | ||
2521 | The ``type`` field specifies the type of the control. There are | |
2522 | ``BOOLEAN``, ``INTEGER``, ``ENUMERATED``, ``BYTES``, ``IEC958`` and | |
2523 | ``INTEGER64``. The ``count`` field specifies the number of elements in | |
2524 | this control. For example, a stereo volume would have count = 2. The | |
4d421eeb | 2525 | ``value`` field is a union, and the values stored depend on the |
7ddedebb TI |
2526 | type. The boolean and integer types are identical. |
2527 | ||
4d421eeb OB |
2528 | The enumerated type is a bit different from the others. You'll need to |
2529 | set the string for the selectec item index:: | |
7ddedebb TI |
2530 | |
2531 | static int snd_myctl_enum_info(struct snd_kcontrol *kcontrol, | |
2532 | struct snd_ctl_elem_info *uinfo) | |
2533 | { | |
2534 | static char *texts[4] = { | |
2535 | "First", "Second", "Third", "Fourth" | |
2536 | }; | |
2537 | uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED; | |
2538 | uinfo->count = 1; | |
2539 | uinfo->value.enumerated.items = 4; | |
2540 | if (uinfo->value.enumerated.item > 3) | |
2541 | uinfo->value.enumerated.item = 3; | |
2542 | strcpy(uinfo->value.enumerated.name, | |
2543 | texts[uinfo->value.enumerated.item]); | |
2544 | return 0; | |
2545 | } | |
2546 | ||
2547 | The above callback can be simplified with a helper function, | |
2548 | :c:func:`snd_ctl_enum_info()`. The final code looks like below. | |
2549 | (You can pass ``ARRAY_SIZE(texts)`` instead of 4 in the third argument; | |
2550 | it's a matter of taste.) | |
2551 | ||
2552 | :: | |
2553 | ||
2554 | static int snd_myctl_enum_info(struct snd_kcontrol *kcontrol, | |
2555 | struct snd_ctl_elem_info *uinfo) | |
2556 | { | |
2557 | static char *texts[4] = { | |
2558 | "First", "Second", "Third", "Fourth" | |
2559 | }; | |
2560 | return snd_ctl_enum_info(uinfo, 1, 4, texts); | |
2561 | } | |
2562 | ||
2563 | ||
2564 | Some common info callbacks are available for your convenience: | |
2565 | :c:func:`snd_ctl_boolean_mono_info()` and | |
2566 | :c:func:`snd_ctl_boolean_stereo_info()`. Obviously, the former | |
2567 | is an info callback for a mono channel boolean item, just like | |
2568 | :c:func:`snd_myctl_mono_info()` above, and the latter is for a | |
2569 | stereo channel boolean item. | |
2570 | ||
2571 | get callback | |
2572 | ~~~~~~~~~~~~ | |
2573 | ||
4d421eeb OB |
2574 | This callback is used to read the current value of the control, so it |
2575 | can be returned to user-space. | |
7ddedebb | 2576 | |
4d421eeb | 2577 | For example:: |
7ddedebb TI |
2578 | |
2579 | static int snd_myctl_get(struct snd_kcontrol *kcontrol, | |
2580 | struct snd_ctl_elem_value *ucontrol) | |
2581 | { | |
2582 | struct mychip *chip = snd_kcontrol_chip(kcontrol); | |
2583 | ucontrol->value.integer.value[0] = get_some_value(chip); | |
2584 | return 0; | |
2585 | } | |
2586 | ||
2587 | ||
2588 | ||
2589 | The ``value`` field depends on the type of control as well as on the | |
2590 | info callback. For example, the sb driver uses this field to store the | |
2591 | register offset, the bit-shift and the bit-mask. The ``private_value`` | |
4d421eeb | 2592 | field is set as follows:: |
7ddedebb TI |
2593 | |
2594 | .private_value = reg | (shift << 16) | (mask << 24) | |
2595 | ||
4d421eeb | 2596 | and is retrieved in callbacks like:: |
7ddedebb TI |
2597 | |
2598 | static int snd_sbmixer_get_single(struct snd_kcontrol *kcontrol, | |
2599 | struct snd_ctl_elem_value *ucontrol) | |
2600 | { | |
2601 | int reg = kcontrol->private_value & 0xff; | |
2602 | int shift = (kcontrol->private_value >> 16) & 0xff; | |
2603 | int mask = (kcontrol->private_value >> 24) & 0xff; | |
2604 | .... | |
2605 | } | |
2606 | ||
2607 | In the ``get`` callback, you have to fill all the elements if the | |
4d421eeb | 2608 | control has more than one element, i.e. ``count > 1``. In the example |
7ddedebb | 2609 | above, we filled only one element (``value.integer.value[0]``) since |
4d421eeb | 2610 | ``count = 1`` is assumed. |
7ddedebb TI |
2611 | |
2612 | put callback | |
2613 | ~~~~~~~~~~~~ | |
2614 | ||
4d421eeb | 2615 | This callback is used to write a value coming from user-space. |
7ddedebb | 2616 | |
4d421eeb | 2617 | For example:: |
7ddedebb TI |
2618 | |
2619 | static int snd_myctl_put(struct snd_kcontrol *kcontrol, | |
2620 | struct snd_ctl_elem_value *ucontrol) | |
2621 | { | |
2622 | struct mychip *chip = snd_kcontrol_chip(kcontrol); | |
2623 | int changed = 0; | |
2624 | if (chip->current_value != | |
2625 | ucontrol->value.integer.value[0]) { | |
2626 | change_current_value(chip, | |
2627 | ucontrol->value.integer.value[0]); | |
2628 | changed = 1; | |
2629 | } | |
2630 | return changed; | |
2631 | } | |
2632 | ||
2633 | ||
2634 | ||
2635 | As seen above, you have to return 1 if the value is changed. If the | |
2636 | value is not changed, return 0 instead. If any fatal error happens, | |
2637 | return a negative error code as usual. | |
2638 | ||
2639 | As in the ``get`` callback, when the control has more than one | |
4d421eeb | 2640 | element, all elements must be evaluated in this callback, too. |
7ddedebb TI |
2641 | |
2642 | Callbacks are not atomic | |
2643 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
2644 | ||
4d421eeb | 2645 | All these three callbacks are not-atomic. |
7ddedebb TI |
2646 | |
2647 | Control Constructor | |
2648 | ------------------- | |
2649 | ||
2650 | When everything is ready, finally we can create a new control. To create | |
2651 | a control, there are two functions to be called, | |
2652 | :c:func:`snd_ctl_new1()` and :c:func:`snd_ctl_add()`. | |
2653 | ||
4d421eeb | 2654 | In the simplest way, you can do it like this:: |
7ddedebb TI |
2655 | |
2656 | err = snd_ctl_add(card, snd_ctl_new1(&my_control, chip)); | |
2657 | if (err < 0) | |
2658 | return err; | |
2659 | ||
68735902 MCC |
2660 | where ``my_control`` is the struct snd_kcontrol_new object defined above, |
2661 | and chip is the object pointer to be passed to kcontrol->private_data which | |
2662 | can be referred to in callbacks. | |
7ddedebb | 2663 | |
68735902 | 2664 | :c:func:`snd_ctl_new1()` allocates a new struct snd_kcontrol instance, and |
7ddedebb TI |
2665 | :c:func:`snd_ctl_add()` assigns the given control component to the |
2666 | card. | |
2667 | ||
2668 | Change Notification | |
2669 | ------------------- | |
2670 | ||
2671 | If you need to change and update a control in the interrupt routine, you | |
4d421eeb | 2672 | can call :c:func:`snd_ctl_notify()`. For example:: |
7ddedebb TI |
2673 | |
2674 | snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, id_pointer); | |
2675 | ||
2676 | This function takes the card pointer, the event-mask, and the control id | |
2677 | pointer for the notification. The event-mask specifies the types of | |
2678 | notification, for example, in the above example, the change of control | |
68735902 MCC |
2679 | values is notified. The id pointer is the pointer of struct snd_ctl_elem_id |
2680 | to be notified. You can find some examples in ``es1938.c`` or ``es1968.c`` | |
2681 | for hardware volume interrupts. | |
7ddedebb TI |
2682 | |
2683 | Metadata | |
2684 | -------- | |
2685 | ||
4d421eeb | 2686 | To provide information about the dB values of a mixer control, use one of |
7ddedebb TI |
2687 | the ``DECLARE_TLV_xxx`` macros from ``<sound/tlv.h>`` to define a |
2688 | variable containing this information, set the ``tlv.p`` field to point to | |
2689 | this variable, and include the ``SNDRV_CTL_ELEM_ACCESS_TLV_READ`` flag | |
4d421eeb | 2690 | in the ``access`` field; like this:: |
7ddedebb TI |
2691 | |
2692 | static DECLARE_TLV_DB_SCALE(db_scale_my_control, -4050, 150, 0); | |
2693 | ||
2694 | static struct snd_kcontrol_new my_control = { | |
2695 | ... | |
2696 | .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | | |
2697 | SNDRV_CTL_ELEM_ACCESS_TLV_READ, | |
2698 | ... | |
2699 | .tlv.p = db_scale_my_control, | |
2700 | }; | |
2701 | ||
2702 | ||
2703 | The :c:func:`DECLARE_TLV_DB_SCALE()` macro defines information | |
2704 | about a mixer control where each step in the control's value changes the | |
2705 | dB value by a constant dB amount. The first parameter is the name of the | |
2706 | variable to be defined. The second parameter is the minimum value, in | |
2707 | units of 0.01 dB. The third parameter is the step size, in units of 0.01 | |
2708 | dB. Set the fourth parameter to 1 if the minimum value actually mutes | |
2709 | the control. | |
2710 | ||
2711 | The :c:func:`DECLARE_TLV_DB_LINEAR()` macro defines information | |
2712 | about a mixer control where the control's value affects the output | |
2713 | linearly. The first parameter is the name of the variable to be defined. | |
2714 | The second parameter is the minimum value, in units of 0.01 dB. The | |
2715 | third parameter is the maximum value, in units of 0.01 dB. If the | |
2716 | minimum value mutes the control, set the second parameter to | |
2717 | ``TLV_DB_GAIN_MUTE``. | |
2718 | ||
2719 | API for AC97 Codec | |
2720 | ================== | |
2721 | ||
2722 | General | |
2723 | ------- | |
2724 | ||
2725 | The ALSA AC97 codec layer is a well-defined one, and you don't have to | |
2726 | write much code to control it. Only low-level control routines are | |
2727 | necessary. The AC97 codec API is defined in ``<sound/ac97_codec.h>``. | |
2728 | ||
2729 | Full Code Example | |
2730 | ----------------- | |
2731 | ||
2732 | :: | |
2733 | ||
2734 | struct mychip { | |
2735 | .... | |
2736 | struct snd_ac97 *ac97; | |
2737 | .... | |
2738 | }; | |
2739 | ||
2740 | static unsigned short snd_mychip_ac97_read(struct snd_ac97 *ac97, | |
2741 | unsigned short reg) | |
2742 | { | |
2743 | struct mychip *chip = ac97->private_data; | |
2744 | .... | |
2745 | /* read a register value here from the codec */ | |
2746 | return the_register_value; | |
2747 | } | |
2748 | ||
2749 | static void snd_mychip_ac97_write(struct snd_ac97 *ac97, | |
2750 | unsigned short reg, unsigned short val) | |
2751 | { | |
2752 | struct mychip *chip = ac97->private_data; | |
2753 | .... | |
2754 | /* write the given register value to the codec */ | |
2755 | } | |
2756 | ||
2757 | static int snd_mychip_ac97(struct mychip *chip) | |
2758 | { | |
2759 | struct snd_ac97_bus *bus; | |
2760 | struct snd_ac97_template ac97; | |
2761 | int err; | |
2762 | static struct snd_ac97_bus_ops ops = { | |
2763 | .write = snd_mychip_ac97_write, | |
2764 | .read = snd_mychip_ac97_read, | |
2765 | }; | |
2766 | ||
2767 | err = snd_ac97_bus(chip->card, 0, &ops, NULL, &bus); | |
2768 | if (err < 0) | |
2769 | return err; | |
2770 | memset(&ac97, 0, sizeof(ac97)); | |
2771 | ac97.private_data = chip; | |
2772 | return snd_ac97_mixer(bus, &ac97, &chip->ac97); | |
2773 | } | |
2774 | ||
2775 | ||
2776 | AC97 Constructor | |
2777 | ---------------- | |
2778 | ||
2779 | To create an ac97 instance, first call :c:func:`snd_ac97_bus()` | |
4d421eeb | 2780 | with an ``ac97_bus_ops_t`` record with callback functions:: |
7ddedebb TI |
2781 | |
2782 | struct snd_ac97_bus *bus; | |
2783 | static struct snd_ac97_bus_ops ops = { | |
2784 | .write = snd_mychip_ac97_write, | |
2785 | .read = snd_mychip_ac97_read, | |
2786 | }; | |
2787 | ||
2788 | snd_ac97_bus(card, 0, &ops, NULL, &pbus); | |
2789 | ||
2790 | The bus record is shared among all belonging ac97 instances. | |
2791 | ||
4d421eeb OB |
2792 | And then call :c:func:`snd_ac97_mixer()` with a struct snd_ac97_template |
2793 | record together with the bus pointer created above:: | |
7ddedebb TI |
2794 | |
2795 | struct snd_ac97_template ac97; | |
2796 | int err; | |
2797 | ||
2798 | memset(&ac97, 0, sizeof(ac97)); | |
2799 | ac97.private_data = chip; | |
2800 | snd_ac97_mixer(bus, &ac97, &chip->ac97); | |
2801 | ||
2802 | where chip->ac97 is a pointer to a newly created ``ac97_t`` | |
2803 | instance. In this case, the chip pointer is set as the private data, | |
2804 | so that the read/write callback functions can refer to this chip | |
2805 | instance. This instance is not necessarily stored in the chip | |
2806 | record. If you need to change the register values from the driver, or | |
2807 | need the suspend/resume of ac97 codecs, keep this pointer to pass to | |
2808 | the corresponding functions. | |
2809 | ||
2810 | AC97 Callbacks | |
2811 | -------------- | |
2812 | ||
2813 | The standard callbacks are ``read`` and ``write``. Obviously they | |
2814 | correspond to the functions for read and write accesses to the | |
2815 | hardware low-level codes. | |
2816 | ||
2817 | The ``read`` callback returns the register value specified in the | |
4d421eeb | 2818 | argument:: |
7ddedebb TI |
2819 | |
2820 | static unsigned short snd_mychip_ac97_read(struct snd_ac97 *ac97, | |
2821 | unsigned short reg) | |
2822 | { | |
2823 | struct mychip *chip = ac97->private_data; | |
2824 | .... | |
2825 | return the_register_value; | |
2826 | } | |
2827 | ||
2828 | Here, the chip can be cast from ``ac97->private_data``. | |
2829 | ||
2830 | Meanwhile, the ``write`` callback is used to set the register | |
4d421eeb | 2831 | value:: |
7ddedebb TI |
2832 | |
2833 | static void snd_mychip_ac97_write(struct snd_ac97 *ac97, | |
2834 | unsigned short reg, unsigned short val) | |
2835 | ||
2836 | ||
2837 | These callbacks are non-atomic like the control API callbacks. | |
2838 | ||
2839 | There are also other callbacks: ``reset``, ``wait`` and ``init``. | |
2840 | ||
2841 | The ``reset`` callback is used to reset the codec. If the chip | |
2842 | requires a special kind of reset, you can define this callback. | |
2843 | ||
2844 | The ``wait`` callback is used to add some waiting time in the standard | |
2845 | initialization of the codec. If the chip requires the extra waiting | |
2846 | time, define this callback. | |
2847 | ||
2848 | The ``init`` callback is used for additional initialization of the | |
2849 | codec. | |
2850 | ||
2851 | Updating Registers in The Driver | |
2852 | -------------------------------- | |
2853 | ||
2854 | If you need to access to the codec from the driver, you can call the | |
2855 | following functions: :c:func:`snd_ac97_write()`, | |
2856 | :c:func:`snd_ac97_read()`, :c:func:`snd_ac97_update()` and | |
2857 | :c:func:`snd_ac97_update_bits()`. | |
2858 | ||
2859 | Both :c:func:`snd_ac97_write()` and | |
2860 | :c:func:`snd_ac97_update()` functions are used to set a value to | |
2861 | the given register (``AC97_XXX``). The difference between them is that | |
2862 | :c:func:`snd_ac97_update()` doesn't write a value if the given | |
2863 | value has been already set, while :c:func:`snd_ac97_write()` | |
4d421eeb | 2864 | always rewrites the value:: |
7ddedebb TI |
2865 | |
2866 | snd_ac97_write(ac97, AC97_MASTER, 0x8080); | |
2867 | snd_ac97_update(ac97, AC97_MASTER, 0x8080); | |
2868 | ||
2869 | :c:func:`snd_ac97_read()` is used to read the value of the given | |
4d421eeb | 2870 | register. For example:: |
7ddedebb TI |
2871 | |
2872 | value = snd_ac97_read(ac97, AC97_MASTER); | |
2873 | ||
2874 | :c:func:`snd_ac97_update_bits()` is used to update some bits in | |
4d421eeb | 2875 | the given register:: |
7ddedebb TI |
2876 | |
2877 | snd_ac97_update_bits(ac97, reg, mask, value); | |
2878 | ||
2879 | Also, there is a function to change the sample rate (of a given register | |
2880 | such as ``AC97_PCM_FRONT_DAC_RATE``) when VRA or DRA is supported by the | |
4d421eeb | 2881 | codec: :c:func:`snd_ac97_set_rate()`:: |
7ddedebb TI |
2882 | |
2883 | snd_ac97_set_rate(ac97, AC97_PCM_FRONT_DAC_RATE, 44100); | |
2884 | ||
2885 | ||
2886 | The following registers are available to set the rate: | |
2887 | ``AC97_PCM_MIC_ADC_RATE``, ``AC97_PCM_FRONT_DAC_RATE``, | |
2888 | ``AC97_PCM_LR_ADC_RATE``, ``AC97_SPDIF``. When ``AC97_SPDIF`` is | |
2889 | specified, the register is not really changed but the corresponding | |
2890 | IEC958 status bits will be updated. | |
2891 | ||
2892 | Clock Adjustment | |
2893 | ---------------- | |
2894 | ||
2895 | In some chips, the clock of the codec isn't 48000 but using a PCI clock | |
2896 | (to save a quartz!). In this case, change the field ``bus->clock`` to | |
2897 | the corresponding value. For example, intel8x0 and es1968 drivers have | |
2898 | their own function to read from the clock. | |
2899 | ||
2900 | Proc Files | |
2901 | ---------- | |
2902 | ||
2903 | The ALSA AC97 interface will create a proc file such as | |
2904 | ``/proc/asound/card0/codec97#0/ac97#0-0`` and ``ac97#0-0+regs``. You | |
2905 | can refer to these files to see the current status and registers of | |
2906 | the codec. | |
2907 | ||
2908 | Multiple Codecs | |
2909 | --------------- | |
2910 | ||
2911 | When there are several codecs on the same card, you need to call | |
2912 | :c:func:`snd_ac97_mixer()` multiple times with ``ac97.num=1`` or | |
2913 | greater. The ``num`` field specifies the codec number. | |
2914 | ||
2915 | If you set up multiple codecs, you either need to write different | |
2916 | callbacks for each codec or check ``ac97->num`` in the callback | |
2917 | routines. | |
2918 | ||
2919 | MIDI (MPU401-UART) Interface | |
2920 | ============================ | |
2921 | ||
2922 | General | |
2923 | ------- | |
2924 | ||
2925 | Many soundcards have built-in MIDI (MPU401-UART) interfaces. When the | |
2926 | soundcard supports the standard MPU401-UART interface, most likely you | |
2927 | can use the ALSA MPU401-UART API. The MPU401-UART API is defined in | |
2928 | ``<sound/mpu401.h>``. | |
2929 | ||
2930 | Some soundchips have a similar but slightly different implementation of | |
2931 | mpu401 stuff. For example, emu10k1 has its own mpu401 routines. | |
2932 | ||
2933 | MIDI Constructor | |
2934 | ---------------- | |
2935 | ||
4d421eeb | 2936 | To create a rawmidi object, call :c:func:`snd_mpu401_uart_new()`:: |
7ddedebb TI |
2937 | |
2938 | struct snd_rawmidi *rmidi; | |
2939 | snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401, port, info_flags, | |
2940 | irq, &rmidi); | |
2941 | ||
2942 | ||
2943 | The first argument is the card pointer, and the second is the index of | |
2944 | this component. You can create up to 8 rawmidi devices. | |
2945 | ||
2946 | The third argument is the type of the hardware, ``MPU401_HW_XXX``. If | |
2947 | it's not a special one, you can use ``MPU401_HW_MPU401``. | |
2948 | ||
2949 | The 4th argument is the I/O port address. Many backward-compatible | |
2950 | MPU401 have an I/O port such as 0x330. Or, it might be a part of its own | |
2951 | PCI I/O region. It depends on the chip design. | |
2952 | ||
2953 | The 5th argument is a bitflag for additional information. When the I/O | |
2954 | port address above is part of the PCI I/O region, the MPU401 I/O port | |
2955 | might have been already allocated (reserved) by the driver itself. In | |
2956 | such a case, pass a bit flag ``MPU401_INFO_INTEGRATED``, and the | |
2957 | mpu401-uart layer will allocate the I/O ports by itself. | |
2958 | ||
2959 | When the controller supports only the input or output MIDI stream, pass | |
2960 | the ``MPU401_INFO_INPUT`` or ``MPU401_INFO_OUTPUT`` bitflag, | |
2961 | respectively. Then the rawmidi instance is created as a single stream. | |
2962 | ||
2963 | ``MPU401_INFO_MMIO`` bitflag is used to change the access method to MMIO | |
2964 | (via readb and writeb) instead of iob and outb. In this case, you have | |
2965 | to pass the iomapped address to :c:func:`snd_mpu401_uart_new()`. | |
2966 | ||
2967 | When ``MPU401_INFO_TX_IRQ`` is set, the output stream isn't checked in | |
2968 | the default interrupt handler. The driver needs to call | |
2969 | :c:func:`snd_mpu401_uart_interrupt_tx()` by itself to start | |
2970 | processing the output stream in the irq handler. | |
2971 | ||
2972 | If the MPU-401 interface shares its interrupt with the other logical | |
2973 | devices on the card, set ``MPU401_INFO_IRQ_HOOK`` (see | |
4f8af077 | 2974 | `below <MIDI Interrupt Handler_>`__). |
7ddedebb TI |
2975 | |
2976 | Usually, the port address corresponds to the command port and port + 1 | |
2977 | corresponds to the data port. If not, you may change the ``cport`` | |
68735902 MCC |
2978 | field of struct snd_mpu401 manually afterward. |
2979 | However, struct snd_mpu401 pointer is | |
7ddedebb | 2980 | not returned explicitly by :c:func:`snd_mpu401_uart_new()`. You |
4d421eeb | 2981 | need to cast ``rmidi->private_data`` to struct snd_mpu401 explicitly:: |
7ddedebb TI |
2982 | |
2983 | struct snd_mpu401 *mpu; | |
2984 | mpu = rmidi->private_data; | |
2985 | ||
4d421eeb | 2986 | and reset the ``cport`` as you like:: |
7ddedebb TI |
2987 | |
2988 | mpu->cport = my_own_control_port; | |
2989 | ||
2990 | The 6th argument specifies the ISA irq number that will be allocated. If | |
2991 | no interrupt is to be allocated (because your code is already allocating | |
2992 | a shared interrupt, or because the device does not use interrupts), pass | |
2993 | -1 instead. For a MPU-401 device without an interrupt, a polling timer | |
2994 | will be used instead. | |
2995 | ||
2996 | MIDI Interrupt Handler | |
2997 | ---------------------- | |
2998 | ||
2999 | When the interrupt is allocated in | |
3000 | :c:func:`snd_mpu401_uart_new()`, an exclusive ISA interrupt | |
3001 | handler is automatically used, hence you don't have anything else to do | |
3002 | than creating the mpu401 stuff. Otherwise, you have to set | |
3003 | ``MPU401_INFO_IRQ_HOOK``, and call | |
3004 | :c:func:`snd_mpu401_uart_interrupt()` explicitly from your own | |
3005 | interrupt handler when it has determined that a UART interrupt has | |
3006 | occurred. | |
3007 | ||
3008 | In this case, you need to pass the private_data of the returned rawmidi | |
3009 | object from :c:func:`snd_mpu401_uart_new()` as the second | |
4d421eeb | 3010 | argument of :c:func:`snd_mpu401_uart_interrupt()`:: |
7ddedebb TI |
3011 | |
3012 | snd_mpu401_uart_interrupt(irq, rmidi->private_data, regs); | |
3013 | ||
3014 | ||
3015 | RawMIDI Interface | |
3016 | ================= | |
3017 | ||
3018 | Overview | |
3019 | -------- | |
3020 | ||
3021 | The raw MIDI interface is used for hardware MIDI ports that can be | |
3022 | accessed as a byte stream. It is not used for synthesizer chips that do | |
3023 | not directly understand MIDI. | |
3024 | ||
3025 | ALSA handles file and buffer management. All you have to do is to write | |
3026 | some code to move data between the buffer and the hardware. | |
3027 | ||
3028 | The rawmidi API is defined in ``<sound/rawmidi.h>``. | |
3029 | ||
3030 | RawMIDI Constructor | |
3031 | ------------------- | |
3032 | ||
3033 | To create a rawmidi device, call the :c:func:`snd_rawmidi_new()` | |
4d421eeb | 3034 | function:: |
7ddedebb TI |
3035 | |
3036 | struct snd_rawmidi *rmidi; | |
3037 | err = snd_rawmidi_new(chip->card, "MyMIDI", 0, outs, ins, &rmidi); | |
3038 | if (err < 0) | |
3039 | return err; | |
3040 | rmidi->private_data = chip; | |
3041 | strcpy(rmidi->name, "My MIDI"); | |
3042 | rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT | | |
3043 | SNDRV_RAWMIDI_INFO_INPUT | | |
3044 | SNDRV_RAWMIDI_INFO_DUPLEX; | |
3045 | ||
3046 | The first argument is the card pointer, the second argument is the ID | |
3047 | string. | |
3048 | ||
3049 | The third argument is the index of this component. You can create up to | |
3050 | 8 rawmidi devices. | |
3051 | ||
3052 | The fourth and fifth arguments are the number of output and input | |
3053 | substreams, respectively, of this device (a substream is the equivalent | |
3054 | of a MIDI port). | |
3055 | ||
3056 | Set the ``info_flags`` field to specify the capabilities of the | |
3057 | device. Set ``SNDRV_RAWMIDI_INFO_OUTPUT`` if there is at least one | |
3058 | output port, ``SNDRV_RAWMIDI_INFO_INPUT`` if there is at least one | |
3059 | input port, and ``SNDRV_RAWMIDI_INFO_DUPLEX`` if the device can handle | |
3060 | output and input at the same time. | |
3061 | ||
3062 | After the rawmidi device is created, you need to set the operators | |
3063 | (callbacks) for each substream. There are helper functions to set the | |
4d421eeb | 3064 | operators for all the substreams of a device:: |
7ddedebb TI |
3065 | |
3066 | snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_mymidi_output_ops); | |
3067 | snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_mymidi_input_ops); | |
3068 | ||
4d421eeb | 3069 | The operators are usually defined like this:: |
7ddedebb TI |
3070 | |
3071 | static struct snd_rawmidi_ops snd_mymidi_output_ops = { | |
3072 | .open = snd_mymidi_output_open, | |
3073 | .close = snd_mymidi_output_close, | |
3074 | .trigger = snd_mymidi_output_trigger, | |
3075 | }; | |
3076 | ||
3077 | These callbacks are explained in the `RawMIDI Callbacks`_ section. | |
3078 | ||
3079 | If there are more than one substream, you should give a unique name to | |
4d421eeb | 3080 | each of them:: |
7ddedebb TI |
3081 | |
3082 | struct snd_rawmidi_substream *substream; | |
3083 | list_for_each_entry(substream, | |
3084 | &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams, | |
3085 | list { | |
3086 | sprintf(substream->name, "My MIDI Port %d", substream->number + 1); | |
3087 | } | |
3088 | /* same for SNDRV_RAWMIDI_STREAM_INPUT */ | |
3089 | ||
3090 | RawMIDI Callbacks | |
3091 | ----------------- | |
3092 | ||
3093 | In all the callbacks, the private data that you've set for the rawmidi | |
3094 | device can be accessed as ``substream->rmidi->private_data``. | |
3095 | ||
3096 | If there is more than one port, your callbacks can determine the port | |
3097 | index from the struct snd_rawmidi_substream data passed to each | |
4d421eeb | 3098 | callback:: |
7ddedebb TI |
3099 | |
3100 | struct snd_rawmidi_substream *substream; | |
3101 | int index = substream->number; | |
3102 | ||
3103 | RawMIDI open callback | |
3104 | ~~~~~~~~~~~~~~~~~~~~~ | |
3105 | ||
3106 | :: | |
3107 | ||
3108 | static int snd_xxx_open(struct snd_rawmidi_substream *substream); | |
3109 | ||
3110 | ||
3111 | This is called when a substream is opened. You can initialize the | |
3112 | hardware here, but you shouldn't start transmitting/receiving data yet. | |
3113 | ||
3114 | RawMIDI close callback | |
3115 | ~~~~~~~~~~~~~~~~~~~~~~ | |
3116 | ||
3117 | :: | |
3118 | ||
3119 | static int snd_xxx_close(struct snd_rawmidi_substream *substream); | |
3120 | ||
3121 | Guess what. | |
3122 | ||
3123 | The ``open`` and ``close`` callbacks of a rawmidi device are | |
3124 | serialized with a mutex, and can sleep. | |
3125 | ||
3126 | Rawmidi trigger callback for output substreams | |
3127 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
3128 | ||
3129 | :: | |
3130 | ||
3131 | static void snd_xxx_output_trigger(struct snd_rawmidi_substream *substream, int up); | |
3132 | ||
3133 | ||
3134 | This is called with a nonzero ``up`` parameter when there is some data | |
3135 | in the substream buffer that must be transmitted. | |
3136 | ||
3137 | To read data from the buffer, call | |
3138 | :c:func:`snd_rawmidi_transmit_peek()`. It will return the number | |
3139 | of bytes that have been read; this will be less than the number of bytes | |
3140 | requested when there are no more data in the buffer. After the data have | |
3141 | been transmitted successfully, call | |
3142 | :c:func:`snd_rawmidi_transmit_ack()` to remove the data from the | |
4d421eeb | 3143 | substream buffer:: |
7ddedebb TI |
3144 | |
3145 | unsigned char data; | |
3146 | while (snd_rawmidi_transmit_peek(substream, &data, 1) == 1) { | |
3147 | if (snd_mychip_try_to_transmit(data)) | |
3148 | snd_rawmidi_transmit_ack(substream, 1); | |
3149 | else | |
3150 | break; /* hardware FIFO full */ | |
3151 | } | |
3152 | ||
3153 | If you know beforehand that the hardware will accept data, you can use | |
3154 | the :c:func:`snd_rawmidi_transmit()` function which reads some | |
4d421eeb | 3155 | data and removes them from the buffer at once:: |
7ddedebb TI |
3156 | |
3157 | while (snd_mychip_transmit_possible()) { | |
3158 | unsigned char data; | |
3159 | if (snd_rawmidi_transmit(substream, &data, 1) != 1) | |
3160 | break; /* no more data */ | |
3161 | snd_mychip_transmit(data); | |
3162 | } | |
3163 | ||
3164 | If you know beforehand how many bytes you can accept, you can use a | |
4d9d18ad | 3165 | buffer size greater than one with the ``snd_rawmidi_transmit*()`` functions. |
7ddedebb TI |
3166 | |
3167 | The ``trigger`` callback must not sleep. If the hardware FIFO is full | |
3168 | before the substream buffer has been emptied, you have to continue | |
3169 | transmitting data later, either in an interrupt handler, or with a | |
3170 | timer if the hardware doesn't have a MIDI transmit interrupt. | |
3171 | ||
3172 | The ``trigger`` callback is called with a zero ``up`` parameter when | |
3173 | the transmission of data should be aborted. | |
3174 | ||
3175 | RawMIDI trigger callback for input substreams | |
3176 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
3177 | ||
3178 | :: | |
3179 | ||
3180 | static void snd_xxx_input_trigger(struct snd_rawmidi_substream *substream, int up); | |
3181 | ||
3182 | ||
3183 | This is called with a nonzero ``up`` parameter to enable receiving data, | |
3184 | or with a zero ``up`` parameter do disable receiving data. | |
3185 | ||
3186 | The ``trigger`` callback must not sleep; the actual reading of data | |
3187 | from the device is usually done in an interrupt handler. | |
3188 | ||
3189 | When data reception is enabled, your interrupt handler should call | |
4d421eeb | 3190 | :c:func:`snd_rawmidi_receive()` for all received data:: |
7ddedebb TI |
3191 | |
3192 | void snd_mychip_midi_interrupt(...) | |
3193 | { | |
3194 | while (mychip_midi_available()) { | |
3195 | unsigned char data; | |
3196 | data = mychip_midi_read(); | |
3197 | snd_rawmidi_receive(substream, &data, 1); | |
3198 | } | |
3199 | } | |
3200 | ||
3201 | ||
3202 | drain callback | |
3203 | ~~~~~~~~~~~~~~ | |
3204 | ||
3205 | :: | |
3206 | ||
3207 | static void snd_xxx_drain(struct snd_rawmidi_substream *substream); | |
3208 | ||
3209 | ||
3210 | This is only used with output substreams. This function should wait | |
3211 | until all data read from the substream buffer have been transmitted. | |
3212 | This ensures that the device can be closed and the driver unloaded | |
3213 | without losing data. | |
3214 | ||
3215 | This callback is optional. If you do not set ``drain`` in the struct | |
f3fd34fe | 3216 | snd_rawmidi_ops structure, ALSA will simply wait for 50 milliseconds |
7ddedebb TI |
3217 | instead. |
3218 | ||
3219 | Miscellaneous Devices | |
3220 | ===================== | |
3221 | ||
3222 | FM OPL3 | |
3223 | ------- | |
3224 | ||
3225 | The FM OPL3 is still used in many chips (mainly for backward | |
3226 | compatibility). ALSA has a nice OPL3 FM control layer, too. The OPL3 API | |
3227 | is defined in ``<sound/opl3.h>``. | |
3228 | ||
3229 | FM registers can be directly accessed through the direct-FM API, defined | |
3230 | in ``<sound/asound_fm.h>``. In ALSA native mode, FM registers are | |
3231 | accessed through the Hardware-Dependent Device direct-FM extension API, | |
3232 | whereas in OSS compatible mode, FM registers can be accessed with the | |
3233 | OSS direct-FM compatible API in ``/dev/dmfmX`` device. | |
3234 | ||
3235 | To create the OPL3 component, you have two functions to call. The first | |
4d421eeb | 3236 | one is a constructor for the ``opl3_t`` instance:: |
7ddedebb TI |
3237 | |
3238 | struct snd_opl3 *opl3; | |
3239 | snd_opl3_create(card, lport, rport, OPL3_HW_OPL3_XXX, | |
3240 | integrated, &opl3); | |
3241 | ||
3242 | The first argument is the card pointer, the second one is the left port | |
3243 | address, and the third is the right port address. In most cases, the | |
3244 | right port is placed at the left port + 2. | |
3245 | ||
3246 | The fourth argument is the hardware type. | |
3247 | ||
3248 | When the left and right ports have been already allocated by the card | |
3249 | driver, pass non-zero to the fifth argument (``integrated``). Otherwise, | |
3250 | the opl3 module will allocate the specified ports by itself. | |
3251 | ||
3252 | When the accessing the hardware requires special method instead of the | |
3253 | standard I/O access, you can create opl3 instance separately with | |
4d421eeb | 3254 | :c:func:`snd_opl3_new()`:: |
7ddedebb TI |
3255 | |
3256 | struct snd_opl3 *opl3; | |
3257 | snd_opl3_new(card, OPL3_HW_OPL3_XXX, &opl3); | |
3258 | ||
3259 | Then set ``command``, ``private_data`` and ``private_free`` for the | |
3260 | private access function, the private data and the destructor. The | |
3261 | ``l_port`` and ``r_port`` are not necessarily set. Only the command | |
3262 | must be set properly. You can retrieve the data from the | |
3263 | ``opl3->private_data`` field. | |
3264 | ||
3265 | After creating the opl3 instance via :c:func:`snd_opl3_new()`, | |
3266 | call :c:func:`snd_opl3_init()` to initialize the chip to the | |
3267 | proper state. Note that :c:func:`snd_opl3_create()` always calls | |
3268 | it internally. | |
3269 | ||
3270 | If the opl3 instance is created successfully, then create a hwdep device | |
4d421eeb | 3271 | for this opl3:: |
7ddedebb TI |
3272 | |
3273 | struct snd_hwdep *opl3hwdep; | |
3274 | snd_opl3_hwdep_new(opl3, 0, 1, &opl3hwdep); | |
3275 | ||
3276 | The first argument is the ``opl3_t`` instance you created, and the | |
3277 | second is the index number, usually 0. | |
3278 | ||
3279 | The third argument is the index-offset for the sequencer client assigned | |
3280 | to the OPL3 port. When there is an MPU401-UART, give 1 for here (UART | |
3281 | always takes 0). | |
3282 | ||
3283 | Hardware-Dependent Devices | |
3284 | -------------------------- | |
3285 | ||
3286 | Some chips need user-space access for special controls or for loading | |
3287 | the micro code. In such a case, you can create a hwdep | |
3288 | (hardware-dependent) device. The hwdep API is defined in | |
3289 | ``<sound/hwdep.h>``. You can find examples in opl3 driver or | |
3290 | ``isa/sb/sb16_csp.c``. | |
3291 | ||
3292 | The creation of the ``hwdep`` instance is done via | |
4d421eeb | 3293 | :c:func:`snd_hwdep_new()`:: |
7ddedebb TI |
3294 | |
3295 | struct snd_hwdep *hw; | |
3296 | snd_hwdep_new(card, "My HWDEP", 0, &hw); | |
3297 | ||
3298 | where the third argument is the index number. | |
3299 | ||
3300 | You can then pass any pointer value to the ``private_data``. If you | |
4d421eeb OB |
3301 | assign private data, you should define a destructor, too. The |
3302 | destructor function is set in the ``private_free`` field:: | |
7ddedebb TI |
3303 | |
3304 | struct mydata *p = kmalloc(sizeof(*p), GFP_KERNEL); | |
3305 | hw->private_data = p; | |
3306 | hw->private_free = mydata_free; | |
3307 | ||
4d421eeb | 3308 | and the implementation of the destructor would be:: |
7ddedebb TI |
3309 | |
3310 | static void mydata_free(struct snd_hwdep *hw) | |
3311 | { | |
3312 | struct mydata *p = hw->private_data; | |
3313 | kfree(p); | |
3314 | } | |
3315 | ||
3316 | The arbitrary file operations can be defined for this instance. The file | |
3317 | operators are defined in the ``ops`` table. For example, assume that | |
4d421eeb | 3318 | this chip needs an ioctl:: |
7ddedebb TI |
3319 | |
3320 | hw->ops.open = mydata_open; | |
3321 | hw->ops.ioctl = mydata_ioctl; | |
3322 | hw->ops.release = mydata_release; | |
3323 | ||
3324 | And implement the callback functions as you like. | |
3325 | ||
3326 | IEC958 (S/PDIF) | |
3327 | --------------- | |
3328 | ||
3329 | Usually the controls for IEC958 devices are implemented via the control | |
3330 | interface. There is a macro to compose a name string for IEC958 | |
3331 | controls, :c:func:`SNDRV_CTL_NAME_IEC958()` defined in | |
3332 | ``<include/asound.h>``. | |
3333 | ||
3334 | There are some standard controls for IEC958 status bits. These controls | |
3335 | use the type ``SNDRV_CTL_ELEM_TYPE_IEC958``, and the size of element is | |
3336 | fixed as 4 bytes array (value.iec958.status[x]). For the ``info`` | |
3337 | callback, you don't specify the value field for this type (the count | |
3338 | field must be set, though). | |
3339 | ||
3340 | “IEC958 Playback Con Mask” is used to return the bit-mask for the IEC958 | |
3341 | status bits of consumer mode. Similarly, “IEC958 Playback Pro Mask” | |
aa789953 | 3342 | returns the bitmask for professional mode. They are read-only controls. |
7ddedebb TI |
3343 | |
3344 | Meanwhile, “IEC958 Playback Default” control is defined for getting and | |
aa789953 MR |
3345 | setting the current default IEC958 bits. |
3346 | ||
3347 | Due to historical reasons, both variants of the Playback Mask and the | |
3348 | Playback Default controls can be implemented on either a | |
3349 | ``SNDRV_CTL_ELEM_IFACE_PCM`` or a ``SNDRV_CTL_ELEM_IFACE_MIXER`` iface. | |
3350 | Drivers should expose the mask and default on the same iface though. | |
7ddedebb TI |
3351 | |
3352 | In addition, you can define the control switches to enable/disable or to | |
3353 | set the raw bit mode. The implementation will depend on the chip, but | |
3354 | the control should be named as “IEC958 xxx”, preferably using the | |
3355 | :c:func:`SNDRV_CTL_NAME_IEC958()` macro. | |
3356 | ||
3357 | You can find several cases, for example, ``pci/emu10k1``, | |
3358 | ``pci/ice1712``, or ``pci/cmipci.c``. | |
3359 | ||
3360 | Buffer and Memory Management | |
3361 | ============================ | |
3362 | ||
3363 | Buffer Types | |
3364 | ------------ | |
3365 | ||
3366 | ALSA provides several different buffer allocation functions depending on | |
3367 | the bus and the architecture. All these have a consistent API. The | |
4d421eeb | 3368 | allocation of physically-contiguous pages is done via the |
7ddedebb TI |
3369 | :c:func:`snd_malloc_xxx_pages()` function, where xxx is the bus |
3370 | type. | |
3371 | ||
4d421eeb OB |
3372 | The allocation of pages with fallback is done via |
3373 | :c:func:`snd_dma_alloc_pages_fallback()`. This function tries | |
3374 | to allocate the specified number of pages, but if not enough pages are | |
3375 | available, it tries to reduce the request size until enough space | |
3376 | is found, down to one page. | |
7ddedebb | 3377 | |
4d421eeb | 3378 | To release the pages, call the :c:func:`snd_dma_free_pages()` |
7ddedebb TI |
3379 | function. |
3380 | ||
3381 | Usually, ALSA drivers try to allocate and reserve a large contiguous | |
4d421eeb | 3382 | physical space at the time the module is loaded for later use. This |
7ddedebb | 3383 | is called “pre-allocation”. As already written, you can call the |
4d421eeb OB |
3384 | following function at PCM instance construction time (in the case of PCI |
3385 | bus):: | |
7ddedebb TI |
3386 | |
3387 | snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV, | |
b65f131b | 3388 | &pci->dev, size, max); |
7ddedebb | 3389 | |
4d421eeb OB |
3390 | where ``size`` is the byte size to be pre-allocated and ``max`` is |
3391 | the maximum size settable via the ``prealloc`` proc file. The | |
7ddedebb TI |
3392 | allocator will try to get an area as large as possible within the |
3393 | given size. | |
3394 | ||
3395 | The second argument (type) and the third argument (device pointer) are | |
0b6a2c9c TI |
3396 | dependent on the bus. For normal devices, pass the device pointer |
3397 | (typically identical as ``card->dev``) to the third argument with | |
0db78532 TI |
3398 | ``SNDRV_DMA_TYPE_DEV`` type. |
3399 | ||
4d421eeb | 3400 | A continuous buffer unrelated to the |
08422d2c TI |
3401 | bus can be pre-allocated with ``SNDRV_DMA_TYPE_CONTINUOUS`` type. |
3402 | You can pass NULL to the device pointer in that case, which is the | |
4d421eeb | 3403 | default mode implying to allocate with the ``GFP_KERNEL`` flag. |
0db78532 TI |
3404 | If you need a restricted (lower) address, set up the coherent DMA mask |
3405 | bits for the device, and pass the device pointer, like the normal | |
3406 | device memory allocations. For this type, it's still allowed to pass | |
3407 | NULL to the device pointer, too, if no address restriction is needed. | |
3408 | ||
08422d2c TI |
3409 | For the scatter-gather buffers, use ``SNDRV_DMA_TYPE_DEV_SG`` with the |
3410 | device pointer (see the `Non-Contiguous Buffers`_ section). | |
7ddedebb TI |
3411 | |
3412 | Once the buffer is pre-allocated, you can use the allocator in the | |
4d421eeb | 3413 | ``hw_params`` callback:: |
7ddedebb TI |
3414 | |
3415 | snd_pcm_lib_malloc_pages(substream, size); | |
3416 | ||
3417 | Note that you have to pre-allocate to use this function. | |
3418 | ||
4d421eeb OB |
3419 | But most drivers use the "managed buffer allocation mode" instead |
3420 | of manual allocation and release. | |
72b4bcbf | 3421 | This is done by calling :c:func:`snd_pcm_set_managed_buffer_all()` |
4d421eeb | 3422 | instead of :c:func:`snd_pcm_lib_preallocate_pages_for_all()`:: |
72b4bcbf TI |
3423 | |
3424 | snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV, | |
3425 | &pci->dev, size, max); | |
3426 | ||
4d421eeb | 3427 | where the passed arguments are identical for both functions. |
72b4bcbf TI |
3428 | The difference in the managed mode is that PCM core will call |
3429 | :c:func:`snd_pcm_lib_malloc_pages()` internally already before calling | |
3430 | the PCM ``hw_params`` callback, and call :c:func:`snd_pcm_lib_free_pages()` | |
3431 | after the PCM ``hw_free`` callback automatically. So the driver | |
3432 | doesn't have to call these functions explicitly in its callback any | |
4d421eeb | 3433 | longer. This allows many drivers to have NULL ``hw_params`` and |
72b4bcbf TI |
3434 | ``hw_free`` entries. |
3435 | ||
7ddedebb TI |
3436 | External Hardware Buffers |
3437 | ------------------------- | |
3438 | ||
4d421eeb | 3439 | Some chips have their own hardware buffers and DMA transfer from the |
7ddedebb TI |
3440 | host memory is not available. In such a case, you need to either 1) |
3441 | copy/set the audio data directly to the external hardware buffer, or 2) | |
3442 | make an intermediate buffer and copy/set the data from it to the | |
3443 | external hardware buffer in interrupts (or in tasklets, preferably). | |
3444 | ||
3445 | The first case works fine if the external hardware buffer is large | |
3446 | enough. This method doesn't need any extra buffers and thus is more | |
4d421eeb OB |
3447 | efficient. You need to define the ``copy_user`` and ``copy_kernel`` |
3448 | callbacks for the data transfer, in addition to the ``fill_silence`` | |
f7a47817 | 3449 | callback for playback. However, there is a drawback: it cannot be |
7ddedebb TI |
3450 | mmapped. The examples are GUS's GF1 PCM or emu8000's wavetable PCM. |
3451 | ||
3452 | The second case allows for mmap on the buffer, although you have to | |
3453 | handle an interrupt or a tasklet to transfer the data from the | |
3454 | intermediate buffer to the hardware buffer. You can find an example in | |
3455 | the vxpocket driver. | |
3456 | ||
3457 | Another case is when the chip uses a PCI memory-map region for the | |
3458 | buffer instead of the host memory. In this case, mmap is available only | |
3459 | on certain architectures like the Intel one. In non-mmap mode, the data | |
3460 | cannot be transferred as in the normal way. Thus you need to define the | |
f7a47817 | 3461 | ``copy_user``, ``copy_kernel`` and ``fill_silence`` callbacks as well, |
4d421eeb | 3462 | as in the cases above. Examples are found in ``rme32.c`` and |
f7a47817 | 3463 | ``rme96.c``. |
7ddedebb | 3464 | |
f7a47817 TI |
3465 | The implementation of the ``copy_user``, ``copy_kernel`` and |
3466 | ``silence`` callbacks depends upon whether the hardware supports | |
3467 | interleaved or non-interleaved samples. The ``copy_user`` callback is | |
4d421eeb OB |
3468 | defined like below, a bit differently depending on whether the direction |
3469 | is playback or capture:: | |
7ddedebb | 3470 | |
f7a47817 TI |
3471 | static int playback_copy_user(struct snd_pcm_substream *substream, |
3472 | int channel, unsigned long pos, | |
3473 | void __user *src, unsigned long count); | |
3474 | static int capture_copy_user(struct snd_pcm_substream *substream, | |
3475 | int channel, unsigned long pos, | |
3476 | void __user *dst, unsigned long count); | |
7ddedebb TI |
3477 | |
3478 | In the case of interleaved samples, the second argument (``channel``) is | |
4d421eeb | 3479 | not used. The third argument (``pos``) specifies the position in bytes. |
7ddedebb TI |
3480 | |
3481 | The meaning of the fourth argument is different between playback and | |
3482 | capture. For playback, it holds the source data pointer, and for | |
3483 | capture, it's the destination data pointer. | |
3484 | ||
f7a47817 | 3485 | The last argument is the number of bytes to be copied. |
7ddedebb TI |
3486 | |
3487 | What you have to do in this callback is again different between playback | |
3488 | and capture directions. In the playback case, you copy the given amount | |
3489 | of data (``count``) at the specified pointer (``src``) to the specified | |
4d421eeb OB |
3490 | offset (``pos``) in the hardware buffer. When coded like memcpy-like |
3491 | way, the copy would look like:: | |
7ddedebb | 3492 | |
f7a47817 | 3493 | my_memcpy_from_user(my_buffer + pos, src, count); |
7ddedebb TI |
3494 | |
3495 | For the capture direction, you copy the given amount of data (``count``) | |
4d421eeb OB |
3496 | at the specified offset (``pos``) in the hardware buffer to the |
3497 | specified pointer (``dst``):: | |
7ddedebb | 3498 | |
f7a47817 TI |
3499 | my_memcpy_to_user(dst, my_buffer + pos, count); |
3500 | ||
4d421eeb | 3501 | Here the functions are named ``from_user`` and ``to_user`` because |
f7a47817 | 3502 | it's the user-space buffer that is passed to these callbacks. That |
4d421eeb | 3503 | is, the callback is supposed to copy data from/to the user-space |
f7a47817 | 3504 | directly to/from the hardware buffer. |
7ddedebb | 3505 | |
f7a47817 TI |
3506 | Careful readers might notice that these callbacks receive the |
3507 | arguments in bytes, not in frames like other callbacks. It's because | |
4d421eeb OB |
3508 | this makes coding easier like in the examples above, and also it makes |
3509 | it easier to unify both the interleaved and non-interleaved cases, as | |
3510 | explained below. | |
7ddedebb TI |
3511 | |
3512 | In the case of non-interleaved samples, the implementation will be a bit | |
4d421eeb OB |
3513 | more complicated. The callback is called for each channel, passed in |
3514 | the second argument, so in total it's called N times per transfer. | |
f7a47817 | 3515 | |
4d421eeb OB |
3516 | The meaning of the other arguments are almost the same as in the |
3517 | interleaved case. The callback is supposed to copy the data from/to | |
3518 | the given user-space buffer, but only for the given channel. For | |
3519 | details, please check ``isa/gus/gus_pcm.c`` or ``pci/rme9652/rme9652.c`` | |
3520 | as examples. | |
f7a47817 | 3521 | |
4d421eeb OB |
3522 | The above callbacks are the copies from/to the user-space buffer. There |
3523 | are some cases where we want to copy from/to the kernel-space buffer | |
3524 | instead. In such a case, the ``copy_kernel`` callback is called. It'd | |
3525 | look like:: | |
f7a47817 TI |
3526 | |
3527 | static int playback_copy_kernel(struct snd_pcm_substream *substream, | |
3528 | int channel, unsigned long pos, | |
3529 | void *src, unsigned long count); | |
3530 | static int capture_copy_kernel(struct snd_pcm_substream *substream, | |
3531 | int channel, unsigned long pos, | |
3532 | void *dst, unsigned long count); | |
3533 | ||
3534 | As found easily, the only difference is that the buffer pointer is | |
4d421eeb | 3535 | without a ``__user`` prefix; that is, a kernel-buffer pointer is passed |
f7a47817 | 3536 | in the fourth argument. Correspondingly, the implementation would be |
4d421eeb | 3537 | a version without the user-copy, such as:: |
f7a47817 TI |
3538 | |
3539 | my_memcpy(my_buffer + pos, src, count); | |
7ddedebb | 3540 | |
f7a47817 TI |
3541 | Usually for the playback, another callback ``fill_silence`` is |
3542 | defined. It's implemented in a similar way as the copy callbacks | |
4d421eeb | 3543 | above:: |
7ddedebb TI |
3544 | |
3545 | static int silence(struct snd_pcm_substream *substream, int channel, | |
f7a47817 | 3546 | unsigned long pos, unsigned long count); |
7ddedebb | 3547 | |
f7a47817 TI |
3548 | The meanings of arguments are the same as in the ``copy_user`` and |
3549 | ``copy_kernel`` callbacks, although there is no buffer pointer | |
3550 | argument. In the case of interleaved samples, the channel argument has | |
4d421eeb | 3551 | no meaning, as for the ``copy_*`` callbacks. |
7ddedebb | 3552 | |
4d421eeb OB |
3553 | The role of the ``fill_silence`` callback is to set the given amount |
3554 | (``count``) of silence data at the specified offset (``pos``) in the | |
7ddedebb TI |
3555 | hardware buffer. Suppose that the data format is signed (that is, the |
3556 | silent-data is 0), and the implementation using a memset-like function | |
4d421eeb | 3557 | would look like:: |
7ddedebb | 3558 | |
f7a47817 | 3559 | my_memset(my_buffer + pos, 0, count); |
7ddedebb TI |
3560 | |
3561 | In the case of non-interleaved samples, again, the implementation | |
4d421eeb | 3562 | becomes a bit more complicated, as it's called N times per transfer |
f7a47817 | 3563 | for each channel. See, for example, ``isa/gus/gus_pcm.c``. |
7ddedebb TI |
3564 | |
3565 | Non-Contiguous Buffers | |
3566 | ---------------------- | |
3567 | ||
4d421eeb OB |
3568 | If your hardware supports a page table as in emu10k1 or buffer |
3569 | descriptors as in via82xx, you can use scatter-gather (SG) DMA. ALSA | |
7ddedebb TI |
3570 | provides an interface for handling SG-buffers. The API is provided in |
3571 | ``<sound/pcm.h>``. | |
3572 | ||
3573 | For creating the SG-buffer handler, call | |
72b4bcbf TI |
3574 | :c:func:`snd_pcm_set_managed_buffer()` or |
3575 | :c:func:`snd_pcm_set_managed_buffer_all()` with | |
4d421eeb OB |
3576 | ``SNDRV_DMA_TYPE_DEV_SG`` in the PCM constructor like for other PCI |
3577 | pre-allocations. You need to pass ``&pci->dev``, where pci is | |
3578 | the struct pci_dev pointer of the chip as well:: | |
abffd8d0 | 3579 | |
72b4bcbf TI |
3580 | snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG, |
3581 | &pci->dev, size, max); | |
abffd8d0 TI |
3582 | |
3583 | The ``struct snd_sg_buf`` instance is created as | |
4d421eeb | 3584 | ``substream->dma_private`` in turn. You can cast the pointer like:: |
7ddedebb TI |
3585 | |
3586 | struct snd_sg_buf *sgbuf = (struct snd_sg_buf *)substream->dma_private; | |
3587 | ||
4d421eeb | 3588 | Then in the :c:func:`snd_pcm_lib_malloc_pages()` call, the common SG-buffer |
7ddedebb | 3589 | handler will allocate the non-contiguous kernel pages of the given size |
4d421eeb OB |
3590 | and map them as virtually contiguous memory. The virtual pointer |
3591 | is addressed via runtime->dma_area. The physical address | |
7ddedebb TI |
3592 | (``runtime->dma_addr``) is set to zero, because the buffer is |
3593 | physically non-contiguous. The physical address table is set up in | |
3594 | ``sgbuf->table``. You can get the physical address at a certain offset | |
3595 | via :c:func:`snd_pcm_sgbuf_get_addr()`. | |
3596 | ||
72b4bcbf TI |
3597 | If you need to release the SG-buffer data explicitly, call the |
3598 | standard API function :c:func:`snd_pcm_lib_free_pages()` as usual. | |
7ddedebb TI |
3599 | |
3600 | Vmalloc'ed Buffers | |
3601 | ------------------ | |
3602 | ||
3603 | It's possible to use a buffer allocated via :c:func:`vmalloc()`, for | |
4d421eeb OB |
3604 | example, for an intermediate buffer. |
3605 | You can simply allocate it via the standard | |
3606 | :c:func:`snd_pcm_lib_malloc_pages()` and co. after setting up the | |
3607 | buffer preallocation with ``SNDRV_DMA_TYPE_VMALLOC`` type:: | |
f90afe79 | 3608 | |
72b4bcbf TI |
3609 | snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_VMALLOC, |
3610 | NULL, 0, 0); | |
7ddedebb | 3611 | |
4d421eeb OB |
3612 | NULL is passed as the device pointer argument, which indicates |
3613 | that default pages (GFP_KERNEL and GFP_HIGHMEM) will be | |
abffd8d0 | 3614 | allocated. |
7ddedebb | 3615 | |
4d421eeb OB |
3616 | Also, note that zero is passed as both the size and the max size |
3617 | argument here. Since each vmalloc call should succeed at any time, | |
abffd8d0 TI |
3618 | we don't need to pre-allocate the buffers like other continuous |
3619 | pages. | |
7ddedebb | 3620 | |
7ddedebb TI |
3621 | Proc Interface |
3622 | ============== | |
3623 | ||
3624 | ALSA provides an easy interface for procfs. The proc files are very | |
3625 | useful for debugging. I recommend you set up proc files if you write a | |
3626 | driver and want to get a running status or register dumps. The API is | |
3627 | found in ``<sound/info.h>``. | |
3628 | ||
4d421eeb | 3629 | To create a proc file, call :c:func:`snd_card_proc_new()`:: |
7ddedebb TI |
3630 | |
3631 | struct snd_info_entry *entry; | |
3632 | int err = snd_card_proc_new(card, "my-file", &entry); | |
3633 | ||
3634 | where the second argument specifies the name of the proc file to be | |
3635 | created. The above example will create a file ``my-file`` under the | |
3636 | card directory, e.g. ``/proc/asound/card0/my-file``. | |
3637 | ||
3638 | Like other components, the proc entry created via | |
3639 | :c:func:`snd_card_proc_new()` will be registered and released | |
3640 | automatically in the card registration and release functions. | |
3641 | ||
3642 | When the creation is successful, the function stores a new instance in | |
3643 | the pointer given in the third argument. It is initialized as a text | |
3644 | proc file for read only. To use this proc file as a read-only text file | |
4d421eeb OB |
3645 | as-is, set the read callback with private data via |
3646 | :c:func:`snd_info_set_text_ops()`:: | |
7ddedebb TI |
3647 | |
3648 | snd_info_set_text_ops(entry, chip, my_proc_read); | |
3649 | ||
3650 | where the second argument (``chip``) is the private data to be used in | |
4d421eeb | 3651 | the callback. The third parameter specifies the read buffer size and |
7ddedebb | 3652 | the fourth (``my_proc_read``) is the callback function, which is |
4d421eeb | 3653 | defined like:: |
7ddedebb TI |
3654 | |
3655 | static void my_proc_read(struct snd_info_entry *entry, | |
3656 | struct snd_info_buffer *buffer); | |
3657 | ||
3658 | In the read callback, use :c:func:`snd_iprintf()` for output | |
3659 | strings, which works just like normal :c:func:`printf()`. For | |
4d421eeb | 3660 | example:: |
7ddedebb TI |
3661 | |
3662 | static void my_proc_read(struct snd_info_entry *entry, | |
3663 | struct snd_info_buffer *buffer) | |
3664 | { | |
3665 | struct my_chip *chip = entry->private_data; | |
3666 | ||
3667 | snd_iprintf(buffer, "This is my chip!\n"); | |
3668 | snd_iprintf(buffer, "Port = %ld\n", chip->port); | |
3669 | } | |
3670 | ||
4d421eeb | 3671 | The file permissions can be changed afterwards. By default, they are |
7ddedebb | 3672 | read only for all users. If you want to add write permission for the |
4d421eeb | 3673 | user (root by default), do as follows:: |
7ddedebb TI |
3674 | |
3675 | entry->mode = S_IFREG | S_IRUGO | S_IWUSR; | |
3676 | ||
4d421eeb | 3677 | and set the write buffer size and the callback:: |
7ddedebb TI |
3678 | |
3679 | entry->c.text.write = my_proc_write; | |
3680 | ||
4d421eeb | 3681 | In the write callback, you can use :c:func:`snd_info_get_line()` |
7ddedebb TI |
3682 | to get a text line, and :c:func:`snd_info_get_str()` to retrieve |
3683 | a string from the line. Some examples are found in | |
3684 | ``core/oss/mixer_oss.c``, core/oss/and ``pcm_oss.c``. | |
3685 | ||
4d421eeb | 3686 | For a raw-data proc-file, set the attributes as follows:: |
7ddedebb | 3687 | |
d25ff268 | 3688 | static const struct snd_info_entry_ops my_file_io_ops = { |
7ddedebb TI |
3689 | .read = my_file_io_read, |
3690 | }; | |
3691 | ||
3692 | entry->content = SNDRV_INFO_CONTENT_DATA; | |
3693 | entry->private_data = chip; | |
3694 | entry->c.ops = &my_file_io_ops; | |
3695 | entry->size = 4096; | |
3696 | entry->mode = S_IFREG | S_IRUGO; | |
3697 | ||
4d421eeb | 3698 | For raw data, ``size`` field must be set properly. This specifies |
7ddedebb TI |
3699 | the maximum size of the proc file access. |
3700 | ||
3701 | The read/write callbacks of raw mode are more direct than the text mode. | |
3702 | You need to use a low-level I/O functions such as | |
4d421eeb OB |
3703 | :c:func:`copy_from_user()` and :c:func:`copy_to_user()` to transfer the |
3704 | data:: | |
7ddedebb TI |
3705 | |
3706 | static ssize_t my_file_io_read(struct snd_info_entry *entry, | |
3707 | void *file_private_data, | |
3708 | struct file *file, | |
3709 | char *buf, | |
3710 | size_t count, | |
3711 | loff_t pos) | |
3712 | { | |
3713 | if (copy_to_user(buf, local_data + pos, count)) | |
3714 | return -EFAULT; | |
3715 | return count; | |
3716 | } | |
3717 | ||
3718 | If the size of the info entry has been set up properly, ``count`` and | |
3719 | ``pos`` are guaranteed to fit within 0 and the given size. You don't | |
3720 | have to check the range in the callbacks unless any other condition is | |
3721 | required. | |
3722 | ||
3723 | Power Management | |
3724 | ================ | |
3725 | ||
3726 | If the chip is supposed to work with suspend/resume functions, you need | |
3727 | to add power-management code to the driver. The additional code for | |
f90afe79 | 3728 | power-management should be ifdef-ed with ``CONFIG_PM``, or annotated |
4d421eeb | 3729 | with __maybe_unused attribute; otherwise the compiler will complain. |
7ddedebb TI |
3730 | |
3731 | If the driver *fully* supports suspend/resume that is, the device can be | |
3732 | properly resumed to its state when suspend was called, you can set the | |
4d421eeb | 3733 | ``SNDRV_PCM_INFO_RESUME`` flag in the PCM info field. Usually, this is |
7ddedebb TI |
3734 | possible when the registers of the chip can be safely saved and restored |
3735 | to RAM. If this is set, the trigger callback is called with | |
3736 | ``SNDRV_PCM_TRIGGER_RESUME`` after the resume callback completes. | |
3737 | ||
3738 | Even if the driver doesn't support PM fully but partial suspend/resume | |
3739 | is still possible, it's still worthy to implement suspend/resume | |
3740 | callbacks. In such a case, applications would reset the status by | |
3741 | calling :c:func:`snd_pcm_prepare()` and restart the stream | |
3742 | appropriately. Hence, you can define suspend/resume callbacks below but | |
4d421eeb | 3743 | don't set the ``SNDRV_PCM_INFO_RESUME`` info flag to the PCM. |
7ddedebb TI |
3744 | |
3745 | Note that the trigger with SUSPEND can always be called when | |
3746 | :c:func:`snd_pcm_suspend_all()` is called, regardless of the | |
3747 | ``SNDRV_PCM_INFO_RESUME`` flag. The ``RESUME`` flag affects only the | |
3748 | behavior of :c:func:`snd_pcm_resume()`. (Thus, in theory, | |
3749 | ``SNDRV_PCM_TRIGGER_RESUME`` isn't needed to be handled in the trigger | |
3750 | callback when no ``SNDRV_PCM_INFO_RESUME`` flag is set. But, it's better | |
3751 | to keep it for compatibility reasons.) | |
3752 | ||
4d421eeb | 3753 | The driver needs to define the |
7ddedebb | 3754 | suspend/resume hooks according to the bus the device is connected to. In |
4d421eeb | 3755 | the case of PCI drivers, the callbacks look like below:: |
7ddedebb | 3756 | |
f90afe79 | 3757 | static int __maybe_unused snd_my_suspend(struct device *dev) |
7ddedebb TI |
3758 | { |
3759 | .... /* do things for suspend */ | |
3760 | return 0; | |
3761 | } | |
f90afe79 | 3762 | static int __maybe_unused snd_my_resume(struct device *dev) |
7ddedebb TI |
3763 | { |
3764 | .... /* do things for suspend */ | |
3765 | return 0; | |
3766 | } | |
7ddedebb | 3767 | |
4d421eeb | 3768 | The scheme of the real suspend job is as follows: |
7ddedebb TI |
3769 | |
3770 | 1. Retrieve the card and the chip data. | |
3771 | ||
3772 | 2. Call :c:func:`snd_power_change_state()` with | |
3773 | ``SNDRV_CTL_POWER_D3hot`` to change the power status. | |
3774 | ||
910e7e19 | 3775 | 3. If AC97 codecs are used, call :c:func:`snd_ac97_suspend()` for |
7ddedebb TI |
3776 | each codec. |
3777 | ||
910e7e19 | 3778 | 4. Save the register values if necessary. |
7ddedebb | 3779 | |
910e7e19 | 3780 | 5. Stop the hardware if necessary. |
7ddedebb | 3781 | |
4d421eeb | 3782 | Typical code would look like:: |
7ddedebb | 3783 | |
f90afe79 | 3784 | static int __maybe_unused mychip_suspend(struct device *dev) |
7ddedebb TI |
3785 | { |
3786 | /* (1) */ | |
f90afe79 | 3787 | struct snd_card *card = dev_get_drvdata(dev); |
7ddedebb TI |
3788 | struct mychip *chip = card->private_data; |
3789 | /* (2) */ | |
3790 | snd_power_change_state(card, SNDRV_CTL_POWER_D3hot); | |
3791 | /* (3) */ | |
7ddedebb | 3792 | snd_ac97_suspend(chip->ac97); |
910e7e19 | 3793 | /* (4) */ |
7ddedebb | 3794 | snd_mychip_save_registers(chip); |
910e7e19 | 3795 | /* (5) */ |
7ddedebb | 3796 | snd_mychip_stop_hardware(chip); |
7ddedebb TI |
3797 | return 0; |
3798 | } | |
3799 | ||
3800 | ||
4d421eeb | 3801 | The scheme of the real resume job is as follows: |
7ddedebb TI |
3802 | |
3803 | 1. Retrieve the card and the chip data. | |
3804 | ||
f90afe79 | 3805 | 2. Re-initialize the chip. |
7ddedebb | 3806 | |
f90afe79 | 3807 | 3. Restore the saved registers if necessary. |
7ddedebb | 3808 | |
4d421eeb | 3809 | 4. Resume the mixer, e.g. by calling :c:func:`snd_ac97_resume()`. |
7ddedebb | 3810 | |
f90afe79 | 3811 | 5. Restart the hardware (if any). |
7ddedebb | 3812 | |
f90afe79 | 3813 | 6. Call :c:func:`snd_power_change_state()` with |
7ddedebb TI |
3814 | ``SNDRV_CTL_POWER_D0`` to notify the processes. |
3815 | ||
4d421eeb | 3816 | Typical code would look like:: |
7ddedebb | 3817 | |
f90afe79 | 3818 | static int __maybe_unused mychip_resume(struct pci_dev *pci) |
7ddedebb TI |
3819 | { |
3820 | /* (1) */ | |
f90afe79 | 3821 | struct snd_card *card = dev_get_drvdata(dev); |
7ddedebb TI |
3822 | struct mychip *chip = card->private_data; |
3823 | /* (2) */ | |
7ddedebb | 3824 | snd_mychip_reinit_chip(chip); |
f90afe79 | 3825 | /* (3) */ |
7ddedebb | 3826 | snd_mychip_restore_registers(chip); |
f90afe79 | 3827 | /* (4) */ |
7ddedebb | 3828 | snd_ac97_resume(chip->ac97); |
f90afe79 | 3829 | /* (5) */ |
7ddedebb | 3830 | snd_mychip_restart_chip(chip); |
f90afe79 | 3831 | /* (6) */ |
7ddedebb TI |
3832 | snd_power_change_state(card, SNDRV_CTL_POWER_D0); |
3833 | return 0; | |
3834 | } | |
3835 | ||
910e7e19 TI |
3836 | Note that, at the time this callback gets called, the PCM stream has |
3837 | been already suspended via its own PM ops calling | |
3838 | :c:func:`snd_pcm_suspend_all()` internally. | |
7ddedebb TI |
3839 | |
3840 | OK, we have all callbacks now. Let's set them up. In the initialization | |
3841 | of the card, make sure that you can get the chip data from the card | |
3842 | instance, typically via ``private_data`` field, in case you created the | |
4d421eeb | 3843 | chip data individually:: |
7ddedebb TI |
3844 | |
3845 | static int snd_mychip_probe(struct pci_dev *pci, | |
3846 | const struct pci_device_id *pci_id) | |
3847 | { | |
3848 | .... | |
3849 | struct snd_card *card; | |
3850 | struct mychip *chip; | |
3851 | int err; | |
3852 | .... | |
3853 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
3854 | 0, &card); | |
3855 | .... | |
3856 | chip = kzalloc(sizeof(*chip), GFP_KERNEL); | |
3857 | .... | |
3858 | card->private_data = chip; | |
3859 | .... | |
3860 | } | |
3861 | ||
3862 | When you created the chip data with :c:func:`snd_card_new()`, it's | |
4d421eeb | 3863 | anyway accessible via ``private_data`` field:: |
7ddedebb TI |
3864 | |
3865 | static int snd_mychip_probe(struct pci_dev *pci, | |
3866 | const struct pci_device_id *pci_id) | |
3867 | { | |
3868 | .... | |
3869 | struct snd_card *card; | |
3870 | struct mychip *chip; | |
3871 | int err; | |
3872 | .... | |
3873 | err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE, | |
3874 | sizeof(struct mychip), &card); | |
3875 | .... | |
3876 | chip = card->private_data; | |
3877 | .... | |
3878 | } | |
3879 | ||
4d421eeb | 3880 | If you need space to save the registers, allocate the buffer for it |
7ddedebb TI |
3881 | here, too, since it would be fatal if you cannot allocate a memory in |
3882 | the suspend phase. The allocated buffer should be released in the | |
3883 | corresponding destructor. | |
3884 | ||
4d421eeb | 3885 | And next, set suspend/resume callbacks to the pci_driver:: |
7ddedebb | 3886 | |
f90afe79 TI |
3887 | static SIMPLE_DEV_PM_OPS(snd_my_pm_ops, mychip_suspend, mychip_resume); |
3888 | ||
7ddedebb TI |
3889 | static struct pci_driver driver = { |
3890 | .name = KBUILD_MODNAME, | |
3891 | .id_table = snd_my_ids, | |
3892 | .probe = snd_my_probe, | |
3893 | .remove = snd_my_remove, | |
f90afe79 | 3894 | .driver.pm = &snd_my_pm_ops, |
7ddedebb TI |
3895 | }; |
3896 | ||
3897 | Module Parameters | |
3898 | ================= | |
3899 | ||
3900 | There are standard module options for ALSA. At least, each module should | |
3901 | have the ``index``, ``id`` and ``enable`` options. | |
3902 | ||
3903 | If the module supports multiple cards (usually up to 8 = ``SNDRV_CARDS`` | |
3904 | cards), they should be arrays. The default initial values are defined | |
4d421eeb | 3905 | already as constants for easier programming:: |
7ddedebb TI |
3906 | |
3907 | static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; | |
3908 | static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; | |
3909 | static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; | |
3910 | ||
3911 | If the module supports only a single card, they could be single | |
3912 | variables, instead. ``enable`` option is not always necessary in this | |
3913 | case, but it would be better to have a dummy option for compatibility. | |
3914 | ||
3915 | The module parameters must be declared with the standard | |
f90afe79 | 3916 | ``module_param()``, ``module_param_array()`` and |
7ddedebb TI |
3917 | :c:func:`MODULE_PARM_DESC()` macros. |
3918 | ||
4d421eeb | 3919 | Typical code would look as below:: |
7ddedebb TI |
3920 | |
3921 | #define CARD_NAME "My Chip" | |
3922 | ||
3923 | module_param_array(index, int, NULL, 0444); | |
3924 | MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard."); | |
3925 | module_param_array(id, charp, NULL, 0444); | |
3926 | MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard."); | |
3927 | module_param_array(enable, bool, NULL, 0444); | |
3928 | MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard."); | |
3929 | ||
f90afe79 TI |
3930 | Also, don't forget to define the module description and the license. |
3931 | Especially, the recent modprobe requires to define the | |
4d421eeb | 3932 | module license as GPL, etc., otherwise the system is shown as “tainted”:: |
7ddedebb | 3933 | |
f90afe79 | 3934 | MODULE_DESCRIPTION("Sound driver for My Chip"); |
7ddedebb | 3935 | MODULE_LICENSE("GPL"); |
7ddedebb TI |
3936 | |
3937 | ||
ac327f1b TI |
3938 | Device-Managed Resources |
3939 | ======================== | |
3940 | ||
3941 | In the examples above, all resources are allocated and released | |
3942 | manually. But human beings are lazy in nature, especially developers | |
3943 | are lazier. So there are some ways to automate the release part; it's | |
3944 | the (device-)managed resources aka devres or devm family. For | |
3945 | example, an object allocated via :c:func:`devm_kmalloc()` will be | |
3946 | freed automatically at unbinding the device. | |
3947 | ||
3948 | ALSA core provides also the device-managed helper, namely, | |
3949 | :c:func:`snd_devm_card_new()` for creating a card object. | |
3950 | Call this functions instead of the normal :c:func:`snd_card_new()`, | |
3951 | and you can forget the explicit :c:func:`snd_card_free()` call, as | |
3952 | it's called automagically at error and removal paths. | |
3953 | ||
3954 | One caveat is that the call of :c:func:`snd_card_free()` would be put | |
3955 | at the beginning of the call chain only after you call | |
3956 | :c:func:`snd_card_register()`. | |
3957 | ||
3958 | Also, the ``private_free`` callback is always called at the card free, | |
3959 | so be careful to put the hardware clean-up procedure in | |
3960 | ``private_free`` callback. It might be called even before you | |
3961 | actually set up at an earlier error path. For avoiding such an | |
3962 | invalid initialization, you can set ``private_free`` callback after | |
3963 | :c:func:`snd_card_register()` call succeeds. | |
3964 | ||
3965 | Another thing to be remarked is that you should use device-managed | |
3966 | helpers for each component as much as possible once when you manage | |
3967 | the card in that way. Mixing up with the normal and the managed | |
3968 | resources may screw up the release order. | |
3969 | ||
3970 | ||
7ddedebb TI |
3971 | How To Put Your Driver Into ALSA Tree |
3972 | ===================================== | |
3973 | ||
3974 | General | |
3975 | ------- | |
3976 | ||
3977 | So far, you've learned how to write the driver codes. And you might have | |
3978 | a question now: how to put my own driver into the ALSA driver tree? Here | |
3979 | (finally :) the standard procedure is described briefly. | |
3980 | ||
3981 | Suppose that you create a new PCI driver for the card “xyz”. The card | |
3982 | module name would be snd-xyz. The new driver is usually put into the | |
f90afe79 TI |
3983 | alsa-driver tree, ``sound/pci`` directory in the case of PCI |
3984 | cards. | |
7ddedebb TI |
3985 | |
3986 | In the following sections, the driver code is supposed to be put into | |
f90afe79 | 3987 | Linux kernel tree. The two cases are covered: a driver consisting of a |
7ddedebb TI |
3988 | single source file and one consisting of several source files. |
3989 | ||
3990 | Driver with A Single Source File | |
3991 | -------------------------------- | |
3992 | ||
f90afe79 | 3993 | 1. Modify sound/pci/Makefile |
7ddedebb | 3994 | |
4d421eeb | 3995 | Suppose you have a file xyz.c. Add the following two lines:: |
7ddedebb TI |
3996 | |
3997 | snd-xyz-objs := xyz.o | |
3998 | obj-$(CONFIG_SND_XYZ) += snd-xyz.o | |
3999 | ||
4000 | 2. Create the Kconfig entry | |
4001 | ||
4d421eeb OB |
4002 | Add the new entry of Kconfig for your xyz driver:: |
4003 | ||
4004 | config SND_XYZ | |
4005 | tristate "Foobar XYZ" | |
4006 | depends on SND | |
4007 | select SND_PCM | |
4008 | help | |
4009 | Say Y here to include support for Foobar XYZ soundcard. | |
4010 | To compile this driver as a module, choose M here: | |
4011 | the module will be called snd-xyz. | |
4012 | ||
4013 | The line ``select SND_PCM`` specifies that the driver xyz supports PCM. | |
4014 | In addition to SND_PCM, the following components are supported for | |
4015 | select command: SND_RAWMIDI, SND_TIMER, SND_HWDEP, SND_MPU401_UART, | |
4016 | SND_OPL3_LIB, SND_OPL4_LIB, SND_VX_LIB, SND_AC97_CODEC. | |
4017 | Add the select command for each supported component. | |
7ddedebb | 4018 | |
4d421eeb OB |
4019 | Note that some selections imply the lowlevel selections. For example, |
4020 | PCM includes TIMER, MPU401_UART includes RAWMIDI, AC97_CODEC | |
4021 | includes PCM, and OPL3_LIB includes HWDEP. You don't need to give | |
4022 | the lowlevel selections again. | |
7ddedebb | 4023 | |
4d421eeb | 4024 | For the details of Kconfig script, refer to the kbuild documentation. |
7ddedebb | 4025 | |
7ddedebb TI |
4026 | Drivers with Several Source Files |
4027 | --------------------------------- | |
4028 | ||
4029 | Suppose that the driver snd-xyz have several source files. They are | |
f90afe79 | 4030 | located in the new subdirectory, sound/pci/xyz. |
7ddedebb | 4031 | |
f90afe79 | 4032 | 1. Add a new directory (``sound/pci/xyz``) in ``sound/pci/Makefile`` |
4d421eeb | 4033 | as below:: |
7ddedebb | 4034 | |
f90afe79 | 4035 | obj-$(CONFIG_SND) += sound/pci/xyz/ |
7ddedebb TI |
4036 | |
4037 | ||
4d421eeb | 4038 | 2. Under the directory ``sound/pci/xyz``, create a Makefile:: |
7ddedebb | 4039 | |
7ddedebb | 4040 | snd-xyz-objs := xyz.o abc.o def.o |
7ddedebb TI |
4041 | obj-$(CONFIG_SND_XYZ) += snd-xyz.o |
4042 | ||
7ddedebb TI |
4043 | 3. Create the Kconfig entry |
4044 | ||
4045 | This procedure is as same as in the last section. | |
4046 | ||
7ddedebb TI |
4047 | |
4048 | Useful Functions | |
4049 | ================ | |
4050 | ||
4051 | :c:func:`snd_printk()` and friends | |
f90afe79 TI |
4052 | ---------------------------------- |
4053 | ||
4054 | .. note:: This subsection describes a few helper functions for | |
4055 | decorating a bit more on the standard :c:func:`printk()` & co. | |
4056 | However, in general, the use of such helpers is no longer recommended. | |
4057 | If possible, try to stick with the standard functions like | |
4058 | :c:func:`dev_err()` or :c:func:`pr_err()`. | |
7ddedebb TI |
4059 | |
4060 | ALSA provides a verbose version of the :c:func:`printk()` function. | |
4061 | If a kernel config ``CONFIG_SND_VERBOSE_PRINTK`` is set, this function | |
4062 | prints the given message together with the file name and the line of the | |
4063 | caller. The ``KERN_XXX`` prefix is processed as well as the original | |
4064 | :c:func:`printk()` does, so it's recommended to add this prefix, | |
4065 | e.g. snd_printk(KERN_ERR "Oh my, sorry, it's extremely bad!\\n"); | |
4066 | ||
4067 | There are also :c:func:`printk()`'s for debugging. | |
4068 | :c:func:`snd_printd()` can be used for general debugging purposes. | |
4069 | If ``CONFIG_SND_DEBUG`` is set, this function is compiled, and works | |
4070 | just like :c:func:`snd_printk()`. If the ALSA is compiled without | |
4071 | the debugging flag, it's ignored. | |
4072 | ||
4073 | :c:func:`snd_printdd()` is compiled in only when | |
f90afe79 | 4074 | ``CONFIG_SND_DEBUG_VERBOSE`` is set. |
7ddedebb TI |
4075 | |
4076 | :c:func:`snd_BUG()` | |
f90afe79 | 4077 | ------------------- |
7ddedebb TI |
4078 | |
4079 | It shows the ``BUG?`` message and stack trace as well as | |
4080 | :c:func:`snd_BUG_ON()` at the point. It's useful to show that a | |
4081 | fatal error happens there. | |
4082 | ||
4083 | When no debug flag is set, this macro is ignored. | |
4084 | ||
4085 | :c:func:`snd_BUG_ON()` | |
f90afe79 | 4086 | ---------------------- |
7ddedebb TI |
4087 | |
4088 | :c:func:`snd_BUG_ON()` macro is similar with | |
4089 | :c:func:`WARN_ON()` macro. For example, snd_BUG_ON(!pointer); or | |
4090 | it can be used as the condition, if (snd_BUG_ON(non_zero_is_bug)) | |
4091 | return -EINVAL; | |
4092 | ||
4093 | The macro takes an conditional expression to evaluate. When | |
4094 | ``CONFIG_SND_DEBUG``, is set, if the expression is non-zero, it shows | |
4095 | the warning message such as ``BUG? (xxx)`` normally followed by stack | |
4096 | trace. In both cases it returns the evaluated value. | |
4097 | ||
4098 | Acknowledgments | |
4099 | =============== | |
4100 | ||
4101 | I would like to thank Phil Kerr for his help for improvement and | |
4102 | corrections of this document. | |
4103 | ||
4104 | Kevin Conder reformatted the original plain-text to the DocBook format. | |
4105 | ||
4106 | Giuliano Pochini corrected typos and contributed the example codes in | |
4107 | the hardware constraints section. |