1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * 32bit -> 64bit ioctl wrapper for PCM API
4 * Copyright (c) by Takashi Iwai <tiwai@suse.de>
7 /* This file included from pcm_native.c */
9 #include <linux/compat.h>
10 #include <linux/slab.h>
12 static int snd_pcm_ioctl_delay_compat(struct snd_pcm_substream *substream,
15 snd_pcm_sframes_t delay;
18 err = snd_pcm_delay(substream, &delay);
21 if (put_user(delay, src))
26 static int snd_pcm_ioctl_rewind_compat(struct snd_pcm_substream *substream,
29 snd_pcm_uframes_t frames;
32 if (get_user(frames, src))
34 err = snd_pcm_rewind(substream, frames);
35 if (put_user(err, src))
37 return err < 0 ? err : 0;
40 static int snd_pcm_ioctl_forward_compat(struct snd_pcm_substream *substream,
43 snd_pcm_uframes_t frames;
46 if (get_user(frames, src))
48 err = snd_pcm_forward(substream, frames);
49 if (put_user(err, src))
51 return err < 0 ? err : 0;
54 struct snd_pcm_hw_params32 {
56 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - SNDRV_PCM_HW_PARAM_FIRST_MASK + 1]; /* this must be identical */
57 struct snd_mask mres[5]; /* reserved masks */
58 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
59 struct snd_interval ires[9]; /* reserved intervals */
67 unsigned char reserved[64];
70 struct snd_pcm_sw_params32 {
78 u32 silence_threshold;
83 unsigned char reserved[56];
86 static int snd_pcm_ioctl_sw_params_compat(struct snd_pcm_substream *substream,
87 struct snd_pcm_sw_params32 __user *src)
89 struct snd_pcm_sw_params params;
90 snd_pcm_uframes_t boundary;
93 memset(¶ms, 0, sizeof(params));
94 if (get_user(params.tstamp_mode, &src->tstamp_mode) ||
95 get_user(params.period_step, &src->period_step) ||
96 get_user(params.sleep_min, &src->sleep_min) ||
97 get_user(params.avail_min, &src->avail_min) ||
98 get_user(params.xfer_align, &src->xfer_align) ||
99 get_user(params.start_threshold, &src->start_threshold) ||
100 get_user(params.stop_threshold, &src->stop_threshold) ||
101 get_user(params.silence_threshold, &src->silence_threshold) ||
102 get_user(params.silence_size, &src->silence_size) ||
103 get_user(params.tstamp_type, &src->tstamp_type) ||
104 get_user(params.proto, &src->proto))
107 * Check silent_size parameter. Since we have 64bit boundary,
108 * silence_size must be compared with the 32bit boundary.
110 boundary = recalculate_boundary(substream->runtime);
111 if (boundary && params.silence_size >= boundary)
112 params.silence_size = substream->runtime->boundary;
113 err = snd_pcm_sw_params(substream, ¶ms);
116 if (boundary && put_user(boundary, &src->boundary))
121 struct snd_pcm_channel_info32 {
128 static int snd_pcm_ioctl_channel_info_compat(struct snd_pcm_substream *substream,
129 struct snd_pcm_channel_info32 __user *src)
131 struct snd_pcm_channel_info info;
134 if (get_user(info.channel, &src->channel) ||
135 get_user(info.offset, &src->offset) ||
136 get_user(info.first, &src->first) ||
137 get_user(info.step, &src->step))
139 err = snd_pcm_channel_info(substream, &info);
142 if (put_user(info.channel, &src->channel) ||
143 put_user(info.offset, &src->offset) ||
144 put_user(info.first, &src->first) ||
145 put_user(info.step, &src->step))
150 #ifdef CONFIG_X86_X32
151 /* X32 ABI has the same struct as x86-64 for snd_pcm_channel_info */
152 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
153 struct snd_pcm_channel_info __user *src);
154 #define snd_pcm_ioctl_channel_info_x32(s, p) \
155 snd_pcm_channel_info_user(s, p)
156 #endif /* CONFIG_X86_X32 */
158 struct compat_snd_pcm_status64 {
160 u8 rsvd[4]; /* alignment */
161 s64 trigger_tstamp_sec;
162 s64 trigger_tstamp_nsec;
172 u32 audio_tstamp_data;
173 s64 audio_tstamp_sec;
174 s64 audio_tstamp_nsec;
175 s64 driver_tstamp_sec;
176 s64 driver_tstamp_nsec;
177 u32 audio_tstamp_accuracy;
178 unsigned char reserved[52-4*sizeof(s64)];
181 #define put_timespec(src, dst) copy_to_user(dst, src, sizeof(*dst))
183 static int snd_pcm_status_user_compat64(struct snd_pcm_substream *substream,
184 struct compat_snd_pcm_status64 __user *src,
187 struct snd_pcm_status64 status;
188 struct compat_snd_pcm_status64 compat_status64;
191 memset(&status, 0, sizeof(status));
192 memset(&compat_status64, 0, sizeof(compat_status64));
194 * with extension, parameters are read/write,
195 * get audio_tstamp_data from user,
196 * ignore rest of status structure
198 if (ext && get_user(status.audio_tstamp_data,
199 (u32 __user *)(&src->audio_tstamp_data)))
201 err = snd_pcm_status64(substream, &status);
205 if (clear_user(src, sizeof(*src)))
208 compat_status64 = (struct compat_snd_pcm_status64) {
209 .state = status.state,
210 .trigger_tstamp_sec = status.trigger_tstamp_sec,
211 .trigger_tstamp_nsec = status.trigger_tstamp_nsec,
212 .tstamp_sec = status.tstamp_sec,
213 .tstamp_nsec = status.tstamp_nsec,
214 .appl_ptr = status.appl_ptr,
215 .hw_ptr = status.hw_ptr,
216 .delay = status.delay,
217 .avail = status.avail,
218 .avail_max = status.avail_max,
219 .overrange = status.overrange,
220 .suspended_state = status.suspended_state,
221 .audio_tstamp_data = status.audio_tstamp_data,
222 .audio_tstamp_sec = status.audio_tstamp_sec,
223 .audio_tstamp_nsec = status.audio_tstamp_nsec,
224 .driver_tstamp_sec = status.audio_tstamp_sec,
225 .driver_tstamp_nsec = status.audio_tstamp_nsec,
226 .audio_tstamp_accuracy = status.audio_tstamp_accuracy,
229 if (copy_to_user(src, &compat_status64, sizeof(compat_status64)))
235 /* both for HW_PARAMS and HW_REFINE */
236 static int snd_pcm_ioctl_hw_params_compat(struct snd_pcm_substream *substream,
238 struct snd_pcm_hw_params32 __user *data32)
240 struct snd_pcm_hw_params *data;
241 struct snd_pcm_runtime *runtime;
244 if (! (runtime = substream->runtime))
247 data = kmalloc(sizeof(*data), GFP_KERNEL);
251 /* only fifo_size (RO from userspace) is different, so just copy all */
252 if (copy_from_user(data, data32, sizeof(*data32))) {
258 err = snd_pcm_hw_refine(substream, data);
260 err = snd_pcm_hw_params(substream, data);
263 if (copy_to_user(data32, data, sizeof(*data32)) ||
264 put_user(data->fifo_size, &data32->fifo_size)) {
270 unsigned int new_boundary = recalculate_boundary(runtime);
272 runtime->boundary = new_boundary;
288 static int snd_pcm_ioctl_xferi_compat(struct snd_pcm_substream *substream,
289 int dir, struct snd_xferi32 __user *data32)
295 if (! substream->runtime)
297 if (substream->stream != dir)
299 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
302 if (get_user(buf, &data32->buf) ||
303 get_user(frames, &data32->frames))
306 if (dir == SNDRV_PCM_STREAM_PLAYBACK)
307 err = snd_pcm_lib_write(substream, compat_ptr(buf), frames);
309 err = snd_pcm_lib_read(substream, compat_ptr(buf), frames);
312 /* copy the result */
313 if (put_user(err, &data32->result))
319 /* snd_xfern needs remapping of bufs */
322 u32 bufs; /* this is void **; */
327 * xfern ioctl nees to copy (up to) 128 pointers on stack.
328 * although we may pass the copied pointers through f_op->ioctl, but the ioctl
329 * handler there expands again the same 128 pointers on stack, so it is better
330 * to handle the function (calling pcm_readv/writev) directly in this handler.
332 static int snd_pcm_ioctl_xfern_compat(struct snd_pcm_substream *substream,
333 int dir, struct snd_xfern32 __user *data32)
336 compat_caddr_t __user *bufptr;
341 if (! substream->runtime)
343 if (substream->stream != dir)
345 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
348 if ((ch = substream->runtime->channels) > 128)
350 if (get_user(buf, &data32->bufs) ||
351 get_user(frames, &data32->frames))
353 bufptr = compat_ptr(buf);
354 bufs = kmalloc_array(ch, sizeof(void __user *), GFP_KERNEL);
357 for (i = 0; i < ch; i++) {
359 if (get_user(ptr, bufptr)) {
363 bufs[i] = compat_ptr(ptr);
366 if (dir == SNDRV_PCM_STREAM_PLAYBACK)
367 err = snd_pcm_lib_writev(substream, bufs, frames);
369 err = snd_pcm_lib_readv(substream, bufs, frames);
371 if (put_user(err, &data32->result))
378 #ifdef CONFIG_X86_X32
379 /* X32 ABI has 64bit timespec and 64bit alignment */
380 struct snd_pcm_mmap_status_x32 {
384 u32 pad2; /* alignment */
385 struct timespec tstamp;
388 struct timespec audio_tstamp;
391 struct snd_pcm_mmap_control_x32 {
396 struct snd_pcm_sync_ptr_x32 {
398 u32 rsvd; /* alignment */
400 struct snd_pcm_mmap_status_x32 status;
401 unsigned char reserved[64];
404 struct snd_pcm_mmap_control_x32 control;
405 unsigned char reserved[64];
409 static int snd_pcm_ioctl_sync_ptr_x32(struct snd_pcm_substream *substream,
410 struct snd_pcm_sync_ptr_x32 __user *src)
412 struct snd_pcm_runtime *runtime = substream->runtime;
413 volatile struct snd_pcm_mmap_status *status;
414 volatile struct snd_pcm_mmap_control *control;
416 struct snd_pcm_mmap_control scontrol;
417 struct snd_pcm_mmap_status sstatus;
418 snd_pcm_uframes_t boundary;
421 if (snd_BUG_ON(!runtime))
424 if (get_user(sflags, &src->flags) ||
425 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
426 get_user(scontrol.avail_min, &src->c.control.avail_min))
428 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
429 err = snd_pcm_hwsync(substream);
433 status = runtime->status;
434 control = runtime->control;
435 boundary = recalculate_boundary(runtime);
437 boundary = 0x7fffffff;
438 snd_pcm_stream_lock_irq(substream);
439 /* FIXME: we should consider the boundary for the sync from app */
440 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
441 control->appl_ptr = scontrol.appl_ptr;
443 scontrol.appl_ptr = control->appl_ptr % boundary;
444 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
445 control->avail_min = scontrol.avail_min;
447 scontrol.avail_min = control->avail_min;
448 sstatus.state = status->state;
449 sstatus.hw_ptr = status->hw_ptr % boundary;
450 sstatus.tstamp = status->tstamp;
451 sstatus.suspended_state = status->suspended_state;
452 sstatus.audio_tstamp = status->audio_tstamp;
453 snd_pcm_stream_unlock_irq(substream);
454 if (put_user(sstatus.state, &src->s.status.state) ||
455 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
456 put_timespec(&sstatus.tstamp, &src->s.status.tstamp) ||
457 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
458 put_timespec(&sstatus.audio_tstamp, &src->s.status.audio_tstamp) ||
459 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
460 put_user(scontrol.avail_min, &src->c.control.avail_min))
465 #endif /* CONFIG_X86_X32 */
470 SNDRV_PCM_IOCTL_HW_REFINE32 = _IOWR('A', 0x10, struct snd_pcm_hw_params32),
471 SNDRV_PCM_IOCTL_HW_PARAMS32 = _IOWR('A', 0x11, struct snd_pcm_hw_params32),
472 SNDRV_PCM_IOCTL_SW_PARAMS32 = _IOWR('A', 0x13, struct snd_pcm_sw_params32),
473 SNDRV_PCM_IOCTL_STATUS_COMPAT32 = _IOR('A', 0x20, struct snd_pcm_status32),
474 SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT32 = _IOWR('A', 0x24, struct snd_pcm_status32),
475 SNDRV_PCM_IOCTL_DELAY32 = _IOR('A', 0x21, s32),
476 SNDRV_PCM_IOCTL_CHANNEL_INFO32 = _IOR('A', 0x32, struct snd_pcm_channel_info32),
477 SNDRV_PCM_IOCTL_REWIND32 = _IOW('A', 0x46, u32),
478 SNDRV_PCM_IOCTL_FORWARD32 = _IOW('A', 0x49, u32),
479 SNDRV_PCM_IOCTL_WRITEI_FRAMES32 = _IOW('A', 0x50, struct snd_xferi32),
480 SNDRV_PCM_IOCTL_READI_FRAMES32 = _IOR('A', 0x51, struct snd_xferi32),
481 SNDRV_PCM_IOCTL_WRITEN_FRAMES32 = _IOW('A', 0x52, struct snd_xfern32),
482 SNDRV_PCM_IOCTL_READN_FRAMES32 = _IOR('A', 0x53, struct snd_xfern32),
483 SNDRV_PCM_IOCTL_SYNC_PTR32 = _IOWR('A', 0x23, struct snd_pcm_sync_ptr32),
484 SNDRV_PCM_IOCTL_STATUS_COMPAT64 = _IOR('A', 0x20, struct compat_snd_pcm_status64),
485 SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT64 = _IOWR('A', 0x24, struct compat_snd_pcm_status64),
486 #ifdef CONFIG_X86_X32
487 SNDRV_PCM_IOCTL_CHANNEL_INFO_X32 = _IOR('A', 0x32, struct snd_pcm_channel_info),
488 SNDRV_PCM_IOCTL_SYNC_PTR_X32 = _IOWR('A', 0x23, struct snd_pcm_sync_ptr_x32),
489 #endif /* CONFIG_X86_X32 */
492 static long snd_pcm_ioctl_compat(struct file *file, unsigned int cmd, unsigned long arg)
494 struct snd_pcm_file *pcm_file;
495 struct snd_pcm_substream *substream;
496 void __user *argp = compat_ptr(arg);
498 pcm_file = file->private_data;
501 substream = pcm_file->substream;
506 * When PCM is used on 32bit mode, we need to disable
507 * mmap of PCM status/control records because of the size
510 pcm_file->no_compat_mmap = 1;
513 case SNDRV_PCM_IOCTL_PVERSION:
514 case SNDRV_PCM_IOCTL_INFO:
515 case SNDRV_PCM_IOCTL_TSTAMP:
516 case SNDRV_PCM_IOCTL_TTSTAMP:
517 case SNDRV_PCM_IOCTL_USER_PVERSION:
518 case SNDRV_PCM_IOCTL_HWSYNC:
519 case SNDRV_PCM_IOCTL_PREPARE:
520 case SNDRV_PCM_IOCTL_RESET:
521 case SNDRV_PCM_IOCTL_START:
522 case SNDRV_PCM_IOCTL_DROP:
523 case SNDRV_PCM_IOCTL_DRAIN:
524 case SNDRV_PCM_IOCTL_PAUSE:
525 case SNDRV_PCM_IOCTL_HW_FREE:
526 case SNDRV_PCM_IOCTL_RESUME:
527 case SNDRV_PCM_IOCTL_XRUN:
528 case SNDRV_PCM_IOCTL_LINK:
529 case SNDRV_PCM_IOCTL_UNLINK:
530 return snd_pcm_common_ioctl(file, substream, cmd, argp);
531 case SNDRV_PCM_IOCTL_HW_REFINE32:
532 return snd_pcm_ioctl_hw_params_compat(substream, 1, argp);
533 case SNDRV_PCM_IOCTL_HW_PARAMS32:
534 return snd_pcm_ioctl_hw_params_compat(substream, 0, argp);
535 case SNDRV_PCM_IOCTL_SW_PARAMS32:
536 return snd_pcm_ioctl_sw_params_compat(substream, argp);
537 case SNDRV_PCM_IOCTL_STATUS_COMPAT32:
538 return snd_pcm_status_user32(substream, argp, false);
539 case SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT32:
540 return snd_pcm_status_user32(substream, argp, true);
541 case SNDRV_PCM_IOCTL_SYNC_PTR32:
542 return snd_pcm_ioctl_sync_ptr_compat(substream, argp);
543 case SNDRV_PCM_IOCTL_CHANNEL_INFO32:
544 return snd_pcm_ioctl_channel_info_compat(substream, argp);
545 case SNDRV_PCM_IOCTL_WRITEI_FRAMES32:
546 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
547 case SNDRV_PCM_IOCTL_READI_FRAMES32:
548 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
549 case SNDRV_PCM_IOCTL_WRITEN_FRAMES32:
550 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
551 case SNDRV_PCM_IOCTL_READN_FRAMES32:
552 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
553 case SNDRV_PCM_IOCTL_DELAY32:
554 return snd_pcm_ioctl_delay_compat(substream, argp);
555 case SNDRV_PCM_IOCTL_REWIND32:
556 return snd_pcm_ioctl_rewind_compat(substream, argp);
557 case SNDRV_PCM_IOCTL_FORWARD32:
558 return snd_pcm_ioctl_forward_compat(substream, argp);
559 case SNDRV_PCM_IOCTL_STATUS_COMPAT64:
560 return snd_pcm_status_user_compat64(substream, argp, false);
561 case SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT64:
562 return snd_pcm_status_user_compat64(substream, argp, true);
563 #ifdef CONFIG_X86_X32
564 case SNDRV_PCM_IOCTL_SYNC_PTR_X32:
565 return snd_pcm_ioctl_sync_ptr_x32(substream, argp);
566 case SNDRV_PCM_IOCTL_CHANNEL_INFO_X32:
567 return snd_pcm_ioctl_channel_info_x32(substream, argp);
568 #endif /* CONFIG_X86_X32 */