[deliverable/linux.git] / sound / pci / asihpi / hpioctl.c

/*******************************************************************************
    AudioScience HPI driver
    Common Linux HPI ioctl and module probe/remove functions

    Copyright (C) 1997-2014  AudioScience Inc. <support@audioscience.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of version 2 of the GNU General Public License as
    published by the Free Software Foundation;

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

*******************************************************************************/
#define SOURCEFILE_NAME "hpioctl.c"

#include "hpi_internal.h"
#include "hpi_version.h"
#include "hpimsginit.h"
#include "hpidebug.h"
#include "hpimsgx.h"
#include "hpioctl.h"
#include "hpicmn.h"

#include <linux/fs.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/moduleparam.h>
#include <asm/uaccess.h>
#include <linux/pci.h>
#include <linux/stringify.h>
#include <linux/module.h>

#ifdef MODULE_FIRMWARE
MODULE_FIRMWARE("asihpi/dsp5000.bin");
MODULE_FIRMWARE("asihpi/dsp6200.bin");
MODULE_FIRMWARE("asihpi/dsp6205.bin");
MODULE_FIRMWARE("asihpi/dsp6400.bin");
MODULE_FIRMWARE("asihpi/dsp6600.bin");
MODULE_FIRMWARE("asihpi/dsp8700.bin");
MODULE_FIRMWARE("asihpi/dsp8900.bin");
#endif

static int prealloc_stream_buf;
module_param(prealloc_stream_buf, int, S_IRUGO);
MODULE_PARM_DESC(prealloc_stream_buf,
	"Preallocate size for per-adapter stream buffer");

/* Allow the debug level to be changed after module load.
 E.g.   echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel
*/
module_param(hpi_debug_level, int, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(hpi_debug_level, "debug verbosity 0..5");

/* List of adapters found */
static struct hpi_adapter adapters[HPI_MAX_ADAPTERS];

/* Wrapper function to HPI_Message to enable dumping of the
   message and response types.
*/
static void hpi_send_recv_f(struct hpi_message *phm, struct hpi_response *phr,
	struct file *file)
{
	if ((phm->adapter_index >= HPI_MAX_ADAPTERS)
		&& (phm->object != HPI_OBJ_SUBSYSTEM))
		phr->error = HPI_ERROR_INVALID_OBJ_INDEX;
	else
		hpi_send_recv_ex(phm, phr, file);
}

/* This is called from hpifunc.c functions, called by ALSA
 * (or other kernel process) In this case there is no file descriptor
 * available for the message cache code
 */
void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr)
{
	hpi_send_recv_f(phm, phr, HOWNER_KERNEL);
}

EXPORT_SYMBOL(hpi_send_recv);
/* for radio-asihpi */

int asihpi_hpi_release(struct file *file)
{
	struct hpi_message hm;
	struct hpi_response hr;

/* HPI_DEBUG_LOG(INFO,"hpi_release file %p, pid %d\n", file, current->pid); */
	/* close the subsystem just in case the application forgot to. */
	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
		HPI_SUBSYS_CLOSE);
	hpi_send_recv_ex(&hm, &hr, file);
	return 0;
}

long asihpi_hpi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
{
	struct hpi_ioctl_linux __user *phpi_ioctl_data;
	void __user *puhm;
	void __user *puhr;
	union hpi_message_buffer_v1 *hm;
	union hpi_response_buffer_v1 *hr;
	u16 res_max_size;
	u32 uncopied_bytes;
	int err = 0;

	if (cmd != HPI_IOCTL_LINUX)
		return -EINVAL;

	hm = kmalloc(sizeof(*hm), GFP_KERNEL);
	hr = kmalloc(sizeof(*hr), GFP_KERNEL);
	if (!hm || !hr) {
		err = -ENOMEM;
		goto out;
	}

	phpi_ioctl_data = (struct hpi_ioctl_linux __user *)arg;

	/* Read the message and response pointers from user space.  */
	if (get_user(puhm, &phpi_ioctl_data->phm)
		|| get_user(puhr, &phpi_ioctl_data->phr)) {
		err = -EFAULT;
		goto out;
	}

	/* Now read the message size and data from user space.  */
	if (get_user(hm->h.size, (u16 __user *)puhm)) {
		err = -EFAULT;
		goto out;
	}
	if (hm->h.size > sizeof(*hm))
		hm->h.size = sizeof(*hm);

	/* printk(KERN_INFO "message size %d\n", hm->h.wSize); */

	uncopied_bytes = copy_from_user(hm, puhm, hm->h.size);
	if (uncopied_bytes) {
		HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
		err = -EFAULT;
		goto out;
	}

	if (get_user(res_max_size, (u16 __user *)puhr)) {
		err = -EFAULT;
		goto out;
	}
	/* printk(KERN_INFO "user response size %d\n", res_max_size); */
	if (res_max_size < sizeof(struct hpi_response_header)) {
		HPI_DEBUG_LOG(WARNING, "small res size %d\n", res_max_size);
		err = -EFAULT;
		goto out;
	}

	switch (hm->h.function) {
	case HPI_SUBSYS_CREATE_ADAPTER:
	case HPI_ADAPTER_DELETE:
		/* Application must not use these functions! */
		hr->h.size = sizeof(hr->h);
		hr->h.error = HPI_ERROR_INVALID_OPERATION;
		hr->h.function = hm->h.function;
		uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
		if (uncopied_bytes)
			err = -EFAULT;
		else
			err = 0;
		goto out;
	}

	hr->h.size = res_max_size;
	if (hm->h.object == HPI_OBJ_SUBSYSTEM) {
		hpi_send_recv_f(&hm->m0, &hr->r0, file);
	} else {
		u16 __user *ptr = NULL;
		u32 size = 0;
		/* -1=no data 0=read from user mem, 1=write to user mem */
		int wrflag = -1;
		struct hpi_adapter *pa = NULL;

		if (hm->h.adapter_index < ARRAY_SIZE(adapters))
			pa = &adapters[hm->h.adapter_index];

		if (!pa || !pa->adapter || !pa->adapter->type) {
			hpi_init_response(&hr->r0, hm->h.object,
				hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER);

			uncopied_bytes =
				copy_to_user(puhr, hr, sizeof(hr->h));
			if (uncopied_bytes)
				err = -EFAULT;
			else
				err = 0;
			goto out;
		}

		if (mutex_lock_interruptible(&pa->mutex)) {
			err = -EINTR;
			goto out;
		}

		/* Dig out any pointers embedded in the message.  */
		switch (hm->h.function) {
		case HPI_OSTREAM_WRITE:
		case HPI_ISTREAM_READ:{
				/* Yes, sparse, this is correct. */
				ptr = (u16 __user *)hm->m0.u.d.u.data.pb_data;
				size = hm->m0.u.d.u.data.data_size;

				/* Allocate buffer according to application request.
				   ?Is it better to alloc/free for the duration
				   of the transaction?
				 */
				if (pa->buffer_size < size) {
					HPI_DEBUG_LOG(DEBUG,
						"Realloc adapter %d stream "
						"buffer from %zd to %d\n",
						hm->h.adapter_index,
						pa->buffer_size, size);
					if (pa->p_buffer) {
						pa->buffer_size = 0;
						vfree(pa->p_buffer);
					}
					pa->p_buffer = vmalloc(size);
					if (pa->p_buffer)
						pa->buffer_size = size;
					else {
						HPI_DEBUG_LOG(ERROR,
							"HPI could not allocate "
							"stream buffer size %d\n",
							size);

						mutex_unlock(&pa->mutex);
						err = -EINVAL;
						goto out;
					}
				}

				hm->m0.u.d.u.data.pb_data = pa->p_buffer;
				if (hm->h.function == HPI_ISTREAM_READ)
					/* from card, WRITE to user mem */
					wrflag = 1;
				else
					wrflag = 0;
				break;
			}

		default:
			size = 0;
			break;
		}

		if (size && (wrflag == 0)) {
			uncopied_bytes =
				copy_from_user(pa->p_buffer, ptr, size);
			if (uncopied_bytes)
				HPI_DEBUG_LOG(WARNING,
					"Missed %d of %d "
					"bytes from user\n", uncopied_bytes,
					size);
		}

		hpi_send_recv_f(&hm->m0, &hr->r0, file);

		if (size && (wrflag == 1)) {
			uncopied_bytes =
				copy_to_user(ptr, pa->p_buffer, size);
			if (uncopied_bytes)
				HPI_DEBUG_LOG(WARNING,
					"Missed %d of %d " "bytes to user\n",
					uncopied_bytes, size);
		}

		mutex_unlock(&pa->mutex);
	}

	/* on return response size must be set */
	/*printk(KERN_INFO "response size %d\n", hr->h.wSize); */

	if (!hr->h.size) {
		HPI_DEBUG_LOG(ERROR, "response zero size\n");
		err = -EFAULT;
		goto out;
	}

	if (hr->h.size > res_max_size) {
		HPI_DEBUG_LOG(ERROR, "response too big %d %d\n", hr->h.size,
			res_max_size);
		hr->h.error = HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL;
		hr->h.specific_error = hr->h.size;
		hr->h.size = sizeof(hr->h);
	}

	uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
	if (uncopied_bytes) {
		HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
		err = -EFAULT;
		goto out;
	}

out:
	kfree(hm);
	kfree(hr);
	return err;
}

static int asihpi_irq_count;

static irqreturn_t asihpi_isr(int irq, void *dev_id)
{
	struct hpi_adapter *a = dev_id;
	int handled;

	if (!a->adapter->irq_query_and_clear) {
		pr_err("asihpi_isr ASI%04X:%d no handler\n", a->adapter->type,
			a->adapter->index);
		return IRQ_NONE;
	}

	handled = a->adapter->irq_query_and_clear(a->adapter, 0);

	if (!handled)
		return IRQ_NONE;

	asihpi_irq_count++;
	/* printk(KERN_INFO "asihpi_isr %d ASI%04X:%d irq handled\n",
	   asihpi_irq_count, a->adapter->type, a->adapter->index); */

	if (a->interrupt_callback)
		a->interrupt_callback(a);

	return IRQ_HANDLED;
}

int asihpi_adapter_probe(struct pci_dev *pci_dev,
			 const struct pci_device_id *pci_id)
{
	int idx, nm, low_latency_mode = 0, irq_supported = 0;
	int adapter_index;
	unsigned int memlen;
	struct hpi_message hm;
	struct hpi_response hr;
	struct hpi_adapter adapter;
	struct hpi_pci pci;

	memset(&adapter, 0, sizeof(adapter));

	dev_printk(KERN_DEBUG, &pci_dev->dev,
		"probe %04x:%04x,%04x:%04x,%04x\n", pci_dev->vendor,
		pci_dev->device, pci_dev->subsystem_vendor,
		pci_dev->subsystem_device, pci_dev->devfn);

	if (pci_enable_device(pci_dev) < 0) {
		dev_err(&pci_dev->dev,
			"pci_enable_device failed, disabling device\n");
		return -EIO;
	}

	pci_set_master(pci_dev);	/* also sets latency timer if < 16 */

	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
		HPI_SUBSYS_CREATE_ADAPTER);
	hpi_init_response(&hr, HPI_OBJ_SUBSYSTEM, HPI_SUBSYS_CREATE_ADAPTER,
		HPI_ERROR_PROCESSING_MESSAGE);

	hm.adapter_index = HPI_ADAPTER_INDEX_INVALID;

	nm = HPI_MAX_ADAPTER_MEM_SPACES;

	for (idx = 0; idx < nm; idx++) {
		HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx,
			&pci_dev->resource[idx]);

		if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) {
			memlen = pci_resource_len(pci_dev, idx);
			pci.ap_mem_base[idx] =
				ioremap(pci_resource_start(pci_dev, idx),
				memlen);
			if (!pci.ap_mem_base[idx]) {
				HPI_DEBUG_LOG(ERROR,
					"ioremap failed, aborting\n");
				/* unmap previously mapped pci mem space */
				goto err;
			}
		}
	}

	pci.pci_dev = pci_dev;
	hm.u.s.resource.bus_type = HPI_BUS_PCI;
	hm.u.s.resource.r.pci = &pci;

	/* call CreateAdapterObject on the relevant hpi module */
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	if (hr.error)
		goto err;

	adapter_index = hr.u.s.adapter_index;
	adapter.adapter = hpi_find_adapter(adapter_index);

	if (prealloc_stream_buf) {
		adapter.p_buffer = vmalloc(prealloc_stream_buf);
		if (!adapter.p_buffer) {
			HPI_DEBUG_LOG(ERROR,
				"HPI could not allocate "
				"kernel buffer size %d\n",
				prealloc_stream_buf);
			goto err;
		}
	}

	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
		HPI_ADAPTER_OPEN);
	hm.adapter_index = adapter.adapter->index;
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);

	if (hr.error) {
		HPI_DEBUG_LOG(ERROR, "HPI_ADAPTER_OPEN failed, aborting\n");
		goto err;
	}

	/* Check if current mode == Low Latency mode */
	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
		HPI_ADAPTER_GET_MODE);
	hm.adapter_index = adapter.adapter->index;
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);

	if (!hr.error
		&& hr.u.ax.mode.adapter_mode == HPI_ADAPTER_MODE_LOW_LATENCY)
		low_latency_mode = 1;
	else
		dev_info(&pci_dev->dev,
			"Adapter at index %d is not in low latency mode\n",
			adapter.adapter->index);

	/* Check if IRQs are supported */
	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
		HPI_ADAPTER_GET_PROPERTY);
	hm.adapter_index = adapter.adapter->index;
	hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ;
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	if (hr.error || !hr.u.ax.property_get.parameter1) {
		dev_info(&pci_dev->dev,
			"IRQs not supported by adapter at index %d\n",
			adapter.adapter->index);
	} else {
		irq_supported = 1;
	}

	/* WARNING can't init mutex in 'adapter'
	 * and then copy it to adapters[] ?!?!
	 */
	adapters[adapter_index] = adapter;
	mutex_init(&adapters[adapter_index].mutex);
	pci_set_drvdata(pci_dev, &adapters[adapter_index]);

	if (low_latency_mode && irq_supported) {
		if (!adapter.adapter->irq_query_and_clear) {
			dev_err(&pci_dev->dev,
				"no IRQ handler for adapter %d, aborting\n",
				adapter.adapter->index);
			goto err;
		}

		/* Disable IRQ generation on DSP side by setting the rate to 0 */
		hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
			HPI_ADAPTER_SET_PROPERTY);
		hm.adapter_index = adapter.adapter->index;
		hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
		hm.u.ax.property_set.parameter1 = 0;
		hm.u.ax.property_set.parameter2 = 0;
		hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
		if (hr.error) {
			HPI_DEBUG_LOG(ERROR,
				"HPI_ADAPTER_GET_MODE failed, aborting\n");
			goto err;
		}

		/* Note: request_irq calls asihpi_isr here */
		if (request_irq(pci_dev->irq, asihpi_isr, IRQF_SHARED,
				"asihpi", &adapters[adapter_index])) {
			dev_err(&pci_dev->dev, "request_irq(%d) failed\n",
				pci_dev->irq);
			goto err;
		}

		adapters[adapter_index].interrupt_mode = 1;

		dev_info(&pci_dev->dev, "using irq %d\n", pci_dev->irq);
		adapters[adapter_index].irq = pci_dev->irq;
	} else {
		dev_info(&pci_dev->dev, "using polled mode\n");
	}

	dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n",
		 adapter.adapter->type, adapter_index);

	return 0;

err:
	for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
		if (pci.ap_mem_base[idx]) {
			iounmap(pci.ap_mem_base[idx]);
			pci.ap_mem_base[idx] = NULL;
		}
	}

	if (adapter.p_buffer) {
		adapter.buffer_size = 0;
		vfree(adapter.p_buffer);
	}

	HPI_DEBUG_LOG(ERROR, "adapter_probe failed\n");
	return -ENODEV;
}

void asihpi_adapter_remove(struct pci_dev *pci_dev)
{
	int idx;
	struct hpi_message hm;
	struct hpi_response hr;
	struct hpi_adapter *pa;
	struct hpi_pci pci;

	pa = pci_get_drvdata(pci_dev);
	pci = pa->adapter->pci;

	/* Disable IRQ generation on DSP side */
	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
		HPI_ADAPTER_SET_PROPERTY);
	hm.adapter_index = pa->adapter->index;
	hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
	hm.u.ax.property_set.parameter1 = 0;
	hm.u.ax.property_set.parameter2 = 0;
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);

	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
		HPI_ADAPTER_DELETE);
	hm.adapter_index = pa->adapter->index;
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);

	/* unmap PCI memory space, mapped during device init. */
	for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
		if (pci.ap_mem_base[idx])
			iounmap(pci.ap_mem_base[idx]);
	}

	if (pa->irq)
		free_irq(pa->irq, pa);

	if (pa->p_buffer)
		vfree(pa->p_buffer);

	if (1)
		dev_info(&pci_dev->dev,
			 "remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
			 pci_dev->vendor, pci_dev->device,
			 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
			 pci_dev->devfn, pa->adapter->index);

	memset(pa, 0, sizeof(*pa));
}

void __init asihpi_init(void)
{
	struct hpi_message hm;
	struct hpi_response hr;

	memset(adapters, 0, sizeof(adapters));

	printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n");

	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
		HPI_SUBSYS_DRIVER_LOAD);
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
}

void asihpi_exit(void)
{
	struct hpi_message hm;
	struct hpi_response hr;

	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
		HPI_SUBSYS_DRIVER_UNLOAD);
	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
}
Commit	Line	Data
719f82d3	1	/*******************************************************************************
719f82d3	2	AudioScience HPI driver
f9a376c3 EB	3	Common Linux HPI ioctl and module probe/remove functions
	4
	5	Copyright (C) 1997-2014 AudioScience Inc. <support@audioscience.com>
719f82d3 EB	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
719f82d3 EB	16	*******************************************************************************/
	17	#define SOURCEFILE_NAME "hpioctl.c"
	18
	19	#include "hpi_internal.h"
f6baaec2	20	#include "hpi_version.h"
719f82d3 EB	21	#include "hpimsginit.h"
	22	#include "hpidebug.h"
	23	#include "hpimsgx.h"
	24	#include "hpioctl.h"
6d0b898e	25	#include "hpicmn.h"
719f82d3 EB	26
719f82d3 EB	27	#include <linux/fs.h>
f9a376c3	28	#include <linux/interrupt.h>
719f82d3 EB	29	#include <linux/slab.h>
	30	#include <linux/moduleparam.h>
	31	#include <asm/uaccess.h>
3285ea10	32	#include <linux/pci.h>
719f82d3	33	#include <linux/stringify.h>
da155d5b	34	#include <linux/module.h>
719f82d3 EB	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,
3285ea10	49	"Preallocate size for per-adapter stream buffer");
719f82d3 EB	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	{
7036b92d	66	if ((phm->adapter_index >= HPI_MAX_ADAPTERS)
719f82d3 EB	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;
719f82d3 EB	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. */
3285ea10 EB	122	if (get_user(puhm, &phpi_ioctl_data->phm)
3285ea10 EB	123	\|\| get_user(puhr, &phpi_ioctl_data->phr)) {
ec9d04b2 KV	124	err = -EFAULT;
	125	goto out;
	126	}
719f82d3 EB	127
719f82d3 EB	128	/* Now read the message size and data from user space. */
ec9d04b2 KV	129	if (get_user(hm->h.size, (u16 __user *)puhm)) {
	130	err = -EFAULT;
	131	goto out;
	132	}
719f82d3 EB	133	if (hm->h.size > sizeof(*hm))
	134	hm->h.size = sizeof(*hm);
	135
3285ea10	136	/* printk(KERN_INFO "message size %d\n", hm->h.wSize); */
719f82d3 EB	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
ec9d04b2 KV	145	if (get_user(res_max_size, (u16 __user *)puhr)) {
	146	err = -EFAULT;
	147	goto out;
	148	}
719f82d3 EB	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
6d0b898e EB	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
3285ea10	171	hr->h.size = res_max_size;
719f82d3	172	if (hm->h.object == HPI_OBJ_SUBSYSTEM) {
6d0b898e	173	hpi_send_recv_f(&hm->m0, &hr->r0, file);
719f82d3 EB	174	} else {
	175	u16 __user *ptr = NULL;
	176	u32 size = 0;
719f82d3 EB	177	/* -1=no data 0=read from user mem, 1=write to user mem */
719f82d3 EB	178	int wrflag = -1;
7036b92d	179	struct hpi_adapter *pa = NULL;
08f984c7	180
7036b92d	181	if (hm->h.adapter_index < ARRAY_SIZE(adapters))
08f984c7	182	pa = &adapters[hm->h.adapter_index];
719f82d3	183
7036b92d	184	if (!pa \|\| !pa->adapter \|\| !pa->adapter->type) {
08f984c7 EB	185	hpi_init_response(&hr->r0, hm->h.object,
08f984c7 EB	186	hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER);
719f82d3 EB	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
767cd365	197	if (mutex_lock_interruptible(&pa->mutex)) {
719f82d3 EB	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,
3285ea10	216	"Realloc adapter %d stream "
719f82d3 EB	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
767cd365	233	mutex_unlock(&pa->mutex);
719f82d3 EB	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,
3285ea10	258	"Missed %d of %d "
719f82d3 EB	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,
3285ea10	270	"Missed %d of %d " "bytes to user\n",
719f82d3 EB	271	uncopied_bytes, size);
	272	}
	273
767cd365	274	mutex_unlock(&pa->mutex);
719f82d3 EB	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);
3285ea10 EB	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);
719f82d3 EB	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
f9a376c3 EB	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
e23e7a14 BP	335	int asihpi_adapter_probe(struct pci_dev *pci_dev,
e23e7a14 BP	336	const struct pci_device_id *pci_id)
719f82d3	337	{
f9a376c3	338	int idx, nm, low_latency_mode = 0, irq_supported = 0;
7036b92d	339	int adapter_index;
719f82d3 EB	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
3285ea10 EB	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,
719f82d3 EB	351	pci_dev->subsystem_device, pci_dev->devfn);
719f82d3 EB	352
3285ea10	353	if (pci_enable_device(pci_dev) < 0) {
4ee3bffc	354	dev_err(&pci_dev->dev,
3285ea10 EB	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
719f82d3 EB	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
3285ea10	366	hm.adapter_index = HPI_ADAPTER_INDEX_INVALID;
719f82d3	367
719f82d3 EB	368	nm = HPI_MAX_ADAPTER_MEM_SPACES;
	369
	370	for (idx = 0; idx < nm; idx++) {
42258dab EB	371	HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx,
42258dab EB	372	&pci_dev->resource[idx]);
719f82d3 EB	373
	374	if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) {
	375	memlen = pci_resource_len(pci_dev, idx);
7036b92d	376	pci.ap_mem_base[idx] =
719f82d3 EB	377	ioremap(pci_resource_start(pci_dev, idx),
719f82d3 EB	378	memlen);
7036b92d	379	if (!pci.ap_mem_base[idx]) {
719f82d3 EB	380	HPI_DEBUG_LOG(ERROR,
	381	"ioremap failed, aborting\n");
	382	/* unmap previously mapped pci mem space */
	383	goto err;
	384	}
	385	}
719f82d3 EB	386	}
719f82d3 EB	387
3285ea10	388	pci.pci_dev = pci_dev;
719f82d3 EB	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
7036b92d EB	397	adapter_index = hr.u.s.adapter_index;
	398	adapter.adapter = hpi_find_adapter(adapter_index);
	399
719f82d3 EB	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
6d0b898e EB	411	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
6d0b898e EB	412	HPI_ADAPTER_OPEN);
7036b92d	413	hm.adapter_index = adapter.adapter->index;
6d0b898e	414	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
719f82d3	415
f9a376c3 EB	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
dc612838 EB	427	if (!hr.error
dc612838 EB	428	&& hr.u.ax.mode.adapter_mode == HPI_ADAPTER_MODE_LOW_LATENCY)
f9a376c3	429	low_latency_mode = 1;
dc612838 EB	430	else
	431	dev_info(&pci_dev->dev,
	432	"Adapter at index %d is not in low latency mode\n",
	433	adapter.adapter->index);
f9a376c3 EB	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	}
719f82d3	448
719f82d3 EB	449	/* WARNING can't init mutex in 'adapter'
	450	* and then copy it to adapters[] ?!?!
	451	*/
7036b92d EB	452	adapters[adapter_index] = adapter;
	453	mutex_init(&adapters[adapter_index].mutex);
	454	pci_set_drvdata(pci_dev, &adapters[adapter_index]);
719f82d3	455
f9a376c3 EB	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
4ee3bffc JP	494	dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n",
4ee3bffc JP	495	adapter.adapter->type, adapter_index);
719f82d3 EB	496
	497	return 0;
	498
	499	err:
	500	for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
7036b92d EB	501	if (pci.ap_mem_base[idx]) {
	502	iounmap(pci.ap_mem_base[idx]);
	503	pci.ap_mem_base[idx] = NULL;
719f82d3 EB	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
e23e7a14	516	void asihpi_adapter_remove(struct pci_dev *pci_dev)
719f82d3 EB	517	{
	518	int idx;
	519	struct hpi_message hm;
	520	struct hpi_response hr;
	521	struct hpi_adapter *pa;
7036b92d EB	522	struct hpi_pci pci;
7036b92d EB	523
5dbea6b1	524	pa = pci_get_drvdata(pci_dev);
7036b92d	525	pci = pa->adapter->pci;
719f82d3	526
f9a376c3 EB	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
6d0b898e EB	536	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
6d0b898e EB	537	HPI_ADAPTER_DELETE);
7036b92d	538	hm.adapter_index = pa->adapter->index;
719f82d3 EB	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++) {
7036b92d EB	543	if (pci.ap_mem_base[idx])
7036b92d EB	544	iounmap(pci.ap_mem_base[idx]);
719f82d3 EB	545	}
719f82d3 EB	546
f9a376c3 EB	547	if (pa->irq)
	548	free_irq(pa->irq, pa);
	549
c188dec3	550	if (pa->p_buffer)
719f82d3	551	vfree(pa->p_buffer);
719f82d3	552
3285ea10	553	if (1)
4ee3bffc JP	554	dev_info(&pci_dev->dev,
	555	"remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
	556	pci_dev->vendor, pci_dev->device,
	557	pci_dev->subsystem_vendor, pci_dev->subsystem_device,
	558	pci_dev->devfn, pa->adapter->index);
c188dec3 EB	559
c188dec3 EB	560	memset(pa, 0, sizeof(*pa));
719f82d3 EB	561	}
	562
	563	void __init asihpi_init(void)
	564	{
	565	struct hpi_message hm;
	566	struct hpi_response hr;
	567
	568	memset(adapters, 0, sizeof(adapters));
	569
1dd6aaaa	570	printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n");
719f82d3 EB	571
	572	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
	573	HPI_SUBSYS_DRIVER_LOAD);
	574	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	575	}
	576
	577	void asihpi_exit(void)
	578	{
	579	struct hpi_message hm;
	580	struct hpi_response hr;
	581
	582	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
	583	HPI_SUBSYS_DRIVER_UNLOAD);
	584	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	585	}