[mirror_ubuntu-jammy-kernel.git] / include / net / bluetooth / bluetooth.h

/*
   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.
*/

#ifndef __BLUETOOTH_H
#define __BLUETOOTH_H

#include <linux/types.h>
#include <asm/byteorder.h>
#include <linux/list.h>
#include <linux/poll.h>
#include <net/sock.h>

#ifndef AF_BLUETOOTH
#define AF_BLUETOOTH	31
#define PF_BLUETOOTH	AF_BLUETOOTH
#endif

/* Bluetooth versions */
#define BLUETOOTH_VER_1_1	1
#define BLUETOOTH_VER_1_2	2
#define BLUETOOTH_VER_2_0	3

/* Reserv for core and drivers use */
#define BT_SKB_RESERVE	8

#define BTPROTO_L2CAP	0
#define BTPROTO_HCI	1
#define BTPROTO_SCO	2
#define BTPROTO_RFCOMM	3
#define BTPROTO_BNEP	4
#define BTPROTO_CMTP	5
#define BTPROTO_HIDP	6
#define BTPROTO_AVDTP	7

#define SOL_HCI		0
#define SOL_L2CAP	6
#define SOL_SCO		17
#define SOL_RFCOMM	18

#define BT_SECURITY	4
struct bt_security {
	__u8 level;
	__u8 key_size;
};
#define BT_SECURITY_SDP		0
#define BT_SECURITY_LOW		1
#define BT_SECURITY_MEDIUM	2
#define BT_SECURITY_HIGH	3

#define BT_DEFER_SETUP	7

#define BT_FLUSHABLE	8

#define BT_FLUSHABLE_OFF	0
#define BT_FLUSHABLE_ON		1

#define BT_POWER	9
struct bt_power {
	__u8 force_active;
};
#define BT_POWER_FORCE_ACTIVE_OFF 0
#define BT_POWER_FORCE_ACTIVE_ON  1

#define BT_CHANNEL_POLICY	10

/* BR/EDR only (default policy)
 *   AMP controllers cannot be used.
 *   Channel move requests from the remote device are denied.
 *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
 */
#define BT_CHANNEL_POLICY_BREDR_ONLY		0

/* BR/EDR Preferred
 *   Allow use of AMP controllers.
 *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
 *   Channel move requests from the remote device are allowed.
 */
#define BT_CHANNEL_POLICY_BREDR_PREFERRED	1

/* AMP Preferred
 *   Allow use of AMP controllers
 *   If the L2CAP channel is currently on BR/EDR and AMP controller
 *     resources are available, initiate a channel move to AMP.
 *   Channel move requests from the remote device are allowed.
 *   If the L2CAP socket has not been connected yet, try to create
 *     and configure the channel directly on an AMP controller rather
 *     than BR/EDR.
 */
#define BT_CHANNEL_POLICY_AMP_PREFERRED		2

__printf(1, 2)
int bt_info(const char *fmt, ...);
__printf(1, 2)
int bt_err(const char *fmt, ...);

#define BT_INFO(fmt, ...)	bt_info(fmt "\n", ##__VA_ARGS__)
#define BT_ERR(fmt, ...)	bt_err(fmt "\n", ##__VA_ARGS__)
#define BT_DBG(fmt, ...)	pr_debug(fmt "\n", ##__VA_ARGS__)

/* Connection and socket states */
enum {
	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
	BT_OPEN,
	BT_BOUND,
	BT_LISTEN,
	BT_CONNECT,
	BT_CONNECT2,
	BT_CONFIG,
	BT_DISCONN,
	BT_CLOSED
};

/* If unused will be removed by compiler */
static inline const char *state_to_string(int state)
{
	switch (state) {
	case BT_CONNECTED:
		return "BT_CONNECTED";
	case BT_OPEN:
		return "BT_OPEN";
	case BT_BOUND:
		return "BT_BOUND";
	case BT_LISTEN:
		return "BT_LISTEN";
	case BT_CONNECT:
		return "BT_CONNECT";
	case BT_CONNECT2:
		return "BT_CONNECT2";
	case BT_CONFIG:
		return "BT_CONFIG";
	case BT_DISCONN:
		return "BT_DISCONN";
	case BT_CLOSED:
		return "BT_CLOSED";
	}

	return "invalid state";
}

/* BD Address */
typedef struct {
	__u8 b[6];
} __packed bdaddr_t;

/* BD Address type */
#define BDADDR_BREDR		0x00
#define BDADDR_LE_PUBLIC	0x01
#define BDADDR_LE_RANDOM	0x02

#define BDADDR_ANY   (&(bdaddr_t) {{0, 0, 0, 0, 0, 0} })
#define BDADDR_LOCAL (&(bdaddr_t) {{0, 0, 0, 0xff, 0xff, 0xff} })

/* Copy, swap, convert BD Address */
static inline int bacmp(bdaddr_t *ba1, bdaddr_t *ba2)
{
	return memcmp(ba1, ba2, sizeof(bdaddr_t));
}
static inline void bacpy(bdaddr_t *dst, bdaddr_t *src)
{
	memcpy(dst, src, sizeof(bdaddr_t));
}

void baswap(bdaddr_t *dst, bdaddr_t *src);
char *batostr(bdaddr_t *ba);

/* Common socket structures and functions */

#define bt_sk(__sk) ((struct bt_sock *) __sk)

struct bt_sock {
	struct sock sk;
	bdaddr_t    src;
	bdaddr_t    dst;
	struct list_head accept_q;
	struct sock *parent;
	unsigned long flags;
};

enum {
	BT_SK_DEFER_SETUP,
	BT_SK_SUSPEND,
};

struct bt_sock_list {
	struct hlist_head head;
	rwlock_t          lock;
};

int  bt_sock_register(int proto, const struct net_proto_family *ops);
int  bt_sock_unregister(int proto);
void bt_sock_link(struct bt_sock_list *l, struct sock *s);
void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
int  bt_sock_recvmsg(struct kiocb *iocb, struct socket *sock,
				struct msghdr *msg, size_t len, int flags);
int  bt_sock_stream_recvmsg(struct kiocb *iocb, struct socket *sock,
			struct msghdr *msg, size_t len, int flags);
uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);

void bt_accept_enqueue(struct sock *parent, struct sock *sk);
void bt_accept_unlink(struct sock *sk);
struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);

/* Skb helpers */
struct l2cap_ctrl {
	unsigned int	sframe:1,
			poll:1,
			final:1,
			fcs:1,
			sar:2,
			super:2;
	__u16		reqseq;
	__u16		txseq;
	__u8		retries;
};

struct bt_skb_cb {
	__u8 pkt_type;
	__u8 incoming;
	__u16 expect;
	__u8 force_active;
	struct l2cap_ctrl control;
};
#define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))

static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
{
	struct sk_buff *skb;

	skb = alloc_skb(len + BT_SKB_RESERVE, how);
	if (skb) {
		skb_reserve(skb, BT_SKB_RESERVE);
		bt_cb(skb)->incoming  = 0;
	}
	return skb;
}

static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
					unsigned long len, int nb, int *err)
{
	struct sk_buff *skb;

	skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
	if (skb) {
		skb_reserve(skb, BT_SKB_RESERVE);
		bt_cb(skb)->incoming  = 0;
	}

	if (!skb && *err)
		return NULL;

	*err = sock_error(sk);
	if (*err)
		goto out;

	if (sk->sk_shutdown) {
		*err = -ECONNRESET;
		goto out;
	}

	return skb;

out:
	kfree_skb(skb);
	return NULL;
}

int bt_to_errno(__u16 code);

extern int hci_sock_init(void);
extern void hci_sock_cleanup(void);

extern int bt_sysfs_init(void);
extern void bt_sysfs_cleanup(void);

extern struct dentry *bt_debugfs;

int l2cap_init(void);
void l2cap_exit(void);

int sco_init(void);
void sco_exit(void);

void bt_sock_reclassify_lock(struct sock *sk, int proto);

#endif /* __BLUETOOTH_H */
Commit	Line	Data
38351c66	1	/*
1da177e4 LT	2	BlueZ - Bluetooth protocol stack for Linux
	3	Copyright (C) 2000-2001 Qualcomm Incorporated
	4
	5	Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License version 2 as
	9	published by the Free Software Foundation;
	10
	11	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
	12	OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	13	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
	14	IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
38351c66 GP	15	CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
	16	WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	17	ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1da177e4 LT	18	OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1da177e4 LT	19
38351c66 GP	20	ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
38351c66 GP	21	COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
1da177e4 LT	22	SOFTWARE IS DISCLAIMED.
	23	*/
	24
	25	#ifndef __BLUETOOTH_H
	26	#define __BLUETOOTH_H
	27
c3c7ea65	28	#include <linux/types.h>
1da177e4 LT	29	#include <asm/byteorder.h>
	30	#include <linux/list.h>
	31	#include <linux/poll.h>
	32	#include <net/sock.h>
	33
	34	#ifndef AF_BLUETOOTH
	35	#define AF_BLUETOOTH 31
	36	#define PF_BLUETOOTH AF_BLUETOOTH
	37	#endif
	38
d095c1eb AE	39	/* Bluetooth versions */
	40	#define BLUETOOTH_VER_1_1 1
	41	#define BLUETOOTH_VER_1_2 2
	42	#define BLUETOOTH_VER_2_0 3
	43
1da177e4 LT	44	/* Reserv for core and drivers use */
	45	#define BT_SKB_RESERVE 8
	46
	47	#define BTPROTO_L2CAP 0
	48	#define BTPROTO_HCI 1
	49	#define BTPROTO_SCO 2
	50	#define BTPROTO_RFCOMM 3
	51	#define BTPROTO_BNEP 4
	52	#define BTPROTO_CMTP 5
	53	#define BTPROTO_HIDP 6
	54	#define BTPROTO_AVDTP 7
	55
	56	#define SOL_HCI 0
	57	#define SOL_L2CAP 6
	58	#define SOL_SCO 17
	59	#define SOL_RFCOMM 18
	60
8c1b2355 MH	61	#define BT_SECURITY 4
	62	struct bt_security {
	63	__u8 level;
8f360119	64	__u8 key_size;
8c1b2355 MH	65	};
	66	#define BT_SECURITY_SDP 0
	67	#define BT_SECURITY_LOW 1
	68	#define BT_SECURITY_MEDIUM 2
	69	#define BT_SECURITY_HIGH 3
	70
c4f912e1 MH	71	#define BT_DEFER_SETUP 7
c4f912e1 MH	72
e702112f AE	73	#define BT_FLUSHABLE 8
	74
	75	#define BT_FLUSHABLE_OFF 0
	76	#define BT_FLUSHABLE_ON 1
	77
14b12d0b JG	78	#define BT_POWER 9
	79	struct bt_power {
	80	__u8 force_active;
	81	};
	82	#define BT_POWER_FORCE_ACTIVE_OFF 0
	83	#define BT_POWER_FORCE_ACTIVE_ON 1
	84
c14968b0 MM	85	#define BT_CHANNEL_POLICY 10
	86
	87	/* BR/EDR only (default policy)
	88	* AMP controllers cannot be used.
	89	* Channel move requests from the remote device are denied.
	90	* If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
	91	*/
	92	#define BT_CHANNEL_POLICY_BREDR_ONLY 0
	93
	94	/* BR/EDR Preferred
	95	* Allow use of AMP controllers.
	96	* If the L2CAP channel is currently on AMP, move it to BR/EDR.
	97	* Channel move requests from the remote device are allowed.
	98	*/
	99	#define BT_CHANNEL_POLICY_BREDR_PREFERRED 1
	100
	101	/* AMP Preferred
	102	* Allow use of AMP controllers
	103	* If the L2CAP channel is currently on BR/EDR and AMP controller
	104	* resources are available, initiate a channel move to AMP.
	105	* Channel move requests from the remote device are allowed.
	106	* If the L2CAP socket has not been connected yet, try to create
	107	* and configure the channel directly on an AMP controller rather
	108	* than BR/EDR.
	109	*/
	110	#define BT_CHANNEL_POLICY_AMP_PREFERRED 2
	111
3ed7003e JP	112	__printf(1, 2)
	113	int bt_info(const char *fmt, ...);
	114	__printf(1, 2)
	115	int bt_err(const char *fmt, ...);
	116
	117	#define BT_INFO(fmt, ...) bt_info(fmt "\n", ##__VA_ARGS__)
	118	#define BT_ERR(fmt, ...) bt_err(fmt "\n", ##__VA_ARGS__)
	119	#define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__)
1da177e4	120
1da177e4 LT	121	/* Connection and socket states */
	122	enum {
	123	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
	124	BT_OPEN,
	125	BT_BOUND,
	126	BT_LISTEN,
	127	BT_CONNECT,
	128	BT_CONNECT2,
	129	BT_CONFIG,
	130	BT_DISCONN,
	131	BT_CLOSED
	132	};
	133
20d1803a AE	134	/* If unused will be removed by compiler */
	135	static inline const char *state_to_string(int state)
	136	{
	137	switch (state) {
	138	case BT_CONNECTED:
	139	return "BT_CONNECTED";
	140	case BT_OPEN:
	141	return "BT_OPEN";
	142	case BT_BOUND:
	143	return "BT_BOUND";
	144	case BT_LISTEN:
	145	return "BT_LISTEN";
	146	case BT_CONNECT:
	147	return "BT_CONNECT";
	148	case BT_CONNECT2:
	149	return "BT_CONNECT2";
	150	case BT_CONFIG:
	151	return "BT_CONFIG";
	152	case BT_DISCONN:
	153	return "BT_DISCONN";
	154	case BT_CLOSED:
	155	return "BT_CLOSED";
	156	}
	157
	158	return "invalid state";
	159	}
	160
1da177e4 LT	161	/* BD Address */
	162	typedef struct {
	163	__u8 b[6];
66c853cc	164	} __packed bdaddr_t;
1da177e4	165
591f47f3 AG	166	/* BD Address type */
	167	#define BDADDR_BREDR 0x00
	168	#define BDADDR_LE_PUBLIC 0x01
	169	#define BDADDR_LE_RANDOM 0x02
	170
c3c7ea65 GP	171	#define BDADDR_ANY (&(bdaddr_t) {{0, 0, 0, 0, 0, 0} })
c3c7ea65 GP	172	#define BDADDR_LOCAL (&(bdaddr_t) {{0, 0, 0, 0xff, 0xff, 0xff} })
1da177e4 LT	173
	174	/* Copy, swap, convert BD Address */
	175	static inline int bacmp(bdaddr_t ba1, bdaddr_t ba2)
	176	{
	177	return memcmp(ba1, ba2, sizeof(bdaddr_t));
	178	}
	179	static inline void bacpy(bdaddr_t dst, bdaddr_t src)
	180	{
	181	memcpy(dst, src, sizeof(bdaddr_t));
	182	}
	183
	184	void baswap(bdaddr_t dst, bdaddr_t src);
	185	char batostr(bdaddr_t ba);
1da177e4 LT	186
	187	/* Common socket structures and functions */
	188
	189	#define bt_sk(__sk) ((struct bt_sock *) __sk)
	190
	191	struct bt_sock {
	192	struct sock sk;
	193	bdaddr_t src;
	194	bdaddr_t dst;
	195	struct list_head accept_q;
	196	struct sock *parent;
c5daa683 GP	197	unsigned long flags;
	198	};
	199
	200	enum {
	201	BT_SK_DEFER_SETUP,
	202	BT_SK_SUSPEND,
1da177e4 LT	203	};
	204
	205	struct bt_sock_list {
	206	struct hlist_head head;
	207	rwlock_t lock;
	208	};
	209
ec1b4cf7	210	int bt_sock_register(int proto, const struct net_proto_family *ops);
1da177e4 LT	211	int bt_sock_unregister(int proto);
	212	void bt_sock_link(struct bt_sock_list l, struct sock s);
	213	void bt_sock_unlink(struct bt_sock_list l, struct sock s);
5a9d0a3f WR	214	int bt_sock_recvmsg(struct kiocb iocb, struct socket sock,
5a9d0a3f WR	215	struct msghdr *msg, size_t len, int flags);
796c86ee MM	216	int bt_sock_stream_recvmsg(struct kiocb iocb, struct socket sock,
796c86ee MM	217	struct msghdr *msg, size_t len, int flags);
c3c7ea65	218	uint bt_sock_poll(struct file file, struct socket sock, poll_table *wait);
3241ad82	219	int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
1da177e4 LT	220	int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
	221
	222	void bt_accept_enqueue(struct sock parent, struct sock sk);
	223	void bt_accept_unlink(struct sock *sk);
	224	struct sock bt_accept_dequeue(struct sock parent, struct socket *newsock);
	225
	226	/* Skb helpers */
00e3112c	227	struct l2cap_ctrl {
c3c7ea65 GP	228	unsigned int sframe:1,
	229	poll:1,
	230	final:1,
	231	fcs:1,
	232	sar:2,
	233	super:2;
00e3112c MM	234	__u16 reqseq;
	235	__u16 txseq;
	236	__u8 retries;
	237	};
	238
1da177e4	239	struct bt_skb_cb {
0d48d939 MH	240	__u8 pkt_type;
0d48d939 MH	241	__u8 incoming;
33e882a5	242	__u16 expect;
14b12d0b	243	__u8 force_active;
00e3112c	244	struct l2cap_ctrl control;
1da177e4	245	};
1c2acffb	246	#define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
1da177e4	247
dd0fc66f	248	static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
1da177e4 LT	249	{
	250	struct sk_buff *skb;
	251
c3c7ea65 GP	252	skb = alloc_skb(len + BT_SKB_RESERVE, how);
c3c7ea65 GP	253	if (skb) {
1da177e4 LT	254	skb_reserve(skb, BT_SKB_RESERVE);
	255	bt_cb(skb)->incoming = 0;
	256	}
	257	return skb;
	258	}
	259
5a9d0a3f WR	260	static inline struct sk_buff bt_skb_send_alloc(struct sock sk,
5a9d0a3f WR	261	unsigned long len, int nb, int *err)
1da177e4 LT	262	{
	263	struct sk_buff *skb;
	264
c3c7ea65 GP	265	skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
c3c7ea65 GP	266	if (skb) {
1da177e4 LT	267	skb_reserve(skb, BT_SKB_RESERVE);
	268	bt_cb(skb)->incoming = 0;
	269	}
e454c844 GP	270
	271	if (!skb && *err)
	272	return NULL;
	273
	274	*err = sock_error(sk);
	275	if (*err)
	276	goto out;
	277
	278	if (sk->sk_shutdown) {
	279	*err = -ECONNRESET;
	280	goto out;
	281	}
1da177e4 LT	282
1da177e4 LT	283	return skb;
e454c844 GP	284
	285	out:
	286	kfree_skb(skb);
	287	return NULL;
1da177e4 LT	288	}
1da177e4 LT	289
e175072f	290	int bt_to_errno(__u16 code);
1da177e4	291
6516455d	292	extern int hci_sock_init(void);
04005dd9	293	extern void hci_sock_cleanup(void);
6516455d MH	294
	295	extern int bt_sysfs_init(void);
	296	extern void bt_sysfs_cleanup(void);
	297
aef7d97c	298	extern struct dentry *bt_debugfs;
be9d1227	299
64274518 GP	300	int l2cap_init(void);
64274518 GP	301	void l2cap_exit(void);
64274518	302
64274518 GP	303	int sco_init(void);
64274518 GP	304	void sco_exit(void);
64274518	305
d22015aa OP	306	void bt_sock_reclassify_lock(struct sock *sk, int proto);
d22015aa OP	307
1da177e4	308	#endif /* __BLUETOOTH_H */