5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * Abramo Bagnara <abramo@alsa-project.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <sound/asound.h>
27 #include <sound/memalloc.h>
28 #include <sound/minors.h>
29 #include <linux/poll.h>
31 #include <linux/bitops.h>
32 #include <linux/pm_qos.h>
34 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
35 #define snd_pcm_chip(pcm) ((pcm)->private_data)
37 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
38 #include <sound/pcm_oss.h>
42 * Hardware (lowlevel) section
45 struct snd_pcm_hardware
{
46 unsigned int info
; /* SNDRV_PCM_INFO_* */
47 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
48 unsigned int rates
; /* SNDRV_PCM_RATE_* */
49 unsigned int rate_min
; /* min rate */
50 unsigned int rate_max
; /* max rate */
51 unsigned int channels_min
; /* min channels */
52 unsigned int channels_max
; /* max channels */
53 size_t buffer_bytes_max
; /* max buffer size */
54 size_t period_bytes_min
; /* min period size */
55 size_t period_bytes_max
; /* max period size */
56 unsigned int periods_min
; /* min # of periods */
57 unsigned int periods_max
; /* max # of periods */
58 size_t fifo_size
; /* fifo size in bytes */
61 struct snd_pcm_substream
;
64 int (*open
)(struct snd_pcm_substream
*substream
);
65 int (*close
)(struct snd_pcm_substream
*substream
);
66 int (*ioctl
)(struct snd_pcm_substream
* substream
,
67 unsigned int cmd
, void *arg
);
68 int (*hw_params
)(struct snd_pcm_substream
*substream
,
69 struct snd_pcm_hw_params
*params
);
70 int (*hw_free
)(struct snd_pcm_substream
*substream
);
71 int (*prepare
)(struct snd_pcm_substream
*substream
);
72 int (*trigger
)(struct snd_pcm_substream
*substream
, int cmd
);
73 snd_pcm_uframes_t (*pointer
)(struct snd_pcm_substream
*substream
);
74 int (*wall_clock
)(struct snd_pcm_substream
*substream
,
75 struct timespec
*audio_ts
);
76 int (*copy
)(struct snd_pcm_substream
*substream
, int channel
,
77 snd_pcm_uframes_t pos
,
78 void __user
*buf
, snd_pcm_uframes_t count
);
79 int (*silence
)(struct snd_pcm_substream
*substream
, int channel
,
80 snd_pcm_uframes_t pos
, snd_pcm_uframes_t count
);
81 struct page
*(*page
)(struct snd_pcm_substream
*substream
,
82 unsigned long offset
);
83 int (*mmap
)(struct snd_pcm_substream
*substream
, struct vm_area_struct
*vma
);
84 int (*ack
)(struct snd_pcm_substream
*substream
);
91 #if defined(CONFIG_SND_DYNAMIC_MINORS)
92 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
94 #define SNDRV_PCM_DEVICES 8
97 #define SNDRV_PCM_IOCTL1_RESET 0
98 #define SNDRV_PCM_IOCTL1_INFO 1
99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
100 #define SNDRV_PCM_IOCTL1_GSTATE 3
101 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
103 #define SNDRV_PCM_TRIGGER_STOP 0
104 #define SNDRV_PCM_TRIGGER_START 1
105 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
106 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
107 #define SNDRV_PCM_TRIGGER_SUSPEND 5
108 #define SNDRV_PCM_TRIGGER_RESUME 6
109 #define SNDRV_PCM_TRIGGER_DRAIN 7
111 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
113 /* If you change this don't forget to change rates[] table in pcm_native.c */
114 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
115 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
116 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
117 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
118 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
119 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
120 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
121 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
122 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
123 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
124 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
125 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
126 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
128 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
129 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
131 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
132 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
133 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
134 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
135 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
136 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
137 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
138 SNDRV_PCM_RATE_192000)
139 #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
140 #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
141 #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
142 #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
143 #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
144 #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
145 #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
146 #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
147 #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
148 #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
149 #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
150 #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
151 #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
152 #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
153 #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
154 #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
155 #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
156 #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
157 #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
158 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
159 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
160 #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
161 #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
162 #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
163 #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
164 #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
165 #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
166 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
167 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
168 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
169 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
170 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
171 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
172 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
173 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
174 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
175 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
176 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
177 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
178 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
179 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
180 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
181 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
182 #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
183 #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
184 #define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
185 #define SNDRV_PCM_FMTBIT_DSD_U16_BE _SNDRV_PCM_FMTBIT(DSD_U16_BE)
186 #define SNDRV_PCM_FMTBIT_DSD_U32_BE _SNDRV_PCM_FMTBIT(DSD_U32_BE)
188 #ifdef SNDRV_LITTLE_ENDIAN
189 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
190 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
191 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
192 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
193 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
194 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
195 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
196 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
197 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
199 #ifdef SNDRV_BIG_ENDIAN
200 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
201 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
202 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
203 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
204 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
205 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
206 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
207 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
208 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
211 struct snd_pcm_file
{
212 struct snd_pcm_substream
*substream
;
216 struct snd_pcm_hw_rule
;
217 typedef int (*snd_pcm_hw_rule_func_t
)(struct snd_pcm_hw_params
*params
,
218 struct snd_pcm_hw_rule
*rule
);
220 struct snd_pcm_hw_rule
{
222 snd_pcm_hw_rule_func_t func
;
228 struct snd_pcm_hw_constraints
{
229 struct snd_mask masks
[SNDRV_PCM_HW_PARAM_LAST_MASK
-
230 SNDRV_PCM_HW_PARAM_FIRST_MASK
+ 1];
231 struct snd_interval intervals
[SNDRV_PCM_HW_PARAM_LAST_INTERVAL
-
232 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
+ 1];
233 unsigned int rules_num
;
234 unsigned int rules_all
;
235 struct snd_pcm_hw_rule
*rules
;
238 static inline struct snd_mask
*constrs_mask(struct snd_pcm_hw_constraints
*constrs
,
239 snd_pcm_hw_param_t var
)
241 return &constrs
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
244 static inline struct snd_interval
*constrs_interval(struct snd_pcm_hw_constraints
*constrs
,
245 snd_pcm_hw_param_t var
)
247 return &constrs
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
252 unsigned int den_min
, den_max
, den_step
;
256 unsigned int num_min
, num_max
, num_step
;
260 struct snd_pcm_hw_constraint_ratnums
{
262 struct snd_ratnum
*rats
;
265 struct snd_pcm_hw_constraint_ratdens
{
267 struct snd_ratden
*rats
;
270 struct snd_pcm_hw_constraint_list
{
272 const unsigned int *list
;
276 struct snd_pcm_hw_constraint_ranges
{
278 const struct snd_interval
*ranges
;
282 struct snd_pcm_hwptr_log
;
284 struct snd_pcm_runtime
{
286 struct snd_pcm_substream
*trigger_master
;
287 struct timespec trigger_tstamp
; /* trigger timestamp */
288 bool trigger_tstamp_latched
; /* trigger timestamp latched in low-level driver/hardware */
290 snd_pcm_uframes_t avail_max
;
291 snd_pcm_uframes_t hw_ptr_base
; /* Position at buffer restart */
292 snd_pcm_uframes_t hw_ptr_interrupt
; /* Position at interrupt time */
293 unsigned long hw_ptr_jiffies
; /* Time when hw_ptr is updated */
294 unsigned long hw_ptr_buffer_jiffies
; /* buffer time in jiffies */
295 snd_pcm_sframes_t delay
; /* extra delay; typically FIFO size */
296 u64 hw_ptr_wrap
; /* offset for hw_ptr due to boundary wrap-around */
298 /* -- HW params -- */
299 snd_pcm_access_t access
; /* access mode */
300 snd_pcm_format_t format
; /* SNDRV_PCM_FORMAT_* */
301 snd_pcm_subformat_t subformat
; /* subformat */
302 unsigned int rate
; /* rate in Hz */
303 unsigned int channels
; /* channels */
304 snd_pcm_uframes_t period_size
; /* period size */
305 unsigned int periods
; /* periods */
306 snd_pcm_uframes_t buffer_size
; /* buffer size */
307 snd_pcm_uframes_t min_align
; /* Min alignment for the format */
309 unsigned int frame_bits
;
310 unsigned int sample_bits
;
312 unsigned int rate_num
;
313 unsigned int rate_den
;
314 unsigned int no_period_wakeup
: 1;
316 /* -- SW params -- */
317 int tstamp_mode
; /* mmap timestamp is updated */
318 unsigned int period_step
;
319 snd_pcm_uframes_t start_threshold
;
320 snd_pcm_uframes_t stop_threshold
;
321 snd_pcm_uframes_t silence_threshold
; /* Silence filling happens when
322 noise is nearest than this */
323 snd_pcm_uframes_t silence_size
; /* Silence filling size */
324 snd_pcm_uframes_t boundary
; /* pointers wrap point */
326 snd_pcm_uframes_t silence_start
; /* starting pointer to silence area */
327 snd_pcm_uframes_t silence_filled
; /* size filled with silence */
329 union snd_pcm_sync_id sync
; /* hardware synchronization ID */
332 struct snd_pcm_mmap_status
*status
;
333 struct snd_pcm_mmap_control
*control
;
335 /* -- locking / scheduling -- */
336 snd_pcm_uframes_t twake
; /* do transfer (!poll) wakeup if non-zero */
337 wait_queue_head_t sleep
; /* poll sleep */
338 wait_queue_head_t tsleep
; /* transfer sleep */
339 struct fasync_struct
*fasync
;
341 /* -- private section -- */
343 void (*private_free
)(struct snd_pcm_runtime
*runtime
);
345 /* -- hardware description -- */
346 struct snd_pcm_hardware hw
;
347 struct snd_pcm_hw_constraints hw_constraints
;
349 /* -- interrupt callbacks -- */
350 void (*transfer_ack_begin
)(struct snd_pcm_substream
*substream
);
351 void (*transfer_ack_end
)(struct snd_pcm_substream
*substream
);
354 unsigned int timer_resolution
; /* timer resolution */
355 int tstamp_type
; /* timestamp type */
358 unsigned char *dma_area
; /* DMA area */
359 dma_addr_t dma_addr
; /* physical bus address (not accessible from main CPU) */
360 size_t dma_bytes
; /* size of DMA area */
362 struct snd_dma_buffer
*dma_buffer_p
; /* allocated buffer */
364 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
365 /* -- OSS things -- */
366 struct snd_pcm_oss_runtime oss
;
369 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
370 struct snd_pcm_hwptr_log
*hwptr_log
;
374 struct snd_pcm_group
{ /* keep linked substreams */
377 struct list_head substreams
;
383 struct snd_pcm_substream
{
385 struct snd_pcm_str
*pstr
;
386 void *private_data
; /* copied from pcm->private_data */
388 char name
[32]; /* substream name */
389 int stream
; /* stream (direction) */
390 struct pm_qos_request latency_pm_qos_req
; /* pm_qos request */
391 size_t buffer_bytes_max
; /* limit ring buffer size */
392 struct snd_dma_buffer dma_buffer
;
394 /* -- hardware operations -- */
395 const struct snd_pcm_ops
*ops
;
396 /* -- runtime information -- */
397 struct snd_pcm_runtime
*runtime
;
398 /* -- timer section -- */
399 struct snd_timer
*timer
; /* timer */
400 unsigned timer_running
: 1; /* time is running */
401 /* -- next substream -- */
402 struct snd_pcm_substream
*next
;
403 /* -- linked substreams -- */
404 struct list_head link_list
; /* linked list member */
405 struct snd_pcm_group self_group
; /* fake group for non linked substream (with substream lock inside) */
406 struct snd_pcm_group
*group
; /* pointer to current group */
407 /* -- assigned files -- */
411 unsigned int f_flags
;
412 void (*pcm_release
)(struct snd_pcm_substream
*);
414 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
415 /* -- OSS things -- */
416 struct snd_pcm_oss_substream oss
;
418 #ifdef CONFIG_SND_VERBOSE_PROCFS
419 struct snd_info_entry
*proc_root
;
420 struct snd_info_entry
*proc_info_entry
;
421 struct snd_info_entry
*proc_hw_params_entry
;
422 struct snd_info_entry
*proc_sw_params_entry
;
423 struct snd_info_entry
*proc_status_entry
;
424 struct snd_info_entry
*proc_prealloc_entry
;
425 struct snd_info_entry
*proc_prealloc_max_entry
;
426 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
427 struct snd_info_entry
*proc_xrun_injection_entry
;
429 #endif /* CONFIG_SND_VERBOSE_PROCFS */
431 unsigned int hw_opened
: 1;
434 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
438 int stream
; /* stream (direction) */
440 /* -- substreams -- */
441 unsigned int substream_count
;
442 unsigned int substream_opened
;
443 struct snd_pcm_substream
*substream
;
444 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
445 /* -- OSS things -- */
446 struct snd_pcm_oss_stream oss
;
448 #ifdef CONFIG_SND_VERBOSE_PROCFS
449 struct snd_info_entry
*proc_root
;
450 struct snd_info_entry
*proc_info_entry
;
451 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
452 unsigned int xrun_debug
; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
453 struct snd_info_entry
*proc_xrun_debug_entry
;
456 struct snd_kcontrol
*chmap_kctl
; /* channel-mapping controls */
461 struct snd_card
*card
;
462 struct list_head list
;
463 int device
; /* device number */
464 unsigned int info_flags
;
465 unsigned short dev_class
;
466 unsigned short dev_subclass
;
469 struct snd_pcm_str streams
[2];
470 struct mutex open_mutex
;
471 wait_queue_head_t open_wait
;
473 void (*private_free
) (struct snd_pcm
*pcm
);
474 bool internal
; /* pcm is for internal use only */
475 bool nonatomic
; /* whole PCM operations are in non-atomic context */
476 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
477 struct snd_pcm_oss oss
;
481 struct snd_pcm_notify
{
482 int (*n_register
) (struct snd_pcm
* pcm
);
483 int (*n_disconnect
) (struct snd_pcm
* pcm
);
484 int (*n_unregister
) (struct snd_pcm
* pcm
);
485 struct list_head list
;
492 extern const struct file_operations snd_pcm_f_ops
[2];
494 int snd_pcm_new(struct snd_card
*card
, const char *id
, int device
,
495 int playback_count
, int capture_count
,
496 struct snd_pcm
**rpcm
);
497 int snd_pcm_new_internal(struct snd_card
*card
, const char *id
, int device
,
498 int playback_count
, int capture_count
,
499 struct snd_pcm
**rpcm
);
500 int snd_pcm_new_stream(struct snd_pcm
*pcm
, int stream
, int substream_count
);
502 int snd_pcm_notify(struct snd_pcm_notify
*notify
, int nfree
);
508 int snd_pcm_info(struct snd_pcm_substream
*substream
, struct snd_pcm_info
*info
);
509 int snd_pcm_info_user(struct snd_pcm_substream
*substream
,
510 struct snd_pcm_info __user
*info
);
511 int snd_pcm_status(struct snd_pcm_substream
*substream
,
512 struct snd_pcm_status
*status
);
513 int snd_pcm_start(struct snd_pcm_substream
*substream
);
514 int snd_pcm_stop(struct snd_pcm_substream
*substream
, snd_pcm_state_t status
);
515 int snd_pcm_drain_done(struct snd_pcm_substream
*substream
);
516 int snd_pcm_stop_xrun(struct snd_pcm_substream
*substream
);
518 int snd_pcm_suspend(struct snd_pcm_substream
*substream
);
519 int snd_pcm_suspend_all(struct snd_pcm
*pcm
);
521 int snd_pcm_kernel_ioctl(struct snd_pcm_substream
*substream
, unsigned int cmd
, void *arg
);
522 int snd_pcm_open_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
523 struct snd_pcm_substream
**rsubstream
);
524 void snd_pcm_release_substream(struct snd_pcm_substream
*substream
);
525 int snd_pcm_attach_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
526 struct snd_pcm_substream
**rsubstream
);
527 void snd_pcm_detach_substream(struct snd_pcm_substream
*substream
);
528 int snd_pcm_mmap_data(struct snd_pcm_substream
*substream
, struct file
*file
, struct vm_area_struct
*area
);
531 #ifdef CONFIG_SND_DEBUG
532 void snd_pcm_debug_name(struct snd_pcm_substream
*substream
,
533 char *name
, size_t len
);
536 snd_pcm_debug_name(struct snd_pcm_substream
*substream
, char *buf
, size_t size
)
547 * snd_pcm_stream_linked - Check whether the substream is linked with others
548 * @substream: substream to check
550 * Returns true if the given substream is being linked with others.
552 static inline int snd_pcm_stream_linked(struct snd_pcm_substream
*substream
)
554 return substream
->group
!= &substream
->self_group
;
557 void snd_pcm_stream_lock(struct snd_pcm_substream
*substream
);
558 void snd_pcm_stream_unlock(struct snd_pcm_substream
*substream
);
559 void snd_pcm_stream_lock_irq(struct snd_pcm_substream
*substream
);
560 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream
*substream
);
561 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream
*substream
);
564 * snd_pcm_stream_lock_irqsave - Lock the PCM stream
565 * @substream: PCM substream
568 * This locks the PCM stream like snd_pcm_stream_lock() but with the local
569 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
570 * as snd_pcm_stream_lock().
572 #define snd_pcm_stream_lock_irqsave(substream, flags) \
574 typecheck(unsigned long, flags); \
575 flags = _snd_pcm_stream_lock_irqsave(substream); \
577 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream
*substream
,
578 unsigned long flags
);
581 * snd_pcm_group_for_each_entry - iterate over the linked substreams
583 * @substream: the substream
585 * Iterate over the all linked substreams to the given @substream.
586 * When @substream isn't linked with any others, this gives returns @substream
589 #define snd_pcm_group_for_each_entry(s, substream) \
590 list_for_each_entry(s, &substream->group->substreams, link_list)
593 * snd_pcm_running - Check whether the substream is in a running state
594 * @substream: substream to check
596 * Returns true if the given substream is in the state RUNNING, or in the
597 * state DRAINING for playback.
599 static inline int snd_pcm_running(struct snd_pcm_substream
*substream
)
601 return (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_RUNNING
||
602 (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_DRAINING
&&
603 substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
));
607 * bytes_to_samples - Unit conversion of the size from bytes to samples
608 * @runtime: PCM runtime instance
609 * @size: size in bytes
611 static inline ssize_t
bytes_to_samples(struct snd_pcm_runtime
*runtime
, ssize_t size
)
613 return size
* 8 / runtime
->sample_bits
;
617 * bytes_to_frames - Unit conversion of the size from bytes to frames
618 * @runtime: PCM runtime instance
619 * @size: size in bytes
621 static inline snd_pcm_sframes_t
bytes_to_frames(struct snd_pcm_runtime
*runtime
, ssize_t size
)
623 return size
* 8 / runtime
->frame_bits
;
627 * samples_to_bytes - Unit conversion of the size from samples to bytes
628 * @runtime: PCM runtime instance
629 * @size: size in samples
631 static inline ssize_t
samples_to_bytes(struct snd_pcm_runtime
*runtime
, ssize_t size
)
633 return size
* runtime
->sample_bits
/ 8;
637 * frames_to_bytes - Unit conversion of the size from frames to bytes
638 * @runtime: PCM runtime instance
639 * @size: size in frames
641 static inline ssize_t
frames_to_bytes(struct snd_pcm_runtime
*runtime
, snd_pcm_sframes_t size
)
643 return size
* runtime
->frame_bits
/ 8;
647 * frame_aligned - Check whether the byte size is aligned to frames
648 * @runtime: PCM runtime instance
649 * @bytes: size in bytes
651 static inline int frame_aligned(struct snd_pcm_runtime
*runtime
, ssize_t bytes
)
653 return bytes
% runtime
->byte_align
== 0;
657 * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
658 * @substream: PCM substream
660 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream
*substream
)
662 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
663 return frames_to_bytes(runtime
, runtime
->buffer_size
);
667 * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
668 * @substream: PCM substream
670 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream
*substream
)
672 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
673 return frames_to_bytes(runtime
, runtime
->period_size
);
677 * snd_pcm_playback_avail - Get the available (writable) space for playback
678 * @runtime: PCM runtime instance
680 * Result is between 0 ... (boundary - 1)
682 static inline snd_pcm_uframes_t
snd_pcm_playback_avail(struct snd_pcm_runtime
*runtime
)
684 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
+ runtime
->buffer_size
- runtime
->control
->appl_ptr
;
686 avail
+= runtime
->boundary
;
687 else if ((snd_pcm_uframes_t
) avail
>= runtime
->boundary
)
688 avail
-= runtime
->boundary
;
693 * snd_pcm_playback_avail - Get the available (readable) space for capture
694 * @runtime: PCM runtime instance
696 * Result is between 0 ... (boundary - 1)
698 static inline snd_pcm_uframes_t
snd_pcm_capture_avail(struct snd_pcm_runtime
*runtime
)
700 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
- runtime
->control
->appl_ptr
;
702 avail
+= runtime
->boundary
;
707 * snd_pcm_playback_hw_avail - Get the queued space for playback
708 * @runtime: PCM runtime instance
710 static inline snd_pcm_sframes_t
snd_pcm_playback_hw_avail(struct snd_pcm_runtime
*runtime
)
712 return runtime
->buffer_size
- snd_pcm_playback_avail(runtime
);
716 * snd_pcm_capture_hw_avail - Get the free space for capture
717 * @runtime: PCM runtime instance
719 static inline snd_pcm_sframes_t
snd_pcm_capture_hw_avail(struct snd_pcm_runtime
*runtime
)
721 return runtime
->buffer_size
- snd_pcm_capture_avail(runtime
);
725 * snd_pcm_playback_ready - check whether the playback buffer is available
726 * @substream: the pcm substream instance
728 * Checks whether enough free space is available on the playback buffer.
730 * Return: Non-zero if available, or zero if not.
732 static inline int snd_pcm_playback_ready(struct snd_pcm_substream
*substream
)
734 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
735 return snd_pcm_playback_avail(runtime
) >= runtime
->control
->avail_min
;
739 * snd_pcm_capture_ready - check whether the capture buffer is available
740 * @substream: the pcm substream instance
742 * Checks whether enough capture data is available on the capture buffer.
744 * Return: Non-zero if available, or zero if not.
746 static inline int snd_pcm_capture_ready(struct snd_pcm_substream
*substream
)
748 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
749 return snd_pcm_capture_avail(runtime
) >= runtime
->control
->avail_min
;
753 * snd_pcm_playback_data - check whether any data exists on the playback buffer
754 * @substream: the pcm substream instance
756 * Checks whether any data exists on the playback buffer.
758 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
759 * is bigger or equal to boundary, then this function returns always non-zero.
761 static inline int snd_pcm_playback_data(struct snd_pcm_substream
*substream
)
763 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
765 if (runtime
->stop_threshold
>= runtime
->boundary
)
767 return snd_pcm_playback_avail(runtime
) < runtime
->buffer_size
;
771 * snd_pcm_playback_empty - check whether the playback buffer is empty
772 * @substream: the pcm substream instance
774 * Checks whether the playback buffer is empty.
776 * Return: Non-zero if empty, or zero if not.
778 static inline int snd_pcm_playback_empty(struct snd_pcm_substream
*substream
)
780 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
781 return snd_pcm_playback_avail(runtime
) >= runtime
->buffer_size
;
785 * snd_pcm_capture_empty - check whether the capture buffer is empty
786 * @substream: the pcm substream instance
788 * Checks whether the capture buffer is empty.
790 * Return: Non-zero if empty, or zero if not.
792 static inline int snd_pcm_capture_empty(struct snd_pcm_substream
*substream
)
794 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
795 return snd_pcm_capture_avail(runtime
) == 0;
799 * snd_pcm_trigger_done - Mark the master substream
800 * @substream: the pcm substream instance
801 * @master: the linked master substream
803 * When multiple substreams of the same card are linked and the hardware
804 * supports the single-shot operation, the driver calls this in the loop
805 * in snd_pcm_group_for_each_entry() for marking the substream as "done".
806 * Then most of trigger operations are performed only to the given master
809 * The trigger_master mark is cleared at timestamp updates at the end
810 * of trigger operations.
812 static inline void snd_pcm_trigger_done(struct snd_pcm_substream
*substream
,
813 struct snd_pcm_substream
*master
)
815 substream
->runtime
->trigger_master
= master
;
818 static inline int hw_is_mask(int var
)
820 return var
>= SNDRV_PCM_HW_PARAM_FIRST_MASK
&&
821 var
<= SNDRV_PCM_HW_PARAM_LAST_MASK
;
824 static inline int hw_is_interval(int var
)
826 return var
>= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
&&
827 var
<= SNDRV_PCM_HW_PARAM_LAST_INTERVAL
;
830 static inline struct snd_mask
*hw_param_mask(struct snd_pcm_hw_params
*params
,
831 snd_pcm_hw_param_t var
)
833 return ¶ms
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
836 static inline struct snd_interval
*hw_param_interval(struct snd_pcm_hw_params
*params
,
837 snd_pcm_hw_param_t var
)
839 return ¶ms
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
842 static inline const struct snd_mask
*hw_param_mask_c(const struct snd_pcm_hw_params
*params
,
843 snd_pcm_hw_param_t var
)
845 return ¶ms
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
848 static inline const struct snd_interval
*hw_param_interval_c(const struct snd_pcm_hw_params
*params
,
849 snd_pcm_hw_param_t var
)
851 return ¶ms
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
855 * params_channels - Get the number of channels from the hw params
858 static inline unsigned int params_channels(const struct snd_pcm_hw_params
*p
)
860 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_CHANNELS
)->min
;
864 * params_rate - Get the sample rate from the hw params
867 static inline unsigned int params_rate(const struct snd_pcm_hw_params
*p
)
869 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_RATE
)->min
;
873 * params_period_size - Get the period size (in frames) from the hw params
876 static inline unsigned int params_period_size(const struct snd_pcm_hw_params
*p
)
878 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_PERIOD_SIZE
)->min
;
882 * params_periods - Get the number of periods from the hw params
885 static inline unsigned int params_periods(const struct snd_pcm_hw_params
*p
)
887 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_PERIODS
)->min
;
891 * params_buffer_size - Get the buffer size (in frames) from the hw params
894 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params
*p
)
896 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_BUFFER_SIZE
)->min
;
900 * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
903 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params
*p
)
905 return hw_param_interval_c(p
, SNDRV_PCM_HW_PARAM_BUFFER_BYTES
)->min
;
908 int snd_interval_refine(struct snd_interval
*i
, const struct snd_interval
*v
);
909 void snd_interval_mul(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
910 void snd_interval_div(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
911 void snd_interval_muldivk(const struct snd_interval
*a
, const struct snd_interval
*b
,
912 unsigned int k
, struct snd_interval
*c
);
913 void snd_interval_mulkdiv(const struct snd_interval
*a
, unsigned int k
,
914 const struct snd_interval
*b
, struct snd_interval
*c
);
915 int snd_interval_list(struct snd_interval
*i
, unsigned int count
,
916 const unsigned int *list
, unsigned int mask
);
917 int snd_interval_ranges(struct snd_interval
*i
, unsigned int count
,
918 const struct snd_interval
*list
, unsigned int mask
);
919 int snd_interval_ratnum(struct snd_interval
*i
,
920 unsigned int rats_count
, struct snd_ratnum
*rats
,
921 unsigned int *nump
, unsigned int *denp
);
923 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params
*params
);
924 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params
*params
, snd_pcm_hw_param_t var
);
925 int snd_pcm_hw_params_choose(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
927 int snd_pcm_hw_refine(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
929 int snd_pcm_hw_constraints_init(struct snd_pcm_substream
*substream
);
930 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream
*substream
);
932 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
934 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
936 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
937 unsigned int min
, unsigned int max
);
938 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
);
939 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime
*runtime
,
941 snd_pcm_hw_param_t var
,
942 const struct snd_pcm_hw_constraint_list
*l
);
943 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime
*runtime
,
945 snd_pcm_hw_param_t var
,
946 const struct snd_pcm_hw_constraint_ranges
*r
);
947 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime
*runtime
,
949 snd_pcm_hw_param_t var
,
950 struct snd_pcm_hw_constraint_ratnums
*r
);
951 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime
*runtime
,
953 snd_pcm_hw_param_t var
,
954 struct snd_pcm_hw_constraint_ratdens
*r
);
955 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime
*runtime
,
958 unsigned int msbits
);
959 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime
*runtime
,
961 snd_pcm_hw_param_t var
,
963 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime
*runtime
,
965 snd_pcm_hw_param_t var
);
966 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime
*runtime
,
967 unsigned int base_rate
);
968 int snd_pcm_hw_rule_add(struct snd_pcm_runtime
*runtime
,
971 snd_pcm_hw_rule_func_t func
, void *private,
974 int snd_pcm_format_signed(snd_pcm_format_t format
);
975 int snd_pcm_format_unsigned(snd_pcm_format_t format
);
976 int snd_pcm_format_linear(snd_pcm_format_t format
);
977 int snd_pcm_format_little_endian(snd_pcm_format_t format
);
978 int snd_pcm_format_big_endian(snd_pcm_format_t format
);
979 #if 0 /* just for DocBook */
981 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
982 * @format: the format to check
984 * Return: 1 if the given PCM format is CPU-endian, 0 if
985 * opposite, or a negative error code if endian not specified.
987 int snd_pcm_format_cpu_endian(snd_pcm_format_t format
);
989 #ifdef SNDRV_LITTLE_ENDIAN
990 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
992 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
994 int snd_pcm_format_width(snd_pcm_format_t format
); /* in bits */
995 int snd_pcm_format_physical_width(snd_pcm_format_t format
); /* in bits */
996 ssize_t
snd_pcm_format_size(snd_pcm_format_t format
, size_t samples
);
997 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format
);
998 int snd_pcm_format_set_silence(snd_pcm_format_t format
, void *buf
, unsigned int frames
);
1000 void snd_pcm_set_ops(struct snd_pcm
* pcm
, int direction
,
1001 const struct snd_pcm_ops
*ops
);
1002 void snd_pcm_set_sync(struct snd_pcm_substream
*substream
);
1003 int snd_pcm_lib_ioctl(struct snd_pcm_substream
*substream
,
1004 unsigned int cmd
, void *arg
);
1005 int snd_pcm_update_state(struct snd_pcm_substream
*substream
,
1006 struct snd_pcm_runtime
*runtime
);
1007 int snd_pcm_update_hw_ptr(struct snd_pcm_substream
*substream
);
1008 void snd_pcm_playback_silence(struct snd_pcm_substream
*substream
, snd_pcm_uframes_t new_hw_ptr
);
1009 void snd_pcm_period_elapsed(struct snd_pcm_substream
*substream
);
1010 snd_pcm_sframes_t
snd_pcm_lib_write(struct snd_pcm_substream
*substream
,
1011 const void __user
*buf
,
1012 snd_pcm_uframes_t frames
);
1013 snd_pcm_sframes_t
snd_pcm_lib_read(struct snd_pcm_substream
*substream
,
1014 void __user
*buf
, snd_pcm_uframes_t frames
);
1015 snd_pcm_sframes_t
snd_pcm_lib_writev(struct snd_pcm_substream
*substream
,
1016 void __user
**bufs
, snd_pcm_uframes_t frames
);
1017 snd_pcm_sframes_t
snd_pcm_lib_readv(struct snd_pcm_substream
*substream
,
1018 void __user
**bufs
, snd_pcm_uframes_t frames
);
1020 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates
;
1022 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime
*runtime
);
1023 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate
);
1024 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit
);
1025 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a
,
1026 unsigned int rates_b
);
1029 * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1030 * @substream: PCM substream to set
1031 * @bufp: the buffer information, NULL to clear
1033 * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1034 * Otherwise it clears the current buffer information.
1036 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream
*substream
,
1037 struct snd_dma_buffer
*bufp
)
1039 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1041 runtime
->dma_buffer_p
= bufp
;
1042 runtime
->dma_area
= bufp
->area
;
1043 runtime
->dma_addr
= bufp
->addr
;
1044 runtime
->dma_bytes
= bufp
->bytes
;
1046 runtime
->dma_buffer_p
= NULL
;
1047 runtime
->dma_area
= NULL
;
1048 runtime
->dma_addr
= 0;
1049 runtime
->dma_bytes
= 0;
1057 void snd_pcm_timer_resolution_change(struct snd_pcm_substream
*substream
);
1058 void snd_pcm_timer_init(struct snd_pcm_substream
*substream
);
1059 void snd_pcm_timer_done(struct snd_pcm_substream
*substream
);
1062 * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1063 * @runtime: PCM runtime instance
1064 * @tv: timespec to fill
1066 static inline void snd_pcm_gettime(struct snd_pcm_runtime
*runtime
,
1067 struct timespec
*tv
)
1069 switch (runtime
->tstamp_type
) {
1070 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC
:
1073 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW
:
1074 getrawmonotonic(tv
);
1086 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream
*substream
);
1087 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm
*pcm
);
1088 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream
*substream
,
1089 int type
, struct device
*data
,
1090 size_t size
, size_t max
);
1091 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm
*pcm
,
1092 int type
, void *data
,
1093 size_t size
, size_t max
);
1094 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream
*substream
, size_t size
);
1095 int snd_pcm_lib_free_pages(struct snd_pcm_substream
*substream
);
1097 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream
*substream
,
1098 size_t size
, gfp_t gfp_flags
);
1099 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream
*substream
);
1100 struct page
*snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream
*substream
,
1101 unsigned long offset
);
1103 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1104 * @substream: the substream to allocate the buffer to
1105 * @size: the requested buffer size, in bytes
1107 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1108 * contiguous in kernel virtual space, but not in physical memory. Use this
1109 * if the buffer is accessed by kernel code but not by device DMA.
1111 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1114 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1115 (struct snd_pcm_substream
*substream
, size_t size
)
1117 return _snd_pcm_lib_alloc_vmalloc_buffer(substream
, size
,
1118 GFP_KERNEL
| __GFP_HIGHMEM
| __GFP_ZERO
);
1122 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1123 * @substream: the substream to allocate the buffer to
1124 * @size: the requested buffer size, in bytes
1126 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1127 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1129 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1132 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1133 (struct snd_pcm_substream
*substream
, size_t size
)
1135 return _snd_pcm_lib_alloc_vmalloc_buffer(substream
, size
,
1136 GFP_KERNEL
| GFP_DMA32
| __GFP_ZERO
);
1139 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1141 #ifdef CONFIG_SND_DMA_SGBUF
1143 * SG-buffer handling
1145 #define snd_pcm_substream_sgbuf(substream) \
1146 snd_pcm_get_dma_buf(substream)->private_data
1148 struct page
*snd_pcm_sgbuf_ops_page(struct snd_pcm_substream
*substream
,
1149 unsigned long offset
);
1150 #else /* !SND_DMA_SGBUF */
1152 * fake using a continuous buffer
1154 #define snd_pcm_sgbuf_ops_page NULL
1155 #endif /* SND_DMA_SGBUF */
1158 * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1159 * @substream: PCM substream
1162 static inline dma_addr_t
1163 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream
*substream
, unsigned int ofs
)
1165 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream
), ofs
);
1169 * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1170 * @substream: PCM substream
1173 static inline void *
1174 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream
*substream
, unsigned int ofs
)
1176 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream
), ofs
);
1180 * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1181 * page from the given size
1182 * @substream: PCM substream
1184 * @size: byte size to examine
1186 static inline unsigned int
1187 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream
*substream
,
1188 unsigned int ofs
, unsigned int size
)
1190 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream
), ofs
, size
);
1194 * snd_pcm_mmap_data_open - increase the mmap counter
1197 * PCM mmap callback should handle this counter properly
1199 static inline void snd_pcm_mmap_data_open(struct vm_area_struct
*area
)
1201 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
1202 atomic_inc(&substream
->mmap_count
);
1206 * snd_pcm_mmap_data_close - decrease the mmap counter
1209 * PCM mmap callback should handle this counter properly
1211 static inline void snd_pcm_mmap_data_close(struct vm_area_struct
*area
)
1213 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
1214 atomic_dec(&substream
->mmap_count
);
1217 int snd_pcm_lib_default_mmap(struct snd_pcm_substream
*substream
,
1218 struct vm_area_struct
*area
);
1219 /* mmap for io-memory area */
1220 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1221 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1222 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream
*substream
, struct vm_area_struct
*area
);
1224 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1225 #define snd_pcm_lib_mmap_iomem NULL
1228 #define snd_pcm_lib_mmap_vmalloc NULL
1231 * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1233 * @max: pointer to store the max size
1235 static inline void snd_pcm_limit_isa_dma_size(int dma
, size_t *max
)
1237 *max
= dma
< 4 ? 64 * 1024 : 128 * 1024;
1244 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1245 (IEC958_AES1_CON_ORIGINAL<<8)|\
1246 (IEC958_AES1_CON_PCM_CODER<<8)|\
1247 (IEC958_AES3_CON_FS_48000<<24))
1249 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1251 const char *snd_pcm_format_name(snd_pcm_format_t format
);
1254 * snd_pcm_stream_str - Get a string naming the direction of a stream
1255 * @substream: the pcm substream instance
1257 * Return: A string naming the direction of the stream.
1259 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream
*substream
)
1261 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
)
1268 * PCM channel-mapping control API
1270 /* array element of channel maps */
1271 struct snd_pcm_chmap_elem
{
1272 unsigned char channels
;
1273 unsigned char map
[15];
1276 /* channel map information; retrieved via snd_kcontrol_chip() */
1277 struct snd_pcm_chmap
{
1278 struct snd_pcm
*pcm
; /* assigned PCM instance */
1279 int stream
; /* PLAYBACK or CAPTURE */
1280 struct snd_kcontrol
*kctl
;
1281 const struct snd_pcm_chmap_elem
*chmap
;
1282 unsigned int max_channels
;
1283 unsigned int channel_mask
; /* optional: active channels bitmask */
1284 void *private_data
; /* optional: private data pointer */
1288 * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1289 * @info: chmap information
1290 * @idx: the substream number index
1292 static inline struct snd_pcm_substream
*
1293 snd_pcm_chmap_substream(struct snd_pcm_chmap
*info
, unsigned int idx
)
1295 struct snd_pcm_substream
*s
;
1296 for (s
= info
->pcm
->streams
[info
->stream
].substream
; s
; s
= s
->next
)
1297 if (s
->number
== idx
)
1302 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1303 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps
[];
1304 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1305 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps
[];
1307 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1308 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1309 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1310 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1312 int snd_pcm_add_chmap_ctls(struct snd_pcm
*pcm
, int stream
,
1313 const struct snd_pcm_chmap_elem
*chmap
,
1315 unsigned long private_value
,
1316 struct snd_pcm_chmap
**info_ret
);
1319 * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1320 * @pcm_format: PCM format
1322 static inline u64
pcm_format_to_bits(snd_pcm_format_t pcm_format
)
1324 return 1ULL << (__force
int) pcm_format
;
1327 /* printk helpers */
1328 #define pcm_err(pcm, fmt, args...) \
1329 dev_err((pcm)->card->dev, fmt, ##args)
1330 #define pcm_warn(pcm, fmt, args...) \
1331 dev_warn((pcm)->card->dev, fmt, ##args)
1332 #define pcm_dbg(pcm, fmt, args...) \
1333 dev_dbg((pcm)->card->dev, fmt, ##args)
1335 #endif /* __SOUND_PCM_H */