blob: c53513cb76542b35e110cf24691efc557b5e6481 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
Marcel Holtmann0372a662005-10-28 19:20:45 +02003 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/module.h>
27
28#include <linux/kernel.h>
29#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/types.h>
31#include <linux/fcntl.h>
32#include <linux/interrupt.h>
33#include <linux/ptrace.h>
34#include <linux/poll.h>
35
36#include <linux/slab.h>
37#include <linux/tty.h>
38#include <linux/errno.h>
39#include <linux/string.h>
40#include <linux/signal.h>
41#include <linux/ioctl.h>
42#include <linux/skbuff.h>
Frederic Danis18aeb442015-05-28 11:25:01 +020043#include <linux/firmware.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45#include <net/bluetooth/bluetooth.h>
46#include <net/bluetooth/hci_core.h>
47
Marcel Holtmannbca03c92015-04-06 00:52:14 -070048#include "btintel.h"
Marcel Holtmann3e0ac122015-04-05 22:52:12 -070049#include "btbcm.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include "hci_uart.h"
51
Marcel Holtmann788a6752015-04-04 22:36:04 -070052#define VERSION "2.3"
Marcel Holtmann0372a662005-10-28 19:20:45 +020053
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -070054static const struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -070056int hci_uart_register_proto(const struct hci_uart_proto *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
58 if (p->id >= HCI_UART_MAX_PROTO)
59 return -EINVAL;
60
61 if (hup[p->id])
62 return -EEXIST;
63
64 hup[p->id] = p;
Marcel Holtmann0372a662005-10-28 19:20:45 +020065
Marcel Holtmann01009ee2015-04-04 22:27:35 -070066 BT_INFO("HCI UART protocol %s registered", p->name);
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 return 0;
69}
70
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -070071int hci_uart_unregister_proto(const struct hci_uart_proto *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072{
73 if (p->id >= HCI_UART_MAX_PROTO)
74 return -EINVAL;
75
76 if (!hup[p->id])
77 return -EINVAL;
78
79 hup[p->id] = NULL;
Marcel Holtmann0372a662005-10-28 19:20:45 +020080
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 return 0;
82}
83
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -070084static const struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
86 if (id >= HCI_UART_MAX_PROTO)
87 return NULL;
Marcel Holtmann0372a662005-10-28 19:20:45 +020088
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 return hup[id];
90}
91
92static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
93{
94 struct hci_dev *hdev = hu->hdev;
Marcel Holtmann0372a662005-10-28 19:20:45 +020095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 /* Update HCI stat counters */
97 switch (pkt_type) {
98 case HCI_COMMAND_PKT:
99 hdev->stat.cmd_tx++;
100 break;
101
102 case HCI_ACLDATA_PKT:
103 hdev->stat.acl_tx++;
104 break;
105
106 case HCI_SCODATA_PKT:
Karl Beldan7f8f2722010-10-07 21:57:10 +0200107 hdev->stat.sco_tx++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 break;
109 }
110}
111
112static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
113{
114 struct sk_buff *skb = hu->tx_skb;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 if (!skb)
117 skb = hu->proto->dequeue(hu);
118 else
119 hu->tx_skb = NULL;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 return skb;
122}
123
124int hci_uart_tx_wakeup(struct hci_uart *hu)
125{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
127 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
128 return 0;
129 }
130
131 BT_DBG("");
132
Felipe Balbida64c272014-04-23 09:58:26 -0500133 schedule_work(&hu->write_work);
134
135 return 0;
136}
Sebastian Reichel081f36a2017-03-28 17:59:37 +0200137EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
Felipe Balbida64c272014-04-23 09:58:26 -0500138
139static void hci_uart_write_work(struct work_struct *work)
140{
141 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
142 struct tty_struct *tty = hu->tty;
143 struct hci_dev *hdev = hu->hdev;
144 struct sk_buff *skb;
145
146 /* REVISIT: should we cope with bad skbs or ->write() returning
147 * and error value ?
148 */
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150restart:
151 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
152
153 while ((skb = hci_uart_dequeue(hu))) {
154 int len;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700157 len = tty->ops->write(tty, skb->data, skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 hdev->stat.byte_tx += len;
159
160 skb_pull(skb, len);
161 if (skb->len) {
162 hu->tx_skb = skb;
163 break;
164 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200165
Marcel Holtmann618e8bc2015-11-05 07:33:56 +0100166 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 kfree_skb(skb);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200168 }
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
171 goto restart;
172
173 clear_bit(HCI_UART_SENDING, &hu->tx_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174}
175
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300176static void hci_uart_init_work(struct work_struct *work)
177{
178 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
179 int err;
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100180 struct hci_dev *hdev;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300181
182 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
183 return;
184
185 err = hci_register_dev(hu->hdev);
186 if (err < 0) {
187 BT_ERR("Can't register HCI device");
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100188 hdev = hu->hdev;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300189 hu->hdev = NULL;
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100190 hci_free_dev(hdev);
Dean Jenkinsd160b742017-04-20 18:06:41 +0100191 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300192 hu->proto->close(hu);
Dean Jenkinscb926522017-04-20 18:06:39 +0100193 return;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300194 }
195
196 set_bit(HCI_UART_REGISTERED, &hu->flags);
197}
198
199int hci_uart_init_ready(struct hci_uart *hu)
200{
201 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
202 return -EALREADY;
203
204 schedule_work(&hu->init_ready);
205
206 return 0;
207}
208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209/* ------- Interface to HCI layer ------ */
210/* Initialize device */
211static int hci_uart_open(struct hci_dev *hdev)
212{
213 BT_DBG("%s %p", hdev->name, hdev);
214
215 /* Nothing to do for UART driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 return 0;
217}
218
219/* Reset device */
220static int hci_uart_flush(struct hci_dev *hdev)
221{
David Herrmann155961e2012-02-09 21:58:32 +0100222 struct hci_uart *hu = hci_get_drvdata(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 struct tty_struct *tty = hu->tty;
224
225 BT_DBG("hdev %p tty %p", hdev, tty);
226
227 if (hu->tx_skb) {
228 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
229 }
230
231 /* Flush any pending characters in the driver and discipline. */
232 tty_ldisc_flush(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -0700233 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Loic Poulain84cb3df2016-04-04 10:48:13 +0200235 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 hu->proto->flush(hu);
237
238 return 0;
239}
240
241/* Close device */
242static int hci_uart_close(struct hci_dev *hdev)
243{
244 BT_DBG("hdev %p", hdev);
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 hci_uart_flush(hdev);
David Newall3611f4d2008-02-11 21:41:30 -0800247 hdev->flush = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 return 0;
249}
250
251/* Send frames from HCI layer */
Marcel Holtmann7bd8f092013-10-11 06:19:18 -0700252static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Marcel Holtmann52bc4232013-10-11 07:01:03 -0700254 struct hci_uart *hu = hci_get_drvdata(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Marcel Holtmann618e8bc2015-11-05 07:33:56 +0100256 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
257 skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259 hu->proto->enqueue(hu, skb);
260
261 hci_uart_tx_wakeup(hu);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 return 0;
264}
265
Ilya Faenson2a973df2015-06-17 17:30:56 -0400266/* Flow control or un-flow control the device */
267void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
268{
269 struct tty_struct *tty = hu->tty;
270 struct ktermios ktermios;
271 int status;
272 unsigned int set = 0;
273 unsigned int clear = 0;
274
275 if (enable) {
276 /* Disable hardware flow control */
277 ktermios = tty->termios;
278 ktermios.c_cflag &= ~CRTSCTS;
279 status = tty_set_termios(tty, &ktermios);
280 BT_DBG("Disabling hardware flow control: %s",
281 status ? "failed" : "success");
282
283 /* Clear RTS to prevent the device from sending */
284 /* Most UARTs need OUT2 to enable interrupts */
285 status = tty->driver->ops->tiocmget(tty);
286 BT_DBG("Current tiocm 0x%x", status);
287
288 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
289 clear = ~set;
290 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
291 TIOCM_OUT2 | TIOCM_LOOP;
292 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
293 TIOCM_OUT2 | TIOCM_LOOP;
294 status = tty->driver->ops->tiocmset(tty, set, clear);
295 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
296 } else {
297 /* Set RTS to allow the device to send again */
298 status = tty->driver->ops->tiocmget(tty);
299 BT_DBG("Current tiocm 0x%x", status);
300
301 set |= (TIOCM_OUT2 | TIOCM_RTS);
302 clear = ~set;
303 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
304 TIOCM_OUT2 | TIOCM_LOOP;
305 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
306 TIOCM_OUT2 | TIOCM_LOOP;
307 status = tty->driver->ops->tiocmset(tty, set, clear);
308 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
309
310 /* Re-enable hardware flow control */
311 ktermios = tty->termios;
312 ktermios.c_cflag |= CRTSCTS;
313 status = tty_set_termios(tty, &ktermios);
314 BT_DBG("Enabling hardware flow control: %s",
315 status ? "failed" : "success");
316 }
317}
318
319void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
320 unsigned int oper_speed)
321{
322 hu->init_speed = init_speed;
323 hu->oper_speed = oper_speed;
324}
325
Frederic Danis77213832015-05-28 11:25:03 +0200326void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
327{
328 struct tty_struct *tty = hu->tty;
329 struct ktermios ktermios;
330
331 ktermios = tty->termios;
332 ktermios.c_cflag &= ~CBAUD;
Frederic Danis77213832015-05-28 11:25:03 +0200333 tty_termios_encode_baud_rate(&ktermios, speed, speed);
334
335 /* tty_set_termios() return not checked as it is always 0 */
336 tty_set_termios(tty, &ktermios);
337
Ilya Faenson2a973df2015-06-17 17:30:56 -0400338 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
339 tty->termios.c_ispeed, tty->termios.c_ospeed);
Frederic Danis77213832015-05-28 11:25:03 +0200340}
341
Loic Poulaineb173802015-03-25 15:19:30 +0100342static int hci_uart_setup(struct hci_dev *hdev)
343{
344 struct hci_uart *hu = hci_get_drvdata(hdev);
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700345 struct hci_rp_read_local_version *ver;
346 struct sk_buff *skb;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400347 unsigned int speed;
Frederic Danis77213832015-05-28 11:25:03 +0200348 int err;
349
Ilya Faenson2a973df2015-06-17 17:30:56 -0400350 /* Init speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200351 if (hu->init_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400352 speed = hu->init_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200353 else if (hu->proto->init_speed)
354 speed = hu->proto->init_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400355 else
356 speed = 0;
Frederic Danis77213832015-05-28 11:25:03 +0200357
Ilya Faenson2a973df2015-06-17 17:30:56 -0400358 if (speed)
359 hci_uart_set_baudrate(hu, speed);
360
361 /* Operational speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200362 if (hu->oper_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400363 speed = hu->oper_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200364 else if (hu->proto->oper_speed)
365 speed = hu->proto->oper_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400366 else
367 speed = 0;
368
369 if (hu->proto->set_baudrate && speed) {
370 err = hu->proto->set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200371 if (!err)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400372 hci_uart_set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200373 }
Loic Poulaineb173802015-03-25 15:19:30 +0100374
375 if (hu->proto->setup)
376 return hu->proto->setup(hu);
377
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700378 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
379 return 0;
380
381 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
382 HCI_INIT_TIMEOUT);
383 if (IS_ERR(skb)) {
384 BT_ERR("%s: Reading local version information failed (%ld)",
385 hdev->name, PTR_ERR(skb));
386 return 0;
387 }
388
389 if (skb->len != sizeof(*ver)) {
390 BT_ERR("%s: Event length mismatch for version information",
391 hdev->name);
392 goto done;
393 }
394
395 ver = (struct hci_rp_read_local_version *)skb->data;
396
397 switch (le16_to_cpu(ver->manufacturer)) {
Marcel Holtmann16e38872015-04-04 16:13:02 -0700398#ifdef CONFIG_BT_HCIUART_INTEL
399 case 2:
Marcel Holtmannbca03c92015-04-06 00:52:14 -0700400 hdev->set_bdaddr = btintel_set_bdaddr;
401 btintel_check_bdaddr(hdev);
Marcel Holtmann16e38872015-04-04 16:13:02 -0700402 break;
403#endif
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700404#ifdef CONFIG_BT_HCIUART_BCM
405 case 15:
Marcel Holtmann3e0ac122015-04-05 22:52:12 -0700406 hdev->set_bdaddr = btbcm_set_bdaddr;
407 btbcm_check_bdaddr(hdev);
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700408 break;
409#endif
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700410 }
411
412done:
413 kfree_skb(skb);
Loic Poulaineb173802015-03-25 15:19:30 +0100414 return 0;
415}
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417/* ------ LDISC part ------ */
418/* hci_uart_tty_open
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900419 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 * Called when line discipline changed to HCI_UART.
421 *
422 * Arguments:
423 * tty pointer to tty info structure
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900424 * Return Value:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 * 0 if success, otherwise error code
426 */
427static int hci_uart_tty_open(struct tty_struct *tty)
428{
Jiri Slabyf327b342012-10-18 22:26:34 +0200429 struct hci_uart *hu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
431 BT_DBG("tty %p", tty);
432
Alan Coxc19483c2010-10-22 14:11:26 +0100433 /* Error if the tty has no write op instead of leaving an exploitable
434 hole */
435 if (tty->ops->write == NULL)
436 return -EOPNOTSUPP;
437
Valentin Iliea08b15e2013-08-12 18:46:00 +0300438 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
439 if (!hu) {
Marcel Holtmann77851622006-09-21 16:23:19 +0200440 BT_ERR("Can't allocate control structure");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 return -ENFILE;
442 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 tty->disc_data = hu;
445 hu->tty = tty;
Alan Cox33f0f882006-01-09 20:54:13 -0800446 tty->receive_room = 65536;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Sebastian Reichelaeac3012017-03-28 17:59:34 +0200448 /* disable alignment support by default */
449 hu->alignment = 1;
450 hu->padding = 0;
451
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300452 INIT_WORK(&hu->init_ready, hci_uart_init_work);
Felipe Balbida64c272014-04-23 09:58:26 -0500453 INIT_WORK(&hu->write_work, hci_uart_write_work);
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300454
Peter Hurleye6e981c2015-11-27 16:39:00 -0500455 /* Flush any pending characters in the driver */
Alan Coxf34d7a52008-04-30 00:54:13 -0700456 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458 return 0;
459}
460
461/* hci_uart_tty_close()
462 *
463 * Called when the line discipline is changed to something
464 * else, the tty is closed, or the tty detects a hangup.
465 */
466static void hci_uart_tty_close(struct tty_struct *tty)
467{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700468 struct hci_uart *hu = tty->disc_data;
Johan Hedbergdac670b2012-07-16 16:12:10 +0300469 struct hci_dev *hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471 BT_DBG("tty %p", tty);
472
473 /* Detach from the tty */
474 tty->disc_data = NULL;
475
Johan Hedbergdac670b2012-07-16 16:12:10 +0300476 if (!hu)
477 return;
Marcel Holtmann22ad4202007-05-09 09:15:40 +0200478
Johan Hedbergdac670b2012-07-16 16:12:10 +0300479 hdev = hu->hdev;
480 if (hdev)
481 hci_uart_close(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Felipe Balbida64c272014-04-23 09:58:26 -0500483 cancel_work_sync(&hu->write_work);
484
Loic Poulain84cb3df2016-04-04 10:48:13 +0200485 if (test_and_clear_bit(HCI_UART_PROTO_READY, &hu->flags)) {
Johan Hedbergdac670b2012-07-16 16:12:10 +0300486 if (hdev) {
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300487 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
488 hci_unregister_dev(hdev);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300489 hci_free_dev(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 }
Johan Hedbergdac670b2012-07-16 16:12:10 +0300491 hu->proto->close(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
Loic Poulain84cb3df2016-04-04 10:48:13 +0200493 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300494
495 kfree(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
498/* hci_uart_tty_wakeup()
499 *
500 * Callback for transmit wakeup. Called when low level
501 * device driver can accept more send data.
502 *
503 * Arguments: tty pointer to associated tty instance data
504 * Return Value: None
505 */
506static void hci_uart_tty_wakeup(struct tty_struct *tty)
507{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700508 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510 BT_DBG("");
511
512 if (!hu)
513 return;
514
515 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
516
517 if (tty != hu->tty)
518 return;
519
Loic Poulain84cb3df2016-04-04 10:48:13 +0200520 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 hci_uart_tx_wakeup(hu);
522}
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524/* hci_uart_tty_receive()
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900525 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 * Called by tty low level driver when receive data is
527 * available.
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900528 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 * Arguments: tty pointer to tty isntance data
530 * data pointer to received data
531 * flags pointer to flags for data
532 * count count of received data in bytes
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900533 *
Linus Torvalds55db4c62011-06-04 06:33:24 +0900534 * Return Value: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700536static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
537 char *flags, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700539 struct hci_uart *hu = tty->disc_data;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 if (!hu || tty != hu->tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900542 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Loic Poulain84cb3df2016-04-04 10:48:13 +0200544 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds55db4c62011-06-04 06:33:24 +0900545 return;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200546
Frederic Danis7649faf2015-09-23 18:18:10 +0200547 /* It does not need a lock here as it is already protected by a mutex in
548 * tty caller
549 */
Marcel Holtmann9d1c40e2015-04-04 20:59:41 -0700550 hu->proto->recv(hu, data, count);
Chan-yeol Park788f0922013-04-02 21:24:22 +0900551
552 if (hu->hdev)
553 hu->hdev->stat.byte_rx += count;
554
Alan Cox39c2e602008-04-30 00:54:18 -0700555 tty_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556}
557
558static int hci_uart_register_dev(struct hci_uart *hu)
559{
560 struct hci_dev *hdev;
561
562 BT_DBG("");
563
564 /* Initialize and register HCI device */
565 hdev = hci_alloc_dev();
566 if (!hdev) {
567 BT_ERR("Can't allocate HCI device");
568 return -ENOMEM;
569 }
570
571 hu->hdev = hdev;
572
Marcel Holtmannc13854c2010-02-08 15:27:07 +0100573 hdev->bus = HCI_UART;
David Herrmann155961e2012-02-09 21:58:32 +0100574 hci_set_drvdata(hdev, hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Marcel Holtmannaee61f72015-10-20 21:30:45 +0200576 /* Only when vendor specific setup callback is provided, consider
577 * the manufacturer information valid. This avoids filling in the
578 * value for Ericsson when nothing is specified.
579 */
580 if (hu->proto->setup)
581 hdev->manufacturer = hu->proto->manufacturer;
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 hdev->open = hci_uart_open;
584 hdev->close = hci_uart_close;
585 hdev->flush = hci_uart_flush;
586 hdev->send = hci_uart_send_frame;
Loic Poulaineb173802015-03-25 15:19:30 +0100587 hdev->setup = hci_uart_setup;
David Herrmann6935e0f2012-03-09 15:53:42 +0100588 SET_HCIDEV_DEV(hdev, hu->tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Johan Hedberg63c7d092010-07-12 11:37:04 -0300590 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
591 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
592
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200593 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
594 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
595
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100596 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
Szymon Janca6c511c2012-05-23 12:35:46 +0200597 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100598
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100599 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
600 hdev->dev_type = HCI_AMP;
601 else
Marcel Holtmannca8bee52016-07-05 14:30:14 +0200602 hdev->dev_type = HCI_PRIMARY;
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100603
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300604 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
605 return 0;
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 if (hci_register_dev(hdev) < 0) {
608 BT_ERR("Can't register HCI device");
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100609 hu->hdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 hci_free_dev(hdev);
611 return -ENODEV;
612 }
613
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300614 set_bit(HCI_UART_REGISTERED, &hu->flags);
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return 0;
617}
618
619static int hci_uart_set_proto(struct hci_uart *hu, int id)
620{
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -0700621 const struct hci_uart_proto *p;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200622 int err;
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 p = hci_uart_get_proto(id);
625 if (!p)
626 return -EPROTONOSUPPORT;
627
628 err = p->open(hu);
629 if (err)
630 return err;
631
632 hu->proto = p;
Loic Poulain84cb3df2016-04-04 10:48:13 +0200633 set_bit(HCI_UART_PROTO_READY, &hu->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635 err = hci_uart_register_dev(hu);
636 if (err) {
Loic Poulain84cb3df2016-04-04 10:48:13 +0200637 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 p->close(hu);
639 return err;
640 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return 0;
643}
644
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200645static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
646{
647 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
648 BIT(HCI_UART_RESET_ON_INIT) |
649 BIT(HCI_UART_CREATE_AMP) |
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200650 BIT(HCI_UART_INIT_PENDING) |
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700651 BIT(HCI_UART_EXT_CONFIG) |
652 BIT(HCI_UART_VND_DETECT);
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200653
Marcel Holtmann41533fe2015-04-01 13:51:51 -0700654 if (flags & ~valid_flags)
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200655 return -EINVAL;
656
657 hu->hdev_flags = flags;
658
659 return 0;
660}
661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662/* hci_uart_tty_ioctl()
663 *
664 * Process IOCTL system call for the tty device.
665 *
666 * Arguments:
667 *
668 * tty pointer to tty instance data
669 * file pointer to open file object for device
670 * cmd IOCTL command code
671 * arg argument for IOCTL call (cmd dependent)
672 *
673 * Return Value: Command dependent
674 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700675static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
676 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700678 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 int err = 0;
680
681 BT_DBG("");
682
683 /* Verify the status of the device */
684 if (!hu)
685 return -EBADF;
686
687 switch (cmd) {
688 case HCIUARTSETPROTO:
689 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
690 err = hci_uart_set_proto(hu, arg);
Vignesh Raman05650692016-09-23 18:56:28 +0100691 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200693 } else
Vignesh Raman05650692016-09-23 18:56:28 +0100694 err = -EBUSY;
Marcel Holtmannc33be3c2007-05-09 09:15:45 +0200695 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697 case HCIUARTGETPROTO:
698 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100699 err = hu->proto->id;
700 else
701 err = -EUNATCH;
702 break;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200703
Marcel Holtmannd2158742007-05-09 09:15:35 +0200704 case HCIUARTGETDEVICE:
Marcel Holtmannc7e0c142014-07-12 17:00:29 +0200705 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100706 err = hu->hdev->id;
707 else
708 err = -EUNATCH;
709 break;
Marcel Holtmannd2158742007-05-09 09:15:35 +0200710
Johan Hedberg63c7d092010-07-12 11:37:04 -0300711 case HCIUARTSETFLAGS:
712 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100713 err = -EBUSY;
714 else
715 err = hci_uart_set_flags(hu, arg);
Johan Hedberg63c7d092010-07-12 11:37:04 -0300716 break;
717
718 case HCIUARTGETFLAGS:
Vignesh Raman05650692016-09-23 18:56:28 +0100719 err = hu->hdev_flags;
720 break;
Johan Hedberg63c7d092010-07-12 11:37:04 -0300721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 default:
Alan Cox47afa7a2008-10-13 10:44:17 +0100723 err = n_tty_ioctl_helper(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 break;
Peter Senna Tschudina20890d2012-09-07 17:24:39 +0200725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 return err;
728}
729
730/*
731 * We don't provide read/write/poll interface for user space.
732 */
Marcel Holtmann0372a662005-10-28 19:20:45 +0200733static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700734 unsigned char __user *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
736 return 0;
737}
738
Marcel Holtmann0372a662005-10-28 19:20:45 +0200739static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700740 const unsigned char *data, size_t count)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200741{
742 return 0;
743}
744
745static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700746 struct file *filp, poll_table *wait)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200747{
748 return 0;
749}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751static int __init hci_uart_init(void)
752{
Alan Coxa352def2008-07-16 21:53:12 +0100753 static struct tty_ldisc_ops hci_uart_ldisc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 int err;
755
756 BT_INFO("HCI UART driver ver %s", VERSION);
757
758 /* Register the tty discipline */
759
Prasanna Karthikacf50c52015-07-23 11:08:52 +0000760 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
Marcel Holtmann0372a662005-10-28 19:20:45 +0200761 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
762 hci_uart_ldisc.name = "n_hci";
763 hci_uart_ldisc.open = hci_uart_tty_open;
764 hci_uart_ldisc.close = hci_uart_tty_close;
765 hci_uart_ldisc.read = hci_uart_tty_read;
766 hci_uart_ldisc.write = hci_uart_tty_write;
767 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
768 hci_uart_ldisc.poll = hci_uart_tty_poll;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200769 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
770 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
771 hci_uart_ldisc.owner = THIS_MODULE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Valentin Iliea08b15e2013-08-12 18:46:00 +0300773 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
774 if (err) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 BT_ERR("HCI line discipline registration failed. (%d)", err);
776 return err;
777 }
778
779#ifdef CONFIG_BT_HCIUART_H4
780 h4_init();
781#endif
782#ifdef CONFIG_BT_HCIUART_BCSP
783 bcsp_init();
784#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200785#ifdef CONFIG_BT_HCIUART_LL
786 ll_init();
787#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530788#ifdef CONFIG_BT_HCIUART_ATH3K
789 ath_init();
790#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300791#ifdef CONFIG_BT_HCIUART_3WIRE
792 h5_init();
793#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200794#ifdef CONFIG_BT_HCIUART_INTEL
795 intel_init();
796#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700797#ifdef CONFIG_BT_HCIUART_BCM
798 bcm_init();
799#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700800#ifdef CONFIG_BT_HCIUART_QCA
801 qca_init();
802#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100803#ifdef CONFIG_BT_HCIUART_AG6XX
804 ag6xx_init();
805#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200806#ifdef CONFIG_BT_HCIUART_MRVL
807 mrvl_init();
808#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return 0;
811}
812
813static void __exit hci_uart_exit(void)
814{
815 int err;
816
817#ifdef CONFIG_BT_HCIUART_H4
818 h4_deinit();
819#endif
820#ifdef CONFIG_BT_HCIUART_BCSP
821 bcsp_deinit();
822#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200823#ifdef CONFIG_BT_HCIUART_LL
824 ll_deinit();
825#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530826#ifdef CONFIG_BT_HCIUART_ATH3K
827 ath_deinit();
828#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300829#ifdef CONFIG_BT_HCIUART_3WIRE
830 h5_deinit();
831#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200832#ifdef CONFIG_BT_HCIUART_INTEL
833 intel_deinit();
834#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700835#ifdef CONFIG_BT_HCIUART_BCM
836 bcm_deinit();
837#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700838#ifdef CONFIG_BT_HCIUART_QCA
839 qca_deinit();
840#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100841#ifdef CONFIG_BT_HCIUART_AG6XX
842 ag6xx_deinit();
843#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200844#ifdef CONFIG_BT_HCIUART_MRVL
845 mrvl_deinit();
846#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
848 /* Release tty registration of line discipline */
Valentin Iliea08b15e2013-08-12 18:46:00 +0300849 err = tty_unregister_ldisc(N_HCI);
850 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 BT_ERR("Can't unregister HCI line discipline (%d)", err);
852}
853
854module_init(hci_uart_init);
855module_exit(hci_uart_exit);
856
Marcel Holtmann63fbd242008-08-18 13:23:53 +0200857MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
859MODULE_VERSION(VERSION);
860MODULE_LICENSE("GPL");
861MODULE_ALIAS_LDISC(N_HCI);