1/* 2 * Ultra Wide Band 3 * UWB internal API 4 * 5 * Copyright (C) 2005-2006 Intel Corporation 6 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com> 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/version.h> 32#include <linux/kernel.h> 33#include <linux/device.h> 34#include <linux/uwb.h> 35#include <linux/mutex.h> 36 37struct uwb_beca_e; 38 39/* General device API */ 40extern void uwb_dev_init(struct uwb_dev *uwb_dev); 41extern int __uwb_dev_offair(struct uwb_dev *, struct uwb_rc *); 42extern int uwb_dev_add(struct uwb_dev *uwb_dev, struct device *parent_dev, 43 struct uwb_rc *parent_rc); 44extern void uwb_dev_rm(struct uwb_dev *uwb_dev); 45extern void uwbd_dev_onair(struct uwb_rc *, struct uwb_beca_e *); 46extern void uwbd_dev_offair(struct uwb_beca_e *); 47void uwb_notify(struct uwb_rc *rc, struct uwb_dev *uwb_dev, enum uwb_notifs event); 48 49/* General UWB Radio Controller Internal API */ 50extern struct uwb_rc *__uwb_rc_try_get(struct uwb_rc *); 51static inline struct uwb_rc *__uwb_rc_get(struct uwb_rc *rc) 52{ 53 uwb_dev_get(&rc->uwb_dev); 54 return rc; 55} 56 57static inline void __uwb_rc_put(struct uwb_rc *rc) 58{ 59 uwb_dev_put(&rc->uwb_dev); 60} 61 62extern int uwb_rc_reset(struct uwb_rc *rc); 63extern int uwb_rc_beacon(struct uwb_rc *rc, 64 int channel, unsigned bpst_offset); 65extern int uwb_rc_scan(struct uwb_rc *rc, 66 unsigned channel, enum uwb_scan_type type, 67 unsigned bpst_offset); 68extern int uwb_rc_send_all_drp_ie(struct uwb_rc *rc); 69 70void uwb_rc_ie_init(struct uwb_rc *); 71int uwb_rc_ie_setup(struct uwb_rc *); 72void uwb_rc_ie_release(struct uwb_rc *); 73int uwb_ie_dump_hex(const struct uwb_ie_hdr *ies, size_t len, 74 char *buf, size_t size); 75int uwb_rc_set_ie(struct uwb_rc *, struct uwb_rc_cmd_set_ie *); 76 77 78extern const char *uwb_rc_strerror(unsigned code); 79 80/* 81 * Time to wait for a response to an RC command. 82 * 83 * Some commands can take a long time to response. e.g., START_BEACON 84 * may scan for several superframes before joining an existing beacon 85 * group and this can take around 600 ms. 86 */ 87#define UWB_RC_CMD_TIMEOUT_MS 1000 /* ms */ 88 89/* 90 * Notification/Event Handlers 91 */ 92 93struct uwb_rc_neh; 94 95extern int uwb_rc_cmd_async(struct uwb_rc *rc, const char *cmd_name, 96 struct uwb_rccb *cmd, size_t cmd_size, 97 u8 expected_type, u16 expected_event, 98 uwb_rc_cmd_cb_f cb, void *arg); 99 100 101void uwb_rc_neh_create(struct uwb_rc *rc); 102void uwb_rc_neh_destroy(struct uwb_rc *rc); 103 104struct uwb_rc_neh *uwb_rc_neh_add(struct uwb_rc *rc, struct uwb_rccb *cmd, 105 u8 expected_type, u16 expected_event, 106 uwb_rc_cmd_cb_f cb, void *arg); 107void uwb_rc_neh_rm(struct uwb_rc *rc, struct uwb_rc_neh *neh); 108void uwb_rc_neh_arm(struct uwb_rc *rc, struct uwb_rc_neh *neh); 109void uwb_rc_neh_put(struct uwb_rc_neh *neh); 110 111/* Event size tables */ 112extern int uwb_est_create(void); 113extern void uwb_est_destroy(void); 114 115/* 116 * UWB conflicting alien reservations 117 */ 118struct uwb_cnflt_alien { 119 struct uwb_rc *rc; 120 struct list_head rc_node; 121 struct uwb_mas_bm mas; 122 struct timer_list timer; 123 struct work_struct cnflt_update_work; 124}; 125 126enum uwb_uwb_rsv_alloc_result { 127 UWB_RSV_ALLOC_FOUND = 0, 128 UWB_RSV_ALLOC_NOT_FOUND, 129}; 130 131enum uwb_rsv_mas_status { 132 UWB_RSV_MAS_NOT_AVAIL = 1, 133 UWB_RSV_MAS_SAFE, 134 UWB_RSV_MAS_UNSAFE, 135}; 136 137struct uwb_rsv_col_set_info { 138 unsigned char start_col; 139 unsigned char interval; 140 unsigned char safe_mas_per_col; 141 unsigned char unsafe_mas_per_col; 142}; 143 144struct uwb_rsv_col_info { 145 unsigned char max_avail_safe; 146 unsigned char max_avail_unsafe; 147 unsigned char highest_mas[UWB_MAS_PER_ZONE]; 148 struct uwb_rsv_col_set_info csi; 149}; 150 151struct uwb_rsv_row_info { 152 unsigned char avail[UWB_MAS_PER_ZONE]; 153 unsigned char free_rows; 154 unsigned char used_rows; 155}; 156 157/* 158 * UWB find allocation 159 */ 160struct uwb_rsv_alloc_info { 161 unsigned char bm[UWB_MAS_PER_ZONE * UWB_NUM_ZONES]; 162 struct uwb_rsv_col_info ci[UWB_NUM_ZONES]; 163 struct uwb_rsv_row_info ri; 164 struct uwb_mas_bm *not_available; 165 struct uwb_mas_bm *result; 166 int min_mas; 167 int max_mas; 168 int max_interval; 169 int total_allocated_mases; 170 int safe_allocated_mases; 171 int unsafe_allocated_mases; 172 int interval; 173}; 174 175int uwb_rsv_find_best_allocation(struct uwb_rsv *rsv, struct uwb_mas_bm *available, 176 struct uwb_mas_bm *result); 177void uwb_rsv_handle_drp_avail_change(struct uwb_rc *rc); 178/* 179 * UWB Events & management daemon 180 */ 181 182/** 183 * enum uwb_event_type - types of UWB management daemon events 184 * 185 * The UWB management daemon (uwbd) can receive two types of events: 186 * UWB_EVT_TYPE_NOTIF - notification from the radio controller. 187 * UWB_EVT_TYPE_MSG - a simple message. 188 */ 189enum uwb_event_type { 190 UWB_EVT_TYPE_NOTIF, 191 UWB_EVT_TYPE_MSG, 192}; 193 194/** 195 * struct uwb_event_notif - an event for a radio controller notification 196 * @size: Size of the buffer (ie: Guaranteed to contain at least 197 * a full 'struct uwb_rceb') 198 * @rceb: Pointer to a kmalloced() event payload 199 */ 200struct uwb_event_notif { 201 size_t size; 202 struct uwb_rceb *rceb; 203}; 204 205/** 206 * enum uwb_event_message - an event for a message for asynchronous processing 207 * 208 * UWB_EVT_MSG_RESET - reset the radio controller and all PAL hardware. 209 */ 210enum uwb_event_message { 211 UWB_EVT_MSG_RESET, 212}; 213 214/** 215 * UWB Event 216 * @rc: Radio controller that emitted the event (referenced) 217 * @ts_jiffies: Timestamp, when was it received 218 * @type: This event's type. 219 */ 220struct uwb_event { 221 struct list_head list_node; 222 struct uwb_rc *rc; 223 unsigned long ts_jiffies; 224 enum uwb_event_type type; 225 union { 226 struct uwb_event_notif notif; 227 enum uwb_event_message message; 228 }; 229}; 230 231extern void uwbd_start(struct uwb_rc *rc); 232extern void uwbd_stop(struct uwb_rc *rc); 233extern struct uwb_event *uwb_event_alloc(size_t, gfp_t gfp_mask); 234extern void uwbd_event_queue(struct uwb_event *); 235void uwbd_flush(struct uwb_rc *rc); 236 237/* UWB event handlers */ 238extern int uwbd_evt_handle_rc_ie_rcv(struct uwb_event *); 239extern int uwbd_evt_handle_rc_beacon(struct uwb_event *); 240extern int uwbd_evt_handle_rc_beacon_size(struct uwb_event *); 241extern int uwbd_evt_handle_rc_bpoie_change(struct uwb_event *); 242extern int uwbd_evt_handle_rc_bp_slot_change(struct uwb_event *); 243extern int uwbd_evt_handle_rc_drp(struct uwb_event *); 244extern int uwbd_evt_handle_rc_drp_avail(struct uwb_event *); 245 246int uwbd_msg_handle_reset(struct uwb_event *evt); 247 248 249/* 250 * Address management 251 */ 252int uwb_rc_dev_addr_assign(struct uwb_rc *rc); 253int uwbd_evt_handle_rc_dev_addr_conflict(struct uwb_event *evt); 254 255/* 256 * UWB Beacon Cache 257 * 258 * Each beacon we received is kept in a cache--when we receive that 259 * beacon consistently, that means there is a new device that we have 260 * to add to the system. 261 */ 262 263extern unsigned long beacon_timeout_ms; 264 265/** 266 * Beacon cache entry 267 * 268 * @jiffies_refresh: last time a beacon was received that refreshed 269 * this cache entry. 270 * @uwb_dev: device connected to this beacon. This pointer is not 271 * safe, you need to get it with uwb_dev_try_get() 272 * 273 * @hits: how many time we have seen this beacon since last time we 274 * cleared it 275 */ 276struct uwb_beca_e { 277 struct mutex mutex; 278 struct kref refcnt; 279 struct list_head node; 280 struct uwb_mac_addr *mac_addr; 281 struct uwb_dev_addr dev_addr; 282 u8 hits; 283 unsigned long ts_jiffies; 284 struct uwb_dev *uwb_dev; 285 struct uwb_rc_evt_beacon *be; 286 struct stats lqe_stats, rssi_stats; /* radio statistics */ 287}; 288struct uwb_beacon_frame; 289extern ssize_t uwb_bce_print_IEs(struct uwb_dev *, struct uwb_beca_e *, 290 char *, size_t); 291 292extern void uwb_bce_kfree(struct kref *_bce); 293static inline void uwb_bce_get(struct uwb_beca_e *bce) 294{ 295 kref_get(&bce->refcnt); 296} 297static inline void uwb_bce_put(struct uwb_beca_e *bce) 298{ 299 kref_put(&bce->refcnt, uwb_bce_kfree); 300} 301extern void uwb_beca_purge(struct uwb_rc *rc); 302extern void uwb_beca_release(struct uwb_rc *rc); 303 304struct uwb_dev *uwb_dev_get_by_devaddr(struct uwb_rc *rc, 305 const struct uwb_dev_addr *devaddr); 306struct uwb_dev *uwb_dev_get_by_macaddr(struct uwb_rc *rc, 307 const struct uwb_mac_addr *macaddr); 308 309int uwb_radio_setup(struct uwb_rc *rc); 310void uwb_radio_reset_state(struct uwb_rc *rc); 311void uwb_radio_shutdown(struct uwb_rc *rc); 312int uwb_radio_force_channel(struct uwb_rc *rc, int channel); 313 314/* -- UWB Sysfs representation */ 315extern struct class uwb_rc_class; 316extern struct device_attribute dev_attr_mac_address; 317extern struct device_attribute dev_attr_beacon; 318extern struct device_attribute dev_attr_scan; 319 320/* -- DRP Bandwidth allocator: bandwidth allocations, reservations, DRP */ 321void uwb_rsv_init(struct uwb_rc *rc); 322int uwb_rsv_setup(struct uwb_rc *rc); 323void uwb_rsv_cleanup(struct uwb_rc *rc); 324void uwb_rsv_remove_all(struct uwb_rc *rc); 325void uwb_rsv_get(struct uwb_rsv *rsv); 326void uwb_rsv_put(struct uwb_rsv *rsv); 327bool uwb_rsv_has_two_drp_ies(struct uwb_rsv *rsv); 328void uwb_rsv_dump(char *text, struct uwb_rsv *rsv); 329int uwb_rsv_try_move(struct uwb_rsv *rsv, struct uwb_mas_bm *available); 330void uwb_rsv_backoff_win_timer(unsigned long arg); 331void uwb_rsv_backoff_win_increment(struct uwb_rc *rc); 332int uwb_rsv_status(struct uwb_rsv *rsv); 333int uwb_rsv_companion_status(struct uwb_rsv *rsv); 334 335void uwb_rsv_set_state(struct uwb_rsv *rsv, enum uwb_rsv_state new_state); 336void uwb_rsv_remove(struct uwb_rsv *rsv); 337struct uwb_rsv *uwb_rsv_find(struct uwb_rc *rc, struct uwb_dev *src, 338 struct uwb_ie_drp *drp_ie); 339void uwb_rsv_sched_update(struct uwb_rc *rc); 340void uwb_rsv_queue_update(struct uwb_rc *rc); 341 342int uwb_drp_ie_update(struct uwb_rsv *rsv); 343void uwb_drp_ie_to_bm(struct uwb_mas_bm *bm, const struct uwb_ie_drp *drp_ie); 344 345void uwb_drp_avail_init(struct uwb_rc *rc); 346void uwb_drp_available(struct uwb_rc *rc, struct uwb_mas_bm *avail); 347int uwb_drp_avail_reserve_pending(struct uwb_rc *rc, struct uwb_mas_bm *mas); 348void uwb_drp_avail_reserve(struct uwb_rc *rc, struct uwb_mas_bm *mas); 349void uwb_drp_avail_release(struct uwb_rc *rc, struct uwb_mas_bm *mas); 350void uwb_drp_avail_ie_update(struct uwb_rc *rc); 351 352/* -- PAL support */ 353void uwb_rc_pal_init(struct uwb_rc *rc); 354 355/* -- Misc */ 356 357extern ssize_t uwb_mac_frame_hdr_print(char *, size_t, 358 const struct uwb_mac_frame_hdr *); 359 360/* -- Debug interface */ 361void uwb_dbg_init(void); 362void uwb_dbg_exit(void); 363void uwb_dbg_add_rc(struct uwb_rc *rc); 364void uwb_dbg_del_rc(struct uwb_rc *rc); 365struct dentry *uwb_dbg_create_pal_dir(struct uwb_pal *pal); 366 367static inline void uwb_dev_lock(struct uwb_dev *uwb_dev) 368{ 369 device_lock(&uwb_dev->dev); 370} 371 372static inline void uwb_dev_unlock(struct uwb_dev *uwb_dev) 373{ 374 device_unlock(&uwb_dev->dev); 375} 376 377#endif /* #ifndef __UWB_INTERNAL_H__ */ 378