1 /*******************************************************************************
3 AudioScience HPI driver
4 Copyright (C) 1997-2011 AudioScience Inc. <support@audioscience.com>
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;
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.
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
19 Common Linux HPI ioctl and module probe/remove functions
20 *******************************************************************************/
21 #define SOURCEFILE_NAME "hpioctl.c"
23 #include "hpi_internal.h"
24 #include "hpi_version.h"
25 #include "hpimsginit.h"
32 #include <linux/slab.h>
33 #include <linux/moduleparam.h>
34 #include <asm/uaccess.h>
35 #include <linux/pci.h>
36 #include <linux/stringify.h>
37 #include <linux/module.h>
39 #ifdef MODULE_FIRMWARE
40 MODULE_FIRMWARE("asihpi/dsp5000.bin");
41 MODULE_FIRMWARE("asihpi/dsp6200.bin");
42 MODULE_FIRMWARE("asihpi/dsp6205.bin");
43 MODULE_FIRMWARE("asihpi/dsp6400.bin");
44 MODULE_FIRMWARE("asihpi/dsp6600.bin");
45 MODULE_FIRMWARE("asihpi/dsp8700.bin");
46 MODULE_FIRMWARE("asihpi/dsp8900.bin");
49 static int prealloc_stream_buf;
50 module_param(prealloc_stream_buf, int, S_IRUGO);
51 MODULE_PARM_DESC(prealloc_stream_buf,
52 "Preallocate size for per-adapter stream buffer");
54 /* Allow the debug level to be changed after module load.
55 E.g. echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel
57 module_param(hpi_debug_level, int, S_IRUGO | S_IWUSR);
58 MODULE_PARM_DESC(hpi_debug_level, "debug verbosity 0..5");
60 /* List of adapters found */
61 static struct hpi_adapter adapters[HPI_MAX_ADAPTERS];
63 /* Wrapper function to HPI_Message to enable dumping of the
64 message and response types.
66 static void hpi_send_recv_f(struct hpi_message *phm, struct hpi_response *phr,
69 if ((phm->adapter_index >= HPI_MAX_ADAPTERS)
70 && (phm->object != HPI_OBJ_SUBSYSTEM))
71 phr->error = HPI_ERROR_INVALID_OBJ_INDEX;
73 hpi_send_recv_ex(phm, phr, file);
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
80 void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr)
82 hpi_send_recv_f(phm, phr, HOWNER_KERNEL);
85 EXPORT_SYMBOL(hpi_send_recv);
86 /* for radio-asihpi */
88 int asihpi_hpi_release(struct file *file)
90 struct hpi_message hm;
91 struct hpi_response hr;
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,
97 hpi_send_recv_ex(&hm, &hr, file);
101 long asihpi_hpi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
103 struct hpi_ioctl_linux __user *phpi_ioctl_data;
106 union hpi_message_buffer_v1 *hm;
107 union hpi_response_buffer_v1 *hr;
112 if (cmd != HPI_IOCTL_LINUX)
115 hm = kmalloc(sizeof(*hm), GFP_KERNEL);
116 hr = kmalloc(sizeof(*hr), GFP_KERNEL);
122 phpi_ioctl_data = (struct hpi_ioctl_linux __user *)arg;
124 /* Read the message and response pointers from user space. */
125 if (get_user(puhm, &phpi_ioctl_data->phm)
126 || get_user(puhr, &phpi_ioctl_data->phr)) {
131 /* Now read the message size and data from user space. */
132 if (get_user(hm->h.size, (u16 __user *)puhm)) {
136 if (hm->h.size > sizeof(*hm))
137 hm->h.size = sizeof(*hm);
139 /* printk(KERN_INFO "message size %d\n", hm->h.wSize); */
141 uncopied_bytes = copy_from_user(hm, puhm, hm->h.size);
142 if (uncopied_bytes) {
143 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
148 if (get_user(res_max_size, (u16 __user *)puhr)) {
152 /* printk(KERN_INFO "user response size %d\n", res_max_size); */
153 if (res_max_size < sizeof(struct hpi_response_header)) {
154 HPI_DEBUG_LOG(WARNING, "small res size %d\n", res_max_size);
159 switch (hm->h.function) {
160 case HPI_SUBSYS_CREATE_ADAPTER:
161 case HPI_ADAPTER_DELETE:
162 /* Application must not use these functions! */
163 hr->h.size = sizeof(hr->h);
164 hr->h.error = HPI_ERROR_INVALID_OPERATION;
165 hr->h.function = hm->h.function;
166 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
174 hr->h.size = res_max_size;
175 if (hm->h.object == HPI_OBJ_SUBSYSTEM) {
176 hpi_send_recv_f(&hm->m0, &hr->r0, file);
178 u16 __user *ptr = NULL;
180 /* -1=no data 0=read from user mem, 1=write to user mem */
182 struct hpi_adapter *pa = NULL;
184 if (hm->h.adapter_index < ARRAY_SIZE(adapters))
185 pa = &adapters[hm->h.adapter_index];
187 if (!pa || !pa->adapter || !pa->adapter->type) {
188 hpi_init_response(&hr->r0, hm->h.object,
189 hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER);
192 copy_to_user(puhr, hr, sizeof(hr->h));
200 if (mutex_lock_interruptible(&pa->mutex)) {
205 /* Dig out any pointers embedded in the message. */
206 switch (hm->h.function) {
207 case HPI_OSTREAM_WRITE:
208 case HPI_ISTREAM_READ:{
209 /* Yes, sparse, this is correct. */
210 ptr = (u16 __user *)hm->m0.u.d.u.data.pb_data;
211 size = hm->m0.u.d.u.data.data_size;
213 /* Allocate buffer according to application request.
214 ?Is it better to alloc/free for the duration
217 if (pa->buffer_size < size) {
219 "Realloc adapter %d stream "
220 "buffer from %zd to %d\n",
222 pa->buffer_size, size);
227 pa->p_buffer = vmalloc(size);
229 pa->buffer_size = size;
232 "HPI could not allocate "
233 "stream buffer size %d\n",
236 mutex_unlock(&pa->mutex);
242 hm->m0.u.d.u.data.pb_data = pa->p_buffer;
243 if (hm->h.function == HPI_ISTREAM_READ)
244 /* from card, WRITE to user mem */
256 if (size && (wrflag == 0)) {
258 copy_from_user(pa->p_buffer, ptr, size);
260 HPI_DEBUG_LOG(WARNING,
262 "bytes from user\n", uncopied_bytes,
266 hpi_send_recv_f(&hm->m0, &hr->r0, file);
268 if (size && (wrflag == 1)) {
270 copy_to_user(ptr, pa->p_buffer, size);
272 HPI_DEBUG_LOG(WARNING,
273 "Missed %d of %d " "bytes to user\n",
274 uncopied_bytes, size);
277 mutex_unlock(&pa->mutex);
280 /* on return response size must be set */
281 /*printk(KERN_INFO "response size %d\n", hr->h.wSize); */
284 HPI_DEBUG_LOG(ERROR, "response zero size\n");
289 if (hr->h.size > res_max_size) {
290 HPI_DEBUG_LOG(ERROR, "response too big %d %d\n", hr->h.size,
292 hr->h.error = HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL;
293 hr->h.specific_error = hr->h.size;
294 hr->h.size = sizeof(hr->h);
297 uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
298 if (uncopied_bytes) {
299 HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
310 int asihpi_adapter_probe(struct pci_dev *pci_dev,
311 const struct pci_device_id *pci_id)
316 struct hpi_message hm;
317 struct hpi_response hr;
318 struct hpi_adapter adapter;
321 memset(&adapter, 0, sizeof(adapter));
323 dev_printk(KERN_DEBUG, &pci_dev->dev,
324 "probe %04x:%04x,%04x:%04x,%04x\n", pci_dev->vendor,
325 pci_dev->device, pci_dev->subsystem_vendor,
326 pci_dev->subsystem_device, pci_dev->devfn);
328 if (pci_enable_device(pci_dev) < 0) {
329 dev_err(&pci_dev->dev,
330 "pci_enable_device failed, disabling device\n");
334 pci_set_master(pci_dev); /* also sets latency timer if < 16 */
336 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
337 HPI_SUBSYS_CREATE_ADAPTER);
338 hpi_init_response(&hr, HPI_OBJ_SUBSYSTEM, HPI_SUBSYS_CREATE_ADAPTER,
339 HPI_ERROR_PROCESSING_MESSAGE);
341 hm.adapter_index = HPI_ADAPTER_INDEX_INVALID;
343 nm = HPI_MAX_ADAPTER_MEM_SPACES;
345 for (idx = 0; idx < nm; idx++) {
346 HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx,
347 &pci_dev->resource[idx]);
349 if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) {
350 memlen = pci_resource_len(pci_dev, idx);
351 pci.ap_mem_base[idx] =
352 ioremap(pci_resource_start(pci_dev, idx),
354 if (!pci.ap_mem_base[idx]) {
356 "ioremap failed, aborting\n");
357 /* unmap previously mapped pci mem space */
363 pci.pci_dev = pci_dev;
364 hm.u.s.resource.bus_type = HPI_BUS_PCI;
365 hm.u.s.resource.r.pci = &pci;
367 /* call CreateAdapterObject on the relevant hpi module */
368 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
372 adapter_index = hr.u.s.adapter_index;
373 adapter.adapter = hpi_find_adapter(adapter_index);
375 if (prealloc_stream_buf) {
376 adapter.p_buffer = vmalloc(prealloc_stream_buf);
377 if (!adapter.p_buffer) {
379 "HPI could not allocate "
380 "kernel buffer size %d\n",
381 prealloc_stream_buf);
386 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
388 hm.adapter_index = adapter.adapter->index;
389 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
394 /* WARNING can't init mutex in 'adapter'
395 * and then copy it to adapters[] ?!?!
397 adapters[adapter_index] = adapter;
398 mutex_init(&adapters[adapter_index].mutex);
399 pci_set_drvdata(pci_dev, &adapters[adapter_index]);
401 dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n",
402 adapter.adapter->type, adapter_index);
407 for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
408 if (pci.ap_mem_base[idx]) {
409 iounmap(pci.ap_mem_base[idx]);
410 pci.ap_mem_base[idx] = NULL;
414 if (adapter.p_buffer) {
415 adapter.buffer_size = 0;
416 vfree(adapter.p_buffer);
419 HPI_DEBUG_LOG(ERROR, "adapter_probe failed\n");
423 void asihpi_adapter_remove(struct pci_dev *pci_dev)
426 struct hpi_message hm;
427 struct hpi_response hr;
428 struct hpi_adapter *pa;
431 pa = pci_get_drvdata(pci_dev);
432 pci = pa->adapter->pci;
434 hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
436 hm.adapter_index = pa->adapter->index;
437 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
439 /* unmap PCI memory space, mapped during device init. */
440 for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
441 if (pci.ap_mem_base[idx])
442 iounmap(pci.ap_mem_base[idx]);
448 pci_set_drvdata(pci_dev, NULL);
450 dev_info(&pci_dev->dev,
451 "remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
452 pci_dev->vendor, pci_dev->device,
453 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
454 pci_dev->devfn, pa->adapter->index);
456 memset(pa, 0, sizeof(*pa));
459 void __init asihpi_init(void)
461 struct hpi_message hm;
462 struct hpi_response hr;
464 memset(adapters, 0, sizeof(adapters));
466 printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n");
468 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
469 HPI_SUBSYS_DRIVER_LOAD);
470 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
473 void asihpi_exit(void)
475 struct hpi_message hm;
476 struct hpi_response hr;
478 hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
479 HPI_SUBSYS_DRIVER_UNLOAD);
480 hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);