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