blob: 6f9e406b28a6765a0a93e1e743bbf2a708254cfe [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 Jenkins048e1bd2017-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 Jenkins048e1bd2017-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{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
129 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
130 return 0;
131 }
132
133 BT_DBG("");
134
Felipe Balbida64c272014-04-23 09:58:26 -0500135 schedule_work(&hu->write_work);
136
137 return 0;
138}
Sebastian Reichel081f36a2017-03-28 17:59:37 +0200139EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
Felipe Balbida64c272014-04-23 09:58:26 -0500140
141static void hci_uart_write_work(struct work_struct *work)
142{
143 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
144 struct tty_struct *tty = hu->tty;
145 struct hci_dev *hdev = hu->hdev;
146 struct sk_buff *skb;
147
148 /* REVISIT: should we cope with bad skbs or ->write() returning
149 * and error value ?
150 */
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152restart:
153 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
154
155 while ((skb = hci_uart_dequeue(hu))) {
156 int len;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700159 len = tty->ops->write(tty, skb->data, skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 hdev->stat.byte_tx += len;
161
162 skb_pull(skb, len);
163 if (skb->len) {
164 hu->tx_skb = skb;
165 break;
166 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200167
Marcel Holtmann618e8bc2015-11-05 07:33:56 +0100168 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 kfree_skb(skb);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200170 }
171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
173 goto restart;
174
175 clear_bit(HCI_UART_SENDING, &hu->tx_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176}
177
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300178static void hci_uart_init_work(struct work_struct *work)
179{
180 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
181 int err;
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100182 struct hci_dev *hdev;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300183
184 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
185 return;
186
187 err = hci_register_dev(hu->hdev);
188 if (err < 0) {
189 BT_ERR("Can't register HCI device");
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100190 hdev = hu->hdev;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300191 hu->hdev = NULL;
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100192 hci_free_dev(hdev);
Dean Jenkinsd160b742017-04-20 18:06:41 +0100193 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300194 hu->proto->close(hu);
Dean Jenkinscb926522017-04-20 18:06:39 +0100195 return;
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300196 }
197
198 set_bit(HCI_UART_REGISTERED, &hu->flags);
199}
200
201int hci_uart_init_ready(struct hci_uart *hu)
202{
203 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
204 return -EALREADY;
205
206 schedule_work(&hu->init_ready);
207
208 return 0;
209}
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/* ------- Interface to HCI layer ------ */
212/* Initialize device */
213static int hci_uart_open(struct hci_dev *hdev)
214{
215 BT_DBG("%s %p", hdev->name, hdev);
216
217 /* Nothing to do for UART driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 return 0;
219}
220
221/* Reset device */
222static int hci_uart_flush(struct hci_dev *hdev)
223{
David Herrmann155961e2012-02-09 21:58:32 +0100224 struct hci_uart *hu = hci_get_drvdata(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 struct tty_struct *tty = hu->tty;
226
227 BT_DBG("hdev %p tty %p", hdev, tty);
228
229 if (hu->tx_skb) {
230 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
231 }
232
233 /* Flush any pending characters in the driver and discipline. */
234 tty_ldisc_flush(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -0700235 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Loic Poulain84cb3df2016-04-04 10:48:13 +0200237 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 hu->proto->flush(hu);
239
240 return 0;
241}
242
243/* Close device */
244static int hci_uart_close(struct hci_dev *hdev)
245{
246 BT_DBG("hdev %p", hdev);
247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 hci_uart_flush(hdev);
David Newall3611f4d2008-02-11 21:41:30 -0800249 hdev->flush = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 return 0;
251}
252
253/* Send frames from HCI layer */
Marcel Holtmann7bd8f092013-10-11 06:19:18 -0700254static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
Marcel Holtmann52bc4232013-10-11 07:01:03 -0700256 struct hci_uart *hu = hci_get_drvdata(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Marcel Holtmann618e8bc2015-11-05 07:33:56 +0100258 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
259 skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Dean Jenkinsab00f892017-04-28 13:57:24 +0100261 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
262 return -EUNATCH;
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 hu->proto->enqueue(hu, skb);
265
266 hci_uart_tx_wakeup(hu);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return 0;
269}
270
Ilya Faenson2a973df2015-06-17 17:30:56 -0400271/* Flow control or un-flow control the device */
272void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
273{
274 struct tty_struct *tty = hu->tty;
275 struct ktermios ktermios;
276 int status;
277 unsigned int set = 0;
278 unsigned int clear = 0;
279
280 if (enable) {
281 /* Disable hardware flow control */
282 ktermios = tty->termios;
283 ktermios.c_cflag &= ~CRTSCTS;
284 status = tty_set_termios(tty, &ktermios);
285 BT_DBG("Disabling hardware flow control: %s",
286 status ? "failed" : "success");
287
288 /* Clear RTS to prevent the device from sending */
289 /* Most UARTs need OUT2 to enable interrupts */
290 status = tty->driver->ops->tiocmget(tty);
291 BT_DBG("Current tiocm 0x%x", status);
292
293 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
294 clear = ~set;
295 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
296 TIOCM_OUT2 | TIOCM_LOOP;
297 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
298 TIOCM_OUT2 | TIOCM_LOOP;
299 status = tty->driver->ops->tiocmset(tty, set, clear);
300 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
301 } else {
302 /* Set RTS to allow the device to send again */
303 status = tty->driver->ops->tiocmget(tty);
304 BT_DBG("Current tiocm 0x%x", status);
305
306 set |= (TIOCM_OUT2 | TIOCM_RTS);
307 clear = ~set;
308 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
309 TIOCM_OUT2 | TIOCM_LOOP;
310 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
311 TIOCM_OUT2 | TIOCM_LOOP;
312 status = tty->driver->ops->tiocmset(tty, set, clear);
313 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
314
315 /* Re-enable hardware flow control */
316 ktermios = tty->termios;
317 ktermios.c_cflag |= CRTSCTS;
318 status = tty_set_termios(tty, &ktermios);
319 BT_DBG("Enabling hardware flow control: %s",
320 status ? "failed" : "success");
321 }
322}
323
324void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
325 unsigned int oper_speed)
326{
327 hu->init_speed = init_speed;
328 hu->oper_speed = oper_speed;
329}
330
Frederic Danis77213832015-05-28 11:25:03 +0200331void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
332{
333 struct tty_struct *tty = hu->tty;
334 struct ktermios ktermios;
335
336 ktermios = tty->termios;
337 ktermios.c_cflag &= ~CBAUD;
Frederic Danis77213832015-05-28 11:25:03 +0200338 tty_termios_encode_baud_rate(&ktermios, speed, speed);
339
340 /* tty_set_termios() return not checked as it is always 0 */
341 tty_set_termios(tty, &ktermios);
342
Ilya Faenson2a973df2015-06-17 17:30:56 -0400343 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
344 tty->termios.c_ispeed, tty->termios.c_ospeed);
Frederic Danis77213832015-05-28 11:25:03 +0200345}
346
Loic Poulaineb173802015-03-25 15:19:30 +0100347static int hci_uart_setup(struct hci_dev *hdev)
348{
349 struct hci_uart *hu = hci_get_drvdata(hdev);
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700350 struct hci_rp_read_local_version *ver;
351 struct sk_buff *skb;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400352 unsigned int speed;
Frederic Danis77213832015-05-28 11:25:03 +0200353 int err;
354
Ilya Faenson2a973df2015-06-17 17:30:56 -0400355 /* Init speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200356 if (hu->init_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400357 speed = hu->init_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200358 else if (hu->proto->init_speed)
359 speed = hu->proto->init_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400360 else
361 speed = 0;
Frederic Danis77213832015-05-28 11:25:03 +0200362
Ilya Faenson2a973df2015-06-17 17:30:56 -0400363 if (speed)
364 hci_uart_set_baudrate(hu, speed);
365
366 /* Operational speed if any */
Frederic Danis960ef1d2015-06-18 12:43:27 +0200367 if (hu->oper_speed)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400368 speed = hu->oper_speed;
Frederic Danis960ef1d2015-06-18 12:43:27 +0200369 else if (hu->proto->oper_speed)
370 speed = hu->proto->oper_speed;
Ilya Faenson2a973df2015-06-17 17:30:56 -0400371 else
372 speed = 0;
373
374 if (hu->proto->set_baudrate && speed) {
375 err = hu->proto->set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200376 if (!err)
Ilya Faenson2a973df2015-06-17 17:30:56 -0400377 hci_uart_set_baudrate(hu, speed);
Frederic Danis77213832015-05-28 11:25:03 +0200378 }
Loic Poulaineb173802015-03-25 15:19:30 +0100379
380 if (hu->proto->setup)
381 return hu->proto->setup(hu);
382
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700383 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
384 return 0;
385
386 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
387 HCI_INIT_TIMEOUT);
388 if (IS_ERR(skb)) {
389 BT_ERR("%s: Reading local version information failed (%ld)",
390 hdev->name, PTR_ERR(skb));
391 return 0;
392 }
393
394 if (skb->len != sizeof(*ver)) {
395 BT_ERR("%s: Event length mismatch for version information",
396 hdev->name);
397 goto done;
398 }
399
400 ver = (struct hci_rp_read_local_version *)skb->data;
401
402 switch (le16_to_cpu(ver->manufacturer)) {
Marcel Holtmann16e38872015-04-04 16:13:02 -0700403#ifdef CONFIG_BT_HCIUART_INTEL
404 case 2:
Marcel Holtmannbca03c92015-04-06 00:52:14 -0700405 hdev->set_bdaddr = btintel_set_bdaddr;
406 btintel_check_bdaddr(hdev);
Marcel Holtmann16e38872015-04-04 16:13:02 -0700407 break;
408#endif
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700409#ifdef CONFIG_BT_HCIUART_BCM
410 case 15:
Marcel Holtmann3e0ac122015-04-05 22:52:12 -0700411 hdev->set_bdaddr = btbcm_set_bdaddr;
412 btbcm_check_bdaddr(hdev);
Marcel Holtmanne9a2dd22015-04-04 16:13:03 -0700413 break;
414#endif
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700415 }
416
417done:
418 kfree_skb(skb);
Loic Poulaineb173802015-03-25 15:19:30 +0100419 return 0;
420}
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/* ------ LDISC part ------ */
423/* hci_uart_tty_open
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900424 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 * Called when line discipline changed to HCI_UART.
426 *
427 * Arguments:
428 * tty pointer to tty info structure
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900429 * Return Value:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 * 0 if success, otherwise error code
431 */
432static int hci_uart_tty_open(struct tty_struct *tty)
433{
Jiri Slabyf327b342012-10-18 22:26:34 +0200434 struct hci_uart *hu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436 BT_DBG("tty %p", tty);
437
Alan Coxc19483c2010-10-22 14:11:26 +0100438 /* Error if the tty has no write op instead of leaving an exploitable
439 hole */
440 if (tty->ops->write == NULL)
441 return -EOPNOTSUPP;
442
Valentin Iliea08b15e2013-08-12 18:46:00 +0300443 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
444 if (!hu) {
Marcel Holtmann77851622006-09-21 16:23:19 +0200445 BT_ERR("Can't allocate control structure");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return -ENFILE;
447 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 tty->disc_data = hu;
450 hu->tty = tty;
Alan Cox33f0f882006-01-09 20:54:13 -0800451 tty->receive_room = 65536;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Sebastian Reichelaeac3012017-03-28 17:59:34 +0200453 /* disable alignment support by default */
454 hu->alignment = 1;
455 hu->padding = 0;
456
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300457 INIT_WORK(&hu->init_ready, hci_uart_init_work);
Felipe Balbida64c272014-04-23 09:58:26 -0500458 INIT_WORK(&hu->write_work, hci_uart_write_work);
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300459
Peter Hurleye6e981c2015-11-27 16:39:00 -0500460 /* Flush any pending characters in the driver */
Alan Coxf34d7a52008-04-30 00:54:13 -0700461 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 return 0;
464}
465
466/* hci_uart_tty_close()
467 *
468 * Called when the line discipline is changed to something
469 * else, the tty is closed, or the tty detects a hangup.
470 */
471static void hci_uart_tty_close(struct tty_struct *tty)
472{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700473 struct hci_uart *hu = tty->disc_data;
Johan Hedbergdac670b2012-07-16 16:12:10 +0300474 struct hci_dev *hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476 BT_DBG("tty %p", tty);
477
478 /* Detach from the tty */
479 tty->disc_data = NULL;
480
Johan Hedbergdac670b2012-07-16 16:12:10 +0300481 if (!hu)
482 return;
Marcel Holtmann22ad4202007-05-09 09:15:40 +0200483
Johan Hedbergdac670b2012-07-16 16:12:10 +0300484 hdev = hu->hdev;
485 if (hdev)
486 hci_uart_close(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
Felipe Balbida64c272014-04-23 09:58:26 -0500488 cancel_work_sync(&hu->write_work);
489
Loic Poulain84cb3df2016-04-04 10:48:13 +0200490 if (test_and_clear_bit(HCI_UART_PROTO_READY, &hu->flags)) {
Johan Hedbergdac670b2012-07-16 16:12:10 +0300491 if (hdev) {
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300492 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
493 hci_unregister_dev(hdev);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300494 hci_free_dev(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 }
Johan Hedbergdac670b2012-07-16 16:12:10 +0300496 hu->proto->close(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
Loic Poulain84cb3df2016-04-04 10:48:13 +0200498 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Johan Hedbergdac670b2012-07-16 16:12:10 +0300499
500 kfree(hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
503/* hci_uart_tty_wakeup()
504 *
505 * Callback for transmit wakeup. Called when low level
506 * device driver can accept more send data.
507 *
508 * Arguments: tty pointer to associated tty instance data
509 * Return Value: None
510 */
511static void hci_uart_tty_wakeup(struct tty_struct *tty)
512{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700513 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515 BT_DBG("");
516
517 if (!hu)
518 return;
519
520 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
521
522 if (tty != hu->tty)
523 return;
524
Loic Poulain84cb3df2016-04-04 10:48:13 +0200525 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 hci_uart_tx_wakeup(hu);
527}
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529/* hci_uart_tty_receive()
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900530 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 * Called by tty low level driver when receive data is
532 * available.
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900533 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 * Arguments: tty pointer to tty isntance data
535 * data pointer to received data
536 * flags pointer to flags for data
537 * count count of received data in bytes
Chan-yeol Park1687dfc2013-04-02 21:24:23 +0900538 *
Linus Torvalds55db4c62011-06-04 06:33:24 +0900539 * Return Value: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700541static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
542 char *flags, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700544 struct hci_uart *hu = tty->disc_data;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 if (!hu || tty != hu->tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900547 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Loic Poulain84cb3df2016-04-04 10:48:13 +0200549 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
Linus Torvalds55db4c62011-06-04 06:33:24 +0900550 return;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200551
Frederic Danis7649faf2015-09-23 18:18:10 +0200552 /* It does not need a lock here as it is already protected by a mutex in
553 * tty caller
554 */
Marcel Holtmann9d1c40e2015-04-04 20:59:41 -0700555 hu->proto->recv(hu, data, count);
Chan-yeol Park788f0922013-04-02 21:24:22 +0900556
557 if (hu->hdev)
558 hu->hdev->stat.byte_rx += count;
559
Alan Cox39c2e602008-04-30 00:54:18 -0700560 tty_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
562
563static int hci_uart_register_dev(struct hci_uart *hu)
564{
565 struct hci_dev *hdev;
566
567 BT_DBG("");
568
569 /* Initialize and register HCI device */
570 hdev = hci_alloc_dev();
571 if (!hdev) {
572 BT_ERR("Can't allocate HCI device");
573 return -ENOMEM;
574 }
575
576 hu->hdev = hdev;
577
Marcel Holtmannc13854c2010-02-08 15:27:07 +0100578 hdev->bus = HCI_UART;
David Herrmann155961e2012-02-09 21:58:32 +0100579 hci_set_drvdata(hdev, hu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Marcel Holtmannaee61f72015-10-20 21:30:45 +0200581 /* Only when vendor specific setup callback is provided, consider
582 * the manufacturer information valid. This avoids filling in the
583 * value for Ericsson when nothing is specified.
584 */
585 if (hu->proto->setup)
586 hdev->manufacturer = hu->proto->manufacturer;
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 hdev->open = hci_uart_open;
589 hdev->close = hci_uart_close;
590 hdev->flush = hci_uart_flush;
591 hdev->send = hci_uart_send_frame;
Loic Poulaineb173802015-03-25 15:19:30 +0100592 hdev->setup = hci_uart_setup;
David Herrmann6935e0f2012-03-09 15:53:42 +0100593 SET_HCIDEV_DEV(hdev, hu->tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Johan Hedberg63c7d092010-07-12 11:37:04 -0300595 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
596 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
597
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200598 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
599 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
600
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100601 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
Szymon Janca6c511c2012-05-23 12:35:46 +0200602 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
Marcel Holtmanna55e1f32012-02-24 17:12:24 +0100603
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100604 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
605 hdev->dev_type = HCI_AMP;
606 else
Marcel Holtmannca8bee52016-07-05 14:30:14 +0200607 hdev->dev_type = HCI_PRIMARY;
Marcel Holtmann8a7a3fd2012-02-24 17:09:38 +0100608
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300609 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
610 return 0;
611
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 if (hci_register_dev(hdev) < 0) {
613 BT_ERR("Can't register HCI device");
Dean Jenkinsa225b8c2017-04-20 18:06:40 +0100614 hu->hdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 hci_free_dev(hdev);
616 return -ENODEV;
617 }
618
Johan Hedberg9f2aee82012-07-16 16:12:11 +0300619 set_bit(HCI_UART_REGISTERED, &hu->flags);
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return 0;
622}
623
624static int hci_uart_set_proto(struct hci_uart *hu, int id)
625{
Marcel Holtmann4ee7ef12015-04-04 22:11:43 -0700626 const struct hci_uart_proto *p;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200627 int err;
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 p = hci_uart_get_proto(id);
630 if (!p)
631 return -EPROTONOSUPPORT;
632
633 err = p->open(hu);
634 if (err)
635 return err;
636
637 hu->proto = p;
Loic Poulain84cb3df2016-04-04 10:48:13 +0200638 set_bit(HCI_UART_PROTO_READY, &hu->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 err = hci_uart_register_dev(hu);
641 if (err) {
Loic Poulain84cb3df2016-04-04 10:48:13 +0200642 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 p->close(hu);
644 return err;
645 }
Marcel Holtmann0372a662005-10-28 19:20:45 +0200646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return 0;
648}
649
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200650static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
651{
652 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
653 BIT(HCI_UART_RESET_ON_INIT) |
654 BIT(HCI_UART_CREATE_AMP) |
Marcel Holtmann6afd04a2014-07-11 07:12:58 +0200655 BIT(HCI_UART_INIT_PENDING) |
Marcel Holtmannfb2ce8d2015-04-04 16:13:01 -0700656 BIT(HCI_UART_EXT_CONFIG) |
657 BIT(HCI_UART_VND_DETECT);
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200658
Marcel Holtmann41533fe2015-04-01 13:51:51 -0700659 if (flags & ~valid_flags)
Marcel Holtmannbb72bd62014-07-11 07:12:57 +0200660 return -EINVAL;
661
662 hu->hdev_flags = flags;
663
664 return 0;
665}
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/* hci_uart_tty_ioctl()
668 *
669 * Process IOCTL system call for the tty device.
670 *
671 * Arguments:
672 *
673 * tty pointer to tty instance data
674 * file pointer to open file object for device
675 * cmd IOCTL command code
676 * arg argument for IOCTL call (cmd dependent)
677 *
678 * Return Value: Command dependent
679 */
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700680static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
681 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Marcel Holtmanndfe19d22015-04-04 19:57:21 -0700683 struct hci_uart *hu = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 int err = 0;
685
686 BT_DBG("");
687
688 /* Verify the status of the device */
689 if (!hu)
690 return -EBADF;
691
692 switch (cmd) {
693 case HCIUARTSETPROTO:
694 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
695 err = hci_uart_set_proto(hu, arg);
Vignesh Raman05650692016-09-23 18:56:28 +0100696 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
Marcel Holtmann0372a662005-10-28 19:20:45 +0200698 } else
Vignesh Raman05650692016-09-23 18:56:28 +0100699 err = -EBUSY;
Marcel Holtmannc33be3c2007-05-09 09:15:45 +0200700 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 case HCIUARTGETPROTO:
703 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100704 err = hu->proto->id;
705 else
706 err = -EUNATCH;
707 break;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200708
Marcel Holtmannd2158742007-05-09 09:15:35 +0200709 case HCIUARTGETDEVICE:
Marcel Holtmannc7e0c142014-07-12 17:00:29 +0200710 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100711 err = hu->hdev->id;
712 else
713 err = -EUNATCH;
714 break;
Marcel Holtmannd2158742007-05-09 09:15:35 +0200715
Johan Hedberg63c7d092010-07-12 11:37:04 -0300716 case HCIUARTSETFLAGS:
717 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
Vignesh Raman05650692016-09-23 18:56:28 +0100718 err = -EBUSY;
719 else
720 err = hci_uart_set_flags(hu, arg);
Johan Hedberg63c7d092010-07-12 11:37:04 -0300721 break;
722
723 case HCIUARTGETFLAGS:
Vignesh Raman05650692016-09-23 18:56:28 +0100724 err = hu->hdev_flags;
725 break;
Johan Hedberg63c7d092010-07-12 11:37:04 -0300726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 default:
Alan Cox47afa7a2008-10-13 10:44:17 +0100728 err = n_tty_ioctl_helper(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 break;
Peter Senna Tschudina20890d2012-09-07 17:24:39 +0200730 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
732 return err;
733}
734
735/*
736 * We don't provide read/write/poll interface for user space.
737 */
Marcel Holtmann0372a662005-10-28 19:20:45 +0200738static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700739 unsigned char __user *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740{
741 return 0;
742}
743
Marcel Holtmann0372a662005-10-28 19:20:45 +0200744static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700745 const unsigned char *data, size_t count)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200746{
747 return 0;
748}
749
750static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
Marcel Holtmannfacf5222015-04-04 19:57:22 -0700751 struct file *filp, poll_table *wait)
Marcel Holtmann0372a662005-10-28 19:20:45 +0200752{
753 return 0;
754}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756static int __init hci_uart_init(void)
757{
Alan Coxa352def2008-07-16 21:53:12 +0100758 static struct tty_ldisc_ops hci_uart_ldisc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 int err;
760
761 BT_INFO("HCI UART driver ver %s", VERSION);
762
763 /* Register the tty discipline */
764
Prasanna Karthikacf50c52015-07-23 11:08:52 +0000765 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
Marcel Holtmann0372a662005-10-28 19:20:45 +0200766 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
767 hci_uart_ldisc.name = "n_hci";
768 hci_uart_ldisc.open = hci_uart_tty_open;
769 hci_uart_ldisc.close = hci_uart_tty_close;
770 hci_uart_ldisc.read = hci_uart_tty_read;
771 hci_uart_ldisc.write = hci_uart_tty_write;
772 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
773 hci_uart_ldisc.poll = hci_uart_tty_poll;
Marcel Holtmann0372a662005-10-28 19:20:45 +0200774 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
775 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
776 hci_uart_ldisc.owner = THIS_MODULE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Valentin Iliea08b15e2013-08-12 18:46:00 +0300778 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
779 if (err) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 BT_ERR("HCI line discipline registration failed. (%d)", err);
781 return err;
782 }
783
784#ifdef CONFIG_BT_HCIUART_H4
785 h4_init();
786#endif
787#ifdef CONFIG_BT_HCIUART_BCSP
788 bcsp_init();
789#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200790#ifdef CONFIG_BT_HCIUART_LL
791 ll_init();
792#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530793#ifdef CONFIG_BT_HCIUART_ATH3K
794 ath_init();
795#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300796#ifdef CONFIG_BT_HCIUART_3WIRE
797 h5_init();
798#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200799#ifdef CONFIG_BT_HCIUART_INTEL
800 intel_init();
801#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700802#ifdef CONFIG_BT_HCIUART_BCM
803 bcm_init();
804#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700805#ifdef CONFIG_BT_HCIUART_QCA
806 qca_init();
807#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100808#ifdef CONFIG_BT_HCIUART_AG6XX
809 ag6xx_init();
810#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200811#ifdef CONFIG_BT_HCIUART_MRVL
812 mrvl_init();
813#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 return 0;
816}
817
818static void __exit hci_uart_exit(void)
819{
820 int err;
821
822#ifdef CONFIG_BT_HCIUART_H4
823 h4_deinit();
824#endif
825#ifdef CONFIG_BT_HCIUART_BCSP
826 bcsp_deinit();
827#endif
Ohad Ben-Cohen166d2f62007-10-20 13:42:36 +0200828#ifdef CONFIG_BT_HCIUART_LL
829 ll_deinit();
830#endif
Suraj Sumangalab3190df2010-07-19 12:34:07 +0530831#ifdef CONFIG_BT_HCIUART_ATH3K
832 ath_deinit();
833#endif
Johan Hedberg7dec65c2012-07-16 16:12:02 +0300834#ifdef CONFIG_BT_HCIUART_3WIRE
835 h5_deinit();
836#endif
Loic Poulainca93cee2015-07-01 12:20:26 +0200837#ifdef CONFIG_BT_HCIUART_INTEL
838 intel_deinit();
839#endif
Marcel Holtmannbdd88182015-04-05 22:52:18 -0700840#ifdef CONFIG_BT_HCIUART_BCM
841 bcm_deinit();
842#endif
Ben Young Tae Kim0ff252c2015-08-10 14:24:17 -0700843#ifdef CONFIG_BT_HCIUART_QCA
844 qca_deinit();
845#endif
Loic Poulain395174b2016-02-22 10:48:03 +0100846#ifdef CONFIG_BT_HCIUART_AG6XX
847 ag6xx_deinit();
848#endif
Loic Poulain162f8122016-09-19 16:29:27 +0200849#ifdef CONFIG_BT_HCIUART_MRVL
850 mrvl_deinit();
851#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
853 /* Release tty registration of line discipline */
Valentin Iliea08b15e2013-08-12 18:46:00 +0300854 err = tty_unregister_ldisc(N_HCI);
855 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 BT_ERR("Can't unregister HCI line discipline (%d)", err);
857}
858
859module_init(hci_uart_init);
860module_exit(hci_uart_exit);
861
Marcel Holtmann63fbd242008-08-18 13:23:53 +0200862MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
864MODULE_VERSION(VERSION);
865MODULE_LICENSE("GPL");
866MODULE_ALIAS_LDISC(N_HCI);