1 /******************************************************************************* 2 AudioScience HPI driver 3 Common Linux HPI ioctl and module probe/remove functions 4 5 Copyright (C) 1997-2014 AudioScience Inc. <support@audioscience.com> 6 7 This program is free software; you can redistribute it and/or modify 8 it under the terms of version 2 of the GNU General Public License as 9 published by the Free Software Foundation; 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 *******************************************************************************/ 17 #define SOURCEFILE_NAME "hpioctl.c" 18 19 #include "hpi_internal.h" 20 #include "hpi_version.h" 21 #include "hpimsginit.h" 22 #include "hpidebug.h" 23 #include "hpimsgx.h" 24 #include "hpioctl.h" 25 #include "hpicmn.h" 26 27 #include <linux/fs.h> 28 #include <linux/interrupt.h> 29 #include <linux/slab.h> 30 #include <linux/moduleparam.h> 31 #include <asm/uaccess.h> 32 #include <linux/pci.h> 33 #include <linux/stringify.h> 34 #include <linux/module.h> 35 36 #ifdef MODULE_FIRMWARE 37 MODULE_FIRMWARE("asihpi/dsp5000.bin"); 38 MODULE_FIRMWARE("asihpi/dsp6200.bin"); 39 MODULE_FIRMWARE("asihpi/dsp6205.bin"); 40 MODULE_FIRMWARE("asihpi/dsp6400.bin"); 41 MODULE_FIRMWARE("asihpi/dsp6600.bin"); 42 MODULE_FIRMWARE("asihpi/dsp8700.bin"); 43 MODULE_FIRMWARE("asihpi/dsp8900.bin"); 44 #endif 45 46 static int prealloc_stream_buf; 47 module_param(prealloc_stream_buf, int, S_IRUGO); 48 MODULE_PARM_DESC(prealloc_stream_buf, 49 "Preallocate size for per-adapter stream buffer"); 50 51 /* Allow the debug level to be changed after module load. 52 E.g. echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel 53 */ 54 module_param(hpi_debug_level, int, S_IRUGO | S_IWUSR); 55 MODULE_PARM_DESC(hpi_debug_level, "debug verbosity 0..5"); 56 57 /* List of adapters found */ 58 static struct hpi_adapter adapters[HPI_MAX_ADAPTERS]; 59 60 /* Wrapper function to HPI_Message to enable dumping of the 61 message and response types. 62 */ 63 static void hpi_send_recv_f(struct hpi_message *phm, struct hpi_response *phr, 64 struct file *file) 65 { 66 if ((phm->adapter_index >= HPI_MAX_ADAPTERS) 67 && (phm->object != HPI_OBJ_SUBSYSTEM)) 68 phr->error = HPI_ERROR_INVALID_OBJ_INDEX; 69 else 70 hpi_send_recv_ex(phm, phr, file); 71 } 72 73 /* This is called from hpifunc.c functions, called by ALSA 74 * (or other kernel process) In this case there is no file descriptor 75 * available for the message cache code 76 */ 77 void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr) 78 { 79 hpi_send_recv_f(phm, phr, HOWNER_KERNEL); 80 } 81 82 EXPORT_SYMBOL(hpi_send_recv); 83 /* for radio-asihpi */ 84 85 int asihpi_hpi_release(struct file *file) 86 { 87 struct hpi_message hm; 88 struct hpi_response hr; 89 90 /* HPI_DEBUG_LOG(INFO,"hpi_release file %p, pid %d\n", file, current->pid); */ 91 /* close the subsystem just in case the application forgot to. */ 92 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM, 93 HPI_SUBSYS_CLOSE); 94 hpi_send_recv_ex(&hm, &hr, file); 95 return 0; 96 } 97 98 long asihpi_hpi_ioctl(struct file *file, unsigned int cmd, unsigned long arg) 99 { 100 struct hpi_ioctl_linux __user *phpi_ioctl_data; 101 void __user *puhm; 102 void __user *puhr; 103 union hpi_message_buffer_v1 *hm; 104 union hpi_response_buffer_v1 *hr; 105 u16 res_max_size; 106 u32 uncopied_bytes; 107 int err = 0; 108 109 if (cmd != HPI_IOCTL_LINUX) 110 return -EINVAL; 111 112 hm = kmalloc(sizeof(*hm), GFP_KERNEL); 113 hr = kmalloc(sizeof(*hr), GFP_KERNEL); 114 if (!hm || !hr) { 115 err = -ENOMEM; 116 goto out; 117 } 118 119 phpi_ioctl_data = (struct hpi_ioctl_linux __user *)arg; 120 121 /* Read the message and response pointers from user space. */ 122 if (get_user(puhm, &phpi_ioctl_data->phm) 123 || get_user(puhr, &phpi_ioctl_data->phr)) { 124 err = -EFAULT; 125 goto out; 126 } 127 128 /* Now read the message size and data from user space. */ 129 if (get_user(hm->h.size, (u16 __user *)puhm)) { 130 err = -EFAULT; 131 goto out; 132 } 133 if (hm->h.size > sizeof(*hm)) 134 hm->h.size = sizeof(*hm); 135 136 /* printk(KERN_INFO "message size %d\n", hm->h.wSize); */ 137 138 uncopied_bytes = copy_from_user(hm, puhm, hm->h.size); 139 if (uncopied_bytes) { 140 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes); 141 err = -EFAULT; 142 goto out; 143 } 144 145 if (get_user(res_max_size, (u16 __user *)puhr)) { 146 err = -EFAULT; 147 goto out; 148 } 149 /* printk(KERN_INFO "user response size %d\n", res_max_size); */ 150 if (res_max_size < sizeof(struct hpi_response_header)) { 151 HPI_DEBUG_LOG(WARNING, "small res size %d\n", res_max_size); 152 err = -EFAULT; 153 goto out; 154 } 155 156 switch (hm->h.function) { 157 case HPI_SUBSYS_CREATE_ADAPTER: 158 case HPI_ADAPTER_DELETE: 159 /* Application must not use these functions! */ 160 hr->h.size = sizeof(hr->h); 161 hr->h.error = HPI_ERROR_INVALID_OPERATION; 162 hr->h.function = hm->h.function; 163 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size); 164 if (uncopied_bytes) 165 err = -EFAULT; 166 else 167 err = 0; 168 goto out; 169 } 170 171 hr->h.size = res_max_size; 172 if (hm->h.object == HPI_OBJ_SUBSYSTEM) { 173 hpi_send_recv_f(&hm->m0, &hr->r0, file); 174 } else { 175 u16 __user *ptr = NULL; 176 u32 size = 0; 177 /* -1=no data 0=read from user mem, 1=write to user mem */ 178 int wrflag = -1; 179 struct hpi_adapter *pa = NULL; 180 181 if (hm->h.adapter_index < ARRAY_SIZE(adapters)) 182 pa = &adapters[hm->h.adapter_index]; 183 184 if (!pa || !pa->adapter || !pa->adapter->type) { 185 hpi_init_response(&hr->r0, hm->h.object, 186 hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER); 187 188 uncopied_bytes = 189 copy_to_user(puhr, hr, sizeof(hr->h)); 190 if (uncopied_bytes) 191 err = -EFAULT; 192 else 193 err = 0; 194 goto out; 195 } 196 197 if (mutex_lock_interruptible(&pa->mutex)) { 198 err = -EINTR; 199 goto out; 200 } 201 202 /* Dig out any pointers embedded in the message. */ 203 switch (hm->h.function) { 204 case HPI_OSTREAM_WRITE: 205 case HPI_ISTREAM_READ:{ 206 /* Yes, sparse, this is correct. */ 207 ptr = (u16 __user *)hm->m0.u.d.u.data.pb_data; 208 size = hm->m0.u.d.u.data.data_size; 209 210 /* Allocate buffer according to application request. 211 ?Is it better to alloc/free for the duration 212 of the transaction? 213 */ 214 if (pa->buffer_size < size) { 215 HPI_DEBUG_LOG(DEBUG, 216 "Realloc adapter %d stream " 217 "buffer from %zd to %d\n", 218 hm->h.adapter_index, 219 pa->buffer_size, size); 220 if (pa->p_buffer) { 221 pa->buffer_size = 0; 222 vfree(pa->p_buffer); 223 } 224 pa->p_buffer = vmalloc(size); 225 if (pa->p_buffer) 226 pa->buffer_size = size; 227 else { 228 HPI_DEBUG_LOG(ERROR, 229 "HPI could not allocate " 230 "stream buffer size %d\n", 231 size); 232 233 mutex_unlock(&pa->mutex); 234 err = -EINVAL; 235 goto out; 236 } 237 } 238 239 hm->m0.u.d.u.data.pb_data = pa->p_buffer; 240 if (hm->h.function == HPI_ISTREAM_READ) 241 /* from card, WRITE to user mem */ 242 wrflag = 1; 243 else 244 wrflag = 0; 245 break; 246 } 247 248 default: 249 size = 0; 250 break; 251 } 252 253 if (size && (wrflag == 0)) { 254 uncopied_bytes = 255 copy_from_user(pa->p_buffer, ptr, size); 256 if (uncopied_bytes) 257 HPI_DEBUG_LOG(WARNING, 258 "Missed %d of %d " 259 "bytes from user\n", uncopied_bytes, 260 size); 261 } 262 263 hpi_send_recv_f(&hm->m0, &hr->r0, file); 264 265 if (size && (wrflag == 1)) { 266 uncopied_bytes = 267 copy_to_user(ptr, pa->p_buffer, size); 268 if (uncopied_bytes) 269 HPI_DEBUG_LOG(WARNING, 270 "Missed %d of %d " "bytes to user\n", 271 uncopied_bytes, size); 272 } 273 274 mutex_unlock(&pa->mutex); 275 } 276 277 /* on return response size must be set */ 278 /*printk(KERN_INFO "response size %d\n", hr->h.wSize); */ 279 280 if (!hr->h.size) { 281 HPI_DEBUG_LOG(ERROR, "response zero size\n"); 282 err = -EFAULT; 283 goto out; 284 } 285 286 if (hr->h.size > res_max_size) { 287 HPI_DEBUG_LOG(ERROR, "response too big %d %d\n", hr->h.size, 288 res_max_size); 289 hr->h.error = HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL; 290 hr->h.specific_error = hr->h.size; 291 hr->h.size = sizeof(hr->h); 292 } 293 294 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size); 295 if (uncopied_bytes) { 296 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes); 297 err = -EFAULT; 298 goto out; 299 } 300 301 out: 302 kfree(hm); 303 kfree(hr); 304 return err; 305 } 306 307 static int asihpi_irq_count; 308 309 static irqreturn_t asihpi_isr(int irq, void *dev_id) 310 { 311 struct hpi_adapter *a = dev_id; 312 int handled; 313 314 if (!a->adapter->irq_query_and_clear) { 315 pr_err("asihpi_isr ASI%04X:%d no handler\n", a->adapter->type, 316 a->adapter->index); 317 return IRQ_NONE; 318 } 319 320 handled = a->adapter->irq_query_and_clear(a->adapter, 0); 321 322 if (!handled) 323 return IRQ_NONE; 324 325 asihpi_irq_count++; 326 /* printk(KERN_INFO "asihpi_isr %d ASI%04X:%d irq handled\n", 327 asihpi_irq_count, a->adapter->type, a->adapter->index); */ 328 329 if (a->interrupt_callback) 330 a->interrupt_callback(a); 331 332 return IRQ_HANDLED; 333 } 334 335 int asihpi_adapter_probe(struct pci_dev *pci_dev, 336 const struct pci_device_id *pci_id) 337 { 338 int idx, nm, low_latency_mode = 0, irq_supported = 0; 339 int adapter_index; 340 unsigned int memlen; 341 struct hpi_message hm; 342 struct hpi_response hr; 343 struct hpi_adapter adapter; 344 struct hpi_pci pci; 345 346 memset(&adapter, 0, sizeof(adapter)); 347 348 dev_printk(KERN_DEBUG, &pci_dev->dev, 349 "probe %04x:%04x,%04x:%04x,%04x\n", pci_dev->vendor, 350 pci_dev->device, pci_dev->subsystem_vendor, 351 pci_dev->subsystem_device, pci_dev->devfn); 352 353 if (pci_enable_device(pci_dev) < 0) { 354 dev_err(&pci_dev->dev, 355 "pci_enable_device failed, disabling device\n"); 356 return -EIO; 357 } 358 359 pci_set_master(pci_dev); /* also sets latency timer if < 16 */ 360 361 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM, 362 HPI_SUBSYS_CREATE_ADAPTER); 363 hpi_init_response(&hr, HPI_OBJ_SUBSYSTEM, HPI_SUBSYS_CREATE_ADAPTER, 364 HPI_ERROR_PROCESSING_MESSAGE); 365 366 hm.adapter_index = HPI_ADAPTER_INDEX_INVALID; 367 368 nm = HPI_MAX_ADAPTER_MEM_SPACES; 369 370 for (idx = 0; idx < nm; idx++) { 371 HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx, 372 &pci_dev->resource[idx]); 373 374 if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) { 375 memlen = pci_resource_len(pci_dev, idx); 376 pci.ap_mem_base[idx] = 377 ioremap(pci_resource_start(pci_dev, idx), 378 memlen); 379 if (!pci.ap_mem_base[idx]) { 380 HPI_DEBUG_LOG(ERROR, 381 "ioremap failed, aborting\n"); 382 /* unmap previously mapped pci mem space */ 383 goto err; 384 } 385 } 386 } 387 388 pci.pci_dev = pci_dev; 389 hm.u.s.resource.bus_type = HPI_BUS_PCI; 390 hm.u.s.resource.r.pci = &pci; 391 392 /* call CreateAdapterObject on the relevant hpi module */ 393 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 394 if (hr.error) 395 goto err; 396 397 adapter_index = hr.u.s.adapter_index; 398 adapter.adapter = hpi_find_adapter(adapter_index); 399 400 if (prealloc_stream_buf) { 401 adapter.p_buffer = vmalloc(prealloc_stream_buf); 402 if (!adapter.p_buffer) { 403 HPI_DEBUG_LOG(ERROR, 404 "HPI could not allocate " 405 "kernel buffer size %d\n", 406 prealloc_stream_buf); 407 goto err; 408 } 409 } 410 411 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 412 HPI_ADAPTER_OPEN); 413 hm.adapter_index = adapter.adapter->index; 414 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 415 416 if (hr.error) { 417 HPI_DEBUG_LOG(ERROR, "HPI_ADAPTER_OPEN failed, aborting\n"); 418 goto err; 419 } 420 421 /* Check if current mode == Low Latency mode */ 422 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 423 HPI_ADAPTER_GET_MODE); 424 hm.adapter_index = adapter.adapter->index; 425 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 426 427 if (!hr.error 428 && hr.u.ax.mode.adapter_mode == HPI_ADAPTER_MODE_LOW_LATENCY) 429 low_latency_mode = 1; 430 else 431 dev_info(&pci_dev->dev, 432 "Adapter at index %d is not in low latency mode\n", 433 adapter.adapter->index); 434 435 /* Check if IRQs are supported */ 436 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 437 HPI_ADAPTER_GET_PROPERTY); 438 hm.adapter_index = adapter.adapter->index; 439 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ; 440 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 441 if (hr.error || !hr.u.ax.property_get.parameter1) { 442 dev_info(&pci_dev->dev, 443 "IRQs not supported by adapter at index %d\n", 444 adapter.adapter->index); 445 } else { 446 irq_supported = 1; 447 } 448 449 /* WARNING can't init mutex in 'adapter' 450 * and then copy it to adapters[] ?!?! 451 */ 452 adapters[adapter_index] = adapter; 453 mutex_init(&adapters[adapter_index].mutex); 454 pci_set_drvdata(pci_dev, &adapters[adapter_index]); 455 456 if (low_latency_mode && irq_supported) { 457 if (!adapter.adapter->irq_query_and_clear) { 458 dev_err(&pci_dev->dev, 459 "no IRQ handler for adapter %d, aborting\n", 460 adapter.adapter->index); 461 goto err; 462 } 463 464 /* Disable IRQ generation on DSP side by setting the rate to 0 */ 465 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 466 HPI_ADAPTER_SET_PROPERTY); 467 hm.adapter_index = adapter.adapter->index; 468 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE; 469 hm.u.ax.property_set.parameter1 = 0; 470 hm.u.ax.property_set.parameter2 = 0; 471 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 472 if (hr.error) { 473 HPI_DEBUG_LOG(ERROR, 474 "HPI_ADAPTER_GET_MODE failed, aborting\n"); 475 goto err; 476 } 477 478 /* Note: request_irq calls asihpi_isr here */ 479 if (request_irq(pci_dev->irq, asihpi_isr, IRQF_SHARED, 480 "asihpi", &adapters[adapter_index])) { 481 dev_err(&pci_dev->dev, "request_irq(%d) failed\n", 482 pci_dev->irq); 483 goto err; 484 } 485 486 adapters[adapter_index].interrupt_mode = 1; 487 488 dev_info(&pci_dev->dev, "using irq %d\n", pci_dev->irq); 489 adapters[adapter_index].irq = pci_dev->irq; 490 } else { 491 dev_info(&pci_dev->dev, "using polled mode\n"); 492 } 493 494 dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n", 495 adapter.adapter->type, adapter_index); 496 497 return 0; 498 499 err: 500 for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) { 501 if (pci.ap_mem_base[idx]) { 502 iounmap(pci.ap_mem_base[idx]); 503 pci.ap_mem_base[idx] = NULL; 504 } 505 } 506 507 if (adapter.p_buffer) { 508 adapter.buffer_size = 0; 509 vfree(adapter.p_buffer); 510 } 511 512 HPI_DEBUG_LOG(ERROR, "adapter_probe failed\n"); 513 return -ENODEV; 514 } 515 516 void asihpi_adapter_remove(struct pci_dev *pci_dev) 517 { 518 int idx; 519 struct hpi_message hm; 520 struct hpi_response hr; 521 struct hpi_adapter *pa; 522 struct hpi_pci pci; 523 524 pa = pci_get_drvdata(pci_dev); 525 pci = pa->adapter->pci; 526 527 /* Disable IRQ generation on DSP side */ 528 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 529 HPI_ADAPTER_SET_PROPERTY); 530 hm.adapter_index = pa->adapter->index; 531 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE; 532 hm.u.ax.property_set.parameter1 = 0; 533 hm.u.ax.property_set.parameter2 = 0; 534 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 535 536 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER, 537 HPI_ADAPTER_DELETE); 538 hm.adapter_index = pa->adapter->index; 539 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 540 541 /* unmap PCI memory space, mapped during device init. */ 542 for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) { 543 if (pci.ap_mem_base[idx]) 544 iounmap(pci.ap_mem_base[idx]); 545 } 546 547 if (pa->irq) 548 free_irq(pa->irq, pa); 549 550 vfree(pa->p_buffer); 551 552 if (1) 553 dev_info(&pci_dev->dev, 554 "remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n", 555 pci_dev->vendor, pci_dev->device, 556 pci_dev->subsystem_vendor, pci_dev->subsystem_device, 557 pci_dev->devfn, pa->adapter->index); 558 559 memset(pa, 0, sizeof(*pa)); 560 } 561 562 void __init asihpi_init(void) 563 { 564 struct hpi_message hm; 565 struct hpi_response hr; 566 567 memset(adapters, 0, sizeof(adapters)); 568 569 printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n"); 570 571 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM, 572 HPI_SUBSYS_DRIVER_LOAD); 573 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 574 } 575 576 void asihpi_exit(void) 577 { 578 struct hpi_message hm; 579 struct hpi_response hr; 580 581 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM, 582 HPI_SUBSYS_DRIVER_UNLOAD); 583 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL); 584 } 585