blob: 0a21fb86fd67d9322b73aa52c04a31ff500f0e29 [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
Dean Jenkinsbbb952d2017-04-28 13:57:25 +0100116 if (!skb) {
117 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
118 skb = hu->proto->dequeue(hu);
119 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 hu->tx_skb = NULL;
Dean Jenkinsbbb952d2017-04-28 13:57:25 +0100121 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 return skb;
124}
125
126int hci_uart_tx_wakeup(struct hci_uart *hu)
127{
Dean Jenkinsb5d95e82017-04-28 13:57:26 +0100128 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
129 return 0;
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
132 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
133 return 0;
134 }
135
136 BT_DBG("");
137
Felipe Balbida64c272014-04-23 09:58:26 -0500138 schedule_work(&hu->write_work);
139
140 return 0;
141}
142
143static void hci_uart_write_work(struct work_struct *work)
144{
145 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
146 struct tty_struct *tty = hu->tty;
147 struct hci_dev *hdev = hu->hdev;
148 struct sk_buff *skb;
149
150 /* REVISIT: should we cope with bad skbs or ->write() returning
151 * and error value ?
152 */
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154restart:
155 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
156
157 while ((skb = hci_uart_dequeue(hu))) {
158 int len;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700161 len = tty->ops->write(tty, skb->data, skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 hdev->stat.byte_tx += len;
163
164 skb_pull(skb, len);
165 if (skb->len) {
166 hu->tx_skb = skb;
167 break;
168 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200169
Marcel Holtmann618e8bc2015-11-05 07:33:56 +0100170 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 kfree_skb(skb);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200172 }
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
175 goto restart;
176
177 clear_bit(HCI_UART_SENDING, &hu->tx_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178}
179
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300180static void hci_uart_init_work(struct work_struct *work)
181{
182 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
183 int err;
184
185 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
186 return;
187
188 err = hci_register_dev(hu->hdev);
189 if (err < 0) {
190 BT_ERR("Can't register HCI device");
191 hci_free_dev(hu->hdev);
192 hu->hdev = NULL;
193 hu->proto->close(hu);
194 }
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
Vladis Dronov58a01b02019-07-30 11:33:45 +0200266/* Check the underlying device or tty has flow control support */
267bool hci_uart_has_flow_control(struct hci_uart *hu)
268{
269 if (hu->tty->driver->ops->tiocmget && hu->tty->driver->ops->tiocmset)
270 return true;
271
272 return false;
273}
274
Ilya Faenson2a973df2015-06-17 17:30:56 -0400275/* Flow control or un-flow control the device */
276void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
277{
278 struct tty_struct *tty = hu->tty;
279 struct ktermios ktermios;
280 int status;
281 unsigned int set = 0;
282 unsigned int clear = 0;
283
284 if (enable) {
285 /* Disable hardware flow control */
286 ktermios = tty->termios;
287 ktermios.c_cflag &= ~CRTSCTS;
288 status = tty_set_termios(tty, &ktermios);
289 BT_DBG("Disabling hardware flow control: %s",
290 status ? "failed" : "success");
291
292 /* Clear RTS to prevent the device from sending */
293 /* Most UARTs need OUT2 to enable interrupts */
294 status = tty->driver->ops->tiocmget(tty);
295 BT_DBG("Current tiocm 0x%x", status);
296
297 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
298 clear = ~set;
299 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
300 TIOCM_OUT2 | TIOCM_LOOP;
301 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
302 TIOCM_OUT2 | TIOCM_LOOP;
303 status = tty->driver->ops->tiocmset(tty, set, clear);
304 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
305 } else {
306 /* Set RTS to allow the device to send again */
307 status = tty->driver->ops->tiocmget(tty);
308 BT_DBG("Current tiocm 0x%x", status);
309
310 set |= (TIOCM_OUT2 | TIOCM_RTS);
311 clear = ~set;
312 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
313 TIOCM_OUT2 | TIOCM_LOOP;
314 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
315 TIOCM_OUT2 | TIOCM_LOOP;
316 status = tty->driver->ops->tiocmset(tty, set, clear);
317 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
318
319 /* Re-enable hardware flow control */
320 ktermios = tty->termios;
321 ktermios.c_cflag |= CRTSCTS;
322 status = tty_set_termios(tty, &ktermios);
323 BT_DBG("Enabling hardware flow control: %s",
324 status ? "failed" : "success");
325 }
326}
327
328void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
329 unsigned int oper_speed)
330{
331 hu->init_speed = init_speed;
332 hu->oper_speed = oper_speed;
333}
334
335void hci_uart_init_tty(struct hci_uart *hu)
336{
337 struct tty_struct *tty = hu->tty;
338 struct ktermios ktermios;
339
340 /* Bring the UART into a known 8 bits no parity hw fc state */
341 ktermios = tty->termios;
342 ktermios.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP |
343 INLCR | IGNCR | ICRNL | IXON);
344 ktermios.c_oflag &= ~OPOST;
345 ktermios.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
346 ktermios.c_cflag &= ~(CSIZE | PARENB);
347 ktermios.c_cflag |= CS8;
348 ktermios.c_cflag |= CRTSCTS;
349
350 /* tty_set_termios() return not checked as it is always 0 */
351 tty_set_termios(tty, &ktermios);
352}
353
Frederic Danis77213832015-05-28 11:25:03 +0200354void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
355{
356 struct tty_struct *tty = hu->tty;
357 struct ktermios ktermios;
358
359 ktermios = tty->termios;
360 ktermios.c_cflag &= ~CBAUD;
Frederic Danis77213832015-05-28 11:25:03 +0200361 tty_termios_encode_baud_rate(&ktermios, speed, speed);
362
363 /* tty_set_termios() return not checked as it is always 0 */
364 tty_set_termios(tty, &ktermios);
365
Ilya Faenson2a973df2015-06-17 17:30:56 -0400366 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
367 tty->termios.c_ispeed, tty->termios.c_ospeed);
Frederic Danis77213832015-05-28 11:25:03 +0200368}
369
Loic Poulaineb173802015-03-25 15:19:30 +0100370static int hci_uart_setup(struct hci_dev *hdev)
371{
372 struct hci_uart *hu = hci_get_drvdata(hdev);
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700373 struct hci_rp_read_local_version *ver;
374 struct sk_buff *skb;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400375 unsigned int speed;
Frederic Danis77213832015-05-28 11:25:03 +0200376 int err;
377
Ilya Faenson2a973df2015-06-17 17:30:56 -0400378 /* Init speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200379 if (hu->init_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400380 speed = hu->init_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200381 else if (hu->proto->init_speed)
382 speed = hu->proto->init_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400383 else
384 speed = 0;
Frederic Danis77213832015-05-28 11:25:03 +0200385
Ilya Faenson2a973df2015-06-17 17:30:56 -0400386 if (speed)
387 hci_uart_set_baudrate(hu, speed);
388
389 /* Operational speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200390 if (hu->oper_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400391 speed = hu->oper_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200392 else if (hu->proto->oper_speed)
393 speed = hu->proto->oper_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400394 else
395 speed = 0;
396
397 if (hu->proto->set_baudrate && speed) {
398 err = hu->proto->set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200399 if (!err)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400400 hci_uart_set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200401 }
Loic Poulaineb173802015-03-25 15:19:30 +0100402
403 if (hu->proto->setup)
404 return hu->proto->setup(hu);
405
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700406 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
407 return 0;
408
409 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
410 HCI_INIT_TIMEOUT);
411 if (IS_ERR(skb)) {
412 BT_ERR("%s: Reading local version information failed (%ld)",
413 hdev->name, PTR_ERR(skb));
414 return 0;
415 }
416
417 if (skb->len != sizeof(*ver)) {
418 BT_ERR("%s: Event length mismatch for version information",
419 hdev->name);
420 goto done;
421 }
422
423 ver = (struct hci_rp_read_local_version *)skb->data;
424
425 switch (le16_to_cpu(ver->manufacturer)) {
Marcel Holtmann16e38872015-04-04 16:13:02 -0700426#ifdef CONFIG_BT_HCIUART_INTEL
427 case 2:
Marcel Holtmannbca03c92015-04-06 00:52:14 -0700428 hdev->set_bdaddr = btintel_set_bdaddr;
429 btintel_check_bdaddr(hdev);
Marcel Holtmann16e38872015-04-04 16:13:02 -0700430 break;
431#endif
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700432#ifdef CONFIG_BT_HCIUART_BCM
433 case 15:
Marcel Holtmann3e0ac122015-04-05 22:52:12 -0700434 hdev->set_bdaddr = btbcm_set_bdaddr;
435 btbcm_check_bdaddr(hdev);
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700436 break;
437#endif
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700438 }
439
440done:
441 kfree_skb(skb);
Loic Poulaineb173802015-03-25 15:19:30 +0100442 return 0;
443}
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445/* ------ LDISC part ------ */
446/* hci_uart_tty_open
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900447 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 * Called when line discipline changed to HCI_UART.
449 *
450 * Arguments:
451 * tty pointer to tty info structure
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900452 * Return Value:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 * 0 if success, otherwise error code
454 */
455static int hci_uart_tty_open(struct tty_struct *tty)
456{
Jiri Slabyf327b342012-10-18 22:26:34 +0200457 struct hci_uart *hu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459 BT_DBG("tty %p", tty);
460
Alan Coxc19483c2010-10-22 14:11:26 +0100461 /* Error if the tty has no write op instead of leaving an exploitable
462 hole */
463 if (tty->ops->write == NULL)
464 return -EOPNOTSUPP;
465
Valentin Iliea08b15e2013-08-12 18:46:00 +0300466 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
467 if (!hu) {
Marcel Holtmann77851622006-09-21 16:23:19 +0200468 BT_ERR("Can't allocate control structure");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 return -ENFILE;
470 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 tty->disc_data = hu;
473 hu->tty = tty;
Alan Cox33f0f882006-01-09 20:54:13 -0800474 tty->receive_room = 65536;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300476 INIT_WORK(&hu->init_ready, hci_uart_init_work);
Felipe Balbida64c272014-04-23 09:58:26 -0500477 INIT_WORK(&hu->write_work, hci_uart_write_work);
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300478
Peter Hurleye6e981c2015-11-27 16:39:00 -0500479 /* Flush any pending characters in the driver */
Alan Coxf34d7a52008-04-30 00:54:13 -0700480 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 return 0;
483}
484
485/* hci_uart_tty_close()
486 *
487 * Called when the line discipline is changed to something
488 * else, the tty is closed, or the tty detects a hangup.
489 */
490static void hci_uart_tty_close(struct tty_struct *tty)
491{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700492 struct hci_uart *hu = tty->disc_data;
Johan Hedbergdac670b2012-07-16 16:12:10 +0300493 struct hci_dev *hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 BT_DBG("tty %p", tty);
496
497 /* Detach from the tty */
498 tty->disc_data = NULL;
499
Johan Hedbergdac670b2012-07-16 16:12:10 +0300500 if (!hu)
501 return;
Marcel Holtmann22ad4202007-05-09 09:15:40 +0200502
Johan Hedbergdac670b2012-07-16 16:12:10 +0300503 hdev = hu->hdev;
504 if (hdev)
505 hci_uart_close(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Felipe Balbida64c272014-04-23 09:58:26 -0500507 cancel_work_sync(&hu->write_work);
508
Loic Poulain84cb3df2016-04-04 10:48:13 +0200509 if (test_and_clear_bit(HCI_UART_PROTO_READY, &hu->flags)) {
Johan Hedbergdac670b2012-07-16 16:12:10 +0300510 if (hdev) {
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300511 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
512 hci_unregister_dev(hdev);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300513 hci_free_dev(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 }
Johan Hedbergdac670b2012-07-16 16:12:10 +0300515 hu->proto->close(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 }
Loic Poulain84cb3df2016-04-04 10:48:13 +0200517 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300518
519 kfree(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520}
521
522/* hci_uart_tty_wakeup()
523 *
524 * Callback for transmit wakeup. Called when low level
525 * device driver can accept more send data.
526 *
527 * Arguments: tty pointer to associated tty instance data
528 * Return Value: None
529 */
530static void hci_uart_tty_wakeup(struct tty_struct *tty)
531{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700532 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534 BT_DBG("");
535
536 if (!hu)
537 return;
538
539 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
540
541 if (tty != hu->tty)
542 return;
543
Loic Poulain84cb3df2016-04-04 10:48:13 +0200544 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 hci_uart_tx_wakeup(hu);
546}
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548/* hci_uart_tty_receive()
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900549 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 * Called by tty low level driver when receive data is
551 * available.
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900552 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 * Arguments: tty pointer to tty isntance data
554 * data pointer to received data
555 * flags pointer to flags for data
556 * count count of received data in bytes
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900557 *
Linus Torvalds55db4c62011-06-04 06:33:24 +0900558 * Return Value: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700560static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
561 char *flags, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700563 struct hci_uart *hu = tty->disc_data;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 if (!hu || tty != hu->tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900566 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Loic Poulain84cb3df2016-04-04 10:48:13 +0200568 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds55db4c62011-06-04 06:33:24 +0900569 return;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200570
Frederic Danis7649faf2015-09-23 18:18:10 +0200571 /* It does not need a lock here as it is already protected by a mutex in
572 * tty caller
573 */
Marcel Holtmann9d1c40e2015-04-04 20:59:41 -0700574 hu->proto->recv(hu, data, count);
Chan-yeol Park788f0922013-04-02 21:24:22 +0900575
576 if (hu->hdev)
577 hu->hdev->stat.byte_rx += count;
578
Alan Cox39c2e602008-04-30 00:54:18 -0700579 tty_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580}
581
582static int hci_uart_register_dev(struct hci_uart *hu)
583{
584 struct hci_dev *hdev;
585
586 BT_DBG("");
587
588 /* Initialize and register HCI device */
589 hdev = hci_alloc_dev();
590 if (!hdev) {
591 BT_ERR("Can't allocate HCI device");
592 return -ENOMEM;
593 }
594
595 hu->hdev = hdev;
596
Marcel Holtmannc13854c2010-02-08 15:27:07 +0100597 hdev->bus = HCI_UART;
David Herrmann155961e2012-02-09 21:58:32 +0100598 hci_set_drvdata(hdev, hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Marcel Holtmannaee61f72015-10-20 21:30:45 +0200600 /* Only when vendor specific setup callback is provided, consider
601 * the manufacturer information valid. This avoids filling in the
602 * value for Ericsson when nothing is specified.
603 */
604 if (hu->proto->setup)
605 hdev->manufacturer = hu->proto->manufacturer;
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 hdev->open = hci_uart_open;
608 hdev->close = hci_uart_close;
609 hdev->flush = hci_uart_flush;
610 hdev->send = hci_uart_send_frame;
Loic Poulaineb173802015-03-25 15:19:30 +0100611 hdev->setup = hci_uart_setup;
David Herrmann6935e0f2012-03-09 15:53:42 +0100612 SET_HCIDEV_DEV(hdev, hu->tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Johan Hedberg63c7d092010-07-12 11:37:04 -0300614 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
615 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
616
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200617 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
618 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
619
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100620 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
Szymon Janca6c511c2012-05-23 12:35:46 +0200621 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100622
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100623 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
624 hdev->dev_type = HCI_AMP;
625 else
Marcel Holtmannca8bee52016-07-05 14:30:14 +0200626 hdev->dev_type = HCI_PRIMARY;
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100627
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300628 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
629 return 0;
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 if (hci_register_dev(hdev) < 0) {
632 BT_ERR("Can't register HCI device");
633 hci_free_dev(hdev);
634 return -ENODEV;
635 }
636
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300637 set_bit(HCI_UART_REGISTERED, &hu->flags);
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 return 0;
640}
641
642static int hci_uart_set_proto(struct hci_uart *hu, int id)
643{
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -0700644 const struct hci_uart_proto *p;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200645 int err;
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 p = hci_uart_get_proto(id);
648 if (!p)
649 return -EPROTONOSUPPORT;
650
651 err = p->open(hu);
652 if (err)
653 return err;
654
655 hu->proto = p;
656
657 err = hci_uart_register_dev(hu);
658 if (err) {
659 p->close(hu);
660 return err;
661 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200662
Kefeng Wang3858f0132019-02-23 12:33:27 +0800663 set_bit(HCI_UART_PROTO_READY, &hu->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 return 0;
665}
666
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200667static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
668{
669 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
670 BIT(HCI_UART_RESET_ON_INIT) |
671 BIT(HCI_UART_CREATE_AMP) |
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200672 BIT(HCI_UART_INIT_PENDING) |
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700673 BIT(HCI_UART_EXT_CONFIG) |
674 BIT(HCI_UART_VND_DETECT);
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200675
Marcel Holtmann41533fe2015-04-01 13:51:51 -0700676 if (flags & ~valid_flags)
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200677 return -EINVAL;
678
679 hu->hdev_flags = flags;
680
681 return 0;
682}
683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684/* hci_uart_tty_ioctl()
685 *
686 * Process IOCTL system call for the tty device.
687 *
688 * Arguments:
689 *
690 * tty pointer to tty instance data
691 * file pointer to open file object for device
692 * cmd IOCTL command code
693 * arg argument for IOCTL call (cmd dependent)
694 *
695 * Return Value: Command dependent
696 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700697static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
698 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700700 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 int err = 0;
702
703 BT_DBG("");
704
705 /* Verify the status of the device */
706 if (!hu)
707 return -EBADF;
708
709 switch (cmd) {
710 case HCIUARTSETPROTO:
711 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
712 err = hci_uart_set_proto(hu, arg);
Vignesh Raman05650692016-09-23 18:56:28 +0100713 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200715 } else
Vignesh Raman05650692016-09-23 18:56:28 +0100716 err = -EBUSY;
Marcel Holtmannc33be3c2007-05-09 09:15:45 +0200717 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 case HCIUARTGETPROTO:
720 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100721 err = hu->proto->id;
722 else
723 err = -EUNATCH;
724 break;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200725
Marcel Holtmannd2158742007-05-09 09:15:35 +0200726 case HCIUARTGETDEVICE:
Marcel Holtmannc7e0c142014-07-12 17:00:29 +0200727 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100728 err = hu->hdev->id;
729 else
730 err = -EUNATCH;
731 break;
Marcel Holtmannd2158742007-05-09 09:15:35 +0200732
Johan Hedberg63c7d092010-07-12 11:37:04 -0300733 case HCIUARTSETFLAGS:
734 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100735 err = -EBUSY;
736 else
737 err = hci_uart_set_flags(hu, arg);
Johan Hedberg63c7d092010-07-12 11:37:04 -0300738 break;
739
740 case HCIUARTGETFLAGS:
Vignesh Raman05650692016-09-23 18:56:28 +0100741 err = hu->hdev_flags;
742 break;
Johan Hedberg63c7d092010-07-12 11:37:04 -0300743
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 default:
Alan Cox47afa7a2008-10-13 10:44:17 +0100745 err = n_tty_ioctl_helper(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 break;
Peter Senna Tschudina20890d2012-09-07 17:24:39 +0200747 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 return err;
750}
751
752/*
753 * We don't provide read/write/poll interface for user space.
754 */
Marcel Holtmann0372a662005-10-28 19:20:45 +0200755static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700756 unsigned char __user *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757{
758 return 0;
759}
760
Marcel Holtmann0372a662005-10-28 19:20:45 +0200761static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700762 const unsigned char *data, size_t count)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200763{
764 return 0;
765}
766
767static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700768 struct file *filp, poll_table *wait)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200769{
770 return 0;
771}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773static int __init hci_uart_init(void)
774{
Alan Coxa352def2008-07-16 21:53:12 +0100775 static struct tty_ldisc_ops hci_uart_ldisc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 int err;
777
778 BT_INFO("HCI UART driver ver %s", VERSION);
779
780 /* Register the tty discipline */
781
Prasanna Karthikacf50c52015-07-23 11:08:52 +0000782 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
Marcel Holtmann0372a662005-10-28 19:20:45 +0200783 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
784 hci_uart_ldisc.name = "n_hci";
785 hci_uart_ldisc.open = hci_uart_tty_open;
786 hci_uart_ldisc.close = hci_uart_tty_close;
787 hci_uart_ldisc.read = hci_uart_tty_read;
788 hci_uart_ldisc.write = hci_uart_tty_write;
789 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
790 hci_uart_ldisc.poll = hci_uart_tty_poll;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200791 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
792 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
793 hci_uart_ldisc.owner = THIS_MODULE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Valentin Iliea08b15e2013-08-12 18:46:00 +0300795 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
796 if (err) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 BT_ERR("HCI line discipline registration failed. (%d)", err);
798 return err;
799 }
800
801#ifdef CONFIG_BT_HCIUART_H4
802 h4_init();
803#endif
804#ifdef CONFIG_BT_HCIUART_BCSP
805 bcsp_init();
806#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200807#ifdef CONFIG_BT_HCIUART_LL
808 ll_init();
809#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530810#ifdef CONFIG_BT_HCIUART_ATH3K
811 ath_init();
812#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300813#ifdef CONFIG_BT_HCIUART_3WIRE
814 h5_init();
815#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200816#ifdef CONFIG_BT_HCIUART_INTEL
817 intel_init();
818#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700819#ifdef CONFIG_BT_HCIUART_BCM
820 bcm_init();
821#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700822#ifdef CONFIG_BT_HCIUART_QCA
823 qca_init();
824#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100825#ifdef CONFIG_BT_HCIUART_AG6XX
826 ag6xx_init();
827#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200828#ifdef CONFIG_BT_HCIUART_MRVL
829 mrvl_init();
830#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 return 0;
833}
834
835static void __exit hci_uart_exit(void)
836{
837 int err;
838
839#ifdef CONFIG_BT_HCIUART_H4
840 h4_deinit();
841#endif
842#ifdef CONFIG_BT_HCIUART_BCSP
843 bcsp_deinit();
844#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200845#ifdef CONFIG_BT_HCIUART_LL
846 ll_deinit();
847#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530848#ifdef CONFIG_BT_HCIUART_ATH3K
849 ath_deinit();
850#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300851#ifdef CONFIG_BT_HCIUART_3WIRE
852 h5_deinit();
853#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200854#ifdef CONFIG_BT_HCIUART_INTEL
855 intel_deinit();
856#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700857#ifdef CONFIG_BT_HCIUART_BCM
858 bcm_deinit();
859#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700860#ifdef CONFIG_BT_HCIUART_QCA
861 qca_deinit();
862#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100863#ifdef CONFIG_BT_HCIUART_AG6XX
864 ag6xx_deinit();
865#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200866#ifdef CONFIG_BT_HCIUART_MRVL
867 mrvl_deinit();
868#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
870 /* Release tty registration of line discipline */
Valentin Iliea08b15e2013-08-12 18:46:00 +0300871 err = tty_unregister_ldisc(N_HCI);
872 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 BT_ERR("Can't unregister HCI line discipline (%d)", err);
874}
875
876module_init(hci_uart_init);
877module_exit(hci_uart_exit);
878
Marcel Holtmann63fbd242008-08-18 13:23:53 +0200879MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
881MODULE_VERSION(VERSION);
882MODULE_LICENSE("GPL");
883MODULE_ALIAS_LDISC(N_HCI);