net/irda/irda_device.c

   1 /*********************************************************************
   2  *
   3  * Filename:      irda_device.c
   4  * Version:       0.9
   5  * Description:   Utility functions used by the device drivers
   6  * Status:        Experimental.
   7  * Author:        Dag Brattli <dagb@cs.uit.no>
   8  * Created at:    Sat Oct  9 09:22:27 1999
   9  * Modified at:   Sun Jan 23 17:41:24 2000
  10  * Modified by:   Dag Brattli <dagb@cs.uit.no>
  11  *
  12  *     Copyright (c) 1999-2000 Dag Brattli, All Rights Reserved.
  13  *     Copyright (c) 2000-2001 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/config.h>
  33 #include <linux/string.h>
  34 #include <linux/proc_fs.h>
  35 #include <linux/skbuff.h>
  36 #include <linux/if.h>
  37 #include <linux/if_ether.h>
  38 #include <linux/if_arp.h>
  39 #include <linux/netdevice.h>
  40 #include <linux/init.h>
  41 #include <linux/tty.h>
  42 #include <linux/kmod.h>
  43 #include <linux/spinlock.h>
  44
  45 #include <asm/ioctls.h>
  46 #include <asm/uaccess.h>
  47 #include <asm/dma.h>
  48 #include <asm/io.h>
  49
  50 #include <net/irda/irda_device.h>
  51 #include <net/irda/irlap.h>
  52 #include <net/irda/timer.h>
  53 #include <net/irda/wrapper.h>
  54
  55 static void __irda_task_delete(struct irda_task *task);
  56
  57 static hashbin_t *dongles = NULL;
  58 static hashbin_t *tasks = NULL;
  59
  60 #ifdef CONFIG_IRDA_DEBUG
  61 static const char *task_state[] = {
  62         "IRDA_TASK_INIT",
  63         "IRDA_TASK_DONE",
  64         "IRDA_TASK_WAIT",
  65         "IRDA_TASK_WAIT1",
  66         "IRDA_TASK_WAIT2",
  67         "IRDA_TASK_WAIT3",
  68         "IRDA_TASK_CHILD_INIT",
  69         "IRDA_TASK_CHILD_WAIT",
  70         "IRDA_TASK_CHILD_DONE",
  71 };
  72 #endif  /* CONFIG_IRDA_DEBUG */
  73
  74 static void irda_task_timer_expired(void *data);
  75
  76 int __init irda_device_init( void)
  77 {
  78         dongles = hashbin_new(HB_NOLOCK);
  79         if (dongles == NULL) {
  80                 printk(KERN_WARNING "IrDA: Can't allocate dongles hashbin!\n");
  81                 return -ENOMEM;
  82         }
  83         spin_lock_init(&dongles->hb_spinlock);
  84
  85         tasks = hashbin_new(HB_LOCK);
  86         if (tasks == NULL) {
  87                 printk(KERN_WARNING "IrDA: Can't allocate tasks hashbin!\n");
  88                 hashbin_delete(dongles, NULL);
  89                 return -ENOMEM;
  90         }
  91
  92         /* We no longer initialise the driver ourselves here, we let
  93          * the system do it for us... - Jean II */
  94
  95         return 0;
  96 }
  97
  98 static void __exit leftover_dongle(void *arg)
  99 {
 100         struct dongle_reg *reg = arg;
 101         printk(KERN_WARNING "IrDA: Dongle type %x not unregistered\n",
 102                reg->type);
 103 }
 104
 105 void __exit irda_device_cleanup(void)
 106 {
 107         IRDA_DEBUG(4, "%s()\n", __FUNCTION__);
 108
 109         hashbin_delete(tasks, (FREE_FUNC) __irda_task_delete);
 110
 111         hashbin_delete(dongles, leftover_dongle);
 112 }
 113
 114 /*
 115  * Function irda_device_set_media_busy (self, status)
 116  *
 117  *    Called when we have detected that another station is transmitting
 118  *    in contention mode.
 119  */
 120 void irda_device_set_media_busy(struct net_device *dev, int status)
 121 {
 122         struct irlap_cb *self;
 123
 124         IRDA_DEBUG(4, "%s(%s)\n", __FUNCTION__, status ? "TRUE" : "FALSE");
 125
 126         self = (struct irlap_cb *) dev->atalk_ptr;
 127
 128         ASSERT(self != NULL, return;);
 129         ASSERT(self->magic == LAP_MAGIC, return;);
 130
 131         if (status) {
 132                 self->media_busy = TRUE;
 133                 if (status == SMALL)
 134                         irlap_start_mbusy_timer(self, SMALLBUSY_TIMEOUT);
 135                 else
 136                         irlap_start_mbusy_timer(self, MEDIABUSY_TIMEOUT);
 137                 IRDA_DEBUG( 4, "Media busy!\n");
 138         } else {
 139                 self->media_busy = FALSE;
 140                 irlap_stop_mbusy_timer(self);
 141         }
 142 }
 143 EXPORT_SYMBOL(irda_device_set_media_busy);
 144
 145
 146 /*
 147  * Function irda_device_is_receiving (dev)
 148  *
 149  *    Check if the device driver is currently receiving data
 150  *
 151  */
 152 int irda_device_is_receiving(struct net_device *dev)
 153 {
 154         struct if_irda_req req;
 155         int ret;
 156
 157         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 158
 159         if (!dev->do_ioctl) {
 160                 ERROR("%s: do_ioctl not impl. by device driver\n",
 161                                 __FUNCTION__);
 162                 return -1;
 163         }
 164
 165         ret = dev->do_ioctl(dev, (struct ifreq *) &req, SIOCGRECEIVING);
 166         if (ret < 0)
 167                 return ret;
 168
 169         return req.ifr_receiving;
 170 }
 171
 172 void irda_task_next_state(struct irda_task *task, IRDA_TASK_STATE state)
 173 {
 174         IRDA_DEBUG(2, "%s(), state = %s\n", __FUNCTION__, task_state[state]);
 175
 176         task->state = state;
 177 }
 178 EXPORT_SYMBOL(irda_task_next_state);
 179
 180 static void __irda_task_delete(struct irda_task *task)
 181 {
 182         del_timer(&task->timer);
 183
 184         kfree(task);
 185 }
 186
 187 void irda_task_delete(struct irda_task *task)
 188 {
 189         /* Unregister task */
 190         hashbin_remove(tasks, (long) task, NULL);
 191
 192         __irda_task_delete(task);
 193 }
 194 EXPORT_SYMBOL(irda_task_delete);
 195
 196 /*
 197  * Function irda_task_kick (task)
 198  *
 199  *    Tries to execute a task possible multiple times until the task is either
 200  *    finished, or askes for a timeout. When a task is finished, we do post
 201  *    processing, and notify the parent task, that is waiting for this task
 202  *    to complete.
 203  */
 204 static int irda_task_kick(struct irda_task *task)
 205 {
 206         int finished = TRUE;
 207         int count = 0;
 208         int timeout;
 209
 210         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 211
 212         ASSERT(task != NULL, return -1;);
 213         ASSERT(task->magic == IRDA_TASK_MAGIC, return -1;);
 214
 215         /* Execute task until it's finished, or askes for a timeout */
 216         do {
 217                 timeout = task->function(task);
 218                 if (count++ > 100) {
 219                         ERROR("%s: error in task handler!\n", __FUNCTION__);
 220                         irda_task_delete(task);
 221                         return TRUE;
 222                 }
 223         } while ((timeout == 0) && (task->state != IRDA_TASK_DONE));
 224
 225         if (timeout < 0) {
 226                 ERROR("%s: Error executing task!\n", __FUNCTION__);
 227                 irda_task_delete(task);
 228                 return TRUE;
 229         }
 230
 231         /* Check if we are finished */
 232         if (task->state == IRDA_TASK_DONE) {
 233                 del_timer(&task->timer);
 234
 235                 /* Do post processing */
 236                 if (task->finished)
 237                         task->finished(task);
 238
 239                 /* Notify parent */
 240                 if (task->parent) {
 241                         /* Check if parent is waiting for us to complete */
 242                         if (task->parent->state == IRDA_TASK_CHILD_WAIT) {
 243                                 task->parent->state = IRDA_TASK_CHILD_DONE;
 244
 245                                 /* Stop timer now that we are here */
 246                                 del_timer(&task->parent->timer);
 247
 248                                 /* Kick parent task */
 249                                 irda_task_kick(task->parent);
 250                         }
 251                 }
 252                 irda_task_delete(task);
 253         } else if (timeout > 0) {
 254                 irda_start_timer(&task->timer, timeout, (void *) task,
 255                                  irda_task_timer_expired);
 256                 finished = FALSE;
 257         } else {
 258                 IRDA_DEBUG(0, "%s(), not finished, and no timeout!\n",
 259                            __FUNCTION__);
 260                 finished = FALSE;
 261         }
 262
 263         return finished;
 264 }
 265
 266 /*
 267  * Function irda_task_execute (instance, function, finished)
 268  *
 269  *    This function registers and tries to execute tasks that may take some
 270  *    time to complete. We do it this hairy way since we may have been
 271  *    called from interrupt context, so it's not possible to use
 272  *    schedule_timeout()
 273  * Two important notes :
 274  *      o Make sure you irda_task_delete(task); in case you delete the
 275  *        calling instance.
 276  *      o No real need to lock when calling this function, but you may
 277  *        want to lock within the task handler.
 278  * Jean II
 279  */
 280 struct irda_task *irda_task_execute(void *instance,
 281                                     IRDA_TASK_CALLBACK function,
 282                                     IRDA_TASK_CALLBACK finished,
 283                                     struct irda_task *parent, void *param)
 284 {
 285         struct irda_task *task;
 286
 287         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 288
 289         task = kmalloc(sizeof(struct irda_task), GFP_ATOMIC);
 290         if (!task)
 291                 return NULL;
 292
 293         task->state    = IRDA_TASK_INIT;
 294         task->instance = instance;
 295         task->function = function;
 296         task->finished = finished;
 297         task->parent   = parent;
 298         task->param    = param;
 299         task->magic    = IRDA_TASK_MAGIC;
 300
 301         init_timer(&task->timer);
 302
 303         /* Register task */
 304         hashbin_insert(tasks, (irda_queue_t *) task, (long) task, NULL);
 305
 306         /* No time to waste, so lets get going! */
 307         return irda_task_kick(task) ? NULL : task;
 308 }
 309 EXPORT_SYMBOL(irda_task_execute);
 310
 311 /*
 312  * Function irda_task_timer_expired (data)
 313  *
 314  *    Task time has expired. We now try to execute task (again), and restart
 315  *    the timer if the task has not finished yet
 316  */
 317 static void irda_task_timer_expired(void *data)
 318 {
 319         struct irda_task *task;
 320
 321         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 322
 323         task = (struct irda_task *) data;
 324
 325         irda_task_kick(task);
 326 }
 327
 328 /*
 329  * Function irda_device_setup (dev)
 330  *
 331  *    This function should be used by low level device drivers in a similar way
 332  *    as ether_setup() is used by normal network device drivers
 333  */
 334 static void irda_device_setup(struct net_device *dev)
 335 {
 336         dev->hard_header_len = 0;
 337         dev->addr_len        = 0;
 338
 339         dev->type            = ARPHRD_IRDA;
 340         dev->tx_queue_len    = 8; /* Window size + 1 s-frame */
 341
 342         memset(dev->broadcast, 0xff, 4);
 343
 344         dev->mtu = 2048;
 345         dev->flags = IFF_NOARP;
 346 }
 347
 348 /*
 349  * Funciton  alloc_irdadev
 350  *      Allocates and sets up an IRDA device in a manner similar to
 351  *      alloc_etherdev.
 352  */
 353 struct net_device *alloc_irdadev(int sizeof_priv)
 354 {
 355         return alloc_netdev(sizeof_priv, "irda%d", irda_device_setup);
 356 }
 357 EXPORT_SYMBOL(alloc_irdadev);
 358
 359 /*
 360  * Function irda_device_init_dongle (self, type, qos)
 361  *
 362  *    Initialize attached dongle.
 363  *
 364  * Important : request_module require us to call this function with
 365  * a process context and irq enabled. - Jean II
 366  */
 367 dongle_t *irda_device_dongle_init(struct net_device *dev, int type)
 368 {
 369         struct dongle_reg *reg;
 370         dongle_t *dongle = NULL;
 371
 372         might_sleep();
 373
 374         spin_lock(&dongles->hb_spinlock);
 375         reg = hashbin_find(dongles, type, NULL);
 376
 377 #ifdef CONFIG_KMOD
 378         /* Try to load the module needed */
 379         if (!reg && capable(CAP_SYS_MODULE)) {
 380                 spin_unlock(&dongles->hb_spinlock);
 381
 382                 request_module("irda-dongle-%d", type);
 383
 384                 spin_lock(&dongles->hb_spinlock);
 385                 reg = hashbin_find(dongles, type, NULL);
 386         }
 387 #endif
 388
 389         if (!reg || !try_module_get(reg->owner) ) {
 390                 ERROR("IrDA: Unable to find requested dongle type %x\n", type);
 391                 goto out;
 392         }
 393
 394         /* Allocate dongle info for this instance */
 395         dongle = kmalloc(sizeof(dongle_t), GFP_KERNEL);
 396         if (!dongle)
 397                 goto out;
 398
 399         memset(dongle, 0, sizeof(dongle_t));
 400
 401         /* Bind the registration info to this particular instance */
 402         dongle->issue = reg;
 403         dongle->dev = dev;
 404
 405  out:
 406         spin_unlock(&dongles->hb_spinlock);
 407         return dongle;
 408 }
 409 EXPORT_SYMBOL(irda_device_dongle_init);
 410
 411 /*
 412  * Function irda_device_dongle_cleanup (dongle)
 413  */
 414 int irda_device_dongle_cleanup(dongle_t *dongle)
 415 {
 416         ASSERT(dongle != NULL, return -1;);
 417
 418         dongle->issue->close(dongle);
 419         module_put(dongle->issue->owner);
 420         kfree(dongle);
 421
 422         return 0;
 423 }
 424 EXPORT_SYMBOL(irda_device_dongle_cleanup);
 425
 426 /*
 427  * Function irda_device_register_dongle (dongle)
 428  */
 429 int irda_device_register_dongle(struct dongle_reg *new)
 430 {
 431         spin_lock(&dongles->hb_spinlock);
 432         /* Check if this dongle has been registered before */
 433         if (hashbin_find(dongles, new->type, NULL)) {
 434                 MESSAGE("%s: Dongle type %x already registered\n",
 435                         __FUNCTION__, new->type);
 436         } else {
 437                 /* Insert IrDA dongle into hashbin */
 438                 hashbin_insert(dongles, (irda_queue_t *) new, new->type, NULL);
 439         }
 440         spin_unlock(&dongles->hb_spinlock);
 441
 442         return 0;
 443 }
 444 EXPORT_SYMBOL(irda_device_register_dongle);
 445
 446 /*
 447  * Function irda_device_unregister_dongle (dongle)
 448  *
 449  *    Unregister dongle, and remove dongle from list of registered dongles
 450  *
 451  */
 452 void irda_device_unregister_dongle(struct dongle_reg *dongle)
 453 {
 454         struct dongle *node;
 455
 456         spin_lock(&dongles->hb_spinlock);
 457         node = hashbin_remove(dongles, dongle->type, NULL);
 458         if (!node)
 459                 ERROR("%s: dongle not found!\n", __FUNCTION__);
 460         spin_unlock(&dongles->hb_spinlock);
 461 }
 462 EXPORT_SYMBOL(irda_device_unregister_dongle);
 463
 464 #ifdef CONFIG_ISA
 465 /*
 466  * Function setup_dma (idev, buffer, count, mode)
 467  *
 468  *    Setup the DMA channel. Commonly used by ISA FIR drivers
 469  *
 470  */
 471 void irda_setup_dma(int channel, dma_addr_t buffer, int count, int mode)
 472 {
 473         unsigned long flags;
 474
 475         flags = claim_dma_lock();
 476
 477         disable_dma(channel);
 478         clear_dma_ff(channel);
 479         set_dma_mode(channel, mode);
 480         set_dma_addr(channel, buffer);
 481         set_dma_count(channel, count);
 482         enable_dma(channel);
 483
 484         release_dma_lock(flags);
 485 }
 486 EXPORT_SYMBOL(irda_setup_dma);
 487 #endif