3 * Life cycle of radio controllers
5 * Copyright (C) 2005-2006 Intel Corporation
6 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
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.
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.
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
25 * A UWB radio controller is also a UWB device, so it embeds one...
27 * List of RCs comes from the 'struct class uwb_rc_class'.
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>
38 #include <linux/slab.h>
40 #include "uwb-internal.h"
42 static int uwb_rc_index_match(struct device *dev, void *data)
45 struct uwb_rc *rc = dev_get_drvdata(dev);
47 if (rc->index == *index)
52 static struct uwb_rc *uwb_rc_find_by_index(int index)
55 struct uwb_rc *rc = NULL;
57 dev = class_find_device(&uwb_rc_class, NULL, &index, uwb_rc_index_match);
59 rc = dev_get_drvdata(dev);
63 static int uwb_rc_new_index(void)
68 if (!uwb_rc_find_by_index(index))
76 * Release the backing device of a uwb_rc that has been dynamically allocated.
78 static void uwb_rc_sys_release(struct device *dev)
80 struct uwb_dev *uwb_dev = container_of(dev, struct uwb_dev, dev);
81 struct uwb_rc *rc = container_of(uwb_dev, struct uwb_rc, uwb_dev);
83 uwb_rc_ie_release(rc);
88 void uwb_rc_init(struct uwb_rc *rc)
90 struct uwb_dev *uwb_dev = &rc->uwb_dev;
92 uwb_dev_init(uwb_dev);
93 rc->uwb_dev.dev.class = &uwb_rc_class;
94 rc->uwb_dev.dev.release = uwb_rc_sys_release;
95 uwb_rc_neh_create(rc);
97 rc->scan_type = UWB_SCAN_DISABLED;
98 INIT_LIST_HEAD(&rc->notifs_chain.list);
99 mutex_init(&rc->notifs_chain.mutex);
100 INIT_LIST_HEAD(&rc->uwb_beca.list);
101 mutex_init(&rc->uwb_beca.mutex);
102 uwb_drp_avail_init(rc);
107 EXPORT_SYMBOL_GPL(uwb_rc_init);
110 struct uwb_rc *uwb_rc_alloc(void)
113 rc = kzalloc(sizeof(*rc), GFP_KERNEL);
119 EXPORT_SYMBOL_GPL(uwb_rc_alloc);
121 static struct attribute *rc_attrs[] = {
122 &dev_attr_mac_address.attr,
124 &dev_attr_beacon.attr,
128 static struct attribute_group rc_attr_group = {
133 * Registration of sysfs specific stuff
135 static int uwb_rc_sys_add(struct uwb_rc *rc)
137 return sysfs_create_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
141 static void __uwb_rc_sys_rm(struct uwb_rc *rc)
143 sysfs_remove_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
147 * uwb_rc_mac_addr_setup - get an RC's EUI-48 address or set it
148 * @rc: the radio controller.
150 * If the EUI-48 address is 00:00:00:00:00:00 or FF:FF:FF:FF:FF:FF
151 * then a random locally administered EUI-48 is generated and set on
152 * the device. The probability of address collisions is sufficiently
153 * unlikely (1/2^40 = 9.1e-13) that they're not checked for.
156 int uwb_rc_mac_addr_setup(struct uwb_rc *rc)
159 struct device *dev = &rc->uwb_dev.dev;
160 struct uwb_dev *uwb_dev = &rc->uwb_dev;
161 char devname[UWB_ADDR_STRSIZE];
162 struct uwb_mac_addr addr;
164 result = uwb_rc_mac_addr_get(rc, &addr);
166 dev_err(dev, "cannot retrieve UWB EUI-48 address: %d\n", result);
170 if (uwb_mac_addr_unset(&addr) || uwb_mac_addr_bcast(&addr)) {
171 addr.data[0] = 0x02; /* locally adminstered and unicast */
172 get_random_bytes(&addr.data[1], sizeof(addr.data)-1);
174 result = uwb_rc_mac_addr_set(rc, &addr);
176 uwb_mac_addr_print(devname, sizeof(devname), &addr);
177 dev_err(dev, "cannot set EUI-48 address %s: %d\n",
182 uwb_dev->mac_addr = addr;
188 static int uwb_rc_setup(struct uwb_rc *rc)
191 struct device *dev = &rc->uwb_dev.dev;
193 result = uwb_radio_setup(rc);
195 dev_err(dev, "cannot setup UWB radio: %d\n", result);
198 result = uwb_rc_mac_addr_setup(rc);
200 dev_err(dev, "cannot setup UWB MAC address: %d\n", result);
203 result = uwb_rc_dev_addr_assign(rc);
205 dev_err(dev, "cannot assign UWB DevAddr: %d\n", result);
208 result = uwb_rc_ie_setup(rc);
210 dev_err(dev, "cannot setup IE subsystem: %d\n", result);
213 result = uwb_rsv_setup(rc);
215 dev_err(dev, "cannot setup reservation subsystem: %d\n", result);
216 goto error_rsv_setup;
222 uwb_rc_ie_release(rc);
230 * Register a new UWB radio controller
232 * Did you call uwb_rc_init() on your rc?
234 * We assume that this is being called with a > 0 refcount on
235 * it [through ops->{get|put}_device(). We'll take our own, though.
237 * @parent_dev is our real device, the one that provides the actual UWB device
239 int uwb_rc_add(struct uwb_rc *rc, struct device *parent_dev, void *priv)
243 char macbuf[UWB_ADDR_STRSIZE], devbuf[UWB_ADDR_STRSIZE];
245 rc->index = uwb_rc_new_index();
247 dev = &rc->uwb_dev.dev;
248 dev_set_name(dev, "uwb%d", rc->index);
252 init_waitqueue_head(&rc->uwbd.wq);
253 INIT_LIST_HEAD(&rc->uwbd.event_list);
254 spin_lock_init(&rc->uwbd.event_list_lock);
258 result = rc->start(rc);
262 result = uwb_rc_setup(rc);
264 dev_err(dev, "cannot setup UWB radio controller: %d\n", result);
268 result = uwb_dev_add(&rc->uwb_dev, parent_dev, rc);
269 if (result < 0 && result != -EADDRNOTAVAIL)
272 result = uwb_rc_sys_add(rc);
274 dev_err(parent_dev, "cannot register UWB radio controller "
275 "dev attributes: %d\n", result);
279 uwb_mac_addr_print(macbuf, sizeof(macbuf), &rc->uwb_dev.mac_addr);
280 uwb_dev_addr_print(devbuf, sizeof(devbuf), &rc->uwb_dev.dev_addr);
282 "new uwb radio controller (mac %s dev %s) on %s %s\n",
283 macbuf, devbuf, parent_dev->bus->name, dev_name(parent_dev));
288 uwb_dev_rm(&rc->uwb_dev);
296 EXPORT_SYMBOL_GPL(uwb_rc_add);
299 static int uwb_dev_offair_helper(struct device *dev, void *priv)
301 struct uwb_dev *uwb_dev = to_uwb_dev(dev);
303 return __uwb_dev_offair(uwb_dev, uwb_dev->rc);
307 * Remove a Radio Controller; stop beaconing/scanning, disconnect all children
309 void uwb_rc_rm(struct uwb_rc *rc)
314 uwb_rsv_remove_all(rc);
315 uwb_radio_shutdown(rc);
320 uwb_rc_neh_destroy(rc);
322 uwb_dev_lock(&rc->uwb_dev);
325 uwb_dev_unlock(&rc->uwb_dev);
326 mutex_lock(&rc->uwb_beca.mutex);
327 uwb_dev_for_each(rc, uwb_dev_offair_helper, NULL);
329 mutex_unlock(&rc->uwb_beca.mutex);
331 uwb_beca_release(rc);
332 uwb_dev_rm(&rc->uwb_dev);
334 EXPORT_SYMBOL_GPL(uwb_rc_rm);
336 static int find_rc_try_get(struct device *dev, void *data)
338 struct uwb_rc *target_rc = data;
339 struct uwb_rc *rc = dev_get_drvdata(dev);
345 if (rc == target_rc) {
355 * Given a radio controller descriptor, validate and refcount it
357 * @returns NULL if the rc does not exist or is quiescing; the ptr to
360 struct uwb_rc *__uwb_rc_try_get(struct uwb_rc *target_rc)
363 struct uwb_rc *rc = NULL;
365 dev = class_find_device(&uwb_rc_class, NULL, target_rc,
368 rc = dev_get_drvdata(dev);
373 EXPORT_SYMBOL_GPL(__uwb_rc_try_get);
376 * RC get for external refcount acquirers...
378 * Increments the refcount of the device and it's backend modules
380 static inline struct uwb_rc *uwb_rc_get(struct uwb_rc *rc)
384 uwb_dev_get(&rc->uwb_dev);
388 static int find_rc_grandpa(struct device *dev, void *data)
390 struct device *grandpa_dev = data;
391 struct uwb_rc *rc = dev_get_drvdata(dev);
393 if (rc->uwb_dev.dev.parent->parent == grandpa_dev) {
401 * Locate and refcount a radio controller given a common grand-parent
403 * @grandpa_dev Pointer to the 'grandparent' device structure.
404 * @returns NULL If the rc does not exist or is quiescing; the ptr to
405 * it otherwise, properly referenced.
407 * The Radio Control interface (or the UWB Radio Controller) is always
408 * an interface of a device. The parent is the interface, the
409 * grandparent is the device that encapsulates the interface.
411 * There is no need to lock around as the "grandpa" would be
412 * refcounted by the target, and to remove the referemes, the
413 * uwb_rc_class->sem would have to be taken--we hold it, ergo we
416 struct uwb_rc *uwb_rc_get_by_grandpa(const struct device *grandpa_dev)
419 struct uwb_rc *rc = NULL;
421 dev = class_find_device(&uwb_rc_class, NULL, (void *)grandpa_dev,
424 rc = dev_get_drvdata(dev);
427 EXPORT_SYMBOL_GPL(uwb_rc_get_by_grandpa);
430 * Find a radio controller by device address
432 * @returns the pointer to the radio controller, properly referenced
434 static int find_rc_dev(struct device *dev, void *data)
436 struct uwb_dev_addr *addr = data;
437 struct uwb_rc *rc = dev_get_drvdata(dev);
443 if (!uwb_dev_addr_cmp(&rc->uwb_dev.dev_addr, addr)) {
450 struct uwb_rc *uwb_rc_get_by_dev(const struct uwb_dev_addr *addr)
453 struct uwb_rc *rc = NULL;
455 dev = class_find_device(&uwb_rc_class, NULL, (void *)addr,
458 rc = dev_get_drvdata(dev);
462 EXPORT_SYMBOL_GPL(uwb_rc_get_by_dev);
465 * Drop a reference on a radio controller
467 * This is the version that should be done by entities external to the
468 * UWB Radio Control stack (ie: clients of the API).
470 void uwb_rc_put(struct uwb_rc *rc)
474 EXPORT_SYMBOL_GPL(uwb_rc_put);