wusb: WHCI host controller driver (7e6133aa) · Commits · e / devices / android_kernel_fairphone_FP3

drivers/usb/host/Kconfig

+12 −0

Original line number	Diff line number	Diff line
		@@ -305,3 +305,15 @@ config SUPERH_ON_CHIP_R8A66597
		help
		This driver enables support for the on-chip R8A66597 in the
		SH7366 and SH7723 processors.

		config USB_WHCI_HCD
		tristate "Wireless USB Host Controller Interface (WHCI) driver"
		depends on PCI && USB
		select USB_WUSB
		select UWB_WHCI
		help
		A driver for PCI-based Wireless USB Host Controllers that are
		compliant with the WHCI specification.

		To compile this driver a module, choose M here: the module
		will be called "whci-hcd".

drivers/usb/host/Makefile

+2 −0

Original line number	Diff line number	Diff line
		@@ -8,6 +8,8 @@ endif

		isp1760-objs := isp1760-hcd.o isp1760-if.o

		obj-$(CONFIG_USB_WHCI_HCD) += whci/

		obj-$(CONFIG_PCI) += pci-quirks.o

		obj-$(CONFIG_USB_EHCI_HCD) += ehci-hcd.o

drivers/usb/host/whci/Kbuild

0 → 100644

+11 −0

Original line number	Diff line number	Diff line
		obj-$(CONFIG_USB_WHCI_HCD) += whci-hcd.o

		whci-hcd-y := \
		asl.o \
		hcd.o \
		hw.o \
		init.o \
		int.o \
		pzl.o \
		qset.o \
		wusb.o

drivers/usb/host/whci/asl.c

0 → 100644

+367 −0

Original line number	Diff line number	Diff line
		/*
		* Wireless Host Controller (WHC) asynchronous schedule management.
		*
		* Copyright (C) 2007 Cambridge Silicon Radio Ltd.
		*
		* This program is free software; you can redistribute it and/or
		* modify it under the terms of the GNU General Public License version
		* 2 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.
		*
		* You should have received a copy of the GNU General Public License
		* along with this program. If not, see <http://www.gnu.org/licenses/>.
		*/
		#include <linux/kernel.h>
		#include <linux/dma-mapping.h>
		#include <linux/uwb/umc.h>
		#include <linux/usb.h>
		#define D_LOCAL 0
		#include <linux/uwb/debug.h>

		#include "../../wusbcore/wusbhc.h"

		#include "whcd.h"

		#if D_LOCAL >= 4
		static void dump_asl(struct whc whc, const char tag)
		{
		struct device *dev = &whc->umc->dev;
		struct whc_qset *qset;

		d_printf(4, dev, "ASL %s\n", tag);

		list_for_each_entry(qset, &whc->async_list, list_node) {
		dump_qset(qset, dev);
		}
		}
		#else
		static inline void dump_asl(struct whc whc, const char tag)
		{
		}
		#endif


		static void qset_get_next_prev(struct whc whc, struct whc_qset qset,
		struct whc_qset next, struct whc_qset prev)
		{
		struct list_head n, p;

		BUG_ON(list_empty(&whc->async_list));

		n = qset->list_node.next;
		if (n == &whc->async_list)
		n = n->next;
		p = qset->list_node.prev;
		if (p == &whc->async_list)
		p = p->prev;

		*next = container_of(n, struct whc_qset, list_node);
		*prev = container_of(p, struct whc_qset, list_node);

		}

		static void asl_qset_insert_begin(struct whc whc, struct whc_qset qset)
		{
		list_move(&qset->list_node, &whc->async_list);
		qset->in_sw_list = true;
		}

		static void asl_qset_insert(struct whc whc, struct whc_qset qset)
		{
		struct whc_qset next, prev;

		qset_clear(whc, qset);

		/* Link into ASL. */
		qset_get_next_prev(whc, qset, &next, &prev);
		whc_qset_set_link_ptr(&qset->qh.link, next->qset_dma);
		whc_qset_set_link_ptr(&prev->qh.link, qset->qset_dma);
		qset->in_hw_list = true;
		}

		static void asl_qset_remove(struct whc whc, struct whc_qset qset)
		{
		struct whc_qset prev, next;

		qset_get_next_prev(whc, qset, &next, &prev);

		list_move(&qset->list_node, &whc->async_removed_list);
		qset->in_sw_list = false;

		/*
		* No more qsets in the ASL? The caller must stop the ASL as
		* it's no longer valid.
		*/
		if (list_empty(&whc->async_list))
		return;

		/* Remove from ASL. */
		whc_qset_set_link_ptr(&prev->qh.link, next->qset_dma);
		qset->in_hw_list = false;
		}

		/**
		* process_qset - process any recently inactivated or halted qTDs in a
		* qset.
		*
		* After inactive qTDs are removed, new qTDs can be added if the
		* urb queue still contains URBs.
		*
		* Returns any additional WUSBCMD bits for the ASL sync command (i.e.,
		* WUSBCMD_ASYNC_QSET_RM if a halted qset was removed).
		*/
		static uint32_t process_qset(struct whc whc, struct whc_qset qset)
		{
		enum whc_update update = 0;
		uint32_t status = 0;

		while (qset->ntds) {
		struct whc_qtd *td;
		int t;

		t = qset->td_start;
		td = &qset->qtd[qset->td_start];
		status = le32_to_cpu(td->status);

		/*
		* Nothing to do with a still active qTD.
		*/
		if (status & QTD_STS_ACTIVE)
		break;

		if (status & QTD_STS_HALTED) {
		/* Ug, an error. */
		process_halted_qtd(whc, qset, td);
		goto done;
		}

		/* Mmm, a completed qTD. */
		process_inactive_qtd(whc, qset, td);
		}

		update \|= qset_add_qtds(whc, qset);

		done:
		/*
		* Remove this qset from the ASL if requested, but only if has
		* no qTDs.
		*/
		if (qset->remove && qset->ntds == 0) {
		asl_qset_remove(whc, qset);
		update \|= WHC_UPDATE_REMOVED;
		}
		return update;
		}

		void asl_start(struct whc *whc)
		{
		struct whc_qset *qset;

		qset = list_first_entry(&whc->async_list, struct whc_qset, list_node);

		le_writeq(qset->qset_dma \| QH_LINK_NTDS(8), whc->base + WUSBASYNCLISTADDR);

		whc_write_wusbcmd(whc, WUSBCMD_ASYNC_EN, WUSBCMD_ASYNC_EN);
		whci_wait_for(&whc->umc->dev, whc->base + WUSBSTS,
		WUSBSTS_ASYNC_SCHED, WUSBSTS_ASYNC_SCHED,
		1000, "start ASL");
		}

		void asl_stop(struct whc *whc)
		{
		whc_write_wusbcmd(whc, WUSBCMD_ASYNC_EN, 0);
		whci_wait_for(&whc->umc->dev, whc->base + WUSBSTS,
		WUSBSTS_ASYNC_SCHED, 0,
		1000, "stop ASL");
		}

		void asl_update(struct whc *whc, uint32_t wusbcmd)
		{
		whc_write_wusbcmd(whc, wusbcmd, wusbcmd);
		wait_event(whc->async_list_wq,
		(le_readl(whc->base + WUSBCMD) & WUSBCMD_ASYNC_UPDATED) == 0);
		}

		/**
		* scan_async_work - scan the ASL for qsets to process.
		*
		* Process each qset in the ASL in turn and then signal the WHC that
		* the ASL has been updated.
		*
		* Then start, stop or update the asynchronous schedule as required.
		*/
		void scan_async_work(struct work_struct *work)
		{
		struct whc *whc = container_of(work, struct whc, async_work);
		struct whc_qset qset, t;
		enum whc_update update = 0;

		spin_lock_irq(&whc->lock);

		dump_asl(whc, "before processing");

		/*
		* Transerve the software list backwards so new qsets can be
		* safely inserted into the ASL without making it non-circular.
		*/
		list_for_each_entry_safe_reverse(qset, t, &whc->async_list, list_node) {
		if (!qset->in_hw_list) {
		asl_qset_insert(whc, qset);
		update \|= WHC_UPDATE_ADDED;
		}

		update \|= process_qset(whc, qset);
		}

		dump_asl(whc, "after processing");

		spin_unlock_irq(&whc->lock);

		if (update) {
		uint32_t wusbcmd = WUSBCMD_ASYNC_UPDATED \| WUSBCMD_ASYNC_SYNCED_DB;
		if (update & WHC_UPDATE_REMOVED)
		wusbcmd \|= WUSBCMD_ASYNC_QSET_RM;
		asl_update(whc, wusbcmd);
		}

		/*
		* Now that the ASL is updated, complete the removal of any
		* removed qsets.
		*/
		spin_lock(&whc->lock);

		list_for_each_entry_safe(qset, t, &whc->async_removed_list, list_node) {
		qset_remove_complete(whc, qset);
		}

		spin_unlock(&whc->lock);
		}

		/**
		* asl_urb_enqueue - queue an URB onto the asynchronous list (ASL).
		* @whc: the WHCI host controller
		* @urb: the URB to enqueue
		* @mem_flags: flags for any memory allocations
		*
		* The qset for the endpoint is obtained and the urb queued on to it.
		*
		* Work is scheduled to update the hardware's view of the ASL.
		*/
		int asl_urb_enqueue(struct whc whc, struct urb urb, gfp_t mem_flags)
		{
		struct whc_qset *qset;
		int err;
		unsigned long flags;

		spin_lock_irqsave(&whc->lock, flags);

		qset = get_qset(whc, urb, GFP_ATOMIC);
		if (qset == NULL)
		err = -ENOMEM;
		else
		err = qset_add_urb(whc, qset, urb, GFP_ATOMIC);
		if (!err) {
		usb_hcd_link_urb_to_ep(&whc->wusbhc.usb_hcd, urb);
		if (!qset->in_sw_list)
		asl_qset_insert_begin(whc, qset);
		}

		spin_unlock_irqrestore(&whc->lock, flags);

		if (!err)
		queue_work(whc->workqueue, &whc->async_work);

		return 0;
		}

		/**
		* asl_urb_dequeue - remove an URB (qset) from the async list.
		* @whc: the WHCI host controller
		* @urb: the URB to dequeue
		* @status: the current status of the URB
		*
		* URBs that do yet have qTDs can simply be removed from the software
		* queue, otherwise the qset must be removed from the ASL so the qTDs
		* can be removed.
		*/
		int asl_urb_dequeue(struct whc whc, struct urb urb, int status)
		{
		struct whc_urb *wurb = urb->hcpriv;
		struct whc_qset *qset = wurb->qset;
		struct whc_std std, t;
		int ret;
		unsigned long flags;

		spin_lock_irqsave(&whc->lock, flags);

		ret = usb_hcd_check_unlink_urb(&whc->wusbhc.usb_hcd, urb, status);
		if (ret < 0)
		goto out;

		list_for_each_entry_safe(std, t, &qset->stds, list_node) {
		if (std->urb == urb)
		qset_free_std(whc, std);
		else
		std->qtd = NULL; /* so this std is re-added when the qset is */
		}

		asl_qset_remove(whc, qset);
		wurb->status = status;
		wurb->is_async = true;
		queue_work(whc->workqueue, &wurb->dequeue_work);

		out:
		spin_unlock_irqrestore(&whc->lock, flags);

		return ret;
		}

		/**
		* asl_qset_delete - delete a qset from the ASL
		*/
		void asl_qset_delete(struct whc whc, struct whc_qset qset)
		{
		qset->remove = 1;
		queue_work(whc->workqueue, &whc->async_work);
		qset_delete(whc, qset);
		}

		/**
		* asl_init - initialize the asynchronous schedule list
		*
		* A dummy qset with no qTDs is added to the ASL to simplify removing
		* qsets (no need to stop the ASL when the last qset is removed).
		*/
		int asl_init(struct whc *whc)
		{
		struct whc_qset *qset;

		qset = qset_alloc(whc, GFP_KERNEL);
		if (qset == NULL)
		return -ENOMEM;

		asl_qset_insert_begin(whc, qset);
		asl_qset_insert(whc, qset);

		return 0;
		}

		/**
		* asl_clean_up - free ASL resources
		*
		* The ASL is stopped and empty except for the dummy qset.
		*/
		void asl_clean_up(struct whc *whc)
		{
		struct whc_qset *qset;

		if (!list_empty(&whc->async_list)) {
		qset = list_first_entry(&whc->async_list, struct whc_qset, list_node);
		list_del(&qset->list_node);
		qset_free(whc, qset);
		}
		}

drivers/usb/host/whci/hcd.c

0 → 100644

+339 −0

Original line number	Diff line number	Diff line
		/*
		* Wireless Host Controller (WHC) driver.
		*
		* Copyright (C) 2007 Cambridge Silicon Radio Ltd.
		*
		* This program is free software; you can redistribute it and/or
		* modify it under the terms of the GNU General Public License version
		* 2 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.
		*
		* You should have received a copy of the GNU General Public License
		* along with this program. If not, see <http://www.gnu.org/licenses/>.
		*/
		#include <linux/version.h>
		#include <linux/kernel.h>
		#include <linux/init.h>
		#include <linux/uwb/umc.h>

		#include "../../wusbcore/wusbhc.h"

		#include "whcd.h"

		/*
		* One time initialization.
		*
		* Nothing to do here.
		*/
		static int whc_reset(struct usb_hcd *usb_hcd)
		{
		return 0;
		}

		/*
		* Start the wireless host controller.
		*
		* Start device notification.
		*
		* Put hc into run state, set DNTS parameters.
		*/
		static int whc_start(struct usb_hcd *usb_hcd)
		{
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);
		u8 bcid;
		int ret;

		mutex_lock(&wusbhc->mutex);

		le_writel(WUSBINTR_GEN_CMD_DONE
		\| WUSBINTR_HOST_ERR
		\| WUSBINTR_ASYNC_SCHED_SYNCED
		\| WUSBINTR_DNTS_INT
		\| WUSBINTR_ERR_INT
		\| WUSBINTR_INT,
		whc->base + WUSBINTR);

		/* set cluster ID */
		bcid = wusb_cluster_id_get();
		ret = whc_set_cluster_id(whc, bcid);
		if (ret < 0)
		goto out;
		wusbhc->cluster_id = bcid;

		/* start HC */
		whc_write_wusbcmd(whc, WUSBCMD_RUN, WUSBCMD_RUN);

		usb_hcd->uses_new_polling = 1;
		usb_hcd->poll_rh = 1;
		usb_hcd->state = HC_STATE_RUNNING;

		out:
		mutex_unlock(&wusbhc->mutex);
		return ret;
		}


		/*
		* Stop the wireless host controller.
		*
		* Stop device notification.
		*
		* Wait for pending transfer to stop? Put hc into stop state?
		*/
		static void whc_stop(struct usb_hcd *usb_hcd)
		{
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);

		mutex_lock(&wusbhc->mutex);

		wusbhc_stop(wusbhc);

		/* stop HC */
		le_writel(0, whc->base + WUSBINTR);
		whc_write_wusbcmd(whc, WUSBCMD_RUN, 0);
		whci_wait_for(&whc->umc->dev, whc->base + WUSBSTS,
		WUSBSTS_HCHALTED, WUSBSTS_HCHALTED,
		100, "HC to halt");

		wusb_cluster_id_put(wusbhc->cluster_id);

		mutex_unlock(&wusbhc->mutex);
		}

		static int whc_get_frame_number(struct usb_hcd *usb_hcd)
		{
		/* Frame numbers are not applicable to WUSB. */
		return -ENOSYS;
		}


		/*
		* Queue an URB to the ASL or PZL
		*/
		static int whc_urb_enqueue(struct usb_hcd usb_hcd, struct urb urb,
		gfp_t mem_flags)
		{
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);
		int ret;

		switch (usb_pipetype(urb->pipe)) {
		case PIPE_INTERRUPT:
		ret = pzl_urb_enqueue(whc, urb, mem_flags);
		break;
		case PIPE_ISOCHRONOUS:
		dev_err(&whc->umc->dev, "isochronous transfers unsupported\n");
		ret = -ENOTSUPP;
		break;
		case PIPE_CONTROL:
		case PIPE_BULK:
		default:
		ret = asl_urb_enqueue(whc, urb, mem_flags);
		break;
		};

		return ret;
		}

		/*
		* Remove a queued URB from the ASL or PZL.
		*/
		static int whc_urb_dequeue(struct usb_hcd usb_hcd, struct urb urb, int status)
		{
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);
		int ret;

		switch (usb_pipetype(urb->pipe)) {
		case PIPE_INTERRUPT:
		ret = pzl_urb_dequeue(whc, urb, status);
		break;
		case PIPE_ISOCHRONOUS:
		ret = -ENOTSUPP;
		break;
		case PIPE_CONTROL:
		case PIPE_BULK:
		default:
		ret = asl_urb_dequeue(whc, urb, status);
		break;
		};

		return ret;
		}

		/*
		* Wait for all URBs to the endpoint to be completed, then delete the
		* qset.
		*/
		static void whc_endpoint_disable(struct usb_hcd *usb_hcd,
		struct usb_host_endpoint *ep)
		{
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);
		struct whc_qset *qset;

		qset = ep->hcpriv;
		if (qset) {
		ep->hcpriv = NULL;
		if (usb_endpoint_xfer_bulk(&ep->desc)
		\|\| usb_endpoint_xfer_control(&ep->desc))
		asl_qset_delete(whc, qset);
		else
		pzl_qset_delete(whc, qset);
		}
		}

		static struct hc_driver whc_hc_driver = {
		.description = "whci-hcd",
		.product_desc = "Wireless host controller",
		.hcd_priv_size = sizeof(struct whc) - sizeof(struct usb_hcd),
		.irq = whc_int_handler,
		.flags = HCD_USB2,

		.reset = whc_reset,
		.start = whc_start,
		.stop = whc_stop,
		.get_frame_number = whc_get_frame_number,
		.urb_enqueue = whc_urb_enqueue,
		.urb_dequeue = whc_urb_dequeue,
		.endpoint_disable = whc_endpoint_disable,

		.hub_status_data = wusbhc_rh_status_data,
		.hub_control = wusbhc_rh_control,
		.bus_suspend = wusbhc_rh_suspend,
		.bus_resume = wusbhc_rh_resume,
		.start_port_reset = wusbhc_rh_start_port_reset,
		};

		static int whc_probe(struct umc_dev *umc)
		{
		int ret = -ENOMEM;
		struct usb_hcd *usb_hcd;
		struct wusbhc *wusbhc = NULL;
		struct whc *whc = NULL;
		struct device *dev = &umc->dev;

		usb_hcd = usb_create_hcd(&whc_hc_driver, dev, "whci");
		if (usb_hcd == NULL) {
		dev_err(dev, "unable to create hcd\n");
		goto error;
		}

		usb_hcd->wireless = 1;

		wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		whc = wusbhc_to_whc(wusbhc);
		whc->umc = umc;

		ret = whc_init(whc);
		if (ret)
		goto error;

		wusbhc->dev = dev;
		wusbhc->uwb_rc = uwb_rc_get_by_grandpa(umc->dev.parent);
		if (!wusbhc->uwb_rc) {
		ret = -ENODEV;
		dev_err(dev, "cannot get radio controller\n");
		goto error;
		}

		if (whc->n_devices > USB_MAXCHILDREN) {
		dev_warn(dev, "USB_MAXCHILDREN too low for WUSB adapter (%u ports)\n",
		whc->n_devices);
		wusbhc->ports_max = USB_MAXCHILDREN;
		} else
		wusbhc->ports_max = whc->n_devices;
		wusbhc->mmcies_max = whc->n_mmc_ies;
		wusbhc->start = whc_wusbhc_start;
		wusbhc->stop = whc_wusbhc_stop;
		wusbhc->mmcie_add = whc_mmcie_add;
		wusbhc->mmcie_rm = whc_mmcie_rm;
		wusbhc->dev_info_set = whc_dev_info_set;
		wusbhc->bwa_set = whc_bwa_set;
		wusbhc->set_num_dnts = whc_set_num_dnts;
		wusbhc->set_ptk = whc_set_ptk;
		wusbhc->set_gtk = whc_set_gtk;

		ret = wusbhc_create(wusbhc);
		if (ret)
		goto error_wusbhc_create;

		ret = usb_add_hcd(usb_hcd, whc->umc->irq, IRQF_SHARED);
		if (ret) {
		dev_err(dev, "cannot add HCD: %d\n", ret);
		goto error_usb_add_hcd;
		}

		ret = wusbhc_b_create(wusbhc);
		if (ret) {
		dev_err(dev, "WUSBHC phase B setup failed: %d\n", ret);
		goto error_wusbhc_b_create;
		}

		return 0;

		error_wusbhc_b_create:
		usb_remove_hcd(usb_hcd);
		error_usb_add_hcd:
		wusbhc_destroy(wusbhc);
		error_wusbhc_create:
		uwb_rc_put(wusbhc->uwb_rc);
		error:
		whc_clean_up(whc);
		if (usb_hcd)
		usb_put_hcd(usb_hcd);
		return ret;
		}


		static void whc_remove(struct umc_dev *umc)
		{
		struct usb_hcd *usb_hcd = dev_get_drvdata(&umc->dev);
		struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
		struct whc *whc = wusbhc_to_whc(wusbhc);

		if (usb_hcd) {
		wusbhc_b_destroy(wusbhc);
		usb_remove_hcd(usb_hcd);
		wusbhc_destroy(wusbhc);
		uwb_rc_put(wusbhc->uwb_rc);
		whc_clean_up(whc);
		usb_put_hcd(usb_hcd);
		}
		}

		static struct umc_driver whci_hc_driver = {
		.name = "whci-hcd",
		.cap_id = UMC_CAP_ID_WHCI_WUSB_HC,
		.probe = whc_probe,
		.remove = whc_remove,
		};

		static int __init whci_hc_driver_init(void)
		{
		return umc_driver_register(&whci_hc_driver);
		}
		module_init(whci_hc_driver_init);

		static void __exit whci_hc_driver_exit(void)
		{
		umc_driver_unregister(&whci_hc_driver);
		}
		module_exit(whci_hc_driver_exit);

		/* PCI device ID's that we handle (so it gets loaded) */
		static struct pci_device_id whci_hcd_id_table[] = {
		{ PCI_DEVICE_CLASS(PCI_CLASS_WIRELESS_WHCI, ~0) },
		{ /* empty last entry */ }
		};
		MODULE_DEVICE_TABLE(pci, whci_hcd_id_table);

		MODULE_DESCRIPTION("WHCI Wireless USB host controller driver");
		MODULE_AUTHOR("Cambridge Silicon Radio Ltd.");
		MODULE_LICENSE("GPL");