1 /*******************************************************************************
2 AudioScience HPI driver
3 Common Linux HPI ioctl and module probe/remove functions
5 Copyright (C) 1997-2014 AudioScience Inc. <support@audioscience.com>
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;
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.
16 *******************************************************************************/
17 #define SOURCEFILE_NAME "hpioctl.c"
19 #include "hpi_internal.h"
20 #include "hpi_version.h"
21 #include "hpimsginit.h"
28 #include <linux/interrupt.h>
29 #include <linux/slab.h>
30 #include <linux/moduleparam.h>
31 #include <linux/uaccess.h>
32 #include <linux/pci.h>
33 #include <linux/stringify.h>
34 #include <linux/module.h>
35 #include <linux/vmalloc.h>
36 #include <linux/nospec.h>
38 #ifdef MODULE_FIRMWARE
42 static int prealloc_stream_buf;
43 module_param(prealloc_stream_buf, int, S_IRUGO);
44 MODULE_PARM_DESC(prealloc_stream_buf,
45 "Preallocate size for per-adapter stream buffer");
47 /* Allow the debug level to be changed after module load.
48 E.g. echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel
50 module_param(hpi_debug_level, int, S_IRUGO | S_IWUSR);
51 MODULE_PARM_DESC(hpi_debug_level, "debug verbosity 0..5");
53 /* List of adapters found */
54 static struct hpi_adapter adapters[HPI_MAX_ADAPTERS];
56 /* Wrapper function to HPI_Message to enable dumping of the
57 message and response types.
59 static void hpi_send_recv_f(struct hpi_message *phm, struct hpi_response *phr,
62 if ((phm->adapter_index >= HPI_MAX_ADAPTERS)
63 && (phm->object != HPI_OBJ_SUBSYSTEM))
64 phr->error = HPI_ERROR_INVALID_OBJ_INDEX;
66 hpi_send_recv_ex(phm, phr, file);
69 /* This is called from hpifunc.c functions, called by ALSA
70 * (or other kernel process) In this case there is no file descriptor
71 * available for the message cache code
73 void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr)
75 hpi_send_recv_f(phm, phr, HOWNER_KERNEL);
78 EXPORT_SYMBOL(hpi_send_recv);
79 /* for radio-asihpi */
81 int asihpi_hpi_release(struct file *file)
83 struct hpi_message hm;
84 struct hpi_response hr;
86 /* HPI_DEBUG_LOG(INFO,"hpi_release file %p, pid %d\n", file, current->pid); */
87 /* close the subsystem just in case the application forgot to. */
88 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
90 hpi_send_recv_ex(&hm, &hr, file);
94 long asihpi_hpi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
96 struct hpi_ioctl_linux __user *phpi_ioctl_data;
99 union hpi_message_buffer_v1 *hm;
100 union hpi_response_buffer_v1 *hr;
105 if (cmd != HPI_IOCTL_LINUX)
108 hm = kmalloc(sizeof(*hm), GFP_KERNEL);
109 hr = kmalloc(sizeof(*hr), GFP_KERNEL);
115 phpi_ioctl_data = (struct hpi_ioctl_linux __user *)arg;
117 /* Read the message and response pointers from user space. */
118 if (get_user(puhm, &phpi_ioctl_data->phm)
119 || get_user(puhr, &phpi_ioctl_data->phr)) {
124 /* Now read the message size and data from user space. */
125 if (get_user(hm->h.size, (u16 __user *)puhm)) {
129 if (hm->h.size > sizeof(*hm))
130 hm->h.size = sizeof(*hm);
132 /* printk(KERN_INFO "message size %d\n", hm->h.wSize); */
134 uncopied_bytes = copy_from_user(hm, puhm, hm->h.size);
135 if (uncopied_bytes) {
136 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
141 if (get_user(res_max_size, (u16 __user *)puhr)) {
145 /* printk(KERN_INFO "user response size %d\n", res_max_size); */
146 if (res_max_size < sizeof(struct hpi_response_header)) {
147 HPI_DEBUG_LOG(WARNING, "small res size %d\n", res_max_size);
152 res_max_size = min_t(size_t, res_max_size, sizeof(*hr));
154 switch (hm->h.function) {
155 case HPI_SUBSYS_CREATE_ADAPTER:
156 case HPI_ADAPTER_DELETE:
157 /* Application must not use these functions! */
158 hr->h.size = sizeof(hr->h);
159 hr->h.error = HPI_ERROR_INVALID_OPERATION;
160 hr->h.function = hm->h.function;
161 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
169 hr->h.size = res_max_size;
170 if (hm->h.object == HPI_OBJ_SUBSYSTEM) {
171 hpi_send_recv_f(&hm->m0, &hr->r0, file);
173 u16 __user *ptr = NULL;
175 /* -1=no data 0=read from user mem, 1=write to user mem */
177 struct hpi_adapter *pa = NULL;
179 if (hm->h.adapter_index < ARRAY_SIZE(adapters))
180 pa = &adapters[array_index_nospec(hm->h.adapter_index,
181 ARRAY_SIZE(adapters))];
183 if (!pa || !pa->adapter || !pa->adapter->type) {
184 hpi_init_response(&hr->r0, hm->h.object,
185 hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER);
188 copy_to_user(puhr, hr, sizeof(hr->h));
196 if (mutex_lock_interruptible(&pa->mutex)) {
201 /* Dig out any pointers embedded in the message. */
202 switch (hm->h.function) {
203 case HPI_OSTREAM_WRITE:
204 case HPI_ISTREAM_READ:{
205 /* Yes, sparse, this is correct. */
206 ptr = (u16 __user *)hm->m0.u.d.u.data.pb_data;
207 size = hm->m0.u.d.u.data.data_size;
209 /* Allocate buffer according to application request.
210 ?Is it better to alloc/free for the duration
213 if (pa->buffer_size < size) {
215 "Realloc adapter %d stream "
216 "buffer from %zd to %d\n",
218 pa->buffer_size, size);
223 pa->p_buffer = vmalloc(size);
225 pa->buffer_size = size;
228 "HPI could not allocate "
229 "stream buffer size %d\n",
232 mutex_unlock(&pa->mutex);
238 hm->m0.u.d.u.data.pb_data = pa->p_buffer;
239 if (hm->h.function == HPI_ISTREAM_READ)
240 /* from card, WRITE to user mem */
252 if (size && (wrflag == 0)) {
254 copy_from_user(pa->p_buffer, ptr, size);
256 HPI_DEBUG_LOG(WARNING,
258 "bytes from user\n", uncopied_bytes,
262 hpi_send_recv_f(&hm->m0, &hr->r0, file);
264 if (size && (wrflag == 1)) {
266 copy_to_user(ptr, pa->p_buffer, size);
268 HPI_DEBUG_LOG(WARNING,
269 "Missed %d of %d " "bytes to user\n",
270 uncopied_bytes, size);
273 mutex_unlock(&pa->mutex);
276 /* on return response size must be set */
277 /*printk(KERN_INFO "response size %d\n", hr->h.wSize); */
280 HPI_DEBUG_LOG(ERROR, "response zero size\n");
285 if (hr->h.size > res_max_size) {
286 HPI_DEBUG_LOG(ERROR, "response too big %d %d\n", hr->h.size,
288 hr->h.error = HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL;
289 hr->h.specific_error = hr->h.size;
290 hr->h.size = sizeof(hr->h);
293 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
294 if (uncopied_bytes) {
295 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
306 static int asihpi_irq_count;
308 static irqreturn_t asihpi_isr(int irq, void *dev_id)
310 struct hpi_adapter *a = dev_id;
313 if (!a->adapter->irq_query_and_clear) {
314 pr_err("asihpi_isr ASI%04X:%d no handler\n", a->adapter->type,
319 handled = a->adapter->irq_query_and_clear(a->adapter, 0);
325 /* printk(KERN_INFO "asihpi_isr %d ASI%04X:%d irq handled\n",
326 asihpi_irq_count, a->adapter->type, a->adapter->index); */
328 if (a->interrupt_callback)
329 a->interrupt_callback(a);
334 int asihpi_adapter_probe(struct pci_dev *pci_dev,
335 const struct pci_device_id *pci_id)
337 int idx, nm, low_latency_mode = 0, irq_supported = 0;
340 struct hpi_message hm;
341 struct hpi_response hr;
342 struct hpi_adapter adapter;
343 struct hpi_pci pci = { 0 };
345 memset(&adapter, 0, sizeof(adapter));
347 dev_printk(KERN_DEBUG, &pci_dev->dev,
348 "probe %04x:%04x,%04x:%04x,%04x\n", pci_dev->vendor,
349 pci_dev->device, pci_dev->subsystem_vendor,
350 pci_dev->subsystem_device, pci_dev->devfn);
352 if (pci_enable_device(pci_dev) < 0) {
353 dev_err(&pci_dev->dev,
354 "pci_enable_device failed, disabling device\n");
358 pci_set_master(pci_dev); /* also sets latency timer if < 16 */
360 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
361 HPI_SUBSYS_CREATE_ADAPTER);
362 hpi_init_response(&hr, HPI_OBJ_SUBSYSTEM, HPI_SUBSYS_CREATE_ADAPTER,
363 HPI_ERROR_PROCESSING_MESSAGE);
365 hm.adapter_index = HPI_ADAPTER_INDEX_INVALID;
367 nm = HPI_MAX_ADAPTER_MEM_SPACES;
369 for (idx = 0; idx < nm; idx++) {
370 HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx,
371 &pci_dev->resource[idx]);
373 if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) {
374 memlen = pci_resource_len(pci_dev, idx);
375 pci.ap_mem_base[idx] =
376 ioremap(pci_resource_start(pci_dev, idx),
378 if (!pci.ap_mem_base[idx]) {
380 "ioremap failed, aborting\n");
381 /* unmap previously mapped pci mem space */
387 pci.pci_dev = pci_dev;
388 hm.u.s.resource.bus_type = HPI_BUS_PCI;
389 hm.u.s.resource.r.pci = &pci;
391 /* call CreateAdapterObject on the relevant hpi module */
392 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
396 adapter_index = hr.u.s.adapter_index;
397 adapter.adapter = hpi_find_adapter(adapter_index);
399 if (prealloc_stream_buf) {
400 adapter.p_buffer = vmalloc(prealloc_stream_buf);
401 if (!adapter.p_buffer) {
403 "HPI could not allocate "
404 "kernel buffer size %d\n",
405 prealloc_stream_buf);
410 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
412 hm.adapter_index = adapter.adapter->index;
413 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
416 HPI_DEBUG_LOG(ERROR, "HPI_ADAPTER_OPEN failed, aborting\n");
420 /* Check if current mode == Low Latency mode */
421 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
422 HPI_ADAPTER_GET_MODE);
423 hm.adapter_index = adapter.adapter->index;
424 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
427 && hr.u.ax.mode.adapter_mode == HPI_ADAPTER_MODE_LOW_LATENCY)
428 low_latency_mode = 1;
430 dev_info(&pci_dev->dev,
431 "Adapter at index %d is not in low latency mode\n",
432 adapter.adapter->index);
434 /* Check if IRQs are supported */
435 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
436 HPI_ADAPTER_GET_PROPERTY);
437 hm.adapter_index = adapter.adapter->index;
438 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ;
439 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
440 if (hr.error || !hr.u.ax.property_get.parameter1) {
441 dev_info(&pci_dev->dev,
442 "IRQs not supported by adapter at index %d\n",
443 adapter.adapter->index);
448 /* WARNING can't init mutex in 'adapter'
449 * and then copy it to adapters[] ?!?!
451 adapters[adapter_index] = adapter;
452 mutex_init(&adapters[adapter_index].mutex);
453 pci_set_drvdata(pci_dev, &adapters[adapter_index]);
455 if (low_latency_mode && irq_supported) {
456 if (!adapter.adapter->irq_query_and_clear) {
457 dev_err(&pci_dev->dev,
458 "no IRQ handler for adapter %d, aborting\n",
459 adapter.adapter->index);
463 /* Disable IRQ generation on DSP side by setting the rate to 0 */
464 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
465 HPI_ADAPTER_SET_PROPERTY);
466 hm.adapter_index = adapter.adapter->index;
467 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
468 hm.u.ax.property_set.parameter1 = 0;
469 hm.u.ax.property_set.parameter2 = 0;
470 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
473 "HPI_ADAPTER_GET_MODE failed, aborting\n");
477 /* Note: request_irq calls asihpi_isr here */
478 if (request_irq(pci_dev->irq, asihpi_isr, IRQF_SHARED,
479 "asihpi", &adapters[adapter_index])) {
480 dev_err(&pci_dev->dev, "request_irq(%d) failed\n",
485 adapters[adapter_index].interrupt_mode = 1;
487 dev_info(&pci_dev->dev, "using irq %d\n", pci_dev->irq);
488 adapters[adapter_index].irq = pci_dev->irq;
490 dev_info(&pci_dev->dev, "using polled mode\n");
493 dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n",
494 adapter.adapter->type, adapter_index);
500 if (pci.ap_mem_base[idx]) {
501 iounmap(pci.ap_mem_base[idx]);
502 pci.ap_mem_base[idx] = NULL;
506 if (adapter.p_buffer) {
507 adapter.buffer_size = 0;
508 vfree(adapter.p_buffer);
511 HPI_DEBUG_LOG(ERROR, "adapter_probe failed\n");
515 void asihpi_adapter_remove(struct pci_dev *pci_dev)
518 struct hpi_message hm;
519 struct hpi_response hr;
520 struct hpi_adapter *pa;
523 pa = pci_get_drvdata(pci_dev);
524 pci = pa->adapter->pci;
526 /* Disable IRQ generation on DSP side */
527 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
528 HPI_ADAPTER_SET_PROPERTY);
529 hm.adapter_index = pa->adapter->index;
530 hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
531 hm.u.ax.property_set.parameter1 = 0;
532 hm.u.ax.property_set.parameter2 = 0;
533 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
535 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
537 hm.adapter_index = pa->adapter->index;
538 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
540 /* unmap PCI memory space, mapped during device init. */
541 for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; ++idx)
542 iounmap(pci.ap_mem_base[idx]);
545 free_irq(pa->irq, pa);
550 dev_info(&pci_dev->dev,
551 "remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
552 pci_dev->vendor, pci_dev->device,
553 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
554 pci_dev->devfn, pa->adapter->index);
556 memset(pa, 0, sizeof(*pa));
559 void __init asihpi_init(void)
561 struct hpi_message hm;
562 struct hpi_response hr;
564 memset(adapters, 0, sizeof(adapters));
566 printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n");
568 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
569 HPI_SUBSYS_DRIVER_LOAD);
570 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
573 void asihpi_exit(void)
575 struct hpi_message hm;
576 struct hpi_response hr;
578 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
579 HPI_SUBSYS_DRIVER_UNLOAD);
580 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);