[linux.git] / drivers / uwb / lc-rc.c

/*
 * Ultra Wide Band
 * Life cycle of radio controllers
 *
 * Copyright (C) 2005-2006 Intel Corporation
 * Inaky Perez-Gonzalez <[email protected]>
 *
 * 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.
 *
 *
 * FIXME: docs
 *
 * A UWB radio controller is also a UWB device, so it embeds one...
 *
 * List of RCs comes from the 'struct class uwb_rc_class'.
 */

#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/random.h>
#include <linux/kdev_t.h>
#include <linux/etherdevice.h>
#include <linux/usb.h>
#include <linux/slab.h>
#include <linux/export.h>

#include "uwb-internal.h"

static int uwb_rc_index_match(struct device *dev, void *data)
{
	int *index = data;
	struct uwb_rc *rc = dev_get_drvdata(dev);

	if (rc->index == *index)
		return 1;
	return 0;
}

static struct uwb_rc *uwb_rc_find_by_index(int index)
{
	struct device *dev;
	struct uwb_rc *rc = NULL;

	dev = class_find_device(&uwb_rc_class, NULL, &index, uwb_rc_index_match);
	if (dev)
		rc = dev_get_drvdata(dev);
	return rc;
}

static int uwb_rc_new_index(void)
{
	int index = 0;

	for (;;) {
		if (!uwb_rc_find_by_index(index))
			return index;
		if (++index < 0)
			index = 0;
	}
}

/**
 * Release the backing device of a uwb_rc that has been dynamically allocated.
 */
static void uwb_rc_sys_release(struct device *dev)
{
	struct uwb_dev *uwb_dev = container_of(dev, struct uwb_dev, dev);
	struct uwb_rc *rc = container_of(uwb_dev, struct uwb_rc, uwb_dev);

	uwb_rc_ie_release(rc);
	kfree(rc);
}


void uwb_rc_init(struct uwb_rc *rc)
{
	struct uwb_dev *uwb_dev = &rc->uwb_dev;

	uwb_dev_init(uwb_dev);
	rc->uwb_dev.dev.class = &uwb_rc_class;
	rc->uwb_dev.dev.release = uwb_rc_sys_release;
	uwb_rc_neh_create(rc);
	rc->beaconing = -1;
	rc->scan_type = UWB_SCAN_DISABLED;
	INIT_LIST_HEAD(&rc->notifs_chain.list);
	mutex_init(&rc->notifs_chain.mutex);
	INIT_LIST_HEAD(&rc->uwb_beca.list);
	mutex_init(&rc->uwb_beca.mutex);
	uwb_drp_avail_init(rc);
	uwb_rc_ie_init(rc);
	uwb_rsv_init(rc);
	uwb_rc_pal_init(rc);
}
EXPORT_SYMBOL_GPL(uwb_rc_init);


struct uwb_rc *uwb_rc_alloc(void)
{
	struct uwb_rc *rc;
	rc = kzalloc(sizeof(*rc), GFP_KERNEL);
	if (rc == NULL)
		return NULL;
	uwb_rc_init(rc);
	return rc;
}
EXPORT_SYMBOL_GPL(uwb_rc_alloc);

static struct attribute *rc_attrs[] = {
		&dev_attr_mac_address.attr,
		&dev_attr_scan.attr,
		&dev_attr_beacon.attr,
		NULL,
};

static struct attribute_group rc_attr_group = {
	.attrs = rc_attrs,
};

/*
 * Registration of sysfs specific stuff
 */
static int uwb_rc_sys_add(struct uwb_rc *rc)
{
	return sysfs_create_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
}


static void __uwb_rc_sys_rm(struct uwb_rc *rc)
{
	sysfs_remove_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
}

/**
 * uwb_rc_mac_addr_setup - get an RC's EUI-48 address or set it
 * @rc:  the radio controller.
 *
 * If the EUI-48 address is 00:00:00:00:00:00 or FF:FF:FF:FF:FF:FF
 * then a random locally administered EUI-48 is generated and set on
 * the device.  The probability of address collisions is sufficiently
 * unlikely (1/2^40 = 9.1e-13) that they're not checked for.
 */
static
int uwb_rc_mac_addr_setup(struct uwb_rc *rc)
{
	int result;
	struct device *dev = &rc->uwb_dev.dev;
	struct uwb_dev *uwb_dev = &rc->uwb_dev;
	char devname[UWB_ADDR_STRSIZE];
	struct uwb_mac_addr addr;

	result = uwb_rc_mac_addr_get(rc, &addr);
	if (result < 0) {
		dev_err(dev, "cannot retrieve UWB EUI-48 address: %d\n", result);
		return result;
	}

	if (uwb_mac_addr_unset(&addr) || uwb_mac_addr_bcast(&addr)) {
		addr.data[0] = 0x02; /* locally administered and unicast */
		get_random_bytes(&addr.data[1], sizeof(addr.data)-1);

		result = uwb_rc_mac_addr_set(rc, &addr);
		if (result < 0) {
			uwb_mac_addr_print(devname, sizeof(devname), &addr);
			dev_err(dev, "cannot set EUI-48 address %s: %d\n",
				devname, result);
			return result;
		}
	}
	uwb_dev->mac_addr = addr;
	return 0;
}


static int uwb_rc_setup(struct uwb_rc *rc)
{
	int result;
	struct device *dev = &rc->uwb_dev.dev;

	result = uwb_radio_setup(rc);
	if (result < 0) {
		dev_err(dev, "cannot setup UWB radio: %d\n", result);
		goto error;
	}
	result = uwb_rc_mac_addr_setup(rc);
	if (result < 0) {
		dev_err(dev, "cannot setup UWB MAC address: %d\n", result);
		goto error;
	}
	result = uwb_rc_dev_addr_assign(rc);
	if (result < 0) {
		dev_err(dev, "cannot assign UWB DevAddr: %d\n", result);
		goto error;
	}
	result = uwb_rc_ie_setup(rc);
	if (result < 0) {
		dev_err(dev, "cannot setup IE subsystem: %d\n", result);
		goto error_ie_setup;
	}
	result = uwb_rsv_setup(rc);
	if (result < 0) {
		dev_err(dev, "cannot setup reservation subsystem: %d\n", result);
		goto error_rsv_setup;
	}
	uwb_dbg_add_rc(rc);
	return 0;

error_rsv_setup:
	uwb_rc_ie_release(rc);
error_ie_setup:
error:
	return result;
}


/**
 * Register a new UWB radio controller
 *
 * Did you call uwb_rc_init() on your rc?
 *
 * We assume that this is being called with a > 0 refcount on
 * it [through ops->{get|put}_device(). We'll take our own, though.
 *
 * @parent_dev is our real device, the one that provides the actual UWB device
 */
int uwb_rc_add(struct uwb_rc *rc, struct device *parent_dev, void *priv)
{
	int result;
	struct device *dev;
	char macbuf[UWB_ADDR_STRSIZE], devbuf[UWB_ADDR_STRSIZE];

	rc->index = uwb_rc_new_index();

	dev = &rc->uwb_dev.dev;
	dev_set_name(dev, "uwb%d", rc->index);

	rc->priv = priv;

	init_waitqueue_head(&rc->uwbd.wq);
	INIT_LIST_HEAD(&rc->uwbd.event_list);
	spin_lock_init(&rc->uwbd.event_list_lock);

	uwbd_start(rc);

	result = rc->start(rc);
	if (result < 0)
		goto error_rc_start;

	result = uwb_rc_setup(rc);
	if (result < 0) {
		dev_err(dev, "cannot setup UWB radio controller: %d\n", result);
		goto error_rc_setup;
	}

	result = uwb_dev_add(&rc->uwb_dev, parent_dev, rc);
	if (result < 0 && result != -EADDRNOTAVAIL)
		goto error_dev_add;

	result = uwb_rc_sys_add(rc);
	if (result < 0) {
		dev_err(parent_dev, "cannot register UWB radio controller "
			"dev attributes: %d\n", result);
		goto error_sys_add;
	}

	uwb_mac_addr_print(macbuf, sizeof(macbuf), &rc->uwb_dev.mac_addr);
	uwb_dev_addr_print(devbuf, sizeof(devbuf), &rc->uwb_dev.dev_addr);
	dev_info(dev,
		 "new uwb radio controller (mac %s dev %s) on %s %s\n",
		 macbuf, devbuf, parent_dev->bus->name, dev_name(parent_dev));
	rc->ready = 1;
	return 0;

error_sys_add:
	uwb_dev_rm(&rc->uwb_dev);
error_dev_add:
error_rc_setup:
	rc->stop(rc);
error_rc_start:
	uwbd_stop(rc);
	return result;
}
EXPORT_SYMBOL_GPL(uwb_rc_add);


static int uwb_dev_offair_helper(struct device *dev, void *priv)
{
	struct uwb_dev *uwb_dev = to_uwb_dev(dev);

	return __uwb_dev_offair(uwb_dev, uwb_dev->rc);
}

/*
 * Remove a Radio Controller; stop beaconing/scanning, disconnect all children
 */
void uwb_rc_rm(struct uwb_rc *rc)
{
	rc->ready = 0;

	uwb_dbg_del_rc(rc);
	uwb_rsv_remove_all(rc);
	uwb_radio_shutdown(rc);

	rc->stop(rc);

	uwbd_stop(rc);
	uwb_rc_neh_destroy(rc);

	uwb_dev_lock(&rc->uwb_dev);
	rc->priv = NULL;
	rc->cmd = NULL;
	uwb_dev_unlock(&rc->uwb_dev);
	mutex_lock(&rc->uwb_beca.mutex);
	uwb_dev_for_each(rc, uwb_dev_offair_helper, NULL);
	__uwb_rc_sys_rm(rc);
	mutex_unlock(&rc->uwb_beca.mutex);
	uwb_rsv_cleanup(rc);
 	uwb_beca_release(rc);
	uwb_dev_rm(&rc->uwb_dev);
}
EXPORT_SYMBOL_GPL(uwb_rc_rm);

static int find_rc_try_get(struct device *dev, void *data)
{
	struct uwb_rc *target_rc = data;
	struct uwb_rc *rc = dev_get_drvdata(dev);

	if (rc == NULL) {
		WARN_ON(1);
		return 0;
	}
	if (rc == target_rc) {
		if (rc->ready == 0)
			return 0;
		else
			return 1;
	}
	return 0;
}

/**
 * Given a radio controller descriptor, validate and refcount it
 *
 * @returns NULL if the rc does not exist or is quiescing; the ptr to
 *               it otherwise.
 */
struct uwb_rc *__uwb_rc_try_get(struct uwb_rc *target_rc)
{
	struct device *dev;
	struct uwb_rc *rc = NULL;

	dev = class_find_device(&uwb_rc_class, NULL, target_rc,
				find_rc_try_get);
	if (dev) {
		rc = dev_get_drvdata(dev);
		__uwb_rc_get(rc);
	}
	return rc;
}
EXPORT_SYMBOL_GPL(__uwb_rc_try_get);

/*
 * RC get for external refcount acquirers...
 *
 * Increments the refcount of the device and it's backend modules
 */
static inline struct uwb_rc *uwb_rc_get(struct uwb_rc *rc)
{
	if (rc->ready == 0)
		return NULL;
	uwb_dev_get(&rc->uwb_dev);
	return rc;
}

static int find_rc_grandpa(struct device *dev, void *data)
{
	struct device *grandpa_dev = data;
	struct uwb_rc *rc = dev_get_drvdata(dev);

	if (rc->uwb_dev.dev.parent->parent == grandpa_dev) {
		rc = uwb_rc_get(rc);
		return 1;
	}
	return 0;
}

/**
 * Locate and refcount a radio controller given a common grand-parent
 *
 * @grandpa_dev  Pointer to the 'grandparent' device structure.
 * @returns NULL If the rc does not exist or is quiescing; the ptr to
 *               it otherwise, properly referenced.
 *
 * The Radio Control interface (or the UWB Radio Controller) is always
 * an interface of a device. The parent is the interface, the
 * grandparent is the device that encapsulates the interface.
 *
 * There is no need to lock around as the "grandpa" would be
 * refcounted by the target, and to remove the referemes, the
 * uwb_rc_class->sem would have to be taken--we hold it, ergo we
 * should be safe.
 */
struct uwb_rc *uwb_rc_get_by_grandpa(const struct device *grandpa_dev)
{
	struct device *dev;
	struct uwb_rc *rc = NULL;

	dev = class_find_device(&uwb_rc_class, NULL, (void *)grandpa_dev,
				find_rc_grandpa);
	if (dev)
		rc = dev_get_drvdata(dev);
	return rc;
}
EXPORT_SYMBOL_GPL(uwb_rc_get_by_grandpa);

/**
 * Find a radio controller by device address
 *
 * @returns the pointer to the radio controller, properly referenced
 */
static int find_rc_dev(struct device *dev, void *data)
{
	struct uwb_dev_addr *addr = data;
	struct uwb_rc *rc = dev_get_drvdata(dev);

	if (rc == NULL) {
		WARN_ON(1);
		return 0;
	}
	if (!uwb_dev_addr_cmp(&rc->uwb_dev.dev_addr, addr)) {
		rc = uwb_rc_get(rc);
		return 1;
	}
	return 0;
}

struct uwb_rc *uwb_rc_get_by_dev(const struct uwb_dev_addr *addr)
{
	struct device *dev;
	struct uwb_rc *rc = NULL;

	dev = class_find_device(&uwb_rc_class, NULL, (void *)addr,
				find_rc_dev);
	if (dev)
		rc = dev_get_drvdata(dev);

	return rc;
}
EXPORT_SYMBOL_GPL(uwb_rc_get_by_dev);

/**
 * Drop a reference on a radio controller
 *
 * This is the version that should be done by entities external to the
 * UWB Radio Control stack (ie: clients of the API).
 */
void uwb_rc_put(struct uwb_rc *rc)
{
	__uwb_rc_put(rc);
}
EXPORT_SYMBOL_GPL(uwb_rc_put);
Commit	Line	Data
183b9b59 IPG	1	/*
	2	* Ultra Wide Band
	3	* Life cycle of radio controllers
	4	*
	5	* Copyright (C) 2005-2006 Intel Corporation
	6	* Inaky Perez-Gonzalez <[email protected]>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License version
	10	* 2 as published by the Free Software Foundation.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	20	* 02110-1301, USA.
	21	*
	22	*
	23	* FIXME: docs
	24	*
	25	* A UWB radio controller is also a UWB device, so it embeds one...
	26	*
	27	* List of RCs comes from the 'struct class uwb_rc_class'.
	28	*/
	29
	30	#include <linux/kernel.h>
	31	#include <linux/string.h>
	32	#include <linux/device.h>
	33	#include <linux/err.h>
	34	#include <linux/random.h>
	35	#include <linux/kdev_t.h>
	36	#include <linux/etherdevice.h>
	37	#include <linux/usb.h>
5a0e3ad6	38	#include <linux/slab.h>
475c0a6b	39	#include <linux/export.h>
183b9b59	40
183b9b59 IPG	41	#include "uwb-internal.h"
	42
	43	static int uwb_rc_index_match(struct device dev, void data)
	44	{
	45	int *index = data;
	46	struct uwb_rc *rc = dev_get_drvdata(dev);
	47
	48	if (rc->index == *index)
	49	return 1;
	50	return 0;
	51	}
	52
	53	static struct uwb_rc *uwb_rc_find_by_index(int index)
	54	{
	55	struct device *dev;
	56	struct uwb_rc *rc = NULL;
	57
	58	dev = class_find_device(&uwb_rc_class, NULL, &index, uwb_rc_index_match);
	59	if (dev)
	60	rc = dev_get_drvdata(dev);
	61	return rc;
	62	}
	63
	64	static int uwb_rc_new_index(void)
	65	{
	66	int index = 0;
	67
	68	for (;;) {
	69	if (!uwb_rc_find_by_index(index))
	70	return index;
	71	if (++index < 0)
	72	index = 0;
	73	}
	74	}
	75
	76	/**
	77	* Release the backing device of a uwb_rc that has been dynamically allocated.
	78	*/
	79	static void uwb_rc_sys_release(struct device *dev)
	80	{
	81	struct uwb_dev *uwb_dev = container_of(dev, struct uwb_dev, dev);
	82	struct uwb_rc *rc = container_of(uwb_dev, struct uwb_rc, uwb_dev);
	83
183b9b59	84	uwb_rc_ie_release(rc);
183b9b59 IPG	85	kfree(rc);
	86	}
	87
	88
	89	void uwb_rc_init(struct uwb_rc *rc)
	90	{
	91	struct uwb_dev *uwb_dev = &rc->uwb_dev;
	92
	93	uwb_dev_init(uwb_dev);
	94	rc->uwb_dev.dev.class = &uwb_rc_class;
	95	rc->uwb_dev.dev.release = uwb_rc_sys_release;
	96	uwb_rc_neh_create(rc);
	97	rc->beaconing = -1;
	98	rc->scan_type = UWB_SCAN_DISABLED;
	99	INIT_LIST_HEAD(&rc->notifs_chain.list);
	100	mutex_init(&rc->notifs_chain.mutex);
fec1a593 SP	101	INIT_LIST_HEAD(&rc->uwb_beca.list);
fec1a593 SP	102	mutex_init(&rc->uwb_beca.mutex);
183b9b59 IPG	103	uwb_drp_avail_init(rc);
	104	uwb_rc_ie_init(rc);
	105	uwb_rsv_init(rc);
	106	uwb_rc_pal_init(rc);
	107	}
	108	EXPORT_SYMBOL_GPL(uwb_rc_init);
	109
	110
	111	struct uwb_rc *uwb_rc_alloc(void)
	112	{
	113	struct uwb_rc *rc;
	114	rc = kzalloc(sizeof(*rc), GFP_KERNEL);
	115	if (rc == NULL)
	116	return NULL;
	117	uwb_rc_init(rc);
	118	return rc;
	119	}
	120	EXPORT_SYMBOL_GPL(uwb_rc_alloc);
	121
	122	static struct attribute *rc_attrs[] = {
	123	&dev_attr_mac_address.attr,
	124	&dev_attr_scan.attr,
	125	&dev_attr_beacon.attr,
	126	NULL,
	127	};
	128
	129	static struct attribute_group rc_attr_group = {
	130	.attrs = rc_attrs,
	131	};
	132
	133	/*
	134	* Registration of sysfs specific stuff
	135	*/
	136	static int uwb_rc_sys_add(struct uwb_rc *rc)
	137	{
	138	return sysfs_create_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
	139	}
	140
	141
	142	static void __uwb_rc_sys_rm(struct uwb_rc *rc)
	143	{
	144	sysfs_remove_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
	145	}
	146
	147	/**
	148	* uwb_rc_mac_addr_setup - get an RC's EUI-48 address or set it
	149	* @rc: the radio controller.
	150	*
	151	* If the EUI-48 address is 00:00:00:00:00:00 or FF:FF:FF:FF:FF:FF
	152	* then a random locally administered EUI-48 is generated and set on
	153	* the device. The probability of address collisions is sufficiently
	154	* unlikely (1/2^40 = 9.1e-13) that they're not checked for.
	155	*/
	156	static
	157	int uwb_rc_mac_addr_setup(struct uwb_rc *rc)
	158	{
	159	int result;
	160	struct device *dev = &rc->uwb_dev.dev;
	161	struct uwb_dev *uwb_dev = &rc->uwb_dev;
	162	char devname[UWB_ADDR_STRSIZE];
	163	struct uwb_mac_addr addr;
	164
	165	result = uwb_rc_mac_addr_get(rc, &addr);
	166	if (result < 0) {
167	dev_err(dev, "cannot retrieve UWB EUI-48 address: %d\n", result);
168	return result;
169	}
170
171	if (uwb_mac_addr_unset(&addr) \|\| uwb_mac_addr_bcast(&addr)) {
25985edc	172	addr.data[0] = 0x02; /* locally administered and unicast */
183b9b59 IPG	173	get_random_bytes(&addr.data[1], sizeof(addr.data)-1);
	174
	175	result = uwb_rc_mac_addr_set(rc, &addr);
	176	if (result < 0) {
	177	uwb_mac_addr_print(devname, sizeof(devname), &addr);
	178	dev_err(dev, "cannot set EUI-48 address %s: %d\n",
	179	devname, result);
	180	return result;
	181	}
	182	}
	183	uwb_dev->mac_addr = addr;
	184	return 0;
	185	}
	186
	187
	188
	189	static int uwb_rc_setup(struct uwb_rc *rc)
	190	{
	191	int result;
	192	struct device *dev = &rc->uwb_dev.dev;
	193
6fae35f9	194	result = uwb_radio_setup(rc);
183b9b59	195	if (result < 0) {
6fae35f9	196	dev_err(dev, "cannot setup UWB radio: %d\n", result);
183b9b59 IPG	197	goto error;
	198	}
	199	result = uwb_rc_mac_addr_setup(rc);
	200	if (result < 0) {
	201	dev_err(dev, "cannot setup UWB MAC address: %d\n", result);
	202	goto error;
	203	}
	204	result = uwb_rc_dev_addr_assign(rc);
	205	if (result < 0) {
	206	dev_err(dev, "cannot assign UWB DevAddr: %d\n", result);
	207	goto error;
	208	}
	209	result = uwb_rc_ie_setup(rc);
	210	if (result < 0) {
	211	dev_err(dev, "cannot setup IE subsystem: %d\n", result);
	212	goto error_ie_setup;
	213	}
183b9b59 IPG	214	result = uwb_rsv_setup(rc);
	215	if (result < 0) {
	216	dev_err(dev, "cannot setup reservation subsystem: %d\n", result);
	217	goto error_rsv_setup;
	218	}
	219	uwb_dbg_add_rc(rc);
	220	return 0;
	221
	222	error_rsv_setup:
	223	uwb_rc_ie_release(rc);
	224	error_ie_setup:
	225	error:
	226	return result;
	227	}
	228
	229
	230	/**
	231	* Register a new UWB radio controller
	232	*
	233	* Did you call uwb_rc_init() on your rc?
	234	*
	235	* We assume that this is being called with a > 0 refcount on
	236	* it [through ops->{get\|put}_device(). We'll take our own, though.
	237	*
	238	* @parent_dev is our real device, the one that provides the actual UWB device
	239	*/
	240	int uwb_rc_add(struct uwb_rc rc, struct device parent_dev, void *priv)
	241	{
	242	int result;
	243	struct device *dev;
	244	char macbuf[UWB_ADDR_STRSIZE], devbuf[UWB_ADDR_STRSIZE];
	245
	246	rc->index = uwb_rc_new_index();
	247
	248	dev = &rc->uwb_dev.dev;
	249	dev_set_name(dev, "uwb%d", rc->index);
	250
	251	rc->priv = priv;
	252
fec1a593 SP	253	init_waitqueue_head(&rc->uwbd.wq);
	254	INIT_LIST_HEAD(&rc->uwbd.event_list);
	255	spin_lock_init(&rc->uwbd.event_list_lock);
	256
	257	uwbd_start(rc);
	258
183b9b59 IPG	259	result = rc->start(rc);
	260	if (result < 0)
	261	goto error_rc_start;
	262
	263	result = uwb_rc_setup(rc);
	264	if (result < 0) {
	265	dev_err(dev, "cannot setup UWB radio controller: %d\n", result);
	266	goto error_rc_setup;
	267	}
	268
	269	result = uwb_dev_add(&rc->uwb_dev, parent_dev, rc);
	270	if (result < 0 && result != -EADDRNOTAVAIL)
	271	goto error_dev_add;
	272
	273	result = uwb_rc_sys_add(rc);
	274	if (result < 0) {
	275	dev_err(parent_dev, "cannot register UWB radio controller "
	276	"dev attributes: %d\n", result);
	277	goto error_sys_add;
	278	}
	279
	280	uwb_mac_addr_print(macbuf, sizeof(macbuf), &rc->uwb_dev.mac_addr);
	281	uwb_dev_addr_print(devbuf, sizeof(devbuf), &rc->uwb_dev.dev_addr);
	282	dev_info(dev,
	283	"new uwb radio controller (mac %s dev %s) on %s %s\n",
	284	macbuf, devbuf, parent_dev->bus->name, dev_name(parent_dev));
	285	rc->ready = 1;
	286	return 0;
	287
	288	error_sys_add:
	289	uwb_dev_rm(&rc->uwb_dev);
	290	error_dev_add:
	291	error_rc_setup:
	292	rc->stop(rc);
183b9b59	293	error_rc_start:
a9e75a38	294	uwbd_stop(rc);
183b9b59 IPG	295	return result;
	296	}
	297	EXPORT_SYMBOL_GPL(uwb_rc_add);
	298
	299
	300	static int uwb_dev_offair_helper(struct device dev, void priv)
	301	{
	302	struct uwb_dev *uwb_dev = to_uwb_dev(dev);
	303
	304	return __uwb_dev_offair(uwb_dev, uwb_dev->rc);
	305	}
	306
	307	/*
	308	* Remove a Radio Controller; stop beaconing/scanning, disconnect all children
	309	*/
	310	void uwb_rc_rm(struct uwb_rc *rc)
	311	{
	312	rc->ready = 0;
	313
	314	uwb_dbg_del_rc(rc);
58be81ed	315	uwb_rsv_remove_all(rc);
6fae35f9	316	uwb_radio_shutdown(rc);
183b9b59 IPG	317
183b9b59 IPG	318	rc->stop(rc);
fec1a593 SP	319
fec1a593 SP	320	uwbd_stop(rc);
58be81ed	321	uwb_rc_neh_destroy(rc);
183b9b59 IPG	322
	323	uwb_dev_lock(&rc->uwb_dev);
	324	rc->priv = NULL;
	325	rc->cmd = NULL;
	326	uwb_dev_unlock(&rc->uwb_dev);
fec1a593	327	mutex_lock(&rc->uwb_beca.mutex);
183b9b59 IPG	328	uwb_dev_for_each(rc, uwb_dev_offair_helper, NULL);
183b9b59 IPG	329	__uwb_rc_sys_rm(rc);
fec1a593	330	mutex_unlock(&rc->uwb_beca.mutex);
58be81ed	331	uwb_rsv_cleanup(rc);
fec1a593	332	uwb_beca_release(rc);
183b9b59 IPG	333	uwb_dev_rm(&rc->uwb_dev);
	334	}
	335	EXPORT_SYMBOL_GPL(uwb_rc_rm);
	336
	337	static int find_rc_try_get(struct device dev, void data)
	338	{
	339	struct uwb_rc *target_rc = data;
	340	struct uwb_rc *rc = dev_get_drvdata(dev);
	341
	342	if (rc == NULL) {
	343	WARN_ON(1);
	344	return 0;
	345	}
	346	if (rc == target_rc) {
	347	if (rc->ready == 0)
	348	return 0;
	349	else
	350	return 1;
	351	}
	352	return 0;
	353	}
	354
	355	/**
	356	* Given a radio controller descriptor, validate and refcount it
	357	*
	358	* @returns NULL if the rc does not exist or is quiescing; the ptr to
	359	* it otherwise.
	360	*/
	361	struct uwb_rc __uwb_rc_try_get(struct uwb_rc target_rc)
	362	{
	363	struct device *dev;
	364	struct uwb_rc *rc = NULL;
	365
	366	dev = class_find_device(&uwb_rc_class, NULL, target_rc,
	367	find_rc_try_get);
	368	if (dev) {
	369	rc = dev_get_drvdata(dev);
	370	__uwb_rc_get(rc);
	371	}
	372	return rc;
	373	}
	374	EXPORT_SYMBOL_GPL(__uwb_rc_try_get);
	375
	376	/*
	377	* RC get for external refcount acquirers...
	378	*
	379	* Increments the refcount of the device and it's backend modules
	380	*/
	381	static inline struct uwb_rc uwb_rc_get(struct uwb_rc rc)
	382	{
	383	if (rc->ready == 0)
	384	return NULL;
	385	uwb_dev_get(&rc->uwb_dev);
	386	return rc;
	387	}
	388
	389	static int find_rc_grandpa(struct device dev, void data)
	390	{
	391	struct device *grandpa_dev = data;
	392	struct uwb_rc *rc = dev_get_drvdata(dev);
	393
	394	if (rc->uwb_dev.dev.parent->parent == grandpa_dev) {
	395	rc = uwb_rc_get(rc);
	396	return 1;
397	}
398	return 0;
399	}
400
401	/**
402	* Locate and refcount a radio controller given a common grand-parent
403	*
404	* @grandpa_dev Pointer to the 'grandparent' device structure.
405	* @returns NULL If the rc does not exist or is quiescing; the ptr to
406	* it otherwise, properly referenced.
407	*
408	* The Radio Control interface (or the UWB Radio Controller) is always
409	* an interface of a device. The parent is the interface, the
410	* grandparent is the device that encapsulates the interface.
411	*
412	* There is no need to lock around as the "grandpa" would be
413	* refcounted by the target, and to remove the referemes, the
414	* uwb_rc_class->sem would have to be taken--we hold it, ergo we
415	* should be safe.
416	*/
417	struct uwb_rc uwb_rc_get_by_grandpa(const struct device grandpa_dev)
418	{
419	struct device *dev;
420	struct uwb_rc *rc = NULL;
421
422	dev = class_find_device(&uwb_rc_class, NULL, (void *)grandpa_dev,
423	find_rc_grandpa);
424	if (dev)
425	rc = dev_get_drvdata(dev);
426	return rc;
427	}
428	EXPORT_SYMBOL_GPL(uwb_rc_get_by_grandpa);
429
430	/**
431	* Find a radio controller by device address
432	*
433	* @returns the pointer to the radio controller, properly referenced
434	*/
435	static int find_rc_dev(struct device dev, void data)
436	{
437	struct uwb_dev_addr *addr = data;
438	struct uwb_rc *rc = dev_get_drvdata(dev);
439
440	if (rc == NULL) {
441	WARN_ON(1);
442	return 0;
443	}
444	if (!uwb_dev_addr_cmp(&rc->uwb_dev.dev_addr, addr)) {
445	rc = uwb_rc_get(rc);
446	return 1;
447	}
448	return 0;
449	}
450
451	struct uwb_rc uwb_rc_get_by_dev(const struct uwb_dev_addr addr)
452	{
453	struct device *dev;
454	struct uwb_rc *rc = NULL;
455
456	dev = class_find_device(&uwb_rc_class, NULL, (void *)addr,
457	find_rc_dev);
458	if (dev)
459	rc = dev_get_drvdata(dev);
460
461	return rc;
462	}
463	EXPORT_SYMBOL_GPL(uwb_rc_get_by_dev);
464
465	/**
466	* Drop a reference on a radio controller
467	*
468	* This is the version that should be done by entities external to the
469	* UWB Radio Control stack (ie: clients of the API).
470	*/
471	void uwb_rc_put(struct uwb_rc *rc)
472	{
473	__uwb_rc_put(rc);
474	}
475	EXPORT_SYMBOL_GPL(uwb_rc_put);