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 {
159 snd_pcm_state_t state;
160 u8 rsvd[4]; /* alignment */
161 s64 trigger_tstamp_sec;
162 s64 trigger_tstamp_nsec;
171 snd_pcm_state_t suspended_state;
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 static int snd_pcm_status_user_compat64(struct snd_pcm_substream *substream,
182 struct compat_snd_pcm_status64 __user *src,
185 struct snd_pcm_status64 status;
186 struct compat_snd_pcm_status64 compat_status64;
189 memset(&status, 0, sizeof(status));
190 memset(&compat_status64, 0, sizeof(compat_status64));
192 * with extension, parameters are read/write,
193 * get audio_tstamp_data from user,
194 * ignore rest of status structure
196 if (ext && get_user(status.audio_tstamp_data,
197 (u32 __user *)(&src->audio_tstamp_data)))
199 err = snd_pcm_status64(substream, &status);
203 if (clear_user(src, sizeof(*src)))
206 compat_status64 = (struct compat_snd_pcm_status64) {
207 .state = status.state,
208 .trigger_tstamp_sec = status.trigger_tstamp_sec,
209 .trigger_tstamp_nsec = status.trigger_tstamp_nsec,
210 .tstamp_sec = status.tstamp_sec,
211 .tstamp_nsec = status.tstamp_nsec,
212 .appl_ptr = status.appl_ptr,
213 .hw_ptr = status.hw_ptr,
214 .delay = status.delay,
215 .avail = status.avail,
216 .avail_max = status.avail_max,
217 .overrange = status.overrange,
218 .suspended_state = status.suspended_state,
219 .audio_tstamp_data = status.audio_tstamp_data,
220 .audio_tstamp_sec = status.audio_tstamp_sec,
221 .audio_tstamp_nsec = status.audio_tstamp_nsec,
222 .driver_tstamp_sec = status.audio_tstamp_sec,
223 .driver_tstamp_nsec = status.audio_tstamp_nsec,
224 .audio_tstamp_accuracy = status.audio_tstamp_accuracy,
227 if (copy_to_user(src, &compat_status64, sizeof(compat_status64)))
233 /* both for HW_PARAMS and HW_REFINE */
234 static int snd_pcm_ioctl_hw_params_compat(struct snd_pcm_substream *substream,
236 struct snd_pcm_hw_params32 __user *data32)
238 struct snd_pcm_hw_params *data;
239 struct snd_pcm_runtime *runtime;
242 if (! (runtime = substream->runtime))
245 data = kmalloc(sizeof(*data), GFP_KERNEL);
249 /* only fifo_size (RO from userspace) is different, so just copy all */
250 if (copy_from_user(data, data32, sizeof(*data32))) {
256 err = snd_pcm_hw_refine(substream, data);
259 err = fixup_unreferenced_params(substream, data);
261 err = snd_pcm_hw_params(substream, data);
265 if (copy_to_user(data32, data, sizeof(*data32)) ||
266 put_user(data->fifo_size, &data32->fifo_size)) {
272 unsigned int new_boundary = recalculate_boundary(runtime);
274 runtime->boundary = new_boundary;
290 static int snd_pcm_ioctl_xferi_compat(struct snd_pcm_substream *substream,
291 int dir, struct snd_xferi32 __user *data32)
297 if (! substream->runtime)
299 if (substream->stream != dir)
301 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
304 if (get_user(buf, &data32->buf) ||
305 get_user(frames, &data32->frames))
308 if (dir == SNDRV_PCM_STREAM_PLAYBACK)
309 err = snd_pcm_lib_write(substream, compat_ptr(buf), frames);
311 err = snd_pcm_lib_read(substream, compat_ptr(buf), frames);
314 /* copy the result */
315 if (put_user(err, &data32->result))
321 /* snd_xfern needs remapping of bufs */
324 u32 bufs; /* this is void **; */
329 * xfern ioctl nees to copy (up to) 128 pointers on stack.
330 * although we may pass the copied pointers through f_op->ioctl, but the ioctl
331 * handler there expands again the same 128 pointers on stack, so it is better
332 * to handle the function (calling pcm_readv/writev) directly in this handler.
334 static int snd_pcm_ioctl_xfern_compat(struct snd_pcm_substream *substream,
335 int dir, struct snd_xfern32 __user *data32)
338 compat_caddr_t __user *bufptr;
343 if (! substream->runtime)
345 if (substream->stream != dir)
347 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
350 if ((ch = substream->runtime->channels) > 128)
352 if (get_user(buf, &data32->bufs) ||
353 get_user(frames, &data32->frames))
355 bufptr = compat_ptr(buf);
356 bufs = kmalloc_array(ch, sizeof(void __user *), GFP_KERNEL);
359 for (i = 0; i < ch; i++) {
361 if (get_user(ptr, bufptr)) {
365 bufs[i] = compat_ptr(ptr);
368 if (dir == SNDRV_PCM_STREAM_PLAYBACK)
369 err = snd_pcm_lib_writev(substream, bufs, frames);
371 err = snd_pcm_lib_readv(substream, bufs, frames);
373 if (put_user(err, &data32->result))
380 #ifdef CONFIG_X86_X32
381 /* X32 ABI has 64bit timespec and 64bit alignment */
382 struct snd_pcm_mmap_status_x32 {
383 snd_pcm_state_t state;
386 u32 pad2; /* alignment */
389 snd_pcm_state_t suspended_state;
391 s64 audio_tstamp_sec;
392 s64 audio_tstamp_nsec;
395 struct snd_pcm_mmap_control_x32 {
400 struct snd_pcm_sync_ptr_x32 {
402 u32 rsvd; /* alignment */
404 struct snd_pcm_mmap_status_x32 status;
405 unsigned char reserved[64];
408 struct snd_pcm_mmap_control_x32 control;
409 unsigned char reserved[64];
413 static int snd_pcm_ioctl_sync_ptr_x32(struct snd_pcm_substream *substream,
414 struct snd_pcm_sync_ptr_x32 __user *src)
416 struct snd_pcm_runtime *runtime = substream->runtime;
417 volatile struct snd_pcm_mmap_status *status;
418 volatile struct snd_pcm_mmap_control *control;
420 struct snd_pcm_mmap_control scontrol;
421 struct snd_pcm_mmap_status sstatus;
422 snd_pcm_uframes_t boundary;
425 if (snd_BUG_ON(!runtime))
428 if (get_user(sflags, &src->flags) ||
429 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
430 get_user(scontrol.avail_min, &src->c.control.avail_min))
432 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
433 err = snd_pcm_hwsync(substream);
437 status = runtime->status;
438 control = runtime->control;
439 boundary = recalculate_boundary(runtime);
441 boundary = 0x7fffffff;
442 snd_pcm_stream_lock_irq(substream);
443 /* FIXME: we should consider the boundary for the sync from app */
444 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
445 control->appl_ptr = scontrol.appl_ptr;
447 scontrol.appl_ptr = control->appl_ptr % boundary;
448 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
449 control->avail_min = scontrol.avail_min;
451 scontrol.avail_min = control->avail_min;
452 sstatus.state = status->state;
453 sstatus.hw_ptr = status->hw_ptr % boundary;
454 sstatus.tstamp = status->tstamp;
455 sstatus.suspended_state = status->suspended_state;
456 sstatus.audio_tstamp = status->audio_tstamp;
457 snd_pcm_stream_unlock_irq(substream);
458 if (put_user(sstatus.state, &src->s.status.state) ||
459 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
460 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
461 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
462 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
463 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
464 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
465 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
466 put_user(scontrol.avail_min, &src->c.control.avail_min))
471 #endif /* CONFIG_X86_X32 */
474 typedef char __pad_before_u32[4];
475 typedef char __pad_after_u32[0];
477 typedef char __pad_before_u32[0];
478 typedef char __pad_after_u32[4];
481 /* PCM 2.0.15 API definition had a bug in mmap control; it puts the avail_min
482 * at the wrong offset due to a typo in padding type.
483 * The bug hits only 32bit.
484 * A workaround for incorrect read/write is needed only in 32bit compat mode.
486 struct __snd_pcm_mmap_control64_buggy {
487 __pad_before_u32 __pad1;
489 __pad_before_u32 __pad2; /* SiC! here is the bug */
490 __pad_before_u32 __pad3;
492 __pad_after_uframe __pad4;
495 static int snd_pcm_ioctl_sync_ptr_buggy(struct snd_pcm_substream *substream,
496 struct snd_pcm_sync_ptr __user *_sync_ptr)
498 struct snd_pcm_runtime *runtime = substream->runtime;
499 struct snd_pcm_sync_ptr sync_ptr;
500 struct __snd_pcm_mmap_control64_buggy *sync_cp;
501 volatile struct snd_pcm_mmap_status *status;
502 volatile struct snd_pcm_mmap_control *control;
505 memset(&sync_ptr, 0, sizeof(sync_ptr));
506 sync_cp = (struct __snd_pcm_mmap_control64_buggy *)&sync_ptr.c.control;
507 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
509 if (copy_from_user(sync_cp, &(_sync_ptr->c.control), sizeof(*sync_cp)))
511 status = runtime->status;
512 control = runtime->control;
513 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
514 err = snd_pcm_hwsync(substream);
518 snd_pcm_stream_lock_irq(substream);
519 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
520 err = pcm_lib_apply_appl_ptr(substream, sync_cp->appl_ptr);
522 snd_pcm_stream_unlock_irq(substream);
526 sync_cp->appl_ptr = control->appl_ptr;
528 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
529 control->avail_min = sync_cp->avail_min;
531 sync_cp->avail_min = control->avail_min;
532 sync_ptr.s.status.state = status->state;
533 sync_ptr.s.status.hw_ptr = status->hw_ptr;
534 sync_ptr.s.status.tstamp = status->tstamp;
535 sync_ptr.s.status.suspended_state = status->suspended_state;
536 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
537 snd_pcm_stream_unlock_irq(substream);
538 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
546 SNDRV_PCM_IOCTL_HW_REFINE32 = _IOWR('A', 0x10, struct snd_pcm_hw_params32),
547 SNDRV_PCM_IOCTL_HW_PARAMS32 = _IOWR('A', 0x11, struct snd_pcm_hw_params32),
548 SNDRV_PCM_IOCTL_SW_PARAMS32 = _IOWR('A', 0x13, struct snd_pcm_sw_params32),
549 SNDRV_PCM_IOCTL_STATUS_COMPAT32 = _IOR('A', 0x20, struct snd_pcm_status32),
550 SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT32 = _IOWR('A', 0x24, struct snd_pcm_status32),
551 SNDRV_PCM_IOCTL_DELAY32 = _IOR('A', 0x21, s32),
552 SNDRV_PCM_IOCTL_CHANNEL_INFO32 = _IOR('A', 0x32, struct snd_pcm_channel_info32),
553 SNDRV_PCM_IOCTL_REWIND32 = _IOW('A', 0x46, u32),
554 SNDRV_PCM_IOCTL_FORWARD32 = _IOW('A', 0x49, u32),
555 SNDRV_PCM_IOCTL_WRITEI_FRAMES32 = _IOW('A', 0x50, struct snd_xferi32),
556 SNDRV_PCM_IOCTL_READI_FRAMES32 = _IOR('A', 0x51, struct snd_xferi32),
557 SNDRV_PCM_IOCTL_WRITEN_FRAMES32 = _IOW('A', 0x52, struct snd_xfern32),
558 SNDRV_PCM_IOCTL_READN_FRAMES32 = _IOR('A', 0x53, struct snd_xfern32),
559 SNDRV_PCM_IOCTL_STATUS_COMPAT64 = _IOR('A', 0x20, struct compat_snd_pcm_status64),
560 SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT64 = _IOWR('A', 0x24, struct compat_snd_pcm_status64),
561 #ifdef CONFIG_X86_X32
562 SNDRV_PCM_IOCTL_CHANNEL_INFO_X32 = _IOR('A', 0x32, struct snd_pcm_channel_info),
563 SNDRV_PCM_IOCTL_SYNC_PTR_X32 = _IOWR('A', 0x23, struct snd_pcm_sync_ptr_x32),
564 #endif /* CONFIG_X86_X32 */
567 static long snd_pcm_ioctl_compat(struct file *file, unsigned int cmd, unsigned long arg)
569 struct snd_pcm_file *pcm_file;
570 struct snd_pcm_substream *substream;
571 void __user *argp = compat_ptr(arg);
573 pcm_file = file->private_data;
576 substream = pcm_file->substream;
581 * When PCM is used on 32bit mode, we need to disable
582 * mmap of the old PCM status/control records because
583 * of the size incompatibility.
585 pcm_file->no_compat_mmap = 1;
588 case SNDRV_PCM_IOCTL_PVERSION:
589 case SNDRV_PCM_IOCTL_INFO:
590 case SNDRV_PCM_IOCTL_TSTAMP:
591 case SNDRV_PCM_IOCTL_TTSTAMP:
592 case SNDRV_PCM_IOCTL_USER_PVERSION:
593 case SNDRV_PCM_IOCTL_HWSYNC:
594 case SNDRV_PCM_IOCTL_PREPARE:
595 case SNDRV_PCM_IOCTL_RESET:
596 case SNDRV_PCM_IOCTL_START:
597 case SNDRV_PCM_IOCTL_DROP:
598 case SNDRV_PCM_IOCTL_DRAIN:
599 case SNDRV_PCM_IOCTL_PAUSE:
600 case SNDRV_PCM_IOCTL_HW_FREE:
601 case SNDRV_PCM_IOCTL_RESUME:
602 case SNDRV_PCM_IOCTL_XRUN:
603 case SNDRV_PCM_IOCTL_LINK:
604 case SNDRV_PCM_IOCTL_UNLINK:
605 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
606 return snd_pcm_common_ioctl(file, substream, cmd, argp);
607 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
608 #ifdef CONFIG_X86_X32
609 if (in_x32_syscall())
610 return snd_pcm_ioctl_sync_ptr_x32(substream, argp);
611 #endif /* CONFIG_X86_X32 */
612 return snd_pcm_ioctl_sync_ptr_buggy(substream, argp);
613 case SNDRV_PCM_IOCTL_HW_REFINE32:
614 return snd_pcm_ioctl_hw_params_compat(substream, 1, argp);
615 case SNDRV_PCM_IOCTL_HW_PARAMS32:
616 return snd_pcm_ioctl_hw_params_compat(substream, 0, argp);
617 case SNDRV_PCM_IOCTL_SW_PARAMS32:
618 return snd_pcm_ioctl_sw_params_compat(substream, argp);
619 case SNDRV_PCM_IOCTL_STATUS_COMPAT32:
620 return snd_pcm_status_user32(substream, argp, false);
621 case SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT32:
622 return snd_pcm_status_user32(substream, argp, true);
623 case SNDRV_PCM_IOCTL_CHANNEL_INFO32:
624 return snd_pcm_ioctl_channel_info_compat(substream, argp);
625 case SNDRV_PCM_IOCTL_WRITEI_FRAMES32:
626 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
627 case SNDRV_PCM_IOCTL_READI_FRAMES32:
628 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
629 case SNDRV_PCM_IOCTL_WRITEN_FRAMES32:
630 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
631 case SNDRV_PCM_IOCTL_READN_FRAMES32:
632 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
633 case SNDRV_PCM_IOCTL_DELAY32:
634 return snd_pcm_ioctl_delay_compat(substream, argp);
635 case SNDRV_PCM_IOCTL_REWIND32:
636 return snd_pcm_ioctl_rewind_compat(substream, argp);
637 case SNDRV_PCM_IOCTL_FORWARD32:
638 return snd_pcm_ioctl_forward_compat(substream, argp);
639 case SNDRV_PCM_IOCTL_STATUS_COMPAT64:
640 return snd_pcm_status_user_compat64(substream, argp, false);
641 case SNDRV_PCM_IOCTL_STATUS_EXT_COMPAT64:
642 return snd_pcm_status_user_compat64(substream, argp, true);
643 #ifdef CONFIG_X86_X32
644 case SNDRV_PCM_IOCTL_CHANNEL_INFO_X32:
645 return snd_pcm_ioctl_channel_info_x32(substream, argp);
646 #endif /* CONFIG_X86_X32 */