linux/sound/core/pcm_compat.c
<<
>>
Prefs
   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
  26static 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
  43static 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
  60static 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
  77struct 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
  93struct 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 */
 108static 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
 120static 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
 153struct snd_pcm_channel_info32 {
 154        u32 channel;
 155        u32 offset;
 156        u32 first;
 157        u32 step;
 158};
 159
 160static 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
 182struct 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        unsigned char reserved[60];
 194} __attribute__((packed));
 195
 196
 197static int snd_pcm_status_user_compat(struct snd_pcm_substream *substream,
 198                                      struct snd_pcm_status32 __user *src)
 199{
 200        struct snd_pcm_status status;
 201        int err;
 202
 203        err = snd_pcm_status(substream, &status);
 204        if (err < 0)
 205                return err;
 206
 207        if (put_user(status.state, &src->state) ||
 208            put_user(status.trigger_tstamp.tv_sec, &src->trigger_tstamp.tv_sec) ||
 209            put_user(status.trigger_tstamp.tv_nsec, &src->trigger_tstamp.tv_nsec) ||
 210            put_user(status.tstamp.tv_sec, &src->tstamp.tv_sec) ||
 211            put_user(status.tstamp.tv_nsec, &src->tstamp.tv_nsec) ||
 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                return -EFAULT;
 220
 221        return err;
 222}
 223
 224/* both for HW_PARAMS and HW_REFINE */
 225static int snd_pcm_ioctl_hw_params_compat(struct snd_pcm_substream *substream,
 226                                          int refine, 
 227                                          struct snd_pcm_hw_params32 __user *data32)
 228{
 229        struct snd_pcm_hw_params *data;
 230        struct snd_pcm_runtime *runtime;
 231        int err;
 232
 233        if (! (runtime = substream->runtime))
 234                return -ENOTTY;
 235
 236        /* only fifo_size is different, so just copy all */
 237        data = memdup_user(data32, sizeof(*data32));
 238        if (IS_ERR(data))
 239                return PTR_ERR(data);
 240
 241        if (refine)
 242                err = snd_pcm_hw_refine(substream, data);
 243        else
 244                err = snd_pcm_hw_params(substream, data);
 245        if (err < 0)
 246                goto error;
 247        if (copy_to_user(data32, data, sizeof(*data32)) ||
 248            put_user(data->fifo_size, &data32->fifo_size)) {
 249                err = -EFAULT;
 250                goto error;
 251        }
 252
 253        if (! refine) {
 254                unsigned int new_boundary = recalculate_boundary(runtime);
 255                if (new_boundary)
 256                        runtime->boundary = new_boundary;
 257        }
 258 error:
 259        kfree(data);
 260        return err;
 261}
 262
 263
 264/*
 265 */
 266struct snd_xferi32 {
 267        s32 result;
 268        u32 buf;
 269        u32 frames;
 270};
 271
 272static int snd_pcm_ioctl_xferi_compat(struct snd_pcm_substream *substream,
 273                                      int dir, struct snd_xferi32 __user *data32)
 274{
 275        compat_caddr_t buf;
 276        u32 frames;
 277        int err;
 278
 279        if (! substream->runtime)
 280                return -ENOTTY;
 281        if (substream->stream != dir)
 282                return -EINVAL;
 283        if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN)
 284                return -EBADFD;
 285
 286        if (get_user(buf, &data32->buf) ||
 287            get_user(frames, &data32->frames))
 288                return -EFAULT;
 289
 290        if (dir == SNDRV_PCM_STREAM_PLAYBACK)
 291                err = snd_pcm_lib_write(substream, compat_ptr(buf), frames);
 292        else
 293                err = snd_pcm_lib_read(substream, compat_ptr(buf), frames);
 294        if (err < 0)
 295                return err;
 296        /* copy the result */
 297        if (put_user(err, &data32->result))
 298                return -EFAULT;
 299        return 0;
 300}
 301
 302
 303/* snd_xfern needs remapping of bufs */
 304struct snd_xfern32 {
 305        s32 result;
 306        u32 bufs;  /* this is void **; */
 307        u32 frames;
 308};
 309
 310/*
 311 * xfern ioctl nees to copy (up to) 128 pointers on stack.
 312 * although we may pass the copied pointers through f_op->ioctl, but the ioctl
 313 * handler there expands again the same 128 pointers on stack, so it is better
 314 * to handle the function (calling pcm_readv/writev) directly in this handler.
 315 */
 316static int snd_pcm_ioctl_xfern_compat(struct snd_pcm_substream *substream,
 317                                      int dir, struct snd_xfern32 __user *data32)
 318{
 319        compat_caddr_t buf;
 320        compat_caddr_t __user *bufptr;
 321        u32 frames;
 322        void __user **bufs;
 323        int err, ch, i;
 324
 325        if (! substream->runtime)
 326                return -ENOTTY;
 327        if (substream->stream != dir)
 328                return -EINVAL;
 329
 330        if ((ch = substream->runtime->channels) > 128)
 331                return -EINVAL;
 332        if (get_user(buf, &data32->bufs) ||
 333            get_user(frames, &data32->frames))
 334                return -EFAULT;
 335        bufptr = compat_ptr(buf);
 336        bufs = kmalloc(sizeof(void __user *) * ch, GFP_KERNEL);
 337        if (bufs == NULL)
 338                return -ENOMEM;
 339        for (i = 0; i < ch; i++) {
 340                u32 ptr;
 341                if (get_user(ptr, bufptr)) {
 342                        kfree(bufs);
 343                        return -EFAULT;
 344                }
 345                bufs[ch] = compat_ptr(ptr);
 346                bufptr++;
 347        }
 348        if (dir == SNDRV_PCM_STREAM_PLAYBACK)
 349                err = snd_pcm_lib_writev(substream, bufs, frames);
 350        else
 351                err = snd_pcm_lib_readv(substream, bufs, frames);
 352        if (err >= 0) {
 353                if (put_user(err, &data32->result))
 354                        err = -EFAULT;
 355        }
 356        kfree(bufs);
 357        return err;
 358}
 359
 360
 361struct snd_pcm_mmap_status32 {
 362        s32 state;
 363        s32 pad1;
 364        u32 hw_ptr;
 365        struct compat_timespec tstamp;
 366        s32 suspended_state;
 367} __attribute__((packed));
 368
 369struct snd_pcm_mmap_control32 {
 370        u32 appl_ptr;
 371        u32 avail_min;
 372};
 373
 374struct snd_pcm_sync_ptr32 {
 375        u32 flags;
 376        union {
 377                struct snd_pcm_mmap_status32 status;
 378                unsigned char reserved[64];
 379        } s;
 380        union {
 381                struct snd_pcm_mmap_control32 control;
 382                unsigned char reserved[64];
 383        } c;
 384} __attribute__((packed));
 385
 386static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
 387                                         struct snd_pcm_sync_ptr32 __user *src)
 388{
 389        struct snd_pcm_runtime *runtime = substream->runtime;
 390        volatile struct snd_pcm_mmap_status *status;
 391        volatile struct snd_pcm_mmap_control *control;
 392        u32 sflags;
 393        struct snd_pcm_mmap_control scontrol;
 394        struct snd_pcm_mmap_status sstatus;
 395        snd_pcm_uframes_t boundary;
 396        int err;
 397
 398        if (snd_BUG_ON(!runtime))
 399                return -EINVAL;
 400
 401        if (get_user(sflags, &src->flags) ||
 402            get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
 403            get_user(scontrol.avail_min, &src->c.control.avail_min))
 404                return -EFAULT;
 405        if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
 406                err = snd_pcm_hwsync(substream);
 407                if (err < 0)
 408                        return err;
 409        }
 410        status = runtime->status;
 411        control = runtime->control;
 412        boundary = recalculate_boundary(runtime);
 413        if (! boundary)
 414                boundary = 0x7fffffff;
 415        snd_pcm_stream_lock_irq(substream);
 416        /* FIXME: we should consider the boundary for the sync from app */
 417        if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
 418                control->appl_ptr = scontrol.appl_ptr;
 419        else
 420                scontrol.appl_ptr = control->appl_ptr % boundary;
 421        if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
 422                control->avail_min = scontrol.avail_min;
 423        else
 424                scontrol.avail_min = control->avail_min;
 425        sstatus.state = status->state;
 426        sstatus.hw_ptr = status->hw_ptr % boundary;
 427        sstatus.tstamp = status->tstamp;
 428        sstatus.suspended_state = status->suspended_state;
 429        snd_pcm_stream_unlock_irq(substream);
 430        if (put_user(sstatus.state, &src->s.status.state) ||
 431            put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
 432            put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp.tv_sec) ||
 433            put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp.tv_nsec) ||
 434            put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
 435            put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
 436            put_user(scontrol.avail_min, &src->c.control.avail_min))
 437                return -EFAULT;
 438
 439        return 0;
 440}
 441
 442
 443/*
 444 */
 445enum {
 446        SNDRV_PCM_IOCTL_HW_REFINE32 = _IOWR('A', 0x10, struct snd_pcm_hw_params32),
 447        SNDRV_PCM_IOCTL_HW_PARAMS32 = _IOWR('A', 0x11, struct snd_pcm_hw_params32),
 448        SNDRV_PCM_IOCTL_SW_PARAMS32 = _IOWR('A', 0x13, struct snd_pcm_sw_params32),
 449        SNDRV_PCM_IOCTL_STATUS32 = _IOR('A', 0x20, struct snd_pcm_status32),
 450        SNDRV_PCM_IOCTL_DELAY32 = _IOR('A', 0x21, s32),
 451        SNDRV_PCM_IOCTL_CHANNEL_INFO32 = _IOR('A', 0x32, struct snd_pcm_channel_info32),
 452        SNDRV_PCM_IOCTL_REWIND32 = _IOW('A', 0x46, u32),
 453        SNDRV_PCM_IOCTL_FORWARD32 = _IOW('A', 0x49, u32),
 454        SNDRV_PCM_IOCTL_WRITEI_FRAMES32 = _IOW('A', 0x50, struct snd_xferi32),
 455        SNDRV_PCM_IOCTL_READI_FRAMES32 = _IOR('A', 0x51, struct snd_xferi32),
 456        SNDRV_PCM_IOCTL_WRITEN_FRAMES32 = _IOW('A', 0x52, struct snd_xfern32),
 457        SNDRV_PCM_IOCTL_READN_FRAMES32 = _IOR('A', 0x53, struct snd_xfern32),
 458        SNDRV_PCM_IOCTL_SYNC_PTR32 = _IOWR('A', 0x23, struct snd_pcm_sync_ptr32),
 459
 460};
 461
 462static long snd_pcm_ioctl_compat(struct file *file, unsigned int cmd, unsigned long arg)
 463{
 464        struct snd_pcm_file *pcm_file;
 465        struct snd_pcm_substream *substream;
 466        void __user *argp = compat_ptr(arg);
 467
 468        pcm_file = file->private_data;
 469        if (! pcm_file)
 470                return -ENOTTY;
 471        substream = pcm_file->substream;
 472        if (! substream)
 473                return -ENOTTY;
 474
 475        /*
 476         * When PCM is used on 32bit mode, we need to disable
 477         * mmap of PCM status/control records because of the size
 478         * incompatibility.
 479         */
 480        pcm_file->no_compat_mmap = 1;
 481
 482        switch (cmd) {
 483        case SNDRV_PCM_IOCTL_PVERSION:
 484        case SNDRV_PCM_IOCTL_INFO:
 485        case SNDRV_PCM_IOCTL_TSTAMP:
 486        case SNDRV_PCM_IOCTL_TTSTAMP:
 487        case SNDRV_PCM_IOCTL_HWSYNC:
 488        case SNDRV_PCM_IOCTL_PREPARE:
 489        case SNDRV_PCM_IOCTL_RESET:
 490        case SNDRV_PCM_IOCTL_START:
 491        case SNDRV_PCM_IOCTL_DROP:
 492        case SNDRV_PCM_IOCTL_DRAIN:
 493        case SNDRV_PCM_IOCTL_PAUSE:
 494        case SNDRV_PCM_IOCTL_HW_FREE:
 495        case SNDRV_PCM_IOCTL_RESUME:
 496        case SNDRV_PCM_IOCTL_XRUN:
 497        case SNDRV_PCM_IOCTL_LINK:
 498        case SNDRV_PCM_IOCTL_UNLINK:
 499                if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 500                        return snd_pcm_playback_ioctl1(file, substream, cmd, argp);
 501                else
 502                        return snd_pcm_capture_ioctl1(file, substream, cmd, argp);
 503        case SNDRV_PCM_IOCTL_HW_REFINE32:
 504                return snd_pcm_ioctl_hw_params_compat(substream, 1, argp);
 505        case SNDRV_PCM_IOCTL_HW_PARAMS32:
 506                return snd_pcm_ioctl_hw_params_compat(substream, 0, argp);
 507        case SNDRV_PCM_IOCTL_SW_PARAMS32:
 508                return snd_pcm_ioctl_sw_params_compat(substream, argp);
 509        case SNDRV_PCM_IOCTL_STATUS32:
 510                return snd_pcm_status_user_compat(substream, argp);
 511        case SNDRV_PCM_IOCTL_SYNC_PTR32:
 512                return snd_pcm_ioctl_sync_ptr_compat(substream, argp);
 513        case SNDRV_PCM_IOCTL_CHANNEL_INFO32:
 514                return snd_pcm_ioctl_channel_info_compat(substream, argp);
 515        case SNDRV_PCM_IOCTL_WRITEI_FRAMES32:
 516                return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
 517        case SNDRV_PCM_IOCTL_READI_FRAMES32:
 518                return snd_pcm_ioctl_xferi_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
 519        case SNDRV_PCM_IOCTL_WRITEN_FRAMES32:
 520                return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_PLAYBACK, argp);
 521        case SNDRV_PCM_IOCTL_READN_FRAMES32:
 522                return snd_pcm_ioctl_xfern_compat(substream, SNDRV_PCM_STREAM_CAPTURE, argp);
 523        case SNDRV_PCM_IOCTL_DELAY32:
 524                return snd_pcm_ioctl_delay_compat(substream, argp);
 525        case SNDRV_PCM_IOCTL_REWIND32:
 526                return snd_pcm_ioctl_rewind_compat(substream, argp);
 527        case SNDRV_PCM_IOCTL_FORWARD32:
 528                return snd_pcm_ioctl_forward_compat(substream, argp);
 529        }
 530
 531        return -ENOIOCTLCMD;
 532}
 533