1 /* 2 * Hardware dependent layer 3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz> 4 * 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 19 * 20 */ 21 22 #include <linux/major.h> 23 #include <linux/init.h> 24 #include <linux/slab.h> 25 #include <linux/time.h> 26 #include <linux/mutex.h> 27 #include <linux/module.h> 28 #include <linux/sched/signal.h> 29 #include <sound/core.h> 30 #include <sound/control.h> 31 #include <sound/minors.h> 32 #include <sound/hwdep.h> 33 #include <sound/info.h> 34 35 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>"); 36 MODULE_DESCRIPTION("Hardware dependent layer"); 37 MODULE_LICENSE("GPL"); 38 39 static LIST_HEAD(snd_hwdep_devices); 40 static DEFINE_MUTEX(register_mutex); 41 42 static int snd_hwdep_dev_free(struct snd_device *device); 43 static int snd_hwdep_dev_register(struct snd_device *device); 44 static int snd_hwdep_dev_disconnect(struct snd_device *device); 45 46 47 static struct snd_hwdep *snd_hwdep_search(struct snd_card *card, int device) 48 { 49 struct snd_hwdep *hwdep; 50 51 list_for_each_entry(hwdep, &snd_hwdep_devices, list) 52 if (hwdep->card == card && hwdep->device == device) 53 return hwdep; 54 return NULL; 55 } 56 57 static loff_t snd_hwdep_llseek(struct file * file, loff_t offset, int orig) 58 { 59 struct snd_hwdep *hw = file->private_data; 60 if (hw->ops.llseek) 61 return hw->ops.llseek(hw, file, offset, orig); 62 return -ENXIO; 63 } 64 65 static ssize_t snd_hwdep_read(struct file * file, char __user *buf, 66 size_t count, loff_t *offset) 67 { 68 struct snd_hwdep *hw = file->private_data; 69 if (hw->ops.read) 70 return hw->ops.read(hw, buf, count, offset); 71 return -ENXIO; 72 } 73 74 static ssize_t snd_hwdep_write(struct file * file, const char __user *buf, 75 size_t count, loff_t *offset) 76 { 77 struct snd_hwdep *hw = file->private_data; 78 if (hw->ops.write) 79 return hw->ops.write(hw, buf, count, offset); 80 return -ENXIO; 81 } 82 83 static int snd_hwdep_open(struct inode *inode, struct file * file) 84 { 85 int major = imajor(inode); 86 struct snd_hwdep *hw; 87 int err; 88 wait_queue_entry_t wait; 89 90 if (major == snd_major) { 91 hw = snd_lookup_minor_data(iminor(inode), 92 SNDRV_DEVICE_TYPE_HWDEP); 93 #ifdef CONFIG_SND_OSSEMUL 94 } else if (major == SOUND_MAJOR) { 95 hw = snd_lookup_oss_minor_data(iminor(inode), 96 SNDRV_OSS_DEVICE_TYPE_DMFM); 97 #endif 98 } else 99 return -ENXIO; 100 if (hw == NULL) 101 return -ENODEV; 102 103 if (!try_module_get(hw->card->module)) { 104 snd_card_unref(hw->card); 105 return -EFAULT; 106 } 107 108 init_waitqueue_entry(&wait, current); 109 add_wait_queue(&hw->open_wait, &wait); 110 mutex_lock(&hw->open_mutex); 111 while (1) { 112 if (hw->exclusive && hw->used > 0) { 113 err = -EBUSY; 114 break; 115 } 116 if (!hw->ops.open) { 117 err = 0; 118 break; 119 } 120 err = hw->ops.open(hw, file); 121 if (err >= 0) 122 break; 123 if (err == -EAGAIN) { 124 if (file->f_flags & O_NONBLOCK) { 125 err = -EBUSY; 126 break; 127 } 128 } else 129 break; 130 set_current_state(TASK_INTERRUPTIBLE); 131 mutex_unlock(&hw->open_mutex); 132 schedule(); 133 mutex_lock(&hw->open_mutex); 134 if (hw->card->shutdown) { 135 err = -ENODEV; 136 break; 137 } 138 if (signal_pending(current)) { 139 err = -ERESTARTSYS; 140 break; 141 } 142 } 143 remove_wait_queue(&hw->open_wait, &wait); 144 if (err >= 0) { 145 err = snd_card_file_add(hw->card, file); 146 if (err >= 0) { 147 file->private_data = hw; 148 hw->used++; 149 } else { 150 if (hw->ops.release) 151 hw->ops.release(hw, file); 152 } 153 } 154 mutex_unlock(&hw->open_mutex); 155 if (err < 0) 156 module_put(hw->card->module); 157 snd_card_unref(hw->card); 158 return err; 159 } 160 161 static int snd_hwdep_release(struct inode *inode, struct file * file) 162 { 163 int err = 0; 164 struct snd_hwdep *hw = file->private_data; 165 struct module *mod = hw->card->module; 166 167 mutex_lock(&hw->open_mutex); 168 if (hw->ops.release) 169 err = hw->ops.release(hw, file); 170 if (hw->used > 0) 171 hw->used--; 172 mutex_unlock(&hw->open_mutex); 173 wake_up(&hw->open_wait); 174 175 snd_card_file_remove(hw->card, file); 176 module_put(mod); 177 return err; 178 } 179 180 static unsigned int snd_hwdep_poll(struct file * file, poll_table * wait) 181 { 182 struct snd_hwdep *hw = file->private_data; 183 if (hw->ops.poll) 184 return hw->ops.poll(hw, file, wait); 185 return 0; 186 } 187 188 static int snd_hwdep_info(struct snd_hwdep *hw, 189 struct snd_hwdep_info __user *_info) 190 { 191 struct snd_hwdep_info info; 192 193 memset(&info, 0, sizeof(info)); 194 info.card = hw->card->number; 195 strlcpy(info.id, hw->id, sizeof(info.id)); 196 strlcpy(info.name, hw->name, sizeof(info.name)); 197 info.iface = hw->iface; 198 if (copy_to_user(_info, &info, sizeof(info))) 199 return -EFAULT; 200 return 0; 201 } 202 203 static int snd_hwdep_dsp_status(struct snd_hwdep *hw, 204 struct snd_hwdep_dsp_status __user *_info) 205 { 206 struct snd_hwdep_dsp_status info; 207 int err; 208 209 if (! hw->ops.dsp_status) 210 return -ENXIO; 211 memset(&info, 0, sizeof(info)); 212 info.dsp_loaded = hw->dsp_loaded; 213 if ((err = hw->ops.dsp_status(hw, &info)) < 0) 214 return err; 215 if (copy_to_user(_info, &info, sizeof(info))) 216 return -EFAULT; 217 return 0; 218 } 219 220 static int snd_hwdep_dsp_load(struct snd_hwdep *hw, 221 struct snd_hwdep_dsp_image __user *_info) 222 { 223 struct snd_hwdep_dsp_image info; 224 int err; 225 226 if (! hw->ops.dsp_load) 227 return -ENXIO; 228 memset(&info, 0, sizeof(info)); 229 if (copy_from_user(&info, _info, sizeof(info))) 230 return -EFAULT; 231 if (info.index >= 32) 232 return -EINVAL; 233 /* check whether the dsp was already loaded */ 234 if (hw->dsp_loaded & (1 << info.index)) 235 return -EBUSY; 236 if (!access_ok(VERIFY_READ, info.image, info.length)) 237 return -EFAULT; 238 err = hw->ops.dsp_load(hw, &info); 239 if (err < 0) 240 return err; 241 hw->dsp_loaded |= (1 << info.index); 242 return 0; 243 } 244 245 static long snd_hwdep_ioctl(struct file * file, unsigned int cmd, 246 unsigned long arg) 247 { 248 struct snd_hwdep *hw = file->private_data; 249 void __user *argp = (void __user *)arg; 250 switch (cmd) { 251 case SNDRV_HWDEP_IOCTL_PVERSION: 252 return put_user(SNDRV_HWDEP_VERSION, (int __user *)argp); 253 case SNDRV_HWDEP_IOCTL_INFO: 254 return snd_hwdep_info(hw, argp); 255 case SNDRV_HWDEP_IOCTL_DSP_STATUS: 256 return snd_hwdep_dsp_status(hw, argp); 257 case SNDRV_HWDEP_IOCTL_DSP_LOAD: 258 return snd_hwdep_dsp_load(hw, argp); 259 } 260 if (hw->ops.ioctl) 261 return hw->ops.ioctl(hw, file, cmd, arg); 262 return -ENOTTY; 263 } 264 265 static int snd_hwdep_mmap(struct file * file, struct vm_area_struct * vma) 266 { 267 struct snd_hwdep *hw = file->private_data; 268 if (hw->ops.mmap) 269 return hw->ops.mmap(hw, file, vma); 270 return -ENXIO; 271 } 272 273 static int snd_hwdep_control_ioctl(struct snd_card *card, 274 struct snd_ctl_file * control, 275 unsigned int cmd, unsigned long arg) 276 { 277 switch (cmd) { 278 case SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE: 279 { 280 int device; 281 282 if (get_user(device, (int __user *)arg)) 283 return -EFAULT; 284 mutex_lock(®ister_mutex); 285 286 if (device < 0) 287 device = 0; 288 else if (device < SNDRV_MINOR_HWDEPS) 289 device++; 290 else 291 device = SNDRV_MINOR_HWDEPS; 292 293 while (device < SNDRV_MINOR_HWDEPS) { 294 if (snd_hwdep_search(card, device)) 295 break; 296 device++; 297 } 298 if (device >= SNDRV_MINOR_HWDEPS) 299 device = -1; 300 mutex_unlock(®ister_mutex); 301 if (put_user(device, (int __user *)arg)) 302 return -EFAULT; 303 return 0; 304 } 305 case SNDRV_CTL_IOCTL_HWDEP_INFO: 306 { 307 struct snd_hwdep_info __user *info = (struct snd_hwdep_info __user *)arg; 308 int device, err; 309 struct snd_hwdep *hwdep; 310 311 if (get_user(device, &info->device)) 312 return -EFAULT; 313 mutex_lock(®ister_mutex); 314 hwdep = snd_hwdep_search(card, device); 315 if (hwdep) 316 err = snd_hwdep_info(hwdep, info); 317 else 318 err = -ENXIO; 319 mutex_unlock(®ister_mutex); 320 return err; 321 } 322 } 323 return -ENOIOCTLCMD; 324 } 325 326 #ifdef CONFIG_COMPAT 327 #include "hwdep_compat.c" 328 #else 329 #define snd_hwdep_ioctl_compat NULL 330 #endif 331 332 /* 333 334 */ 335 336 static const struct file_operations snd_hwdep_f_ops = 337 { 338 .owner = THIS_MODULE, 339 .llseek = snd_hwdep_llseek, 340 .read = snd_hwdep_read, 341 .write = snd_hwdep_write, 342 .open = snd_hwdep_open, 343 .release = snd_hwdep_release, 344 .poll = snd_hwdep_poll, 345 .unlocked_ioctl = snd_hwdep_ioctl, 346 .compat_ioctl = snd_hwdep_ioctl_compat, 347 .mmap = snd_hwdep_mmap, 348 }; 349 350 static void release_hwdep_device(struct device *dev) 351 { 352 kfree(container_of(dev, struct snd_hwdep, dev)); 353 } 354 355 /** 356 * snd_hwdep_new - create a new hwdep instance 357 * @card: the card instance 358 * @id: the id string 359 * @device: the device index (zero-based) 360 * @rhwdep: the pointer to store the new hwdep instance 361 * 362 * Creates a new hwdep instance with the given index on the card. 363 * The callbacks (hwdep->ops) must be set on the returned instance 364 * after this call manually by the caller. 365 * 366 * Return: Zero if successful, or a negative error code on failure. 367 */ 368 int snd_hwdep_new(struct snd_card *card, char *id, int device, 369 struct snd_hwdep **rhwdep) 370 { 371 struct snd_hwdep *hwdep; 372 int err; 373 static struct snd_device_ops ops = { 374 .dev_free = snd_hwdep_dev_free, 375 .dev_register = snd_hwdep_dev_register, 376 .dev_disconnect = snd_hwdep_dev_disconnect, 377 }; 378 379 if (snd_BUG_ON(!card)) 380 return -ENXIO; 381 if (rhwdep) 382 *rhwdep = NULL; 383 hwdep = kzalloc(sizeof(*hwdep), GFP_KERNEL); 384 if (!hwdep) 385 return -ENOMEM; 386 387 init_waitqueue_head(&hwdep->open_wait); 388 mutex_init(&hwdep->open_mutex); 389 hwdep->card = card; 390 hwdep->device = device; 391 if (id) 392 strlcpy(hwdep->id, id, sizeof(hwdep->id)); 393 394 snd_device_initialize(&hwdep->dev, card); 395 hwdep->dev.release = release_hwdep_device; 396 dev_set_name(&hwdep->dev, "hwC%iD%i", card->number, device); 397 #ifdef CONFIG_SND_OSSEMUL 398 hwdep->oss_type = -1; 399 #endif 400 401 err = snd_device_new(card, SNDRV_DEV_HWDEP, hwdep, &ops); 402 if (err < 0) { 403 put_device(&hwdep->dev); 404 return err; 405 } 406 407 if (rhwdep) 408 *rhwdep = hwdep; 409 return 0; 410 } 411 EXPORT_SYMBOL(snd_hwdep_new); 412 413 static int snd_hwdep_dev_free(struct snd_device *device) 414 { 415 struct snd_hwdep *hwdep = device->device_data; 416 if (!hwdep) 417 return 0; 418 if (hwdep->private_free) 419 hwdep->private_free(hwdep); 420 put_device(&hwdep->dev); 421 return 0; 422 } 423 424 static int snd_hwdep_dev_register(struct snd_device *device) 425 { 426 struct snd_hwdep *hwdep = device->device_data; 427 struct snd_card *card = hwdep->card; 428 int err; 429 430 mutex_lock(®ister_mutex); 431 if (snd_hwdep_search(card, hwdep->device)) { 432 mutex_unlock(®ister_mutex); 433 return -EBUSY; 434 } 435 list_add_tail(&hwdep->list, &snd_hwdep_devices); 436 err = snd_register_device(SNDRV_DEVICE_TYPE_HWDEP, 437 hwdep->card, hwdep->device, 438 &snd_hwdep_f_ops, hwdep, &hwdep->dev); 439 if (err < 0) { 440 dev_err(&hwdep->dev, "unable to register\n"); 441 list_del(&hwdep->list); 442 mutex_unlock(®ister_mutex); 443 return err; 444 } 445 446 #ifdef CONFIG_SND_OSSEMUL 447 hwdep->ossreg = 0; 448 if (hwdep->oss_type >= 0) { 449 if (hwdep->oss_type == SNDRV_OSS_DEVICE_TYPE_DMFM && 450 hwdep->device) 451 dev_warn(&hwdep->dev, 452 "only hwdep device 0 can be registered as OSS direct FM device!\n"); 453 else if (snd_register_oss_device(hwdep->oss_type, 454 card, hwdep->device, 455 &snd_hwdep_f_ops, hwdep) < 0) 456 dev_warn(&hwdep->dev, 457 "unable to register OSS compatibility device\n"); 458 else 459 hwdep->ossreg = 1; 460 } 461 #endif 462 mutex_unlock(®ister_mutex); 463 return 0; 464 } 465 466 static int snd_hwdep_dev_disconnect(struct snd_device *device) 467 { 468 struct snd_hwdep *hwdep = device->device_data; 469 470 if (snd_BUG_ON(!hwdep)) 471 return -ENXIO; 472 mutex_lock(®ister_mutex); 473 if (snd_hwdep_search(hwdep->card, hwdep->device) != hwdep) { 474 mutex_unlock(®ister_mutex); 475 return -EINVAL; 476 } 477 mutex_lock(&hwdep->open_mutex); 478 wake_up(&hwdep->open_wait); 479 #ifdef CONFIG_SND_OSSEMUL 480 if (hwdep->ossreg) 481 snd_unregister_oss_device(hwdep->oss_type, hwdep->card, hwdep->device); 482 #endif 483 snd_unregister_device(&hwdep->dev); 484 list_del_init(&hwdep->list); 485 mutex_unlock(&hwdep->open_mutex); 486 mutex_unlock(®ister_mutex); 487 return 0; 488 } 489 490 #ifdef CONFIG_SND_PROC_FS 491 /* 492 * Info interface 493 */ 494 495 static void snd_hwdep_proc_read(struct snd_info_entry *entry, 496 struct snd_info_buffer *buffer) 497 { 498 struct snd_hwdep *hwdep; 499 500 mutex_lock(®ister_mutex); 501 list_for_each_entry(hwdep, &snd_hwdep_devices, list) 502 snd_iprintf(buffer, "%02i-%02i: %s\n", 503 hwdep->card->number, hwdep->device, hwdep->name); 504 mutex_unlock(®ister_mutex); 505 } 506 507 static struct snd_info_entry *snd_hwdep_proc_entry; 508 509 static void __init snd_hwdep_proc_init(void) 510 { 511 struct snd_info_entry *entry; 512 513 if ((entry = snd_info_create_module_entry(THIS_MODULE, "hwdep", NULL)) != NULL) { 514 entry->c.text.read = snd_hwdep_proc_read; 515 if (snd_info_register(entry) < 0) { 516 snd_info_free_entry(entry); 517 entry = NULL; 518 } 519 } 520 snd_hwdep_proc_entry = entry; 521 } 522 523 static void __exit snd_hwdep_proc_done(void) 524 { 525 snd_info_free_entry(snd_hwdep_proc_entry); 526 } 527 #else /* !CONFIG_SND_PROC_FS */ 528 #define snd_hwdep_proc_init() 529 #define snd_hwdep_proc_done() 530 #endif /* CONFIG_SND_PROC_FS */ 531 532 533 /* 534 * ENTRY functions 535 */ 536 537 static int __init alsa_hwdep_init(void) 538 { 539 snd_hwdep_proc_init(); 540 snd_ctl_register_ioctl(snd_hwdep_control_ioctl); 541 snd_ctl_register_ioctl_compat(snd_hwdep_control_ioctl); 542 return 0; 543 } 544 545 static void __exit alsa_hwdep_exit(void) 546 { 547 snd_ctl_unregister_ioctl(snd_hwdep_control_ioctl); 548 snd_ctl_unregister_ioctl_compat(snd_hwdep_control_ioctl); 549 snd_hwdep_proc_done(); 550 } 551 552 module_init(alsa_hwdep_init) 553 module_exit(alsa_hwdep_exit) 554