[linux-2.6-block.git] / sound / pci / asihpi / hpioctl.c

// SPDX-License-Identifier: GPL-2.0-only
/*******************************************************************************
    AudioScience HPI driver
    Common Linux HPI ioctl and module probe/remove functions

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


*******************************************************************************/
#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)
		return IRQ_WAKE_THREAD;

	return IRQ_HANDLED;
}

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

	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 = { 0 };

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

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