Merge tag 'bootconfig-fixes-v6.9-rc4' of git://git.kernel.org/pub/scm/linux/kernel...
[sfrench/cifs-2.6.git] / include / net / bluetooth / bluetooth.h
1 /*
2    BlueZ - Bluetooth protocol stack for Linux
3    Copyright (C) 2000-2001 Qualcomm Incorporated
4    Copyright 2023 NXP
5
6    Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License version 2 as
10    published by the Free Software Foundation;
11
12    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
13    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
15    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
16    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
17    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20
21    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
22    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
23    SOFTWARE IS DISCLAIMED.
24 */
25
26 #ifndef __BLUETOOTH_H
27 #define __BLUETOOTH_H
28
29 #include <linux/poll.h>
30 #include <net/sock.h>
31 #include <linux/seq_file.h>
32
33 #define BT_SUBSYS_VERSION       2
34 #define BT_SUBSYS_REVISION      22
35
36 #ifndef AF_BLUETOOTH
37 #define AF_BLUETOOTH    31
38 #define PF_BLUETOOTH    AF_BLUETOOTH
39 #endif
40
41 /* Bluetooth versions */
42 #define BLUETOOTH_VER_1_1       1
43 #define BLUETOOTH_VER_1_2       2
44 #define BLUETOOTH_VER_2_0       3
45 #define BLUETOOTH_VER_2_1       4
46 #define BLUETOOTH_VER_4_0       6
47
48 /* Reserv for core and drivers use */
49 #define BT_SKB_RESERVE  8
50
51 #define BTPROTO_L2CAP   0
52 #define BTPROTO_HCI     1
53 #define BTPROTO_SCO     2
54 #define BTPROTO_RFCOMM  3
55 #define BTPROTO_BNEP    4
56 #define BTPROTO_CMTP    5
57 #define BTPROTO_HIDP    6
58 #define BTPROTO_AVDTP   7
59 #define BTPROTO_ISO     8
60 #define BTPROTO_LAST    BTPROTO_ISO
61
62 #define SOL_HCI         0
63 #define SOL_L2CAP       6
64 #define SOL_SCO         17
65 #define SOL_RFCOMM      18
66
67 #define BT_SECURITY     4
68 struct bt_security {
69         __u8 level;
70         __u8 key_size;
71 };
72 #define BT_SECURITY_SDP         0
73 #define BT_SECURITY_LOW         1
74 #define BT_SECURITY_MEDIUM      2
75 #define BT_SECURITY_HIGH        3
76 #define BT_SECURITY_FIPS        4
77
78 #define BT_DEFER_SETUP  7
79
80 #define BT_FLUSHABLE    8
81
82 #define BT_FLUSHABLE_OFF        0
83 #define BT_FLUSHABLE_ON         1
84
85 #define BT_POWER        9
86 struct bt_power {
87         __u8 force_active;
88 };
89 #define BT_POWER_FORCE_ACTIVE_OFF 0
90 #define BT_POWER_FORCE_ACTIVE_ON  1
91
92 #define BT_CHANNEL_POLICY       10
93
94 /* BR/EDR only (default policy)
95  *   AMP controllers cannot be used.
96  *   Channel move requests from the remote device are denied.
97  *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
98  */
99 #define BT_CHANNEL_POLICY_BREDR_ONLY            0
100
101 /* BR/EDR Preferred
102  *   Allow use of AMP controllers.
103  *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
104  *   Channel move requests from the remote device are allowed.
105  */
106 #define BT_CHANNEL_POLICY_BREDR_PREFERRED       1
107
108 /* AMP Preferred
109  *   Allow use of AMP controllers
110  *   If the L2CAP channel is currently on BR/EDR and AMP controller
111  *     resources are available, initiate a channel move to AMP.
112  *   Channel move requests from the remote device are allowed.
113  *   If the L2CAP socket has not been connected yet, try to create
114  *     and configure the channel directly on an AMP controller rather
115  *     than BR/EDR.
116  */
117 #define BT_CHANNEL_POLICY_AMP_PREFERRED         2
118
119 #define BT_VOICE                11
120 struct bt_voice {
121         __u16 setting;
122 };
123
124 #define BT_VOICE_TRANSPARENT                    0x0003
125 #define BT_VOICE_CVSD_16BIT                     0x0060
126
127 #define BT_SNDMTU               12
128 #define BT_RCVMTU               13
129 #define BT_PHY                  14
130
131 #define BT_PHY_BR_1M_1SLOT      0x00000001
132 #define BT_PHY_BR_1M_3SLOT      0x00000002
133 #define BT_PHY_BR_1M_5SLOT      0x00000004
134 #define BT_PHY_EDR_2M_1SLOT     0x00000008
135 #define BT_PHY_EDR_2M_3SLOT     0x00000010
136 #define BT_PHY_EDR_2M_5SLOT     0x00000020
137 #define BT_PHY_EDR_3M_1SLOT     0x00000040
138 #define BT_PHY_EDR_3M_3SLOT     0x00000080
139 #define BT_PHY_EDR_3M_5SLOT     0x00000100
140 #define BT_PHY_LE_1M_TX         0x00000200
141 #define BT_PHY_LE_1M_RX         0x00000400
142 #define BT_PHY_LE_2M_TX         0x00000800
143 #define BT_PHY_LE_2M_RX         0x00001000
144 #define BT_PHY_LE_CODED_TX      0x00002000
145 #define BT_PHY_LE_CODED_RX      0x00004000
146
147 #define BT_MODE                 15
148
149 #define BT_MODE_BASIC           0x00
150 #define BT_MODE_ERTM            0x01
151 #define BT_MODE_STREAMING       0x02
152 #define BT_MODE_LE_FLOWCTL      0x03
153 #define BT_MODE_EXT_FLOWCTL     0x04
154
155 #define BT_PKT_STATUS           16
156
157 #define BT_SCM_PKT_STATUS       0x03
158
159 #define BT_ISO_QOS              17
160
161 #define BT_ISO_QOS_CIG_UNSET    0xff
162 #define BT_ISO_QOS_CIS_UNSET    0xff
163
164 #define BT_ISO_QOS_BIG_UNSET    0xff
165 #define BT_ISO_QOS_BIS_UNSET    0xff
166
167 #define BT_ISO_SYNC_TIMEOUT     0x07d0 /* 20 secs */
168
169 struct bt_iso_io_qos {
170         __u32 interval;
171         __u16 latency;
172         __u16 sdu;
173         __u8  phy;
174         __u8  rtn;
175 };
176
177 struct bt_iso_ucast_qos {
178         __u8  cig;
179         __u8  cis;
180         __u8  sca;
181         __u8  packing;
182         __u8  framing;
183         struct bt_iso_io_qos in;
184         struct bt_iso_io_qos out;
185 };
186
187 struct bt_iso_bcast_qos {
188         __u8  big;
189         __u8  bis;
190         __u8  sync_factor;
191         __u8  packing;
192         __u8  framing;
193         struct bt_iso_io_qos in;
194         struct bt_iso_io_qos out;
195         __u8  encryption;
196         __u8  bcode[16];
197         __u8  options;
198         __u16 skip;
199         __u16 sync_timeout;
200         __u8  sync_cte_type;
201         __u8  mse;
202         __u16 timeout;
203 };
204
205 struct bt_iso_qos {
206         union {
207                 struct bt_iso_ucast_qos ucast;
208                 struct bt_iso_bcast_qos bcast;
209         };
210 };
211
212 #define BT_ISO_PHY_1M           0x01
213 #define BT_ISO_PHY_2M           0x02
214 #define BT_ISO_PHY_CODED        0x04
215 #define BT_ISO_PHY_ANY          (BT_ISO_PHY_1M | BT_ISO_PHY_2M | \
216                                  BT_ISO_PHY_CODED)
217
218 #define BT_CODEC        19
219
220 struct  bt_codec_caps {
221         __u8    len;
222         __u8    data[];
223 } __packed;
224
225 struct bt_codec {
226         __u8    id;
227         __u16   cid;
228         __u16   vid;
229         __u8    data_path;
230         __u8    num_caps;
231 } __packed;
232
233 struct bt_codecs {
234         __u8            num_codecs;
235         struct bt_codec codecs[];
236 } __packed;
237
238 #define BT_CODEC_CVSD           0x02
239 #define BT_CODEC_TRANSPARENT    0x03
240 #define BT_CODEC_MSBC           0x05
241
242 #define BT_ISO_BASE             20
243
244 __printf(1, 2)
245 void bt_info(const char *fmt, ...);
246 __printf(1, 2)
247 void bt_warn(const char *fmt, ...);
248 __printf(1, 2)
249 void bt_err(const char *fmt, ...);
250 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG)
251 void bt_dbg_set(bool enable);
252 bool bt_dbg_get(void);
253 __printf(1, 2)
254 void bt_dbg(const char *fmt, ...);
255 #endif
256 __printf(1, 2)
257 void bt_warn_ratelimited(const char *fmt, ...);
258 __printf(1, 2)
259 void bt_err_ratelimited(const char *fmt, ...);
260
261 #define BT_INFO(fmt, ...)       bt_info(fmt "\n", ##__VA_ARGS__)
262 #define BT_WARN(fmt, ...)       bt_warn(fmt "\n", ##__VA_ARGS__)
263 #define BT_ERR(fmt, ...)        bt_err(fmt "\n", ##__VA_ARGS__)
264
265 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG)
266 #define BT_DBG(fmt, ...)        bt_dbg(fmt "\n", ##__VA_ARGS__)
267 #else
268 #define BT_DBG(fmt, ...)        pr_debug(fmt "\n", ##__VA_ARGS__)
269 #endif
270
271 #define bt_dev_name(hdev) ((hdev) ? (hdev)->name : "null")
272
273 #define bt_dev_info(hdev, fmt, ...)                             \
274         BT_INFO("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
275 #define bt_dev_warn(hdev, fmt, ...)                             \
276         BT_WARN("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
277 #define bt_dev_err(hdev, fmt, ...)                              \
278         BT_ERR("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
279 #define bt_dev_dbg(hdev, fmt, ...)                              \
280         BT_DBG("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
281
282 #define bt_dev_warn_ratelimited(hdev, fmt, ...)                 \
283         bt_warn_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
284 #define bt_dev_err_ratelimited(hdev, fmt, ...)                  \
285         bt_err_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
286
287 /* Connection and socket states */
288 enum {
289         BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
290         BT_OPEN,
291         BT_BOUND,
292         BT_LISTEN,
293         BT_CONNECT,
294         BT_CONNECT2,
295         BT_CONFIG,
296         BT_DISCONN,
297         BT_CLOSED
298 };
299
300 /* If unused will be removed by compiler */
301 static inline const char *state_to_string(int state)
302 {
303         switch (state) {
304         case BT_CONNECTED:
305                 return "BT_CONNECTED";
306         case BT_OPEN:
307                 return "BT_OPEN";
308         case BT_BOUND:
309                 return "BT_BOUND";
310         case BT_LISTEN:
311                 return "BT_LISTEN";
312         case BT_CONNECT:
313                 return "BT_CONNECT";
314         case BT_CONNECT2:
315                 return "BT_CONNECT2";
316         case BT_CONFIG:
317                 return "BT_CONFIG";
318         case BT_DISCONN:
319                 return "BT_DISCONN";
320         case BT_CLOSED:
321                 return "BT_CLOSED";
322         }
323
324         return "invalid state";
325 }
326
327 /* BD Address */
328 typedef struct {
329         __u8 b[6];
330 } __packed bdaddr_t;
331
332 /* BD Address type */
333 #define BDADDR_BREDR            0x00
334 #define BDADDR_LE_PUBLIC        0x01
335 #define BDADDR_LE_RANDOM        0x02
336
337 static inline bool bdaddr_type_is_valid(u8 type)
338 {
339         switch (type) {
340         case BDADDR_BREDR:
341         case BDADDR_LE_PUBLIC:
342         case BDADDR_LE_RANDOM:
343                 return true;
344         }
345
346         return false;
347 }
348
349 static inline bool bdaddr_type_is_le(u8 type)
350 {
351         switch (type) {
352         case BDADDR_LE_PUBLIC:
353         case BDADDR_LE_RANDOM:
354                 return true;
355         }
356
357         return false;
358 }
359
360 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
361 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
362
363 /* Copy, swap, convert BD Address */
364 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
365 {
366         return memcmp(ba1, ba2, sizeof(bdaddr_t));
367 }
368 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
369 {
370         memcpy(dst, src, sizeof(bdaddr_t));
371 }
372
373 void baswap(bdaddr_t *dst, const bdaddr_t *src);
374
375 /* Common socket structures and functions */
376
377 #define bt_sk(__sk) ((struct bt_sock *) __sk)
378
379 struct bt_sock {
380         struct sock sk;
381         struct list_head accept_q;
382         struct sock *parent;
383         unsigned long flags;
384         void (*skb_msg_name)(struct sk_buff *, void *, int *);
385         void (*skb_put_cmsg)(struct sk_buff *, struct msghdr *, struct sock *);
386 };
387
388 enum {
389         BT_SK_DEFER_SETUP,
390         BT_SK_SUSPEND,
391         BT_SK_PKT_STATUS
392 };
393
394 struct bt_sock_list {
395         struct hlist_head head;
396         rwlock_t          lock;
397 #ifdef CONFIG_PROC_FS
398         int (* custom_seq_show)(struct seq_file *, void *);
399 #endif
400 };
401
402 int  bt_sock_register(int proto, const struct net_proto_family *ops);
403 void bt_sock_unregister(int proto);
404 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
405 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
406 struct sock *bt_sock_alloc(struct net *net, struct socket *sock,
407                            struct proto *prot, int proto, gfp_t prio, int kern);
408 int  bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
409                      int flags);
410 int  bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
411                             size_t len, int flags);
412 __poll_t bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
413 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
414 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
415 int  bt_sock_wait_ready(struct sock *sk, unsigned int msg_flags);
416
417 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh);
418 void bt_accept_unlink(struct sock *sk);
419 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
420
421 /* Skb helpers */
422 struct l2cap_ctrl {
423         u8      sframe:1,
424                 poll:1,
425                 final:1,
426                 fcs:1,
427                 sar:2,
428                 super:2;
429
430         u16     reqseq;
431         u16     txseq;
432         u8      retries;
433         __le16  psm;
434         bdaddr_t bdaddr;
435         struct l2cap_chan *chan;
436 };
437
438 struct hci_dev;
439
440 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
441 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
442                                        u16 opcode, struct sk_buff *skb);
443
444 #define HCI_REQ_START   BIT(0)
445 #define HCI_REQ_SKB     BIT(1)
446
447 struct hci_ctrl {
448         struct sock *sk;
449         u16 opcode;
450         u8 req_flags;
451         u8 req_event;
452         union {
453                 hci_req_complete_t req_complete;
454                 hci_req_complete_skb_t req_complete_skb;
455         };
456 };
457
458 struct mgmt_ctrl {
459         struct hci_dev *hdev;
460         u16 opcode;
461 };
462
463 struct bt_skb_cb {
464         u8 pkt_type;
465         u8 force_active;
466         u16 expect;
467         u8 incoming:1;
468         u8 pkt_status:2;
469         union {
470                 struct l2cap_ctrl l2cap;
471                 struct hci_ctrl hci;
472                 struct mgmt_ctrl mgmt;
473                 struct scm_creds creds;
474         };
475 };
476 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
477
478 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
479 #define hci_skb_pkt_status(skb) bt_cb((skb))->pkt_status
480 #define hci_skb_expect(skb) bt_cb((skb))->expect
481 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
482 #define hci_skb_event(skb) bt_cb((skb))->hci.req_event
483 #define hci_skb_sk(skb) bt_cb((skb))->hci.sk
484
485 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
486 {
487         struct sk_buff *skb;
488
489         skb = alloc_skb(len + BT_SKB_RESERVE, how);
490         if (skb)
491                 skb_reserve(skb, BT_SKB_RESERVE);
492         return skb;
493 }
494
495 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
496                                         unsigned long len, int nb, int *err)
497 {
498         struct sk_buff *skb;
499
500         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
501         if (skb)
502                 skb_reserve(skb, BT_SKB_RESERVE);
503
504         if (!skb && *err)
505                 return NULL;
506
507         *err = sock_error(sk);
508         if (*err)
509                 goto out;
510
511         if (sk->sk_shutdown) {
512                 *err = -ECONNRESET;
513                 goto out;
514         }
515
516         return skb;
517
518 out:
519         kfree_skb(skb);
520         return NULL;
521 }
522
523 /* Shall not be called with lock_sock held */
524 static inline struct sk_buff *bt_skb_sendmsg(struct sock *sk,
525                                              struct msghdr *msg,
526                                              size_t len, size_t mtu,
527                                              size_t headroom, size_t tailroom)
528 {
529         struct sk_buff *skb;
530         size_t size = min_t(size_t, len, mtu);
531         int err;
532
533         skb = bt_skb_send_alloc(sk, size + headroom + tailroom,
534                                 msg->msg_flags & MSG_DONTWAIT, &err);
535         if (!skb)
536                 return ERR_PTR(err);
537
538         skb_reserve(skb, headroom);
539         skb_tailroom_reserve(skb, mtu, tailroom);
540
541         if (!copy_from_iter_full(skb_put(skb, size), size, &msg->msg_iter)) {
542                 kfree_skb(skb);
543                 return ERR_PTR(-EFAULT);
544         }
545
546         skb->priority = READ_ONCE(sk->sk_priority);
547
548         return skb;
549 }
550
551 /* Similar to bt_skb_sendmsg but can split the msg into multiple fragments
552  * accourding to the MTU.
553  */
554 static inline struct sk_buff *bt_skb_sendmmsg(struct sock *sk,
555                                               struct msghdr *msg,
556                                               size_t len, size_t mtu,
557                                               size_t headroom, size_t tailroom)
558 {
559         struct sk_buff *skb, **frag;
560
561         skb = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
562         if (IS_ERR(skb))
563                 return skb;
564
565         len -= skb->len;
566         if (!len)
567                 return skb;
568
569         /* Add remaining data over MTU as continuation fragments */
570         frag = &skb_shinfo(skb)->frag_list;
571         while (len) {
572                 struct sk_buff *tmp;
573
574                 tmp = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
575                 if (IS_ERR(tmp)) {
576                         return skb;
577                 }
578
579                 len -= tmp->len;
580
581                 *frag = tmp;
582                 frag = &(*frag)->next;
583         }
584
585         return skb;
586 }
587
588 static inline int bt_copy_from_sockptr(void *dst, size_t dst_size,
589                                        sockptr_t src, size_t src_size)
590 {
591         if (dst_size > src_size)
592                 return -EINVAL;
593
594         return copy_from_sockptr(dst, src, dst_size);
595 }
596
597 int bt_to_errno(u16 code);
598 __u8 bt_status(int err);
599
600 void hci_sock_set_flag(struct sock *sk, int nr);
601 void hci_sock_clear_flag(struct sock *sk, int nr);
602 int hci_sock_test_flag(struct sock *sk, int nr);
603 unsigned short hci_sock_get_channel(struct sock *sk);
604 u32 hci_sock_get_cookie(struct sock *sk);
605
606 int hci_sock_init(void);
607 void hci_sock_cleanup(void);
608
609 int bt_sysfs_init(void);
610 void bt_sysfs_cleanup(void);
611
612 int bt_procfs_init(struct net *net, const char *name,
613                    struct bt_sock_list *sk_list,
614                    int (*seq_show)(struct seq_file *, void *));
615 void bt_procfs_cleanup(struct net *net, const char *name);
616
617 extern struct dentry *bt_debugfs;
618
619 int l2cap_init(void);
620 void l2cap_exit(void);
621
622 #if IS_ENABLED(CONFIG_BT_BREDR)
623 int sco_init(void);
624 void sco_exit(void);
625 #else
626 static inline int sco_init(void)
627 {
628         return 0;
629 }
630
631 static inline void sco_exit(void)
632 {
633 }
634 #endif
635
636 #if IS_ENABLED(CONFIG_BT_LE)
637 int iso_init(void);
638 int iso_exit(void);
639 bool iso_enabled(void);
640 #else
641 static inline int iso_init(void)
642 {
643         return 0;
644 }
645
646 static inline int iso_exit(void)
647 {
648         return 0;
649 }
650
651 static inline bool iso_enabled(void)
652 {
653         return false;
654 }
655 #endif
656
657 int mgmt_init(void);
658 void mgmt_exit(void);
659 void mgmt_cleanup(struct sock *sk);
660
661 void bt_sock_reclassify_lock(struct sock *sk, int proto);
662
663 #endif /* __BLUETOOTH_H */