[deliverable/linux.git] / drivers / usb / wusbcore / wusbhc.c

/*
 * Wireless USB Host Controller
 * sysfs glue, wusbcore module support and life cycle management
 *
 *
 * Copyright (C) 2005-2006 Intel Corporation
 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 *
 * Creation/destruction of wusbhc is split in two parts; that that
 * doesn't require the HCD to be added (wusbhc_{create,destroy}) and
 * the one that requires (phase B, wusbhc_b_{create,destroy}).
 *
 * This is so because usb_add_hcd() will start the HC, and thus, all
 * the HC specific stuff has to be already initialized (like sysfs
 * thingies).
 */
#include <linux/device.h>
#include <linux/module.h>
#include "wusbhc.h"

/**
 * Extract the wusbhc that corresponds to a USB Host Controller class device
 *
 * WARNING! Apply only if @dev is that of a
 *          wusbhc.usb_hcd.self->class_dev; otherwise, you loose.
 */
static struct wusbhc *usbhc_dev_to_wusbhc(struct device *dev)
{
	struct usb_bus *usb_bus = dev_get_drvdata(dev);
	struct usb_hcd *usb_hcd = bus_to_hcd(usb_bus);
	return usb_hcd_to_wusbhc(usb_hcd);
}

/*
 * Show & store the current WUSB trust timeout
 *
 * We don't do locking--it is an 'atomic' value.
 *
 * The units that we store/show are always MILLISECONDS. However, the
 * value of trust_timeout is jiffies.
 */
static ssize_t wusb_trust_timeout_show(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);

	return scnprintf(buf, PAGE_SIZE, "%u\n", wusbhc->trust_timeout);
}

static ssize_t wusb_trust_timeout_store(struct device *dev,
					struct device_attribute *attr,
					const char *buf, size_t size)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	ssize_t result = -ENOSYS;
	unsigned trust_timeout;

	result = sscanf(buf, "%u", &trust_timeout);
	if (result != 1) {
		result = -EINVAL;
		goto out;
	}
	wusbhc->trust_timeout = min_t(unsigned, trust_timeout, 500);
	cancel_delayed_work(&wusbhc->keep_alive_timer);
	flush_workqueue(wusbd);
	queue_delayed_work(wusbd, &wusbhc->keep_alive_timer,
			   msecs_to_jiffies(wusbhc->trust_timeout / 2));
out:
	return result < 0 ? result : size;
}
static DEVICE_ATTR(wusb_trust_timeout, 0644, wusb_trust_timeout_show,
					     wusb_trust_timeout_store);

/*
 * Show the current WUSB CHID.
 */
static ssize_t wusb_chid_show(struct device *dev,
			      struct device_attribute *attr, char *buf)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	const struct wusb_ckhdid *chid;
	ssize_t result = 0;

	if (wusbhc->wuie_host_info != NULL)
		chid = &wusbhc->wuie_host_info->CHID;
	else
		chid = &wusb_ckhdid_zero;

	result += ckhdid_printf(buf, PAGE_SIZE, chid);
	result += sprintf(buf + result, "\n");

	return result;
}

/*
 * Store a new CHID.
 *
 * - Write an all zeros CHID and it will stop the controller
 * - Write a non-zero CHID and it will start it.
 *
 * See wusbhc_chid_set() for more info.
 */
static ssize_t wusb_chid_store(struct device *dev,
			       struct device_attribute *attr,
			       const char *buf, size_t size)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	struct wusb_ckhdid chid;
	ssize_t result;

	result = sscanf(buf,
			"%02hhx %02hhx %02hhx %02hhx "
			"%02hhx %02hhx %02hhx %02hhx "
			"%02hhx %02hhx %02hhx %02hhx "
			"%02hhx %02hhx %02hhx %02hhx\n",
			&chid.data[0] , &chid.data[1] ,
			&chid.data[2] , &chid.data[3] ,
			&chid.data[4] , &chid.data[5] ,
			&chid.data[6] , &chid.data[7] ,
			&chid.data[8] , &chid.data[9] ,
			&chid.data[10], &chid.data[11],
			&chid.data[12], &chid.data[13],
			&chid.data[14], &chid.data[15]);
	if (result != 16) {
		dev_err(dev, "Unrecognized CHID (need 16 8-bit hex digits): "
			"%d\n", (int)result);
		return -EINVAL;
	}
	result = wusbhc_chid_set(wusbhc, &chid);
	return result < 0 ? result : size;
}
static DEVICE_ATTR(wusb_chid, 0644, wusb_chid_show, wusb_chid_store);


static ssize_t wusb_phy_rate_show(struct device *dev,
				  struct device_attribute *attr,
				  char *buf)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);

	return sprintf(buf, "%d\n", wusbhc->phy_rate);
}

static ssize_t wusb_phy_rate_store(struct device *dev,
				   struct device_attribute *attr,
				   const char *buf, size_t size)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	uint8_t phy_rate;
	ssize_t result;

	result = sscanf(buf, "%hhu", &phy_rate);
	if (result != 1)
		return -EINVAL;
	if (phy_rate >= UWB_PHY_RATE_INVALID)
		return -EINVAL;

	wusbhc->phy_rate = phy_rate;
	return size;
}
static DEVICE_ATTR(wusb_phy_rate, 0644, wusb_phy_rate_show,
			wusb_phy_rate_store);

static ssize_t wusb_dnts_show(struct device *dev,
				  struct device_attribute *attr,
				  char *buf)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);

	return sprintf(buf, "num slots: %d\ninterval: %dms\n",
			wusbhc->dnts_num_slots, wusbhc->dnts_interval);
}

static ssize_t wusb_dnts_store(struct device *dev,
				   struct device_attribute *attr,
				   const char *buf, size_t size)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	uint8_t num_slots, interval;
	ssize_t result;

	result = sscanf(buf, "%hhu %hhu", &num_slots, &interval);

	if (result != 2)
		return -EINVAL;

	wusbhc->dnts_num_slots = num_slots;
	wusbhc->dnts_interval = interval;

	return size;
}
static DEVICE_ATTR(wusb_dnts, 0644, wusb_dnts_show, wusb_dnts_store);

static ssize_t wusb_retry_count_show(struct device *dev,
				  struct device_attribute *attr,
				  char *buf)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);

	return sprintf(buf, "%d\n", wusbhc->retry_count);
}

static ssize_t wusb_retry_count_store(struct device *dev,
				   struct device_attribute *attr,
				   const char *buf, size_t size)
{
	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	uint8_t retry_count;
	ssize_t result;

	result = sscanf(buf, "%hhu", &retry_count);

	if (result != 1)
		return -EINVAL;

	wusbhc->retry_count = max_t(uint8_t, retry_count,
					WUSB_RETRY_COUNT_MAX);

	return size;
}
static DEVICE_ATTR(wusb_retry_count, 0644, wusb_retry_count_show,
	wusb_retry_count_store);

/* Group all the WUSBHC attributes */
static struct attribute *wusbhc_attrs[] = {
		&dev_attr_wusb_trust_timeout.attr,
		&dev_attr_wusb_chid.attr,
		&dev_attr_wusb_phy_rate.attr,
		&dev_attr_wusb_dnts.attr,
		&dev_attr_wusb_retry_count.attr,
		NULL,
};

static struct attribute_group wusbhc_attr_group = {
	.name = NULL,	/* we want them in the same directory */
	.attrs = wusbhc_attrs,
};

/*
 * Create a wusbhc instance
 *
 * NOTEs:
 *
 *  - assumes *wusbhc has been zeroed and wusbhc->usb_hcd has been
 *    initialized but not added.
 *
 *  - fill out ports_max, mmcies_max and mmcie_{add,rm} before calling.
 *
 *  - fill out wusbhc->uwb_rc and refcount it before calling
 *  - fill out the wusbhc->sec_modes array
 */
int wusbhc_create(struct wusbhc *wusbhc)
{
	int result = 0;

	/* set defaults.  These can be overwritten using sysfs attributes. */
	wusbhc->trust_timeout = WUSB_TRUST_TIMEOUT_MS;
	wusbhc->phy_rate = UWB_PHY_RATE_INVALID - 1;
	wusbhc->dnts_num_slots = 4;
	wusbhc->dnts_interval = 2;
	wusbhc->retry_count = WUSB_RETRY_COUNT_INFINITE;

	mutex_init(&wusbhc->mutex);
	result = wusbhc_mmcie_create(wusbhc);
	if (result < 0)
		goto error_mmcie_create;
	result = wusbhc_devconnect_create(wusbhc);
	if (result < 0)
		goto error_devconnect_create;
	result = wusbhc_rh_create(wusbhc);
	if (result < 0)
		goto error_rh_create;
	result = wusbhc_sec_create(wusbhc);
	if (result < 0)
		goto error_sec_create;
	return 0;

error_sec_create:
	wusbhc_rh_destroy(wusbhc);
error_rh_create:
	wusbhc_devconnect_destroy(wusbhc);
error_devconnect_create:
	wusbhc_mmcie_destroy(wusbhc);
error_mmcie_create:
	return result;
}
EXPORT_SYMBOL_GPL(wusbhc_create);

static inline struct kobject *wusbhc_kobj(struct wusbhc *wusbhc)
{
	return &wusbhc->usb_hcd.self.controller->kobj;
}

/*
 * Phase B of a wusbhc instance creation
 *
 * Creates fields that depend on wusbhc->usb_hcd having been
 * added. This is where we create the sysfs files in
 * /sys/class/usb_host/usb_hostX/.
 *
 * NOTE: Assumes wusbhc->usb_hcd has been already added by the upper
 *       layer (hwahc or whci)
 */
int wusbhc_b_create(struct wusbhc *wusbhc)
{
	int result = 0;
	struct device *dev = wusbhc->usb_hcd.self.controller;

	result = sysfs_create_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
	if (result < 0) {
		dev_err(dev, "Cannot register WUSBHC attributes: %d\n",
			result);
		goto error_create_attr_group;
	}

	return 0;
error_create_attr_group:
	return result;
}
EXPORT_SYMBOL_GPL(wusbhc_b_create);

void wusbhc_b_destroy(struct wusbhc *wusbhc)
{
	wusbhc_pal_unregister(wusbhc);
	sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
}
EXPORT_SYMBOL_GPL(wusbhc_b_destroy);

void wusbhc_destroy(struct wusbhc *wusbhc)
{
	wusbhc_sec_destroy(wusbhc);
	wusbhc_rh_destroy(wusbhc);
	wusbhc_devconnect_destroy(wusbhc);
	wusbhc_mmcie_destroy(wusbhc);
}
EXPORT_SYMBOL_GPL(wusbhc_destroy);

struct workqueue_struct *wusbd;
EXPORT_SYMBOL_GPL(wusbd);

/*
 * WUSB Cluster ID allocation map
 *
 * Each WUSB bus in a channel is identified with a Cluster Id in the
 * unauth address pace (WUSB1.0[4.3]). We take the range 0xe0 to 0xff
 * (that's space for 31 WUSB controllers, as 0xff can't be taken). We
 * start taking from 0xff, 0xfe, 0xfd... (hence the += or -= 0xff).
 *
 * For each one we taken, we pin it in the bitap
 */
#define CLUSTER_IDS 32
static DECLARE_BITMAP(wusb_cluster_id_table, CLUSTER_IDS);
static DEFINE_SPINLOCK(wusb_cluster_ids_lock);

/*
 * Get a WUSB Cluster ID
 *
 * Need to release with wusb_cluster_id_put() when done w/ it.
 */
/* FIXME: coordinate with the choose_addres() from the USB stack */
/* we want to leave the top of the 128 range for cluster addresses and
 * the bottom for device addresses (as we map them one on one with
 * ports). */
u8 wusb_cluster_id_get(void)
{
	u8 id;
	spin_lock(&wusb_cluster_ids_lock);
	id = find_first_zero_bit(wusb_cluster_id_table, CLUSTER_IDS);
	if (id >= CLUSTER_IDS) {
		id = 0;
		goto out;
	}
	set_bit(id, wusb_cluster_id_table);
	id = (u8) 0xff - id;
out:
	spin_unlock(&wusb_cluster_ids_lock);
	return id;

}
EXPORT_SYMBOL_GPL(wusb_cluster_id_get);

/*
 * Release a WUSB Cluster ID
 *
 * Obtained it with wusb_cluster_id_get()
 */
void wusb_cluster_id_put(u8 id)
{
	id = 0xff - id;
	BUG_ON(id >= CLUSTER_IDS);
	spin_lock(&wusb_cluster_ids_lock);
	WARN_ON(!test_bit(id, wusb_cluster_id_table));
	clear_bit(id, wusb_cluster_id_table);
	spin_unlock(&wusb_cluster_ids_lock);
}
EXPORT_SYMBOL_GPL(wusb_cluster_id_put);

/**
 * wusbhc_giveback_urb - return an URB to the USB core
 * @wusbhc: the host controller the URB is from.
 * @urb:    the URB.
 * @status: the URB's status.
 *
 * Return an URB to the USB core doing some additional WUSB specific
 * processing.
 *
 *  - After a successful transfer, update the trust timeout timestamp
 *    for the WUSB device.
 *
 *  - [WUSB] sections 4.13 and 7.5.1 specify the stop retransmission
 *    condition for the WCONNECTACK_IE is that the host has observed
 *    the associated device responding to a control transfer.
 */
void wusbhc_giveback_urb(struct wusbhc *wusbhc, struct urb *urb, int status)
{
	struct wusb_dev *wusb_dev = __wusb_dev_get_by_usb_dev(wusbhc,
					urb->dev);

	if (status == 0 && wusb_dev) {
		wusb_dev->entry_ts = jiffies;

		/* wusbhc_devconnect_acked() can't be called from
		   atomic context so defer it to a work queue. */
		if (!list_empty(&wusb_dev->cack_node))
			queue_work(wusbd, &wusb_dev->devconnect_acked_work);
		else
			wusb_dev_put(wusb_dev);
	}

	usb_hcd_giveback_urb(&wusbhc->usb_hcd, urb, status);
}
EXPORT_SYMBOL_GPL(wusbhc_giveback_urb);

/**
 * wusbhc_reset_all - reset the HC hardware
 * @wusbhc: the host controller to reset.
 *
 * Request a full hardware reset of the chip.  This will also reset
 * the radio controller and any other PALs.
 */
void wusbhc_reset_all(struct wusbhc *wusbhc)
{
	if (wusbhc->uwb_rc)
		uwb_rc_reset_all(wusbhc->uwb_rc);
}
EXPORT_SYMBOL_GPL(wusbhc_reset_all);

static struct notifier_block wusb_usb_notifier = {
	.notifier_call = wusb_usb_ncb,
	.priority = INT_MAX	/* Need to be called first of all */
};

static int __init wusbcore_init(void)
{
	int result;
	result = wusb_crypto_init();
	if (result < 0)
		goto error_crypto_init;
	/* WQ is singlethread because we need to serialize notifications */
	wusbd = create_singlethread_workqueue("wusbd");
	if (wusbd == NULL) {
		result = -ENOMEM;
		printk(KERN_ERR "WUSB-core: Cannot create wusbd workqueue\n");
		goto error_wusbd_create;
	}
	usb_register_notify(&wusb_usb_notifier);
	bitmap_zero(wusb_cluster_id_table, CLUSTER_IDS);
	set_bit(0, wusb_cluster_id_table);	/* reserve Cluster ID 0xff */
	return 0;

error_wusbd_create:
	wusb_crypto_exit();
error_crypto_init:
	return result;

}
module_init(wusbcore_init);

static void __exit wusbcore_exit(void)
{
	clear_bit(0, wusb_cluster_id_table);
	if (!bitmap_empty(wusb_cluster_id_table, CLUSTER_IDS)) {
		printk(KERN_ERR "BUG: WUSB Cluster IDs not released on exit: %*pb\n",
		       CLUSTER_IDS, wusb_cluster_id_table);
		WARN_ON(1);
	}
	usb_unregister_notify(&wusb_usb_notifier);
	destroy_workqueue(wusbd);
	wusb_crypto_exit();
}
module_exit(wusbcore_exit);

MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
MODULE_DESCRIPTION("Wireless USB core");
MODULE_LICENSE("GPL");
Commit	Line	Data
90ff96f2 IPG	1	/*
	2	* Wireless USB Host Controller
	3	* sysfs glue, wusbcore module support and life cycle management
	4	*
	5	*
	6	* Copyright (C) 2005-2006 Intel Corporation
	7	* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License version
	11	* 2 as published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	21	* 02110-1301, USA.
	22	*
	23	*
	24	* Creation/destruction of wusbhc is split in two parts; that that
	25	* doesn't require the HCD to be added (wusbhc_{create,destroy}) and
	26	* the one that requires (phase B, wusbhc_b_{create,destroy}).
	27	*
	28	* This is so because usb_add_hcd() will start the HC, and thus, all
421f91d2	29	* the HC specific stuff has to be already initialized (like sysfs
90ff96f2 IPG	30	* thingies).
	31	*/
	32	#include <linux/device.h>
	33	#include <linux/module.h>
	34	#include "wusbhc.h"
	35
	36	/**
	37	* Extract the wusbhc that corresponds to a USB Host Controller class device
	38	*
	39	* WARNING! Apply only if @dev is that of a
	40	* wusbhc.usb_hcd.self->class_dev; otherwise, you loose.
	41	*/
	42	static struct wusbhc usbhc_dev_to_wusbhc(struct device dev)
	43	{
	44	struct usb_bus *usb_bus = dev_get_drvdata(dev);
	45	struct usb_hcd *usb_hcd = bus_to_hcd(usb_bus);
	46	return usb_hcd_to_wusbhc(usb_hcd);
	47	}
	48
	49	/*
	50	* Show & store the current WUSB trust timeout
	51	*
	52	* We don't do locking--it is an 'atomic' value.
	53	*
	54	* The units that we store/show are always MILLISECONDS. However, the
	55	* value of trust_timeout is jiffies.
	56	*/
	57	static ssize_t wusb_trust_timeout_show(struct device *dev,
a7737e34 RB	58	struct device_attribute *attr,
a7737e34 RB	59	char *buf)
90ff96f2 IPG	60	{
	61	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	62
	63	return scnprintf(buf, PAGE_SIZE, "%u\n", wusbhc->trust_timeout);
	64	}
	65
	66	static ssize_t wusb_trust_timeout_store(struct device *dev,
	67	struct device_attribute *attr,
	68	const char *buf, size_t size)
	69	{
	70	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	71	ssize_t result = -ENOSYS;
	72	unsigned trust_timeout;
	73
	74	result = sscanf(buf, "%u", &trust_timeout);
	75	if (result != 1) {
	76	result = -EINVAL;
	77	goto out;
	78	}
7d9852a8	79	wusbhc->trust_timeout = min_t(unsigned, trust_timeout, 500);
90ff96f2 IPG	80	cancel_delayed_work(&wusbhc->keep_alive_timer);
	81	flush_workqueue(wusbd);
	82	queue_delayed_work(wusbd, &wusbhc->keep_alive_timer,
7d9852a8	83	msecs_to_jiffies(wusbhc->trust_timeout / 2));
90ff96f2 IPG	84	out:
	85	return result < 0 ? result : size;
	86	}
	87	static DEVICE_ATTR(wusb_trust_timeout, 0644, wusb_trust_timeout_show,
	88	wusb_trust_timeout_store);
	89
	90	/*
fca10c81	91	* Show the current WUSB CHID.
90ff96f2 IPG	92	*/
	93	static ssize_t wusb_chid_show(struct device *dev,
	94	struct device_attribute attr, char buf)
	95	{
	96	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
fca10c81	97	const struct wusb_ckhdid *chid;
90ff96f2 IPG	98	ssize_t result = 0;
	99
	100	if (wusbhc->wuie_host_info != NULL)
fca10c81 DV	101	chid = &wusbhc->wuie_host_info->CHID;
	102	else
	103	chid = &wusb_ckhdid_zero;
	104
	105	result += ckhdid_printf(buf, PAGE_SIZE, chid);
	106	result += sprintf(buf + result, "\n");
	107
90ff96f2 IPG	108	return result;
	109	}
	110
	111	/*
fca10c81	112	* Store a new CHID.
90ff96f2	113	*
fca10c81 DV	114	* - Write an all zeros CHID and it will stop the controller
fca10c81 DV	115	* - Write a non-zero CHID and it will start it.
90ff96f2 IPG	116	*
	117	* See wusbhc_chid_set() for more info.
	118	*/
	119	static ssize_t wusb_chid_store(struct device *dev,
	120	struct device_attribute *attr,
	121	const char *buf, size_t size)
	122	{
	123	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	124	struct wusb_ckhdid chid;
	125	ssize_t result;
	126
	127	result = sscanf(buf,
	128	"%02hhx %02hhx %02hhx %02hhx "
	129	"%02hhx %02hhx %02hhx %02hhx "
	130	"%02hhx %02hhx %02hhx %02hhx "
	131	"%02hhx %02hhx %02hhx %02hhx\n",
	132	&chid.data[0] , &chid.data[1] ,
	133	&chid.data[2] , &chid.data[3] ,
	134	&chid.data[4] , &chid.data[5] ,
	135	&chid.data[6] , &chid.data[7] ,
	136	&chid.data[8] , &chid.data[9] ,
	137	&chid.data[10], &chid.data[11],
	138	&chid.data[12], &chid.data[13],
	139	&chid.data[14], &chid.data[15]);
	140	if (result != 16) {
	141	dev_err(dev, "Unrecognized CHID (need 16 8-bit hex digits): "
	142	"%d\n", (int)result);
	143	return -EINVAL;
	144	}
	145	result = wusbhc_chid_set(wusbhc, &chid);
	146	return result < 0 ? result : size;
	147	}
	148	static DEVICE_ATTR(wusb_chid, 0644, wusb_chid_show, wusb_chid_store);
	149
c3f22d92 DV	150
	151	static ssize_t wusb_phy_rate_show(struct device *dev,
	152	struct device_attribute *attr,
	153	char *buf)
	154	{
	155	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	156
	157	return sprintf(buf, "%d\n", wusbhc->phy_rate);
	158	}
	159
	160	static ssize_t wusb_phy_rate_store(struct device *dev,
	161	struct device_attribute *attr,
	162	const char *buf, size_t size)
	163	{
	164	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	165	uint8_t phy_rate;
	166	ssize_t result;
	167
	168	result = sscanf(buf, "%hhu", &phy_rate);
	169	if (result != 1)
	170	return -EINVAL;
	171	if (phy_rate >= UWB_PHY_RATE_INVALID)
	172	return -EINVAL;
	173
	174	wusbhc->phy_rate = phy_rate;
	175	return size;
	176	}
a7737e34 RB	177	static DEVICE_ATTR(wusb_phy_rate, 0644, wusb_phy_rate_show,
a7737e34 RB	178	wusb_phy_rate_store);
c3f22d92	179
8bf1d071 TP	180	static ssize_t wusb_dnts_show(struct device *dev,
	181	struct device_attribute *attr,
	182	char *buf)
	183	{
	184	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	185
	186	return sprintf(buf, "num slots: %d\ninterval: %dms\n",
	187	wusbhc->dnts_num_slots, wusbhc->dnts_interval);
	188	}
	189
	190	static ssize_t wusb_dnts_store(struct device *dev,
	191	struct device_attribute *attr,
	192	const char *buf, size_t size)
	193	{
	194	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	195	uint8_t num_slots, interval;
	196	ssize_t result;
	197
	198	result = sscanf(buf, "%hhu %hhu", &num_slots, &interval);
	199
	200	if (result != 2)
	201	return -EINVAL;
	202
	203	wusbhc->dnts_num_slots = num_slots;
	204	wusbhc->dnts_interval = interval;
	205
	206	return size;
	207	}
	208	static DEVICE_ATTR(wusb_dnts, 0644, wusb_dnts_show, wusb_dnts_store);
	209
f265d4d3 TP	210	static ssize_t wusb_retry_count_show(struct device *dev,
	211	struct device_attribute *attr,
	212	char *buf)
	213	{
	214	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	215
	216	return sprintf(buf, "%d\n", wusbhc->retry_count);
	217	}
	218
	219	static ssize_t wusb_retry_count_store(struct device *dev,
	220	struct device_attribute *attr,
	221	const char *buf, size_t size)
	222	{
	223	struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
	224	uint8_t retry_count;
	225	ssize_t result;
	226
	227	result = sscanf(buf, "%hhu", &retry_count);
	228
	229	if (result != 1)
	230	return -EINVAL;
	231
a7737e34 RB	232	wusbhc->retry_count = max_t(uint8_t, retry_count,
a7737e34 RB	233	WUSB_RETRY_COUNT_MAX);
f265d4d3 TP	234
	235	return size;
	236	}
	237	static DEVICE_ATTR(wusb_retry_count, 0644, wusb_retry_count_show,
	238	wusb_retry_count_store);
	239
90ff96f2 IPG	240	/* Group all the WUSBHC attributes */
	241	static struct attribute *wusbhc_attrs[] = {
	242	&dev_attr_wusb_trust_timeout.attr,
	243	&dev_attr_wusb_chid.attr,
c3f22d92	244	&dev_attr_wusb_phy_rate.attr,
8bf1d071	245	&dev_attr_wusb_dnts.attr,
f265d4d3	246	&dev_attr_wusb_retry_count.attr,
90ff96f2 IPG	247	NULL,
	248	};
	249
	250	static struct attribute_group wusbhc_attr_group = {
	251	.name = NULL, /* we want them in the same directory */
	252	.attrs = wusbhc_attrs,
	253	};
	254
	255	/*
	256	* Create a wusbhc instance
	257	*
	258	* NOTEs:
	259	*
	260	* - assumes *wusbhc has been zeroed and wusbhc->usb_hcd has been
	261	* initialized but not added.
	262	*
	263	* - fill out ports_max, mmcies_max and mmcie_{add,rm} before calling.
	264	*
	265	* - fill out wusbhc->uwb_rc and refcount it before calling
	266	* - fill out the wusbhc->sec_modes array
	267	*/
	268	int wusbhc_create(struct wusbhc *wusbhc)
	269	{
	270	int result = 0;
	271
8bf1d071	272	/* set defaults. These can be overwritten using sysfs attributes. */
90ff96f2	273	wusbhc->trust_timeout = WUSB_TRUST_TIMEOUT_MS;
c3f22d92	274	wusbhc->phy_rate = UWB_PHY_RATE_INVALID - 1;
8bf1d071 TP	275	wusbhc->dnts_num_slots = 4;
8bf1d071 TP	276	wusbhc->dnts_interval = 2;
f265d4d3	277	wusbhc->retry_count = WUSB_RETRY_COUNT_INFINITE;
c3f22d92	278
90ff96f2 IPG	279	mutex_init(&wusbhc->mutex);
	280	result = wusbhc_mmcie_create(wusbhc);
	281	if (result < 0)
	282	goto error_mmcie_create;
	283	result = wusbhc_devconnect_create(wusbhc);
	284	if (result < 0)
	285	goto error_devconnect_create;
	286	result = wusbhc_rh_create(wusbhc);
	287	if (result < 0)
	288	goto error_rh_create;
	289	result = wusbhc_sec_create(wusbhc);
	290	if (result < 0)
	291	goto error_sec_create;
90ff96f2 IPG	292	return 0;
90ff96f2 IPG	293
90ff96f2 IPG	294	error_sec_create:
	295	wusbhc_rh_destroy(wusbhc);
	296	error_rh_create:
	297	wusbhc_devconnect_destroy(wusbhc);
	298	error_devconnect_create:
	299	wusbhc_mmcie_destroy(wusbhc);
	300	error_mmcie_create:
	301	return result;
	302	}
	303	EXPORT_SYMBOL_GPL(wusbhc_create);
	304
	305	static inline struct kobject wusbhc_kobj(struct wusbhc wusbhc)
	306	{
	307	return &wusbhc->usb_hcd.self.controller->kobj;
	308	}
	309
	310	/*
	311	* Phase B of a wusbhc instance creation
	312	*
	313	* Creates fields that depend on wusbhc->usb_hcd having been
	314	* added. This is where we create the sysfs files in
	315	* /sys/class/usb_host/usb_hostX/.
	316	*
	317	* NOTE: Assumes wusbhc->usb_hcd has been already added by the upper
	318	* layer (hwahc or whci)
	319	*/
	320	int wusbhc_b_create(struct wusbhc *wusbhc)
	321	{
	322	int result = 0;
	323	struct device *dev = wusbhc->usb_hcd.self.controller;
	324
	325	result = sysfs_create_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
	326	if (result < 0) {
a7737e34 RB	327	dev_err(dev, "Cannot register WUSBHC attributes: %d\n",
a7737e34 RB	328	result);
90ff96f2 IPG	329	goto error_create_attr_group;
90ff96f2 IPG	330	}
b60066c1	331
b60066c1	332	return 0;
90ff96f2 IPG	333	error_create_attr_group:
	334	return result;
	335	}
	336	EXPORT_SYMBOL_GPL(wusbhc_b_create);
	337
	338	void wusbhc_b_destroy(struct wusbhc *wusbhc)
	339	{
b60066c1	340	wusbhc_pal_unregister(wusbhc);
90ff96f2 IPG	341	sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
	342	}
	343	EXPORT_SYMBOL_GPL(wusbhc_b_destroy);
	344
	345	void wusbhc_destroy(struct wusbhc *wusbhc)
	346	{
90ff96f2 IPG	347	wusbhc_sec_destroy(wusbhc);
	348	wusbhc_rh_destroy(wusbhc);
	349	wusbhc_devconnect_destroy(wusbhc);
	350	wusbhc_mmcie_destroy(wusbhc);
	351	}
	352	EXPORT_SYMBOL_GPL(wusbhc_destroy);
	353
	354	struct workqueue_struct *wusbd;
	355	EXPORT_SYMBOL_GPL(wusbd);
	356
	357	/*
	358	* WUSB Cluster ID allocation map
	359	*
	360	* Each WUSB bus in a channel is identified with a Cluster Id in the
	361	* unauth address pace (WUSB1.0[4.3]). We take the range 0xe0 to 0xff
	362	* (that's space for 31 WUSB controllers, as 0xff can't be taken). We
	363	* start taking from 0xff, 0xfe, 0xfd... (hence the += or -= 0xff).
	364	*
	365	* For each one we taken, we pin it in the bitap
	366	*/
	367	#define CLUSTER_IDS 32
	368	static DECLARE_BITMAP(wusb_cluster_id_table, CLUSTER_IDS);
	369	static DEFINE_SPINLOCK(wusb_cluster_ids_lock);
	370
	371	/*
	372	* Get a WUSB Cluster ID
	373	*
	374	* Need to release with wusb_cluster_id_put() when done w/ it.
	375	*/
	376	/* FIXME: coordinate with the choose_addres() from the USB stack */
	377	/* we want to leave the top of the 128 range for cluster addresses and
	378	* the bottom for device addresses (as we map them one on one with
	379	* ports). */
	380	u8 wusb_cluster_id_get(void)
	381	{
	382	u8 id;
	383	spin_lock(&wusb_cluster_ids_lock);
	384	id = find_first_zero_bit(wusb_cluster_id_table, CLUSTER_IDS);
962f3ffa	385	if (id >= CLUSTER_IDS) {
90ff96f2 IPG	386	id = 0;
	387	goto out;
	388	}
	389	set_bit(id, wusb_cluster_id_table);
	390	id = (u8) 0xff - id;
	391	out:
	392	spin_unlock(&wusb_cluster_ids_lock);
	393	return id;
	394
	395	}
	396	EXPORT_SYMBOL_GPL(wusb_cluster_id_get);
	397
	398	/*
	399	* Release a WUSB Cluster ID
	400	*
	401	* Obtained it with wusb_cluster_id_get()
	402	*/
	403	void wusb_cluster_id_put(u8 id)
	404	{
	405	id = 0xff - id;
	406	BUG_ON(id >= CLUSTER_IDS);
	407	spin_lock(&wusb_cluster_ids_lock);
	408	WARN_ON(!test_bit(id, wusb_cluster_id_table));
	409	clear_bit(id, wusb_cluster_id_table);
	410	spin_unlock(&wusb_cluster_ids_lock);
	411	}
	412	EXPORT_SYMBOL_GPL(wusb_cluster_id_put);
	413
	414	/**
	415	* wusbhc_giveback_urb - return an URB to the USB core
	416	* @wusbhc: the host controller the URB is from.
	417	* @urb: the URB.
	418	* @status: the URB's status.
	419	*
	420	* Return an URB to the USB core doing some additional WUSB specific
	421	* processing.
	422	*
	423	* - After a successful transfer, update the trust timeout timestamp
	424	* for the WUSB device.
	425	*
1076e7a4	426	* - [WUSB] sections 4.13 and 7.5.1 specify the stop retransmission
90ff96f2 IPG	427	* condition for the WCONNECTACK_IE is that the host has observed
	428	* the associated device responding to a control transfer.
	429	*/
	430	void wusbhc_giveback_urb(struct wusbhc wusbhc, struct urb urb, int status)
	431	{
a7737e34 RB	432	struct wusb_dev *wusb_dev = __wusb_dev_get_by_usb_dev(wusbhc,
a7737e34 RB	433	urb->dev);
90ff96f2	434
5936ac7f	435	if (status == 0 && wusb_dev) {
90ff96f2 IPG	436	wusb_dev->entry_ts = jiffies;
90ff96f2 IPG	437
5936ac7f	438	/* wusbhc_devconnect_acked() can't be called from
90ff96f2 IPG	439	atomic context so defer it to a work queue. */
	440	if (!list_empty(&wusb_dev->cack_node))
	441	queue_work(wusbd, &wusb_dev->devconnect_acked_work);
5936ac7f DV	442	else
5936ac7f DV	443	wusb_dev_put(wusb_dev);
90ff96f2 IPG	444	}
	445
	446	usb_hcd_giveback_urb(&wusbhc->usb_hcd, urb, status);
	447	}
	448	EXPORT_SYMBOL_GPL(wusbhc_giveback_urb);
	449
	450	/**
	451	* wusbhc_reset_all - reset the HC hardware
	452	* @wusbhc: the host controller to reset.
	453	*
	454	* Request a full hardware reset of the chip. This will also reset
	455	* the radio controller and any other PALs.
	456	*/
	457	void wusbhc_reset_all(struct wusbhc *wusbhc)
	458	{
a8995751 TP	459	if (wusbhc->uwb_rc)
a8995751 TP	460	uwb_rc_reset_all(wusbhc->uwb_rc);
90ff96f2 IPG	461	}
	462	EXPORT_SYMBOL_GPL(wusbhc_reset_all);
	463
	464	static struct notifier_block wusb_usb_notifier = {
	465	.notifier_call = wusb_usb_ncb,
	466	.priority = INT_MAX /* Need to be called first of all */
	467	};
	468
	469	static int __init wusbcore_init(void)
	470	{
	471	int result;
	472	result = wusb_crypto_init();
	473	if (result < 0)
	474	goto error_crypto_init;
	475	/* WQ is singlethread because we need to serialize notifications */
	476	wusbd = create_singlethread_workqueue("wusbd");
	477	if (wusbd == NULL) {
	478	result = -ENOMEM;
	479	printk(KERN_ERR "WUSB-core: Cannot create wusbd workqueue\n");
	480	goto error_wusbd_create;
	481	}
	482	usb_register_notify(&wusb_usb_notifier);
	483	bitmap_zero(wusb_cluster_id_table, CLUSTER_IDS);
	484	set_bit(0, wusb_cluster_id_table); /* reserve Cluster ID 0xff */
	485	return 0;
	486
	487	error_wusbd_create:
	488	wusb_crypto_exit();
	489	error_crypto_init:
	490	return result;
	491
	492	}
	493	module_init(wusbcore_init);
	494
	495	static void __exit wusbcore_exit(void)
	496	{
	497	clear_bit(0, wusb_cluster_id_table);
	498	if (!bitmap_empty(wusb_cluster_id_table, CLUSTER_IDS)) {
125918db TH	499	printk(KERN_ERR "BUG: WUSB Cluster IDs not released on exit: %*pb\n",
125918db TH	500	CLUSTER_IDS, wusb_cluster_id_table);
90ff96f2 IPG	501	WARN_ON(1);
	502	}
	503	usb_unregister_notify(&wusb_usb_notifier);
	504	destroy_workqueue(wusbd);
	505	wusb_crypto_exit();
	506	}
	507	module_exit(wusbcore_exit);
	508
	509	MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
	510	MODULE_DESCRIPTION("Wireless USB core");
	511	MODULE_LICENSE("GPL");