drivers/bluetooth/hci_ldisc.c

   1 /*
   2  *
   3  *  Bluetooth HCI UART driver
   4  *
   5  *  Copyright (C) 2000-2001  Qualcomm Incorporated
   6  *  Copyright (C) 2002-2003  Maxim Krasnyansky <maxk@qualcomm.com>
   7  *  Copyright (C) 2004-2005  Marcel Holtmann <marcel@holtmann.org>
   8  *
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  *
  24  */
  25
  26 #include <linux/module.h>
  27
  28 #include <linux/kernel.h>
  29 #include <linux/init.h>
  30 #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>
  43
  44 #include <net/bluetooth/bluetooth.h>
  45 #include <net/bluetooth/hci_core.h>
  46
  47 #include "hci_uart.h"
  48
  49 #ifdef CONFIG_BT_HCIBCM4325
  50 extern int bcm4325_sleep(int bSleep);
  51 #endif
  52
  53 #define VERSION "2.2"
  54
  55 static int reset = 0;
  56
  57 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
  58
  59 int hci_uart_register_proto(struct hci_uart_proto *p)
  60 {
  61         if (p->id >= HCI_UART_MAX_PROTO)
  62                 return -EINVAL;
  63
  64         if (hup[p->id])
  65                 return -EEXIST;
  66
  67         hup[p->id] = p;
  68
  69         return 0;
  70 }
  71
  72 int hci_uart_unregister_proto(struct hci_uart_proto *p)
  73 {
  74         if (p->id >= HCI_UART_MAX_PROTO)
  75                 return -EINVAL;
  76
  77         if (!hup[p->id])
  78                 return -EINVAL;
  79
  80         hup[p->id] = NULL;
  81
  82         return 0;
  83 }
  84
  85 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
  86 {
  87         if (id >= HCI_UART_MAX_PROTO)
  88                 return NULL;
  89
  90         return hup[id];
  91 }
  92
  93 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
  94 {
  95         struct hci_dev *hdev = hu->hdev;
  96
  97         /* Update HCI stat counters */
  98         switch (pkt_type) {
  99         case HCI_COMMAND_PKT:
 100                 hdev->stat.cmd_tx++;
 101                 break;
 102
 103         case HCI_ACLDATA_PKT:
 104                 hdev->stat.acl_tx++;
 105                 break;
 106
 107         case HCI_SCODATA_PKT:
 108                 hdev->stat.cmd_tx++;
 109                 break;
 110         }
 111 }
 112
 113 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
 114 {
 115         struct sk_buff *skb = hu->tx_skb;
 116
 117         if (!skb)
 118                 skb = hu->proto->dequeue(hu);
 119         else
 120                 hu->tx_skb = NULL;
 121
 122         return skb;
 123 }
 124
 125 int hci_uart_tx_wakeup(struct hci_uart *hu)
 126 {
 127         struct tty_struct *tty = hu->tty;
 128         struct hci_dev *hdev = hu->hdev;
 129         struct sk_buff *skb;
 130
 131         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
 138 restart:
 139         clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
 140 /*added by Barry,for broadcom 4325*/
 141 #ifdef CONFIG_BT_HCIBCM4325
 142         bcm4325_sleep(0);
 143 #endif;
 144         while ((skb = hci_uart_dequeue(hu))) {
 145                 int len;
 146
 147                 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 148                 len = tty->ops->write(tty, skb->data, skb->len);
 149                 hdev->stat.byte_tx += len;
 150
 151                 skb_pull(skb, len);
 152                 if (skb->len) {
 153                         hu->tx_skb = skb;
 154                         break;
 155                 }
 156
 157                 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
 158                 kfree_skb(skb);
 159         }
 160
 161         if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
 162                 goto restart;
 163
 164         clear_bit(HCI_UART_SENDING, &hu->tx_state);
 165         return 0;
 166 }
 167
 168 /* ------- Interface to HCI layer ------ */
 169 /* Initialize device */
 170 static int hci_uart_open(struct hci_dev *hdev)
 171 {
 172         BT_DBG("%s %p", hdev->name, hdev);
 173
 174         /* Nothing to do for UART driver */
 175
 176         set_bit(HCI_RUNNING, &hdev->flags);
 177
 178         return 0;
 179 }
 180
 181 /* Reset device */
 182 static int hci_uart_flush(struct hci_dev *hdev)
 183 {
 184         struct hci_uart *hu  = (struct hci_uart *) hdev->driver_data;
 185         struct tty_struct *tty = hu->tty;
 186
 187         BT_DBG("hdev %p tty %p", hdev, tty);
 188
 189         if (hu->tx_skb) {
 190                 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
 191         }
 192
 193         /* Flush any pending characters in the driver and discipline. */
 194         tty_ldisc_flush(tty);
 195         tty_driver_flush_buffer(tty);
 196
 197         if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
 198                 hu->proto->flush(hu);
 199
 200         return 0;
 201 }
 202
 203 /* Close device */
 204 static int hci_uart_close(struct hci_dev *hdev)
 205 {
 206         BT_DBG("hdev %p", hdev);
 207
 208         if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
 209                 return 0;
 210
 211         hci_uart_flush(hdev);
 212         hdev->flush = NULL;
 213         return 0;
 214 }
 215
 216 /* Send frames from HCI layer */
 217 static int hci_uart_send_frame(struct sk_buff *skb)
 218 {
 219         struct hci_dev* hdev = (struct hci_dev *) skb->dev;
 220         struct tty_struct *tty;
 221         struct hci_uart *hu;
 222
 223         if (!hdev) {
 224                 BT_ERR("Frame for uknown device (hdev=NULL)");
 225                 return -ENODEV;
 226         }
 227
 228         if (!test_bit(HCI_RUNNING, &hdev->flags))
 229                 return -EBUSY;
 230
 231         hu = (struct hci_uart *) hdev->driver_data;
 232         tty = hu->tty;
 233
 234         BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
 235
 236         hu->proto->enqueue(hu, skb);
 237
 238         hci_uart_tx_wakeup(hu);
 239
 240         return 0;
 241 }
 242
 243 static void hci_uart_destruct(struct hci_dev *hdev)
 244 {
 245         if (!hdev)
 246                 return;
 247
 248         BT_DBG("%s", hdev->name);
 249         kfree(hdev->driver_data);
 250 }
 251
 252 /* ------ LDISC part ------ */
 253 /* hci_uart_tty_open
 254  *
 255  *     Called when line discipline changed to HCI_UART.
 256  *
 257  * Arguments:
 258  *     tty    pointer to tty info structure
 259  * Return Value:
 260  *     0 if success, otherwise error code
 261  */
 262 static int hci_uart_tty_open(struct tty_struct *tty)
 263 {
 264         struct hci_uart *hu = (void *) tty->disc_data;
 265
 266         BT_DBG("tty %p", tty);
 267
 268         /* FIXME: This btw is bogus, nothing requires the old ldisc to clear
 269            the pointer */
 270         if (hu)
 271                 return -EEXIST;
 272
 273         /* Error if the tty has no write op instead of leaving an exploitable
 274            hole */
 275         if (tty->ops->write == NULL)
 276                 return -EOPNOTSUPP;
 277
 278         if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
 279                 BT_ERR("Can't allocate control structure");
 280                 return -ENFILE;
 281         }
 282
 283         tty->disc_data = hu;
 284         hu->tty = tty;
 285         tty->receive_room = 65536;
 286
 287         spin_lock_init(&hu->rx_lock);
 288
 289         /* Flush any pending characters in the driver and line discipline. */
 290
 291         /* FIXME: why is this needed. Note don't use ldisc_ref here as the
 292            open path is before the ldisc is referencable */
 293
 294         if (tty->ldisc->ops->flush_buffer)
 295                 tty->ldisc->ops->flush_buffer(tty);
 296         tty_driver_flush_buffer(tty);
 297
 298         return 0;
 299 }
 300
 301 /* hci_uart_tty_close()
 302  *
 303  *    Called when the line discipline is changed to something
 304  *    else, the tty is closed, or the tty detects a hangup.
 305  */
 306 static void hci_uart_tty_close(struct tty_struct *tty)
 307 {
 308         struct hci_uart *hu = (void *)tty->disc_data;
 309
 310         BT_DBG("tty %p", tty);
 311
 312         /* Detach from the tty */
 313         tty->disc_data = NULL;
 314
 315         if (hu) {
 316                 struct hci_dev *hdev = hu->hdev;
 317
 318                 if (hdev)
 319                         hci_uart_close(hdev);
 320
 321                 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
 322                         hu->proto->close(hu);
 323                         hci_unregister_dev(hdev);
 324                         hci_free_dev(hdev);
 325                 }
 326         }
 327 }
 328
 329 /* hci_uart_tty_wakeup()
 330  *
 331  *    Callback for transmit wakeup. Called when low level
 332  *    device driver can accept more send data.
 333  *
 334  * Arguments:        tty    pointer to associated tty instance data
 335  * Return Value:    None
 336  */
 337 static void hci_uart_tty_wakeup(struct tty_struct *tty)
 338 {
 339         struct hci_uart *hu = (void *)tty->disc_data;
 340
 341         BT_DBG("");
 342
 343         if (!hu)
 344                 return;
 345
 346         clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 347
 348         if (tty != hu->tty)
 349                 return;
 350
 351         if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
 352                 hci_uart_tx_wakeup(hu);
 353 }
 354
 355 /* hci_uart_tty_receive()
 356  *
 357  *     Called by tty low level driver when receive data is
 358  *     available.
 359  *
 360  * Arguments:  tty          pointer to tty isntance data
 361  *             data         pointer to received data
 362  *             flags        pointer to flags for data
 363  *             count        count of received data in bytes
 364  *
 365  * Return Value:    None
 366  */
 367 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
 368 {
 369         struct hci_uart *hu = (void *)tty->disc_data;
 370
 371         if (!hu || tty != hu->tty)
 372                 return;
 373
 374         if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
 375                 return;
 376
 377         spin_lock(&hu->rx_lock);
 378         hu->proto->recv(hu, (void *) data, count);
 379         hu->hdev->stat.byte_rx += count;
 380         spin_unlock(&hu->rx_lock);
 381
 382         tty_unthrottle(tty);
 383 }
 384
 385 static int hci_uart_register_dev(struct hci_uart *hu)
 386 {
 387         struct hci_dev *hdev;
 388
 389         BT_DBG("");
 390
 391         /* Initialize and register HCI device */
 392         hdev = hci_alloc_dev();
 393         if (!hdev) {
 394                 BT_ERR("Can't allocate HCI device");
 395                 return -ENOMEM;
 396         }
 397
 398         hu->hdev = hdev;
 399
 400         hdev->type = HCI_UART;
 401         hdev->driver_data = hu;
 402
 403         hdev->open  = hci_uart_open;
 404         hdev->close = hci_uart_close;
 405         hdev->flush = hci_uart_flush;
 406         hdev->send  = hci_uart_send_frame;
 407         hdev->destruct = hci_uart_destruct;
 408
 409         hdev->owner = THIS_MODULE;
 410
 411         if (!reset)
 412                 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
 413
 414         if (hci_register_dev(hdev) < 0) {
 415                 BT_ERR("Can't register HCI device");
 416                 hci_free_dev(hdev);
 417                 return -ENODEV;
 418         }
 419
 420         return 0;
 421 }
 422
 423 static int hci_uart_set_proto(struct hci_uart *hu, int id)
 424 {
 425         struct hci_uart_proto *p;
 426         int err;
 427
 428         p = hci_uart_get_proto(id);
 429         if (!p)
 430                 return -EPROTONOSUPPORT;
 431
 432         err = p->open(hu);
 433         if (err)
 434                 return err;
 435
 436         hu->proto = p;
 437
 438         err = hci_uart_register_dev(hu);
 439         if (err) {
 440                 p->close(hu);
 441                 return err;
 442         }
 443
 444         return 0;
 445 }
 446
 447 /* hci_uart_tty_ioctl()
 448  *
 449  *    Process IOCTL system call for the tty device.
 450  *
 451  * Arguments:
 452  *
 453  *    tty        pointer to tty instance data
 454  *    file       pointer to open file object for device
 455  *    cmd        IOCTL command code
 456  *    arg        argument for IOCTL call (cmd dependent)
 457  *
 458  * Return Value:    Command dependent
 459  */
 460 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
 461                                         unsigned int cmd, unsigned long arg)
 462 {
 463         struct hci_uart *hu = (void *)tty->disc_data;
 464         int err = 0;
 465
 466         BT_DBG("");
 467
 468         /* Verify the status of the device */
 469         if (!hu)
 470                 return -EBADF;
 471
 472         switch (cmd) {
 473         case HCIUARTSETPROTO:
 474                 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
 475                         err = hci_uart_set_proto(hu, arg);
 476                         if (err) {
 477                                 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
 478                                 return err;
 479                         }
 480                 } else
 481                         return -EBUSY;
 482                 break;
 483
 484         case HCIUARTGETPROTO:
 485                 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
 486                         return hu->proto->id;
 487                 return -EUNATCH;
 488
 489         case HCIUARTGETDEVICE:
 490                 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
 491                         return hu->hdev->id;
 492                 return -EUNATCH;
 493
 494         default:
 495                 err = n_tty_ioctl_helper(tty, file, cmd, arg);
 496                 break;
 497         };
 498
 499         return err;
 500 }
 501
 502 /*
 503  * We don't provide read/write/poll interface for user space.
 504  */
 505 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
 506                                         unsigned char __user *buf, size_t nr)
 507 {
 508         return 0;
 509 }
 510
 511 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
 512                                         const unsigned char *data, size_t count)
 513 {
 514         return 0;
 515 }
 516
 517 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
 518                                         struct file *filp, poll_table *wait)
 519 {
 520         return 0;
 521 }
 522
 523 static int __init hci_uart_init(void)
 524 {
 525         static struct tty_ldisc_ops hci_uart_ldisc;
 526         int err;
 527
 528         BT_INFO("HCI UART driver ver %s", VERSION);
 529
 530         /* Register the tty discipline */
 531
 532         memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
 533         hci_uart_ldisc.magic            = TTY_LDISC_MAGIC;
 534         hci_uart_ldisc.name             = "n_hci";
 535         hci_uart_ldisc.open             = hci_uart_tty_open;
 536         hci_uart_ldisc.close            = hci_uart_tty_close;
 537         hci_uart_ldisc.read             = hci_uart_tty_read;
 538         hci_uart_ldisc.write            = hci_uart_tty_write;
 539         hci_uart_ldisc.ioctl            = hci_uart_tty_ioctl;
 540         hci_uart_ldisc.poll             = hci_uart_tty_poll;
 541         hci_uart_ldisc.receive_buf      = hci_uart_tty_receive;
 542         hci_uart_ldisc.write_wakeup     = hci_uart_tty_wakeup;
 543         hci_uart_ldisc.owner            = THIS_MODULE;
 544
 545         if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
 546                 BT_ERR("HCI line discipline registration failed. (%d)", err);
 547                 return err;
 548         }
 549
 550 #ifdef CONFIG_BT_HCIUART_H4
 551         h4_init();
 552 #endif
 553 #ifdef CONFIG_BT_HCIUART_BCSP
 554         bcsp_init();
 555 #endif
 556 #ifdef CONFIG_BT_HCIUART_LL
 557         ll_init();
 558 #endif
 559
 560         return 0;
 561 }
 562
 563 static void __exit hci_uart_exit(void)
 564 {
 565         int err;
 566
 567 #ifdef CONFIG_BT_HCIUART_H4
 568         h4_deinit();
 569 #endif
 570 #ifdef CONFIG_BT_HCIUART_BCSP
 571         bcsp_deinit();
 572 #endif
 573 #ifdef CONFIG_BT_HCIUART_LL
 574         ll_deinit();
 575 #endif
 576
 577         /* Release tty registration of line discipline */
 578         if ((err = tty_unregister_ldisc(N_HCI)))
 579                 BT_ERR("Can't unregister HCI line discipline (%d)", err);
 580 }
 581
 582 module_init(hci_uart_init);
 583 module_exit(hci_uart_exit);
 584
 585 module_param(reset, bool, 0644);
 586 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
 587
 588 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
 589 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
 590 MODULE_VERSION(VERSION);
 591 MODULE_LICENSE("GPL");
 592 MODULE_ALIAS_LDISC(N_HCI);