NET: Fix locking issues in PPP, 6pack, mkiss and strip line disciplines.
[linux-2.6.git] / drivers / net / wireless / strip.c
1 /*
2  * Copyright 1996 The Board of Trustees of The Leland Stanford
3  * Junior University. All Rights Reserved.
4  *
5  * Permission to use, copy, modify, and distribute this
6  * software and its documentation for any purpose and without
7  * fee is hereby granted, provided that the above copyright
8  * notice appear in all copies.  Stanford University
9  * makes no representations about the suitability of this
10  * software for any purpose.  It is provided "as is" without
11  * express or implied warranty.
12  *
13  * strip.c      This module implements Starmode Radio IP (STRIP)
14  *              for kernel-based devices like TTY.  It interfaces between a
15  *              raw TTY, and the kernel's INET protocol layers (via DDI).
16  *
17  * Version:     @(#)strip.c     1.3     July 1997
18  *
19  * Author:      Stuart Cheshire <cheshire@cs.stanford.edu>
20  *
21  * Fixes:       v0.9 12th Feb 1996 (SC)
22  *              New byte stuffing (2+6 run-length encoding)
23  *              New watchdog timer task
24  *              New Protocol key (SIP0)
25  *              
26  *              v0.9.1 3rd March 1996 (SC)
27  *              Changed to dynamic device allocation -- no more compile
28  *              time (or boot time) limit on the number of STRIP devices.
29  *              
30  *              v0.9.2 13th March 1996 (SC)
31  *              Uses arp cache lookups (but doesn't send arp packets yet)
32  *              
33  *              v0.9.3 17th April 1996 (SC)
34  *              Fixed bug where STR_ERROR flag was getting set unneccessarily
35  *              (causing otherwise good packets to be unneccessarily dropped)
36  *              
37  *              v0.9.4 27th April 1996 (SC)
38  *              First attempt at using "&COMMAND" Starmode AT commands
39  *              
40  *              v0.9.5 29th May 1996 (SC)
41  *              First attempt at sending (unicast) ARP packets
42  *              
43  *              v0.9.6 5th June 1996 (Elliot)
44  *              Put "message level" tags in every "printk" statement
45  *              
46  *              v0.9.7 13th June 1996 (laik)
47  *              Added support for the /proc fs
48  *
49  *              v0.9.8 July 1996 (Mema)
50  *              Added packet logging
51  *
52  *              v1.0 November 1996 (SC)
53  *              Fixed (severe) memory leaks in the /proc fs code
54  *              Fixed race conditions in the logging code
55  *
56  *              v1.1 January 1997 (SC)
57  *              Deleted packet logging (use tcpdump instead)
58  *              Added support for Metricom Firmware v204 features
59  *              (like message checksums)
60  *
61  *              v1.2 January 1997 (SC)
62  *              Put portables list back in
63  *
64  *              v1.3 July 1997 (SC)
65  *              Made STRIP driver set the radio's baud rate automatically.
66  *              It is no longer necessarily to manually set the radio's
67  *              rate permanently to 115200 -- the driver handles setting
68  *              the rate automatically.
69  */
70
71 #ifdef MODULE
72 static const char StripVersion[] = "1.3A-STUART.CHESHIRE-MODULAR";
73 #else
74 static const char StripVersion[] = "1.3A-STUART.CHESHIRE";
75 #endif
76
77 #define TICKLE_TIMERS 0
78 #define EXT_COUNTERS 1
79
80
81 /************************************************************************/
82 /* Header files                                                         */
83
84 #include <linux/kernel.h>
85 #include <linux/module.h>
86 #include <linux/init.h>
87 #include <linux/bitops.h>
88 #include <asm/system.h>
89 #include <asm/uaccess.h>
90
91 # include <linux/ctype.h>
92 #include <linux/string.h>
93 #include <linux/mm.h>
94 #include <linux/interrupt.h>
95 #include <linux/in.h>
96 #include <linux/tty.h>
97 #include <linux/errno.h>
98 #include <linux/netdevice.h>
99 #include <linux/inetdevice.h>
100 #include <linux/etherdevice.h>
101 #include <linux/skbuff.h>
102 #include <linux/if_arp.h>
103 #include <linux/if_strip.h>
104 #include <linux/proc_fs.h>
105 #include <linux/seq_file.h>
106 #include <linux/serial.h>
107 #include <linux/serialP.h>
108 #include <linux/rcupdate.h>
109 #include <net/arp.h>
110 #include <net/net_namespace.h>
111
112 #include <linux/ip.h>
113 #include <linux/tcp.h>
114 #include <linux/time.h>
115 #include <linux/jiffies.h>
116
117 /************************************************************************/
118 /* Useful structures and definitions                                    */
119
120 /*
121  * A MetricomKey identifies the protocol being carried inside a Metricom
122  * Starmode packet.
123  */
124
125 typedef union {
126         __u8 c[4];
127         __u32 l;
128 } MetricomKey;
129
130 /*
131  * An IP address can be viewed as four bytes in memory (which is what it is) or as
132  * a single 32-bit long (which is convenient for assignment, equality testing etc.)
133  */
134
135 typedef union {
136         __u8 b[4];
137         __u32 l;
138 } IPaddr;
139
140 /*
141  * A MetricomAddressString is used to hold a printable representation of
142  * a Metricom address.
143  */
144
145 typedef struct {
146         __u8 c[24];
147 } MetricomAddressString;
148
149 /* Encapsulation can expand packet of size x to 65/64x + 1
150  * Sent packet looks like "<CR>*<address>*<key><encaps payload><CR>"
151  *                           1 1   1-18  1  4         ?         1
152  * eg.                     <CR>*0000-1234*SIP0<encaps payload><CR>
153  * We allow 31 bytes for the stars, the key, the address and the <CR>s
154  */
155 #define STRIP_ENCAP_SIZE(X) (32 + (X)*65L/64L)
156
157 /*
158  * A STRIP_Header is never really sent over the radio, but making a dummy
159  * header for internal use within the kernel that looks like an Ethernet
160  * header makes certain other software happier. For example, tcpdump
161  * already understands Ethernet headers.
162  */
163
164 typedef struct {
165         MetricomAddress dst_addr;       /* Destination address, e.g. "0000-1234"   */
166         MetricomAddress src_addr;       /* Source address, e.g. "0000-5678"        */
167         unsigned short protocol;        /* The protocol type, using Ethernet codes */
168 } STRIP_Header;
169
170 typedef struct {
171         char c[60];
172 } MetricomNode;
173
174 #define NODE_TABLE_SIZE 32
175 typedef struct {
176         struct timeval timestamp;
177         int num_nodes;
178         MetricomNode node[NODE_TABLE_SIZE];
179 } MetricomNodeTable;
180
181 enum { FALSE = 0, TRUE = 1 };
182
183 /*
184  * Holds the radio's firmware version.
185  */
186 typedef struct {
187         char c[50];
188 } FirmwareVersion;
189
190 /*
191  * Holds the radio's serial number.
192  */
193 typedef struct {
194         char c[18];
195 } SerialNumber;
196
197 /*
198  * Holds the radio's battery voltage.
199  */
200 typedef struct {
201         char c[11];
202 } BatteryVoltage;
203
204 typedef struct {
205         char c[8];
206 } char8;
207
208 enum {
209         NoStructure = 0,        /* Really old firmware */
210         StructuredMessages = 1, /* Parsable AT response msgs */
211         ChecksummedMessages = 2 /* Parsable AT response msgs with checksums */
212 };
213
214 struct strip {
215         int magic;
216         /*
217          * These are pointers to the malloc()ed frame buffers.
218          */
219
220         unsigned char *rx_buff; /* buffer for received IP packet */
221         unsigned char *sx_buff; /* buffer for received serial data */
222         int sx_count;           /* received serial data counter */
223         int sx_size;            /* Serial buffer size           */
224         unsigned char *tx_buff; /* transmitter buffer           */
225         unsigned char *tx_head; /* pointer to next byte to XMIT */
226         int tx_left;            /* bytes left in XMIT queue     */
227         int tx_size;            /* Serial buffer size           */
228
229         /*
230          * STRIP interface statistics.
231          */
232
233         unsigned long rx_packets;       /* inbound frames counter       */
234         unsigned long tx_packets;       /* outbound frames counter      */
235         unsigned long rx_errors;        /* Parity, etc. errors          */
236         unsigned long tx_errors;        /* Planned stuff                */
237         unsigned long rx_dropped;       /* No memory for skb            */
238         unsigned long tx_dropped;       /* When MTU change              */
239         unsigned long rx_over_errors;   /* Frame bigger than STRIP buf. */
240
241         unsigned long pps_timer;        /* Timer to determine pps       */
242         unsigned long rx_pps_count;     /* Counter to determine pps     */
243         unsigned long tx_pps_count;     /* Counter to determine pps     */
244         unsigned long sx_pps_count;     /* Counter to determine pps     */
245         unsigned long rx_average_pps;   /* rx packets per second * 8    */
246         unsigned long tx_average_pps;   /* tx packets per second * 8    */
247         unsigned long sx_average_pps;   /* sent packets per second * 8  */
248
249 #ifdef EXT_COUNTERS
250         unsigned long rx_bytes;         /* total received bytes */
251         unsigned long tx_bytes;         /* total received bytes */
252         unsigned long rx_rbytes;        /* bytes thru radio i/f */
253         unsigned long tx_rbytes;        /* bytes thru radio i/f */
254         unsigned long rx_sbytes;        /* tot bytes thru serial i/f */
255         unsigned long tx_sbytes;        /* tot bytes thru serial i/f */
256         unsigned long rx_ebytes;        /* tot stat/err bytes */
257         unsigned long tx_ebytes;        /* tot stat/err bytes */
258 #endif
259
260         /*
261          * Internal variables.
262          */
263
264         struct list_head  list;         /* Linked list of devices */
265
266         int discard;                    /* Set if serial error          */
267         int working;                    /* Is radio working correctly?  */
268         int firmware_level;             /* Message structuring level    */
269         int next_command;               /* Next periodic command        */
270         unsigned int user_baud;         /* The user-selected baud rate  */
271         int mtu;                        /* Our mtu (to spot changes!)   */
272         long watchdog_doprobe;          /* Next time to test the radio  */
273         long watchdog_doreset;          /* Time to do next reset        */
274         long gratuitous_arp;            /* Time to send next ARP refresh */
275         long arp_interval;              /* Next ARP interval            */
276         struct timer_list idle_timer;   /* For periodic wakeup calls    */
277         MetricomAddress true_dev_addr;  /* True address of radio        */
278         int manual_dev_addr;            /* Hack: See note below         */
279
280         FirmwareVersion firmware_version;       /* The radio's firmware version */
281         SerialNumber serial_number;     /* The radio's serial number    */
282         BatteryVoltage battery_voltage; /* The radio's battery voltage  */
283
284         /*
285          * Other useful structures.
286          */
287
288         struct tty_struct *tty;         /* ptr to TTY structure         */
289         struct net_device *dev;         /* Our device structure         */
290
291         /*
292          * Neighbour radio records
293          */
294
295         MetricomNodeTable portables;
296         MetricomNodeTable poletops;
297 };
298
299 /*
300  * Note: manual_dev_addr hack
301  * 
302  * It is not possible to change the hardware address of a Metricom radio,
303  * or to send packets with a user-specified hardware source address, thus
304  * trying to manually set a hardware source address is a questionable
305  * thing to do.  However, if the user *does* manually set the hardware
306  * source address of a STRIP interface, then the kernel will believe it,
307  * and use it in certain places. For example, the hardware address listed
308  * by ifconfig will be the manual address, not the true one.
309  * (Both addresses are listed in /proc/net/strip.)
310  * Also, ARP packets will be sent out giving the user-specified address as
311  * the source address, not the real address. This is dangerous, because
312  * it means you won't receive any replies -- the ARP replies will go to
313  * the specified address, which will be some other radio. The case where
314  * this is useful is when that other radio is also connected to the same
315  * machine. This allows you to connect a pair of radios to one machine,
316  * and to use one exclusively for inbound traffic, and the other
317  * exclusively for outbound traffic. Pretty neat, huh?
318  * 
319  * Here's the full procedure to set this up:
320  * 
321  * 1. "slattach" two interfaces, e.g. st0 for outgoing packets,
322  *    and st1 for incoming packets
323  * 
324  * 2. "ifconfig" st0 (outbound radio) to have the hardware address
325  *    which is the real hardware address of st1 (inbound radio).
326  *    Now when it sends out packets, it will masquerade as st1, and
327  *    replies will be sent to that radio, which is exactly what we want.
328  * 
329  * 3. Set the route table entry ("route add default ..." or
330  *    "route add -net ...", as appropriate) to send packets via the st0
331  *    interface (outbound radio). Do not add any route which sends packets
332  *    out via the st1 interface -- that radio is for inbound traffic only.
333  * 
334  * 4. "ifconfig" st1 (inbound radio) to have hardware address zero.
335  *    This tells the STRIP driver to "shut down" that interface and not
336  *    send any packets through it. In particular, it stops sending the
337  *    periodic gratuitous ARP packets that a STRIP interface normally sends.
338  *    Also, when packets arrive on that interface, it will search the
339  *    interface list to see if there is another interface who's manual
340  *    hardware address matches its own real address (i.e. st0 in this
341  *    example) and if so it will transfer ownership of the skbuff to
342  *    that interface, so that it looks to the kernel as if the packet
343  *    arrived on that interface. This is necessary because when the
344  *    kernel sends an ARP packet on st0, it expects to get a reply on
345  *    st0, and if it sees the reply come from st1 then it will ignore
346  *    it (to be accurate, it puts the entry in the ARP table, but
347  *    labelled in such a way that st0 can't use it).
348  * 
349  * Thanks to Petros Maniatis for coming up with the idea of splitting
350  * inbound and outbound traffic between two interfaces, which turned
351  * out to be really easy to implement, even if it is a bit of a hack.
352  * 
353  * Having set a manual address on an interface, you can restore it
354  * to automatic operation (where the address is automatically kept
355  * consistent with the real address of the radio) by setting a manual
356  * address of all ones, e.g. "ifconfig st0 hw strip FFFFFFFFFFFF"
357  * This 'turns off' manual override mode for the device address.
358  * 
359  * Note: The IEEE 802 headers reported in tcpdump will show the *real*
360  * radio addresses the packets were sent and received from, so that you
361  * can see what is really going on with packets, and which interfaces
362  * they are really going through.
363  */
364
365
366 /************************************************************************/
367 /* Constants                                                            */
368
369 /*
370  * CommandString1 works on all radios
371  * Other CommandStrings are only used with firmware that provides structured responses.
372  * 
373  * ats319=1 Enables Info message for node additions and deletions
374  * ats319=2 Enables Info message for a new best node
375  * ats319=4 Enables checksums
376  * ats319=8 Enables ACK messages
377  */
378
379 static const int MaxCommandStringLength = 32;
380 static const int CompatibilityCommand = 1;
381
382 static const char CommandString0[] = "*&COMMAND*ATS319=7";      /* Turn on checksums & info messages */
383 static const char CommandString1[] = "*&COMMAND*ATS305?";       /* Query radio name */
384 static const char CommandString2[] = "*&COMMAND*ATS325?";       /* Query battery voltage */
385 static const char CommandString3[] = "*&COMMAND*ATS300?";       /* Query version information */
386 static const char CommandString4[] = "*&COMMAND*ATS311?";       /* Query poletop list */
387 static const char CommandString5[] = "*&COMMAND*AT~LA";         /* Query portables list */
388 typedef struct {
389         const char *string;
390         long length;
391 } StringDescriptor;
392
393 static const StringDescriptor CommandString[] = {
394         {CommandString0, sizeof(CommandString0) - 1},
395         {CommandString1, sizeof(CommandString1) - 1},
396         {CommandString2, sizeof(CommandString2) - 1},
397         {CommandString3, sizeof(CommandString3) - 1},
398         {CommandString4, sizeof(CommandString4) - 1},
399         {CommandString5, sizeof(CommandString5) - 1}
400 };
401
402 #define GOT_ALL_RADIO_INFO(S)      \
403     ((S)->firmware_version.c[0] && \
404      (S)->battery_voltage.c[0]  && \
405      memcmp(&(S)->true_dev_addr, zero_address.c, sizeof(zero_address)))
406
407 static const char hextable[16] = "0123456789ABCDEF";
408
409 static const MetricomAddress zero_address;
410 static const MetricomAddress broadcast_address =
411     { {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF} };
412
413 static const MetricomKey SIP0Key = { "SIP0" };
414 static const MetricomKey ARP0Key = { "ARP0" };
415 static const MetricomKey ATR_Key = { "ATR " };
416 static const MetricomKey ACK_Key = { "ACK_" };
417 static const MetricomKey INF_Key = { "INF_" };
418 static const MetricomKey ERR_Key = { "ERR_" };
419
420 static const long MaxARPInterval = 60 * HZ;     /* One minute */
421
422 /*
423  * Maximum Starmode packet length is 1183 bytes. Allowing 4 bytes for
424  * protocol key, 4 bytes for checksum, one byte for CR, and 65/64 expansion
425  * for STRIP encoding, that translates to a maximum payload MTU of 1155.
426  * Note: A standard NFS 1K data packet is a total of 0x480 (1152) bytes
427  * long, including IP header, UDP header, and NFS header. Setting the STRIP
428  * MTU to 1152 allows us to send default sized NFS packets without fragmentation.
429  */
430 static const unsigned short MAX_SEND_MTU = 1152;
431 static const unsigned short MAX_RECV_MTU = 1500;        /* Hoping for Ethernet sized packets in the future! */
432 static const unsigned short DEFAULT_STRIP_MTU = 1152;
433 static const int STRIP_MAGIC = 0x5303;
434 static const long LongTime = 0x7FFFFFFF;
435
436 /************************************************************************/
437 /* Global variables                                                     */
438
439 static LIST_HEAD(strip_list);
440 static DEFINE_SPINLOCK(strip_lock);
441
442 /************************************************************************/
443 /* Macros                                                               */
444
445 /* Returns TRUE if text T begins with prefix P */
446 #define has_prefix(T,L,P) (((L) >= sizeof(P)-1) && !strncmp((T), (P), sizeof(P)-1))
447
448 /* Returns TRUE if text T of length L is equal to string S */
449 #define text_equal(T,L,S) (((L) == sizeof(S)-1) && !strncmp((T), (S), sizeof(S)-1))
450
451 #define READHEX(X) ((X)>='0' && (X)<='9' ? (X)-'0' :      \
452                     (X)>='a' && (X)<='f' ? (X)-'a'+10 :   \
453                     (X)>='A' && (X)<='F' ? (X)-'A'+10 : 0 )
454
455 #define READHEX16(X) ((__u16)(READHEX(X)))
456
457 #define READDEC(X) ((X)>='0' && (X)<='9' ? (X)-'0' : 0)
458
459 #define ARRAY_END(X) (&((X)[ARRAY_SIZE(X)]))
460
461 #define JIFFIE_TO_SEC(X) ((X) / HZ)
462
463
464 /************************************************************************/
465 /* Utility routines                                                     */
466
467 static int arp_query(unsigned char *haddr, u32 paddr,
468                      struct net_device *dev)
469 {
470         struct neighbour *neighbor_entry;
471         int ret = 0;
472
473         neighbor_entry = neigh_lookup(&arp_tbl, &paddr, dev);
474
475         if (neighbor_entry != NULL) {
476                 neighbor_entry->used = jiffies;
477                 if (neighbor_entry->nud_state & NUD_VALID) {
478                         memcpy(haddr, neighbor_entry->ha, dev->addr_len);
479                         ret = 1;
480                 }
481                 neigh_release(neighbor_entry);
482         }
483         return ret;
484 }
485
486 static void DumpData(char *msg, struct strip *strip_info, __u8 * ptr,
487                      __u8 * end)
488 {
489         static const int MAX_DumpData = 80;
490         __u8 pkt_text[MAX_DumpData], *p = pkt_text;
491
492         *p++ = '\"';
493
494         while (ptr < end && p < &pkt_text[MAX_DumpData - 4]) {
495                 if (*ptr == '\\') {
496                         *p++ = '\\';
497                         *p++ = '\\';
498                 } else {
499                         if (*ptr >= 32 && *ptr <= 126) {
500                                 *p++ = *ptr;
501                         } else {
502                                 sprintf(p, "\\%02X", *ptr);
503                                 p += 3;
504                         }
505                 }
506                 ptr++;
507         }
508
509         if (ptr == end)
510                 *p++ = '\"';
511         *p++ = 0;
512
513         printk(KERN_INFO "%s: %-13s%s\n", strip_info->dev->name, msg, pkt_text);
514 }
515
516
517 /************************************************************************/
518 /* Byte stuffing/unstuffing routines                                    */
519
520 /* Stuffing scheme:
521  * 00    Unused (reserved character)
522  * 01-3F Run of 2-64 different characters
523  * 40-7F Run of 1-64 different characters plus a single zero at the end
524  * 80-BF Run of 1-64 of the same character
525  * C0-FF Run of 1-64 zeroes (ASCII 0)
526  */
527
528 typedef enum {
529         Stuff_Diff = 0x00,
530         Stuff_DiffZero = 0x40,
531         Stuff_Same = 0x80,
532         Stuff_Zero = 0xC0,
533         Stuff_NoCode = 0xFF,    /* Special code, meaning no code selected */
534
535         Stuff_CodeMask = 0xC0,
536         Stuff_CountMask = 0x3F,
537         Stuff_MaxCount = 0x3F,
538         Stuff_Magic = 0x0D      /* The value we are eliminating */
539 } StuffingCode;
540
541 /* StuffData encodes the data starting at "src" for "length" bytes.
542  * It writes it to the buffer pointed to by "dst" (which must be at least
543  * as long as 1 + 65/64 of the input length). The output may be up to 1.6%
544  * larger than the input for pathological input, but will usually be smaller.
545  * StuffData returns the new value of the dst pointer as its result.
546  * "code_ptr_ptr" points to a "__u8 *" which is used to hold encoding state
547  * between calls, allowing an encoded packet to be incrementally built up
548  * from small parts. On the first call, the "__u8 *" pointed to should be
549  * initialized to NULL; between subsequent calls the calling routine should
550  * leave the value alone and simply pass it back unchanged so that the
551  * encoder can recover its current state.
552  */
553
554 #define StuffData_FinishBlock(X) \
555 (*code_ptr = (X) ^ Stuff_Magic, code = Stuff_NoCode)
556
557 static __u8 *StuffData(__u8 * src, __u32 length, __u8 * dst,
558                        __u8 ** code_ptr_ptr)
559 {
560         __u8 *end = src + length;
561         __u8 *code_ptr = *code_ptr_ptr;
562         __u8 code = Stuff_NoCode, count = 0;
563
564         if (!length)
565                 return (dst);
566
567         if (code_ptr) {
568                 /*
569                  * Recover state from last call, if applicable
570                  */
571                 code = (*code_ptr ^ Stuff_Magic) & Stuff_CodeMask;
572                 count = (*code_ptr ^ Stuff_Magic) & Stuff_CountMask;
573         }
574
575         while (src < end) {
576                 switch (code) {
577                         /* Stuff_NoCode: If no current code, select one */
578                 case Stuff_NoCode:
579                         /* Record where we're going to put this code */
580                         code_ptr = dst++;
581                         count = 0;      /* Reset the count (zero means one instance) */
582                         /* Tentatively start a new block */
583                         if (*src == 0) {
584                                 code = Stuff_Zero;
585                                 src++;
586                         } else {
587                                 code = Stuff_Same;
588                                 *dst++ = *src++ ^ Stuff_Magic;
589                         }
590                         /* Note: We optimistically assume run of same -- */
591                         /* which will be fixed later in Stuff_Same */
592                         /* if it turns out not to be true. */
593                         break;
594
595                         /* Stuff_Zero: We already have at least one zero encoded */
596                 case Stuff_Zero:
597                         /* If another zero, count it, else finish this code block */
598                         if (*src == 0) {
599                                 count++;
600                                 src++;
601                         } else {
602                                 StuffData_FinishBlock(Stuff_Zero + count);
603                         }
604                         break;
605
606                         /* Stuff_Same: We already have at least one byte encoded */
607                 case Stuff_Same:
608                         /* If another one the same, count it */
609                         if ((*src ^ Stuff_Magic) == code_ptr[1]) {
610                                 count++;
611                                 src++;
612                                 break;
613                         }
614                         /* else, this byte does not match this block. */
615                         /* If we already have two or more bytes encoded, finish this code block */
616                         if (count) {
617                                 StuffData_FinishBlock(Stuff_Same + count);
618                                 break;
619                         }
620                         /* else, we only have one so far, so switch to Stuff_Diff code */
621                         code = Stuff_Diff;
622                         /* and fall through to Stuff_Diff case below
623                          * Note cunning cleverness here: case Stuff_Diff compares 
624                          * the current character with the previous two to see if it
625                          * has a run of three the same. Won't this be an error if
626                          * there aren't two previous characters stored to compare with?
627                          * No. Because we know the current character is *not* the same
628                          * as the previous one, the first test below will necessarily
629                          * fail and the send half of the "if" won't be executed.
630                          */
631
632                         /* Stuff_Diff: We have at least two *different* bytes encoded */
633                 case Stuff_Diff:
634                         /* If this is a zero, must encode a Stuff_DiffZero, and begin a new block */
635                         if (*src == 0) {
636                                 StuffData_FinishBlock(Stuff_DiffZero +
637                                                       count);
638                         }
639                         /* else, if we have three in a row, it is worth starting a Stuff_Same block */
640                         else if ((*src ^ Stuff_Magic) == dst[-1]
641                                  && dst[-1] == dst[-2]) {
642                                 /* Back off the last two characters we encoded */
643                                 code += count - 2;
644                                 /* Note: "Stuff_Diff + 0" is an illegal code */
645                                 if (code == Stuff_Diff + 0) {
646                                         code = Stuff_Same + 0;
647                                 }
648                                 StuffData_FinishBlock(code);
649                                 code_ptr = dst - 2;
650                                 /* dst[-1] already holds the correct value */
651                                 count = 2;      /* 2 means three bytes encoded */
652                                 code = Stuff_Same;
653                         }
654                         /* else, another different byte, so add it to the block */
655                         else {
656                                 *dst++ = *src ^ Stuff_Magic;
657                                 count++;
658                         }
659                         src++;  /* Consume the byte */
660                         break;
661                 }
662                 if (count == Stuff_MaxCount) {
663                         StuffData_FinishBlock(code + count);
664                 }
665         }
666         if (code == Stuff_NoCode) {
667                 *code_ptr_ptr = NULL;
668         } else {
669                 *code_ptr_ptr = code_ptr;
670                 StuffData_FinishBlock(code + count);
671         }
672         return (dst);
673 }
674
675 /*
676  * UnStuffData decodes the data at "src", up to (but not including) "end".
677  * It writes the decoded data into the buffer pointed to by "dst", up to a
678  * maximum of "dst_length", and returns the new value of "src" so that a
679  * follow-on call can read more data, continuing from where the first left off.
680  * 
681  * There are three types of results:
682  * 1. The source data runs out before extracting "dst_length" bytes:
683  *    UnStuffData returns NULL to indicate failure.
684  * 2. The source data produces exactly "dst_length" bytes:
685  *    UnStuffData returns new_src = end to indicate that all bytes were consumed.
686  * 3. "dst_length" bytes are extracted, with more remaining.
687  *    UnStuffData returns new_src < end to indicate that there are more bytes
688  *    to be read.
689  * 
690  * Note: The decoding may be destructive, in that it may alter the source
691  * data in the process of decoding it (this is necessary to allow a follow-on
692  * call to resume correctly).
693  */
694
695 static __u8 *UnStuffData(__u8 * src, __u8 * end, __u8 * dst,
696                          __u32 dst_length)
697 {
698         __u8 *dst_end = dst + dst_length;
699         /* Sanity check */
700         if (!src || !end || !dst || !dst_length)
701                 return (NULL);
702         while (src < end && dst < dst_end) {
703                 int count = (*src ^ Stuff_Magic) & Stuff_CountMask;
704                 switch ((*src ^ Stuff_Magic) & Stuff_CodeMask) {
705                 case Stuff_Diff:
706                         if (src + 1 + count >= end)
707                                 return (NULL);
708                         do {
709                                 *dst++ = *++src ^ Stuff_Magic;
710                         }
711                         while (--count >= 0 && dst < dst_end);
712                         if (count < 0)
713                                 src += 1;
714                         else {
715                                 if (count == 0)
716                                         *src = Stuff_Same ^ Stuff_Magic;
717                                 else
718                                         *src =
719                                             (Stuff_Diff +
720                                              count) ^ Stuff_Magic;
721                         }
722                         break;
723                 case Stuff_DiffZero:
724                         if (src + 1 + count >= end)
725                                 return (NULL);
726                         do {
727                                 *dst++ = *++src ^ Stuff_Magic;
728                         }
729                         while (--count >= 0 && dst < dst_end);
730                         if (count < 0)
731                                 *src = Stuff_Zero ^ Stuff_Magic;
732                         else
733                                 *src =
734                                     (Stuff_DiffZero + count) ^ Stuff_Magic;
735                         break;
736                 case Stuff_Same:
737                         if (src + 1 >= end)
738                                 return (NULL);
739                         do {
740                                 *dst++ = src[1] ^ Stuff_Magic;
741                         }
742                         while (--count >= 0 && dst < dst_end);
743                         if (count < 0)
744                                 src += 2;
745                         else
746                                 *src = (Stuff_Same + count) ^ Stuff_Magic;
747                         break;
748                 case Stuff_Zero:
749                         do {
750                                 *dst++ = 0;
751                         }
752                         while (--count >= 0 && dst < dst_end);
753                         if (count < 0)
754                                 src += 1;
755                         else
756                                 *src = (Stuff_Zero + count) ^ Stuff_Magic;
757                         break;
758                 }
759         }
760         if (dst < dst_end)
761                 return (NULL);
762         else
763                 return (src);
764 }
765
766
767 /************************************************************************/
768 /* General routines for STRIP                                           */
769
770 /*
771  * set_baud sets the baud rate to the rate defined by baudcode
772  */
773 static void set_baud(struct tty_struct *tty, speed_t baudrate)
774 {
775         struct ktermios old_termios;
776
777         mutex_lock(&tty->termios_mutex);
778         old_termios =*(tty->termios);
779         tty_encode_baud_rate(tty, baudrate, baudrate);
780         tty->ops->set_termios(tty, &old_termios);
781         mutex_unlock(&tty->termios_mutex);
782 }
783
784 /*
785  * Convert a string to a Metricom Address.
786  */
787
788 #define IS_RADIO_ADDRESS(p) (                                                 \
789   isdigit((p)[0]) && isdigit((p)[1]) && isdigit((p)[2]) && isdigit((p)[3]) && \
790   (p)[4] == '-' &&                                                            \
791   isdigit((p)[5]) && isdigit((p)[6]) && isdigit((p)[7]) && isdigit((p)[8])    )
792
793 static int string_to_radio_address(MetricomAddress * addr, __u8 * p)
794 {
795         if (!IS_RADIO_ADDRESS(p))
796                 return (1);
797         addr->c[0] = 0;
798         addr->c[1] = 0;
799         addr->c[2] = READHEX(p[0]) << 4 | READHEX(p[1]);
800         addr->c[3] = READHEX(p[2]) << 4 | READHEX(p[3]);
801         addr->c[4] = READHEX(p[5]) << 4 | READHEX(p[6]);
802         addr->c[5] = READHEX(p[7]) << 4 | READHEX(p[8]);
803         return (0);
804 }
805
806 /*
807  * Convert a Metricom Address to a string.
808  */
809
810 static __u8 *radio_address_to_string(const MetricomAddress * addr,
811                                      MetricomAddressString * p)
812 {
813         sprintf(p->c, "%02X%02X-%02X%02X", addr->c[2], addr->c[3],
814                 addr->c[4], addr->c[5]);
815         return (p->c);
816 }
817
818 /*
819  * Note: Must make sure sx_size is big enough to receive a stuffed
820  * MAX_RECV_MTU packet. Additionally, we also want to ensure that it's
821  * big enough to receive a large radio neighbour list (currently 4K).
822  */
823
824 static int allocate_buffers(struct strip *strip_info, int mtu)
825 {
826         struct net_device *dev = strip_info->dev;
827         int sx_size = max_t(int, STRIP_ENCAP_SIZE(MAX_RECV_MTU), 4096);
828         int tx_size = STRIP_ENCAP_SIZE(mtu) + MaxCommandStringLength;
829         __u8 *r = kmalloc(MAX_RECV_MTU, GFP_ATOMIC);
830         __u8 *s = kmalloc(sx_size, GFP_ATOMIC);
831         __u8 *t = kmalloc(tx_size, GFP_ATOMIC);
832         if (r && s && t) {
833                 strip_info->rx_buff = r;
834                 strip_info->sx_buff = s;
835                 strip_info->tx_buff = t;
836                 strip_info->sx_size = sx_size;
837                 strip_info->tx_size = tx_size;
838                 strip_info->mtu = dev->mtu = mtu;
839                 return (1);
840         }
841         kfree(r);
842         kfree(s);
843         kfree(t);
844         return (0);
845 }
846
847 /*
848  * MTU has been changed by the IP layer. 
849  * We could be in
850  * an upcall from the tty driver, or in an ip packet queue.
851  */
852 static int strip_change_mtu(struct net_device *dev, int new_mtu)
853 {
854         struct strip *strip_info = netdev_priv(dev);
855         int old_mtu = strip_info->mtu;
856         unsigned char *orbuff = strip_info->rx_buff;
857         unsigned char *osbuff = strip_info->sx_buff;
858         unsigned char *otbuff = strip_info->tx_buff;
859         unsigned long flags;
860
861         if (new_mtu > MAX_SEND_MTU) {
862                 printk(KERN_ERR
863                        "%s: MTU exceeds maximum allowable (%d), MTU change cancelled.\n",
864                        strip_info->dev->name, MAX_SEND_MTU);
865                 return -EINVAL;
866         }
867
868         spin_lock_irqsave(&strip_lock, flags);
869         if (!allocate_buffers(strip_info, new_mtu)) {
870                 printk(KERN_ERR "%s: unable to grow strip buffers, MTU change cancelled.\n",
871                        strip_info->dev->name);
872                 spin_unlock_irqrestore(&strip_lock, flags);
873                 return -ENOMEM;
874         }
875
876         if (strip_info->sx_count) {
877                 if (strip_info->sx_count <= strip_info->sx_size)
878                         memcpy(strip_info->sx_buff, osbuff,
879                                strip_info->sx_count);
880                 else {
881                         strip_info->discard = strip_info->sx_count;
882                         strip_info->rx_over_errors++;
883                 }
884         }
885
886         if (strip_info->tx_left) {
887                 if (strip_info->tx_left <= strip_info->tx_size)
888                         memcpy(strip_info->tx_buff, strip_info->tx_head,
889                                strip_info->tx_left);
890                 else {
891                         strip_info->tx_left = 0;
892                         strip_info->tx_dropped++;
893                 }
894         }
895         strip_info->tx_head = strip_info->tx_buff;
896         spin_unlock_irqrestore(&strip_lock, flags);
897
898         printk(KERN_NOTICE "%s: strip MTU changed fom %d to %d.\n",
899                strip_info->dev->name, old_mtu, strip_info->mtu);
900
901         kfree(orbuff);
902         kfree(osbuff);
903         kfree(otbuff);
904         return 0;
905 }
906
907 static void strip_unlock(struct strip *strip_info)
908 {
909         /*
910          * Set the timer to go off in one second.
911          */
912         strip_info->idle_timer.expires = jiffies + 1 * HZ;
913         add_timer(&strip_info->idle_timer);
914         netif_wake_queue(strip_info->dev);
915 }
916
917
918
919 /*
920  * If the time is in the near future, time_delta prints the number of
921  * seconds to go into the buffer and returns the address of the buffer.
922  * If the time is not in the near future, it returns the address of the
923  * string "Not scheduled" The buffer must be long enough to contain the
924  * ascii representation of the number plus 9 charactes for the " seconds"
925  * and the null character.
926  */
927 #ifdef CONFIG_PROC_FS
928 static char *time_delta(char buffer[], long time)
929 {
930         time -= jiffies;
931         if (time > LongTime / 2)
932                 return ("Not scheduled");
933         if (time < 0)
934                 time = 0;       /* Don't print negative times */
935         sprintf(buffer, "%ld seconds", time / HZ);
936         return (buffer);
937 }
938
939 /* get Nth element of the linked list */
940 static struct strip *strip_get_idx(loff_t pos) 
941 {
942         struct strip *str;
943         int i = 0;
944
945         list_for_each_entry_rcu(str, &strip_list, list) {
946                 if (pos == i)
947                         return str;
948                 ++i;
949         }
950         return NULL;
951 }
952
953 static void *strip_seq_start(struct seq_file *seq, loff_t *pos)
954         __acquires(RCU)
955 {
956         rcu_read_lock();
957         return *pos ? strip_get_idx(*pos - 1) : SEQ_START_TOKEN;
958 }
959
960 static void *strip_seq_next(struct seq_file *seq, void *v, loff_t *pos)
961 {
962         struct list_head *l;
963         struct strip *s;
964
965         ++*pos;
966         if (v == SEQ_START_TOKEN)
967                 return strip_get_idx(1);
968
969         s = v;
970         l = &s->list;
971         list_for_each_continue_rcu(l, &strip_list) {
972                 return list_entry(l, struct strip, list);
973         }
974         return NULL;
975 }
976
977 static void strip_seq_stop(struct seq_file *seq, void *v)
978         __releases(RCU)
979 {
980         rcu_read_unlock();
981 }
982
983 static void strip_seq_neighbours(struct seq_file *seq,
984                            const MetricomNodeTable * table,
985                            const char *title)
986 {
987         unsigned long flags;
988         struct timeval t;
989
990         /*
991          * We wrap this in a do/while loop, so if the table changes
992          * while we're reading it, we just go around and try again.
993          */
994         do {
995                 int i;
996                 t = table->timestamp;
997                 if (table->num_nodes)
998                         seq_printf(seq, "\n %s\n", title);
999                 for (i = 0; i < table->num_nodes; i++) {
1000                         MetricomNode node;
1001
1002                         spin_lock_irqsave(&strip_lock, flags);
1003                         node = table->node[i];
1004                         spin_unlock_irqrestore(&strip_lock, flags);
1005                         seq_printf(seq, "  %s\n", node.c);
1006                 }
1007         } while (table->timestamp.tv_sec != t.tv_sec
1008                  || table->timestamp.tv_usec != t.tv_usec);
1009 }
1010
1011 /*
1012  * This function prints radio status information via the seq_file
1013  * interface.  The interface takes care of buffer size and over
1014  * run issues. 
1015  *
1016  * The buffer in seq_file is PAGESIZE (4K) 
1017  * so this routine should never print more or it will get truncated.
1018  * With the maximum of 32 portables and 32 poletops
1019  * reported, the routine outputs 3107 bytes into the buffer.
1020  */
1021 static void strip_seq_status_info(struct seq_file *seq, 
1022                                   const struct strip *strip_info)
1023 {
1024         char temp[32];
1025         MetricomAddressString addr_string;
1026
1027         /* First, we must copy all of our data to a safe place, */
1028         /* in case a serial interrupt comes in and changes it.  */
1029         int tx_left = strip_info->tx_left;
1030         unsigned long rx_average_pps = strip_info->rx_average_pps;
1031         unsigned long tx_average_pps = strip_info->tx_average_pps;
1032         unsigned long sx_average_pps = strip_info->sx_average_pps;
1033         int working = strip_info->working;
1034         int firmware_level = strip_info->firmware_level;
1035         long watchdog_doprobe = strip_info->watchdog_doprobe;
1036         long watchdog_doreset = strip_info->watchdog_doreset;
1037         long gratuitous_arp = strip_info->gratuitous_arp;
1038         long arp_interval = strip_info->arp_interval;
1039         FirmwareVersion firmware_version = strip_info->firmware_version;
1040         SerialNumber serial_number = strip_info->serial_number;
1041         BatteryVoltage battery_voltage = strip_info->battery_voltage;
1042         char *if_name = strip_info->dev->name;
1043         MetricomAddress true_dev_addr = strip_info->true_dev_addr;
1044         MetricomAddress dev_dev_addr =
1045             *(MetricomAddress *) strip_info->dev->dev_addr;
1046         int manual_dev_addr = strip_info->manual_dev_addr;
1047 #ifdef EXT_COUNTERS
1048         unsigned long rx_bytes = strip_info->rx_bytes;
1049         unsigned long tx_bytes = strip_info->tx_bytes;
1050         unsigned long rx_rbytes = strip_info->rx_rbytes;
1051         unsigned long tx_rbytes = strip_info->tx_rbytes;
1052         unsigned long rx_sbytes = strip_info->rx_sbytes;
1053         unsigned long tx_sbytes = strip_info->tx_sbytes;
1054         unsigned long rx_ebytes = strip_info->rx_ebytes;
1055         unsigned long tx_ebytes = strip_info->tx_ebytes;
1056 #endif
1057
1058         seq_printf(seq, "\nInterface name\t\t%s\n", if_name);
1059         seq_printf(seq, " Radio working:\t\t%s\n", working ? "Yes" : "No");
1060         radio_address_to_string(&true_dev_addr, &addr_string);
1061         seq_printf(seq, " Radio address:\t\t%s\n", addr_string.c);
1062         if (manual_dev_addr) {
1063                 radio_address_to_string(&dev_dev_addr, &addr_string);
1064                 seq_printf(seq, " Device address:\t%s\n", addr_string.c);
1065         }
1066         seq_printf(seq, " Firmware version:\t%s", !working ? "Unknown" :
1067                      !firmware_level ? "Should be upgraded" :
1068                      firmware_version.c);
1069         if (firmware_level >= ChecksummedMessages)
1070                 seq_printf(seq, " (Checksums Enabled)");
1071         seq_printf(seq, "\n");
1072         seq_printf(seq, " Serial number:\t\t%s\n", serial_number.c);
1073         seq_printf(seq, " Battery voltage:\t%s\n", battery_voltage.c);
1074         seq_printf(seq, " Transmit queue (bytes):%d\n", tx_left);
1075         seq_printf(seq, " Receive packet rate:   %ld packets per second\n",
1076                      rx_average_pps / 8);
1077         seq_printf(seq, " Transmit packet rate:  %ld packets per second\n",
1078                      tx_average_pps / 8);
1079         seq_printf(seq, " Sent packet rate:      %ld packets per second\n",
1080                      sx_average_pps / 8);
1081         seq_printf(seq, " Next watchdog probe:\t%s\n",
1082                      time_delta(temp, watchdog_doprobe));
1083         seq_printf(seq, " Next watchdog reset:\t%s\n",
1084                      time_delta(temp, watchdog_doreset));
1085         seq_printf(seq, " Next gratuitous ARP:\t");
1086
1087         if (!memcmp
1088             (strip_info->dev->dev_addr, zero_address.c,
1089              sizeof(zero_address)))
1090                 seq_printf(seq, "Disabled\n");
1091         else {
1092                 seq_printf(seq, "%s\n", time_delta(temp, gratuitous_arp));
1093                 seq_printf(seq, " Next ARP interval:\t%ld seconds\n",
1094                              JIFFIE_TO_SEC(arp_interval));
1095         }
1096
1097         if (working) {
1098 #ifdef EXT_COUNTERS
1099                 seq_printf(seq, "\n");
1100                 seq_printf(seq,
1101                              " Total bytes:         \trx:\t%lu\ttx:\t%lu\n",
1102                              rx_bytes, tx_bytes);
1103                 seq_printf(seq,
1104                              "  thru radio:         \trx:\t%lu\ttx:\t%lu\n",
1105                              rx_rbytes, tx_rbytes);
1106                 seq_printf(seq,
1107                              "  thru serial port:   \trx:\t%lu\ttx:\t%lu\n",
1108                              rx_sbytes, tx_sbytes);
1109                 seq_printf(seq,
1110                              " Total stat/err bytes:\trx:\t%lu\ttx:\t%lu\n",
1111                              rx_ebytes, tx_ebytes);
1112 #endif
1113                 strip_seq_neighbours(seq, &strip_info->poletops,
1114                                         "Poletops:");
1115                 strip_seq_neighbours(seq, &strip_info->portables,
1116                                         "Portables:");
1117         }
1118 }
1119
1120 /*
1121  * This function is exports status information from the STRIP driver through
1122  * the /proc file system.
1123  */
1124 static int strip_seq_show(struct seq_file *seq, void *v)
1125 {
1126         if (v == SEQ_START_TOKEN)
1127                 seq_printf(seq, "strip_version: %s\n", StripVersion);
1128         else
1129                 strip_seq_status_info(seq, (const struct strip *)v);
1130         return 0;
1131 }
1132
1133
1134 static const struct seq_operations strip_seq_ops = {
1135         .start = strip_seq_start,
1136         .next  = strip_seq_next,
1137         .stop  = strip_seq_stop,
1138         .show  = strip_seq_show,
1139 };
1140
1141 static int strip_seq_open(struct inode *inode, struct file *file)
1142 {
1143         return seq_open(file, &strip_seq_ops);
1144 }
1145
1146 static const struct file_operations strip_seq_fops = {
1147         .owner   = THIS_MODULE,
1148         .open    = strip_seq_open,
1149         .read    = seq_read,
1150         .llseek  = seq_lseek,
1151         .release = seq_release,
1152 };
1153 #endif
1154
1155
1156
1157 /************************************************************************/
1158 /* Sending routines                                                     */
1159
1160 static void ResetRadio(struct strip *strip_info)
1161 {
1162         struct tty_struct *tty = strip_info->tty;
1163         static const char init[] = "ate0q1dt**starmode\r**";
1164         StringDescriptor s = { init, sizeof(init) - 1 };
1165
1166         /* 
1167          * If the radio isn't working anymore,
1168          * we should clear the old status information.
1169          */
1170         if (strip_info->working) {
1171                 printk(KERN_INFO "%s: No response: Resetting radio.\n",
1172                        strip_info->dev->name);
1173                 strip_info->firmware_version.c[0] = '\0';
1174                 strip_info->serial_number.c[0] = '\0';
1175                 strip_info->battery_voltage.c[0] = '\0';
1176                 strip_info->portables.num_nodes = 0;
1177                 do_gettimeofday(&strip_info->portables.timestamp);
1178                 strip_info->poletops.num_nodes = 0;
1179                 do_gettimeofday(&strip_info->poletops.timestamp);
1180         }
1181
1182         strip_info->pps_timer = jiffies;
1183         strip_info->rx_pps_count = 0;
1184         strip_info->tx_pps_count = 0;
1185         strip_info->sx_pps_count = 0;
1186         strip_info->rx_average_pps = 0;
1187         strip_info->tx_average_pps = 0;
1188         strip_info->sx_average_pps = 0;
1189
1190         /* Mark radio address as unknown */
1191         *(MetricomAddress *) & strip_info->true_dev_addr = zero_address;
1192         if (!strip_info->manual_dev_addr)
1193                 *(MetricomAddress *) strip_info->dev->dev_addr =
1194                     zero_address;
1195         strip_info->working = FALSE;
1196         strip_info->firmware_level = NoStructure;
1197         strip_info->next_command = CompatibilityCommand;
1198         strip_info->watchdog_doprobe = jiffies + 10 * HZ;
1199         strip_info->watchdog_doreset = jiffies + 1 * HZ;
1200
1201         /* If the user has selected a baud rate above 38.4 see what magic we have to do */
1202         if (strip_info->user_baud > 38400) {
1203                 /*
1204                  * Subtle stuff: Pay attention :-)
1205                  * If the serial port is currently at the user's selected (>38.4) rate,
1206                  * then we temporarily switch to 19.2 and issue the ATS304 command
1207                  * to tell the radio to switch to the user's selected rate.
1208                  * If the serial port is not currently at that rate, that means we just
1209                  * issued the ATS304 command last time through, so this time we restore
1210                  * the user's selected rate and issue the normal starmode reset string.
1211                  */
1212                 if (strip_info->user_baud == tty_get_baud_rate(tty)) {
1213                         static const char b0[] = "ate0q1s304=57600\r";
1214                         static const char b1[] = "ate0q1s304=115200\r";
1215                         static const StringDescriptor baudstring[2] =
1216                             { {b0, sizeof(b0) - 1}
1217                         , {b1, sizeof(b1) - 1}
1218                         };
1219                         set_baud(tty, 19200);
1220                         if (strip_info->user_baud == 57600)
1221                                 s = baudstring[0];
1222                         else if (strip_info->user_baud == 115200)
1223                                 s = baudstring[1];
1224                         else
1225                                 s = baudstring[1];      /* For now */
1226                 } else
1227                         set_baud(tty, strip_info->user_baud);
1228         }
1229
1230         tty->ops->write(tty, s.string, s.length);
1231 #ifdef EXT_COUNTERS
1232         strip_info->tx_ebytes += s.length;
1233 #endif
1234 }
1235
1236 /*
1237  * Called by the driver when there's room for more data.  If we have
1238  * more packets to send, we send them here.
1239  */
1240
1241 static void strip_write_some_more(struct tty_struct *tty)
1242 {
1243         struct strip *strip_info = tty->disc_data;
1244
1245         /* First make sure we're connected. */
1246         if (!strip_info || strip_info->magic != STRIP_MAGIC ||
1247             !netif_running(strip_info->dev))
1248                 return;
1249
1250         if (strip_info->tx_left > 0) {
1251                 int num_written =
1252                     tty->ops->write(tty, strip_info->tx_head,
1253                                       strip_info->tx_left);
1254                 strip_info->tx_left -= num_written;
1255                 strip_info->tx_head += num_written;
1256 #ifdef EXT_COUNTERS
1257                 strip_info->tx_sbytes += num_written;
1258 #endif
1259         } else {                /* Else start transmission of another packet */
1260
1261                 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
1262                 strip_unlock(strip_info);
1263         }
1264 }
1265
1266 static __u8 *add_checksum(__u8 * buffer, __u8 * end)
1267 {
1268         __u16 sum = 0;
1269         __u8 *p = buffer;
1270         while (p < end)
1271                 sum += *p++;
1272         end[3] = hextable[sum & 0xF];
1273         sum >>= 4;
1274         end[2] = hextable[sum & 0xF];
1275         sum >>= 4;
1276         end[1] = hextable[sum & 0xF];
1277         sum >>= 4;
1278         end[0] = hextable[sum & 0xF];
1279         return (end + 4);
1280 }
1281
1282 static unsigned char *strip_make_packet(unsigned char *buffer,
1283                                         struct strip *strip_info,
1284                                         struct sk_buff *skb)
1285 {
1286         __u8 *ptr = buffer;
1287         __u8 *stuffstate = NULL;
1288         STRIP_Header *header = (STRIP_Header *) skb->data;
1289         MetricomAddress haddr = header->dst_addr;
1290         int len = skb->len - sizeof(STRIP_Header);
1291         MetricomKey key;
1292
1293         /*HexDump("strip_make_packet", strip_info, skb->data, skb->data + skb->len); */
1294
1295         if (header->protocol == htons(ETH_P_IP))
1296                 key = SIP0Key;
1297         else if (header->protocol == htons(ETH_P_ARP))
1298                 key = ARP0Key;
1299         else {
1300                 printk(KERN_ERR
1301                        "%s: strip_make_packet: Unknown packet type 0x%04X\n",
1302                        strip_info->dev->name, ntohs(header->protocol));
1303                 return (NULL);
1304         }
1305
1306         if (len > strip_info->mtu) {
1307                 printk(KERN_ERR
1308                        "%s: Dropping oversized transmit packet: %d bytes\n",
1309                        strip_info->dev->name, len);
1310                 return (NULL);
1311         }
1312
1313         /*
1314          * If we're sending to ourselves, discard the packet.
1315          * (Metricom radios choke if they try to send a packet to their own address.)
1316          */
1317         if (!memcmp(haddr.c, strip_info->true_dev_addr.c, sizeof(haddr))) {
1318                 printk(KERN_ERR "%s: Dropping packet addressed to self\n",
1319                        strip_info->dev->name);
1320                 return (NULL);
1321         }
1322
1323         /*
1324          * If this is a broadcast packet, send it to our designated Metricom
1325          * 'broadcast hub' radio (First byte of address being 0xFF means broadcast)
1326          */
1327         if (haddr.c[0] == 0xFF) {
1328                 __be32 brd = 0;
1329                 struct in_device *in_dev;
1330
1331                 rcu_read_lock();
1332                 in_dev = __in_dev_get_rcu(strip_info->dev);
1333                 if (in_dev == NULL) {
1334                         rcu_read_unlock();
1335                         return NULL;
1336                 }
1337                 if (in_dev->ifa_list)
1338                         brd = in_dev->ifa_list->ifa_broadcast;
1339                 rcu_read_unlock();
1340
1341                 /* arp_query returns 1 if it succeeds in looking up the address, 0 if it fails */
1342                 if (!arp_query(haddr.c, brd, strip_info->dev)) {
1343                         printk(KERN_ERR
1344                                "%s: Unable to send packet (no broadcast hub configured)\n",
1345                                strip_info->dev->name);
1346                         return (NULL);
1347                 }
1348                 /*
1349                  * If we are the broadcast hub, don't bother sending to ourselves.
1350                  * (Metricom radios choke if they try to send a packet to their own address.)
1351                  */
1352                 if (!memcmp
1353                     (haddr.c, strip_info->true_dev_addr.c, sizeof(haddr)))
1354                         return (NULL);
1355         }
1356
1357         *ptr++ = 0x0D;
1358         *ptr++ = '*';
1359         *ptr++ = hextable[haddr.c[2] >> 4];
1360         *ptr++ = hextable[haddr.c[2] & 0xF];
1361         *ptr++ = hextable[haddr.c[3] >> 4];
1362         *ptr++ = hextable[haddr.c[3] & 0xF];
1363         *ptr++ = '-';
1364         *ptr++ = hextable[haddr.c[4] >> 4];
1365         *ptr++ = hextable[haddr.c[4] & 0xF];
1366         *ptr++ = hextable[haddr.c[5] >> 4];
1367         *ptr++ = hextable[haddr.c[5] & 0xF];
1368         *ptr++ = '*';
1369         *ptr++ = key.c[0];
1370         *ptr++ = key.c[1];
1371         *ptr++ = key.c[2];
1372         *ptr++ = key.c[3];
1373
1374         ptr =
1375             StuffData(skb->data + sizeof(STRIP_Header), len, ptr,
1376                       &stuffstate);
1377
1378         if (strip_info->firmware_level >= ChecksummedMessages)
1379                 ptr = add_checksum(buffer + 1, ptr);
1380
1381         *ptr++ = 0x0D;
1382         return (ptr);
1383 }
1384
1385 static void strip_send(struct strip *strip_info, struct sk_buff *skb)
1386 {
1387         MetricomAddress haddr;
1388         unsigned char *ptr = strip_info->tx_buff;
1389         int doreset = (long) jiffies - strip_info->watchdog_doreset >= 0;
1390         int doprobe = (long) jiffies - strip_info->watchdog_doprobe >= 0
1391             && !doreset;
1392         __be32 addr, brd;
1393
1394         /*
1395          * 1. If we have a packet, encapsulate it and put it in the buffer
1396          */
1397         if (skb) {
1398                 char *newptr = strip_make_packet(ptr, strip_info, skb);
1399                 strip_info->tx_pps_count++;
1400                 if (!newptr)
1401                         strip_info->tx_dropped++;
1402                 else {
1403                         ptr = newptr;
1404                         strip_info->sx_pps_count++;
1405                         strip_info->tx_packets++;       /* Count another successful packet */
1406 #ifdef EXT_COUNTERS
1407                         strip_info->tx_bytes += skb->len;
1408                         strip_info->tx_rbytes += ptr - strip_info->tx_buff;
1409 #endif
1410                         /*DumpData("Sending:", strip_info, strip_info->tx_buff, ptr); */
1411                         /*HexDump("Sending", strip_info, strip_info->tx_buff, ptr); */
1412                 }
1413         }
1414
1415         /*
1416          * 2. If it is time for another tickle, tack it on, after the packet
1417          */
1418         if (doprobe) {
1419                 StringDescriptor ts = CommandString[strip_info->next_command];
1420 #if TICKLE_TIMERS
1421                 {
1422                         struct timeval tv;
1423                         do_gettimeofday(&tv);
1424                         printk(KERN_INFO "**** Sending tickle string %d      at %02d.%06d\n",
1425                                strip_info->next_command, tv.tv_sec % 100,
1426                                tv.tv_usec);
1427                 }
1428 #endif
1429                 if (ptr == strip_info->tx_buff)
1430                         *ptr++ = 0x0D;
1431
1432                 *ptr++ = '*';   /* First send "**" to provoke an error message */
1433                 *ptr++ = '*';
1434
1435                 /* Then add the command */
1436                 memcpy(ptr, ts.string, ts.length);
1437
1438                 /* Add a checksum ? */
1439                 if (strip_info->firmware_level < ChecksummedMessages)
1440                         ptr += ts.length;
1441                 else
1442                         ptr = add_checksum(ptr, ptr + ts.length);
1443
1444                 *ptr++ = 0x0D;  /* Terminate the command with a <CR> */
1445
1446                 /* Cycle to next periodic command? */
1447                 if (strip_info->firmware_level >= StructuredMessages)
1448                         if (++strip_info->next_command >=
1449                             ARRAY_SIZE(CommandString))
1450                                 strip_info->next_command = 0;
1451 #ifdef EXT_COUNTERS
1452                 strip_info->tx_ebytes += ts.length;
1453 #endif
1454                 strip_info->watchdog_doprobe = jiffies + 10 * HZ;
1455                 strip_info->watchdog_doreset = jiffies + 1 * HZ;
1456                 /*printk(KERN_INFO "%s: Routine radio test.\n", strip_info->dev->name); */
1457         }
1458
1459         /*
1460          * 3. Set up the strip_info ready to send the data (if any).
1461          */
1462         strip_info->tx_head = strip_info->tx_buff;
1463         strip_info->tx_left = ptr - strip_info->tx_buff;
1464         set_bit(TTY_DO_WRITE_WAKEUP, &strip_info->tty->flags);
1465         /*
1466          * 4. Debugging check to make sure we're not overflowing the buffer.
1467          */
1468         if (strip_info->tx_size - strip_info->tx_left < 20)
1469                 printk(KERN_ERR "%s: Sending%5d bytes;%5d bytes free.\n",
1470                        strip_info->dev->name, strip_info->tx_left,
1471                        strip_info->tx_size - strip_info->tx_left);
1472
1473         /*
1474          * 5. If watchdog has expired, reset the radio. Note: if there's data waiting in
1475          * the buffer, strip_write_some_more will send it after the reset has finished
1476          */
1477         if (doreset) {
1478                 ResetRadio(strip_info);
1479                 return;
1480         }
1481
1482         if (1) {
1483                 struct in_device *in_dev;
1484
1485                 brd = addr = 0;
1486                 rcu_read_lock();
1487                 in_dev = __in_dev_get_rcu(strip_info->dev);
1488                 if (in_dev) {
1489                         if (in_dev->ifa_list) {
1490                                 brd = in_dev->ifa_list->ifa_broadcast;
1491                                 addr = in_dev->ifa_list->ifa_local;
1492                         }
1493                 }
1494                 rcu_read_unlock();
1495         }
1496
1497
1498         /*
1499          * 6. If it is time for a periodic ARP, queue one up to be sent.
1500          * We only do this if:
1501          *  1. The radio is working
1502          *  2. It's time to send another periodic ARP
1503          *  3. We really know what our address is (and it is not manually set to zero)
1504          *  4. We have a designated broadcast address configured
1505          * If we queue up an ARP packet when we don't have a designated broadcast
1506          * address configured, then the packet will just have to be discarded in
1507          * strip_make_packet. This is not fatal, but it causes misleading information
1508          * to be displayed in tcpdump. tcpdump will report that periodic APRs are
1509          * being sent, when in fact they are not, because they are all being dropped
1510          * in the strip_make_packet routine.
1511          */
1512         if (strip_info->working
1513             && (long) jiffies - strip_info->gratuitous_arp >= 0
1514             && memcmp(strip_info->dev->dev_addr, zero_address.c,
1515                       sizeof(zero_address))
1516             && arp_query(haddr.c, brd, strip_info->dev)) {
1517                 /*printk(KERN_INFO "%s: Sending gratuitous ARP with interval %ld\n",
1518                    strip_info->dev->name, strip_info->arp_interval / HZ); */
1519                 strip_info->gratuitous_arp =
1520                     jiffies + strip_info->arp_interval;
1521                 strip_info->arp_interval *= 2;
1522                 if (strip_info->arp_interval > MaxARPInterval)
1523                         strip_info->arp_interval = MaxARPInterval;
1524                 if (addr)
1525                         arp_send(ARPOP_REPLY, ETH_P_ARP, addr,  /* Target address of ARP packet is our address */
1526                                  strip_info->dev,       /* Device to send packet on */
1527                                  addr,  /* Source IP address this ARP packet comes from */
1528                                  NULL,  /* Destination HW address is NULL (broadcast it) */
1529                                  strip_info->dev->dev_addr,     /* Source HW address is our HW address */
1530                                  strip_info->dev->dev_addr);    /* Target HW address is our HW address (redundant) */
1531         }
1532
1533         /*
1534          * 7. All ready. Start the transmission
1535          */
1536         strip_write_some_more(strip_info->tty);
1537 }
1538
1539 /* Encapsulate a datagram and kick it into a TTY queue. */
1540 static int strip_xmit(struct sk_buff *skb, struct net_device *dev)
1541 {
1542         struct strip *strip_info = netdev_priv(dev);
1543         unsigned long flags;
1544
1545         if (!netif_running(dev)) {
1546                 printk(KERN_ERR "%s: xmit call when iface is down\n",
1547                        dev->name);
1548                 return NETDEV_TX_BUSY;
1549         }
1550
1551         netif_stop_queue(dev);
1552
1553         del_timer(&strip_info->idle_timer);
1554
1555
1556         if (time_after(jiffies, strip_info->pps_timer + HZ)) {
1557                 unsigned long t = jiffies - strip_info->pps_timer;
1558                 unsigned long rx_pps_count = (strip_info->rx_pps_count * HZ * 8 + t / 2) / t;
1559                 unsigned long tx_pps_count = (strip_info->tx_pps_count * HZ * 8 + t / 2) / t;
1560                 unsigned long sx_pps_count = (strip_info->sx_pps_count * HZ * 8 + t / 2) / t;
1561
1562                 strip_info->pps_timer = jiffies;
1563                 strip_info->rx_pps_count = 0;
1564                 strip_info->tx_pps_count = 0;
1565                 strip_info->sx_pps_count = 0;
1566
1567                 strip_info->rx_average_pps = (strip_info->rx_average_pps + rx_pps_count + 1) / 2;
1568                 strip_info->tx_average_pps = (strip_info->tx_average_pps + tx_pps_count + 1) / 2;
1569                 strip_info->sx_average_pps = (strip_info->sx_average_pps + sx_pps_count + 1) / 2;
1570
1571                 if (rx_pps_count / 8 >= 10)
1572                         printk(KERN_INFO "%s: WARNING: Receiving %ld packets per second.\n",
1573                                strip_info->dev->name, rx_pps_count / 8);
1574                 if (tx_pps_count / 8 >= 10)
1575                         printk(KERN_INFO "%s: WARNING: Tx        %ld packets per second.\n",
1576                                strip_info->dev->name, tx_pps_count / 8);
1577                 if (sx_pps_count / 8 >= 10)
1578                         printk(KERN_INFO "%s: WARNING: Sending   %ld packets per second.\n",
1579                                strip_info->dev->name, sx_pps_count / 8);
1580         }
1581
1582         spin_lock_irqsave(&strip_lock, flags);
1583
1584         strip_send(strip_info, skb);
1585
1586         spin_unlock_irqrestore(&strip_lock, flags);
1587
1588         if (skb)
1589                 dev_kfree_skb(skb);
1590         return 0;
1591 }
1592
1593 /*
1594  * IdleTask periodically calls strip_xmit, so even when we have no IP packets
1595  * to send for an extended period of time, the watchdog processing still gets
1596  * done to ensure that the radio stays in Starmode
1597  */
1598
1599 static void strip_IdleTask(unsigned long parameter)
1600 {
1601         strip_xmit(NULL, (struct net_device *) parameter);
1602 }
1603
1604 /*
1605  * Create the MAC header for an arbitrary protocol layer
1606  *
1607  * saddr!=NULL        means use this specific address (n/a for Metricom)
1608  * saddr==NULL        means use default device source address
1609  * daddr!=NULL        means use this destination address
1610  * daddr==NULL        means leave destination address alone
1611  *                 (e.g. unresolved arp -- kernel will call
1612  *                 rebuild_header later to fill in the address)
1613  */
1614
1615 static int strip_header(struct sk_buff *skb, struct net_device *dev,
1616                         unsigned short type, const void *daddr,
1617                         const void *saddr, unsigned len)
1618 {
1619         struct strip *strip_info = netdev_priv(dev);
1620         STRIP_Header *header = (STRIP_Header *) skb_push(skb, sizeof(STRIP_Header));
1621
1622         /*printk(KERN_INFO "%s: strip_header 0x%04X %s\n", dev->name, type,
1623            type == ETH_P_IP ? "IP" : type == ETH_P_ARP ? "ARP" : ""); */
1624
1625         header->src_addr = strip_info->true_dev_addr;
1626         header->protocol = htons(type);
1627
1628         /*HexDump("strip_header", netdev_priv(dev), skb->data, skb->data + skb->len); */
1629
1630         if (!daddr)
1631                 return (-dev->hard_header_len);
1632
1633         header->dst_addr = *(MetricomAddress *) daddr;
1634         return (dev->hard_header_len);
1635 }
1636
1637 /*
1638  * Rebuild the MAC header. This is called after an ARP
1639  * (or in future other address resolution) has completed on this
1640  * sk_buff. We now let ARP fill in the other fields.
1641  * I think this should return zero if packet is ready to send,
1642  * or non-zero if it needs more time to do an address lookup
1643  */
1644
1645 static int strip_rebuild_header(struct sk_buff *skb)
1646 {
1647 #ifdef CONFIG_INET
1648         STRIP_Header *header = (STRIP_Header *) skb->data;
1649
1650         /* Arp find returns zero if if knows the address, */
1651         /* or if it doesn't know the address it sends an ARP packet and returns non-zero */
1652         return arp_find(header->dst_addr.c, skb) ? 1 : 0;
1653 #else
1654         return 0;
1655 #endif
1656 }
1657
1658
1659 /************************************************************************/
1660 /* Receiving routines                                                   */
1661
1662 /*
1663  * This function parses the response to the ATS300? command,
1664  * extracting the radio version and serial number.
1665  */
1666 static void get_radio_version(struct strip *strip_info, __u8 * ptr, __u8 * end)
1667 {
1668         __u8 *p, *value_begin, *value_end;
1669         int len;
1670
1671         /* Determine the beginning of the second line of the payload */
1672         p = ptr;
1673         while (p < end && *p != 10)
1674                 p++;
1675         if (p >= end)
1676                 return;
1677         p++;
1678         value_begin = p;
1679
1680         /* Determine the end of line */
1681         while (p < end && *p != 10)
1682                 p++;
1683         if (p >= end)
1684                 return;
1685         value_end = p;
1686         p++;
1687
1688         len = value_end - value_begin;
1689         len = min_t(int, len, sizeof(FirmwareVersion) - 1);
1690         if (strip_info->firmware_version.c[0] == 0)
1691                 printk(KERN_INFO "%s: Radio Firmware: %.*s\n",
1692                        strip_info->dev->name, len, value_begin);
1693         sprintf(strip_info->firmware_version.c, "%.*s", len, value_begin);
1694
1695         /* Look for the first colon */
1696         while (p < end && *p != ':')
1697                 p++;
1698         if (p >= end)
1699                 return;
1700         /* Skip over the space */
1701         p += 2;
1702         len = sizeof(SerialNumber) - 1;
1703         if (p + len <= end) {
1704                 sprintf(strip_info->serial_number.c, "%.*s", len, p);
1705         } else {
1706                 printk(KERN_DEBUG
1707                        "STRIP: radio serial number shorter (%zd) than expected (%d)\n",
1708                        end - p, len);
1709         }
1710 }
1711
1712 /*
1713  * This function parses the response to the ATS325? command,
1714  * extracting the radio battery voltage.
1715  */
1716 static void get_radio_voltage(struct strip *strip_info, __u8 * ptr, __u8 * end)
1717 {
1718         int len;
1719
1720         len = sizeof(BatteryVoltage) - 1;
1721         if (ptr + len <= end) {
1722                 sprintf(strip_info->battery_voltage.c, "%.*s", len, ptr);
1723         } else {
1724                 printk(KERN_DEBUG
1725                        "STRIP: radio voltage string shorter (%zd) than expected (%d)\n",
1726                        end - ptr, len);
1727         }
1728 }
1729
1730 /*
1731  * This function parses the responses to the AT~LA and ATS311 commands,
1732  * which list the radio's neighbours.
1733  */
1734 static void get_radio_neighbours(MetricomNodeTable * table, __u8 * ptr, __u8 * end)
1735 {
1736         table->num_nodes = 0;
1737         while (ptr < end && table->num_nodes < NODE_TABLE_SIZE) {
1738                 MetricomNode *node = &table->node[table->num_nodes++];
1739                 char *dst = node->c, *limit = dst + sizeof(*node) - 1;
1740                 while (ptr < end && *ptr <= 32)
1741                         ptr++;
1742                 while (ptr < end && dst < limit && *ptr != 10)
1743                         *dst++ = *ptr++;
1744                 *dst++ = 0;
1745                 while (ptr < end && ptr[-1] != 10)
1746                         ptr++;
1747         }
1748         do_gettimeofday(&table->timestamp);
1749 }
1750
1751 static int get_radio_address(struct strip *strip_info, __u8 * p)
1752 {
1753         MetricomAddress addr;
1754
1755         if (string_to_radio_address(&addr, p))
1756                 return (1);
1757
1758         /* See if our radio address has changed */
1759         if (memcmp(strip_info->true_dev_addr.c, addr.c, sizeof(addr))) {
1760                 MetricomAddressString addr_string;
1761                 radio_address_to_string(&addr, &addr_string);
1762                 printk(KERN_INFO "%s: Radio address = %s\n",
1763                        strip_info->dev->name, addr_string.c);
1764                 strip_info->true_dev_addr = addr;
1765                 if (!strip_info->manual_dev_addr)
1766                         *(MetricomAddress *) strip_info->dev->dev_addr =
1767                             addr;
1768                 /* Give the radio a few seconds to get its head straight, then send an arp */
1769                 strip_info->gratuitous_arp = jiffies + 15 * HZ;
1770                 strip_info->arp_interval = 1 * HZ;
1771         }
1772         return (0);
1773 }
1774
1775 static int verify_checksum(struct strip *strip_info)
1776 {
1777         __u8 *p = strip_info->sx_buff;
1778         __u8 *end = strip_info->sx_buff + strip_info->sx_count - 4;
1779         u_short sum =
1780             (READHEX16(end[0]) << 12) | (READHEX16(end[1]) << 8) |
1781             (READHEX16(end[2]) << 4) | (READHEX16(end[3]));
1782         while (p < end)
1783                 sum -= *p++;
1784         if (sum == 0 && strip_info->firmware_level == StructuredMessages) {
1785                 strip_info->firmware_level = ChecksummedMessages;
1786                 printk(KERN_INFO "%s: Radio provides message checksums\n",
1787                        strip_info->dev->name);
1788         }
1789         return (sum == 0);
1790 }
1791
1792 static void RecvErr(char *msg, struct strip *strip_info)
1793 {
1794         __u8 *ptr = strip_info->sx_buff;
1795         __u8 *end = strip_info->sx_buff + strip_info->sx_count;
1796         DumpData(msg, strip_info, ptr, end);
1797         strip_info->rx_errors++;
1798 }
1799
1800 static void RecvErr_Message(struct strip *strip_info, __u8 * sendername,
1801                             const __u8 * msg, u_long len)
1802 {
1803         if (has_prefix(msg, len, "001")) {      /* Not in StarMode! */
1804                 RecvErr("Error Msg:", strip_info);
1805                 printk(KERN_INFO "%s: Radio %s is not in StarMode\n",
1806                        strip_info->dev->name, sendername);
1807         }
1808
1809         else if (has_prefix(msg, len, "002")) { /* Remap handle */
1810                 /* We ignore "Remap handle" messages for now */
1811         }
1812
1813         else if (has_prefix(msg, len, "003")) { /* Can't resolve name */
1814                 RecvErr("Error Msg:", strip_info);
1815                 printk(KERN_INFO "%s: Destination radio name is unknown\n",
1816                        strip_info->dev->name);
1817         }
1818
1819         else if (has_prefix(msg, len, "004")) { /* Name too small or missing */
1820                 strip_info->watchdog_doreset = jiffies + LongTime;
1821 #if TICKLE_TIMERS
1822                 {
1823                         struct timeval tv;
1824                         do_gettimeofday(&tv);
1825                         printk(KERN_INFO
1826                                "**** Got ERR_004 response         at %02d.%06d\n",
1827                                tv.tv_sec % 100, tv.tv_usec);
1828                 }
1829 #endif
1830                 if (!strip_info->working) {
1831                         strip_info->working = TRUE;
1832                         printk(KERN_INFO "%s: Radio now in starmode\n",
1833                                strip_info->dev->name);
1834                         /*
1835                          * If the radio has just entered a working state, we should do our first
1836                          * probe ASAP, so that we find out our radio address etc. without delay.
1837                          */
1838                         strip_info->watchdog_doprobe = jiffies;
1839                 }
1840                 if (strip_info->firmware_level == NoStructure && sendername) {
1841                         strip_info->firmware_level = StructuredMessages;
1842                         strip_info->next_command = 0;   /* Try to enable checksums ASAP */
1843                         printk(KERN_INFO
1844                                "%s: Radio provides structured messages\n",
1845                                strip_info->dev->name);
1846                 }
1847                 if (strip_info->firmware_level >= StructuredMessages) {
1848                         /*
1849                          * If this message has a valid checksum on the end, then the call to verify_checksum
1850                          * will elevate the firmware_level to ChecksummedMessages for us. (The actual return
1851                          * code from verify_checksum is ignored here.)
1852                          */
1853                         verify_checksum(strip_info);
1854                         /*
1855                          * If the radio has structured messages but we don't yet have all our information about it,
1856                          * we should do probes without delay, until we have gathered all the information
1857                          */
1858                         if (!GOT_ALL_RADIO_INFO(strip_info))
1859                                 strip_info->watchdog_doprobe = jiffies;
1860                 }
1861         }
1862
1863         else if (has_prefix(msg, len, "005"))   /* Bad count specification */
1864                 RecvErr("Error Msg:", strip_info);
1865
1866         else if (has_prefix(msg, len, "006"))   /* Header too big */
1867                 RecvErr("Error Msg:", strip_info);
1868
1869         else if (has_prefix(msg, len, "007")) { /* Body too big */
1870                 RecvErr("Error Msg:", strip_info);
1871                 printk(KERN_ERR
1872                        "%s: Error! Packet size too big for radio.\n",
1873                        strip_info->dev->name);
1874         }
1875
1876         else if (has_prefix(msg, len, "008")) { /* Bad character in name */
1877                 RecvErr("Error Msg:", strip_info);
1878                 printk(KERN_ERR
1879                        "%s: Radio name contains illegal character\n",
1880                        strip_info->dev->name);
1881         }
1882
1883         else if (has_prefix(msg, len, "009"))   /* No count or line terminator */
1884                 RecvErr("Error Msg:", strip_info);
1885
1886         else if (has_prefix(msg, len, "010"))   /* Invalid checksum */
1887                 RecvErr("Error Msg:", strip_info);
1888
1889         else if (has_prefix(msg, len, "011"))   /* Checksum didn't match */
1890                 RecvErr("Error Msg:", strip_info);
1891
1892         else if (has_prefix(msg, len, "012"))   /* Failed to transmit packet */
1893                 RecvErr("Error Msg:", strip_info);
1894
1895         else
1896                 RecvErr("Error Msg:", strip_info);
1897 }
1898
1899 static void process_AT_response(struct strip *strip_info, __u8 * ptr,
1900                                 __u8 * end)
1901 {
1902         u_long len;
1903         __u8 *p = ptr;
1904         while (p < end && p[-1] != 10)
1905                 p++;            /* Skip past first newline character */
1906         /* Now ptr points to the AT command, and p points to the text of the response. */
1907         len = p - ptr;
1908
1909 #if TICKLE_TIMERS
1910         {
1911                 struct timeval tv;
1912                 do_gettimeofday(&tv);
1913                 printk(KERN_INFO "**** Got AT response %.7s      at %02d.%06d\n",
1914                        ptr, tv.tv_sec % 100, tv.tv_usec);
1915         }
1916 #endif
1917
1918         if (has_prefix(ptr, len, "ATS300?"))
1919                 get_radio_version(strip_info, p, end);
1920         else if (has_prefix(ptr, len, "ATS305?"))
1921                 get_radio_address(strip_info, p);
1922         else if (has_prefix(ptr, len, "ATS311?"))
1923                 get_radio_neighbours(&strip_info->poletops, p, end);
1924         else if (has_prefix(ptr, len, "ATS319=7"))
1925                 verify_checksum(strip_info);
1926         else if (has_prefix(ptr, len, "ATS325?"))
1927                 get_radio_voltage(strip_info, p, end);
1928         else if (has_prefix(ptr, len, "AT~LA"))
1929                 get_radio_neighbours(&strip_info->portables, p, end);
1930         else
1931                 RecvErr("Unknown AT Response:", strip_info);
1932 }
1933
1934 static void process_ACK(struct strip *strip_info, __u8 * ptr, __u8 * end)
1935 {
1936         /* Currently we don't do anything with ACKs from the radio */
1937 }
1938
1939 static void process_Info(struct strip *strip_info, __u8 * ptr, __u8 * end)
1940 {
1941         if (ptr + 16 > end)
1942                 RecvErr("Bad Info Msg:", strip_info);
1943 }
1944
1945 static struct net_device *get_strip_dev(struct strip *strip_info)
1946 {
1947         /* If our hardware address is *manually set* to zero, and we know our */
1948         /* real radio hardware address, try to find another strip device that has been */
1949         /* manually set to that address that we can 'transfer ownership' of this packet to  */
1950         if (strip_info->manual_dev_addr &&
1951             !memcmp(strip_info->dev->dev_addr, zero_address.c,
1952                     sizeof(zero_address))
1953             && memcmp(&strip_info->true_dev_addr, zero_address.c,
1954                       sizeof(zero_address))) {
1955                 struct net_device *dev;
1956                 read_lock_bh(&dev_base_lock);
1957                 for_each_netdev(&init_net, dev) {
1958                         if (dev->type == strip_info->dev->type &&
1959                             !memcmp(dev->dev_addr,
1960                                     &strip_info->true_dev_addr,
1961                                     sizeof(MetricomAddress))) {
1962                                 printk(KERN_INFO
1963                                        "%s: Transferred packet ownership to %s.\n",
1964                                        strip_info->dev->name, dev->name);
1965                                 read_unlock_bh(&dev_base_lock);
1966                                 return (dev);
1967                         }
1968                 }
1969                 read_unlock_bh(&dev_base_lock);
1970         }
1971         return (strip_info->dev);
1972 }
1973
1974 /*
1975  * Send one completely decapsulated datagram to the next layer.
1976  */
1977
1978 static void deliver_packet(struct strip *strip_info, STRIP_Header * header,
1979                            __u16 packetlen)
1980 {
1981         struct sk_buff *skb = dev_alloc_skb(sizeof(STRIP_Header) + packetlen);
1982         if (!skb) {
1983                 printk(KERN_ERR "%s: memory squeeze, dropping packet.\n",
1984                        strip_info->dev->name);
1985                 strip_info->rx_dropped++;
1986         } else {
1987                 memcpy(skb_put(skb, sizeof(STRIP_Header)), header,
1988                        sizeof(STRIP_Header));
1989                 memcpy(skb_put(skb, packetlen), strip_info->rx_buff,
1990                        packetlen);
1991                 skb->dev = get_strip_dev(strip_info);
1992                 skb->protocol = header->protocol;
1993                 skb_reset_mac_header(skb);
1994
1995                 /* Having put a fake header on the front of the sk_buff for the */
1996                 /* benefit of tools like tcpdump, skb_pull now 'consumes' that  */
1997                 /* fake header before we hand the packet up to the next layer.  */
1998                 skb_pull(skb, sizeof(STRIP_Header));
1999
2000                 /* Finally, hand the packet up to the next layer (e.g. IP or ARP, etc.) */
2001                 strip_info->rx_packets++;
2002                 strip_info->rx_pps_count++;
2003 #ifdef EXT_COUNTERS
2004                 strip_info->rx_bytes += packetlen;
2005 #endif
2006                 netif_rx(skb);
2007         }
2008 }
2009
2010 static void process_IP_packet(struct strip *strip_info,
2011                               STRIP_Header * header, __u8 * ptr,
2012                               __u8 * end)
2013 {
2014         __u16 packetlen;
2015
2016         /* Decode start of the IP packet header */
2017         ptr = UnStuffData(ptr, end, strip_info->rx_buff, 4);
2018         if (!ptr) {
2019                 RecvErr("IP Packet too short", strip_info);
2020                 return;
2021         }
2022
2023         packetlen = ((__u16) strip_info->rx_buff[2] << 8) | strip_info->rx_buff[3];
2024
2025         if (packetlen > MAX_RECV_MTU) {
2026                 printk(KERN_INFO "%s: Dropping oversized received IP packet: %d bytes\n",
2027                        strip_info->dev->name, packetlen);
2028                 strip_info->rx_dropped++;
2029                 return;
2030         }
2031
2032         /*printk(KERN_INFO "%s: Got %d byte IP packet\n", strip_info->dev->name, packetlen); */
2033
2034         /* Decode remainder of the IP packet */
2035         ptr =
2036             UnStuffData(ptr, end, strip_info->rx_buff + 4, packetlen - 4);
2037         if (!ptr) {
2038                 RecvErr("IP Packet too short", strip_info);
2039                 return;
2040         }
2041
2042         if (ptr < end) {
2043                 RecvErr("IP Packet too long", strip_info);
2044                 return;
2045         }
2046
2047         header->protocol = htons(ETH_P_IP);
2048
2049         deliver_packet(strip_info, header, packetlen);
2050 }
2051
2052 static void process_ARP_packet(struct strip *strip_info,
2053                                STRIP_Header * header, __u8 * ptr,
2054                                __u8 * end)
2055 {
2056         __u16 packetlen;
2057         struct arphdr *arphdr = (struct arphdr *) strip_info->rx_buff;
2058
2059         /* Decode start of the ARP packet */
2060         ptr = UnStuffData(ptr, end, strip_info->rx_buff, 8);
2061         if (!ptr) {
2062                 RecvErr("ARP Packet too short", strip_info);
2063                 return;
2064         }
2065
2066         packetlen = 8 + (arphdr->ar_hln + arphdr->ar_pln) * 2;
2067
2068         if (packetlen > MAX_RECV_MTU) {
2069                 printk(KERN_INFO
2070                        "%s: Dropping oversized received ARP packet: %d bytes\n",
2071                        strip_info->dev->name, packetlen);
2072                 strip_info->rx_dropped++;
2073                 return;
2074         }
2075
2076         /*printk(KERN_INFO "%s: Got %d byte ARP %s\n",
2077            strip_info->dev->name, packetlen,
2078            ntohs(arphdr->ar_op) == ARPOP_REQUEST ? "request" : "reply"); */
2079
2080         /* Decode remainder of the ARP packet */
2081         ptr =
2082             UnStuffData(ptr, end, strip_info->rx_buff + 8, packetlen - 8);
2083         if (!ptr) {
2084                 RecvErr("ARP Packet too short", strip_info);
2085                 return;
2086         }
2087
2088         if (ptr < end) {
2089                 RecvErr("ARP Packet too long", strip_info);
2090                 return;
2091         }
2092
2093         header->protocol = htons(ETH_P_ARP);
2094
2095         deliver_packet(strip_info, header, packetlen);
2096 }
2097
2098 /*
2099  * process_text_message processes a <CR>-terminated block of data received
2100  * from the radio that doesn't begin with a '*' character. All normal
2101  * Starmode communication messages with the radio begin with a '*',
2102  * so any text that does not indicates a serial port error, a radio that
2103  * is in Hayes command mode instead of Starmode, or a radio with really
2104  * old firmware that doesn't frame its Starmode responses properly.
2105  */
2106 static void process_text_message(struct strip *strip_info)
2107 {
2108         __u8 *msg = strip_info->sx_buff;
2109         int len = strip_info->sx_count;
2110
2111         /* Check for anything that looks like it might be our radio name */
2112         /* (This is here for backwards compatibility with old firmware)  */
2113         if (len == 9 && get_radio_address(strip_info, msg) == 0)
2114                 return;
2115
2116         if (text_equal(msg, len, "OK"))
2117                 return;         /* Ignore 'OK' responses from prior commands */
2118         if (text_equal(msg, len, "ERROR"))
2119                 return;         /* Ignore 'ERROR' messages */
2120         if (has_prefix(msg, len, "ate0q1"))
2121                 return;         /* Ignore character echo back from the radio */
2122
2123         /* Catch other error messages */
2124         /* (This is here for backwards compatibility with old firmware) */
2125         if (has_prefix(msg, len, "ERR_")) {
2126                 RecvErr_Message(strip_info, NULL, &msg[4], len - 4);
2127                 return;
2128         }
2129
2130         RecvErr("No initial *", strip_info);
2131 }
2132
2133 /*
2134  * process_message processes a <CR>-terminated block of data received
2135  * from the radio. If the radio is not in Starmode or has old firmware,
2136  * it may be a line of text in response to an AT command. Ideally, with
2137  * a current radio that's properly in Starmode, all data received should
2138  * be properly framed and checksummed radio message blocks, containing
2139  * either a starmode packet, or a other communication from the radio
2140  * firmware, like "INF_" Info messages and &COMMAND responses.
2141  */
2142 static void process_message(struct strip *strip_info)
2143 {
2144         STRIP_Header header = { zero_address, zero_address, 0 };
2145         __u8 *ptr = strip_info->sx_buff;
2146         __u8 *end = strip_info->sx_buff + strip_info->sx_count;
2147         __u8 sendername[32], *sptr = sendername;
2148         MetricomKey key;
2149
2150         /*HexDump("Receiving", strip_info, ptr, end); */
2151
2152         /* Check for start of address marker, and then skip over it */
2153         if (*ptr == '*')
2154                 ptr++;
2155         else {
2156                 process_text_message(strip_info);
2157                 return;
2158         }
2159
2160         /* Copy out the return address */
2161         while (ptr < end && *ptr != '*'
2162                && sptr < ARRAY_END(sendername) - 1)
2163                 *sptr++ = *ptr++;
2164         *sptr = 0;              /* Null terminate the sender name */
2165
2166         /* Check for end of address marker, and skip over it */
2167         if (ptr >= end || *ptr != '*') {
2168                 RecvErr("No second *", strip_info);
2169                 return;
2170         }
2171         ptr++;                  /* Skip the second '*' */
2172
2173         /* If the sender name is "&COMMAND", ignore this 'packet'       */
2174         /* (This is here for backwards compatibility with old firmware) */
2175         if (!strcmp(sendername, "&COMMAND")) {
2176                 strip_info->firmware_level = NoStructure;
2177                 strip_info->next_command = CompatibilityCommand;
2178                 return;
2179         }
2180
2181         if (ptr + 4 > end) {
2182                 RecvErr("No proto key", strip_info);
2183                 return;
2184         }
2185
2186         /* Get the protocol key out of the buffer */
2187         key.c[0] = *ptr++;
2188         key.c[1] = *ptr++;
2189         key.c[2] = *ptr++;
2190         key.c[3] = *ptr++;
2191
2192         /* If we're using checksums, verify the checksum at the end of the packet */
2193         if (strip_info->firmware_level >= ChecksummedMessages) {
2194                 end -= 4;       /* Chop the last four bytes off the packet (they're the checksum) */
2195                 if (ptr > end) {
2196                         RecvErr("Missing Checksum", strip_info);
2197                         return;
2198                 }
2199                 if (!verify_checksum(strip_info)) {
2200                         RecvErr("Bad Checksum", strip_info);
2201                         return;
2202                 }
2203         }
2204
2205         /*printk(KERN_INFO "%s: Got packet from \"%s\".\n", strip_info->dev->name, sendername); */
2206
2207         /*
2208          * Fill in (pseudo) source and destination addresses in the packet.
2209          * We assume that the destination address was our address (the radio does not
2210          * tell us this). If the radio supplies a source address, then we use it.
2211          */
2212         header.dst_addr = strip_info->true_dev_addr;
2213         string_to_radio_address(&header.src_addr, sendername);
2214
2215 #ifdef EXT_COUNTERS
2216         if (key.l == SIP0Key.l) {
2217                 strip_info->rx_rbytes += (end - ptr);
2218                 process_IP_packet(strip_info, &header, ptr, end);
2219         } else if (key.l == ARP0Key.l) {
2220                 strip_info->rx_rbytes += (end - ptr);
2221                 process_ARP_packet(strip_info, &header, ptr, end);
2222         } else if (key.l == ATR_Key.l) {
2223                 strip_info->rx_ebytes += (end - ptr);
2224                 process_AT_response(strip_info, ptr, end);
2225         } else if (key.l == ACK_Key.l) {
2226                 strip_info->rx_ebytes += (end - ptr);
2227                 process_ACK(strip_info, ptr, end);
2228         } else if (key.l == INF_Key.l) {
2229                 strip_info->rx_ebytes += (end - ptr);
2230                 process_Info(strip_info, ptr, end);
2231         } else if (key.l == ERR_Key.l) {
2232                 strip_info->rx_ebytes += (end - ptr);
2233                 RecvErr_Message(strip_info, sendername, ptr, end - ptr);
2234         } else
2235                 RecvErr("Unrecognized protocol key", strip_info);
2236 #else
2237         if (key.l == SIP0Key.l)
2238                 process_IP_packet(strip_info, &header, ptr, end);
2239         else if (key.l == ARP0Key.l)
2240                 process_ARP_packet(strip_info, &header, ptr, end);
2241         else if (key.l == ATR_Key.l)
2242                 process_AT_response(strip_info, ptr, end);
2243         else if (key.l == ACK_Key.l)
2244                 process_ACK(strip_info, ptr, end);
2245         else if (key.l == INF_Key.l)
2246                 process_Info(strip_info, ptr, end);
2247         else if (key.l == ERR_Key.l)
2248                 RecvErr_Message(strip_info, sendername, ptr, end - ptr);
2249         else
2250                 RecvErr("Unrecognized protocol key", strip_info);
2251 #endif
2252 }
2253
2254 #define TTYERROR(X) ((X) == TTY_BREAK   ? "Break"            : \
2255                      (X) == TTY_FRAME   ? "Framing Error"    : \
2256                      (X) == TTY_PARITY  ? "Parity Error"     : \
2257                      (X) == TTY_OVERRUN ? "Hardware Overrun" : "Unknown Error")
2258
2259 /*
2260  * Handle the 'receiver data ready' interrupt.
2261  * This function is called by the 'tty_io' module in the kernel when
2262  * a block of STRIP data has been received, which can now be decapsulated
2263  * and sent on to some IP layer for further processing.
2264  */
2265
2266 static void strip_receive_buf(struct tty_struct *tty, const unsigned char *cp,
2267                   char *fp, int count)
2268 {
2269         struct strip *strip_info = tty->disc_data;
2270         const unsigned char *end = cp + count;
2271         unsigned long flags;
2272
2273         if (!strip_info || strip_info->magic != STRIP_MAGIC
2274             || !netif_running(strip_info->dev))
2275                 return;
2276
2277         spin_lock_irqsave(&strip_lock, flags);
2278 #if 0
2279         {
2280                 struct timeval tv;
2281                 do_gettimeofday(&tv);
2282                 printk(KERN_INFO
2283                        "**** strip_receive_buf: %3d bytes at %02d.%06d\n",
2284                        count, tv.tv_sec % 100, tv.tv_usec);
2285         }
2286 #endif
2287
2288 #ifdef EXT_COUNTERS
2289         strip_info->rx_sbytes += count;
2290 #endif
2291
2292         /* Read the characters out of the buffer */
2293         while (cp < end) {
2294                 if (fp && *fp)
2295                         printk(KERN_INFO "%s: %s on serial port\n",
2296                                strip_info->dev->name, TTYERROR(*fp));
2297                 if (fp && *fp++ && !strip_info->discard) {      /* If there's a serial error, record it */
2298                         /* If we have some characters in the buffer, discard them */
2299                         strip_info->discard = strip_info->sx_count;
2300                         strip_info->rx_errors++;
2301                 }
2302
2303                 /* Leading control characters (CR, NL, Tab, etc.) are ignored */
2304                 if (strip_info->sx_count > 0 || *cp >= ' ') {
2305                         if (*cp == 0x0D) {      /* If end of packet, decide what to do with it */
2306                                 if (strip_info->sx_count > 3000)
2307                                         printk(KERN_INFO
2308                                                "%s: Cut a %d byte packet (%zd bytes remaining)%s\n",
2309                                                strip_info->dev->name,
2310                                                strip_info->sx_count,
2311                                                end - cp - 1,
2312                                                strip_info->
2313                                                discard ? " (discarded)" :
2314                                                "");
2315                                 if (strip_info->sx_count >
2316                                     strip_info->sx_size) {
2317                                         strip_info->rx_over_errors++;
2318                                         printk(KERN_INFO
2319                                                "%s: sx_buff overflow (%d bytes total)\n",
2320                                                strip_info->dev->name,
2321                                                strip_info->sx_count);
2322                                 } else if (strip_info->discard)
2323                                         printk(KERN_INFO
2324                                                "%s: Discarding bad packet (%d/%d)\n",
2325                                                strip_info->dev->name,
2326                                                strip_info->discard,
2327                                                strip_info->sx_count);
2328                                 else
2329                                         process_message(strip_info);
2330                                 strip_info->discard = 0;
2331                                 strip_info->sx_count = 0;
2332                         } else {
2333                                 /* Make sure we have space in the buffer */
2334                                 if (strip_info->sx_count <
2335                                     strip_info->sx_size)
2336                                         strip_info->sx_buff[strip_info->
2337                                                             sx_count] =
2338                                             *cp;
2339                                 strip_info->sx_count++;
2340                         }
2341                 }
2342                 cp++;
2343         }
2344         spin_unlock_irqrestore(&strip_lock, flags);
2345 }
2346
2347
2348 /************************************************************************/
2349 /* General control routines                                             */
2350
2351 static int set_mac_address(struct strip *strip_info,
2352                            MetricomAddress * addr)
2353 {
2354         /*
2355          * We're using a manually specified address if the address is set
2356          * to anything other than all ones. Setting the address to all ones
2357          * disables manual mode and goes back to automatic address determination
2358          * (tracking the true address that the radio has).
2359          */
2360         strip_info->manual_dev_addr =
2361             memcmp(addr->c, broadcast_address.c,
2362                    sizeof(broadcast_address));
2363         if (strip_info->manual_dev_addr)
2364                 *(MetricomAddress *) strip_info->dev->dev_addr = *addr;
2365         else
2366                 *(MetricomAddress *) strip_info->dev->dev_addr =
2367                     strip_info->true_dev_addr;
2368         return 0;
2369 }
2370
2371 static int strip_set_mac_address(struct net_device *dev, void *addr)
2372 {
2373         struct strip *strip_info = netdev_priv(dev);
2374         struct sockaddr *sa = addr;
2375         printk(KERN_INFO "%s: strip_set_dev_mac_address called\n", dev->name);
2376         set_mac_address(strip_info, (MetricomAddress *) sa->sa_data);
2377         return 0;
2378 }
2379
2380 static struct net_device_stats *strip_get_stats(struct net_device *dev)
2381 {
2382         struct strip *strip_info = netdev_priv(dev);
2383         static struct net_device_stats stats;
2384
2385         memset(&stats, 0, sizeof(struct net_device_stats));
2386
2387         stats.rx_packets = strip_info->rx_packets;
2388         stats.tx_packets = strip_info->tx_packets;
2389         stats.rx_dropped = strip_info->rx_dropped;
2390         stats.tx_dropped = strip_info->tx_dropped;
2391         stats.tx_errors = strip_info->tx_errors;
2392         stats.rx_errors = strip_info->rx_errors;
2393         stats.rx_over_errors = strip_info->rx_over_errors;
2394         return (&stats);
2395 }
2396
2397
2398 /************************************************************************/
2399 /* Opening and closing                                                  */
2400
2401 /*
2402  * Here's the order things happen:
2403  * When the user runs "slattach -p strip ..."
2404  *  1. The TTY module calls strip_open;;
2405  *  2. strip_open calls strip_alloc
2406  *  3.                  strip_alloc calls register_netdev
2407  *  4.                  register_netdev calls strip_dev_init
2408  *  5. then strip_open finishes setting up the strip_info
2409  *
2410  * When the user runs "ifconfig st<x> up address netmask ..."
2411  *  6. strip_open_low gets called
2412  *
2413  * When the user runs "ifconfig st<x> down"
2414  *  7. strip_close_low gets called
2415  *
2416  * When the user kills the slattach process
2417  *  8. strip_close gets called
2418  *  9. strip_close calls dev_close
2419  * 10. if the device is still up, then dev_close calls strip_close_low
2420  * 11. strip_close calls strip_free
2421  */
2422
2423 /* Open the low-level part of the STRIP channel. Easy! */
2424
2425 static int strip_open_low(struct net_device *dev)
2426 {
2427         struct strip *strip_info = netdev_priv(dev);
2428
2429         if (strip_info->tty == NULL)
2430                 return (-ENODEV);
2431
2432         if (!allocate_buffers(strip_info, dev->mtu))
2433                 return (-ENOMEM);
2434
2435         strip_info->sx_count = 0;
2436         strip_info->tx_left = 0;
2437
2438         strip_info->discard = 0;
2439         strip_info->working = FALSE;
2440         strip_info->firmware_level = NoStructure;
2441         strip_info->next_command = CompatibilityCommand;
2442         strip_info->user_baud = tty_get_baud_rate(strip_info->tty);
2443
2444         printk(KERN_INFO "%s: Initializing Radio.\n",
2445                strip_info->dev->name);
2446         ResetRadio(strip_info);
2447         strip_info->idle_timer.expires = jiffies + 1 * HZ;
2448         add_timer(&strip_info->idle_timer);
2449         netif_wake_queue(dev);
2450         return (0);
2451 }
2452
2453
2454 /*
2455  * Close the low-level part of the STRIP channel. Easy!
2456  */
2457
2458 static int strip_close_low(struct net_device *dev)
2459 {
2460         struct strip *strip_info = netdev_priv(dev);
2461
2462         if (strip_info->tty == NULL)
2463                 return -EBUSY;
2464         clear_bit(TTY_DO_WRITE_WAKEUP, &strip_info->tty->flags);
2465         netif_stop_queue(dev);
2466
2467         /*
2468          * Free all STRIP frame buffers.
2469          */
2470         kfree(strip_info->rx_buff);
2471         strip_info->rx_buff = NULL;
2472         kfree(strip_info->sx_buff);
2473         strip_info->sx_buff = NULL;
2474         kfree(strip_info->tx_buff);
2475         strip_info->tx_buff = NULL;
2476
2477         del_timer(&strip_info->idle_timer);
2478         return 0;
2479 }
2480
2481 static const struct header_ops strip_header_ops = {
2482         .create = strip_header,
2483         .rebuild = strip_rebuild_header,
2484 };
2485
2486
2487 static const struct net_device_ops strip_netdev_ops = {
2488         .ndo_open       = strip_open_low,
2489         .ndo_stop       = strip_close_low,
2490         .ndo_start_xmit = strip_xmit,
2491         .ndo_set_mac_address = strip_set_mac_address,
2492         .ndo_get_stats  = strip_get_stats,
2493         .ndo_change_mtu = strip_change_mtu,
2494 };
2495
2496 /*
2497  * This routine is called by DDI when the
2498  * (dynamically assigned) device is registered
2499  */
2500
2501 static void strip_dev_setup(struct net_device *dev)
2502 {
2503         /*
2504          * Finish setting up the DEVICE info.
2505          */
2506
2507         dev->trans_start = 0;
2508         dev->tx_queue_len = 30; /* Drop after 30 frames queued */
2509
2510         dev->flags = 0;
2511         dev->mtu = DEFAULT_STRIP_MTU;
2512         dev->type = ARPHRD_METRICOM;    /* dtang */
2513         dev->hard_header_len = sizeof(STRIP_Header);
2514         /*
2515          *  netdev_priv(dev) Already holds a pointer to our struct strip
2516          */
2517
2518         *(MetricomAddress *)dev->broadcast = broadcast_address;
2519         dev->dev_addr[0] = 0;
2520         dev->addr_len = sizeof(MetricomAddress);
2521
2522         dev->header_ops = &strip_header_ops,
2523         dev->netdev_ops = &strip_netdev_ops;
2524 }
2525
2526 /*
2527  * Free a STRIP channel.
2528  */
2529
2530 static void strip_free(struct strip *strip_info)
2531 {
2532         unsigned long flags;
2533
2534         spin_lock_irqsave(&strip_lock, flags);
2535         list_del_rcu(&strip_info->list);
2536         spin_unlock_irqrestore(&strip_lock, flags);
2537
2538         strip_info->magic = 0;
2539
2540         free_netdev(strip_info->dev);
2541 }
2542
2543
2544 /*
2545  * Allocate a new free STRIP channel
2546  */
2547 static struct strip *strip_alloc(void)
2548 {
2549         struct list_head *n;
2550         unsigned long flags;
2551         struct net_device *dev;
2552         struct strip *strip_info;
2553
2554         dev = alloc_netdev(sizeof(struct strip), "st%d",
2555                            strip_dev_setup);
2556
2557         if (!dev)
2558                 return NULL;    /* If no more memory, return */
2559
2560
2561         strip_info = netdev_priv(dev);
2562         strip_info->dev = dev;
2563
2564         strip_info->magic = STRIP_MAGIC;
2565         strip_info->tty = NULL;
2566
2567         strip_info->gratuitous_arp = jiffies + LongTime;
2568         strip_info->arp_interval = 0;
2569         init_timer(&strip_info->idle_timer);
2570         strip_info->idle_timer.data = (long) dev;
2571         strip_info->idle_timer.function = strip_IdleTask;
2572
2573
2574         spin_lock_irqsave(&strip_lock, flags);
2575  rescan:
2576         /*
2577          * Search the list to find where to put our new entry
2578          * (and in the process decide what channel number it is
2579          * going to be)
2580          */
2581         list_for_each(n, &strip_list) {
2582                 struct strip *s = hlist_entry(n, struct strip, list);
2583
2584                 if (s->dev->base_addr == dev->base_addr) {
2585                         ++dev->base_addr;
2586                         goto rescan;
2587                 }
2588         }
2589
2590         sprintf(dev->name, "st%ld", dev->base_addr);
2591
2592         list_add_tail_rcu(&strip_info->list, &strip_list);
2593         spin_unlock_irqrestore(&strip_lock, flags);
2594
2595         return strip_info;
2596 }
2597
2598 /*
2599  * Open the high-level part of the STRIP channel.
2600  * This function is called by the TTY module when the
2601  * STRIP line discipline is called for.  Because we are
2602  * sure the tty line exists, we only have to link it to
2603  * a free STRIP channel...
2604  */
2605
2606 static int strip_open(struct tty_struct *tty)
2607 {
2608         struct strip *strip_info = tty->disc_data;
2609
2610         /*
2611          * First make sure we're not already connected.
2612          */
2613
2614         if (strip_info && strip_info->magic == STRIP_MAGIC)
2615                 return -EEXIST;
2616
2617         /*
2618          * We need a write method.
2619          */
2620
2621         if (tty->ops->write == NULL || tty->ops->set_termios == NULL)
2622                 return -EOPNOTSUPP;
2623
2624         /*
2625          * OK.  Find a free STRIP channel to use.
2626          */
2627         if ((strip_info = strip_alloc()) == NULL)
2628                 return -ENFILE;
2629
2630         /*
2631          * Register our newly created device so it can be ifconfig'd
2632          * strip_dev_init() will be called as a side-effect
2633          */
2634
2635         if (register_netdev(strip_info->dev) != 0) {
2636                 printk(KERN_ERR "strip: register_netdev() failed.\n");
2637                 strip_free(strip_info);
2638                 return -ENFILE;
2639         }
2640
2641         strip_info->tty = tty;
2642         tty->disc_data = strip_info;
2643         tty->receive_room = 65536;
2644
2645         tty_driver_flush_buffer(tty);
2646
2647         /*
2648          * Restore default settings
2649          */
2650
2651         strip_info->dev->type = ARPHRD_METRICOM;        /* dtang */
2652
2653         /*
2654          * Set tty options
2655          */
2656
2657         tty->termios->c_iflag |= IGNBRK | IGNPAR;       /* Ignore breaks and parity errors. */
2658         tty->termios->c_cflag |= CLOCAL;        /* Ignore modem control signals. */
2659         tty->termios->c_cflag &= ~HUPCL;        /* Don't close on hup */
2660
2661         printk(KERN_INFO "STRIP: device \"%s\" activated\n",
2662                strip_info->dev->name);
2663
2664         /*
2665          * Done.  We have linked the TTY line to a channel.
2666          */
2667         return (strip_info->dev->base_addr);
2668 }
2669
2670 /*
2671  * Close down a STRIP channel.
2672  * This means flushing out any pending queues, and then restoring the
2673  * TTY line discipline to what it was before it got hooked to STRIP
2674  * (which usually is TTY again).
2675  */
2676
2677 static void strip_close(struct tty_struct *tty)
2678 {
2679         struct strip *strip_info = tty->disc_data;
2680
2681         /*
2682          * First make sure we're connected.
2683          */
2684
2685         if (!strip_info || strip_info->magic != STRIP_MAGIC)
2686                 return;
2687
2688         unregister_netdev(strip_info->dev);
2689
2690         tty->disc_data = NULL;
2691         strip_info->tty = NULL;
2692         printk(KERN_INFO "STRIP: device \"%s\" closed down\n",
2693                strip_info->dev->name);
2694         strip_free(strip_info);
2695         tty->disc_data = NULL;
2696 }
2697
2698
2699 /************************************************************************/
2700 /* Perform I/O control calls on an active STRIP channel.                */
2701
2702 static int strip_ioctl(struct tty_struct *tty, struct file *file,
2703                        unsigned int cmd, unsigned long arg)
2704 {
2705         struct strip *strip_info = tty->disc_data;
2706
2707         /*
2708          * First make sure we're connected.
2709          */
2710
2711         if (!strip_info || strip_info->magic != STRIP_MAGIC)
2712                 return -EINVAL;
2713
2714         switch (cmd) {
2715         case SIOCGIFNAME:
2716                 if(copy_to_user((void __user *) arg, strip_info->dev->name, strlen(strip_info->dev->name) + 1))
2717                         return -EFAULT;
2718                 break;
2719         case SIOCSIFHWADDR:
2720         {
2721                 MetricomAddress addr;
2722                 //printk(KERN_INFO "%s: SIOCSIFHWADDR\n", strip_info->dev->name);
2723                 if(copy_from_user(&addr, (void __user *) arg, sizeof(MetricomAddress)))
2724                         return -EFAULT;
2725                 return set_mac_address(strip_info, &addr);
2726         }
2727         default:
2728                 return tty_mode_ioctl(tty, file, cmd, arg);
2729                 break;
2730         }
2731         return 0;
2732 }
2733
2734
2735 /************************************************************************/
2736 /* Initialization                                                       */
2737
2738 static struct tty_ldisc_ops strip_ldisc = {
2739         .magic = TTY_LDISC_MAGIC,
2740         .name = "strip",
2741         .owner = THIS_MODULE,
2742         .open = strip_open,
2743         .close = strip_close,
2744         .ioctl = strip_ioctl,
2745         .receive_buf = strip_receive_buf,
2746         .write_wakeup = strip_write_some_more,
2747 };
2748
2749 /*
2750  * Initialize the STRIP driver.
2751  * This routine is called at boot time, to bootstrap the multi-channel
2752  * STRIP driver
2753  */
2754
2755 static char signon[] __initdata =
2756     KERN_INFO "STRIP: Version %s (unlimited channels)\n";
2757
2758 static int __init strip_init_driver(void)
2759 {
2760         int status;
2761
2762         printk(signon, StripVersion);
2763
2764         
2765         /*
2766          * Fill in our line protocol discipline, and register it
2767          */
2768         if ((status = tty_register_ldisc(N_STRIP, &strip_ldisc)))
2769                 printk(KERN_ERR "STRIP: can't register line discipline (err = %d)\n",
2770                        status);
2771
2772         /*
2773          * Register the status file with /proc
2774          */
2775         proc_net_fops_create(&init_net, "strip", S_IFREG | S_IRUGO, &strip_seq_fops);
2776
2777         return status;
2778 }
2779
2780 module_init(strip_init_driver);
2781
2782 static const char signoff[] __exitdata =
2783     KERN_INFO "STRIP: Module Unloaded\n";
2784
2785 static void __exit strip_exit_driver(void)
2786 {
2787         int i;
2788         struct list_head *p,*n;
2789
2790         /* module ref count rules assure that all entries are unregistered */
2791         list_for_each_safe(p, n, &strip_list) {
2792                 struct strip *s = list_entry(p, struct strip, list);
2793                 strip_free(s);
2794         }
2795
2796         /* Unregister with the /proc/net file here. */
2797         proc_net_remove(&init_net, "strip");
2798
2799         if ((i = tty_unregister_ldisc(N_STRIP)))
2800                 printk(KERN_ERR "STRIP: can't unregister line discipline (err = %d)\n", i);
2801
2802         printk(signoff);
2803 }
2804
2805 module_exit(strip_exit_driver);
2806
2807 MODULE_AUTHOR("Stuart Cheshire <cheshire@cs.stanford.edu>");
2808 MODULE_DESCRIPTION("Starmode Radio IP (STRIP) Device Driver");
2809 MODULE_LICENSE("Dual BSD/GPL");
2810
2811 MODULE_SUPPORTED_DEVICE("Starmode Radio IP (STRIP) modem");