blob: 4500bf88ff55c7ca65f8752fb8d5d7fa750c371c [file] [log] [blame]
Gustavo Padovan38351c62012-05-22 19:00:20 -03001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 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
Gustavo Padovan38351c62012-05-22 19:00:20 -030015 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19
Gustavo Padovan38351c62012-05-22 19:00:20 -030020 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
21 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 SOFTWARE IS DISCLAIMED.
23*/
24
25#ifndef __BLUETOOTH_H
26#define __BLUETOOTH_H
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/poll.h>
29#include <net/sock.h>
Masatake YAMATO256a06c2012-07-26 01:26:32 +090030#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#ifndef AF_BLUETOOTH
33#define AF_BLUETOOTH 31
34#define PF_BLUETOOTH AF_BLUETOOTH
35#endif
36
Andrei Emeltchenkod095c1e2011-12-01 14:33:27 +020037/* Bluetooth versions */
38#define BLUETOOTH_VER_1_1 1
39#define BLUETOOTH_VER_1_2 2
40#define BLUETOOTH_VER_2_0 3
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* Reserv for core and drivers use */
43#define BT_SKB_RESERVE 8
44
45#define BTPROTO_L2CAP 0
46#define BTPROTO_HCI 1
47#define BTPROTO_SCO 2
48#define BTPROTO_RFCOMM 3
49#define BTPROTO_BNEP 4
50#define BTPROTO_CMTP 5
51#define BTPROTO_HIDP 6
52#define BTPROTO_AVDTP 7
53
54#define SOL_HCI 0
55#define SOL_L2CAP 6
56#define SOL_SCO 17
57#define SOL_RFCOMM 18
58
Marcel Holtmann8c1b2352009-01-15 21:58:04 +010059#define BT_SECURITY 4
60struct bt_security {
61 __u8 level;
Vinicius Costa Gomes8f360112011-07-08 18:31:46 -030062 __u8 key_size;
Marcel Holtmann8c1b2352009-01-15 21:58:04 +010063};
64#define BT_SECURITY_SDP 0
65#define BT_SECURITY_LOW 1
66#define BT_SECURITY_MEDIUM 2
67#define BT_SECURITY_HIGH 3
Marcel Holtmann7b5a9242014-01-15 22:37:39 -080068#define BT_SECURITY_FIPS 4
Marcel Holtmann8c1b2352009-01-15 21:58:04 +010069
Marcel Holtmannc4f912e2009-01-15 21:52:16 +010070#define BT_DEFER_SETUP 7
71
Andrei Emeltchenkoe7021122011-01-03 11:14:36 +020072#define BT_FLUSHABLE 8
73
74#define BT_FLUSHABLE_OFF 0
75#define BT_FLUSHABLE_ON 1
76
Jaikumar Ganesh14b12d02011-05-23 18:06:04 -070077#define BT_POWER 9
78struct bt_power {
79 __u8 force_active;
80};
81#define BT_POWER_FORCE_ACTIVE_OFF 0
82#define BT_POWER_FORCE_ACTIVE_ON 1
83
Mat Martineauc14968b2011-11-02 16:18:28 -070084#define BT_CHANNEL_POLICY 10
85
86/* BR/EDR only (default policy)
87 * AMP controllers cannot be used.
88 * Channel move requests from the remote device are denied.
89 * If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
90 */
91#define BT_CHANNEL_POLICY_BREDR_ONLY 0
92
93/* BR/EDR Preferred
94 * Allow use of AMP controllers.
95 * If the L2CAP channel is currently on AMP, move it to BR/EDR.
96 * Channel move requests from the remote device are allowed.
97 */
98#define BT_CHANNEL_POLICY_BREDR_PREFERRED 1
99
100/* AMP Preferred
101 * Allow use of AMP controllers
102 * If the L2CAP channel is currently on BR/EDR and AMP controller
103 * resources are available, initiate a channel move to AMP.
104 * Channel move requests from the remote device are allowed.
105 * If the L2CAP socket has not been connected yet, try to create
106 * and configure the channel directly on an AMP controller rather
107 * than BR/EDR.
108 */
109#define BT_CHANNEL_POLICY_AMP_PREFERRED 2
110
Frédéric Dalleauad10b1a2013-08-19 14:23:56 +0200111#define BT_VOICE 11
112struct bt_voice {
113 __u16 setting;
114};
115
116#define BT_VOICE_TRANSPARENT 0x0003
117#define BT_VOICE_CVSD_16BIT 0x0060
118
Johan Hedberg1f435422013-12-02 16:34:18 +0200119#define BT_SNDMTU 12
120#define BT_RCVMTU 13
121
Joe Perches3ed70032012-02-16 23:32:42 -0800122__printf(1, 2)
Joe Perches2b0bf6c2014-09-22 11:17:41 -0700123void bt_info(const char *fmt, ...);
Joe Perches3ed70032012-02-16 23:32:42 -0800124__printf(1, 2)
Joe Perches2b0bf6c2014-09-22 11:17:41 -0700125void bt_err(const char *fmt, ...);
Joe Perchese1447d82011-06-30 19:15:37 -0300126
Joe Perches3ed70032012-02-16 23:32:42 -0800127#define BT_INFO(fmt, ...) bt_info(fmt "\n", ##__VA_ARGS__)
128#define BT_ERR(fmt, ...) bt_err(fmt "\n", ##__VA_ARGS__)
129#define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131/* Connection and socket states */
132enum {
133 BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
134 BT_OPEN,
135 BT_BOUND,
136 BT_LISTEN,
137 BT_CONNECT,
138 BT_CONNECT2,
139 BT_CONFIG,
140 BT_DISCONN,
141 BT_CLOSED
142};
143
Andrei Emeltchenko20d18032012-02-17 11:40:55 +0200144/* If unused will be removed by compiler */
145static inline const char *state_to_string(int state)
146{
147 switch (state) {
148 case BT_CONNECTED:
149 return "BT_CONNECTED";
150 case BT_OPEN:
151 return "BT_OPEN";
152 case BT_BOUND:
153 return "BT_BOUND";
154 case BT_LISTEN:
155 return "BT_LISTEN";
156 case BT_CONNECT:
157 return "BT_CONNECT";
158 case BT_CONNECT2:
159 return "BT_CONNECT2";
160 case BT_CONFIG:
161 return "BT_CONFIG";
162 case BT_DISCONN:
163 return "BT_DISCONN";
164 case BT_CLOSED:
165 return "BT_CLOSED";
166 }
167
168 return "invalid state";
169}
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171/* BD Address */
172typedef struct {
173 __u8 b[6];
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300174} __packed bdaddr_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Andre Guedes591f47f2012-04-24 21:02:49 -0300176/* BD Address type */
177#define BDADDR_BREDR 0x00
178#define BDADDR_LE_PUBLIC 0x01
179#define BDADDR_LE_RANDOM 0x02
180
Johan Hedberg679efe22013-01-20 14:27:18 +0200181static inline bool bdaddr_type_is_valid(__u8 type)
182{
183 switch (type) {
184 case BDADDR_BREDR:
185 case BDADDR_LE_PUBLIC:
186 case BDADDR_LE_RANDOM:
187 return true;
188 }
189
190 return false;
191}
192
193static inline bool bdaddr_type_is_le(__u8 type)
194{
195 switch (type) {
196 case BDADDR_LE_PUBLIC:
197 case BDADDR_LE_RANDOM:
198 return true;
199 }
200
201 return false;
202}
203
Marcel Holtmanna59ac2f2013-10-01 22:59:21 -0700204#define BDADDR_ANY (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
205#define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207/* Copy, swap, convert BD Address */
David Herrmannf53c20e2013-04-06 20:28:42 +0200208static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209{
210 return memcmp(ba1, ba2, sizeof(bdaddr_t));
211}
David Herrmannf53c20e2013-04-06 20:28:42 +0200212static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
214 memcpy(dst, src, sizeof(bdaddr_t));
215}
216
217void baswap(bdaddr_t *dst, bdaddr_t *src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/* Common socket structures and functions */
220
221#define bt_sk(__sk) ((struct bt_sock *) __sk)
222
223struct bt_sock {
224 struct sock sk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 struct list_head accept_q;
226 struct sock *parent;
Gustavo Padovanc5daa682012-05-16 12:17:10 -0300227 unsigned long flags;
Marcel Holtmannd9763692013-10-13 12:55:28 -0700228 void (*skb_msg_name)(struct sk_buff *, void *, int *);
Gustavo Padovanc5daa682012-05-16 12:17:10 -0300229};
230
231enum {
232 BT_SK_DEFER_SETUP,
233 BT_SK_SUSPEND,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234};
235
236struct bt_sock_list {
237 struct hlist_head head;
238 rwlock_t lock;
Masatake YAMATO256a06c2012-07-26 01:26:32 +0900239#ifdef CONFIG_PROC_FS
Masatake YAMATO256a06c2012-07-26 01:26:32 +0900240 int (* custom_seq_show)(struct seq_file *, void *);
241#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242};
243
Stephen Hemmingerec1b4cf2009-10-05 05:58:39 +0000244int bt_sock_register(int proto, const struct net_proto_family *ops);
David Herrmannbe9f97f2013-02-24 19:36:52 +0100245void bt_sock_unregister(int proto);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246void bt_sock_link(struct bt_sock_list *l, struct sock *s);
247void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
Waldemar Rymarkiewicz5a9d0a32011-06-07 11:18:06 +0200248int bt_sock_recvmsg(struct kiocb *iocb, struct socket *sock,
249 struct msghdr *msg, size_t len, int flags);
Mat Martineau796c86e2010-09-08 10:05:27 -0700250int bt_sock_stream_recvmsg(struct kiocb *iocb, struct socket *sock,
251 struct msghdr *msg, size_t len, int flags);
Gustavo Padovanc3c7ea62012-05-23 04:04:20 -0300252uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
Marcel Holtmann3241ad82008-07-14 20:13:50 +0200253int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
Johan Hedberge793dcf2013-09-16 13:05:19 +0300255int bt_sock_wait_ready(struct sock *sk, unsigned long flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257void bt_accept_enqueue(struct sock *parent, struct sock *sk);
258void bt_accept_unlink(struct sock *sk);
259struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
260
261/* Skb helpers */
Mat Martineau00e31122012-03-23 16:56:56 -0700262struct l2cap_ctrl {
Marcel Holtmann07758992014-06-08 10:26:57 +0200263 __u8 sframe:1,
264 poll:1,
265 final:1,
266 fcs:1,
267 sar:2,
268 super:2;
269 __u16 reqseq;
270 __u16 txseq;
271 __u8 retries;
Mat Martineau00e31122012-03-23 16:56:56 -0700272};
273
Johan Hedberg3119ae92013-03-05 20:37:44 +0200274struct hci_dev;
275
Marcel Holtmann1904a852015-01-11 13:50:44 -0800276typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
Johan Hedberg3119ae92013-03-05 20:37:44 +0200277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278struct bt_skb_cb {
Marcel Holtmann0d48d932005-08-09 20:30:28 -0700279 __u8 pkt_type;
Eyal Birger6368c232015-03-01 14:58:26 +0200280 __u8 force_active;
Marcel Holtmann43e73e42014-09-14 23:06:28 +0200281 __u16 opcode;
Suraj Sumangala33e882a2010-07-14 13:02:17 +0530282 __u16 expect;
Eyal Birger6368c232015-03-01 14:58:26 +0200283 __u8 incoming:1;
284 __u8 req_start:1;
Eyal Birger49a6fe02015-03-01 14:58:25 +0200285 u8 req_event;
286 hci_req_complete_t req_complete;
Gustavo Padovan0e790c62013-10-21 18:22:24 -0200287 struct l2cap_chan *chan;
Mat Martineau00e31122012-03-23 16:56:56 -0700288 struct l2cap_ctrl control;
Marcel Holtmann2edf8702013-10-13 12:55:29 -0700289 bdaddr_t bdaddr;
290 __le16 psm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291};
Gustavo F. Padovan1c2acff2009-08-20 22:25:57 -0300292#define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Al Virodd0fc662005-10-07 07:46:04 +0100294static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295{
296 struct sk_buff *skb;
297
Gustavo Padovanc3c7ea62012-05-23 04:04:20 -0300298 skb = alloc_skb(len + BT_SKB_RESERVE, how);
299 if (skb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 skb_reserve(skb, BT_SKB_RESERVE);
301 bt_cb(skb)->incoming = 0;
302 }
303 return skb;
304}
305
Waldemar Rymarkiewicz5a9d0a32011-06-07 11:18:06 +0200306static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
307 unsigned long len, int nb, int *err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
309 struct sk_buff *skb;
310
Gustavo Padovanc3c7ea62012-05-23 04:04:20 -0300311 skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
312 if (skb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 skb_reserve(skb, BT_SKB_RESERVE);
314 bt_cb(skb)->incoming = 0;
315 }
Gustavo F. Padovane454c842010-09-21 16:31:11 -0300316
317 if (!skb && *err)
318 return NULL;
319
320 *err = sock_error(sk);
321 if (*err)
322 goto out;
323
324 if (sk->sk_shutdown) {
325 *err = -ECONNRESET;
326 goto out;
327 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329 return skb;
Gustavo F. Padovane454c842010-09-21 16:31:11 -0300330
331out:
332 kfree_skb(skb);
333 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
Joe Perchese1750722011-06-29 18:18:29 -0700336int bt_to_errno(__u16 code);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Joe Perchese74e58f2013-09-23 11:37:36 -0700338int hci_sock_init(void);
339void hci_sock_cleanup(void);
Marcel Holtmann65164552005-10-28 19:20:48 +0200340
Joe Perchese74e58f2013-09-23 11:37:36 -0700341int bt_sysfs_init(void);
342void bt_sysfs_cleanup(void);
Marcel Holtmann65164552005-10-28 19:20:48 +0200343
Joe Perchese74e58f2013-09-23 11:37:36 -0700344int bt_procfs_init(struct net *net, const char *name,
345 struct bt_sock_list *sk_list,
346 int (*seq_show)(struct seq_file *, void *));
347void bt_procfs_cleanup(struct net *net, const char *name);
Masatake YAMATO256a06c2012-07-26 01:26:32 +0900348
Marcel Holtmannaef7d972010-03-21 05:27:45 +0100349extern struct dentry *bt_debugfs;
Marcel Holtmannbe9d1222005-11-08 09:57:38 -0800350
Gustavo F. Padovan64274512011-02-07 20:08:52 -0200351int l2cap_init(void);
352void l2cap_exit(void);
Gustavo F. Padovan64274512011-02-07 20:08:52 -0200353
Gustavo F. Padovan64274512011-02-07 20:08:52 -0200354int sco_init(void);
355void sco_exit(void);
Gustavo F. Padovan64274512011-02-07 20:08:52 -0200356
Octavian Purdilad22015a2012-01-22 00:28:34 +0200357void bt_sock_reclassify_lock(struct sock *sk, int proto);
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359#endif /* __BLUETOOTH_H */