Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
uwb-internal.h
Go to the documentation of this file.
1 /*
2  * Ultra Wide Band
3  * UWB internal API
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  * This contains most of the internal API for UWB. This is stuff used
23  * across the stack that of course, is of no interest to the rest.
24  *
25  * Some parts might end up going public (like uwb_rc_*())...
26  */
27 
28 #ifndef __UWB_INTERNAL_H__
29 #define __UWB_INTERNAL_H__
30 
31 #include <linux/kernel.h>
32 #include <linux/device.h>
33 #include <linux/uwb.h>
34 #include <linux/mutex.h>
35 
36 struct uwb_beca_e;
37 
38 /* General device API */
39 extern void uwb_dev_init(struct uwb_dev *uwb_dev);
40 extern int __uwb_dev_offair(struct uwb_dev *, struct uwb_rc *);
41 extern int uwb_dev_add(struct uwb_dev *uwb_dev, struct device *parent_dev,
42  struct uwb_rc *parent_rc);
43 extern void uwb_dev_rm(struct uwb_dev *uwb_dev);
44 extern void uwbd_dev_onair(struct uwb_rc *, struct uwb_beca_e *);
45 extern void uwbd_dev_offair(struct uwb_beca_e *);
46 void uwb_notify(struct uwb_rc *rc, struct uwb_dev *uwb_dev, enum uwb_notifs event);
47 
48 /* General UWB Radio Controller Internal API */
49 extern struct uwb_rc *__uwb_rc_try_get(struct uwb_rc *);
50 static inline struct uwb_rc *__uwb_rc_get(struct uwb_rc *rc)
51 {
52  uwb_dev_get(&rc->uwb_dev);
53  return rc;
54 }
55 
56 static inline void __uwb_rc_put(struct uwb_rc *rc)
57 {
58  uwb_dev_put(&rc->uwb_dev);
59 }
60 
61 extern int uwb_rc_reset(struct uwb_rc *rc);
62 extern int uwb_rc_beacon(struct uwb_rc *rc,
63  int channel, unsigned bpst_offset);
64 extern int uwb_rc_scan(struct uwb_rc *rc,
65  unsigned channel, enum uwb_scan_type type,
66  unsigned bpst_offset);
67 extern int uwb_rc_send_all_drp_ie(struct uwb_rc *rc);
68 
69 void uwb_rc_ie_init(struct uwb_rc *);
70 int uwb_rc_ie_setup(struct uwb_rc *);
71 void uwb_rc_ie_release(struct uwb_rc *);
72 int uwb_ie_dump_hex(const struct uwb_ie_hdr *ies, size_t len,
73  char *buf, size_t size);
74 int uwb_rc_set_ie(struct uwb_rc *, struct uwb_rc_cmd_set_ie *);
75 
76 
77 extern const char *uwb_rc_strerror(unsigned code);
78 
79 /*
80  * Time to wait for a response to an RC command.
81  *
82  * Some commands can take a long time to response. e.g., START_BEACON
83  * may scan for several superframes before joining an existing beacon
84  * group and this can take around 600 ms.
85  */
86 #define UWB_RC_CMD_TIMEOUT_MS 1000 /* ms */
87 
88 /*
89  * Notification/Event Handlers
90  */
91 
92 struct uwb_rc_neh;
93 
94 extern int uwb_rc_cmd_async(struct uwb_rc *rc, const char *cmd_name,
95  struct uwb_rccb *cmd, size_t cmd_size,
96  u8 expected_type, u16 expected_event,
97  uwb_rc_cmd_cb_f cb, void *arg);
98 
99 
100 void uwb_rc_neh_create(struct uwb_rc *rc);
101 void uwb_rc_neh_destroy(struct uwb_rc *rc);
102 
103 struct uwb_rc_neh *uwb_rc_neh_add(struct uwb_rc *rc, struct uwb_rccb *cmd,
104  u8 expected_type, u16 expected_event,
105  uwb_rc_cmd_cb_f cb, void *arg);
106 void uwb_rc_neh_rm(struct uwb_rc *rc, struct uwb_rc_neh *neh);
107 void uwb_rc_neh_arm(struct uwb_rc *rc, struct uwb_rc_neh *neh);
108 void uwb_rc_neh_put(struct uwb_rc_neh *neh);
109 
110 /* Event size tables */
111 extern int uwb_est_create(void);
112 extern void uwb_est_destroy(void);
113 
114 /*
115  * UWB conflicting alien reservations
116  */
118  struct uwb_rc *rc;
120  struct uwb_mas_bm mas;
123 };
124 
128 };
129 
134 };
135 
137  unsigned char start_col;
138  unsigned char interval;
139  unsigned char safe_mas_per_col;
140  unsigned char unsafe_mas_per_col;
141 };
142 
144  unsigned char max_avail_safe;
145  unsigned char max_avail_unsafe;
148 };
149 
151  unsigned char avail[UWB_MAS_PER_ZONE];
152  unsigned char free_rows;
153  unsigned char used_rows;
154 };
155 
156 /*
157  * UWB find allocation
158  */
165  int min_mas;
166  int max_mas;
171  int interval;
172 };
173 
175  struct uwb_mas_bm *result);
177 /*
178  * UWB Events & management daemon
179  */
180 
191 };
192 
200  size_t size;
201  struct uwb_rceb *rceb;
202 };
203 
211 };
212 
219 struct uwb_event {
221  struct uwb_rc *rc;
222  unsigned long ts_jiffies;
224  union {
227  };
228 };
229 
230 extern void uwbd_start(struct uwb_rc *rc);
231 extern void uwbd_stop(struct uwb_rc *rc);
232 extern struct uwb_event *uwb_event_alloc(size_t, gfp_t gfp_mask);
233 extern void uwbd_event_queue(struct uwb_event *);
234 void uwbd_flush(struct uwb_rc *rc);
235 
236 /* UWB event handlers */
237 extern int uwbd_evt_handle_rc_ie_rcv(struct uwb_event *);
238 extern int uwbd_evt_handle_rc_beacon(struct uwb_event *);
239 extern int uwbd_evt_handle_rc_beacon_size(struct uwb_event *);
240 extern int uwbd_evt_handle_rc_bpoie_change(struct uwb_event *);
241 extern int uwbd_evt_handle_rc_bp_slot_change(struct uwb_event *);
242 extern int uwbd_evt_handle_rc_drp(struct uwb_event *);
243 extern int uwbd_evt_handle_rc_drp_avail(struct uwb_event *);
244 
245 int uwbd_msg_handle_reset(struct uwb_event *evt);
246 
247 
248 /*
249  * Address management
250  */
251 int uwb_rc_dev_addr_assign(struct uwb_rc *rc);
253 
254 /*
255  * UWB Beacon Cache
256  *
257  * Each beacon we received is kept in a cache--when we receive that
258  * beacon consistently, that means there is a new device that we have
259  * to add to the system.
260  */
261 
262 extern unsigned long beacon_timeout_ms;
263 
275 struct uwb_beca_e {
276  struct mutex mutex;
277  struct kref refcnt;
278  struct list_head node;
282  unsigned long ts_jiffies;
283  struct uwb_dev *uwb_dev;
285  struct stats lqe_stats, rssi_stats; /* radio statistics */
286 };
287 struct uwb_beacon_frame;
288 extern ssize_t uwb_bce_print_IEs(struct uwb_dev *, struct uwb_beca_e *,
289  char *, size_t);
290 
291 extern void uwb_bce_kfree(struct kref *_bce);
292 static inline void uwb_bce_get(struct uwb_beca_e *bce)
293 {
294  kref_get(&bce->refcnt);
295 }
296 static inline void uwb_bce_put(struct uwb_beca_e *bce)
297 {
298  kref_put(&bce->refcnt, uwb_bce_kfree);
299 }
300 extern void uwb_beca_purge(struct uwb_rc *rc);
301 extern void uwb_beca_release(struct uwb_rc *rc);
302 
303 struct uwb_dev *uwb_dev_get_by_devaddr(struct uwb_rc *rc,
304  const struct uwb_dev_addr *devaddr);
305 struct uwb_dev *uwb_dev_get_by_macaddr(struct uwb_rc *rc,
306  const struct uwb_mac_addr *macaddr);
307 
308 int uwb_radio_setup(struct uwb_rc *rc);
309 void uwb_radio_reset_state(struct uwb_rc *rc);
310 void uwb_radio_shutdown(struct uwb_rc *rc);
311 int uwb_radio_force_channel(struct uwb_rc *rc, int channel);
312 
313 /* -- UWB Sysfs representation */
314 extern struct class uwb_rc_class;
316 extern struct device_attribute dev_attr_beacon;
317 extern struct device_attribute dev_attr_scan;
318 
319 /* -- DRP Bandwidth allocator: bandwidth allocations, reservations, DRP */
320 void uwb_rsv_init(struct uwb_rc *rc);
321 int uwb_rsv_setup(struct uwb_rc *rc);
322 void uwb_rsv_cleanup(struct uwb_rc *rc);
323 void uwb_rsv_remove_all(struct uwb_rc *rc);
324 void uwb_rsv_get(struct uwb_rsv *rsv);
325 void uwb_rsv_put(struct uwb_rsv *rsv);
326 bool uwb_rsv_has_two_drp_ies(struct uwb_rsv *rsv);
327 void uwb_rsv_dump(char *text, struct uwb_rsv *rsv);
328 int uwb_rsv_try_move(struct uwb_rsv *rsv, struct uwb_mas_bm *available);
329 void uwb_rsv_backoff_win_timer(unsigned long arg);
331 int uwb_rsv_status(struct uwb_rsv *rsv);
333 
335 void uwb_rsv_remove(struct uwb_rsv *rsv);
336 struct uwb_rsv *uwb_rsv_find(struct uwb_rc *rc, struct uwb_dev *src,
337  struct uwb_ie_drp *drp_ie);
338 void uwb_rsv_sched_update(struct uwb_rc *rc);
339 void uwb_rsv_queue_update(struct uwb_rc *rc);
340 
341 int uwb_drp_ie_update(struct uwb_rsv *rsv);
342 void uwb_drp_ie_to_bm(struct uwb_mas_bm *bm, const struct uwb_ie_drp *drp_ie);
343 
344 void uwb_drp_avail_init(struct uwb_rc *rc);
345 void uwb_drp_available(struct uwb_rc *rc, struct uwb_mas_bm *avail);
347 void uwb_drp_avail_reserve(struct uwb_rc *rc, struct uwb_mas_bm *mas);
348 void uwb_drp_avail_release(struct uwb_rc *rc, struct uwb_mas_bm *mas);
349 void uwb_drp_avail_ie_update(struct uwb_rc *rc);
350 
351 /* -- PAL support */
352 void uwb_rc_pal_init(struct uwb_rc *rc);
353 
354 /* -- Misc */
355 
356 extern ssize_t uwb_mac_frame_hdr_print(char *, size_t,
357  const struct uwb_mac_frame_hdr *);
358 
359 /* -- Debug interface */
360 void uwb_dbg_init(void);
361 void uwb_dbg_exit(void);
362 void uwb_dbg_add_rc(struct uwb_rc *rc);
363 void uwb_dbg_del_rc(struct uwb_rc *rc);
364 struct dentry *uwb_dbg_create_pal_dir(struct uwb_pal *pal);
365 
366 static inline void uwb_dev_lock(struct uwb_dev *uwb_dev)
367 {
368  device_lock(&uwb_dev->dev);
369 }
370 
371 static inline void uwb_dev_unlock(struct uwb_dev *uwb_dev)
372 {
373  device_unlock(&uwb_dev->dev);
374 }
375 
376 #endif /* #ifndef __UWB_INTERNAL_H__ */