hci_core.h 12.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/* 
   BlueZ - Bluetooth protocol stack for Linux
   Copyright (C) 2000-2001 Qualcomm Incorporated

   Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>

   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;

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
   IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
   CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES 
   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
   ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

   ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS, 
   COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS 
   SOFTWARE IS DISCLAIMED.
*/

/* 
26
 * $Id: hci_core.h,v 1.3 2002/04/17 18:55:21 maxk Exp $ 
Linus Torvalds's avatar
Linus Torvalds committed
27 28
 */

Linus Torvalds's avatar
Linus Torvalds committed
29 30
#ifndef __HCI_CORE_H
#define __HCI_CORE_H
Linus Torvalds's avatar
Linus Torvalds committed
31

32
#include <linux/proc_fs.h>
Linus Torvalds's avatar
Linus Torvalds committed
33
#include <net/bluetooth/hci.h>
Linus Torvalds's avatar
Linus Torvalds committed
34 35 36

/* HCI upper protocols */
#define HCI_PROTO_L2CAP	0
37
#define HCI_PROTO_SCO	1
Linus Torvalds's avatar
Linus Torvalds committed
38 39 40

#define HCI_INIT_TIMEOUT (HZ * 10)

41 42
extern struct proc_dir_entry *proc_bt_hci;

43
/* HCI Core structures */
Linus Torvalds's avatar
Linus Torvalds committed
44 45 46 47

struct inquiry_entry {
	struct inquiry_entry 	*next;
	__u32			timestamp;
48
	struct inquiry_info	info;
Linus Torvalds's avatar
Linus Torvalds committed
49 50 51 52 53 54 55 56
};

struct inquiry_cache {
	spinlock_t 		lock;
	__u32			timestamp;
	struct inquiry_entry 	*list;
};

57
struct hci_conn_hash {
58 59 60 61
	struct list_head list;
	spinlock_t       lock;
	unsigned int     num;
};
Linus Torvalds's avatar
Linus Torvalds committed
62

63 64 65 66
struct hci_dev {
	struct list_head list;
	spinlock_t	lock;
	atomic_t 	refcnt;
Linus Torvalds's avatar
Linus Torvalds committed
67

68 69 70 71 72 73
	char		name[8];
	unsigned long	flags;
	__u16		id;
	__u8	 	type;
	bdaddr_t	bdaddr;
	__u8		features[8];
Linus Torvalds's avatar
Linus Torvalds committed
74

75 76 77 78 79 80 81
	__u16		pkt_type;
	__u16		link_policy;
	__u16		link_mode;
	
	atomic_t 	cmd_cnt;
	unsigned int 	acl_cnt;
	unsigned int 	sco_cnt;
Linus Torvalds's avatar
Linus Torvalds committed
82

83 84 85 86
	unsigned int	acl_mtu;
	unsigned int 	sco_mtu;
	unsigned int	acl_pkts;
	unsigned int	sco_pkts;
Linus Torvalds's avatar
Linus Torvalds committed
87

88 89 90 91 92 93 94
	unsigned long   cmd_last_tx;
	unsigned long   acl_last_tx;
	unsigned long   sco_last_tx;
	
	struct tasklet_struct 	cmd_task;
	struct tasklet_struct	rx_task;
	struct tasklet_struct 	tx_task;
Linus Torvalds's avatar
Linus Torvalds committed
95

96 97 98
	struct sk_buff_head	rx_q;
	struct sk_buff_head 	raw_q;
	struct sk_buff_head 	cmd_q;
Linus Torvalds's avatar
Linus Torvalds committed
99

100 101 102 103 104 105 106 107
	struct sk_buff     	*sent_cmd;

	struct semaphore	req_lock;
	wait_queue_head_t	req_wait_q;
	__u32			req_status;
	__u32			req_result;

	struct inquiry_cache 	inq_cache;
108
	struct hci_conn_hash 	conn_hash;
109 110 111 112 113 114 115 116

	struct hci_dev_stats 	stat;

	void			*driver_data;
	void			*core_data;

	atomic_t 		promisc;

117 118 119 120
#ifdef CONFIG_PROC_FS
	struct proc_dir_entry   *proc;
#endif

121 122
	struct module           *owner;
	
123 124 125 126 127 128 129
	int (*open)(struct hci_dev *hdev);
	int (*close)(struct hci_dev *hdev);
	int (*flush)(struct hci_dev *hdev);
	int (*send)(struct sk_buff *skb);
	void (*destruct)(struct hci_dev *hdev);
	int (*ioctl)(struct hci_dev *hdev, unsigned int cmd, unsigned long arg);
};
Linus Torvalds's avatar
Linus Torvalds committed
130 131 132

struct hci_conn {
	struct list_head list;
133 134 135 136

	atomic_t	 refcnt;
	spinlock_t	 lock;

Linus Torvalds's avatar
Linus Torvalds committed
137 138
	bdaddr_t         dst;
	__u16            handle;
139
	__u16            state;
Linus Torvalds's avatar
Linus Torvalds committed
140
	__u8		 type;
141 142 143 144 145 146 147
	__u8		 out;
	__u32		 link_mode;
	unsigned long	 pend;
	
	unsigned int	 sent;
	
	struct sk_buff_head data_q;
Linus Torvalds's avatar
Linus Torvalds committed
148

149 150
	struct timer_list timer;
	
Linus Torvalds's avatar
Linus Torvalds committed
151 152
	struct hci_dev 	*hdev;
	void		*l2cap_data;
153
	void		*sco_data;
Linus Torvalds's avatar
Linus Torvalds committed
154 155
	void		*priv;

156
	struct hci_conn *link;
Linus Torvalds's avatar
Linus Torvalds committed
157
};
Linus Torvalds's avatar
Linus Torvalds committed
158

159
extern struct hci_proto *hci_proto[];
160 161
extern struct list_head hci_dev_list;
extern rwlock_t hci_dev_list_lock;
162 163 164 165 166 167 168 169 170

/* ----- Inquiry cache ----- */
#define INQUIRY_CACHE_AGE_MAX   (HZ*30)   // 30 seconds
#define INQUIRY_ENTRY_AGE_MAX   (HZ*60)   // 60 seconds

#define inquiry_cache_lock(c)		spin_lock(&c->lock)
#define inquiry_cache_unlock(c)		spin_unlock(&c->lock)
#define inquiry_cache_lock_bh(c)	spin_lock_bh(&c->lock)
#define inquiry_cache_unlock_bh(c)	spin_unlock_bh(&c->lock)
Linus Torvalds's avatar
Linus Torvalds committed
171

172
static inline void inquiry_cache_init(struct hci_dev *hdev)
Linus Torvalds's avatar
Linus Torvalds committed
173
{
174 175 176
	struct inquiry_cache *c = &hdev->inq_cache;
	spin_lock_init(&c->lock);
	c->list = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
177 178
}

179
static inline long inquiry_cache_age(struct hci_dev *hdev)
Linus Torvalds's avatar
Linus Torvalds committed
180
{
181 182
	struct inquiry_cache *c = &hdev->inq_cache;
	return jiffies - c->timestamp;
Linus Torvalds's avatar
Linus Torvalds committed
183 184
}

185
static inline long inquiry_entry_age(struct inquiry_entry *e)
Linus Torvalds's avatar
Linus Torvalds committed
186
{
187
	return jiffies - e->timestamp;
Linus Torvalds's avatar
Linus Torvalds committed
188 189
}

190
struct inquiry_entry *inquiry_cache_lookup(struct hci_dev *hdev, bdaddr_t *bdaddr);
191
void inquiry_cache_update(struct hci_dev *hdev, struct inquiry_info *info);
192 193 194 195 196 197 198 199 200
void inquiry_cache_flush(struct hci_dev *hdev);
int  inquiry_cache_dump(struct hci_dev *hdev, int num, __u8 *buf);

/* ----- HCI Connections ----- */
enum {
	HCI_CONN_AUTH_PEND,
	HCI_CONN_ENCRYPT_PEND
};

201
static inline void hci_conn_hash_init(struct hci_dev *hdev)
Linus Torvalds's avatar
Linus Torvalds committed
202
{
203
	struct hci_conn_hash *h = &hdev->conn_hash;
204 205 206
	INIT_LIST_HEAD(&h->list);
	spin_lock_init(&h->lock);
	h->num = 0;	
Linus Torvalds's avatar
Linus Torvalds committed
207 208
}

209
static inline void hci_conn_hash_add(struct hci_dev *hdev, struct hci_conn *c)
Linus Torvalds's avatar
Linus Torvalds committed
210
{
211
	struct hci_conn_hash *h = &hdev->conn_hash;
212 213
	list_add(&c->list, &h->list);
	h->num++;
Linus Torvalds's avatar
Linus Torvalds committed
214 215
}

216
static inline void hci_conn_hash_del(struct hci_dev *hdev, struct hci_conn *c)
Linus Torvalds's avatar
Linus Torvalds committed
217
{
218
	struct hci_conn_hash *h = &hdev->conn_hash;
Linus Torvalds's avatar
Linus Torvalds committed
219 220
	list_del(&c->list);
	h->num--;
Linus Torvalds's avatar
Linus Torvalds committed
221 222
}

223
static inline struct hci_conn *hci_conn_hash_lookup_handle(struct hci_dev *hdev,
224
	       				__u16 handle)
Linus Torvalds's avatar
Linus Torvalds committed
225
{
226 227 228
	struct hci_conn_hash *h = &hdev->conn_hash;
	struct list_head *p;
	struct hci_conn  *c;
Linus Torvalds's avatar
Linus Torvalds committed
229 230 231 232 233 234 235

	list_for_each(p, &h->list) {
		c = list_entry(p, struct hci_conn, list);
		if (c->handle == handle)
			return c;
	}
        return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
236 237
}

238
static inline struct hci_conn *hci_conn_hash_lookup_ba(struct hci_dev *hdev,
239
					__u8 type, bdaddr_t *ba)
Linus Torvalds's avatar
Linus Torvalds committed
240
{
241 242 243
	struct hci_conn_hash *h = &hdev->conn_hash;
	struct list_head *p;
	struct hci_conn  *c;
Linus Torvalds's avatar
Linus Torvalds committed
244

245 246 247 248 249 250
	list_for_each(p, &h->list) {
		c = list_entry(p, struct hci_conn, list);
		if (c->type == type && !bacmp(&c->dst, ba))
			return c;
	}
        return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
251 252
}

253 254 255
void hci_acl_connect(struct hci_conn *conn);
void hci_acl_disconn(struct hci_conn *conn, __u8 reason);
void hci_add_sco(struct hci_conn *conn, __u16 handle);
Linus Torvalds's avatar
Linus Torvalds committed
256

257 258 259
struct hci_conn *hci_conn_add(struct hci_dev *hdev, int type, bdaddr_t *dst);
int    hci_conn_del(struct hci_conn *conn);
void   hci_conn_hash_flush(struct hci_dev *hdev);
Linus Torvalds's avatar
Linus Torvalds committed
260

261 262 263
struct hci_conn *hci_connect(struct hci_dev *hdev, int type, bdaddr_t *src);
int hci_conn_auth(struct hci_conn *conn);
int hci_conn_encrypt(struct hci_conn *conn);
Linus Torvalds's avatar
Linus Torvalds committed
264

Maksim Krasnyanskiy's avatar
Maksim Krasnyanskiy committed
265
static inline void hci_conn_set_timer(struct hci_conn *conn, unsigned long timeout)
266 267 268
{
	mod_timer(&conn->timer, jiffies + timeout);
}
Linus Torvalds's avatar
Linus Torvalds committed
269

270 271 272 273
static inline void hci_conn_del_timer(struct hci_conn *conn)
{
	del_timer(&conn->timer);
}
Linus Torvalds's avatar
Linus Torvalds committed
274

275
static inline void hci_conn_hold(struct hci_conn *conn)
Linus Torvalds's avatar
Linus Torvalds committed
276
{
277 278
	atomic_inc(&conn->refcnt);
	hci_conn_del_timer(conn);
Linus Torvalds's avatar
Linus Torvalds committed
279 280
}

281
static inline void hci_conn_put(struct hci_conn *conn)
Linus Torvalds's avatar
Linus Torvalds committed
282
{
Maksim Krasnyanskiy's avatar
Maksim Krasnyanskiy committed
283
	if (atomic_dec_and_test(&conn->refcnt)) {
284 285 286 287 288
		if (conn->type == ACL_LINK) {
			unsigned long timeo = (conn->out) ?
				HCI_DISCONN_TIMEOUT : HCI_DISCONN_TIMEOUT * 2;
			hci_conn_set_timer(conn, timeo);
		} else
Maksim Krasnyanskiy's avatar
Maksim Krasnyanskiy committed
289
			hci_conn_set_timer(conn, HZ / 100);
Maksim Krasnyanskiy's avatar
Maksim Krasnyanskiy committed
290
	}
Linus Torvalds's avatar
Linus Torvalds committed
291 292
}

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/* ----- HCI tasks ----- */
static inline void hci_sched_cmd(struct hci_dev *hdev)
{
	tasklet_schedule(&hdev->cmd_task);
}

static inline void hci_sched_rx(struct hci_dev *hdev)
{
	tasklet_schedule(&hdev->rx_task);
}

static inline void hci_sched_tx(struct hci_dev *hdev)
{
	tasklet_schedule(&hdev->tx_task);
}

309
/* ----- HCI Devices ----- */
310 311
static inline void __hci_dev_put(struct hci_dev *d)
{
312 313 314
	if (atomic_dec_and_test(&d->refcnt))
		d->destruct(d);
}
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

static inline void hci_dev_put(struct hci_dev *d)
{ 
	__hci_dev_put(d);
	module_put(d->owner);
}

static inline struct hci_dev *__hci_dev_hold(struct hci_dev *d)
{
	atomic_inc(&d->refcnt);
	return d;
}

static inline struct hci_dev *hci_dev_hold(struct hci_dev *d)
{
	if (try_module_get(d->owner))
		return __hci_dev_hold(d);
	return NULL;
}
334 335 336 337 338 339 340 341 342 343

#define hci_dev_lock(d)		spin_lock(&d->lock)
#define hci_dev_unlock(d)	spin_unlock(&d->lock)
#define hci_dev_lock_bh(d)	spin_lock_bh(&d->lock)
#define hci_dev_unlock_bh(d)	spin_unlock_bh(&d->lock)

struct hci_dev *hci_dev_get(int index);
struct hci_dev *hci_get_route(bdaddr_t *src, bdaddr_t *dst);
int hci_register_dev(struct hci_dev *hdev);
int hci_unregister_dev(struct hci_dev *hdev);
344 345
int hci_suspend_dev(struct hci_dev *hdev);
int hci_resume_dev(struct hci_dev *hdev);
346 347 348 349 350 351 352 353 354 355 356 357
int hci_dev_open(__u16 dev);
int hci_dev_close(__u16 dev);
int hci_dev_reset(__u16 dev);
int hci_dev_reset_stat(__u16 dev);
int hci_dev_cmd(unsigned int cmd, unsigned long arg);
int hci_get_dev_list(unsigned long arg);
int hci_get_dev_info(unsigned long arg);
int hci_get_conn_list(unsigned long arg);
int hci_get_conn_info(struct hci_dev *hdev, unsigned long arg);
int hci_inquiry(unsigned long arg);

void hci_event_packet(struct hci_dev *hdev, struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
358

359 360
/* Receive frame from HCI drivers */
static inline int hci_recv_frame(struct sk_buff *skb)
Linus Torvalds's avatar
Linus Torvalds committed
361
{
362 363 364 365 366 367
	struct hci_dev *hdev = (struct hci_dev *) skb->dev;
	if (!hdev || (!test_bit(HCI_UP, &hdev->flags) 
			&& !test_bit(HCI_INIT, &hdev->flags))) {
		kfree_skb(skb);
		return -ENXIO;
	}
Linus Torvalds's avatar
Linus Torvalds committed
368

369 370
	/* Incomming skb */
	bt_cb(skb)->incoming = 1;
Linus Torvalds's avatar
Linus Torvalds committed
371

372 373 374 375 376 377 378
	/* Time stamp */
	do_gettimeofday(&skb->stamp);

	/* Queue frame for rx task */
	skb_queue_tail(&hdev->rx_q, skb);
	hci_sched_rx(hdev);
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
379 380
}

381 382 383
int  hci_dev_proc_init(struct hci_dev *hdev);
void hci_dev_proc_cleanup(struct hci_dev *hdev);

384 385 386 387
/* ----- LMP capabilities ----- */
#define lmp_rswitch_capable(dev) (dev->features[0] & LMP_RSWITCH)
#define lmp_encrypt_capable(dev) (dev->features[0] & LMP_ENCRYPT)

Linus Torvalds's avatar
Linus Torvalds committed
388 389 390
/* ----- HCI protocols ----- */
struct hci_proto {
	char 		*name;
391 392
	unsigned int	id;
	unsigned long	flags;
Linus Torvalds's avatar
Linus Torvalds committed
393 394 395

	void		*priv;

396 397
	int (*connect_ind) 	(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type);
	int (*connect_cfm)	(struct hci_conn *conn, __u8 status);
Linus Torvalds's avatar
Linus Torvalds committed
398
	int (*disconn_ind)	(struct hci_conn *conn, __u8 reason);
399
	int (*recv_acldata)	(struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
Linus Torvalds's avatar
Linus Torvalds committed
400
	int (*recv_scodata)	(struct hci_conn *conn, struct sk_buff *skb);
401 402
	int (*auth_cfm)		(struct hci_conn *conn, __u8 status);
	int (*encrypt_cfm)	(struct hci_conn *conn, __u8 status);
Linus Torvalds's avatar
Linus Torvalds committed
403 404
};

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
static inline int hci_proto_connect_ind(struct hci_dev *hdev, bdaddr_t *bdaddr, __u8 type)
{
	register struct hci_proto *hp;
	int mask = 0;
	
	hp = hci_proto[HCI_PROTO_L2CAP];
	if (hp && hp->connect_ind)
		mask |= hp->connect_ind(hdev, bdaddr, type);

	hp = hci_proto[HCI_PROTO_SCO];
	if (hp && hp->connect_ind)
		mask |= hp->connect_ind(hdev, bdaddr, type);

	return mask;
}

static inline void hci_proto_connect_cfm(struct hci_conn *conn, __u8 status)
{
	register struct hci_proto *hp;

	hp = hci_proto[HCI_PROTO_L2CAP];
	if (hp && hp->connect_cfm)
		hp->connect_cfm(conn, status);

	hp = hci_proto[HCI_PROTO_SCO];
	if (hp && hp->connect_cfm)
		hp->connect_cfm(conn, status);
}

static inline void hci_proto_disconn_ind(struct hci_conn *conn, __u8 reason)
{
	register struct hci_proto *hp;

	hp = hci_proto[HCI_PROTO_L2CAP];
	if (hp && hp->disconn_ind)
		hp->disconn_ind(conn, reason);

	hp = hci_proto[HCI_PROTO_SCO];
	if (hp && hp->disconn_ind)
		hp->disconn_ind(conn, reason);
}

static inline void hci_proto_auth_cfm(struct hci_conn *conn, __u8 status)
{
	register struct hci_proto *hp;

	hp = hci_proto[HCI_PROTO_L2CAP];
	if (hp && hp->auth_cfm)
		hp->auth_cfm(conn, status);

	hp = hci_proto[HCI_PROTO_SCO];
	if (hp && hp->auth_cfm)
		hp->auth_cfm(conn, status);
}

static inline void hci_proto_encrypt_cfm(struct hci_conn *conn, __u8 status)
{
	register struct hci_proto *hp;

	hp = hci_proto[HCI_PROTO_L2CAP];
	if (hp && hp->encrypt_cfm)
		hp->encrypt_cfm(conn, status);

	hp = hci_proto[HCI_PROTO_SCO];
	if (hp && hp->encrypt_cfm)
		hp->encrypt_cfm(conn, status);
}

int hci_register_proto(struct hci_proto *hproto);
int hci_unregister_proto(struct hci_proto *hproto);
int hci_register_notifier(struct notifier_block *nb);
int hci_unregister_notifier(struct notifier_block *nb);

int hci_send_cmd(struct hci_dev *hdev, __u16 ogf, __u16 ocf, __u32 plen, void *param);
int hci_send_acl(struct hci_conn *conn, struct sk_buff *skb, __u16 flags);
int hci_send_sco(struct hci_conn *conn, struct sk_buff *skb);

void *hci_sent_cmd_data(struct hci_dev *hdev, __u16 ogf, __u16 ocf);

void hci_si_event(struct hci_dev *hdev, int type, int dlen, void *data);
Linus Torvalds's avatar
Linus Torvalds committed
485 486

/* ----- HCI Sockets ----- */
487
void hci_send_to_sock(struct hci_dev *hdev, struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
488 489

/* HCI info for socket */
490
#define hci_pi(sk)	((struct hci_pinfo *)sk->sk_protinfo)
Linus Torvalds's avatar
Linus Torvalds committed
491
struct hci_pinfo {
Linus Torvalds's avatar
Linus Torvalds committed
492 493 494
	struct hci_dev 	  *hdev;
	struct hci_filter filter;
	__u32             cmsg_mask;
Linus Torvalds's avatar
Linus Torvalds committed
495 496
};

497
/* HCI security filter */
498
#define HCI_SFLT_MAX_OGF  5
499 500

struct hci_sec_filter {
501 502 503
	unsigned long type_mask;
	unsigned long event_mask[2];
	unsigned long ocf_mask[HCI_SFLT_MAX_OGF + 1][4];
504 505
};

Linus Torvalds's avatar
Linus Torvalds committed
506 507 508 509 510
/* ----- HCI requests ----- */
#define HCI_REQ_DONE	  0
#define HCI_REQ_PEND	  1
#define HCI_REQ_CANCELED  2

511 512 513 514 515 516
#define hci_req_lock(d)		down(&d->req_lock)
#define hci_req_unlock(d)	up(&d->req_lock)

void hci_req_complete(struct hci_dev *hdev, int result);
void hci_req_cancel(struct hci_dev *hdev, int err);

Linus Torvalds's avatar
Linus Torvalds committed
517
#endif /* __HCI_CORE_H */