linux/sound/core/control_compat.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * compat ioctls for control API
   4 *
   5 *   Copyright (c) by Takashi Iwai <tiwai@suse.de>
   6 */
   7
   8/* this file included from control.c */
   9
  10#include <linux/compat.h>
  11#include <linux/slab.h>
  12
  13struct snd_ctl_elem_list32 {
  14        u32 offset;
  15        u32 space;
  16        u32 used;
  17        u32 count;
  18        u32 pids;
  19        unsigned char reserved[50];
  20} /* don't set packed attribute here */;
  21
  22static int snd_ctl_elem_list_compat(struct snd_card *card,
  23                                    struct snd_ctl_elem_list32 __user *data32)
  24{
  25        struct snd_ctl_elem_list data = {};
  26        compat_caddr_t ptr;
  27        int err;
  28
  29        /* offset, space, used, count */
  30        if (copy_from_user(&data, data32, 4 * sizeof(u32)))
  31                return -EFAULT;
  32        /* pids */
  33        if (get_user(ptr, &data32->pids))
  34                return -EFAULT;
  35        data.pids = compat_ptr(ptr);
  36        err = snd_ctl_elem_list(card, &data);
  37        if (err < 0)
  38                return err;
  39        /* copy the result */
  40        if (copy_to_user(data32, &data, 4 * sizeof(u32)))
  41                return -EFAULT;
  42        return 0;
  43}
  44
  45/*
  46 * control element info
  47 * it uses union, so the things are not easy..
  48 */
  49
  50struct snd_ctl_elem_info32 {
  51        struct snd_ctl_elem_id id; // the size of struct is same
  52        s32 type;
  53        u32 access;
  54        u32 count;
  55        s32 owner;
  56        union {
  57                struct {
  58                        s32 min;
  59                        s32 max;
  60                        s32 step;
  61                } integer;
  62                struct {
  63                        u64 min;
  64                        u64 max;
  65                        u64 step;
  66                } integer64;
  67                struct {
  68                        u32 items;
  69                        u32 item;
  70                        char name[64];
  71                        u64 names_ptr;
  72                        u32 names_length;
  73                } enumerated;
  74                unsigned char reserved[128];
  75        } value;
  76        unsigned char reserved[64];
  77} __attribute__((packed));
  78
  79static int snd_ctl_elem_info_compat(struct snd_ctl_file *ctl,
  80                                    struct snd_ctl_elem_info32 __user *data32)
  81{
  82        struct snd_ctl_elem_info *data;
  83        int err;
  84
  85        data = kzalloc(sizeof(*data), GFP_KERNEL);
  86        if (! data)
  87                return -ENOMEM;
  88
  89        err = -EFAULT;
  90        /* copy id */
  91        if (copy_from_user(&data->id, &data32->id, sizeof(data->id)))
  92                goto error;
  93        /* we need to copy the item index.
  94         * hope this doesn't break anything..
  95         */
  96        if (get_user(data->value.enumerated.item, &data32->value.enumerated.item))
  97                goto error;
  98
  99        err = snd_ctl_elem_info(ctl, data);
 100        if (err < 0)
 101                goto error;
 102        /* restore info to 32bit */
 103        err = -EFAULT;
 104        /* id, type, access, count */
 105        if (copy_to_user(&data32->id, &data->id, sizeof(data->id)) ||
 106            copy_to_user(&data32->type, &data->type, 3 * sizeof(u32)))
 107                goto error;
 108        if (put_user(data->owner, &data32->owner))
 109                goto error;
 110        switch (data->type) {
 111        case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
 112        case SNDRV_CTL_ELEM_TYPE_INTEGER:
 113                if (put_user(data->value.integer.min, &data32->value.integer.min) ||
 114                    put_user(data->value.integer.max, &data32->value.integer.max) ||
 115                    put_user(data->value.integer.step, &data32->value.integer.step))
 116                        goto error;
 117                break;
 118        case SNDRV_CTL_ELEM_TYPE_INTEGER64:
 119                if (copy_to_user(&data32->value.integer64,
 120                                 &data->value.integer64,
 121                                 sizeof(data->value.integer64)))
 122                        goto error;
 123                break;
 124        case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
 125                if (copy_to_user(&data32->value.enumerated,
 126                                 &data->value.enumerated,
 127                                 sizeof(data->value.enumerated)))
 128                        goto error;
 129                break;
 130        default:
 131                break;
 132        }
 133        err = 0;
 134 error:
 135        kfree(data);
 136        return err;
 137}
 138
 139/* read / write */
 140struct snd_ctl_elem_value32 {
 141        struct snd_ctl_elem_id id;
 142        unsigned int indirect;  /* bit-field causes misalignment */
 143        union {
 144                s32 integer[128];
 145                unsigned char data[512];
 146#ifndef CONFIG_X86_64
 147                s64 integer64[64];
 148#endif
 149        } value;
 150        unsigned char reserved[128];
 151};
 152
 153#ifdef CONFIG_X86_X32
 154/* x32 has a different alignment for 64bit values from ia32 */
 155struct snd_ctl_elem_value_x32 {
 156        struct snd_ctl_elem_id id;
 157        unsigned int indirect;  /* bit-field causes misalignment */
 158        union {
 159                s32 integer[128];
 160                unsigned char data[512];
 161                s64 integer64[64];
 162        } value;
 163        unsigned char reserved[128];
 164};
 165#endif /* CONFIG_X86_X32 */
 166
 167/* get the value type and count of the control */
 168static int get_ctl_type(struct snd_card *card, struct snd_ctl_elem_id *id,
 169                        int *countp)
 170{
 171        struct snd_kcontrol *kctl;
 172        struct snd_ctl_elem_info *info;
 173        int err;
 174
 175        down_read(&card->controls_rwsem);
 176        kctl = snd_ctl_find_id(card, id);
 177        if (! kctl) {
 178                up_read(&card->controls_rwsem);
 179                return -ENOENT;
 180        }
 181        info = kzalloc(sizeof(*info), GFP_KERNEL);
 182        if (info == NULL) {
 183                up_read(&card->controls_rwsem);
 184                return -ENOMEM;
 185        }
 186        info->id = *id;
 187        err = snd_power_ref_and_wait(card);
 188        if (!err)
 189                err = kctl->info(kctl, info);
 190        snd_power_unref(card);
 191        up_read(&card->controls_rwsem);
 192        if (err >= 0) {
 193                err = info->type;
 194                *countp = info->count;
 195        }
 196        kfree(info);
 197        return err;
 198}
 199
 200static int get_elem_size(int type, int count)
 201{
 202        switch (type) {
 203        case SNDRV_CTL_ELEM_TYPE_INTEGER64:
 204                return sizeof(s64) * count;
 205        case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
 206                return sizeof(int) * count;
 207        case SNDRV_CTL_ELEM_TYPE_BYTES:
 208                return 512;
 209        case SNDRV_CTL_ELEM_TYPE_IEC958:
 210                return sizeof(struct snd_aes_iec958);
 211        default:
 212                return -1;
 213        }
 214}
 215
 216static int copy_ctl_value_from_user(struct snd_card *card,
 217                                    struct snd_ctl_elem_value *data,
 218                                    void __user *userdata,
 219                                    void __user *valuep,
 220                                    int *typep, int *countp)
 221{
 222        struct snd_ctl_elem_value32 __user *data32 = userdata;
 223        int i, type, size;
 224        int count;
 225        unsigned int indirect;
 226
 227        if (copy_from_user(&data->id, &data32->id, sizeof(data->id)))
 228                return -EFAULT;
 229        if (get_user(indirect, &data32->indirect))
 230                return -EFAULT;
 231        if (indirect)
 232                return -EINVAL;
 233        type = get_ctl_type(card, &data->id, &count);
 234        if (type < 0)
 235                return type;
 236
 237        if (type == SNDRV_CTL_ELEM_TYPE_BOOLEAN ||
 238            type == SNDRV_CTL_ELEM_TYPE_INTEGER) {
 239                for (i = 0; i < count; i++) {
 240                        s32 __user *intp = valuep;
 241                        int val;
 242                        if (get_user(val, &intp[i]))
 243                                return -EFAULT;
 244                        data->value.integer.value[i] = val;
 245                }
 246        } else {
 247                size = get_elem_size(type, count);
 248                if (size < 0) {
 249                        dev_err(card->dev, "snd_ioctl32_ctl_elem_value: unknown type %d\n", type);
 250                        return -EINVAL;
 251                }
 252                if (copy_from_user(data->value.bytes.data, valuep, size))
 253                        return -EFAULT;
 254        }
 255
 256        *typep = type;
 257        *countp = count;
 258        return 0;
 259}
 260
 261/* restore the value to 32bit */
 262static int copy_ctl_value_to_user(void __user *userdata,
 263                                  void __user *valuep,
 264                                  struct snd_ctl_elem_value *data,
 265                                  int type, int count)
 266{
 267        int i, size;
 268
 269        if (type == SNDRV_CTL_ELEM_TYPE_BOOLEAN ||
 270            type == SNDRV_CTL_ELEM_TYPE_INTEGER) {
 271                for (i = 0; i < count; i++) {
 272                        s32 __user *intp = valuep;
 273                        int val;
 274                        val = data->value.integer.value[i];
 275                        if (put_user(val, &intp[i]))
 276                                return -EFAULT;
 277                }
 278        } else {
 279                size = get_elem_size(type, count);
 280                if (copy_to_user(valuep, data->value.bytes.data, size))
 281                        return -EFAULT;
 282        }
 283        return 0;
 284}
 285
 286static int ctl_elem_read_user(struct snd_card *card,
 287                              void __user *userdata, void __user *valuep)
 288{
 289        struct snd_ctl_elem_value *data;
 290        int err, type, count;
 291
 292        data = kzalloc(sizeof(*data), GFP_KERNEL);
 293        if (data == NULL)
 294                return -ENOMEM;
 295
 296        err = copy_ctl_value_from_user(card, data, userdata, valuep,
 297                                       &type, &count);
 298        if (err < 0)
 299                goto error;
 300
 301        err = snd_ctl_elem_read(card, data);
 302        if (err < 0)
 303                goto error;
 304        err = copy_ctl_value_to_user(userdata, valuep, data, type, count);
 305 error:
 306        kfree(data);
 307        return err;
 308}
 309
 310static int ctl_elem_write_user(struct snd_ctl_file *file,
 311                               void __user *userdata, void __user *valuep)
 312{
 313        struct snd_ctl_elem_value *data;
 314        struct snd_card *card = file->card;
 315        int err, type, count;
 316
 317        data = kzalloc(sizeof(*data), GFP_KERNEL);
 318        if (data == NULL)
 319                return -ENOMEM;
 320
 321        err = copy_ctl_value_from_user(card, data, userdata, valuep,
 322                                       &type, &count);
 323        if (err < 0)
 324                goto error;
 325
 326        err = snd_ctl_elem_write(card, file, data);
 327        if (err < 0)
 328                goto error;
 329        err = copy_ctl_value_to_user(userdata, valuep, data, type, count);
 330 error:
 331        kfree(data);
 332        return err;
 333}
 334
 335static int snd_ctl_elem_read_user_compat(struct snd_card *card,
 336                                         struct snd_ctl_elem_value32 __user *data32)
 337{
 338        return ctl_elem_read_user(card, data32, &data32->value);
 339}
 340
 341static int snd_ctl_elem_write_user_compat(struct snd_ctl_file *file,
 342                                          struct snd_ctl_elem_value32 __user *data32)
 343{
 344        return ctl_elem_write_user(file, data32, &data32->value);
 345}
 346
 347#ifdef CONFIG_X86_X32
 348static int snd_ctl_elem_read_user_x32(struct snd_card *card,
 349                                      struct snd_ctl_elem_value_x32 __user *data32)
 350{
 351        return ctl_elem_read_user(card, data32, &data32->value);
 352}
 353
 354static int snd_ctl_elem_write_user_x32(struct snd_ctl_file *file,
 355                                       struct snd_ctl_elem_value_x32 __user *data32)
 356{
 357        return ctl_elem_write_user(file, data32, &data32->value);
 358}
 359#endif /* CONFIG_X86_X32 */
 360
 361/* add or replace a user control */
 362static int snd_ctl_elem_add_compat(struct snd_ctl_file *file,
 363                                   struct snd_ctl_elem_info32 __user *data32,
 364                                   int replace)
 365{
 366        struct snd_ctl_elem_info *data;
 367        int err;
 368
 369        data = kzalloc(sizeof(*data), GFP_KERNEL);
 370        if (! data)
 371                return -ENOMEM;
 372
 373        err = -EFAULT;
 374        /* id, type, access, count */ \
 375        if (copy_from_user(&data->id, &data32->id, sizeof(data->id)) ||
 376            copy_from_user(&data->type, &data32->type, 3 * sizeof(u32)))
 377                goto error;
 378        if (get_user(data->owner, &data32->owner))
 379                goto error;
 380        switch (data->type) {
 381        case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
 382        case SNDRV_CTL_ELEM_TYPE_INTEGER:
 383                if (get_user(data->value.integer.min, &data32->value.integer.min) ||
 384                    get_user(data->value.integer.max, &data32->value.integer.max) ||
 385                    get_user(data->value.integer.step, &data32->value.integer.step))
 386                        goto error;
 387                break;
 388        case SNDRV_CTL_ELEM_TYPE_INTEGER64:
 389                if (copy_from_user(&data->value.integer64,
 390                                   &data32->value.integer64,
 391                                   sizeof(data->value.integer64)))
 392                        goto error;
 393                break;
 394        case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
 395                if (copy_from_user(&data->value.enumerated,
 396                                   &data32->value.enumerated,
 397                                   sizeof(data->value.enumerated)))
 398                        goto error;
 399                data->value.enumerated.names_ptr =
 400                        (uintptr_t)compat_ptr(data->value.enumerated.names_ptr);
 401                break;
 402        default:
 403                break;
 404        }
 405        err = snd_ctl_elem_add(file, data, replace);
 406 error:
 407        kfree(data);
 408        return err;
 409}  
 410
 411enum {
 412        SNDRV_CTL_IOCTL_ELEM_LIST32 = _IOWR('U', 0x10, struct snd_ctl_elem_list32),
 413        SNDRV_CTL_IOCTL_ELEM_INFO32 = _IOWR('U', 0x11, struct snd_ctl_elem_info32),
 414        SNDRV_CTL_IOCTL_ELEM_READ32 = _IOWR('U', 0x12, struct snd_ctl_elem_value32),
 415        SNDRV_CTL_IOCTL_ELEM_WRITE32 = _IOWR('U', 0x13, struct snd_ctl_elem_value32),
 416        SNDRV_CTL_IOCTL_ELEM_ADD32 = _IOWR('U', 0x17, struct snd_ctl_elem_info32),
 417        SNDRV_CTL_IOCTL_ELEM_REPLACE32 = _IOWR('U', 0x18, struct snd_ctl_elem_info32),
 418#ifdef CONFIG_X86_X32
 419        SNDRV_CTL_IOCTL_ELEM_READ_X32 = _IOWR('U', 0x12, struct snd_ctl_elem_value_x32),
 420        SNDRV_CTL_IOCTL_ELEM_WRITE_X32 = _IOWR('U', 0x13, struct snd_ctl_elem_value_x32),
 421#endif /* CONFIG_X86_X32 */
 422};
 423
 424static inline long snd_ctl_ioctl_compat(struct file *file, unsigned int cmd, unsigned long arg)
 425{
 426        struct snd_ctl_file *ctl;
 427        struct snd_kctl_ioctl *p;
 428        void __user *argp = compat_ptr(arg);
 429        int err;
 430
 431        ctl = file->private_data;
 432        if (snd_BUG_ON(!ctl || !ctl->card))
 433                return -ENXIO;
 434
 435        switch (cmd) {
 436        case SNDRV_CTL_IOCTL_PVERSION:
 437        case SNDRV_CTL_IOCTL_CARD_INFO:
 438        case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
 439        case SNDRV_CTL_IOCTL_POWER:
 440        case SNDRV_CTL_IOCTL_POWER_STATE:
 441        case SNDRV_CTL_IOCTL_ELEM_LOCK:
 442        case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
 443        case SNDRV_CTL_IOCTL_ELEM_REMOVE:
 444        case SNDRV_CTL_IOCTL_TLV_READ:
 445        case SNDRV_CTL_IOCTL_TLV_WRITE:
 446        case SNDRV_CTL_IOCTL_TLV_COMMAND:
 447                return snd_ctl_ioctl(file, cmd, (unsigned long)argp);
 448        case SNDRV_CTL_IOCTL_ELEM_LIST32:
 449                return snd_ctl_elem_list_compat(ctl->card, argp);
 450        case SNDRV_CTL_IOCTL_ELEM_INFO32:
 451                return snd_ctl_elem_info_compat(ctl, argp);
 452        case SNDRV_CTL_IOCTL_ELEM_READ32:
 453                return snd_ctl_elem_read_user_compat(ctl->card, argp);
 454        case SNDRV_CTL_IOCTL_ELEM_WRITE32:
 455                return snd_ctl_elem_write_user_compat(ctl, argp);
 456        case SNDRV_CTL_IOCTL_ELEM_ADD32:
 457                return snd_ctl_elem_add_compat(ctl, argp, 0);
 458        case SNDRV_CTL_IOCTL_ELEM_REPLACE32:
 459                return snd_ctl_elem_add_compat(ctl, argp, 1);
 460#ifdef CONFIG_X86_X32
 461        case SNDRV_CTL_IOCTL_ELEM_READ_X32:
 462                return snd_ctl_elem_read_user_x32(ctl->card, argp);
 463        case SNDRV_CTL_IOCTL_ELEM_WRITE_X32:
 464                return snd_ctl_elem_write_user_x32(ctl, argp);
 465#endif /* CONFIG_X86_X32 */
 466        }
 467
 468        down_read(&snd_ioctl_rwsem);
 469        list_for_each_entry(p, &snd_control_compat_ioctls, list) {
 470                if (p->fioctl) {
 471                        err = p->fioctl(ctl->card, ctl, cmd, arg);
 472                        if (err != -ENOIOCTLCMD) {
 473                                up_read(&snd_ioctl_rwsem);
 474                                return err;
 475                        }
 476                }
 477        }
 478        up_read(&snd_ioctl_rwsem);
 479        return -ENOIOCTLCMD;
 480}
 481