[linux-2.6-block.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 <linux/uaccess.h>
#include <linux/pci.h>
#include <linux/stringify.h>
#include <linux/module.h>
#include <linux/vmalloc.h>
#include <linux/nospec.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, 0444);
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, 0644);
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 msg_size;
	u16 res_max_size;
	u32 uncopied_bytes;
	int err = 0;

	if (cmd != HPI_IOCTL_LINUX)
		return -EINVAL;

	hm = kmalloc(sizeof(*hm), GFP_KERNEL);
	hr = kzalloc(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(msg_size, (u16 __user *)puhm)) {
		err = -EFAULT;
		goto out;
	}
	if (msg_size > sizeof(*hm))
		msg_size = sizeof(*hm);

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

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

	/* Override h.size in case it is changed between two userspace fetches */
	hm->h.size = msg_size;

	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;
	}

	res_max_size = min_t(size_t, res_max_size, sizeof(*hr));

	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[array_index_nospec(hm->h.adapter_index,
							  ARRAY_SIZE(adapters))];

		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)
		iounmap(pci.ap_mem_base[idx]);

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

	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>
719f82d3 EB	30	#include <linux/moduleparam.h>
976412fb	31	#include <linux/uaccess.h>
3285ea10	32	#include <linux/pci.h>
719f82d3	33	#include <linux/stringify.h>
da155d5b	34	#include <linux/module.h>
d6472302	35	#include <linux/vmalloc.h>
f9d94b57	36	#include <linux/nospec.h>
719f82d3 EB	37
	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");
	46	#endif
	47
	48	static int prealloc_stream_buf;
6a73cf46	49	module_param(prealloc_stream_buf, int, 0444);
719f82d3	50	MODULE_PARM_DESC(prealloc_stream_buf,
3285ea10	51	"Preallocate size for per-adapter stream buffer");
719f82d3 EB	52
	53	/* Allow the debug level to be changed after module load.
	54	E.g. echo 2 > /sys/module/asihpi/parameters/hpiDebugLevel
	55	*/
6a73cf46	56	module_param(hpi_debug_level, int, 0644);
719f82d3 EB	57	MODULE_PARM_DESC(hpi_debug_level, "debug verbosity 0..5");
	58
	59	/* List of adapters found */
	60	static struct hpi_adapter adapters[HPI_MAX_ADAPTERS];
	61
	62	/* Wrapper function to HPI_Message to enable dumping of the
	63	message and response types.
	64	*/
	65	static void hpi_send_recv_f(struct hpi_message phm, struct hpi_response phr,
	66	struct file *file)
	67	{
7036b92d	68	if ((phm->adapter_index >= HPI_MAX_ADAPTERS)
719f82d3 EB	69	&& (phm->object != HPI_OBJ_SUBSYSTEM))
	70	phr->error = HPI_ERROR_INVALID_OBJ_INDEX;
	71	else
	72	hpi_send_recv_ex(phm, phr, file);
	73	}
	74
	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
	78	*/
	79	void hpi_send_recv(struct hpi_message phm, struct hpi_response phr)
	80	{
	81	hpi_send_recv_f(phm, phr, HOWNER_KERNEL);
	82	}
	83
	84	EXPORT_SYMBOL(hpi_send_recv);
	85	/* for radio-asihpi */
	86
	87	int asihpi_hpi_release(struct file *file)
	88	{
	89	struct hpi_message hm;
	90	struct hpi_response hr;
	91
	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,
	95	HPI_SUBSYS_CLOSE);
	96	hpi_send_recv_ex(&hm, &hr, file);
	97	return 0;
	98	}
	99
	100	long asihpi_hpi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
	101	{
	102	struct hpi_ioctl_linux __user *phpi_ioctl_data;
	103	void __user *puhm;
	104	void __user *puhr;
	105	union hpi_message_buffer_v1 *hm;
	106	union hpi_response_buffer_v1 *hr;
e1af344d	107	u16 msg_size;
719f82d3 EB	108	u16 res_max_size;
719f82d3 EB	109	u32 uncopied_bytes;
719f82d3 EB	110	int err = 0;
	111
	112	if (cmd != HPI_IOCTL_LINUX)
	113	return -EINVAL;
	114
	115	hm = kmalloc(sizeof(*hm), GFP_KERNEL);
d69bb92e	116	hr = kzalloc(sizeof(*hr), GFP_KERNEL);
719f82d3 EB	117	if (!hm \|\| !hr) {
	118	err = -ENOMEM;
	119	goto out;
	120	}
	121
	122	phpi_ioctl_data = (struct hpi_ioctl_linux __user *)arg;
	123
	124	/* Read the message and response pointers from user space. */
3285ea10 EB	125	if (get_user(puhm, &phpi_ioctl_data->phm)
3285ea10 EB	126	\|\| get_user(puhr, &phpi_ioctl_data->phr)) {
ec9d04b2 KV	127	err = -EFAULT;
	128	goto out;
	129	}
719f82d3 EB	130
719f82d3 EB	131	/* Now read the message size and data from user space. */
e1af344d	132	if (get_user(msg_size, (u16 __user *)puhm)) {
ec9d04b2 KV	133	err = -EFAULT;
	134	goto out;
	135	}
e1af344d MX	136	if (msg_size > sizeof(*hm))
e1af344d MX	137	msg_size = sizeof(*hm);
719f82d3	138
3285ea10	139	/* printk(KERN_INFO "message size %d\n", hm->h.wSize); */
719f82d3	140
e1af344d	141	uncopied_bytes = copy_from_user(hm, puhm, msg_size);
719f82d3 EB	142	if (uncopied_bytes) {
	143	HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
	144	err = -EFAULT;
	145	goto out;
	146	}
	147
e1af344d MX	148	/* Override h.size in case it is changed between two userspace fetches */
	149	hm->h.size = msg_size;
	150
ec9d04b2 KV	151	if (get_user(res_max_size, (u16 __user *)puhr)) {
	152	err = -EFAULT;
	153	goto out;
	154	}
719f82d3 EB	155	/* printk(KERN_INFO "user response size %d\n", res_max_size); */
	156	if (res_max_size < sizeof(struct hpi_response_header)) {
	157	HPI_DEBUG_LOG(WARNING, "small res size %d\n", res_max_size);
	158	err = -EFAULT;
	159	goto out;
	160	}
	161
0d02e129 EB	162	res_max_size = min_t(size_t, res_max_size, sizeof(*hr));
0d02e129 EB	163
6d0b898e EB	164	switch (hm->h.function) {
	165	case HPI_SUBSYS_CREATE_ADAPTER:
	166	case HPI_ADAPTER_DELETE:
	167	/* Application must not use these functions! */
	168	hr->h.size = sizeof(hr->h);
	169	hr->h.error = HPI_ERROR_INVALID_OPERATION;
	170	hr->h.function = hm->h.function;
	171	uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
	172	if (uncopied_bytes)
	173	err = -EFAULT;
	174	else
	175	err = 0;
	176	goto out;
	177	}
	178
3285ea10	179	hr->h.size = res_max_size;
719f82d3	180	if (hm->h.object == HPI_OBJ_SUBSYSTEM) {
6d0b898e	181	hpi_send_recv_f(&hm->m0, &hr->r0, file);
719f82d3 EB	182	} else {
	183	u16 __user *ptr = NULL;
	184	u32 size = 0;
719f82d3 EB	185	/* -1=no data 0=read from user mem, 1=write to user mem */
719f82d3 EB	186	int wrflag = -1;
7036b92d	187	struct hpi_adapter *pa = NULL;
08f984c7	188
7036b92d	189	if (hm->h.adapter_index < ARRAY_SIZE(adapters))
f9d94b57 TI	190	pa = &adapters[array_index_nospec(hm->h.adapter_index,
f9d94b57 TI	191	ARRAY_SIZE(adapters))];
719f82d3	192
7036b92d	193	if (!pa \|\| !pa->adapter \|\| !pa->adapter->type) {
08f984c7 EB	194	hpi_init_response(&hr->r0, hm->h.object,
08f984c7 EB	195	hm->h.function, HPI_ERROR_BAD_ADAPTER_NUMBER);
719f82d3 EB	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
767cd365	206	if (mutex_lock_interruptible(&pa->mutex)) {
719f82d3 EB	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,
3285ea10	225	"Realloc adapter %d stream "
719f82d3 EB	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
767cd365	242	mutex_unlock(&pa->mutex);
719f82d3 EB	243	err = -EINVAL;
	244	goto out;
	245	}
	246	}
	247
	248	hm->m0.u.d.u.data.pb_data = pa->p_buffer;
	249	if (hm->h.function == HPI_ISTREAM_READ)
	250	/* from card, WRITE to user mem */
	251	wrflag = 1;
	252	else
	253	wrflag = 0;
	254	break;
	255	}
	256
	257	default:
	258	size = 0;
	259	break;
	260	}
	261
	262	if (size && (wrflag == 0)) {
	263	uncopied_bytes =
	264	copy_from_user(pa->p_buffer, ptr, size);
	265	if (uncopied_bytes)
	266	HPI_DEBUG_LOG(WARNING,
3285ea10	267	"Missed %d of %d "
719f82d3 EB	268	"bytes from user\n", uncopied_bytes,
	269	size);
	270	}
	271
	272	hpi_send_recv_f(&hm->m0, &hr->r0, file);
	273
	274	if (size && (wrflag == 1)) {
	275	uncopied_bytes =
	276	copy_to_user(ptr, pa->p_buffer, size);
	277	if (uncopied_bytes)
	278	HPI_DEBUG_LOG(WARNING,
3285ea10	279	"Missed %d of %d " "bytes to user\n",
719f82d3 EB	280	uncopied_bytes, size);
	281	}
	282
767cd365	283	mutex_unlock(&pa->mutex);
719f82d3 EB	284	}
	285
	286	/* on return response size must be set */
	287	/printk(KERN_INFO "response size %d\n", hr->h.wSize); /
	288
	289	if (!hr->h.size) {
	290	HPI_DEBUG_LOG(ERROR, "response zero size\n");
	291	err = -EFAULT;
	292	goto out;
	293	}
	294
	295	if (hr->h.size > res_max_size) {
	296	HPI_DEBUG_LOG(ERROR, "response too big %d %d\n", hr->h.size,
	297	res_max_size);
3285ea10 EB	298	hr->h.error = HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL;
	299	hr->h.specific_error = hr->h.size;
	300	hr->h.size = sizeof(hr->h);
719f82d3 EB	301	}
	302
	303	uncopied_bytes = copy_to_user(puhr, hr, hr->h.size);
	304	if (uncopied_bytes) {
	305	HPI_DEBUG_LOG(ERROR, "uncopied bytes %d\n", uncopied_bytes);
	306	err = -EFAULT;
	307	goto out;
	308	}
	309
	310	out:
	311	kfree(hm);
	312	kfree(hr);
	313	return err;
	314	}
	315
f9a376c3 EB	316	static int asihpi_irq_count;
	317
	318	static irqreturn_t asihpi_isr(int irq, void *dev_id)
	319	{
	320	struct hpi_adapter *a = dev_id;
	321	int handled;
	322
	323	if (!a->adapter->irq_query_and_clear) {
	324	pr_err("asihpi_isr ASI%04X:%d no handler\n", a->adapter->type,
	325	a->adapter->index);
	326	return IRQ_NONE;
	327	}
	328
	329	handled = a->adapter->irq_query_and_clear(a->adapter, 0);
	330
	331	if (!handled)
	332	return IRQ_NONE;
	333
	334	asihpi_irq_count++;
	335	/* printk(KERN_INFO "asihpi_isr %d ASI%04X:%d irq handled\n",
	336	asihpi_irq_count, a->adapter->type, a->adapter->index); */
	337
	338	if (a->interrupt_callback)
	339	a->interrupt_callback(a);
	340
	341	return IRQ_HANDLED;
	342	}
	343
e23e7a14 BP	344	int asihpi_adapter_probe(struct pci_dev *pci_dev,
e23e7a14 BP	345	const struct pci_device_id *pci_id)
719f82d3	346	{
f9a376c3	347	int idx, nm, low_latency_mode = 0, irq_supported = 0;
7036b92d	348	int adapter_index;
719f82d3 EB	349	unsigned int memlen;
	350	struct hpi_message hm;
	351	struct hpi_response hr;
	352	struct hpi_adapter adapter;
	353	struct hpi_pci pci;
	354
	355	memset(&adapter, 0, sizeof(adapter));
	356
3285ea10 EB	357	dev_printk(KERN_DEBUG, &pci_dev->dev,
	358	"probe %04x:%04x,%04x:%04x,%04x\n", pci_dev->vendor,
	359	pci_dev->device, pci_dev->subsystem_vendor,
719f82d3 EB	360	pci_dev->subsystem_device, pci_dev->devfn);
719f82d3 EB	361
3285ea10	362	if (pci_enable_device(pci_dev) < 0) {
4ee3bffc	363	dev_err(&pci_dev->dev,
3285ea10 EB	364	"pci_enable_device failed, disabling device\n");
	365	return -EIO;
	366	}
	367
	368	pci_set_master(pci_dev); /* also sets latency timer if < 16 */
	369
719f82d3 EB	370	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
	371	HPI_SUBSYS_CREATE_ADAPTER);
	372	hpi_init_response(&hr, HPI_OBJ_SUBSYSTEM, HPI_SUBSYS_CREATE_ADAPTER,
	373	HPI_ERROR_PROCESSING_MESSAGE);
	374
3285ea10	375	hm.adapter_index = HPI_ADAPTER_INDEX_INVALID;
719f82d3	376
719f82d3 EB	377	nm = HPI_MAX_ADAPTER_MEM_SPACES;
	378
	379	for (idx = 0; idx < nm; idx++) {
42258dab EB	380	HPI_DEBUG_LOG(INFO, "resource %d %pR\n", idx,
42258dab EB	381	&pci_dev->resource[idx]);
719f82d3 EB	382
	383	if (pci_resource_flags(pci_dev, idx) & IORESOURCE_MEM) {
	384	memlen = pci_resource_len(pci_dev, idx);
7036b92d	385	pci.ap_mem_base[idx] =
719f82d3 EB	386	ioremap(pci_resource_start(pci_dev, idx),
719f82d3 EB	387	memlen);
7036b92d	388	if (!pci.ap_mem_base[idx]) {
719f82d3 EB	389	HPI_DEBUG_LOG(ERROR,
	390	"ioremap failed, aborting\n");
	391	/* unmap previously mapped pci mem space */
	392	goto err;
	393	}
	394	}
719f82d3 EB	395	}
719f82d3 EB	396
3285ea10	397	pci.pci_dev = pci_dev;
719f82d3 EB	398	hm.u.s.resource.bus_type = HPI_BUS_PCI;
	399	hm.u.s.resource.r.pci = &pci;
	400
	401	/* call CreateAdapterObject on the relevant hpi module */
	402	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	403	if (hr.error)
	404	goto err;
	405
7036b92d EB	406	adapter_index = hr.u.s.adapter_index;
	407	adapter.adapter = hpi_find_adapter(adapter_index);
	408
719f82d3 EB	409	if (prealloc_stream_buf) {
	410	adapter.p_buffer = vmalloc(prealloc_stream_buf);
	411	if (!adapter.p_buffer) {
	412	HPI_DEBUG_LOG(ERROR,
	413	"HPI could not allocate "
	414	"kernel buffer size %d\n",
	415	prealloc_stream_buf);
	416	goto err;
	417	}
	418	}
	419
6d0b898e EB	420	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
6d0b898e EB	421	HPI_ADAPTER_OPEN);
7036b92d	422	hm.adapter_index = adapter.adapter->index;
6d0b898e	423	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
719f82d3	424
f9a376c3 EB	425	if (hr.error) {
	426	HPI_DEBUG_LOG(ERROR, "HPI_ADAPTER_OPEN failed, aborting\n");
	427	goto err;
	428	}
	429
	430	/* Check if current mode == Low Latency mode */
	431	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
	432	HPI_ADAPTER_GET_MODE);
	433	hm.adapter_index = adapter.adapter->index;
	434	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	435
dc612838 EB	436	if (!hr.error
dc612838 EB	437	&& hr.u.ax.mode.adapter_mode == HPI_ADAPTER_MODE_LOW_LATENCY)
f9a376c3	438	low_latency_mode = 1;
dc612838 EB	439	else
	440	dev_info(&pci_dev->dev,
	441	"Adapter at index %d is not in low latency mode\n",
	442	adapter.adapter->index);
f9a376c3 EB	443
	444	/* Check if IRQs are supported */
	445	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
	446	HPI_ADAPTER_GET_PROPERTY);
	447	hm.adapter_index = adapter.adapter->index;
	448	hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ;
	449	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	450	if (hr.error \|\| !hr.u.ax.property_get.parameter1) {
	451	dev_info(&pci_dev->dev,
	452	"IRQs not supported by adapter at index %d\n",
	453	adapter.adapter->index);
	454	} else {
	455	irq_supported = 1;
	456	}
719f82d3	457
719f82d3 EB	458	/* WARNING can't init mutex in 'adapter'
	459	* and then copy it to adapters[] ?!?!
	460	*/
7036b92d EB	461	adapters[adapter_index] = adapter;
	462	mutex_init(&adapters[adapter_index].mutex);
	463	pci_set_drvdata(pci_dev, &adapters[adapter_index]);
719f82d3	464
f9a376c3 EB	465	if (low_latency_mode && irq_supported) {
	466	if (!adapter.adapter->irq_query_and_clear) {
	467	dev_err(&pci_dev->dev,
	468	"no IRQ handler for adapter %d, aborting\n",
	469	adapter.adapter->index);
	470	goto err;
	471	}
	472
	473	/* Disable IRQ generation on DSP side by setting the rate to 0 */
	474	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
	475	HPI_ADAPTER_SET_PROPERTY);
	476	hm.adapter_index = adapter.adapter->index;
	477	hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
	478	hm.u.ax.property_set.parameter1 = 0;
	479	hm.u.ax.property_set.parameter2 = 0;
	480	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	481	if (hr.error) {
	482	HPI_DEBUG_LOG(ERROR,
	483	"HPI_ADAPTER_GET_MODE failed, aborting\n");
	484	goto err;
	485	}
	486
	487	/* Note: request_irq calls asihpi_isr here */
	488	if (request_irq(pci_dev->irq, asihpi_isr, IRQF_SHARED,
	489	"asihpi", &adapters[adapter_index])) {
	490	dev_err(&pci_dev->dev, "request_irq(%d) failed\n",
	491	pci_dev->irq);
	492	goto err;
	493	}
	494
	495	adapters[adapter_index].interrupt_mode = 1;
	496
	497	dev_info(&pci_dev->dev, "using irq %d\n", pci_dev->irq);
	498	adapters[adapter_index].irq = pci_dev->irq;
	499	} else {
	500	dev_info(&pci_dev->dev, "using polled mode\n");
	501	}
	502
4ee3bffc JP	503	dev_info(&pci_dev->dev, "probe succeeded for ASI%04X HPI index %d\n",
4ee3bffc JP	504	adapter.adapter->type, adapter_index);
719f82d3 EB	505
	506	return 0;
	507
	508	err:
	509	for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; idx++) {
7036b92d EB	510	if (pci.ap_mem_base[idx]) {
	511	iounmap(pci.ap_mem_base[idx]);
	512	pci.ap_mem_base[idx] = NULL;
719f82d3 EB	513	}
	514	}
	515
	516	if (adapter.p_buffer) {
	517	adapter.buffer_size = 0;
	518	vfree(adapter.p_buffer);
	519	}
	520
	521	HPI_DEBUG_LOG(ERROR, "adapter_probe failed\n");
	522	return -ENODEV;
	523	}
	524
e23e7a14	525	void asihpi_adapter_remove(struct pci_dev *pci_dev)
719f82d3 EB	526	{
	527	int idx;
	528	struct hpi_message hm;
	529	struct hpi_response hr;
	530	struct hpi_adapter *pa;
7036b92d EB	531	struct hpi_pci pci;
7036b92d EB	532
5dbea6b1	533	pa = pci_get_drvdata(pci_dev);
7036b92d	534	pci = pa->adapter->pci;
719f82d3	535
f9a376c3 EB	536	/* Disable IRQ generation on DSP side */
	537	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
	538	HPI_ADAPTER_SET_PROPERTY);
	539	hm.adapter_index = pa->adapter->index;
	540	hm.u.ax.property_set.property = HPI_ADAPTER_PROPERTY_IRQ_RATE;
	541	hm.u.ax.property_set.parameter1 = 0;
	542	hm.u.ax.property_set.parameter2 = 0;
	543	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	544
6d0b898e EB	545	hpi_init_message_response(&hm, &hr, HPI_OBJ_ADAPTER,
6d0b898e EB	546	HPI_ADAPTER_DELETE);
7036b92d	547	hm.adapter_index = pa->adapter->index;
719f82d3 EB	548	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	549
	550	/* unmap PCI memory space, mapped during device init. */
ff6defa6 ME	551	for (idx = 0; idx < HPI_MAX_ADAPTER_MEM_SPACES; ++idx)
ff6defa6 ME	552	iounmap(pci.ap_mem_base[idx]);
719f82d3	553
f9a376c3 EB	554	if (pa->irq)
	555	free_irq(pa->irq, pa);
	556
87164cc5	557	vfree(pa->p_buffer);
719f82d3	558
3285ea10	559	if (1)
4ee3bffc JP	560	dev_info(&pci_dev->dev,
	561	"remove %04x:%04x,%04x:%04x,%04x, HPI index %d\n",
	562	pci_dev->vendor, pci_dev->device,
	563	pci_dev->subsystem_vendor, pci_dev->subsystem_device,
	564	pci_dev->devfn, pa->adapter->index);
c188dec3 EB	565
c188dec3 EB	566	memset(pa, 0, sizeof(*pa));
719f82d3 EB	567	}
	568
	569	void __init asihpi_init(void)
	570	{
	571	struct hpi_message hm;
	572	struct hpi_response hr;
	573
	574	memset(adapters, 0, sizeof(adapters));
	575
1dd6aaaa	576	printk(KERN_INFO "ASIHPI driver " HPI_VER_STRING "\n");
719f82d3 EB	577
	578	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
	579	HPI_SUBSYS_DRIVER_LOAD);
	580	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	581	}
	582
	583	void asihpi_exit(void)
	584	{
	585	struct hpi_message hm;
	586	struct hpi_response hr;
	587
	588	hpi_init_message_response(&hm, &hr, HPI_OBJ_SUBSYSTEM,
	589	HPI_SUBSYS_DRIVER_UNLOAD);
	590	hpi_send_recv_ex(&hm, &hr, HOWNER_KERNEL);
	591	}