tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * linux/sound/soc.h -- ALSA SoC Layer
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __LINUX_SND_SOC_H
14#define __LINUX_SND_SOC_H
15
16#include <linux/platform_device.h>
17#include <linux/types.h>
18#include <linux/workqueue.h>
19#include <linux/interrupt.h>
20#include <linux/kernel.h>
21#include <sound/core.h>
22#include <sound/pcm.h>
23#include <sound/control.h>
24#include <sound/ac97_codec.h>
25
26/*
27 * Convenience kcontrol builders
28 */
29#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
30 ((unsigned long)&(struct soc_mixer_control) \
31 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
32 .invert = xinvert})
33#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
34 ((unsigned long)&(struct soc_mixer_control) \
35 {.reg = xreg, .max = xmax, .invert = xinvert})
36#define SOC_SINGLE(xname, reg, shift, max, invert) \
37{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
38 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
39 .put = snd_soc_put_volsw, \
40 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
41#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
42{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
43 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
44 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
45 .tlv.p = (tlv_array), \
46 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
47 .put = snd_soc_put_volsw, \
48 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
49#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
50{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
51 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
52 .put = snd_soc_put_volsw, \
53 .private_value = (unsigned long)&(struct soc_mixer_control) \
54 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
55 .max = xmax, .invert = xinvert} }
56#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
57{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
58 .info = snd_soc_info_volsw_2r, \
59 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
60 .private_value = (unsigned long)&(struct soc_mixer_control) \
61 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
62 .max = xmax, .invert = xinvert} }
63#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
64{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
65 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
66 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
67 .tlv.p = (tlv_array), \
68 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
69 .put = snd_soc_put_volsw, \
70 .private_value = (unsigned long)&(struct soc_mixer_control) \
71 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
72 .max = xmax, .invert = xinvert} }
73#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
74{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
75 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
76 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
77 .tlv.p = (tlv_array), \
78 .info = snd_soc_info_volsw_2r, \
79 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
80 .private_value = (unsigned long)&(struct soc_mixer_control) \
81 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
82 .max = xmax, .invert = xinvert} }
83#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
84{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
85 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
86 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
87 .tlv.p = (tlv_array), \
88 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
89 .put = snd_soc_put_volsw_s8, \
90 .private_value = (unsigned long)&(struct soc_mixer_control) \
91 {.reg = xreg, .min = xmin, .max = xmax} }
92#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
93{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
94 .max = xmax, .texts = xtexts }
95#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
96 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
97#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
98{ .max = xmax, .texts = xtexts }
99#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
100{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
101 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
102#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
103 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
104#define SOC_ENUM(xname, xenum) \
105{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
106 .info = snd_soc_info_enum_double, \
107 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
108 .private_value = (unsigned long)&xenum }
109#define SOC_VALUE_ENUM(xname, xenum) \
110{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
111 .info = snd_soc_info_enum_double, \
112 .get = snd_soc_get_value_enum_double, \
113 .put = snd_soc_put_value_enum_double, \
114 .private_value = (unsigned long)&xenum }
115#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
116 xhandler_get, xhandler_put) \
117{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
118 .info = snd_soc_info_volsw, \
119 .get = xhandler_get, .put = xhandler_put, \
120 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
121#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
122 xhandler_get, xhandler_put, tlv_array) \
123{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
124 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
125 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
126 .tlv.p = (tlv_array), \
127 .info = snd_soc_info_volsw, \
128 .get = xhandler_get, .put = xhandler_put, \
129 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
130#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
131{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
132 .info = snd_soc_info_bool_ext, \
133 .get = xhandler_get, .put = xhandler_put, \
134 .private_value = xdata }
135#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
136{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
137 .info = snd_soc_info_enum_ext, \
138 .get = xhandler_get, .put = xhandler_put, \
139 .private_value = (unsigned long)&xenum }
140
141/*
142 * Bias levels
143 *
144 * @ON: Bias is fully on for audio playback and capture operations.
145 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
146 * stream start and stop operations.
147 * @STANDBY: Low power standby state when no playback/capture operations are
148 * in progress. NOTE: The transition time between STANDBY and ON
149 * should be as fast as possible and no longer than 10ms.
150 * @OFF: Power Off. No restrictions on transition times.
151 */
152enum snd_soc_bias_level {
153 SND_SOC_BIAS_ON,
154 SND_SOC_BIAS_PREPARE,
155 SND_SOC_BIAS_STANDBY,
156 SND_SOC_BIAS_OFF,
157};
158
159struct snd_jack;
160struct snd_soc_card;
161struct snd_soc_device;
162struct snd_soc_pcm_stream;
163struct snd_soc_ops;
164struct snd_soc_dai_mode;
165struct snd_soc_pcm_runtime;
166struct snd_soc_dai;
167struct snd_soc_platform;
168struct snd_soc_codec;
169struct soc_enum;
170struct snd_soc_ac97_ops;
171struct snd_soc_jack;
172struct snd_soc_jack_pin;
173#ifdef CONFIG_GPIOLIB
174struct snd_soc_jack_gpio;
175#endif
176
177typedef int (*hw_write_t)(void *,const char* ,int);
178typedef int (*hw_read_t)(void *,char* ,int);
179
180extern struct snd_ac97_bus_ops soc_ac97_ops;
181
182int snd_soc_register_platform(struct snd_soc_platform *platform);
183void snd_soc_unregister_platform(struct snd_soc_platform *platform);
184int snd_soc_register_codec(struct snd_soc_codec *codec);
185void snd_soc_unregister_codec(struct snd_soc_codec *codec);
186
187/* pcm <-> DAI connect */
188void snd_soc_free_pcms(struct snd_soc_device *socdev);
189int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
190int snd_soc_init_card(struct snd_soc_device *socdev);
191
192/* set runtime hw params */
193int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
194 const struct snd_pcm_hardware *hw);
195
196/* Jack reporting */
197int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
198 struct snd_soc_jack *jack);
199void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
200int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
201 struct snd_soc_jack_pin *pins);
202#ifdef CONFIG_GPIOLIB
203int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
204 struct snd_soc_jack_gpio *gpios);
205void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
206 struct snd_soc_jack_gpio *gpios);
207#endif
208
209/* codec IO */
210#define snd_soc_read(codec, reg) codec->read(codec, reg)
211#define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
212
213/* codec register bit access */
214int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
215 unsigned short mask, unsigned short value);
216int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
217 unsigned short mask, unsigned short value);
218
219int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
220 struct snd_ac97_bus_ops *ops, int num);
221void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
222
223/*
224 *Controls
225 */
226struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
227 void *data, char *long_name);
228int snd_soc_add_controls(struct snd_soc_codec *codec,
229 const struct snd_kcontrol_new *controls, int num_controls);
230int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
231 struct snd_ctl_elem_info *uinfo);
232int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
233 struct snd_ctl_elem_info *uinfo);
234int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
235 struct snd_ctl_elem_value *ucontrol);
236int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
237 struct snd_ctl_elem_value *ucontrol);
238int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
239 struct snd_ctl_elem_value *ucontrol);
240int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
241 struct snd_ctl_elem_value *ucontrol);
242int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
243 struct snd_ctl_elem_info *uinfo);
244int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
245 struct snd_ctl_elem_info *uinfo);
246#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
247int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
248 struct snd_ctl_elem_value *ucontrol);
249int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
250 struct snd_ctl_elem_value *ucontrol);
251int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
252 struct snd_ctl_elem_info *uinfo);
253int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
254 struct snd_ctl_elem_value *ucontrol);
255int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
256 struct snd_ctl_elem_value *ucontrol);
257int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
258 struct snd_ctl_elem_info *uinfo);
259int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
260 struct snd_ctl_elem_value *ucontrol);
261int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
262 struct snd_ctl_elem_value *ucontrol);
263
264/**
265 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
266 *
267 * @pin: name of the pin to update
268 * @mask: bits to check for in reported jack status
269 * @invert: if non-zero then pin is enabled when status is not reported
270 */
271struct snd_soc_jack_pin {
272 struct list_head list;
273 const char *pin;
274 int mask;
275 bool invert;
276};
277
278/**
279 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
280 *
281 * @gpio: gpio number
282 * @name: gpio name
283 * @report: value to report when jack detected
284 * @invert: report presence in low state
285 * @debouce_time: debouce time in ms
286 */
287#ifdef CONFIG_GPIOLIB
288struct snd_soc_jack_gpio {
289 unsigned int gpio;
290 const char *name;
291 int report;
292 int invert;
293 int debounce_time;
294 struct snd_soc_jack *jack;
295 struct work_struct work;
296};
297#endif
298
299struct snd_soc_jack {
300 struct snd_jack *jack;
301 struct snd_soc_card *card;
302 struct list_head pins;
303 int status;
304};
305
306/* SoC PCM stream information */
307struct snd_soc_pcm_stream {
308 char *stream_name;
309 u64 formats; /* SNDRV_PCM_FMTBIT_* */
310 unsigned int rates; /* SNDRV_PCM_RATE_* */
311 unsigned int rate_min; /* min rate */
312 unsigned int rate_max; /* max rate */
313 unsigned int channels_min; /* min channels */
314 unsigned int channels_max; /* max channels */
315 unsigned int active:1; /* stream is in use */
316};
317
318/* SoC audio ops */
319struct snd_soc_ops {
320 int (*startup)(struct snd_pcm_substream *);
321 void (*shutdown)(struct snd_pcm_substream *);
322 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
323 int (*hw_free)(struct snd_pcm_substream *);
324 int (*prepare)(struct snd_pcm_substream *);
325 int (*trigger)(struct snd_pcm_substream *, int);
326};
327
328/* SoC Audio Codec */
329struct snd_soc_codec {
330 char *name;
331 struct module *owner;
332 struct mutex mutex;
333 struct device *dev;
334
335 struct list_head list;
336
337 /* callbacks */
338 int (*set_bias_level)(struct snd_soc_codec *,
339 enum snd_soc_bias_level level);
340
341 /* runtime */
342 struct snd_card *card;
343 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
344 unsigned int active;
345 unsigned int pcm_devs;
346 void *private_data;
347
348 /* codec IO */
349 void *control_data; /* codec control (i2c/3wire) data */
350 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
351 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
352 int (*display_register)(struct snd_soc_codec *, char *,
353 size_t, unsigned int);
354 hw_write_t hw_write;
355 hw_read_t hw_read;
356 void *reg_cache;
357 short reg_cache_size;
358 short reg_cache_step;
359
360 /* dapm */
361 u32 pop_time;
362 struct list_head dapm_widgets;
363 struct list_head dapm_paths;
364 enum snd_soc_bias_level bias_level;
365 enum snd_soc_bias_level suspend_bias_level;
366 struct delayed_work delayed_work;
367
368 /* codec DAI's */
369 struct snd_soc_dai *dai;
370 unsigned int num_dai;
371
372#ifdef CONFIG_DEBUG_FS
373 struct dentry *debugfs_reg;
374 struct dentry *debugfs_pop_time;
375#endif
376};
377
378/* codec device */
379struct snd_soc_codec_device {
380 int (*probe)(struct platform_device *pdev);
381 int (*remove)(struct platform_device *pdev);
382 int (*suspend)(struct platform_device *pdev, pm_message_t state);
383 int (*resume)(struct platform_device *pdev);
384};
385
386/* SoC platform interface */
387struct snd_soc_platform {
388 char *name;
389 struct list_head list;
390
391 int (*probe)(struct platform_device *pdev);
392 int (*remove)(struct platform_device *pdev);
393 int (*suspend)(struct snd_soc_dai *dai);
394 int (*resume)(struct snd_soc_dai *dai);
395
396 /* pcm creation and destruction */
397 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
398 struct snd_pcm *);
399 void (*pcm_free)(struct snd_pcm *);
400
401 /* platform stream ops */
402 struct snd_pcm_ops *pcm_ops;
403};
404
405/* SoC machine DAI configuration, glues a codec and cpu DAI together */
406struct snd_soc_dai_link {
407 char *name; /* Codec name */
408 char *stream_name; /* Stream name */
409
410 /* DAI */
411 struct snd_soc_dai *codec_dai;
412 struct snd_soc_dai *cpu_dai;
413
414 /* machine stream operations */
415 struct snd_soc_ops *ops;
416
417 /* codec/machine specific init - e.g. add machine controls */
418 int (*init)(struct snd_soc_codec *codec);
419
420 /* DAI pcm */
421 struct snd_pcm *pcm;
422};
423
424/* SoC card */
425struct snd_soc_card {
426 char *name;
427 struct device *dev;
428
429 struct list_head list;
430
431 int instantiated;
432
433 int (*probe)(struct platform_device *pdev);
434 int (*remove)(struct platform_device *pdev);
435
436 /* the pre and post PM functions are used to do any PM work before and
437 * after the codec and DAI's do any PM work. */
438 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
439 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
440 int (*resume_pre)(struct platform_device *pdev);
441 int (*resume_post)(struct platform_device *pdev);
442
443 /* callbacks */
444 int (*set_bias_level)(struct snd_soc_card *,
445 enum snd_soc_bias_level level);
446
447 /* CPU <--> Codec DAI links */
448 struct snd_soc_dai_link *dai_link;
449 int num_links;
450
451 struct snd_soc_device *socdev;
452
453 struct snd_soc_codec *codec;
454
455 struct snd_soc_platform *platform;
456 struct delayed_work delayed_work;
457 struct work_struct deferred_resume_work;
458};
459
460/* SoC Device - the audio subsystem */
461struct snd_soc_device {
462 struct device *dev;
463 struct snd_soc_card *card;
464 struct snd_soc_codec_device *codec_dev;
465 void *codec_data;
466};
467
468/* runtime channel data */
469struct snd_soc_pcm_runtime {
470 struct snd_soc_dai_link *dai;
471 struct snd_soc_device *socdev;
472};
473
474/* mixer control */
475struct soc_mixer_control {
476 int min, max;
477 unsigned int reg, rreg, shift, rshift, invert;
478};
479
480/* enumerated kcontrol */
481struct soc_enum {
482 unsigned short reg;
483 unsigned short reg2;
484 unsigned char shift_l;
485 unsigned char shift_r;
486 unsigned int max;
487 unsigned int mask;
488 const char **texts;
489 const unsigned int *values;
490 void *dapm;
491};
492
493#include <sound/soc-dai.h>
494
495#endif