sound/core/pcm_compat.c

   1 /*
   2  *   32bit -> 64bit ioctl wrapper for PCM API
   3  *   Copyright (c) by Takashi Iwai <tiwai@suse.de>
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation; either version 2 of the License, or
   8  *   (at your option) any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details.
  14  *
  15  *   You should have received a copy of the GNU General Public License
  16  *   along with this program; if not, write to the Free Software
  17  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18  *
  19  */
  20
  21 /* This file included from pcm_native.c */
  22
  23 #include <linux/compat.h>
  24 #include <linux/slab.h>
  25
  26 static int snd_pcm_ioctl_delay_compat(struct snd_pcm_substream *substream,
  27                                       s32 __user *src)
  28 {
  29         snd_pcm_sframes_t delay;
  30         mm_segment_t fs;
  31         int err;
  32
  33         fs = snd_enter_user();
  34         err = snd_pcm_delay(substream, &delay);
  35         snd_leave_user(fs);
  36         if (err < 0)
  37                 return err;
  38         if (put_user(delay, src))
  39                 return -EFAULT;
  40         return err;
  41 }
  42
  43 static int snd_pcm_ioctl_rewind_compat(struct snd_pcm_substream *substream,
  44                                        u32 __user *src)
  45 {
  46         snd_pcm_uframes_t frames;
  47         int err;
  48
  49         if (get_user(frames, src))
  50                 return -EFAULT;
  51         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
  52                 err = snd_pcm_playback_rewind(substream, frames);
  53         else
  54                 err = snd_pcm_capture_rewind(substream, frames);
  55         if (put_user(err, src))
  56                 return -EFAULT;
  57         return err < 0 ? err : 0;
  58 }
  59
  60 static int snd_pcm_ioctl_forward_compat(struct snd_pcm_substream *substream,
  61                                        u32 __user *src)
  62 {
  63         snd_pcm_uframes_t frames;
  64         int err;
  65
  66         if (get_user(frames, src))
  67                 return -EFAULT;
  68         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
  69                 err = snd_pcm_playback_forward(substream, frames);
  70         else
  71                 err = snd_pcm_capture_forward(substream, frames);
  72         if (put_user(err, src))
  73                 return -EFAULT;
  74         return err < 0 ? err : 0;
  75 }
  76
  77 struct snd_pcm_hw_params32 {
  78         u32 flags;
  79         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - SNDRV_PCM_HW_PARAM_FIRST_MASK + 1]; /* this must be identical */
  80         struct snd_mask mres[5];        /* reserved masks */
  81         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
  82         struct snd_interval ires[9];    /* reserved intervals */
  83         u32 rmask;
  84         u32 cmask;
  85         u32 info;
  86         u32 msbits;
  87         u32 rate_num;
  88         u32 rate_den;
  89         u32 fifo_size;
  90         unsigned char reserved[64];
  91 };
  92
  93 struct snd_pcm_sw_params32 {
  94         s32 tstamp_mode;
  95         u32 period_step;
  96         u32 sleep_min;
  97         u32 avail_min;
  98         u32 xfer_align;
  99         u32 start_threshold;
 100         u32 stop_threshold;
 101         u32 silence_threshold;
 102         u32 silence_size;
 103         u32 boundary;
 104         unsigned char reserved[64];
 105 };
 106
 107 /* recalcuate the boundary within 32bit */
 108 static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
 109 {
 110         snd_pcm_uframes_t boundary;
 111
 112         if (! runtime->buffer_size)
 113                 return 0;
 114         boundary = runtime->buffer_size;
 115         while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
 116                 boundary *= 2;
 117         return boundary;
 118 }
 119
 120 static int snd_pcm_ioctl_sw_params_compat(struct snd_pcm_substream *substream,
 121                                           struct snd_pcm_sw_params32 __user *src)
 122 {
 123         struct snd_pcm_sw_params params;
 124         snd_pcm_uframes_t boundary;
 125         int err;
 126
 127         memset(&params, 0, sizeof(params));
 128         if (get_user(params.tstamp_mode, &src->tstamp_mode) ||
 129             get_user(params.period_step, &src->period_step) ||
 130             get_user(params.sleep_min, &src->sleep_min) ||
 131             get_user(params.avail_min, &src->avail_min) ||
 132             get_user(params.xfer_align, &src->xfer_align) ||
 133             get_user(params.start_threshold, &src->start_threshold) ||
 134             get_user(params.stop_threshold, &src->stop_threshold) ||
 135             get_user(params.silence_threshold, &src->silence_threshold) ||
 136             get_user(params.silence_size, &src->silence_size))
 137                 return -EFAULT;
 138         /*
 139          * Check silent_size parameter.  Since we have 64bit boundary,
 140          * silence_size must be compared with the 32bit boundary.
 141          */
 142         boundary = recalculate_boundary(substream->runtime);
 143         if (boundary && params.silence_size >= boundary)
 144                 params.silence_size = substream->runtime->boundary;
 145         err = snd_pcm_sw_params(substream, &params);
 146         if (err < 0)
 147                 return err;
 148         if (boundary && put_user(boundary, &src->boundary))
 149                 return -EFAULT;
 150         return err;
 151 }
 152
 153 struct snd_pcm_channel_info32 {
 154         u32 channel;
 155         u32 offset;
 156         u32 first;
 157         u32 step;
 158 };
 159
 160 static int snd_pcm_ioctl_channel_info_compat(struct snd_pcm_substream *substream,
 161                                              struct snd_pcm_channel_info32 __user *src)
 162 {
 163         struct snd_pcm_channel_info info;
 164         int err;
 165
 166         if (get_user(info.channel, &src->channel) ||
 167             get_user(info.offset, &src->offset) ||
 168             get_user(info.first, &src->first) ||
 169             get_user(info.step, &src->step))
 170                 return -EFAULT;
 171         err = snd_pcm_channel_info(substream, &info);
 172         if (err < 0)
 173                 return err;
 174         if (put_user(info.channel, &src->channel) ||
 175             put_user(info.offset, &src->offset) ||
 176             put_user(info.first, &src->first) ||
 177             put_user(info.step, &src->step))
 178                 return -EFAULT;
 179         return err;
 180 }
 181
 182 struct snd_pcm_status32 {
 183         s32 state;
 184         struct compat_timespec trigger_tstamp;
 185         struct compat_timespec tstamp;
 186         u32 appl_ptr;
 187         u32 hw_ptr;
 188         s32 delay;
 189         u32 avail;
 190         u32 avail_max;
 191         u32 overrange;
 192         s32 suspended_state;
 193         u32 reserved_alignment;
 194         struct compat_timespec audio_tstamp;
 195         unsigned char reserved[56-sizeof(struct compat_timespec)];
 196 } __attribute__((packed));
 197
 198
 199 static int snd_pcm_status_user_compat(struct snd_pcm_substream *substream,
 200                                       struct snd_pcm_status32 __user *src)
 201 {
 202         struct snd_pcm_status status;
 203         int err;
 204
 205         err = snd_pcm_status(substream, &status);
 206         if (err < 0)
 207                 return err;
 208
 209         if (put_user(status.state, &src->state) ||
 210             compat_put_timespec(&status.trigger_tstamp, &src->trigger_tstamp) ||
 211             compat_put_timespec(&status.tstamp, &src->tstamp) ||
 212             put_user(status.appl_ptr, &src->appl_ptr) ||
 213             put_user(status.hw_ptr, &src->hw_ptr) ||
 214             put_user(status.delay, &src->delay) ||
 215             put_user(status.avail, &src->avail) ||
 216             put_user(status.avail_max, &src->avail_max) ||
 217             put_user(status.overrange, &src->overrange) ||
 218             put_user(status.suspended_state, &src->suspended_state) ||
 219             compat_put_timespec(&status.audio_tstamp, &src->audio_tstamp))
 220                 return -EFAULT;
 221
 222         return err;
 223 }
 224
 225 /* both for HW_PARAMS and HW_REFINE */
 226 static int snd_pcm_ioctl_hw_params_compat(struct snd_pcm_substream *substream,
 227                                           int refine,
 228                                           struct snd_pcm_hw_params32 __user *data32)
 229 {
 230         struct snd_pcm_hw_params *data;
 231         struct snd_pcm_runtime *runtime;
 232         int err;
 233
 234         if (! (runtime = substream->runtime))
 235                 return -ENOTTY;
 236
 237         /* only fifo_size is different, so just copy all */
 238         data = memdup_user(data32, sizeof(*data32));
 239         if (IS_ERR(data))
 240                 return PTR_ERR(data);
 241
 242         if (refine)
 243                 err = snd_pcm_hw_refine(substream, data);
 244         else
 245                 err = snd_pcm_hw_params(substream, data);
 246         if (err < 0)
 247                 goto error;
 248         if (copy_to_user(data32, data, sizeof(*data32)) ||
 249             put_user(data->fifo_size, &data32->fifo_size)) {
 250                 err = -EFAULT;
 251                 goto error;
 252         }
 253
 254         if (! refine) {
 255                 unsigned int new_boundary = recalculate_boundary(runtime);
 256                 if (new_boundary)
 257                         runtime->boundary = new_boundary;
 258         }
 259  error:
 260         kfree(data);
 261         return err;
 262 }
 263
 264
 265 /*
 266  */
 267 struct snd_xferi32 {
 268         s32 result;
 269         u32 buf;
 270         u32 frames;
 271 };
 272
 273 static int snd_pcm_ioctl_xferi_compat(struct snd_pcm_substream *substream,
 274                                       int dir, struct snd_xferi32 __user *data32)
 275 {
 276         compat_caddr_t buf;
 277         u32 frames;
 278         int err;
 279
 280         if (! substream->runtime)
 281                 return -ENOTTY;
 282         if (substream->stream != dir)
 283                 return -EINVAL;
 284         if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
 285                 return -EBADFD;
 286
 287         if (get_user(buf, &data32->buf) ||
 288             get_user(frames, &data32->frames))
 289                 return -EFAULT;
 290
 291         if (dir == SNDRV_PCM_STREAM_PLAYBACK)
 292                 err = snd_pcm_lib_write(substream, compat_ptr(buf), frames);
 293         else
 294                 err = snd_pcm_lib_read(substream, compat_ptr(buf), frames);
 295         if (err < 0)
 296                 return err;
 297         /* copy the result */
 298         if (put_user(err, &data32->result))
 299                 return -EFAULT;
 300         return 0;
 301 }
 302
 303
 304 /* snd_xfern needs remapping of bufs */
 305 struct snd_xfern32 {
 306         s32 result;
 307         u32 bufs;  /* this is void **; */
 308         u32 frames;
 309 };
 310
 311 /*
 312  * xfern ioctl nees to copy (up to) 128 pointers on stack.
 313  * although we may pass the copied pointers through f_op->ioctl, but the ioctl
 314  * handler there expands again the same 128 pointers on stack, so it is better
 315  * to handle the function (calling pcm_readv/writev) directly in this handler.
 316  */
 317 static int snd_pcm_ioctl_xfern_compat(struct snd_pcm_substream *substream,
 318                                       int dir, struct snd_xfern32 __user *data32)
 319 {
 320         compat_caddr_t buf;
 321         compat_caddr_t __user *bufptr;
 322         u32 frames;
 323         void __user **bufs;
 324         int err, ch, i;
 325
 326         if (! substream->runtime)
 327                 return -ENOTTY;
 328         if (substream->stream != dir)
 329                 return -EINVAL;
 330
 331         if ((ch = substream->runtime->channels) > 128)
 332                 return -EINVAL;
 333         if (get_user(buf, &data32->bufs) ||
 334             get_user(frames, &data32->frames))
 335                 return -EFAULT;
 336         bufptr = compat_ptr(buf);
 337         bufs = kmalloc(sizeof(void __user *) * ch, GFP_KERNEL);
 338         if (bufs == NULL)
 339                 return -ENOMEM;
 340         for (i = 0; i < ch; i++) {
 341                 u32 ptr;
 342                 if (get_user(ptr, bufptr)) {
 343                         kfree(bufs);
 344                         return -EFAULT;
 345                 }
 346                 bufs[i] = compat_ptr(ptr);
 347                 bufptr++;
 348         }
 349         if (dir == SNDRV_PCM_STREAM_PLAYBACK)
 350                 err = snd_pcm_lib_writev(substream, bufs, frames);
 351         else
 352                 err = snd_pcm_lib_readv(substream, bufs, frames);
 353         if (err >= 0) {
 354                 if (put_user(err, &data32->result))
 355                         err = -EFAULT;
 356         }
 357         kfree(bufs);
 358         return err;
 359 }
 360
 361
 362 struct snd_pcm_mmap_status32 {
 363         s32 state;
 364         s32 pad1;
 365         u32 hw_ptr;
 366         struct compat_timespec tstamp;
 367         s32 suspended_state;
 368         struct compat_timespec audio_tstamp;
 369 } __attribute__((packed));
 370
 371 struct snd_pcm_mmap_control32 {
 372         u32 appl_ptr;
 373         u32 avail_min;
 374 };
 375
 376 struct snd_pcm_sync_ptr32 {
 377         u32 flags;
 378         union {
 379                 struct snd_pcm_mmap_status32 status;
 380                 unsigned char reserved[64];
 381         } s;
 382         union {
 383                 struct snd_pcm_mmap_control32 control;
 384                 unsigned char reserved[64];
 385         } c;
 386 } __attribute__((packed));
 387
 388 static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
 389                                          struct snd_pcm_sync_ptr32 __user *src)
 390 {
 391         struct snd_pcm_runtime *runtime = substream->runtime;
 392         volatile struct snd_pcm_mmap_status *status;
 393         volatile struct snd_pcm_mmap_control *control;
 394         u32 sflags;
 395         struct snd_pcm_mmap_control scontrol;
 396         struct snd_pcm_mmap_status sstatus;
 397         snd_pcm_uframes_t boundary;
 398         int err;
 399
 400         if (snd_BUG_ON(!runtime))
 401                 return -EINVAL;
 402
 403         if (get_user(sflags, &src->flags) ||
 404             get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
 405             get_user(scontrol.avail_min, &src->c.control.avail_min))
 406                 return -EFAULT;
 407         if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
 408                 err = snd_pcm_hwsync(substream);
 409                 if (err < 0)
 410                         return err;
 411         }
 412         status = runtime->status;
 413         control = runtime->control;
 414         boundary = recalculate_boundary(runtime);
 415         if (! boundary)
 416                 boundary = 0x7fffffff;
 417         snd_pcm_stream_lock_irq(substream);
 418         /* FIXME: we should consider the boundary for the sync from app */
 419         if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
 420                 control->appl_ptr = scontrol.appl_ptr;
 421         else
 422                 scontrol.appl_ptr = control->appl_ptr % boundary;
 423         if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
 424                 control->avail_min = scontrol.avail_min;
 425         else
 426                 scontrol.avail_min = control->avail_min;
 427         sstatus.state = status->state;
 428         sstatus.hw_ptr = status->hw_ptr % boundary;
 429         sstatus.tstamp = status->tstamp;
 430         sstatus.suspended_state = status->suspended_state;
 431         sstatus.audio_tstamp = status->audio_tstamp;
 432         snd_pcm_stream_unlock_irq(substream);
 433         if (put_user(sstatus.state, &src->s.status.state) ||
 434             put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
 435             compat_put_timespec(&sstatus.tstamp, &src->s.status.tstamp) ||
 436             put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
 437             compat_put_timespec(&sstatus.audio_tstamp,
 438                     &src->s.status.audio_tstamp) ||
 439             put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
 440             put_user(scontrol.avail_min, &src->c.control.avail_min))
 441                 return -EFAULT;
 442
 443         return 0;
 444 }
 445
 446
 447 /*
 448  */
 449 enum {
 450         SNDRV_PCM_IOCTL_HW_REFINE32 = _IOWR('A', 0x10, struct snd_pcm_hw_params32),
 451         SNDRV_PCM_IOCTL_HW_PARAMS32 = _IOWR('A', 0x11, struct snd_pcm_hw_params32),
 452         SNDRV_PCM_IOCTL_SW_PARAMS32 = _IOWR('A', 0x13, struct snd_pcm_sw_params32),
 453         SNDRV_PCM_IOCTL_STATUS32 = _IOR('A', 0x20, struct snd_pcm_status32),
 454         SNDRV_PCM_IOCTL_DELAY32 = _IOR('A', 0x21, s32),
 455         SNDRV_PCM_IOCTL_CHANNEL_INFO32 = _IOR('A', 0x32, struct snd_pcm_channel_info32),
 456         SNDRV_PCM_IOCTL_REWIND32 = _IOW('A', 0x46, u32),
 457         SNDRV_PCM_IOCTL_FORWARD32 = _IOW('A', 0x49, u32),
 458         SNDRV_PCM_IOCTL_WRITEI_FRAMES32 = _IOW('A', 0x50, struct snd_xferi32),
 459         SNDRV_PCM_IOCTL_READI_FRAMES32 = _IOR('A', 0x51, struct snd_xferi32),
 460         SNDRV_PCM_IOCTL_WRITEN_FRAMES32 = _IOW('A', 0x52, struct snd_xfern32),
 461         SNDRV_PCM_IOCTL_READN_FRAMES32 = _IOR('A', 0x53, struct snd_xfern32),
 462         SNDRV_PCM_IOCTL_SYNC_PTR32 = _IOWR('A', 0x23, struct snd_pcm_sync_ptr32),
 463
 464 };
 465
 466 static long snd_pcm_ioctl_compat(struct file *file, unsigned int cmd, unsigned long arg)
 467 {
 468         struct snd_pcm_file *pcm_file;
 469         struct snd_pcm_substream *substream;
 470         void __user *argp = compat_ptr(arg);
 471
 472         pcm_file = file->private_data;
 473         if (! pcm_file)
 474                 return -ENOTTY;
 475         substream = pcm_file->substream;
 476         if (! substream)
 477                 return -ENOTTY;
 478
 479         /*
 480          * When PCM is used on 32bit mode, we need to disable
 481          * mmap of PCM status/control records because of the size
 482          * incompatibility.
 483          */
 484         pcm_file->no_compat_mmap = 1;
 485
 486         switch (cmd) {
 487         case SNDRV_PCM_IOCTL_PVERSION:
 488         case SNDRV_PCM_IOCTL_INFO:
 489         case SNDRV_PCM_IOCTL_TSTAMP:
 490         case SNDRV_PCM_IOCTL_TTSTAMP:
 491         case SNDRV_PCM_IOCTL_HWSYNC:
 492         case SNDRV_PCM_IOCTL_PREPARE:
 493         case SNDRV_PCM_IOCTL_RESET:
 494         case SNDRV_PCM_IOCTL_START:
 495         case SNDRV_PCM_IOCTL_DROP:
 496         case SNDRV_PCM_IOCTL_DRAIN:
 497         case SNDRV_PCM_IOCTL_PAUSE:
 498         case SNDRV_PCM_IOCTL_HW_FREE:
 499         case SNDRV_PCM_IOCTL_RESUME:
 500         case SNDRV_PCM_IOCTL_XRUN:
 501         case SNDRV_PCM_IOCTL_LINK:
 502         case SNDRV_PCM_IOCTL_UNLINK:
 503                 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 504                         return snd_pcm_playback_ioctl1(file, substream, cmd, argp);
 505                 else
 506                         return snd_pcm_capture_ioctl1(file, substream, cmd, argp);
 507         case SNDRV_PCM_IOCTL_HW_REFINE32:
 508                 return snd_pcm_ioctl_hw_params_compat(substream, 1, argp);
 509         case SNDRV_PCM_IOCTL_HW_PARAMS32:
 510                 return snd_pcm_ioctl_hw_params_compat(substream, 0, argp);
 511         case SNDRV_PCM_IOCTL_SW_PARAMS32:
 512                 return snd_pcm_ioctl_sw_params_compat(substream, argp);
 513         case SNDRV_PCM_IOCTL_STATUS32:
 514                 return snd_pcm_status_user_compat(substream, argp);
 515         case SNDRV_PCM_IOCTL_SYNC_PTR32:
 516                 return snd_pcm_ioctl_sync_ptr_compat(substream, argp);
 517         case SNDRV_PCM_IOCTL_CHANNEL_INFO32:
 518                 return snd_pcm_ioctl_channel_info_compat(substream, argp);
 519         case SNDRV_PCM_IOCTL_WRITEI_FRAMES32:
 520                 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
 521         case SNDRV_PCM_IOCTL_READI_FRAMES32:
 522                 return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
 523         case SNDRV_PCM_IOCTL_WRITEN_FRAMES32:
 524                 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
 525         case SNDRV_PCM_IOCTL_READN_FRAMES32:
 526                 return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
 527         case SNDRV_PCM_IOCTL_DELAY32:
 528                 return snd_pcm_ioctl_delay_compat(substream, argp);
 529         case SNDRV_PCM_IOCTL_REWIND32:
 530                 return snd_pcm_ioctl_rewind_compat(substream, argp);
 531         case SNDRV_PCM_IOCTL_FORWARD32:
 532                 return snd_pcm_ioctl_forward_compat(substream, argp);
 533         }
 534
 535         return -ENOIOCTLCMD;
 536 }