net/irda/ircomm/ircomm_core.c

   1 /*********************************************************************
   2  *
   3  * Filename:      ircomm_core.c
   4  * Version:       1.0
   5  * Description:   IrCOMM service interface
   6  * Status:        Experimental.
   7  * Author:        Dag Brattli <dagb@cs.uit.no>
   8  * Created at:    Sun Jun  6 20:37:34 1999
   9  * Modified at:   Tue Dec 21 13:26:41 1999
  10  * Modified by:   Dag Brattli <dagb@cs.uit.no>
  11  *
  12  *     Copyright (c) 1999 Dag Brattli, All Rights Reserved.
  13  *     Copyright (c) 2000-2003 Jean Tourrilhes <jt@hpl.hp.com>
  14  *
  15  *     This program is free software; you can redistribute it and/or
  16  *     modify it under the terms of the GNU General Public License as
  17  *     published by the Free Software Foundation; either version 2 of
  18  *     the License, or (at your option) any later version.
  19  *
  20  *     This program is distributed in the hope that it will be useful,
  21  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23  *     GNU General Public License for more details.
  24  *
  25  *     You should have received a copy of the GNU General Public License
  26  *     along with this program; if not, see <http://www.gnu.org/licenses/>.
  27  *
  28  ********************************************************************/
  29
  30 #include <linux/module.h>
  31 #include <linux/proc_fs.h>
  32 #include <linux/seq_file.h>
  33 #include <linux/init.h>
  34 #include <linux/slab.h>
  35
  36 #include <net/irda/irda.h>
  37 #include <net/irda/irmod.h>
  38 #include <net/irda/irlmp.h>
  39 #include <net/irda/iriap.h>
  40 #include <net/irda/irttp.h>
  41 #include <net/irda/irias_object.h>
  42
  43 #include <net/irda/ircomm_event.h>
  44 #include <net/irda/ircomm_lmp.h>
  45 #include <net/irda/ircomm_ttp.h>
  46 #include <net/irda/ircomm_param.h>
  47 #include <net/irda/ircomm_core.h>
  48
  49 static int __ircomm_close(struct ircomm_cb *self);
  50 static void ircomm_control_indication(struct ircomm_cb *self,
  51                                       struct sk_buff *skb, int clen);
  52
  53 #ifdef CONFIG_PROC_FS
  54 extern struct proc_dir_entry *proc_irda;
  55 static int ircomm_seq_open(struct inode *, struct file *);
  56
  57 static const struct file_operations ircomm_proc_fops = {
  58         .owner          = THIS_MODULE,
  59         .open           = ircomm_seq_open,
  60         .read           = seq_read,
  61         .llseek         = seq_lseek,
  62         .release        = seq_release,
  63 };
  64 #endif /* CONFIG_PROC_FS */
  65
  66 hashbin_t *ircomm = NULL;
  67
  68 static int __init ircomm_init(void)
  69 {
  70         ircomm = hashbin_new(HB_LOCK);
  71         if (ircomm == NULL) {
  72                 net_err_ratelimited("%s(), can't allocate hashbin!\n",
  73                                     __func__);
  74                 return -ENOMEM;
  75         }
  76
  77 #ifdef CONFIG_PROC_FS
  78         { struct proc_dir_entry *ent;
  79         ent = proc_create("ircomm", 0, proc_irda, &ircomm_proc_fops);
  80         if (!ent) {
  81                 printk(KERN_ERR "ircomm_init: can't create /proc entry!\n");
  82                 return -ENODEV;
  83         }
  84         }
  85 #endif /* CONFIG_PROC_FS */
  86
  87         net_info_ratelimited("IrCOMM protocol (Dag Brattli)\n");
  88
  89         return 0;
  90 }
  91
  92 static void __exit ircomm_cleanup(void)
  93 {
  94         IRDA_DEBUG(2, "%s()\n", __func__ );
  95
  96         hashbin_delete(ircomm, (FREE_FUNC) __ircomm_close);
  97
  98 #ifdef CONFIG_PROC_FS
  99         remove_proc_entry("ircomm", proc_irda);
 100 #endif /* CONFIG_PROC_FS */
 101 }
 102
 103 /*
 104  * Function ircomm_open (client_notify)
 105  *
 106  *    Start a new IrCOMM instance
 107  *
 108  */
 109 struct ircomm_cb *ircomm_open(notify_t *notify, __u8 service_type, int line)
 110 {
 111         struct ircomm_cb *self = NULL;
 112         int ret;
 113
 114         IRDA_DEBUG(2, "%s(), service_type=0x%02x\n", __func__ ,
 115                    service_type);
 116
 117         IRDA_ASSERT(ircomm != NULL, return NULL;);
 118
 119         self = kzalloc(sizeof(struct ircomm_cb), GFP_KERNEL);
 120         if (self == NULL)
 121                 return NULL;
 122
 123         self->notify = *notify;
 124         self->magic = IRCOMM_MAGIC;
 125
 126         /* Check if we should use IrLMP or IrTTP */
 127         if (service_type & IRCOMM_3_WIRE_RAW) {
 128                 self->flow_status = FLOW_START;
 129                 ret = ircomm_open_lsap(self);
 130         } else
 131                 ret = ircomm_open_tsap(self);
 132
 133         if (ret < 0) {
 134                 kfree(self);
 135                 return NULL;
 136         }
 137
 138         self->service_type = service_type;
 139         self->line = line;
 140
 141         hashbin_insert(ircomm, (irda_queue_t *) self, line, NULL);
 142
 143         ircomm_next_state(self, IRCOMM_IDLE);
 144
 145         return self;
 146 }
 147
 148 EXPORT_SYMBOL(ircomm_open);
 149
 150 /*
 151  * Function ircomm_close_instance (self)
 152  *
 153  *    Remove IrCOMM instance
 154  *
 155  */
 156 static int __ircomm_close(struct ircomm_cb *self)
 157 {
 158         IRDA_DEBUG(2, "%s()\n", __func__ );
 159
 160         /* Disconnect link if any */
 161         ircomm_do_event(self, IRCOMM_DISCONNECT_REQUEST, NULL, NULL);
 162
 163         /* Remove TSAP */
 164         if (self->tsap) {
 165                 irttp_close_tsap(self->tsap);
 166                 self->tsap = NULL;
 167         }
 168
 169         /* Remove LSAP */
 170         if (self->lsap) {
 171                 irlmp_close_lsap(self->lsap);
 172                 self->lsap = NULL;
 173         }
 174         self->magic = 0;
 175
 176         kfree(self);
 177
 178         return 0;
 179 }
 180
 181 /*
 182  * Function ircomm_close (self)
 183  *
 184  *    Closes and removes the specified IrCOMM instance
 185  *
 186  */
 187 int ircomm_close(struct ircomm_cb *self)
 188 {
 189         struct ircomm_cb *entry;
 190
 191         IRDA_ASSERT(self != NULL, return -EIO;);
 192         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -EIO;);
 193
 194         IRDA_DEBUG(0, "%s()\n", __func__ );
 195
 196         entry = hashbin_remove(ircomm, self->line, NULL);
 197
 198         IRDA_ASSERT(entry == self, return -1;);
 199
 200         return __ircomm_close(self);
 201 }
 202
 203 EXPORT_SYMBOL(ircomm_close);
 204
 205 /*
 206  * Function ircomm_connect_request (self, service_type)
 207  *
 208  *    Impl. of this function is differ from one of the reference. This
 209  *    function does discovery as well as sending connect request
 210  *
 211  */
 212 int ircomm_connect_request(struct ircomm_cb *self, __u8 dlsap_sel,
 213                            __u32 saddr, __u32 daddr, struct sk_buff *skb,
 214                            __u8 service_type)
 215 {
 216         struct ircomm_info info;
 217         int ret;
 218
 219         IRDA_DEBUG(2 , "%s()\n", __func__ );
 220
 221         IRDA_ASSERT(self != NULL, return -1;);
 222         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -1;);
 223
 224         self->service_type= service_type;
 225
 226         info.dlsap_sel = dlsap_sel;
 227         info.saddr = saddr;
 228         info.daddr = daddr;
 229
 230         ret = ircomm_do_event(self, IRCOMM_CONNECT_REQUEST, skb, &info);
 231
 232         return ret;
 233 }
 234
 235 EXPORT_SYMBOL(ircomm_connect_request);
 236
 237 /*
 238  * Function ircomm_connect_indication (self, qos, skb)
 239  *
 240  *    Notify user layer about the incoming connection
 241  *
 242  */
 243 void ircomm_connect_indication(struct ircomm_cb *self, struct sk_buff *skb,
 244                                struct ircomm_info *info)
 245 {
 246         IRDA_DEBUG(2, "%s()\n", __func__ );
 247
 248         /*
 249          * If there are any data hiding in the control channel, we must
 250          * deliver it first. The side effect is that the control channel
 251          * will be removed from the skb
 252          */
 253         if (self->notify.connect_indication)
 254                 self->notify.connect_indication(self->notify.instance, self,
 255                                                 info->qos, info->max_data_size,
 256                                                 info->max_header_size, skb);
 257         else {
 258                 IRDA_DEBUG(0, "%s(), missing handler\n", __func__ );
 259         }
 260 }
 261
 262 /*
 263  * Function ircomm_connect_response (self, userdata, max_sdu_size)
 264  *
 265  *    User accepts connection
 266  *
 267  */
 268 int ircomm_connect_response(struct ircomm_cb *self, struct sk_buff *userdata)
 269 {
 270         int ret;
 271
 272         IRDA_ASSERT(self != NULL, return -1;);
 273         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -1;);
 274
 275         IRDA_DEBUG(4, "%s()\n", __func__ );
 276
 277         ret = ircomm_do_event(self, IRCOMM_CONNECT_RESPONSE, userdata, NULL);
 278
 279         return ret;
 280 }
 281
 282 EXPORT_SYMBOL(ircomm_connect_response);
 283
 284 /*
 285  * Function connect_confirm (self, skb)
 286  *
 287  *    Notify user layer that the link is now connected
 288  *
 289  */
 290 void ircomm_connect_confirm(struct ircomm_cb *self, struct sk_buff *skb,
 291                             struct ircomm_info *info)
 292 {
 293         IRDA_DEBUG(4, "%s()\n", __func__ );
 294
 295         if (self->notify.connect_confirm )
 296                 self->notify.connect_confirm(self->notify.instance,
 297                                              self, info->qos,
 298                                              info->max_data_size,
 299                                              info->max_header_size, skb);
 300         else {
 301                 IRDA_DEBUG(0, "%s(), missing handler\n", __func__ );
 302         }
 303 }
 304
 305 /*
 306  * Function ircomm_data_request (self, userdata)
 307  *
 308  *    Send IrCOMM data to peer device
 309  *
 310  */
 311 int ircomm_data_request(struct ircomm_cb *self, struct sk_buff *skb)
 312 {
 313         int ret;
 314
 315         IRDA_DEBUG(4, "%s()\n", __func__ );
 316
 317         IRDA_ASSERT(self != NULL, return -EFAULT;);
 318         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -EFAULT;);
 319         IRDA_ASSERT(skb != NULL, return -EFAULT;);
 320
 321         ret = ircomm_do_event(self, IRCOMM_DATA_REQUEST, skb, NULL);
 322
 323         return ret;
 324 }
 325
 326 EXPORT_SYMBOL(ircomm_data_request);
 327
 328 /*
 329  * Function ircomm_data_indication (self, skb)
 330  *
 331  *    Data arrived, so deliver it to user
 332  *
 333  */
 334 void ircomm_data_indication(struct ircomm_cb *self, struct sk_buff *skb)
 335 {
 336         IRDA_DEBUG(4, "%s()\n", __func__ );
 337
 338         IRDA_ASSERT(skb->len > 0, return;);
 339
 340         if (self->notify.data_indication)
 341                 self->notify.data_indication(self->notify.instance, self, skb);
 342         else {
 343                 IRDA_DEBUG(0, "%s(), missing handler\n", __func__ );
 344         }
 345 }
 346
 347 /*
 348  * Function ircomm_process_data (self, skb)
 349  *
 350  *    Data arrived which may contain control channel data
 351  *
 352  */
 353 void ircomm_process_data(struct ircomm_cb *self, struct sk_buff *skb)
 354 {
 355         int clen;
 356
 357         IRDA_ASSERT(skb->len > 0, return;);
 358
 359         clen = skb->data[0];
 360
 361         /*
 362          * Input validation check: a stir4200/mcp2150 combinations sometimes
 363          * results in frames with clen > remaining packet size. These are
 364          * illegal; if we throw away just this frame then it seems to carry on
 365          * fine
 366          */
 367         if (unlikely(skb->len < (clen + 1))) {
 368                 IRDA_DEBUG(2, "%s() throwing away illegal frame\n",
 369                            __func__ );
 370                 return;
 371         }
 372
 373         /*
 374          * If there are any data hiding in the control channel, we must
 375          * deliver it first. The side effect is that the control channel
 376          * will be removed from the skb
 377          */
 378         if (clen > 0)
 379                 ircomm_control_indication(self, skb, clen);
 380
 381         /* Remove control channel from data channel */
 382         skb_pull(skb, clen+1);
 383
 384         if (skb->len)
 385                 ircomm_data_indication(self, skb);
 386         else {
 387                 IRDA_DEBUG(4, "%s(), data was control info only!\n",
 388                            __func__ );
 389         }
 390 }
 391
 392 /*
 393  * Function ircomm_control_request (self, params)
 394  *
 395  *    Send control data to peer device
 396  *
 397  */
 398 int ircomm_control_request(struct ircomm_cb *self, struct sk_buff *skb)
 399 {
 400         int ret;
 401
 402         IRDA_DEBUG(2, "%s()\n", __func__ );
 403
 404         IRDA_ASSERT(self != NULL, return -EFAULT;);
 405         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -EFAULT;);
 406         IRDA_ASSERT(skb != NULL, return -EFAULT;);
 407
 408         ret = ircomm_do_event(self, IRCOMM_CONTROL_REQUEST, skb, NULL);
 409
 410         return ret;
 411 }
 412
 413 EXPORT_SYMBOL(ircomm_control_request);
 414
 415 /*
 416  * Function ircomm_control_indication (self, skb)
 417  *
 418  *    Data has arrived on the control channel
 419  *
 420  */
 421 static void ircomm_control_indication(struct ircomm_cb *self,
 422                                       struct sk_buff *skb, int clen)
 423 {
 424         IRDA_DEBUG(2, "%s()\n", __func__ );
 425
 426         /* Use udata for delivering data on the control channel */
 427         if (self->notify.udata_indication) {
 428                 struct sk_buff *ctrl_skb;
 429
 430                 /* We don't own the skb, so clone it */
 431                 ctrl_skb = skb_clone(skb, GFP_ATOMIC);
 432                 if (!ctrl_skb)
 433                         return;
 434
 435                 /* Remove data channel from control channel */
 436                 skb_trim(ctrl_skb, clen+1);
 437
 438                 self->notify.udata_indication(self->notify.instance, self,
 439                                               ctrl_skb);
 440
 441                 /* Drop reference count -
 442                  * see ircomm_tty_control_indication(). */
 443                 dev_kfree_skb(ctrl_skb);
 444         } else {
 445                 IRDA_DEBUG(0, "%s(), missing handler\n", __func__ );
 446         }
 447 }
 448
 449 /*
 450  * Function ircomm_disconnect_request (self, userdata, priority)
 451  *
 452  *    User layer wants to disconnect the IrCOMM connection
 453  *
 454  */
 455 int ircomm_disconnect_request(struct ircomm_cb *self, struct sk_buff *userdata)
 456 {
 457         struct ircomm_info info;
 458         int ret;
 459
 460         IRDA_DEBUG(2, "%s()\n", __func__ );
 461
 462         IRDA_ASSERT(self != NULL, return -1;);
 463         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -1;);
 464
 465         ret = ircomm_do_event(self, IRCOMM_DISCONNECT_REQUEST, userdata,
 466                               &info);
 467         return ret;
 468 }
 469
 470 EXPORT_SYMBOL(ircomm_disconnect_request);
 471
 472 /*
 473  * Function disconnect_indication (self, skb)
 474  *
 475  *    Tell user that the link has been disconnected
 476  *
 477  */
 478 void ircomm_disconnect_indication(struct ircomm_cb *self, struct sk_buff *skb,
 479                                   struct ircomm_info *info)
 480 {
 481         IRDA_DEBUG(2, "%s()\n", __func__ );
 482
 483         IRDA_ASSERT(info != NULL, return;);
 484
 485         if (self->notify.disconnect_indication) {
 486                 self->notify.disconnect_indication(self->notify.instance, self,
 487                                                    info->reason, skb);
 488         } else {
 489                 IRDA_DEBUG(0, "%s(), missing handler\n", __func__ );
 490         }
 491 }
 492
 493 /*
 494  * Function ircomm_flow_request (self, flow)
 495  *
 496  *
 497  *
 498  */
 499 void ircomm_flow_request(struct ircomm_cb *self, LOCAL_FLOW flow)
 500 {
 501         IRDA_DEBUG(2, "%s()\n", __func__ );
 502
 503         IRDA_ASSERT(self != NULL, return;);
 504         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return;);
 505
 506         if (self->service_type == IRCOMM_3_WIRE_RAW)
 507                 return;
 508
 509         irttp_flow_request(self->tsap, flow);
 510 }
 511
 512 EXPORT_SYMBOL(ircomm_flow_request);
 513
 514 #ifdef CONFIG_PROC_FS
 515 static void *ircomm_seq_start(struct seq_file *seq, loff_t *pos)
 516 {
 517         struct ircomm_cb *self;
 518         loff_t off = 0;
 519
 520         spin_lock_irq(&ircomm->hb_spinlock);
 521
 522         for (self = (struct ircomm_cb *) hashbin_get_first(ircomm);
 523              self != NULL;
 524              self = (struct ircomm_cb *) hashbin_get_next(ircomm)) {
 525                 if (off++ == *pos)
 526                         break;
 527
 528         }
 529         return self;
 530 }
 531
 532 static void *ircomm_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 533 {
 534         ++*pos;
 535
 536         return (void *) hashbin_get_next(ircomm);
 537 }
 538
 539 static void ircomm_seq_stop(struct seq_file *seq, void *v)
 540 {
 541         spin_unlock_irq(&ircomm->hb_spinlock);
 542 }
 543
 544 static int ircomm_seq_show(struct seq_file *seq, void *v)
 545 {
 546         const struct ircomm_cb *self = v;
 547
 548         IRDA_ASSERT(self->magic == IRCOMM_MAGIC, return -EINVAL; );
 549
 550         if(self->line < 0x10)
 551                 seq_printf(seq, "ircomm%d", self->line);
 552         else
 553                 seq_printf(seq, "irlpt%d", self->line - 0x10);
 554
 555         seq_printf(seq,
 556                    " state: %s, slsap_sel: %#02x, dlsap_sel: %#02x, mode:",
 557                    ircomm_state[ self->state],
 558                    self->slsap_sel, self->dlsap_sel);
 559
 560         if(self->service_type & IRCOMM_3_WIRE_RAW)
 561                 seq_printf(seq, " 3-wire-raw");
 562         if(self->service_type & IRCOMM_3_WIRE)
 563                 seq_printf(seq, " 3-wire");
 564         if(self->service_type & IRCOMM_9_WIRE)
 565                 seq_printf(seq, " 9-wire");
 566         if(self->service_type & IRCOMM_CENTRONICS)
 567                 seq_printf(seq, " Centronics");
 568         seq_putc(seq, '\n');
 569
 570         return 0;
 571 }
 572
 573 static const struct seq_operations ircomm_seq_ops = {
 574         .start  = ircomm_seq_start,
 575         .next   = ircomm_seq_next,
 576         .stop   = ircomm_seq_stop,
 577         .show   = ircomm_seq_show,
 578 };
 579
 580 static int ircomm_seq_open(struct inode *inode, struct file *file)
 581 {
 582         return seq_open(file, &ircomm_seq_ops);
 583 }
 584 #endif /* CONFIG_PROC_FS */
 585
 586 MODULE_AUTHOR("Dag Brattli <dag@brattli.net>");
 587 MODULE_DESCRIPTION("IrCOMM protocol");
 588 MODULE_LICENSE("GPL");
 589
 590 module_init(ircomm_init);
 591 module_exit(ircomm_cleanup);