xref: /openbmc/linux/drivers/bluetooth/hci_uart.h (revision abb84c46)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *
4  *  Bluetooth HCI UART driver
5  *
6  *  Copyright (C) 2000-2001  Qualcomm Incorporated
7  *  Copyright (C) 2002-2003  Maxim Krasnyansky <maxk@qualcomm.com>
8  *  Copyright (C) 2004-2005  Marcel Holtmann <marcel@holtmann.org>
9  */
10 
11 #ifndef N_HCI
12 #define N_HCI	15
13 #endif
14 
15 /* Ioctls */
16 #define HCIUARTSETPROTO		_IOW('U', 200, int)
17 #define HCIUARTGETPROTO		_IOR('U', 201, int)
18 #define HCIUARTGETDEVICE	_IOR('U', 202, int)
19 #define HCIUARTSETFLAGS		_IOW('U', 203, int)
20 #define HCIUARTGETFLAGS		_IOR('U', 204, int)
21 
22 /* UART protocols */
23 #define HCI_UART_MAX_PROTO	12
24 
25 #define HCI_UART_H4	0
26 #define HCI_UART_BCSP	1
27 #define HCI_UART_3WIRE	2
28 #define HCI_UART_H4DS	3
29 #define HCI_UART_LL	4
30 #define HCI_UART_ATH3K	5
31 #define HCI_UART_INTEL	6
32 #define HCI_UART_BCM	7
33 #define HCI_UART_QCA	8
34 #define HCI_UART_AG6XX	9
35 #define HCI_UART_NOKIA	10
36 #define HCI_UART_MRVL	11
37 
38 #define HCI_UART_RAW_DEVICE	0
39 #define HCI_UART_RESET_ON_INIT	1
40 #define HCI_UART_INIT_PENDING	3
41 #define HCI_UART_EXT_CONFIG	4
42 #define HCI_UART_VND_DETECT	5
43 
44 struct hci_uart;
45 struct serdev_device;
46 
47 struct hci_uart_proto {
48 	unsigned int id;
49 	const char *name;
50 	unsigned int manufacturer;
51 	unsigned int init_speed;
52 	unsigned int oper_speed;
53 	int (*open)(struct hci_uart *hu);
54 	int (*close)(struct hci_uart *hu);
55 	int (*flush)(struct hci_uart *hu);
56 	int (*setup)(struct hci_uart *hu);
57 	int (*set_baudrate)(struct hci_uart *hu, unsigned int speed);
58 	int (*recv)(struct hci_uart *hu, const void *data, int len);
59 	int (*enqueue)(struct hci_uart *hu, struct sk_buff *skb);
60 	struct sk_buff *(*dequeue)(struct hci_uart *hu);
61 };
62 
63 struct hci_uart {
64 	struct tty_struct	*tty;
65 	struct serdev_device	*serdev;
66 	struct hci_dev		*hdev;
67 	unsigned long		flags;
68 	unsigned long		hdev_flags;
69 
70 	struct work_struct	init_ready;
71 	struct work_struct	write_work;
72 
73 	const struct hci_uart_proto *proto;
74 	struct percpu_rw_semaphore proto_lock;	/* Stop work for proto close */
75 	void			*priv;
76 
77 	struct sk_buff		*tx_skb;
78 	unsigned long		tx_state;
79 
80 	unsigned int init_speed;
81 	unsigned int oper_speed;
82 
83 	u8			alignment;
84 	u8			padding;
85 };
86 
87 /* HCI_UART proto flag bits */
88 #define HCI_UART_PROTO_SET		0
89 #define HCI_UART_REGISTERED		1
90 #define HCI_UART_PROTO_READY		2
91 #define HCI_UART_NO_SUSPEND_NOTIFIER	3
92 
93 /* TX states  */
94 #define HCI_UART_SENDING	1
95 #define HCI_UART_TX_WAKEUP	2
96 
97 int hci_uart_register_proto(const struct hci_uart_proto *p);
98 int hci_uart_unregister_proto(const struct hci_uart_proto *p);
99 
100 int hci_uart_register_device_priv(struct hci_uart *hu,
101 				  const struct hci_uart_proto *p,
102 				  int sizeof_priv);
103 
104 static inline int hci_uart_register_device(struct hci_uart *hu,
105 					   const struct hci_uart_proto *p)
106 {
107 	return hci_uart_register_device_priv(hu, p, 0);
108 }
109 
110 void hci_uart_unregister_device(struct hci_uart *hu);
111 
112 int hci_uart_tx_wakeup(struct hci_uart *hu);
113 int hci_uart_wait_until_sent(struct hci_uart *hu);
114 int hci_uart_init_ready(struct hci_uart *hu);
115 void hci_uart_init_work(struct work_struct *work);
116 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
117 bool hci_uart_has_flow_control(struct hci_uart *hu);
118 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
119 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
120 			 unsigned int oper_speed);
121 
122 #ifdef CONFIG_BT_HCIUART_H4
123 int h4_init(void);
124 int h4_deinit(void);
125 
126 struct h4_recv_pkt {
127 	u8  type;	/* Packet type */
128 	u8  hlen;	/* Header length */
129 	u8  loff;	/* Data length offset in header */
130 	u8  lsize;	/* Data length field size */
131 	u16 maxlen;	/* Max overall packet length */
132 	int (*recv)(struct hci_dev *hdev, struct sk_buff *skb);
133 };
134 
135 #define H4_RECV_ACL \
136 	.type = HCI_ACLDATA_PKT, \
137 	.hlen = HCI_ACL_HDR_SIZE, \
138 	.loff = 2, \
139 	.lsize = 2, \
140 	.maxlen = HCI_MAX_FRAME_SIZE \
141 
142 #define H4_RECV_SCO \
143 	.type = HCI_SCODATA_PKT, \
144 	.hlen = HCI_SCO_HDR_SIZE, \
145 	.loff = 2, \
146 	.lsize = 1, \
147 	.maxlen = HCI_MAX_SCO_SIZE
148 
149 #define H4_RECV_EVENT \
150 	.type = HCI_EVENT_PKT, \
151 	.hlen = HCI_EVENT_HDR_SIZE, \
152 	.loff = 1, \
153 	.lsize = 1, \
154 	.maxlen = HCI_MAX_EVENT_SIZE
155 
156 #define H4_RECV_ISO \
157 	.type = HCI_ISODATA_PKT, \
158 	.hlen = HCI_ISO_HDR_SIZE, \
159 	.loff = 2, \
160 	.lsize = 2, \
161 	.maxlen = HCI_MAX_FRAME_SIZE \
162 
163 struct sk_buff *h4_recv_buf(struct hci_dev *hdev, struct sk_buff *skb,
164 			    const unsigned char *buffer, int count,
165 			    const struct h4_recv_pkt *pkts, int pkts_count);
166 #endif
167 
168 #ifdef CONFIG_BT_HCIUART_BCSP
169 int bcsp_init(void);
170 int bcsp_deinit(void);
171 #endif
172 
173 #ifdef CONFIG_BT_HCIUART_LL
174 int ll_init(void);
175 int ll_deinit(void);
176 #endif
177 
178 #ifdef CONFIG_BT_HCIUART_ATH3K
179 int ath_init(void);
180 int ath_deinit(void);
181 #endif
182 
183 #ifdef CONFIG_BT_HCIUART_3WIRE
184 int h5_init(void);
185 int h5_deinit(void);
186 #endif
187 
188 #ifdef CONFIG_BT_HCIUART_INTEL
189 int intel_init(void);
190 int intel_deinit(void);
191 #endif
192 
193 #ifdef CONFIG_BT_HCIUART_BCM
194 int bcm_init(void);
195 int bcm_deinit(void);
196 #endif
197 
198 #ifdef CONFIG_BT_HCIUART_QCA
199 int qca_init(void);
200 int qca_deinit(void);
201 #endif
202 
203 #ifdef CONFIG_BT_HCIUART_AG6XX
204 int ag6xx_init(void);
205 int ag6xx_deinit(void);
206 #endif
207 
208 #ifdef CONFIG_BT_HCIUART_MRVL
209 int mrvl_init(void);
210 int mrvl_deinit(void);
211 #endif
212