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>
39 #include <linux/export.h>
41 #include "uwb-internal.h"
43 static int uwb_rc_index_match(struct device *dev, void *data)
46 struct uwb_rc *rc = dev_get_drvdata(dev);
48 if (rc->index == *index)
53 static struct uwb_rc *uwb_rc_find_by_index(int index)
56 struct uwb_rc *rc = NULL;
58 dev = class_find_device(&uwb_rc_class, NULL, &index, uwb_rc_index_match);
60 rc = dev_get_drvdata(dev);
67 static int uwb_rc_new_index(void)
72 if (!uwb_rc_find_by_index(index))
80 * Release the backing device of a uwb_rc that has been dynamically allocated.
82 static void uwb_rc_sys_release(struct device *dev)
84 struct uwb_dev *uwb_dev = container_of(dev, struct uwb_dev, dev);
85 struct uwb_rc *rc = container_of(uwb_dev, struct uwb_rc, uwb_dev);
87 uwb_rc_ie_release(rc);
92 void uwb_rc_init(struct uwb_rc *rc)
94 struct uwb_dev *uwb_dev = &rc->uwb_dev;
96 uwb_dev_init(uwb_dev);
97 rc->uwb_dev.dev.class = &uwb_rc_class;
98 rc->uwb_dev.dev.release = uwb_rc_sys_release;
99 uwb_rc_neh_create(rc);
101 rc->scan_type = UWB_SCAN_DISABLED;
102 INIT_LIST_HEAD(&rc->notifs_chain.list);
103 mutex_init(&rc->notifs_chain.mutex);
104 INIT_LIST_HEAD(&rc->uwb_beca.list);
105 mutex_init(&rc->uwb_beca.mutex);
106 uwb_drp_avail_init(rc);
111 EXPORT_SYMBOL_GPL(uwb_rc_init);
114 struct uwb_rc *uwb_rc_alloc(void)
117 rc = kzalloc(sizeof(*rc), GFP_KERNEL);
123 EXPORT_SYMBOL_GPL(uwb_rc_alloc);
125 static struct attribute *rc_attrs[] = {
126 &dev_attr_mac_address.attr,
128 &dev_attr_beacon.attr,
132 static struct attribute_group rc_attr_group = {
137 * Registration of sysfs specific stuff
139 static int uwb_rc_sys_add(struct uwb_rc *rc)
141 return sysfs_create_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
145 static void __uwb_rc_sys_rm(struct uwb_rc *rc)
147 sysfs_remove_group(&rc->uwb_dev.dev.kobj, &rc_attr_group);
151 * uwb_rc_mac_addr_setup - get an RC's EUI-48 address or set it
152 * @rc: the radio controller.
154 * If the EUI-48 address is 00:00:00:00:00:00 or FF:FF:FF:FF:FF:FF
155 * then a random locally administered EUI-48 is generated and set on
156 * the device. The probability of address collisions is sufficiently
157 * unlikely (1/2^40 = 9.1e-13) that they're not checked for.
160 int uwb_rc_mac_addr_setup(struct uwb_rc *rc)
163 struct device *dev = &rc->uwb_dev.dev;
164 struct uwb_dev *uwb_dev = &rc->uwb_dev;
165 char devname[UWB_ADDR_STRSIZE];
166 struct uwb_mac_addr addr;
168 result = uwb_rc_mac_addr_get(rc, &addr);
170 dev_err(dev, "cannot retrieve UWB EUI-48 address: %d\n", result);
174 if (uwb_mac_addr_unset(&addr) || uwb_mac_addr_bcast(&addr)) {
175 addr.data[0] = 0x02; /* locally administered and unicast */
176 get_random_bytes(&addr.data[1], sizeof(addr.data)-1);
178 result = uwb_rc_mac_addr_set(rc, &addr);
180 uwb_mac_addr_print(devname, sizeof(devname), &addr);
181 dev_err(dev, "cannot set EUI-48 address %s: %d\n",
186 uwb_dev->mac_addr = addr;
192 static int uwb_rc_setup(struct uwb_rc *rc)
195 struct device *dev = &rc->uwb_dev.dev;
197 result = uwb_radio_setup(rc);
199 dev_err(dev, "cannot setup UWB radio: %d\n", result);
202 result = uwb_rc_mac_addr_setup(rc);
204 dev_err(dev, "cannot setup UWB MAC address: %d\n", result);
207 result = uwb_rc_dev_addr_assign(rc);
209 dev_err(dev, "cannot assign UWB DevAddr: %d\n", result);
212 result = uwb_rc_ie_setup(rc);
214 dev_err(dev, "cannot setup IE subsystem: %d\n", result);
217 result = uwb_rsv_setup(rc);
219 dev_err(dev, "cannot setup reservation subsystem: %d\n", result);
220 goto error_rsv_setup;
226 uwb_rc_ie_release(rc);
234 * Register a new UWB radio controller
236 * Did you call uwb_rc_init() on your rc?
238 * We assume that this is being called with a > 0 refcount on
239 * it [through ops->{get|put}_device(). We'll take our own, though.
241 * @parent_dev is our real device, the one that provides the actual UWB device
243 int uwb_rc_add(struct uwb_rc *rc, struct device *parent_dev, void *priv)
247 char macbuf[UWB_ADDR_STRSIZE], devbuf[UWB_ADDR_STRSIZE];
249 rc->index = uwb_rc_new_index();
251 dev = &rc->uwb_dev.dev;
252 dev_set_name(dev, "uwb%d", rc->index);
256 init_waitqueue_head(&rc->uwbd.wq);
257 INIT_LIST_HEAD(&rc->uwbd.event_list);
258 spin_lock_init(&rc->uwbd.event_list_lock);
262 result = rc->start(rc);
266 result = uwb_rc_setup(rc);
268 dev_err(dev, "cannot setup UWB radio controller: %d\n", result);
272 result = uwb_dev_add(&rc->uwb_dev, parent_dev, rc);
273 if (result < 0 && result != -EADDRNOTAVAIL)
276 result = uwb_rc_sys_add(rc);
278 dev_err(parent_dev, "cannot register UWB radio controller "
279 "dev attributes: %d\n", result);
283 uwb_mac_addr_print(macbuf, sizeof(macbuf), &rc->uwb_dev.mac_addr);
284 uwb_dev_addr_print(devbuf, sizeof(devbuf), &rc->uwb_dev.dev_addr);
286 "new uwb radio controller (mac %s dev %s) on %s %s\n",
287 macbuf, devbuf, parent_dev->bus->name, dev_name(parent_dev));
292 uwb_dev_rm(&rc->uwb_dev);
300 EXPORT_SYMBOL_GPL(uwb_rc_add);
303 static int uwb_dev_offair_helper(struct device *dev, void *priv)
305 struct uwb_dev *uwb_dev = to_uwb_dev(dev);
307 return __uwb_dev_offair(uwb_dev, uwb_dev->rc);
311 * Remove a Radio Controller; stop beaconing/scanning, disconnect all children
313 void uwb_rc_rm(struct uwb_rc *rc)
318 uwb_rsv_remove_all(rc);
319 uwb_radio_shutdown(rc);
324 uwb_rc_neh_destroy(rc);
326 uwb_dev_lock(&rc->uwb_dev);
329 uwb_dev_unlock(&rc->uwb_dev);
330 mutex_lock(&rc->uwb_beca.mutex);
331 uwb_dev_for_each(rc, uwb_dev_offair_helper, NULL);
333 mutex_unlock(&rc->uwb_beca.mutex);
335 uwb_beca_release(rc);
336 uwb_dev_rm(&rc->uwb_dev);
338 EXPORT_SYMBOL_GPL(uwb_rc_rm);
340 static int find_rc_try_get(struct device *dev, void *data)
342 struct uwb_rc *target_rc = data;
343 struct uwb_rc *rc = dev_get_drvdata(dev);
349 if (rc == target_rc) {
359 * Given a radio controller descriptor, validate and refcount it
361 * @returns NULL if the rc does not exist or is quiescing; the ptr to
364 struct uwb_rc *__uwb_rc_try_get(struct uwb_rc *target_rc)
367 struct uwb_rc *rc = NULL;
369 dev = class_find_device(&uwb_rc_class, NULL, target_rc,
372 rc = dev_get_drvdata(dev);
379 EXPORT_SYMBOL_GPL(__uwb_rc_try_get);
382 * RC get for external refcount acquirers...
384 * Increments the refcount of the device and it's backend modules
386 static inline struct uwb_rc *uwb_rc_get(struct uwb_rc *rc)
390 uwb_dev_get(&rc->uwb_dev);
394 static int find_rc_grandpa(struct device *dev, void *data)
396 struct device *grandpa_dev = data;
397 struct uwb_rc *rc = dev_get_drvdata(dev);
399 if (rc->uwb_dev.dev.parent->parent == grandpa_dev) {
407 * Locate and refcount a radio controller given a common grand-parent
409 * @grandpa_dev Pointer to the 'grandparent' device structure.
410 * @returns NULL If the rc does not exist or is quiescing; the ptr to
411 * it otherwise, properly referenced.
413 * The Radio Control interface (or the UWB Radio Controller) is always
414 * an interface of a device. The parent is the interface, the
415 * grandparent is the device that encapsulates the interface.
417 * There is no need to lock around as the "grandpa" would be
418 * refcounted by the target, and to remove the referemes, the
419 * uwb_rc_class->sem would have to be taken--we hold it, ergo we
422 struct uwb_rc *uwb_rc_get_by_grandpa(const struct device *grandpa_dev)
425 struct uwb_rc *rc = NULL;
427 dev = class_find_device(&uwb_rc_class, NULL, (void *)grandpa_dev,
430 rc = dev_get_drvdata(dev);
436 EXPORT_SYMBOL_GPL(uwb_rc_get_by_grandpa);
439 * Find a radio controller by device address
441 * @returns the pointer to the radio controller, properly referenced
443 static int find_rc_dev(struct device *dev, void *data)
445 struct uwb_dev_addr *addr = data;
446 struct uwb_rc *rc = dev_get_drvdata(dev);
452 if (!uwb_dev_addr_cmp(&rc->uwb_dev.dev_addr, addr)) {
459 struct uwb_rc *uwb_rc_get_by_dev(const struct uwb_dev_addr *addr)
462 struct uwb_rc *rc = NULL;
464 dev = class_find_device(&uwb_rc_class, NULL, (void *)addr,
467 rc = dev_get_drvdata(dev);
473 EXPORT_SYMBOL_GPL(uwb_rc_get_by_dev);
476 * Drop a reference on a radio controller
478 * This is the version that should be done by entities external to the
479 * UWB Radio Control stack (ie: clients of the API).
481 void uwb_rc_put(struct uwb_rc *rc)
485 EXPORT_SYMBOL_GPL(uwb_rc_put);