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