ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / net / irda / irnet / irnet_ppp.c
1 /*
2  *      IrNET protocol module : Synchronous PPP over an IrDA socket.
3  *
4  *              Jean II - HPL `00 - <jt@hpl.hp.com>
5  *
6  * This file implement the PPP interface and /dev/irnet character device.
7  * The PPP interface hook to the ppp_generic module, handle all our
8  *      relationship to the PPP code in the kernel (and by extension to pppd),
9  *      and exchange PPP frames with this module (send/receive).
10  * The /dev/irnet device is used primarily for 2 functions :
11  *      1) as a stub for pppd (the ppp daemon), so that we can appropriately
12  *      generate PPP sessions (we pretend we are a tty).
13  *      2) as a control channel (write commands, read events)
14  */
15
16 #include "irnet_ppp.h"          /* Private header */
17 /* Please put other headers in irnet.h - Thanks */
18
19 /************************* CONTROL CHANNEL *************************/
20 /*
21  * When a pppd instance is not active on /dev/irnet, it acts as a control
22  * channel.
23  * Writing allow to set up the IrDA destination of the IrNET channel,
24  * and any application may be read events happening in IrNET...
25  */
26
27 /*------------------------------------------------------------------*/
28 /*
29  * Write is used to send a command to configure a IrNET channel
30  * before it is open by pppd. The syntax is : "command argument"
31  * Currently there is only two defined commands :
32  *      o name : set the requested IrDA nickname of the IrNET peer.
33  *      o addr : set the requested IrDA address of the IrNET peer.
34  * Note : the code is crude, but effective...
35  */
36 static inline ssize_t
37 irnet_ctrl_write(irnet_socket * ap,
38                  const char *   buf,
39                  size_t         count)
40 {
41   char          command[IRNET_MAX_COMMAND];
42   char *        start;          /* Current command being processed */
43   char *        next;           /* Next command to process */
44   int           length;         /* Length of current command */
45
46   DENTER(CTRL_TRACE, "(ap=0x%p, count=%Zd)\n", ap, count);
47
48   /* Check for overflow... */
49   DABORT(count >= IRNET_MAX_COMMAND, -ENOMEM,
50          CTRL_ERROR, "Too much data !!!\n");
51
52   /* Get the data in the driver */
53   if(copy_from_user(command, buf, count))
54     {
55       DERROR(CTRL_ERROR, "Invalid user space pointer.\n");
56       return -EFAULT;
57     }
58
59   /* Safe terminate the string */
60   command[count] = '\0';
61   DEBUG(CTRL_INFO, "Command line received is ``%s'' (%Zd).\n",
62         command, count);
63
64   /* Check every commands in the command line */
65   next = command;
66   while(next != NULL)
67     {
68       /* Look at the next command */
69       start = next;
70
71       /* Scrap whitespaces before the command */
72       while(isspace(*start))
73         start++;
74
75       /* ',' is our command separator */
76       next = strchr(start, ',');
77       if(next)
78         {
79           *next = '\0';                 /* Terminate command */
80           length = next - start;        /* Length */
81           next++;                       /* Skip the '\0' */
82         }
83       else
84         length = strlen(start);
85
86       DEBUG(CTRL_INFO, "Found command ``%s'' (%d).\n", start, length);
87
88       /* Check if we recognised one of the known command
89        * We can't use "switch" with strings, so hack with "continue" */
90       
91       /* First command : name -> Requested IrDA nickname */
92       if(!strncmp(start, "name", 4))
93         {
94           /* Copy the name only if is included and not "any" */
95           if((length > 5) && (strcmp(start + 5, "any")))
96             {
97               /* Strip out trailing whitespaces */
98               while(isspace(start[length - 1]))
99                 length--;
100
101               /* Copy the name for later reuse */
102               memcpy(ap->rname, start + 5, length - 5);
103               ap->rname[length - 5] = '\0';
104             }
105           else
106             ap->rname[0] = '\0';
107           DEBUG(CTRL_INFO, "Got rname = ``%s''\n", ap->rname);
108
109           /* Restart the loop */
110           continue;
111         }
112
113       /* Second command : addr, daddr -> Requested IrDA destination address
114        * Also process : saddr -> Requested IrDA source address */
115       if((!strncmp(start, "addr", 4)) ||
116          (!strncmp(start, "daddr", 5)) ||
117          (!strncmp(start, "saddr", 5)))
118         {
119           __u32         addr = DEV_ADDR_ANY;
120
121           /* Copy the address only if is included and not "any" */
122           if((length > 5) && (strcmp(start + 5, "any")))
123             {
124               char *    begp = start + 5;
125               char *    endp;
126
127               /* Scrap whitespaces before the command */
128               while(isspace(*begp))
129                 begp++;
130
131               /* Convert argument to a number (last arg is the base) */
132               addr = simple_strtoul(begp, &endp, 16);
133               /* Has it worked  ? (endp should be start + length) */
134               DABORT(endp <= (start + 5), -EINVAL,
135                      CTRL_ERROR, "Invalid address.\n");
136             }
137           /* Which type of address ? */
138           if(start[0] == 's')
139             {
140               /* Save it */
141               ap->rsaddr = addr;
142               DEBUG(CTRL_INFO, "Got rsaddr = %08x\n", ap->rsaddr);
143             }
144           else
145             {
146               /* Save it */
147               ap->rdaddr = addr;
148               DEBUG(CTRL_INFO, "Got rdaddr = %08x\n", ap->rdaddr);
149             }
150
151           /* Restart the loop */
152           continue;
153         }
154
155       /* Other possible command : connect N (number of retries) */
156
157       /* No command matched -> Failed... */
158       DABORT(1, -EINVAL, CTRL_ERROR, "Not a recognised IrNET command.\n");
159     }
160
161   /* Success : we have parsed all commands successfully */
162   return(count);
163 }
164
165 #ifdef INITIAL_DISCOVERY
166 /*------------------------------------------------------------------*/
167 /*
168  * Function irnet_read_discovery_log (self)
169  *
170  *    Read the content on the discovery log
171  *
172  * This function dump the current content of the discovery log
173  * at the startup of the event channel.
174  * Return 1 if written on the control channel...
175  *
176  * State of the ap->disco_XXX variables :
177  *      at socket creation :    disco_index = 0 ; disco_number = 0
178  *      while reading :         disco_index = X ; disco_number = Y
179  *      After reading :         disco_index = Y ; disco_number = -1
180  */
181 static inline int
182 irnet_read_discovery_log(irnet_socket * ap,
183                          char *         event)
184 {
185   int           done_event = 0;
186
187   DENTER(CTRL_TRACE, "(ap=0x%p, event=0x%p)\n",
188          ap, event);
189
190   /* Test if we have some work to do or we have already finished */
191   if(ap->disco_number == -1)
192     {
193       DEBUG(CTRL_INFO, "Already done\n");
194       return 0;
195     }
196
197   /* Test if it's the first time and therefore we need to get the log */
198   if(ap->disco_index == 0)
199     {
200       __u16             mask = irlmp_service_to_hint(S_LAN);
201
202       /* Ask IrLMP for the current discovery log */
203       ap->discoveries = irlmp_get_discoveries(&ap->disco_number, mask,
204                                               DISCOVERY_DEFAULT_SLOTS);
205       /* Check if the we got some results */
206       if(ap->discoveries == NULL)
207         ap->disco_number = -1;
208       DEBUG(CTRL_INFO, "Got the log (0x%p), size is %d\n",
209             ap->discoveries, ap->disco_number);
210     }
211
212   /* Check if we have more item to dump */
213   if(ap->disco_index < ap->disco_number)
214     {
215       /* Write an event */
216       sprintf(event, "Found %08x (%s) behind %08x {hints %02X-%02X}\n",
217               ap->discoveries[ap->disco_index].daddr,
218               ap->discoveries[ap->disco_index].info,
219               ap->discoveries[ap->disco_index].saddr,
220               ap->discoveries[ap->disco_index].hints[0],
221               ap->discoveries[ap->disco_index].hints[1]);
222       DEBUG(CTRL_INFO, "Writing discovery %d : %s\n",
223             ap->disco_index, ap->discoveries[ap->disco_index].info);
224
225       /* We have an event */
226       done_event = 1;
227       /* Next discovery */
228       ap->disco_index++;
229     }
230
231   /* Check if we have done the last item */
232   if(ap->disco_index >= ap->disco_number)
233     {
234       /* No more items : remove the log and signal termination */
235       DEBUG(CTRL_INFO, "Cleaning up log (0x%p)\n",
236             ap->discoveries);
237       if(ap->discoveries != NULL)
238         {
239           /* Cleanup our copy of the discovery log */
240           kfree(ap->discoveries);
241           ap->discoveries = NULL;
242         }
243       ap->disco_number = -1;
244     }
245
246   return done_event;
247 }
248 #endif /* INITIAL_DISCOVERY */
249
250 /*------------------------------------------------------------------*/
251 /*
252  * Read is used to get IrNET events
253  */
254 static inline ssize_t
255 irnet_ctrl_read(irnet_socket *  ap,
256                 struct file *   file,
257                 char *          buf,
258                 size_t          count)
259 {
260   DECLARE_WAITQUEUE(wait, current);
261   char          event[64];      /* Max event is 61 char */
262   ssize_t       ret = 0;
263
264   DENTER(CTRL_TRACE, "(ap=0x%p, count=%Zd)\n", ap, count);
265
266   /* Check if we can write an event out in one go */
267   DABORT(count < sizeof(event), -EOVERFLOW, CTRL_ERROR, "Buffer to small.\n");
268
269 #ifdef INITIAL_DISCOVERY
270   /* Check if we have read the log */
271   if(irnet_read_discovery_log(ap, event))
272     {
273       /* We have an event !!! Copy it to the user */
274       if(copy_to_user(buf, event, strlen(event)))
275         {
276           DERROR(CTRL_ERROR, "Invalid user space pointer.\n");
277           return -EFAULT;
278         }
279
280       DEXIT(CTRL_TRACE, "\n");
281       return(strlen(event));
282     }
283 #endif /* INITIAL_DISCOVERY */
284
285   /* Put ourselves on the wait queue to be woken up */
286   add_wait_queue(&irnet_events.rwait, &wait);
287   current->state = TASK_INTERRUPTIBLE;
288   for(;;)
289     {
290       /* If there is unread events */
291       ret = 0;
292       if(ap->event_index != irnet_events.index)
293         break;
294       ret = -EAGAIN;
295       if(file->f_flags & O_NONBLOCK)
296         break;
297       ret = -ERESTARTSYS;
298       if(signal_pending(current))
299         break;
300       /* Yield and wait to be woken up */
301       schedule();
302     }
303   current->state = TASK_RUNNING;
304   remove_wait_queue(&irnet_events.rwait, &wait);
305
306   /* Did we got it ? */
307   if(ret != 0)
308     {
309       /* No, return the error code */
310       DEXIT(CTRL_TRACE, " - ret %Zd\n", ret);
311       return ret;
312     }
313
314   /* Which event is it ? */
315   switch(irnet_events.log[ap->event_index].event)
316     {
317     case IRNET_DISCOVER:
318       sprintf(event, "Discovered %08x (%s) behind %08x {hints %02X-%02X}\n",
319               irnet_events.log[ap->event_index].daddr,
320               irnet_events.log[ap->event_index].name,
321               irnet_events.log[ap->event_index].saddr,
322               irnet_events.log[ap->event_index].hints.byte[0],
323               irnet_events.log[ap->event_index].hints.byte[1]);
324       break;
325     case IRNET_EXPIRE:
326       sprintf(event, "Expired %08x (%s) behind %08x {hints %02X-%02X}\n",
327               irnet_events.log[ap->event_index].daddr,
328               irnet_events.log[ap->event_index].name,
329               irnet_events.log[ap->event_index].saddr,
330               irnet_events.log[ap->event_index].hints.byte[0],
331               irnet_events.log[ap->event_index].hints.byte[1]);
332       break;
333     case IRNET_CONNECT_TO:
334       sprintf(event, "Connected to %08x (%s) on ppp%d\n",
335               irnet_events.log[ap->event_index].daddr,
336               irnet_events.log[ap->event_index].name,
337               irnet_events.log[ap->event_index].unit);
338       break;
339     case IRNET_CONNECT_FROM:
340       sprintf(event, "Connection from %08x (%s) on ppp%d\n",
341               irnet_events.log[ap->event_index].daddr,
342               irnet_events.log[ap->event_index].name,
343               irnet_events.log[ap->event_index].unit);
344       break;
345     case IRNET_REQUEST_FROM:
346       sprintf(event, "Request from %08x (%s) behind %08x\n",
347               irnet_events.log[ap->event_index].daddr,
348               irnet_events.log[ap->event_index].name,
349               irnet_events.log[ap->event_index].saddr);
350       break;
351     case IRNET_NOANSWER_FROM:
352       sprintf(event, "No-answer from %08x (%s) on ppp%d\n",
353               irnet_events.log[ap->event_index].daddr,
354               irnet_events.log[ap->event_index].name,
355               irnet_events.log[ap->event_index].unit);
356       break;
357     case IRNET_BLOCKED_LINK:
358       sprintf(event, "Blocked link with %08x (%s) on ppp%d\n",
359               irnet_events.log[ap->event_index].daddr,
360               irnet_events.log[ap->event_index].name,
361               irnet_events.log[ap->event_index].unit);
362       break;
363     case IRNET_DISCONNECT_FROM:
364       sprintf(event, "Disconnection from %08x (%s) on ppp%d\n",
365               irnet_events.log[ap->event_index].daddr,
366               irnet_events.log[ap->event_index].name,
367               irnet_events.log[ap->event_index].unit);
368       break;
369     case IRNET_DISCONNECT_TO:
370       sprintf(event, "Disconnected to %08x (%s)\n",
371               irnet_events.log[ap->event_index].daddr,
372               irnet_events.log[ap->event_index].name);
373       break;
374     default:
375       sprintf(event, "Bug\n");
376     }
377   /* Increment our event index */
378   ap->event_index = (ap->event_index + 1) % IRNET_MAX_EVENTS;
379
380   DEBUG(CTRL_INFO, "Event is :%s", event);
381
382   /* Copy it to the user */
383   if(copy_to_user(buf, event, strlen(event)))
384     {
385       DERROR(CTRL_ERROR, "Invalid user space pointer.\n");
386       return -EFAULT;
387     }
388
389   DEXIT(CTRL_TRACE, "\n");
390   return(strlen(event));
391 }
392
393 /*------------------------------------------------------------------*/
394 /*
395  * Poll : called when someone do a select on /dev/irnet.
396  * Just check if there are new events...
397  */
398 static inline unsigned int
399 irnet_ctrl_poll(irnet_socket *  ap,
400                 struct file *   file,
401                 poll_table *    wait)
402 {
403   unsigned int mask;
404
405   DENTER(CTRL_TRACE, "(ap=0x%p)\n", ap);
406
407   poll_wait(file, &irnet_events.rwait, wait);
408   mask = POLLOUT | POLLWRNORM;
409   /* If there is unread events */
410   if(ap->event_index != irnet_events.index)
411     mask |= POLLIN | POLLRDNORM;
412 #ifdef INITIAL_DISCOVERY
413   if(ap->disco_number != -1)
414     mask |= POLLIN | POLLRDNORM;
415 #endif /* INITIAL_DISCOVERY */
416
417   DEXIT(CTRL_TRACE, " - mask=0x%X\n", mask);
418   return mask;
419 }
420
421
422 /*********************** FILESYSTEM CALLBACKS ***********************/
423 /*
424  * Implement the usual open, read, write functions that will be called
425  * by the file system when some action is performed on /dev/irnet.
426  * Most of those actions will in fact be performed by "pppd" or
427  * the control channel, we just act as a redirector...
428  */
429
430 /*------------------------------------------------------------------*/
431 /*
432  * Open : when somebody open /dev/irnet
433  * We basically create a new instance of irnet and initialise it.
434  */
435 static int
436 dev_irnet_open(struct inode *   inode,
437                struct file *    file)
438 {
439   struct irnet_socket * ap;
440   int                   err;
441
442   DENTER(FS_TRACE, "(file=0x%p)\n", file);
443
444 #ifdef SECURE_DEVIRNET
445   /* This could (should?) be enforced by the permissions on /dev/irnet. */
446   if(!capable(CAP_NET_ADMIN))
447     return -EPERM;
448 #endif /* SECURE_DEVIRNET */
449
450   /* Allocate a private structure for this IrNET instance */
451   ap = kmalloc(sizeof(*ap), GFP_KERNEL);
452   DABORT(ap == NULL, -ENOMEM, FS_ERROR, "Can't allocate struct irnet...\n");
453
454   /* initialize the irnet structure */
455   memset(ap, 0, sizeof(*ap));
456   ap->file = file;
457
458   /* PPP channel setup */
459   ap->ppp_open = 0;
460   ap->chan.private = ap;
461   ap->chan.ops = &irnet_ppp_ops;
462   ap->chan.mtu = (2048 - TTP_MAX_HEADER - 2 - PPP_HDRLEN);
463   ap->chan.hdrlen = 2 + TTP_MAX_HEADER;         /* for A/C + Max IrDA hdr */
464   /* PPP parameters */
465   ap->mru = (2048 - TTP_MAX_HEADER - 2 - PPP_HDRLEN);
466   ap->xaccm[0] = ~0U;
467   ap->xaccm[3] = 0x60000000U;
468   ap->raccm = ~0U;
469
470   /* Setup the IrDA part... */
471   err = irda_irnet_create(ap);
472   if(err)
473     {
474       DERROR(FS_ERROR, "Can't setup IrDA link...\n");
475       kfree(ap);
476       return err;
477     }
478
479   /* For the control channel */
480   ap->event_index = irnet_events.index; /* Cancel all past events */
481
482   /* Put our stuff where we will be able to find it later */
483   file->private_data = ap;
484
485   DEXIT(FS_TRACE, " - ap=0x%p\n", ap);
486   return 0;
487 }
488
489
490 /*------------------------------------------------------------------*/
491 /*
492  * Close : when somebody close /dev/irnet
493  * Destroy the instance of /dev/irnet
494  */
495 static int
496 dev_irnet_close(struct inode *  inode,
497                 struct file *   file)
498 {
499   irnet_socket *        ap = (struct irnet_socket *) file->private_data;
500
501   DENTER(FS_TRACE, "(file=0x%p, ap=0x%p)\n",
502          file, ap);
503   DABORT(ap == NULL, 0, FS_ERROR, "ap is NULL !!!\n");
504
505   /* Detach ourselves */
506   file->private_data = NULL;
507
508   /* Close IrDA stuff */
509   irda_irnet_destroy(ap);
510
511   /* Disconnect from the generic PPP layer if not already done */
512   if(ap->ppp_open)
513     {
514       DERROR(FS_ERROR, "Channel still registered - deregistering !\n");
515       ap->ppp_open = 0;
516       ppp_unregister_channel(&ap->chan);
517     }
518
519   kfree(ap);
520
521   DEXIT(FS_TRACE, "\n");
522   return 0;
523 }
524
525 /*------------------------------------------------------------------*/
526 /*
527  * Write does nothing.
528  * (we receive packet from ppp_generic through ppp_irnet_send())
529  */
530 static ssize_t
531 dev_irnet_write(struct file *   file,
532                 const char *    buf,
533                 size_t          count,
534                 loff_t *        ppos)
535 {
536   irnet_socket *        ap = (struct irnet_socket *) file->private_data;
537
538   DPASS(FS_TRACE, "(file=0x%p, ap=0x%p, count=%Zd)\n",
539         file, ap, count);
540   DABORT(ap == NULL, -ENXIO, FS_ERROR, "ap is NULL !!!\n");
541
542   /* If we are connected to ppp_generic, let it handle the job */
543   if(ap->ppp_open)
544     return -EAGAIN;
545   else
546     return irnet_ctrl_write(ap, buf, count);
547 }
548
549 /*------------------------------------------------------------------*/
550 /*
551  * Read doesn't do much either.
552  * (pppd poll us, but ultimately reads through /dev/ppp)
553  */
554 static ssize_t
555 dev_irnet_read(struct file *    file,
556                char *           buf,
557                size_t           count,
558                loff_t *         ppos)
559 {
560   irnet_socket *        ap = (struct irnet_socket *) file->private_data;
561
562   DPASS(FS_TRACE, "(file=0x%p, ap=0x%p, count=%Zd)\n",
563         file, ap, count);
564   DABORT(ap == NULL, -ENXIO, FS_ERROR, "ap is NULL !!!\n");
565
566   /* If we are connected to ppp_generic, let it handle the job */
567   if(ap->ppp_open)
568     return -EAGAIN;
569   else
570     return irnet_ctrl_read(ap, file, buf, count);
571 }
572
573 /*------------------------------------------------------------------*/
574 /*
575  * Poll : called when someone do a select on /dev/irnet
576  */
577 static unsigned int
578 dev_irnet_poll(struct file *    file,
579                poll_table *     wait)
580 {
581   irnet_socket *        ap = (struct irnet_socket *) file->private_data;
582   unsigned int          mask;
583
584   DENTER(FS_TRACE, "(file=0x%p, ap=0x%p)\n",
585          file, ap);
586
587   mask = POLLOUT | POLLWRNORM;
588   DABORT(ap == NULL, mask, FS_ERROR, "ap is NULL !!!\n");
589
590   /* If we are connected to ppp_generic, let it handle the job */
591   if(!ap->ppp_open)
592     mask |= irnet_ctrl_poll(ap, file, wait);
593
594   DEXIT(FS_TRACE, " - mask=0x%X\n", mask);
595   return(mask);
596 }
597
598 /*------------------------------------------------------------------*/
599 /*
600  * IOCtl : Called when someone does some ioctls on /dev/irnet
601  * This is the way pppd configure us and control us while the PPP
602  * instance is active.
603  */
604 static int
605 dev_irnet_ioctl(struct inode *  inode,
606                 struct file *   file,
607                 unsigned int    cmd,
608                 unsigned long   arg)
609 {
610   irnet_socket *        ap = (struct irnet_socket *) file->private_data;
611   int                   err;
612   int                   val;
613
614   DENTER(FS_TRACE, "(file=0x%p, ap=0x%p, cmd=0x%X)\n",
615          file, ap, cmd);
616
617   /* Basic checks... */
618   DASSERT(ap != NULL, -ENXIO, PPP_ERROR, "ap is NULL...\n");
619 #ifdef SECURE_DEVIRNET
620   if(!capable(CAP_NET_ADMIN))
621     return -EPERM;
622 #endif /* SECURE_DEVIRNET */
623
624   err = -EFAULT;
625   switch(cmd)
626     {
627       /* Set discipline (should be N_SYNC_PPP or N_TTY) */
628     case TIOCSETD:
629       if(get_user(val, (int *) arg))
630         break;
631       if((val == N_SYNC_PPP) || (val == N_PPP))
632         {
633           DEBUG(FS_INFO, "Entering PPP discipline.\n");
634           /* PPP channel setup (ap->chan in configued in dev_irnet_open())*/
635           err = ppp_register_channel(&ap->chan);
636           if(err == 0)
637             {
638               /* Our ppp side is active */
639               ap->ppp_open = 1;
640
641               DEBUG(FS_INFO, "Trying to establish a connection.\n");
642               /* Setup the IrDA link now - may fail... */
643               irda_irnet_connect(ap);
644             }
645           else
646             DERROR(FS_ERROR, "Can't setup PPP channel...\n");
647         }
648       else
649         {
650           /* In theory, should be N_TTY */
651           DEBUG(FS_INFO, "Exiting PPP discipline.\n");
652           /* Disconnect from the generic PPP layer */
653           if(ap->ppp_open)
654             {
655               ap->ppp_open = 0;
656               ppp_unregister_channel(&ap->chan);
657             }
658           else
659             DERROR(FS_ERROR, "Channel not registered !\n");
660           err = 0;
661         }
662       break;
663
664       /* Query PPP channel and unit number */
665     case PPPIOCGCHAN:
666       if(!ap->ppp_open)
667         break;
668       if(put_user(ppp_channel_index(&ap->chan), (int *) arg))
669         break;
670       DEBUG(FS_INFO, "Query channel.\n");
671       err = 0;
672       break;
673     case PPPIOCGUNIT:
674       if(!ap->ppp_open)
675         break;
676       if(put_user(ppp_unit_number(&ap->chan), (int *) arg))
677         break;
678       DEBUG(FS_INFO, "Query unit number.\n");
679       err = 0;
680       break;
681
682       /* All these ioctls can be passed both directly and from ppp_generic,
683        * so we just deal with them in one place...
684        */
685     case PPPIOCGFLAGS:
686     case PPPIOCSFLAGS:
687     case PPPIOCGASYNCMAP:
688     case PPPIOCSASYNCMAP:
689     case PPPIOCGRASYNCMAP:
690     case PPPIOCSRASYNCMAP:
691     case PPPIOCGXASYNCMAP:
692     case PPPIOCSXASYNCMAP:
693     case PPPIOCGMRU:
694     case PPPIOCSMRU:
695       DEBUG(FS_INFO, "Standard PPP ioctl.\n");
696       if(!capable(CAP_NET_ADMIN))
697         err = -EPERM;
698       else
699         err = ppp_irnet_ioctl(&ap->chan, cmd, arg);
700       break;
701
702       /* TTY IOCTLs : Pretend that we are a tty, to keep pppd happy */
703       /* Get termios */
704     case TCGETS:
705       DEBUG(FS_INFO, "Get termios.\n");
706       if(kernel_termios_to_user_termios((struct termios *)arg, &ap->termios))
707         break;
708       err = 0;
709       break;
710       /* Set termios */
711     case TCSETSF:
712       DEBUG(FS_INFO, "Set termios.\n");
713       if(user_termios_to_kernel_termios(&ap->termios, (struct termios *) arg))
714         break;
715       err = 0;
716       break;
717
718       /* Set DTR/RTS */
719     case TIOCMBIS: 
720     case TIOCMBIC:
721       /* Set exclusive/non-exclusive mode */
722     case TIOCEXCL:
723     case TIOCNXCL:
724       DEBUG(FS_INFO, "TTY compatibility.\n");
725       err = 0;
726       break;
727
728     case TCGETA:
729       DEBUG(FS_INFO, "TCGETA\n");
730       break;
731
732     case TCFLSH:
733       DEBUG(FS_INFO, "TCFLSH\n");
734       /* Note : this will flush buffers in PPP, so it *must* be done
735        * We should also worry that we don't accept junk here and that
736        * we get rid of our own buffers */
737 #ifdef FLUSH_TO_PPP
738       ppp_output_wakeup(&ap->chan);
739 #endif /* FLUSH_TO_PPP */
740       err = 0;
741       break;
742
743     case FIONREAD:
744       DEBUG(FS_INFO, "FIONREAD\n");
745       val = 0;
746       if(put_user(val, (int *) arg))
747         break;
748       err = 0;
749       break;
750
751     default:
752       DERROR(FS_ERROR, "Unsupported ioctl (0x%X)\n", cmd);
753       err = -ENOIOCTLCMD;
754     }
755
756   DEXIT(FS_TRACE, " - err = 0x%X\n", err);
757   return err;
758 }
759
760 /************************** PPP CALLBACKS **************************/
761 /*
762  * This are the functions that the generic PPP driver in the kernel
763  * will call to communicate to us.
764  */
765
766 /*------------------------------------------------------------------*/
767 /*
768  * Prepare the ppp frame for transmission over the IrDA socket.
769  * We make sure that the header space is enough, and we change ppp header
770  * according to flags passed by pppd.
771  * This is not a callback, but just a helper function used in ppp_irnet_send()
772  */
773 static inline struct sk_buff *
774 irnet_prepare_skb(irnet_socket *        ap,
775                   struct sk_buff *      skb)
776 {
777   unsigned char *       data;
778   int                   proto;          /* PPP protocol */
779   int                   islcp;          /* Protocol == LCP */
780   int                   needaddr;       /* Need PPP address */
781
782   DENTER(PPP_TRACE, "(ap=0x%p, skb=0x%p)\n",
783          ap, skb);
784
785   /* Extract PPP protocol from the frame */
786   data  = skb->data;
787   proto = (data[0] << 8) + data[1];
788
789   /* LCP packets with codes between 1 (configure-request)
790    * and 7 (code-reject) must be sent as though no options
791    * have been negotiated. */
792   islcp = (proto == PPP_LCP) && (1 <= data[2]) && (data[2] <= 7);
793
794   /* compress protocol field if option enabled */
795   if((data[0] == 0) && (ap->flags & SC_COMP_PROT) && (!islcp))
796     skb_pull(skb,1);
797
798   /* Check if we need address/control fields */
799   needaddr = 2*((ap->flags & SC_COMP_AC) == 0 || islcp);
800
801   /* Is the skb headroom large enough to contain all IrDA-headers? */
802   if((skb_headroom(skb) < (ap->max_header_size + needaddr)) ||
803       (skb_shared(skb)))
804     {
805       struct sk_buff *  new_skb;
806
807       DEBUG(PPP_INFO, "Reallocating skb\n");
808
809       /* Create a new skb */
810       new_skb = skb_realloc_headroom(skb, ap->max_header_size + needaddr);
811
812       /* We have to free the original skb anyway */
813       dev_kfree_skb(skb);
814
815       /* Did the realloc succeed ? */
816       DABORT(new_skb == NULL, NULL, PPP_ERROR, "Could not realloc skb\n");
817
818       /* Use the new skb instead */
819       skb = new_skb;
820     }
821
822   /* prepend address/control fields if necessary */
823   if(needaddr)
824     {
825       skb_push(skb, 2);
826       skb->data[0] = PPP_ALLSTATIONS;
827       skb->data[1] = PPP_UI;
828     }
829
830   DEXIT(PPP_TRACE, "\n");
831
832   return skb;
833 }
834
835 /*------------------------------------------------------------------*/
836 /*
837  * Send a packet to the peer over the IrTTP connection.
838  * Returns 1 iff the packet was accepted.
839  * Returns 0 iff packet was not consumed.
840  * If the packet was not accepted, we will call ppp_output_wakeup
841  * at some later time to reactivate flow control in ppp_generic.
842  */
843 static int
844 ppp_irnet_send(struct ppp_channel *     chan,
845                struct sk_buff *         skb)
846 {
847   irnet_socket *        self = (struct irnet_socket *) chan->private;
848   int                   ret;
849
850   DENTER(PPP_TRACE, "(channel=0x%p, ap/self=0x%p)\n",
851          chan, self);
852
853   /* Check if things are somewhat valid... */
854   DASSERT(self != NULL, 0, PPP_ERROR, "Self is NULL !!!\n");
855
856   /* Check if we are connected */
857   if(!(test_bit(0, &self->ttp_open)))
858     {
859 #ifdef CONNECT_IN_SEND
860       /* Let's try to connect one more time... */
861       /* Note : we won't be connected after this call, but we should be
862        * ready for next packet... */
863       /* If we are already connecting, this will fail */
864       irda_irnet_connect(self);
865 #endif /* CONNECT_IN_SEND */
866
867       DEBUG(PPP_INFO, "IrTTP not ready ! (%ld-%ld)\n",
868             self->ttp_open, self->ttp_connect);
869
870       /* Note : we can either drop the packet or block the packet.
871        *
872        * Blocking the packet allow us a better connection time,
873        * because by calling ppp_output_wakeup() we can have
874        * ppp_generic resending the LCP request immediately to us,
875        * rather than waiting for one of pppd periodic transmission of
876        * LCP request.
877        *
878        * On the other hand, if we block all packet, all those periodic
879        * transmissions of pppd accumulate in ppp_generic, creating a
880        * backlog of LCP request. When we eventually connect later on,
881        * we have to transmit all this backlog before we can connect
882        * proper (if we don't timeout before).
883        *
884        * The current strategy is as follow :
885        * While we are attempting to connect, we block packets to get
886        * a better connection time.
887        * If we fail to connect, we drain the queue and start dropping packets
888        */
889 #ifdef BLOCK_WHEN_CONNECT
890       /* If we are attempting to connect */
891       if(test_bit(0, &self->ttp_connect))
892         {
893           /* Blocking packet, ppp_generic will retry later */
894           return 0;
895         }
896 #endif /* BLOCK_WHEN_CONNECT */
897
898       /* Dropping packet, pppd will retry later */
899       dev_kfree_skb(skb);
900       return 1;
901     }
902
903   /* Check if the queue can accept any packet, otherwise block */
904   if(self->tx_flow != FLOW_START)
905     DRETURN(0, PPP_INFO, "IrTTP queue full (%d skbs)...\n",
906             skb_queue_len(&self->tsap->tx_queue));
907
908   /* Prepare ppp frame for transmission */
909   skb = irnet_prepare_skb(self, skb);
910   DABORT(skb == NULL, 1, PPP_ERROR, "Prepare skb for Tx failed.\n");
911
912   /* Send the packet to IrTTP */
913   ret = irttp_data_request(self->tsap, skb);
914   if(ret < 0)
915     {
916       /*   
917        * > IrTTPs tx queue is full, so we just have to
918        * > drop the frame! You might think that we should
919        * > just return -1 and don't deallocate the frame,
920        * > but that is dangerous since it's possible that
921        * > we have replaced the original skb with a new
922        * > one with larger headroom, and that would really
923        * > confuse do_dev_queue_xmit() in dev.c! I have
924        * > tried :-) DB 
925        * Correction : we verify the flow control above (self->tx_flow),
926        * so we come here only if IrTTP doesn't like the packet (empty,
927        * too large, IrTTP not connected). In those rare cases, it's ok
928        * to drop it, we don't want to see it here again...
929        * Jean II
930        */
931       DERROR(PPP_ERROR, "IrTTP doesn't like this packet !!! (0x%X)\n", ret);
932       /* irttp_data_request already free the packet */
933     }
934
935   DEXIT(PPP_TRACE, "\n");
936   return 1;     /* Packet has been consumed */
937 }
938
939 /*------------------------------------------------------------------*/
940 /*
941  * Take care of the ioctls that ppp_generic doesn't want to deal with...
942  * Note : we are also called from dev_irnet_ioctl().
943  */
944 static int
945 ppp_irnet_ioctl(struct ppp_channel *    chan,
946                 unsigned int            cmd,
947                 unsigned long           arg)
948 {
949   irnet_socket *        ap = (struct irnet_socket *) chan->private;
950   int                   err;
951   int                   val;
952   u32                   accm[8];
953
954   DENTER(PPP_TRACE, "(channel=0x%p, ap=0x%p, cmd=0x%X)\n",
955          chan, ap, cmd);
956
957   /* Basic checks... */
958   DASSERT(ap != NULL, -ENXIO, PPP_ERROR, "ap is NULL...\n");
959
960   err = -EFAULT;
961   switch(cmd)
962     {
963       /* PPP flags */
964     case PPPIOCGFLAGS:
965       val = ap->flags | ap->rbits;
966       if(put_user(val, (int *) arg))
967         break;
968       err = 0;
969       break;
970     case PPPIOCSFLAGS:
971       if(get_user(val, (int *) arg))
972         break;
973       ap->flags = val & ~SC_RCV_BITS;
974       ap->rbits = val & SC_RCV_BITS;
975       err = 0;
976       break;
977
978       /* Async map stuff - all dummy to please pppd */
979     case PPPIOCGASYNCMAP:
980       if(put_user(ap->xaccm[0], (u32 *) arg))
981         break;
982       err = 0;
983       break;
984     case PPPIOCSASYNCMAP:
985       if(get_user(ap->xaccm[0], (u32 *) arg))
986         break;
987       err = 0;
988       break;
989     case PPPIOCGRASYNCMAP:
990       if(put_user(ap->raccm, (u32 *) arg))
991         break;
992       err = 0;
993       break;
994     case PPPIOCSRASYNCMAP:
995       if(get_user(ap->raccm, (u32 *) arg))
996         break;
997       err = 0;
998       break;
999     case PPPIOCGXASYNCMAP:
1000       if(copy_to_user((void *) arg, ap->xaccm, sizeof(ap->xaccm)))
1001         break;
1002       err = 0;
1003       break;
1004     case PPPIOCSXASYNCMAP:
1005       if(copy_from_user(accm, (void *) arg, sizeof(accm)))
1006         break;
1007       accm[2] &= ~0x40000000U;          /* can't escape 0x5e */
1008       accm[3] |= 0x60000000U;           /* must escape 0x7d, 0x7e */
1009       memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
1010       err = 0;
1011       break;
1012
1013       /* Max PPP frame size */
1014     case PPPIOCGMRU:
1015       if(put_user(ap->mru, (int *) arg))
1016         break;
1017       err = 0;
1018       break;
1019     case PPPIOCSMRU:
1020       if(get_user(val, (int *) arg))
1021         break;
1022       if(val < PPP_MRU)
1023         val = PPP_MRU;
1024       ap->mru = val;
1025       err = 0;
1026       break;
1027
1028     default:
1029       DEBUG(PPP_INFO, "Unsupported ioctl (0x%X)\n", cmd);
1030       err = -ENOIOCTLCMD;
1031     }
1032
1033   DEXIT(PPP_TRACE, " - err = 0x%X\n", err);
1034   return err;
1035 }
1036
1037 /************************** INITIALISATION **************************/
1038 /*
1039  * Module initialisation and all that jazz...
1040  */
1041
1042 /*------------------------------------------------------------------*/
1043 /*
1044  * Hook our device callbacks in the filesystem, to connect our code
1045  * to /dev/irnet
1046  */
1047 static inline int __init
1048 ppp_irnet_init(void)
1049 {
1050   int err = 0;
1051
1052   DENTER(MODULE_TRACE, "()\n");
1053
1054   /* Allocate ourselves as a minor in the misc range */
1055   err = misc_register(&irnet_misc_device);
1056
1057   DEXIT(MODULE_TRACE, "\n");
1058   return err;
1059 }
1060
1061 /*------------------------------------------------------------------*/
1062 /*
1063  * Cleanup at exit...
1064  */
1065 static inline void __exit
1066 ppp_irnet_cleanup(void)
1067 {
1068   DENTER(MODULE_TRACE, "()\n");
1069
1070   /* De-allocate /dev/irnet minor in misc range */
1071   misc_deregister(&irnet_misc_device);
1072
1073   DEXIT(MODULE_TRACE, "\n");
1074 }
1075
1076 /*------------------------------------------------------------------*/
1077 /*
1078  * Module main entry point
1079  */
1080 int __init
1081 irnet_init(void)
1082 {
1083   int err;
1084
1085   /* Initialise both parts... */
1086   err = irda_irnet_init();
1087   if(!err)
1088     err = ppp_irnet_init();
1089   return err;
1090 }
1091
1092 /*------------------------------------------------------------------*/
1093 /*
1094  * Module exit
1095  */
1096 void __exit
1097 irnet_cleanup(void)
1098 {
1099   irda_irnet_cleanup();
1100   return ppp_irnet_cleanup();
1101 }
1102
1103 /*------------------------------------------------------------------*/
1104 /*
1105  * Module magic
1106  */
1107 module_init(irnet_init);
1108 module_exit(irnet_cleanup);
1109 MODULE_AUTHOR("Jean Tourrilhes <jt@hpl.hp.com>");
1110 MODULE_DESCRIPTION("IrNET : Synchronous PPP over IrDA"); 
1111 MODULE_LICENSE("GPL");