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
39 MODULE_FIRMWARE("asihpi/dsp5000.bin");
40 MODULE_FIRMWARE("asihpi/dsp6200.bin");
41 MODULE_FIRMWARE("asihpi/dsp6205.bin");
42 MODULE_FIRMWARE("asihpi/dsp6400.bin");
43 MODULE_FIRMWARE("asihpi/dsp6600.bin");
44 MODULE_FIRMWARE("asihpi/dsp8700.bin");
45 MODULE_FIRMWARE("asihpi/dsp8900.bin");
48 static int prealloc_stream_buf
;
49 module_param(prealloc_stream_buf
, int, S_IRUGO
);
50 MODULE_PARM_DESC(prealloc_stream_buf
,
51 "Preallocate size for per-adapter stream buffer");
53 /* Allow the debug level to be changed after module load.
54 E.g. echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel
56 module_param(hpi_debug_level
, int, S_IRUGO
| S_IWUSR
);
57 MODULE_PARM_DESC(hpi_debug_level
, "debug verbosity 0..5");
59 /* List of adapters found */
60 static struct hpi_adapter adapters
[HPI_MAX_ADAPTERS
];
62 /* Wrapper function to HPI_Message to enable dumping of the
63 message and response types.
65 static void hpi_send_recv_f(struct hpi_message
*phm
, struct hpi_response
*phr
,
68 if ((phm
->adapter_index
>= HPI_MAX_ADAPTERS
)
69 && (phm
->object
!= HPI_OBJ_SUBSYSTEM
))
70 phr
->error
= HPI_ERROR_INVALID_OBJ_INDEX
;
72 hpi_send_recv_ex(phm
, phr
, file
);
75 /* This is called from hpifunc.c functions, called by ALSA
76 * (or other kernel process) In this case there is no file descriptor
77 * available for the message cache code
79 void hpi_send_recv(struct hpi_message
*phm
, struct hpi_response
*phr
)
81 hpi_send_recv_f(phm
, phr
, HOWNER_KERNEL
);
84 EXPORT_SYMBOL(hpi_send_recv
);
85 /* for radio-asihpi */
87 int asihpi_hpi_release(struct file
*file
)
89 struct hpi_message hm
;
90 struct hpi_response hr
;
92 /* HPI_DEBUG_LOG(INFO,"hpi_release file %p, pid %d\n", file, current->pid); */
93 /* close the subsystem just in case the application forgot to. */
94 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_SUBSYSTEM
,
96 hpi_send_recv_ex(&hm
, &hr
, file
);
100 long asihpi_hpi_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
102 struct hpi_ioctl_linux __user
*phpi_ioctl_data
;
105 union hpi_message_buffer_v1
*hm
;
106 union hpi_response_buffer_v1
*hr
;
111 if (cmd
!= HPI_IOCTL_LINUX
)
114 hm
= kmalloc(sizeof(*hm
), GFP_KERNEL
);
115 hr
= kzalloc(sizeof(*hr
), GFP_KERNEL
);
121 phpi_ioctl_data
= (struct hpi_ioctl_linux __user
*)arg
;
123 /* Read the message and response pointers from user space. */
124 if (get_user(puhm
, &phpi_ioctl_data
->phm
)
125 || get_user(puhr
, &phpi_ioctl_data
->phr
)) {
130 /* Now read the message size and data from user space. */
131 if (get_user(hm
->h
.size
, (u16 __user
*)puhm
)) {
135 if (hm
->h
.size
> sizeof(*hm
))
136 hm
->h
.size
= sizeof(*hm
);
138 /* printk(KERN_INFO "message size %d\n", hm->h.wSize); */
140 uncopied_bytes
= copy_from_user(hm
, puhm
, hm
->h
.size
);
141 if (uncopied_bytes
) {
142 HPI_DEBUG_LOG(ERROR
, "uncopied bytes %d\n", uncopied_bytes
);
147 if (get_user(res_max_size
, (u16 __user
*)puhr
)) {
151 /* printk(KERN_INFO "user response size %d\n", res_max_size); */
152 if (res_max_size
< sizeof(struct hpi_response_header
)) {
153 HPI_DEBUG_LOG(WARNING
, "small res size %d\n", res_max_size
);
158 res_max_size
= min_t(size_t, res_max_size
, sizeof(*hr
));
160 switch (hm
->h
.function
) {
161 case HPI_SUBSYS_CREATE_ADAPTER
:
162 case HPI_ADAPTER_DELETE
:
163 /* Application must not use these functions! */
164 hr
->h
.size
= sizeof(hr
->h
);
165 hr
->h
.error
= HPI_ERROR_INVALID_OPERATION
;
166 hr
->h
.function
= hm
->h
.function
;
167 uncopied_bytes
= copy_to_user(puhr
, hr
, hr
->h
.size
);
175 hr
->h
.size
= res_max_size
;
176 if (hm
->h
.object
== HPI_OBJ_SUBSYSTEM
) {
177 hpi_send_recv_f(&hm
->m0
, &hr
->r0
, file
);
179 u16 __user
*ptr
= NULL
;
181 /* -1=no data 0=read from user mem, 1=write to user mem */
183 struct hpi_adapter
*pa
= NULL
;
185 if (hm
->h
.adapter_index
< ARRAY_SIZE(adapters
))
186 pa
= &adapters
[array_index_nospec(hm
->h
.adapter_index
,
187 ARRAY_SIZE(adapters
))];
189 if (!pa
|| !pa
->adapter
|| !pa
->adapter
->type
) {
190 hpi_init_response(&hr
->r0
, hm
->h
.object
,
191 hm
->h
.function
, HPI_ERROR_BAD_ADAPTER_NUMBER
);
194 copy_to_user(puhr
, hr
, sizeof(hr
->h
));
202 if (mutex_lock_interruptible(&pa
->mutex
)) {
207 /* Dig out any pointers embedded in the message. */
208 switch (hm
->h
.function
) {
209 case HPI_OSTREAM_WRITE
:
210 case HPI_ISTREAM_READ
:{
211 /* Yes, sparse, this is correct. */
212 ptr
= (u16 __user
*)hm
->m0
.u
.d
.u
.data
.pb_data
;
213 size
= hm
->m0
.u
.d
.u
.data
.data_size
;
215 /* Allocate buffer according to application request.
216 ?Is it better to alloc/free for the duration
219 if (pa
->buffer_size
< size
) {
221 "Realloc adapter %d stream "
222 "buffer from %zd to %d\n",
224 pa
->buffer_size
, size
);
229 pa
->p_buffer
= vmalloc(size
);
231 pa
->buffer_size
= size
;
234 "HPI could not allocate "
235 "stream buffer size %d\n",
238 mutex_unlock(&pa
->mutex
);
244 hm
->m0
.u
.d
.u
.data
.pb_data
= pa
->p_buffer
;
245 if (hm
->h
.function
== HPI_ISTREAM_READ
)
246 /* from card, WRITE to user mem */
258 if (size
&& (wrflag
== 0)) {
260 copy_from_user(pa
->p_buffer
, ptr
, size
);
262 HPI_DEBUG_LOG(WARNING
,
264 "bytes from user\n", uncopied_bytes
,
268 hpi_send_recv_f(&hm
->m0
, &hr
->r0
, file
);
270 if (size
&& (wrflag
== 1)) {
272 copy_to_user(ptr
, pa
->p_buffer
, size
);
274 HPI_DEBUG_LOG(WARNING
,
275 "Missed %d of %d " "bytes to user\n",
276 uncopied_bytes
, size
);
279 mutex_unlock(&pa
->mutex
);
282 /* on return response size must be set */
283 /*printk(KERN_INFO "response size %d\n", hr->h.wSize); */
286 HPI_DEBUG_LOG(ERROR
, "response zero size\n");
291 if (hr
->h
.size
> res_max_size
) {
292 HPI_DEBUG_LOG(ERROR
, "response too big %d %d\n", hr
->h
.size
,
294 hr
->h
.error
= HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL
;
295 hr
->h
.specific_error
= hr
->h
.size
;
296 hr
->h
.size
= sizeof(hr
->h
);
299 uncopied_bytes
= copy_to_user(puhr
, hr
, hr
->h
.size
);
300 if (uncopied_bytes
) {
301 HPI_DEBUG_LOG(ERROR
, "uncopied bytes %d\n", uncopied_bytes
);
312 static int asihpi_irq_count
;
314 static irqreturn_t
asihpi_isr(int irq
, void *dev_id
)
316 struct hpi_adapter
*a
= dev_id
;
319 if (!a
->adapter
->irq_query_and_clear
) {
320 pr_err("asihpi_isr ASI%04X:%d no handler\n", a
->adapter
->type
,
325 handled
= a
->adapter
->irq_query_and_clear(a
->adapter
, 0);
331 /* printk(KERN_INFO "asihpi_isr %d ASI%04X:%d irq handled\n",
332 asihpi_irq_count, a->adapter->type, a->adapter->index); */
334 if (a
->interrupt_callback
)
335 a
->interrupt_callback(a
);
340 int asihpi_adapter_probe(struct pci_dev
*pci_dev
,
341 const struct pci_device_id
*pci_id
)
343 int idx
, nm
, low_latency_mode
= 0, irq_supported
= 0;
346 struct hpi_message hm
;
347 struct hpi_response hr
;
348 struct hpi_adapter adapter
;
351 memset(&adapter
, 0, sizeof(adapter
));
353 dev_printk(KERN_DEBUG
, &pci_dev
->dev
,
354 "probe %04x:%04x,%04x:%04x,%04x\n", pci_dev
->vendor
,
355 pci_dev
->device
, pci_dev
->subsystem_vendor
,
356 pci_dev
->subsystem_device
, pci_dev
->devfn
);
358 if (pci_enable_device(pci_dev
) < 0) {
359 dev_err(&pci_dev
->dev
,
360 "pci_enable_device failed, disabling device\n");
364 pci_set_master(pci_dev
); /* also sets latency timer if < 16 */
366 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_SUBSYSTEM
,
367 HPI_SUBSYS_CREATE_ADAPTER
);
368 hpi_init_response(&hr
, HPI_OBJ_SUBSYSTEM
, HPI_SUBSYS_CREATE_ADAPTER
,
369 HPI_ERROR_PROCESSING_MESSAGE
);
371 hm
.adapter_index
= HPI_ADAPTER_INDEX_INVALID
;
373 nm
= HPI_MAX_ADAPTER_MEM_SPACES
;
375 for (idx
= 0; idx
< nm
; idx
++) {
376 HPI_DEBUG_LOG(INFO
, "resource %d %pR\n", idx
,
377 &pci_dev
->resource
[idx
]);
379 if (pci_resource_flags(pci_dev
, idx
) & IORESOURCE_MEM
) {
380 memlen
= pci_resource_len(pci_dev
, idx
);
381 pci
.ap_mem_base
[idx
] =
382 ioremap(pci_resource_start(pci_dev
, idx
),
384 if (!pci
.ap_mem_base
[idx
]) {
386 "ioremap failed, aborting\n");
387 /* unmap previously mapped pci mem space */
393 pci
.pci_dev
= pci_dev
;
394 hm
.u
.s
.resource
.bus_type
= HPI_BUS_PCI
;
395 hm
.u
.s
.resource
.r
.pci
= &pci
;
397 /* call CreateAdapterObject on the relevant hpi module */
398 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
402 adapter_index
= hr
.u
.s
.adapter_index
;
403 adapter
.adapter
= hpi_find_adapter(adapter_index
);
405 if (prealloc_stream_buf
) {
406 adapter
.p_buffer
= vmalloc(prealloc_stream_buf
);
407 if (!adapter
.p_buffer
) {
409 "HPI could not allocate "
410 "kernel buffer size %d\n",
411 prealloc_stream_buf
);
416 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
418 hm
.adapter_index
= adapter
.adapter
->index
;
419 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
422 HPI_DEBUG_LOG(ERROR
, "HPI_ADAPTER_OPEN failed, aborting\n");
426 /* Check if current mode == Low Latency mode */
427 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
428 HPI_ADAPTER_GET_MODE
);
429 hm
.adapter_index
= adapter
.adapter
->index
;
430 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
433 && hr
.u
.ax
.mode
.adapter_mode
== HPI_ADAPTER_MODE_LOW_LATENCY
)
434 low_latency_mode
= 1;
436 dev_info(&pci_dev
->dev
,
437 "Adapter at index %d is not in low latency mode\n",
438 adapter
.adapter
->index
);
440 /* Check if IRQs are supported */
441 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
442 HPI_ADAPTER_GET_PROPERTY
);
443 hm
.adapter_index
= adapter
.adapter
->index
;
444 hm
.u
.ax
.property_set
.property
= HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ
;
445 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
446 if (hr
.error
|| !hr
.u
.ax
.property_get
.parameter1
) {
447 dev_info(&pci_dev
->dev
,
448 "IRQs not supported by adapter at index %d\n",
449 adapter
.adapter
->index
);
454 /* WARNING can't init mutex in 'adapter'
455 * and then copy it to adapters[] ?!?!
457 adapters
[adapter_index
] = adapter
;
458 mutex_init(&adapters
[adapter_index
].mutex
);
459 pci_set_drvdata(pci_dev
, &adapters
[adapter_index
]);
461 if (low_latency_mode
&& irq_supported
) {
462 if (!adapter
.adapter
->irq_query_and_clear
) {
463 dev_err(&pci_dev
->dev
,
464 "no IRQ handler for adapter %d, aborting\n",
465 adapter
.adapter
->index
);
469 /* Disable IRQ generation on DSP side by setting the rate to 0 */
470 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
471 HPI_ADAPTER_SET_PROPERTY
);
472 hm
.adapter_index
= adapter
.adapter
->index
;
473 hm
.u
.ax
.property_set
.property
= HPI_ADAPTER_PROPERTY_IRQ_RATE
;
474 hm
.u
.ax
.property_set
.parameter1
= 0;
475 hm
.u
.ax
.property_set
.parameter2
= 0;
476 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
479 "HPI_ADAPTER_GET_MODE failed, aborting\n");
483 /* Note: request_irq calls asihpi_isr here */
484 if (request_irq(pci_dev
->irq
, asihpi_isr
, IRQF_SHARED
,
485 "asihpi", &adapters
[adapter_index
])) {
486 dev_err(&pci_dev
->dev
, "request_irq(%d) failed\n",
491 adapters
[adapter_index
].interrupt_mode
= 1;
493 dev_info(&pci_dev
->dev
, "using irq %d\n", pci_dev
->irq
);
494 adapters
[adapter_index
].irq
= pci_dev
->irq
;
496 dev_info(&pci_dev
->dev
, "using polled mode\n");
499 dev_info(&pci_dev
->dev
, "probe succeeded for ASI%04X HPI index %d\n",
500 adapter
.adapter
->type
, adapter_index
);
505 for (idx
= 0; idx
< HPI_MAX_ADAPTER_MEM_SPACES
; idx
++) {
506 if (pci
.ap_mem_base
[idx
]) {
507 iounmap(pci
.ap_mem_base
[idx
]);
508 pci
.ap_mem_base
[idx
] = NULL
;
512 if (adapter
.p_buffer
) {
513 adapter
.buffer_size
= 0;
514 vfree(adapter
.p_buffer
);
517 HPI_DEBUG_LOG(ERROR
, "adapter_probe failed\n");
521 void asihpi_adapter_remove(struct pci_dev
*pci_dev
)
524 struct hpi_message hm
;
525 struct hpi_response hr
;
526 struct hpi_adapter
*pa
;
529 pa
= pci_get_drvdata(pci_dev
);
530 pci
= pa
->adapter
->pci
;
532 /* Disable IRQ generation on DSP side */
533 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
534 HPI_ADAPTER_SET_PROPERTY
);
535 hm
.adapter_index
= pa
->adapter
->index
;
536 hm
.u
.ax
.property_set
.property
= HPI_ADAPTER_PROPERTY_IRQ_RATE
;
537 hm
.u
.ax
.property_set
.parameter1
= 0;
538 hm
.u
.ax
.property_set
.parameter2
= 0;
539 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
541 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_ADAPTER
,
543 hm
.adapter_index
= pa
->adapter
->index
;
544 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
546 /* unmap PCI memory space, mapped during device init. */
547 for (idx
= 0; idx
< HPI_MAX_ADAPTER_MEM_SPACES
; ++idx
)
548 iounmap(pci
.ap_mem_base
[idx
]);
551 free_irq(pa
->irq
, pa
);
556 dev_info(&pci_dev
->dev
,
557 "remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
558 pci_dev
->vendor
, pci_dev
->device
,
559 pci_dev
->subsystem_vendor
, pci_dev
->subsystem_device
,
560 pci_dev
->devfn
, pa
->adapter
->index
);
562 memset(pa
, 0, sizeof(*pa
));
565 void __init
asihpi_init(void)
567 struct hpi_message hm
;
568 struct hpi_response hr
;
570 memset(adapters
, 0, sizeof(adapters
));
572 printk(KERN_INFO
"ASIHPI driver " HPI_VER_STRING
"\n");
574 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_SUBSYSTEM
,
575 HPI_SUBSYS_DRIVER_LOAD
);
576 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);
579 void asihpi_exit(void)
581 struct hpi_message hm
;
582 struct hpi_response hr
;
584 hpi_init_message_response(&hm
, &hr
, HPI_OBJ_SUBSYSTEM
,
585 HPI_SUBSYS_DRIVER_UNLOAD
);
586 hpi_send_recv_ex(&hm
, &hr
, HOWNER_KERNEL
);