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