* add p cc
[mascara-docs.git] / i386 / linux / linux-2.3.21 / drivers / net / strip.c
blob9acb7f031799562b07f290135423c58067d89ea5
1 /*
2 * Copyright 1996 The Board of Trustees of The Leland Stanford
3 * Junior University. All Rights Reserved.
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.
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).
17 * Version: @(#)strip.c 1.3 July 1997
19 * Author: Stuart Cheshire <cheshire@cs.stanford.edu>
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)
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.
30 * v0.9.2 13th March 1996 (SC)
31 * Uses arp cache lookups (but doesn't send arp packets yet)
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)
37 * v0.9.4 27th April 1996 (SC)
38 * First attempt at using "&COMMAND" Starmode AT commands
40 * v0.9.5 29th May 1996 (SC)
41 * First attempt at sending (unicast) ARP packets
43 * v0.9.6 5th June 1996 (Elliot)
44 * Put "message level" tags in every "printk" statement
46 * v0.9.7 13th June 1996 (laik)
47 * Added support for the /proc fs
49 * v0.9.8 July 1996 (Mema)
50 * Added packet logging
52 * v1.0 November 1996 (SC)
53 * Fixed (severe) memory leaks in the /proc fs code
54 * Fixed race conditions in the logging code
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)
61 * v1.2 January 1997 (SC)
62 * Put portables list back in
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.
71 #ifdef MODULE
72 static const char StripVersion[] = "1.3-STUART.CHESHIRE-MODULAR";
73 #else
74 static const char StripVersion[] = "1.3-STUART.CHESHIRE";
75 #endif
77 #define TICKLE_TIMERS 0
78 #define EXT_COUNTERS 1
81 /************************************************************************/
82 /* Header files */
84 #include <linux/config.h>
86 #ifdef MODULE
87 #include <linux/module.h>
88 #include <linux/version.h>
89 #endif
91 #include <asm/system.h>
92 #include <asm/uaccess.h>
93 #include <asm/segment.h>
94 #include <asm/bitops.h>
97 * isdigit() and isspace() use the ctype[] array, which is not available
98 * to kernel modules. If compiling as a module, use a local definition
99 * of isdigit() and isspace() until _ctype is added to ksyms.
101 #ifdef MODULE
102 # define isdigit(c) ('0' <= (c) && (c) <= '9')
103 # define isspace(c) ((c) == ' ' || (c) == '\t')
104 #else
105 # include <linux/ctype.h>
106 #endif
108 #include <linux/string.h>
109 #include <linux/mm.h>
110 #include <linux/interrupt.h>
111 #include <linux/in.h>
112 #include <linux/tty.h>
113 #include <linux/errno.h>
114 #include <linux/netdevice.h>
115 #include <linux/inetdevice.h>
116 #include <linux/etherdevice.h>
117 #include <linux/skbuff.h>
118 #include <linux/if_arp.h>
119 #include <linux/if_strip.h>
120 #include <linux/proc_fs.h>
121 #include <linux/serial.h>
122 #include <net/arp.h>
124 #include <linux/ip.h>
125 #include <linux/tcp.h>
126 #include <linux/time.h>
129 /************************************************************************/
130 /* Useful structures and definitions */
133 * A MetricomKey identifies the protocol being carried inside a Metricom
134 * Starmode packet.
137 typedef union
139 __u8 c[4];
140 __u32 l;
141 } MetricomKey;
144 * An IP address can be viewed as four bytes in memory (which is what it is) or as
145 * a single 32-bit long (which is convenient for assignment, equality testing etc.)
148 typedef union
150 __u8 b[4];
151 __u32 l;
152 } IPaddr;
155 * A MetricomAddressString is used to hold a printable representation of
156 * a Metricom address.
159 typedef struct
161 __u8 c[24];
162 } MetricomAddressString;
164 /* Encapsulation can expand packet of size x to 65/64x + 1
165 * Sent packet looks like "<CR>*<address>*<key><encaps payload><CR>"
166 * 1 1 1-18 1 4 ? 1
167 * eg. <CR>*0000-1234*SIP0<encaps payload><CR>
168 * We allow 31 bytes for the stars, the key, the address and the <CR>s
170 #define STRIP_ENCAP_SIZE(X) (32 + (X)*65L/64L)
173 * A STRIP_Header is never really sent over the radio, but making a dummy
174 * header for internal use within the kernel that looks like an Ethernet
175 * header makes certain other software happier. For example, tcpdump
176 * already understands Ethernet headers.
179 typedef struct
181 MetricomAddress dst_addr; /* Destination address, e.g. "0000-1234" */
182 MetricomAddress src_addr; /* Source address, e.g. "0000-5678" */
183 unsigned short protocol; /* The protocol type, using Ethernet codes */
184 } STRIP_Header;
186 typedef struct
188 char c[60];
189 } MetricomNode;
191 #define NODE_TABLE_SIZE 32
192 typedef struct
194 struct timeval timestamp;
195 int num_nodes;
196 MetricomNode node[NODE_TABLE_SIZE];
197 } MetricomNodeTable;
199 enum { FALSE = 0, TRUE = 1 };
202 * Holds the radio's firmware version.
204 typedef struct
206 char c[50];
207 } FirmwareVersion;
210 * Holds the radio's serial number.
212 typedef struct
214 char c[18];
215 } SerialNumber;
218 * Holds the radio's battery voltage.
220 typedef struct
222 char c[11];
223 } BatteryVoltage;
225 typedef struct
227 char c[8];
228 } char8;
230 enum
232 NoStructure = 0, /* Really old firmware */
233 StructuredMessages = 1, /* Parsable AT response msgs */
234 ChecksummedMessages = 2 /* Parsable AT response msgs with checksums */
235 } FirmwareLevel;
237 struct strip
239 int magic;
241 * These are pointers to the malloc()ed frame buffers.
244 unsigned char *rx_buff; /* buffer for received IP packet*/
245 unsigned char *sx_buff; /* buffer for received serial data*/
246 int sx_count; /* received serial data counter */
247 int sx_size; /* Serial buffer size */
248 unsigned char *tx_buff; /* transmitter buffer */
249 unsigned char *tx_head; /* pointer to next byte to XMIT */
250 int tx_left; /* bytes left in XMIT queue */
251 int tx_size; /* Serial buffer size */
254 * STRIP interface statistics.
257 unsigned long rx_packets; /* inbound frames counter */
258 unsigned long tx_packets; /* outbound frames counter */
259 unsigned long rx_errors; /* Parity, etc. errors */
260 unsigned long tx_errors; /* Planned stuff */
261 unsigned long rx_dropped; /* No memory for skb */
262 unsigned long tx_dropped; /* When MTU change */
263 unsigned long rx_over_errors; /* Frame bigger then STRIP buf. */
265 unsigned long pps_timer; /* Timer to determine pps */
266 unsigned long rx_pps_count; /* Counter to determine pps */
267 unsigned long tx_pps_count; /* Counter to determine pps */
268 unsigned long sx_pps_count; /* Counter to determine pps */
269 unsigned long rx_average_pps; /* rx packets per second * 8 */
270 unsigned long tx_average_pps; /* tx packets per second * 8 */
271 unsigned long sx_average_pps; /* sent packets per second * 8 */
273 #ifdef EXT_COUNTERS
274 unsigned long rx_bytes; /* total received bytes */
275 unsigned long tx_bytes; /* total received bytes */
276 unsigned long rx_rbytes; /* bytes thru radio i/f */
277 unsigned long tx_rbytes; /* bytes thru radio i/f */
278 unsigned long rx_sbytes; /* tot bytes thru serial i/f */
279 unsigned long tx_sbytes; /* tot bytes thru serial i/f */
280 unsigned long rx_ebytes; /* tot stat/err bytes */
281 unsigned long tx_ebytes; /* tot stat/err bytes */
282 #endif
285 * Internal variables.
288 struct strip *next; /* The next struct in the list */
289 struct strip **referrer; /* The pointer that points to us*/
290 int discard; /* Set if serial error */
291 int working; /* Is radio working correctly? */
292 int firmware_level; /* Message structuring level */
293 int next_command; /* Next periodic command */
294 unsigned int user_baud; /* The user-selected baud rate */
295 int mtu; /* Our mtu (to spot changes!) */
296 long watchdog_doprobe; /* Next time to test the radio */
297 long watchdog_doreset; /* Time to do next reset */
298 long gratuitous_arp; /* Time to send next ARP refresh*/
299 long arp_interval; /* Next ARP interval */
300 struct timer_list idle_timer; /* For periodic wakeup calls */
301 MetricomAddress true_dev_addr; /* True address of radio */
302 int manual_dev_addr; /* Hack: See note below */
304 FirmwareVersion firmware_version; /* The radio's firmware version */
305 SerialNumber serial_number; /* The radio's serial number */
306 BatteryVoltage battery_voltage; /* The radio's battery voltage */
309 * Other useful structures.
312 struct tty_struct *tty; /* ptr to TTY structure */
313 char8 if_name; /* Dynamically generated name */
314 struct net_device dev; /* Our device structure */
317 * Neighbour radio records
320 MetricomNodeTable portables;
321 MetricomNodeTable poletops;
325 * Note: manual_dev_addr hack
327 * It is not possible to change the hardware address of a Metricom radio,
328 * or to send packets with a user-specified hardware source address, thus
329 * trying to manually set a hardware source address is a questionable
330 * thing to do. However, if the user *does* manually set the hardware
331 * source address of a STRIP interface, then the kernel will believe it,
332 * and use it in certain places. For example, the hardware address listed
333 * by ifconfig will be the manual address, not the true one.
334 * (Both addresses are listed in /proc/net/strip.)
335 * Also, ARP packets will be sent out giving the user-specified address as
336 * the source address, not the real address. This is dangerous, because
337 * it means you won't receive any replies -- the ARP replies will go to
338 * the specified address, which will be some other radio. The case where
339 * this is useful is when that other radio is also connected to the same
340 * machine. This allows you to connect a pair of radios to one machine,
341 * and to use one exclusively for inbound traffic, and the other
342 * exclusively for outbound traffic. Pretty neat, huh?
344 * Here's the full procedure to set this up:
346 * 1. "slattach" two interfaces, e.g. st0 for outgoing packets,
347 * and st1 for incoming packets
349 * 2. "ifconfig" st0 (outbound radio) to have the hardware address
350 * which is the real hardware address of st1 (inbound radio).
351 * Now when it sends out packets, it will masquerade as st1, and
352 * replies will be sent to that radio, which is exactly what we want.
354 * 3. Set the route table entry ("route add default ..." or
355 * "route add -net ...", as appropriate) to send packets via the st0
356 * interface (outbound radio). Do not add any route which sends packets
357 * out via the st1 interface -- that radio is for inbound traffic only.
359 * 4. "ifconfig" st1 (inbound radio) to have hardware address zero.
360 * This tells the STRIP driver to "shut down" that interface and not
361 * send any packets through it. In particular, it stops sending the
362 * periodic gratuitous ARP packets that a STRIP interface normally sends.
363 * Also, when packets arrive on that interface, it will search the
364 * interface list to see if there is another interface who's manual
365 * hardware address matches its own real address (i.e. st0 in this
366 * example) and if so it will transfer ownership of the skbuff to
367 * that interface, so that it looks to the kernel as if the packet
368 * arrived on that interface. This is necessary because when the
369 * kernel sends an ARP packet on st0, it expects to get a reply on
370 * st0, and if it sees the reply come from st1 then it will ignore
371 * it (to be accurate, it puts the entry in the ARP table, but
372 * labelled in such a way that st0 can't use it).
374 * Thanks to Petros Maniatis for coming up with the idea of splitting
375 * inbound and outbound traffic between two interfaces, which turned
376 * out to be really easy to implement, even if it is a bit of a hack.
378 * Having set a manual address on an interface, you can restore it
379 * to automatic operation (where the address is automatically kept
380 * consistent with the real address of the radio) by setting a manual
381 * address of all ones, e.g. "ifconfig st0 hw strip FFFFFFFFFFFF"
382 * This 'turns off' manual override mode for the device address.
384 * Note: The IEEE 802 headers reported in tcpdump will show the *real*
385 * radio addresses the packets were sent and received from, so that you
386 * can see what is really going on with packets, and which interfaces
387 * they are really going through.
391 /************************************************************************/
392 /* Constants */
395 * CommandString1 works on all radios
396 * Other CommandStrings are only used with firmware that provides structured responses.
398 * ats319=1 Enables Info message for node additions and deletions
399 * ats319=2 Enables Info message for a new best node
400 * ats319=4 Enables checksums
401 * ats319=8 Enables ACK messages
404 static const int MaxCommandStringLength = 32;
405 static const int CompatibilityCommand = 1;
407 static const char CommandString0[] = "*&COMMAND*ATS319=7"; /* Turn on checksums & info messages */
408 static const char CommandString1[] = "*&COMMAND*ATS305?"; /* Query radio name */
409 static const char CommandString2[] = "*&COMMAND*ATS325?"; /* Query battery voltage */
410 static const char CommandString3[] = "*&COMMAND*ATS300?"; /* Query version information */
411 static const char CommandString4[] = "*&COMMAND*ATS311?"; /* Query poletop list */
412 static const char CommandString5[] = "*&COMMAND*AT~LA"; /* Query portables list */
413 typedef struct { const char *string; long length; } StringDescriptor;
415 static const StringDescriptor CommandString[] =
417 { CommandString0, sizeof(CommandString0)-1 },
418 { CommandString1, sizeof(CommandString1)-1 },
419 { CommandString2, sizeof(CommandString2)-1 },
420 { CommandString3, sizeof(CommandString3)-1 },
421 { CommandString4, sizeof(CommandString4)-1 },
422 { CommandString5, sizeof(CommandString5)-1 }
425 #define GOT_ALL_RADIO_INFO(S) \
426 ((S)->firmware_version.c[0] && \
427 (S)->battery_voltage.c[0] && \
428 memcmp(&(S)->true_dev_addr, zero_address.c, sizeof(zero_address)))
430 static const char hextable[16] = "0123456789ABCDEF";
432 static const MetricomAddress zero_address;
433 static const MetricomAddress broadcast_address = { { 0xFF,0xFF,0xFF,0xFF,0xFF,0xFF } };
435 static const MetricomKey SIP0Key = { { "SIP0" } };
436 static const MetricomKey ARP0Key = { { "ARP0" } };
437 static const MetricomKey ATR_Key = { { "ATR " } };
438 static const MetricomKey ACK_Key = { { "ACK_" } };
439 static const MetricomKey INF_Key = { { "INF_" } };
440 static const MetricomKey ERR_Key = { { "ERR_" } };
442 static const long MaxARPInterval = 60 * HZ; /* One minute */
445 * Maximum Starmode packet length is 1183 bytes. Allowing 4 bytes for
446 * protocol key, 4 bytes for checksum, one byte for CR, and 65/64 expansion
447 * for STRIP encoding, that translates to a maximum payload MTU of 1155.
448 * Note: A standard NFS 1K data packet is a total of 0x480 (1152) bytes
449 * long, including IP header, UDP header, and NFS header. Setting the STRIP
450 * MTU to 1152 allows us to send default sized NFS packets without fragmentation.
452 static const unsigned short MAX_SEND_MTU = 1152;
453 static const unsigned short MAX_RECV_MTU = 1500; /* Hoping for Ethernet sized packets in the future! */
454 static const unsigned short DEFAULT_STRIP_MTU = 1152;
455 static const int STRIP_MAGIC = 0x5303;
456 static const long LongTime = 0x7FFFFFFF;
459 /************************************************************************/
460 /* Global variables */
462 static struct strip *struct_strip_list = NULL;
465 /************************************************************************/
466 /* Macros */
468 /* Returns TRUE if text T begins with prefix P */
469 #define has_prefix(T,L,P) (((L) >= sizeof(P)-1) && !strncmp((T), (P), sizeof(P)-1))
471 /* Returns TRUE if text T of length L is equal to string S */
472 #define text_equal(T,L,S) (((L) == sizeof(S)-1) && !strncmp((T), (S), sizeof(S)-1))
474 #define READHEX(X) ((X)>='0' && (X)<='9' ? (X)-'0' : \
475 (X)>='a' && (X)<='f' ? (X)-'a'+10 : \
476 (X)>='A' && (X)<='F' ? (X)-'A'+10 : 0 )
478 #define READHEX16(X) ((__u16)(READHEX(X)))
480 #define READDEC(X) ((X)>='0' && (X)<='9' ? (X)-'0' : 0)
482 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
483 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
484 #define ELEMENTS_OF(X) (sizeof(X) / sizeof((X)[0]))
485 #define ARRAY_END(X) (&((X)[ELEMENTS_OF(X)]))
487 #define JIFFIE_TO_SEC(X) ((X) / HZ)
490 /************************************************************************/
491 /* Utility routines */
493 typedef unsigned long InterruptStatus;
495 extern __inline__ InterruptStatus DisableInterrupts(void)
497 InterruptStatus x;
498 save_flags(x);
499 cli();
500 return(x);
503 extern __inline__ void RestoreInterrupts(InterruptStatus x)
505 restore_flags(x);
508 static int arp_query(unsigned char *haddr, u32 paddr, struct net_device * dev)
510 struct neighbour *neighbor_entry;
512 neighbor_entry = neigh_lookup(&arp_tbl, &paddr, dev);
514 if (neighbor_entry != NULL)
516 neighbor_entry->used = jiffies;
517 if (neighbor_entry->nud_state & NUD_VALID)
519 memcpy(haddr, neighbor_entry->ha, dev->addr_len);
520 return 1;
523 return 0;
526 static void DumpData(char *msg, struct strip *strip_info, __u8 *ptr, __u8 *end)
528 static const int MAX_DumpData = 80;
529 __u8 pkt_text[MAX_DumpData], *p = pkt_text;
531 *p++ = '\"';
533 while (ptr<end && p < &pkt_text[MAX_DumpData-4])
535 if (*ptr == '\\')
537 *p++ = '\\';
538 *p++ = '\\';
540 else
542 if (*ptr >= 32 && *ptr <= 126)
544 *p++ = *ptr;
546 else
548 sprintf(p, "\\%02X", *ptr);
549 p+= 3;
552 ptr++;
555 if (ptr == end)
557 *p++ = '\"';
560 *p++ = 0;
562 printk(KERN_INFO "%s: %-13s%s\n", strip_info->dev.name, msg, pkt_text);
565 #if 0
566 static void HexDump(char *msg, struct strip *strip_info, __u8 *start, __u8 *end)
568 __u8 *ptr = start;
569 printk(KERN_INFO "%s: %s: %d bytes\n", strip_info->dev.name, msg, end-ptr);
571 while (ptr < end)
573 long offset = ptr - start;
574 __u8 text[80], *p = text;
575 while (ptr < end && p < &text[16*3])
577 *p++ = hextable[*ptr >> 4];
578 *p++ = hextable[*ptr++ & 0xF];
579 *p++ = ' ';
581 p[-1] = 0;
582 printk(KERN_INFO "%s: %4lX %s\n", strip_info->dev.name, offset, text);
585 #endif
588 /************************************************************************/
589 /* Byte stuffing/unstuffing routines */
591 /* Stuffing scheme:
592 * 00 Unused (reserved character)
593 * 01-3F Run of 2-64 different characters
594 * 40-7F Run of 1-64 different characters plus a single zero at the end
595 * 80-BF Run of 1-64 of the same character
596 * C0-FF Run of 1-64 zeroes (ASCII 0)
599 typedef enum
601 Stuff_Diff = 0x00,
602 Stuff_DiffZero = 0x40,
603 Stuff_Same = 0x80,
604 Stuff_Zero = 0xC0,
605 Stuff_NoCode = 0xFF, /* Special code, meaning no code selected */
607 Stuff_CodeMask = 0xC0,
608 Stuff_CountMask = 0x3F,
609 Stuff_MaxCount = 0x3F,
610 Stuff_Magic = 0x0D /* The value we are eliminating */
611 } StuffingCode;
613 /* StuffData encodes the data starting at "src" for "length" bytes.
614 * It writes it to the buffer pointed to by "dst" (which must be at least
615 * as long as 1 + 65/64 of the input length). The output may be up to 1.6%
616 * larger than the input for pathological input, but will usually be smaller.
617 * StuffData returns the new value of the dst pointer as its result.
618 * "code_ptr_ptr" points to a "__u8 *" which is used to hold encoding state
619 * between calls, allowing an encoded packet to be incrementally built up
620 * from small parts. On the first call, the "__u8 *" pointed to should be
621 * initialized to NULL; between subsequent calls the calling routine should
622 * leave the value alone and simply pass it back unchanged so that the
623 * encoder can recover its current state.
626 #define StuffData_FinishBlock(X) \
627 (*code_ptr = (X) ^ Stuff_Magic, code = Stuff_NoCode)
629 static __u8 *StuffData(__u8 *src, __u32 length, __u8 *dst, __u8 **code_ptr_ptr)
631 __u8 *end = src + length;
632 __u8 *code_ptr = *code_ptr_ptr;
633 __u8 code = Stuff_NoCode, count = 0;
635 if (!length)
636 return(dst);
638 if (code_ptr)
641 * Recover state from last call, if applicable
643 code = (*code_ptr ^ Stuff_Magic) & Stuff_CodeMask;
644 count = (*code_ptr ^ Stuff_Magic) & Stuff_CountMask;
647 while (src < end)
649 switch (code)
651 /* Stuff_NoCode: If no current code, select one */
652 case Stuff_NoCode:
653 /* Record where we're going to put this code */
654 code_ptr = dst++;
655 count = 0; /* Reset the count (zero means one instance) */
656 /* Tentatively start a new block */
657 if (*src == 0)
659 code = Stuff_Zero;
660 src++;
662 else
664 code = Stuff_Same;
665 *dst++ = *src++ ^ Stuff_Magic;
667 /* Note: We optimistically assume run of same -- */
668 /* which will be fixed later in Stuff_Same */
669 /* if it turns out not to be true. */
670 break;
672 /* Stuff_Zero: We already have at least one zero encoded */
673 case Stuff_Zero:
674 /* If another zero, count it, else finish this code block */
675 if (*src == 0)
677 count++;
678 src++;
680 else
682 StuffData_FinishBlock(Stuff_Zero + count);
684 break;
686 /* Stuff_Same: We already have at least one byte encoded */
687 case Stuff_Same:
688 /* If another one the same, count it */
689 if ((*src ^ Stuff_Magic) == code_ptr[1])
691 count++;
692 src++;
693 break;
695 /* else, this byte does not match this block. */
696 /* If we already have two or more bytes encoded, finish this code block */
697 if (count)
699 StuffData_FinishBlock(Stuff_Same + count);
700 break;
702 /* else, we only have one so far, so switch to Stuff_Diff code */
703 code = Stuff_Diff;
704 /* and fall through to Stuff_Diff case below
705 * Note cunning cleverness here: case Stuff_Diff compares
706 * the current character with the previous two to see if it
707 * has a run of three the same. Won't this be an error if
708 * there aren't two previous characters stored to compare with?
709 * No. Because we know the current character is *not* the same
710 * as the previous one, the first test below will necessarily
711 * fail and the send half of the "if" won't be executed.
714 /* Stuff_Diff: We have at least two *different* bytes encoded */
715 case Stuff_Diff:
716 /* If this is a zero, must encode a Stuff_DiffZero, and begin a new block */
717 if (*src == 0)
719 StuffData_FinishBlock(Stuff_DiffZero + count);
721 /* else, if we have three in a row, it is worth starting a Stuff_Same block */
722 else if ((*src ^ Stuff_Magic)==dst[-1] && dst[-1]==dst[-2])
724 /* Back off the last two characters we encoded */
725 code += count-2;
726 /* Note: "Stuff_Diff + 0" is an illegal code */
727 if (code == Stuff_Diff + 0)
729 code = Stuff_Same + 0;
731 StuffData_FinishBlock(code);
732 code_ptr = dst-2;
733 /* dst[-1] already holds the correct value */
734 count = 2; /* 2 means three bytes encoded */
735 code = Stuff_Same;
737 /* else, another different byte, so add it to the block */
738 else
740 *dst++ = *src ^ Stuff_Magic;
741 count++;
743 src++; /* Consume the byte */
744 break;
746 if (count == Stuff_MaxCount)
748 StuffData_FinishBlock(code + count);
751 if (code == Stuff_NoCode)
753 *code_ptr_ptr = NULL;
755 else
757 *code_ptr_ptr = code_ptr;
758 StuffData_FinishBlock(code + count);
760 return(dst);
764 * UnStuffData decodes the data at "src", up to (but not including) "end".
765 * It writes the decoded data into the buffer pointed to by "dst", up to a
766 * maximum of "dst_length", and returns the new value of "src" so that a
767 * follow-on call can read more data, continuing from where the first left off.
769 * There are three types of results:
770 * 1. The source data runs out before extracting "dst_length" bytes:
771 * UnStuffData returns NULL to indicate failure.
772 * 2. The source data produces exactly "dst_length" bytes:
773 * UnStuffData returns new_src = end to indicate that all bytes were consumed.
774 * 3. "dst_length" bytes are extracted, with more remaining.
775 * UnStuffData returns new_src < end to indicate that there are more bytes
776 * to be read.
778 * Note: The decoding may be destructive, in that it may alter the source
779 * data in the process of decoding it (this is necessary to allow a follow-on
780 * call to resume correctly).
783 static __u8 *UnStuffData(__u8 *src, __u8 *end, __u8 *dst, __u32 dst_length)
785 __u8 *dst_end = dst + dst_length;
786 /* Sanity check */
787 if (!src || !end || !dst || !dst_length)
788 return(NULL);
789 while (src < end && dst < dst_end)
791 int count = (*src ^ Stuff_Magic) & Stuff_CountMask;
792 switch ((*src ^ Stuff_Magic) & Stuff_CodeMask)
794 case Stuff_Diff:
795 if (src+1+count >= end)
796 return(NULL);
799 *dst++ = *++src ^ Stuff_Magic;
801 while(--count >= 0 && dst < dst_end);
802 if (count < 0)
803 src += 1;
804 else
806 if (count == 0)
807 *src = Stuff_Same ^ Stuff_Magic;
808 else
809 *src = (Stuff_Diff + count) ^ Stuff_Magic;
811 break;
812 case Stuff_DiffZero:
813 if (src+1+count >= end)
814 return(NULL);
817 *dst++ = *++src ^ Stuff_Magic;
819 while(--count >= 0 && dst < dst_end);
820 if (count < 0)
821 *src = Stuff_Zero ^ Stuff_Magic;
822 else
823 *src = (Stuff_DiffZero + count) ^ Stuff_Magic;
824 break;
825 case Stuff_Same:
826 if (src+1 >= end)
827 return(NULL);
830 *dst++ = src[1] ^ Stuff_Magic;
832 while(--count >= 0 && dst < dst_end);
833 if (count < 0)
834 src += 2;
835 else
836 *src = (Stuff_Same + count) ^ Stuff_Magic;
837 break;
838 case Stuff_Zero:
841 *dst++ = 0;
843 while(--count >= 0 && dst < dst_end);
844 if (count < 0)
845 src += 1;
846 else
847 *src = (Stuff_Zero + count) ^ Stuff_Magic;
848 break;
851 if (dst < dst_end)
852 return(NULL);
853 else
854 return(src);
858 /************************************************************************/
859 /* General routines for STRIP */
862 * get_baud returns the current baud rate, as one of the constants defined in
863 * termbits.h
864 * If the user has issued a baud rate override using the 'setserial' command
865 * and the logical current rate is set to 38.4, then the true baud rate
866 * currently in effect (57.6 or 115.2) is returned.
868 static unsigned int get_baud(struct tty_struct *tty)
870 if (!tty || !tty->termios) return(0);
871 if ((tty->termios->c_cflag & CBAUD) == B38400 && tty->driver_data)
873 struct async_struct *info = (struct async_struct *)tty->driver_data;
874 if ((info->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI ) return(B57600);
875 if ((info->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI) return(B115200);
877 return(tty->termios->c_cflag & CBAUD);
881 * set_baud sets the baud rate to the rate defined by baudcode
882 * Note: The rate B38400 should be avoided, because the user may have
883 * issued a 'setserial' speed override to map that to a different speed.
884 * We could achieve a true rate of 38400 if we needed to by cancelling
885 * any user speed override that is in place, but that might annoy the
886 * user, so it is simplest to just avoid using 38400.
888 static void set_baud(struct tty_struct *tty, unsigned int baudcode)
890 struct termios old_termios = *(tty->termios);
891 tty->termios->c_cflag &= ~CBAUD; /* Clear the old baud setting */
892 tty->termios->c_cflag |= baudcode; /* Set the new baud setting */
893 tty->driver.set_termios(tty, &old_termios);
897 * Convert a string to a Metricom Address.
900 #define IS_RADIO_ADDRESS(p) ( \
901 isdigit((p)[0]) && isdigit((p)[1]) && isdigit((p)[2]) && isdigit((p)[3]) && \
902 (p)[4] == '-' && \
903 isdigit((p)[5]) && isdigit((p)[6]) && isdigit((p)[7]) && isdigit((p)[8]) )
905 static int string_to_radio_address(MetricomAddress *addr, __u8 *p)
907 if (!IS_RADIO_ADDRESS(p)) return(1);
908 addr->c[0] = 0;
909 addr->c[1] = 0;
910 addr->c[2] = READHEX(p[0]) << 4 | READHEX(p[1]);
911 addr->c[3] = READHEX(p[2]) << 4 | READHEX(p[3]);
912 addr->c[4] = READHEX(p[5]) << 4 | READHEX(p[6]);
913 addr->c[5] = READHEX(p[7]) << 4 | READHEX(p[8]);
914 return(0);
918 * Convert a Metricom Address to a string.
921 static __u8 *radio_address_to_string(const MetricomAddress *addr, MetricomAddressString *p)
923 sprintf(p->c, "%02X%02X-%02X%02X", addr->c[2], addr->c[3], addr->c[4], addr->c[5]);
924 return(p->c);
928 * Note: Must make sure sx_size is big enough to receive a stuffed
929 * MAX_RECV_MTU packet. Additionally, we also want to ensure that it's
930 * big enough to receive a large radio neighbour list (currently 4K).
933 static int allocate_buffers(struct strip *strip_info)
935 struct net_device *dev = &strip_info->dev;
936 int sx_size = MAX(STRIP_ENCAP_SIZE(MAX_RECV_MTU), 4096);
937 int tx_size = STRIP_ENCAP_SIZE(dev->mtu) + MaxCommandStringLength;
938 __u8 *r = kmalloc(MAX_RECV_MTU, GFP_ATOMIC);
939 __u8 *s = kmalloc(sx_size, GFP_ATOMIC);
940 __u8 *t = kmalloc(tx_size, GFP_ATOMIC);
941 if (r && s && t)
943 strip_info->rx_buff = r;
944 strip_info->sx_buff = s;
945 strip_info->tx_buff = t;
946 strip_info->sx_size = sx_size;
947 strip_info->tx_size = tx_size;
948 strip_info->mtu = dev->mtu;
949 return(1);
951 if (r) kfree(r);
952 if (s) kfree(s);
953 if (t) kfree(t);
954 return(0);
958 * MTU has been changed by the IP layer. Unfortunately we are not told
959 * about this, but we spot it ourselves and fix things up. We could be in
960 * an upcall from the tty driver, or in an ip packet queue.
963 static void strip_changedmtu(struct strip *strip_info)
965 int old_mtu = strip_info->mtu;
966 struct net_device *dev = &strip_info->dev;
967 unsigned char *orbuff = strip_info->rx_buff;
968 unsigned char *osbuff = strip_info->sx_buff;
969 unsigned char *otbuff = strip_info->tx_buff;
970 InterruptStatus intstat;
972 if (dev->mtu > MAX_SEND_MTU)
974 printk(KERN_ERR "%s: MTU exceeds maximum allowable (%d), MTU change cancelled.\n",
975 strip_info->dev.name, MAX_SEND_MTU);
976 dev->mtu = old_mtu;
977 return;
981 * Have to disable interrupts here because we're reallocating and resizing
982 * the serial buffers, and we can't have data arriving in them while we're
983 * moving them around in memory. This may cause data to be lost on the serial
984 * port, but hopefully people won't change MTU that often.
985 * Also note, this may not work on a symmetric multi-processor system.
987 intstat = DisableInterrupts();
989 if (!allocate_buffers(strip_info))
991 RestoreInterrupts(intstat);
992 printk(KERN_ERR "%s: unable to grow strip buffers, MTU change cancelled.\n",
993 strip_info->dev.name);
994 dev->mtu = old_mtu;
995 return;
998 if (strip_info->sx_count)
1000 if (strip_info->sx_count <= strip_info->sx_size)
1001 memcpy(strip_info->sx_buff, osbuff, strip_info->sx_count);
1002 else
1004 strip_info->discard = strip_info->sx_count;
1005 strip_info->rx_over_errors++;
1009 if (strip_info->tx_left)
1011 if (strip_info->tx_left <= strip_info->tx_size)
1012 memcpy(strip_info->tx_buff, strip_info->tx_head, strip_info->tx_left);
1013 else
1015 strip_info->tx_left = 0;
1016 strip_info->tx_dropped++;
1019 strip_info->tx_head = strip_info->tx_buff;
1021 RestoreInterrupts(intstat);
1023 printk(KERN_NOTICE "%s: strip MTU changed fom %d to %d.\n",
1024 strip_info->dev.name, old_mtu, strip_info->mtu);
1026 if (orbuff) kfree(orbuff);
1027 if (osbuff) kfree(osbuff);
1028 if (otbuff) kfree(otbuff);
1031 static void strip_unlock(struct strip *strip_info)
1034 * Set the timer to go off in one second.
1036 strip_info->idle_timer.expires = jiffies + 1*HZ;
1037 add_timer(&strip_info->idle_timer);
1038 if (!test_and_clear_bit(0, (void *)&strip_info->dev.tbusy))
1039 printk(KERN_ERR "%s: trying to unlock already unlocked device!\n",
1040 strip_info->dev.name);
1044 /************************************************************************/
1045 /* Callback routines for exporting information through /proc */
1048 * This function updates the total amount of data printed so far. It then
1049 * determines if the amount of data printed into a buffer has reached the
1050 * offset requested. If it hasn't, then the buffer is shifted over so that
1051 * the next bit of data can be printed over the old bit. If the total
1052 * amount printed so far exceeds the total amount requested, then this
1053 * function returns 1, otherwise 0.
1055 static int
1056 shift_buffer(char *buffer, int requested_offset, int requested_len,
1057 int *total, int *slop, char **buf)
1059 int printed;
1061 /* printk(KERN_DEBUG "shift: buffer: %d o: %d l: %d t: %d buf: %d\n",
1062 (int) buffer, requested_offset, requested_len, *total,
1063 (int) *buf); */
1064 printed = *buf - buffer;
1065 if (*total + printed <= requested_offset) {
1066 *total += printed;
1067 *buf = buffer;
1069 else {
1070 if (*total < requested_offset) {
1071 *slop = requested_offset - *total;
1073 *total = requested_offset + printed - *slop;
1075 if (*total > requested_offset + requested_len) {
1076 return 1;
1078 else {
1079 return 0;
1084 * This function calculates the actual start of the requested data
1085 * in the buffer. It also calculates actual length of data returned,
1086 * which could be less that the amount of data requested.
1088 static int
1089 calc_start_len(char *buffer, char **start, int requested_offset,
1090 int requested_len, int total, char *buf)
1092 int return_len, buffer_len;
1094 buffer_len = buf - buffer;
1095 if (buffer_len >= 4095) {
1096 printk(KERN_ERR "STRIP: exceeded /proc buffer size\n");
1100 * There may be bytes before and after the
1101 * chunk that was actually requested.
1103 return_len = total - requested_offset;
1104 if (return_len < 0) {
1105 return_len = 0;
1107 *start = buf - return_len;
1108 if (return_len > requested_len) {
1109 return_len = requested_len;
1111 /* printk(KERN_DEBUG "return_len: %d\n", return_len); */
1112 return return_len;
1116 * If the time is in the near future, time_delta prints the number of
1117 * seconds to go into the buffer and returns the address of the buffer.
1118 * If the time is not in the near future, it returns the address of the
1119 * string "Not scheduled" The buffer must be long enough to contain the
1120 * ascii representation of the number plus 9 charactes for the " seconds"
1121 * and the null character.
1123 static char *time_delta(char buffer[], long time)
1125 time -= jiffies;
1126 if (time > LongTime / 2) return("Not scheduled");
1127 if(time < 0) time = 0; /* Don't print negative times */
1128 sprintf(buffer, "%ld seconds", time / HZ);
1129 return(buffer);
1132 static int sprintf_neighbours(char *buffer, MetricomNodeTable *table, char *title)
1134 /* We wrap this in a do/while loop, so if the table changes */
1135 /* while we're reading it, we just go around and try again. */
1136 struct timeval t;
1137 char *ptr;
1140 int i;
1141 t = table->timestamp;
1142 ptr = buffer;
1143 if (table->num_nodes) ptr += sprintf(ptr, "\n %s\n", title);
1144 for (i=0; i<table->num_nodes; i++)
1146 InterruptStatus intstat = DisableInterrupts();
1147 MetricomNode node = table->node[i];
1148 RestoreInterrupts(intstat);
1149 ptr += sprintf(ptr, " %s\n", node.c);
1151 } while (table->timestamp.tv_sec != t.tv_sec || table->timestamp.tv_usec != t.tv_usec);
1152 return ptr - buffer;
1156 * This function prints radio status information into the specified buffer.
1157 * I think the buffer size is 4K, so this routine should never print more
1158 * than 4K of data into it. With the maximum of 32 portables and 32 poletops
1159 * reported, the routine outputs 3107 bytes into the buffer.
1161 static int
1162 sprintf_status_info(char *buffer, struct strip *strip_info)
1164 char temp[32];
1165 char *p = buffer;
1166 MetricomAddressString addr_string;
1168 /* First, we must copy all of our data to a safe place, */
1169 /* in case a serial interrupt comes in and changes it. */
1170 InterruptStatus intstat = DisableInterrupts();
1171 int tx_left = strip_info->tx_left;
1172 unsigned long rx_average_pps = strip_info->rx_average_pps;
1173 unsigned long tx_average_pps = strip_info->tx_average_pps;
1174 unsigned long sx_average_pps = strip_info->sx_average_pps;
1175 int working = strip_info->working;
1176 int firmware_level = strip_info->firmware_level;
1177 long watchdog_doprobe = strip_info->watchdog_doprobe;
1178 long watchdog_doreset = strip_info->watchdog_doreset;
1179 long gratuitous_arp = strip_info->gratuitous_arp;
1180 long arp_interval = strip_info->arp_interval;
1181 FirmwareVersion firmware_version = strip_info->firmware_version;
1182 SerialNumber serial_number = strip_info->serial_number;
1183 BatteryVoltage battery_voltage = strip_info->battery_voltage;
1184 char8 if_name = strip_info->if_name;
1185 MetricomAddress true_dev_addr = strip_info->true_dev_addr;
1186 MetricomAddress dev_dev_addr = *(MetricomAddress*)strip_info->dev.dev_addr;
1187 int manual_dev_addr = strip_info->manual_dev_addr;
1188 #ifdef EXT_COUNTERS
1189 unsigned long rx_bytes = strip_info->rx_bytes;
1190 unsigned long tx_bytes = strip_info->tx_bytes;
1191 unsigned long rx_rbytes = strip_info->rx_rbytes;
1192 unsigned long tx_rbytes = strip_info->tx_rbytes;
1193 unsigned long rx_sbytes = strip_info->rx_sbytes;
1194 unsigned long tx_sbytes = strip_info->tx_sbytes;
1195 unsigned long rx_ebytes = strip_info->rx_ebytes;
1196 unsigned long tx_ebytes = strip_info->tx_ebytes;
1197 #endif
1198 RestoreInterrupts(intstat);
1200 p += sprintf(p, "\nInterface name\t\t%s\n", if_name.c);
1201 p += sprintf(p, " Radio working:\t\t%s\n", working ? "Yes" : "No");
1202 radio_address_to_string(&true_dev_addr, &addr_string);
1203 p += sprintf(p, " Radio address:\t\t%s\n", addr_string.c);
1204 if (manual_dev_addr)
1206 radio_address_to_string(&dev_dev_addr, &addr_string);
1207 p += sprintf(p, " Device address:\t%s\n", addr_string.c);
1209 p += sprintf(p, " Firmware version:\t%s", !working ? "Unknown" :
1210 !firmware_level ? "Should be upgraded" :
1211 firmware_version.c);
1212 if (firmware_level >= ChecksummedMessages) p += sprintf(p, " (Checksums Enabled)");
1213 p += sprintf(p, "\n");
1214 p += sprintf(p, " Serial number:\t\t%s\n", serial_number.c);
1215 p += sprintf(p, " Battery voltage:\t%s\n", battery_voltage.c);
1216 p += sprintf(p, " Transmit queue (bytes):%d\n", tx_left);
1217 p += sprintf(p, " Receive packet rate: %ld packets per second\n", rx_average_pps / 8);
1218 p += sprintf(p, " Transmit packet rate: %ld packets per second\n", tx_average_pps / 8);
1219 p += sprintf(p, " Sent packet rate: %ld packets per second\n", sx_average_pps / 8);
1220 p += sprintf(p, " Next watchdog probe:\t%s\n", time_delta(temp, watchdog_doprobe));
1221 p += sprintf(p, " Next watchdog reset:\t%s\n", time_delta(temp, watchdog_doreset));
1222 p += sprintf(p, " Next gratuitous ARP:\t");
1224 if (!memcmp(strip_info->dev.dev_addr, zero_address.c, sizeof(zero_address)))
1225 p += sprintf(p, "Disabled\n");
1226 else
1228 p += sprintf(p, "%s\n", time_delta(temp, gratuitous_arp));
1229 p += sprintf(p, " Next ARP interval:\t%ld seconds\n", JIFFIE_TO_SEC(arp_interval));
1232 if (working)
1234 #ifdef EXT_COUNTERS
1235 p += sprintf(p, "\n");
1236 p += sprintf(p, " Total bytes: \trx:\t%lu\ttx:\t%lu\n", rx_bytes, tx_bytes);
1237 p += sprintf(p, " thru radio: \trx:\t%lu\ttx:\t%lu\n", rx_rbytes, tx_rbytes);
1238 p += sprintf(p, " thru serial port: \trx:\t%lu\ttx:\t%lu\n", rx_sbytes, tx_sbytes);
1239 p += sprintf(p, " Total stat/err bytes:\trx:\t%lu\ttx:\t%lu\n", rx_ebytes, tx_ebytes);
1240 #endif
1241 p += sprintf_neighbours(p, &strip_info->poletops, "Poletops:");
1242 p += sprintf_neighbours(p, &strip_info->portables, "Portables:");
1245 return p - buffer;
1249 * This function is exports status information from the STRIP driver through
1250 * the /proc file system.
1253 static int get_status_info(char *buffer, char **start, off_t req_offset, int req_len, int dummy)
1255 int total = 0, slop = 0;
1256 struct strip *strip_info = struct_strip_list;
1257 char *buf = buffer;
1259 buf += sprintf(buf, "strip_version: %s\n", StripVersion);
1260 if (shift_buffer(buffer, req_offset, req_len, &total, &slop, &buf)) goto exit;
1262 while (strip_info != NULL)
1264 buf += sprintf_status_info(buf, strip_info);
1265 if (shift_buffer(buffer, req_offset, req_len, &total, &slop, &buf)) break;
1266 strip_info = strip_info->next;
1268 exit:
1269 return(calc_start_len(buffer, start, req_offset, req_len, total, buf));
1272 static const char proc_strip_status_name[] = "strip";
1274 #ifdef CONFIG_PROC_FS
1275 static struct proc_dir_entry proc_strip_get_status_info =
1277 PROC_NET_STRIP_STATUS, /* unsigned short low_ino */
1278 sizeof(proc_strip_status_name)-1, /* unsigned short namelen */
1279 proc_strip_status_name, /* const char *name */
1280 S_IFREG | S_IRUGO, /* mode_t mode */
1281 1, /* nlink_t nlink */
1282 0, 0, 0, /* uid_t uid, gid_t gid, unsigned long size */
1283 &proc_net_inode_operations, /* struct inode_operations * ops */
1284 &get_status_info, /* int (*get_info)(...) */
1285 NULL, /* void (*fill_inode)(struct inode *); */
1286 NULL, NULL, NULL, /* struct proc_dir_entry *next, *parent, *subdir; */
1287 NULL /* void *data; */
1289 #endif /* CONFIG_PROC_FS */
1291 /************************************************************************/
1292 /* Sending routines */
1294 static void ResetRadio(struct strip *strip_info)
1296 struct tty_struct *tty = strip_info->tty;
1297 static const char init[] = "ate0q1dt**starmode\r**";
1298 StringDescriptor s = { init, sizeof(init)-1 };
1301 * If the radio isn't working anymore,
1302 * we should clear the old status information.
1304 if (strip_info->working)
1306 printk(KERN_INFO "%s: No response: Resetting radio.\n", strip_info->dev.name);
1307 strip_info->firmware_version.c[0] = '\0';
1308 strip_info->serial_number.c[0] = '\0';
1309 strip_info->battery_voltage.c[0] = '\0';
1310 strip_info->portables.num_nodes = 0;
1311 do_gettimeofday(&strip_info->portables.timestamp);
1312 strip_info->poletops.num_nodes = 0;
1313 do_gettimeofday(&strip_info->poletops.timestamp);
1316 strip_info->pps_timer = jiffies;
1317 strip_info->rx_pps_count = 0;
1318 strip_info->tx_pps_count = 0;
1319 strip_info->sx_pps_count = 0;
1320 strip_info->rx_average_pps = 0;
1321 strip_info->tx_average_pps = 0;
1322 strip_info->sx_average_pps = 0;
1324 /* Mark radio address as unknown */
1325 *(MetricomAddress*)&strip_info->true_dev_addr = zero_address;
1326 if (!strip_info->manual_dev_addr)
1327 *(MetricomAddress*)strip_info->dev.dev_addr = zero_address;
1328 strip_info->working = FALSE;
1329 strip_info->firmware_level = NoStructure;
1330 strip_info->next_command = CompatibilityCommand;
1331 strip_info->watchdog_doprobe = jiffies + 10 * HZ;
1332 strip_info->watchdog_doreset = jiffies + 1 * HZ;
1334 /* If the user has selected a baud rate above 38.4 see what magic we have to do */
1335 if (strip_info->user_baud > B38400)
1338 * Subtle stuff: Pay attention :-)
1339 * If the serial port is currently at the user's selected (>38.4) rate,
1340 * then we temporarily switch to 19.2 and issue the ATS304 command
1341 * to tell the radio to switch to the user's selected rate.
1342 * If the serial port is not currently at that rate, that means we just
1343 * issued the ATS304 command last time through, so this time we restore
1344 * the user's selected rate and issue the normal starmode reset string.
1346 if (strip_info->user_baud == get_baud(tty))
1348 static const char b0[] = "ate0q1s304=57600\r";
1349 static const char b1[] = "ate0q1s304=115200\r";
1350 static const StringDescriptor baudstring[2] =
1351 { { b0, sizeof(b0)-1 }, { b1, sizeof(b1)-1 } };
1352 set_baud(tty, B19200);
1353 if (strip_info->user_baud == B57600 ) s = baudstring[0];
1354 else if (strip_info->user_baud == B115200) s = baudstring[1];
1355 else s = baudstring[1]; /* For now */
1357 else set_baud(tty, strip_info->user_baud);
1360 tty->driver.write(tty, 0, s.string, s.length);
1361 #ifdef EXT_COUNTERS
1362 strip_info->tx_ebytes += s.length;
1363 #endif
1367 * Called by the driver when there's room for more data. If we have
1368 * more packets to send, we send them here.
1371 static void strip_write_some_more(struct tty_struct *tty)
1373 struct strip *strip_info = (struct strip *) tty->disc_data;
1375 /* First make sure we're connected. */
1376 if (!strip_info || strip_info->magic != STRIP_MAGIC || !strip_info->dev.start)
1377 return;
1379 if (strip_info->tx_left > 0)
1382 * If some data left, send it
1383 * Note: There's a kernel design bug here. The write_wakeup routine has to
1384 * know how many bytes were written in the previous call, but the number of
1385 * bytes written is returned as the result of the tty->driver.write call,
1386 * and there's no guarantee that the tty->driver.write routine will have
1387 * returned before the write_wakeup routine is invoked. If the PC has fast
1388 * Serial DMA hardware, then it's quite possible that the write could complete
1389 * almost instantaneously, meaning that my write_wakeup routine could be
1390 * called immediately, before tty->driver.write has had a chance to return
1391 * the number of bytes that it wrote. In an attempt to guard against this,
1392 * I disable interrupts around the call to tty->driver.write, although even
1393 * this might not work on a symmetric multi-processor system.
1395 InterruptStatus intstat = DisableInterrupts();
1396 int num_written = tty->driver.write(tty, 0, strip_info->tx_head, strip_info->tx_left);
1397 strip_info->tx_left -= num_written;
1398 strip_info->tx_head += num_written;
1399 #ifdef EXT_COUNTERS
1400 strip_info->tx_sbytes += num_written;
1401 #endif
1402 RestoreInterrupts(intstat);
1404 else /* Else start transmission of another packet */
1406 tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
1407 strip_unlock(strip_info);
1408 mark_bh(NET_BH);
1412 static __u8 *add_checksum(__u8 *buffer, __u8 *end)
1414 __u16 sum = 0;
1415 __u8 *p = buffer;
1416 while (p < end) sum += *p++;
1417 end[3] = hextable[sum & 0xF]; sum >>= 4;
1418 end[2] = hextable[sum & 0xF]; sum >>= 4;
1419 end[1] = hextable[sum & 0xF]; sum >>= 4;
1420 end[0] = hextable[sum & 0xF];
1421 return(end+4);
1424 static unsigned char *strip_make_packet(unsigned char *buffer, struct strip *strip_info, struct sk_buff *skb)
1426 __u8 *ptr = buffer;
1427 __u8 *stuffstate = NULL;
1428 STRIP_Header *header = (STRIP_Header *)skb->data;
1429 MetricomAddress haddr = header->dst_addr;
1430 int len = skb->len - sizeof(STRIP_Header);
1431 MetricomKey key;
1433 /*HexDump("strip_make_packet", strip_info, skb->data, skb->data + skb->len);*/
1435 if (header->protocol == htons(ETH_P_IP)) key = SIP0Key;
1436 else if (header->protocol == htons(ETH_P_ARP)) key = ARP0Key;
1437 else
1439 printk(KERN_ERR "%s: strip_make_packet: Unknown packet type 0x%04X\n",
1440 strip_info->dev.name, ntohs(header->protocol));
1441 return(NULL);
1444 if (len > strip_info->mtu)
1446 printk(KERN_ERR "%s: Dropping oversized transmit packet: %d bytes\n",
1447 strip_info->dev.name, len);
1448 return(NULL);
1452 * If we're sending to ourselves, discard the packet.
1453 * (Metricom radios choke if they try to send a packet to their own address.)
1455 if (!memcmp(haddr.c, strip_info->true_dev_addr.c, sizeof(haddr)))
1457 printk(KERN_ERR "%s: Dropping packet addressed to self\n", strip_info->dev.name);
1458 return(NULL);
1462 * If this is a broadcast packet, send it to our designated Metricom
1463 * 'broadcast hub' radio (First byte of address being 0xFF means broadcast)
1465 if (haddr.c[0] == 0xFF)
1467 u32 brd = 0;
1468 struct in_device *in_dev = in_dev_get(&strip_info->dev);
1469 if (in_dev == NULL)
1470 return NULL;
1471 read_lock(&in_dev->lock);
1472 if (in_dev->ifa_list)
1473 brd = in_dev->ifa_list->ifa_broadcast;
1474 read_unlock(&in_dev->lock);
1475 in_dev_put(in_dev);
1477 /* arp_query returns 1 if it succeeds in looking up the address, 0 if it fails */
1478 if (!arp_query(haddr.c, brd, &strip_info->dev))
1480 printk(KERN_ERR "%s: Unable to send packet (no broadcast hub configured)\n",
1481 strip_info->dev.name);
1482 return(NULL);
1485 * If we are the broadcast hub, don't bother sending to ourselves.
1486 * (Metricom radios choke if they try to send a packet to their own address.)
1488 if (!memcmp(haddr.c, strip_info->true_dev_addr.c, sizeof(haddr))) return(NULL);
1491 *ptr++ = 0x0D;
1492 *ptr++ = '*';
1493 *ptr++ = hextable[haddr.c[2] >> 4];
1494 *ptr++ = hextable[haddr.c[2] & 0xF];
1495 *ptr++ = hextable[haddr.c[3] >> 4];
1496 *ptr++ = hextable[haddr.c[3] & 0xF];
1497 *ptr++ = '-';
1498 *ptr++ = hextable[haddr.c[4] >> 4];
1499 *ptr++ = hextable[haddr.c[4] & 0xF];
1500 *ptr++ = hextable[haddr.c[5] >> 4];
1501 *ptr++ = hextable[haddr.c[5] & 0xF];
1502 *ptr++ = '*';
1503 *ptr++ = key.c[0];
1504 *ptr++ = key.c[1];
1505 *ptr++ = key.c[2];
1506 *ptr++ = key.c[3];
1508 ptr = StuffData(skb->data + sizeof(STRIP_Header), len, ptr, &stuffstate);
1510 if (strip_info->firmware_level >= ChecksummedMessages) ptr = add_checksum(buffer+1, ptr);
1512 *ptr++ = 0x0D;
1513 return(ptr);
1516 static void strip_send(struct strip *strip_info, struct sk_buff *skb)
1518 MetricomAddress haddr;
1519 unsigned char *ptr = strip_info->tx_buff;
1520 int doreset = (long)jiffies - strip_info->watchdog_doreset >= 0;
1521 int doprobe = (long)jiffies - strip_info->watchdog_doprobe >= 0 && !doreset;
1522 u32 addr, brd;
1525 * 1. If we have a packet, encapsulate it and put it in the buffer
1527 if (skb)
1529 char *newptr = strip_make_packet(ptr, strip_info, skb);
1530 strip_info->tx_pps_count++;
1531 if (!newptr) strip_info->tx_dropped++;
1532 else
1534 ptr = newptr;
1535 strip_info->sx_pps_count++;
1536 strip_info->tx_packets++; /* Count another successful packet */
1537 #ifdef EXT_COUNTERS
1538 strip_info->tx_bytes += skb->len;
1539 strip_info->tx_rbytes += ptr - strip_info->tx_buff;
1540 #endif
1541 /*DumpData("Sending:", strip_info, strip_info->tx_buff, ptr);*/
1542 /*HexDump("Sending", strip_info, strip_info->tx_buff, ptr);*/
1547 * 2. If it is time for another tickle, tack it on, after the packet
1549 if (doprobe)
1551 StringDescriptor ts = CommandString[strip_info->next_command];
1552 #if TICKLE_TIMERS
1554 struct timeval tv;
1555 do_gettimeofday(&tv);
1556 printk(KERN_INFO "**** Sending tickle string %d at %02d.%06d\n",
1557 strip_info->next_command, tv.tv_sec % 100, tv.tv_usec);
1559 #endif
1560 if (ptr == strip_info->tx_buff) *ptr++ = 0x0D;
1562 *ptr++ = '*'; /* First send "**" to provoke an error message */
1563 *ptr++ = '*';
1565 /* Then add the command */
1566 memcpy(ptr, ts.string, ts.length);
1568 /* Add a checksum ? */
1569 if (strip_info->firmware_level < ChecksummedMessages) ptr += ts.length;
1570 else ptr = add_checksum(ptr, ptr + ts.length);
1572 *ptr++ = 0x0D; /* Terminate the command with a <CR> */
1574 /* Cycle to next periodic command? */
1575 if (strip_info->firmware_level >= StructuredMessages)
1576 if (++strip_info->next_command >= ELEMENTS_OF(CommandString))
1577 strip_info->next_command = 0;
1578 #ifdef EXT_COUNTERS
1579 strip_info->tx_ebytes += ts.length;
1580 #endif
1581 strip_info->watchdog_doprobe = jiffies + 10 * HZ;
1582 strip_info->watchdog_doreset = jiffies + 1 * HZ;
1583 /*printk(KERN_INFO "%s: Routine radio test.\n", strip_info->dev.name);*/
1587 * 3. Set up the strip_info ready to send the data (if any).
1589 strip_info->tx_head = strip_info->tx_buff;
1590 strip_info->tx_left = ptr - strip_info->tx_buff;
1591 strip_info->tty->flags |= (1 << TTY_DO_WRITE_WAKEUP);
1594 * 4. Debugging check to make sure we're not overflowing the buffer.
1596 if (strip_info->tx_size - strip_info->tx_left < 20)
1597 printk(KERN_ERR "%s: Sending%5d bytes;%5d bytes free.\n", strip_info->dev.name,
1598 strip_info->tx_left, strip_info->tx_size - strip_info->tx_left);
1601 * 5. If watchdog has expired, reset the radio. Note: if there's data waiting in
1602 * the buffer, strip_write_some_more will send it after the reset has finished
1604 if (doreset) { ResetRadio(strip_info); return; }
1606 if (1) {
1607 struct in_device *in_dev = in_dev_get(&strip_info->dev);
1608 brd = addr = 0;
1609 if (in_dev) {
1610 read_lock(&in_dev->lock);
1611 if (in_dev->ifa_list) {
1612 brd = in_dev->ifa_list->ifa_broadcast;
1613 addr = in_dev->ifa_list->ifa_local;
1615 read_unlock(&in_dev->lock);
1616 in_dev_put(in_dev);
1622 * 6. If it is time for a periodic ARP, queue one up to be sent.
1623 * We only do this if:
1624 * 1. The radio is working
1625 * 2. It's time to send another periodic ARP
1626 * 3. We really know what our address is (and it is not manually set to zero)
1627 * 4. We have a designated broadcast address configured
1628 * If we queue up an ARP packet when we don't have a designated broadcast
1629 * address configured, then the packet will just have to be discarded in
1630 * strip_make_packet. This is not fatal, but it causes misleading information
1631 * to be displayed in tcpdump. tcpdump will report that periodic APRs are
1632 * being sent, when in fact they are not, because they are all being dropped
1633 * in the strip_make_packet routine.
1635 if (strip_info->working && (long)jiffies - strip_info->gratuitous_arp >= 0 &&
1636 memcmp(strip_info->dev.dev_addr, zero_address.c, sizeof(zero_address)) &&
1637 arp_query(haddr.c, brd, &strip_info->dev))
1639 /*printk(KERN_INFO "%s: Sending gratuitous ARP with interval %ld\n",
1640 strip_info->dev.name, strip_info->arp_interval / HZ);*/
1641 strip_info->gratuitous_arp = jiffies + strip_info->arp_interval;
1642 strip_info->arp_interval *= 2;
1643 if (strip_info->arp_interval > MaxARPInterval)
1644 strip_info->arp_interval = MaxARPInterval;
1645 if (addr)
1646 arp_send(
1647 ARPOP_REPLY, ETH_P_ARP,
1648 addr, /* Target address of ARP packet is our address */
1649 &strip_info->dev, /* Device to send packet on */
1650 addr, /* Source IP address this ARP packet comes from */
1651 NULL, /* Destination HW address is NULL (broadcast it) */
1652 strip_info->dev.dev_addr, /* Source HW address is our HW address */
1653 strip_info->dev.dev_addr); /* Target HW address is our HW address (redundant) */
1657 * 7. All ready. Start the transmission
1659 strip_write_some_more(strip_info->tty);
1662 /* Encapsulate a datagram and kick it into a TTY queue. */
1663 static int strip_xmit(struct sk_buff *skb, struct net_device *dev)
1665 struct strip *strip_info = (struct strip *)(dev->priv);
1667 if (!dev->start)
1669 printk(KERN_ERR "%s: xmit call when iface is down\n", dev->name);
1670 return(1);
1672 if (test_and_set_bit(0, (void *) &strip_info->dev.tbusy)) return(1);
1673 del_timer(&strip_info->idle_timer);
1675 /* See if someone has been ifconfigging */
1676 if (strip_info->mtu != strip_info->dev.mtu)
1677 strip_changedmtu(strip_info);
1679 if (jiffies - strip_info->pps_timer > HZ)
1681 unsigned long t = jiffies - strip_info->pps_timer;
1682 unsigned long rx_pps_count = (strip_info->rx_pps_count * HZ * 8 + t/2) / t;
1683 unsigned long tx_pps_count = (strip_info->tx_pps_count * HZ * 8 + t/2) / t;
1684 unsigned long sx_pps_count = (strip_info->sx_pps_count * HZ * 8 + t/2) / t;
1686 strip_info->pps_timer = jiffies;
1687 strip_info->rx_pps_count = 0;
1688 strip_info->tx_pps_count = 0;
1689 strip_info->sx_pps_count = 0;
1691 strip_info->rx_average_pps = (strip_info->rx_average_pps + rx_pps_count + 1) / 2;
1692 strip_info->tx_average_pps = (strip_info->tx_average_pps + tx_pps_count + 1) / 2;
1693 strip_info->sx_average_pps = (strip_info->sx_average_pps + sx_pps_count + 1) / 2;
1695 if (rx_pps_count / 8 >= 10)
1696 printk(KERN_INFO "%s: WARNING: Receiving %ld packets per second.\n",
1697 strip_info->dev.name, rx_pps_count / 8);
1698 if (tx_pps_count / 8 >= 10)
1699 printk(KERN_INFO "%s: WARNING: Tx %ld packets per second.\n",
1700 strip_info->dev.name, tx_pps_count / 8);
1701 if (sx_pps_count / 8 >= 10)
1702 printk(KERN_INFO "%s: WARNING: Sending %ld packets per second.\n",
1703 strip_info->dev.name, sx_pps_count / 8);
1706 strip_send(strip_info, skb);
1708 if (skb) dev_kfree_skb(skb);
1709 return(0);
1713 * IdleTask periodically calls strip_xmit, so even when we have no IP packets
1714 * to send for an extended period of time, the watchdog processing still gets
1715 * done to ensure that the radio stays in Starmode
1718 static void strip_IdleTask(unsigned long parameter)
1720 strip_xmit(NULL, (struct net_device *)parameter);
1724 * Create the MAC header for an arbitrary protocol layer
1726 * saddr!=NULL means use this specific address (n/a for Metricom)
1727 * saddr==NULL means use default device source address
1728 * daddr!=NULL means use this destination address
1729 * daddr==NULL means leave destination address alone
1730 * (e.g. unresolved arp -- kernel will call
1731 * rebuild_header later to fill in the address)
1734 static int strip_header(struct sk_buff *skb, struct net_device *dev,
1735 unsigned short type, void *daddr, void *saddr, unsigned len)
1737 struct strip *strip_info = (struct strip *)(dev->priv);
1738 STRIP_Header *header = (STRIP_Header *)skb_push(skb, sizeof(STRIP_Header));
1740 /*printk(KERN_INFO "%s: strip_header 0x%04X %s\n", dev->name, type,
1741 type == ETH_P_IP ? "IP" : type == ETH_P_ARP ? "ARP" : "");*/
1743 header->src_addr = strip_info->true_dev_addr;
1744 header->protocol = htons(type);
1746 /*HexDump("strip_header", (struct strip *)(dev->priv), skb->data, skb->data + skb->len);*/
1748 if (!daddr) return(-dev->hard_header_len);
1750 header->dst_addr = *(MetricomAddress*)daddr;
1751 return(dev->hard_header_len);
1755 * Rebuild the MAC header. This is called after an ARP
1756 * (or in future other address resolution) has completed on this
1757 * sk_buff. We now let ARP fill in the other fields.
1758 * I think this should return zero if packet is ready to send,
1759 * or non-zero if it needs more time to do an address lookup
1762 static int strip_rebuild_header(struct sk_buff *skb)
1764 #ifdef CONFIG_INET
1765 STRIP_Header *header = (STRIP_Header *) skb->data;
1767 /* Arp find returns zero if if knows the address, */
1768 /* or if it doesn't know the address it sends an ARP packet and returns non-zero */
1769 return arp_find(header->dst_addr.c, skb)? 1 : 0;
1770 #else
1771 return 0;
1772 #endif
1776 /************************************************************************/
1777 /* Receiving routines */
1779 static int strip_receive_room(struct tty_struct *tty)
1781 return 0x10000; /* We can handle an infinite amount of data. :-) */
1785 * This function parses the response to the ATS300? command,
1786 * extracting the radio version and serial number.
1788 static void get_radio_version(struct strip *strip_info, __u8 *ptr, __u8 *end)
1790 __u8 *p, *value_begin, *value_end;
1791 int len;
1793 /* Determine the beginning of the second line of the payload */
1794 p = ptr;
1795 while (p < end && *p != 10) p++;
1796 if (p >= end) return;
1797 p++;
1798 value_begin = p;
1800 /* Determine the end of line */
1801 while (p < end && *p != 10) p++;
1802 if (p >= end) return;
1803 value_end = p;
1804 p++;
1806 len = value_end - value_begin;
1807 len = MIN(len, sizeof(FirmwareVersion) - 1);
1808 if (strip_info->firmware_version.c[0] == 0)
1809 printk(KERN_INFO "%s: Radio Firmware: %.*s\n",
1810 strip_info->dev.name, len, value_begin);
1811 sprintf(strip_info->firmware_version.c, "%.*s", len, value_begin);
1813 /* Look for the first colon */
1814 while (p < end && *p != ':') p++;
1815 if (p >= end) return;
1816 /* Skip over the space */
1817 p += 2;
1818 len = sizeof(SerialNumber) - 1;
1819 if (p + len <= end) {
1820 sprintf(strip_info->serial_number.c, "%.*s", len, p);
1822 else {
1823 printk(KERN_DEBUG "STRIP: radio serial number shorter (%d) than expected (%d)\n",
1824 end - p, len);
1829 * This function parses the response to the ATS325? command,
1830 * extracting the radio battery voltage.
1832 static void get_radio_voltage(struct strip *strip_info, __u8 *ptr, __u8 *end)
1834 int len;
1836 len = sizeof(BatteryVoltage) - 1;
1837 if (ptr + len <= end) {
1838 sprintf(strip_info->battery_voltage.c, "%.*s", len, ptr);
1840 else {
1841 printk(KERN_DEBUG "STRIP: radio voltage string shorter (%d) than expected (%d)\n",
1842 end - ptr, len);
1847 * This function parses the responses to the AT~LA and ATS311 commands,
1848 * which list the radio's neighbours.
1850 static void get_radio_neighbours(MetricomNodeTable *table, __u8 *ptr, __u8 *end)
1852 table->num_nodes = 0;
1853 while (ptr < end && table->num_nodes < NODE_TABLE_SIZE)
1855 MetricomNode *node = &table->node[table->num_nodes++];
1856 char *dst = node->c, *limit = dst + sizeof(*node) - 1;
1857 while (ptr < end && *ptr <= 32) ptr++;
1858 while (ptr < end && dst < limit && *ptr != 10) *dst++ = *ptr++;
1859 *dst++ = 0;
1860 while (ptr < end && ptr[-1] != 10) ptr++;
1862 do_gettimeofday(&table->timestamp);
1865 static int get_radio_address(struct strip *strip_info, __u8 *p)
1867 MetricomAddress addr;
1869 if (string_to_radio_address(&addr, p)) return(1);
1871 /* See if our radio address has changed */
1872 if (memcmp(strip_info->true_dev_addr.c, addr.c, sizeof(addr)))
1874 MetricomAddressString addr_string;
1875 radio_address_to_string(&addr, &addr_string);
1876 printk(KERN_INFO "%s: Radio address = %s\n", strip_info->dev.name, addr_string.c);
1877 strip_info->true_dev_addr = addr;
1878 if (!strip_info->manual_dev_addr) *(MetricomAddress*)strip_info->dev.dev_addr = addr;
1879 /* Give the radio a few seconds to get its head straight, then send an arp */
1880 strip_info->gratuitous_arp = jiffies + 15 * HZ;
1881 strip_info->arp_interval = 1 * HZ;
1883 return(0);
1886 static int verify_checksum(struct strip *strip_info)
1888 __u8 *p = strip_info->sx_buff;
1889 __u8 *end = strip_info->sx_buff + strip_info->sx_count - 4;
1890 u_short sum = (READHEX16(end[0]) << 12) | (READHEX16(end[1]) << 8) |
1891 (READHEX16(end[2]) << 4) | (READHEX16(end[3]));
1892 while (p < end) sum -= *p++;
1893 if (sum == 0 && strip_info->firmware_level == StructuredMessages)
1895 strip_info->firmware_level = ChecksummedMessages;
1896 printk(KERN_INFO "%s: Radio provides message checksums\n", strip_info->dev.name);
1898 return(sum == 0);
1901 static void RecvErr(char *msg, struct strip *strip_info)
1903 __u8 *ptr = strip_info->sx_buff;
1904 __u8 *end = strip_info->sx_buff + strip_info->sx_count;
1905 DumpData(msg, strip_info, ptr, end);
1906 strip_info->rx_errors++;
1909 static void RecvErr_Message(struct strip *strip_info, __u8 *sendername, const __u8 *msg, u_long len)
1911 if (has_prefix(msg, len, "001")) /* Not in StarMode! */
1913 RecvErr("Error Msg:", strip_info);
1914 printk(KERN_INFO "%s: Radio %s is not in StarMode\n",
1915 strip_info->dev.name, sendername);
1918 else if (has_prefix(msg, len, "002")) /* Remap handle */
1920 /* We ignore "Remap handle" messages for now */
1923 else if (has_prefix(msg, len, "003")) /* Can't resolve name */
1925 RecvErr("Error Msg:", strip_info);
1926 printk(KERN_INFO "%s: Destination radio name is unknown\n",
1927 strip_info->dev.name);
1930 else if (has_prefix(msg, len, "004")) /* Name too small or missing */
1932 strip_info->watchdog_doreset = jiffies + LongTime;
1933 #if TICKLE_TIMERS
1935 struct timeval tv;
1936 do_gettimeofday(&tv);
1937 printk(KERN_INFO "**** Got ERR_004 response at %02d.%06d\n",
1938 tv.tv_sec % 100, tv.tv_usec);
1940 #endif
1941 if (!strip_info->working)
1943 strip_info->working = TRUE;
1944 printk(KERN_INFO "%s: Radio now in starmode\n", strip_info->dev.name);
1946 * If the radio has just entered a working state, we should do our first
1947 * probe ASAP, so that we find out our radio address etc. without delay.
1949 strip_info->watchdog_doprobe = jiffies;
1951 if (strip_info->firmware_level == NoStructure && sendername)
1953 strip_info->firmware_level = StructuredMessages;
1954 strip_info->next_command = 0; /* Try to enable checksums ASAP */
1955 printk(KERN_INFO "%s: Radio provides structured messages\n", strip_info->dev.name);
1957 if (strip_info->firmware_level >= StructuredMessages)
1960 * If this message has a valid checksum on the end, then the call to verify_checksum
1961 * will elevate the firmware_level to ChecksummedMessages for us. (The actual return
1962 * code from verify_checksum is ignored here.)
1964 verify_checksum(strip_info);
1966 * If the radio has structured messages but we don't yet have all our information about it,
1967 * we should do probes without delay, until we have gathered all the information
1969 if (!GOT_ALL_RADIO_INFO(strip_info)) strip_info->watchdog_doprobe = jiffies;
1973 else if (has_prefix(msg, len, "005")) /* Bad count specification */
1974 RecvErr("Error Msg:", strip_info);
1976 else if (has_prefix(msg, len, "006")) /* Header too big */
1977 RecvErr("Error Msg:", strip_info);
1979 else if (has_prefix(msg, len, "007")) /* Body too big */
1981 RecvErr("Error Msg:", strip_info);
1982 printk(KERN_ERR "%s: Error! Packet size too big for radio.\n",
1983 strip_info->dev.name);
1986 else if (has_prefix(msg, len, "008")) /* Bad character in name */
1988 RecvErr("Error Msg:", strip_info);
1989 printk(KERN_ERR "%s: Radio name contains illegal character\n",
1990 strip_info->dev.name);
1993 else if (has_prefix(msg, len, "009")) /* No count or line terminator */
1994 RecvErr("Error Msg:", strip_info);
1996 else if (has_prefix(msg, len, "010")) /* Invalid checksum */
1997 RecvErr("Error Msg:", strip_info);
1999 else if (has_prefix(msg, len, "011")) /* Checksum didn't match */
2000 RecvErr("Error Msg:", strip_info);
2002 else if (has_prefix(msg, len, "012")) /* Failed to transmit packet */
2003 RecvErr("Error Msg:", strip_info);
2005 else
2006 RecvErr("Error Msg:", strip_info);
2009 static void process_AT_response(struct strip *strip_info, __u8 *ptr, __u8 *end)
2011 u_long len;
2012 __u8 *p = ptr;
2013 while (p < end && p[-1] != 10) p++; /* Skip past first newline character */
2014 /* Now ptr points to the AT command, and p points to the text of the response. */
2015 len = p-ptr;
2017 #if TICKLE_TIMERS
2019 struct timeval tv;
2020 do_gettimeofday(&tv);
2021 printk(KERN_INFO "**** Got AT response %.7s at %02d.%06d\n",
2022 ptr, tv.tv_sec % 100, tv.tv_usec);
2024 #endif
2026 if (has_prefix(ptr, len, "ATS300?" )) get_radio_version(strip_info, p, end);
2027 else if (has_prefix(ptr, len, "ATS305?" )) get_radio_address(strip_info, p);
2028 else if (has_prefix(ptr, len, "ATS311?" )) get_radio_neighbours(&strip_info->poletops, p, end);
2029 else if (has_prefix(ptr, len, "ATS319=7")) verify_checksum(strip_info);
2030 else if (has_prefix(ptr, len, "ATS325?" )) get_radio_voltage(strip_info, p, end);
2031 else if (has_prefix(ptr, len, "AT~LA" )) get_radio_neighbours(&strip_info->portables, p, end);
2032 else RecvErr("Unknown AT Response:", strip_info);
2035 static void process_ACK(struct strip *strip_info, __u8 *ptr, __u8 *end)
2037 /* Currently we don't do anything with ACKs from the radio */
2040 static void process_Info(struct strip *strip_info, __u8 *ptr, __u8 *end)
2042 if (ptr+16 > end) RecvErr("Bad Info Msg:", strip_info);
2045 static struct net_device *get_strip_dev(struct strip *strip_info)
2047 /* If our hardware address is *manually set* to zero, and we know our */
2048 /* real radio hardware address, try to find another strip device that has been */
2049 /* manually set to that address that we can 'transfer ownership' of this packet to */
2050 if (strip_info->manual_dev_addr &&
2051 !memcmp(strip_info->dev.dev_addr, zero_address.c, sizeof(zero_address)) &&
2052 memcmp(&strip_info->true_dev_addr, zero_address.c, sizeof(zero_address)))
2054 struct net_device *dev;
2055 read_lock_bh(&dev_base_lock);
2056 dev = dev_base;
2057 while (dev)
2059 if (dev->type == strip_info->dev.type &&
2060 !memcmp(dev->dev_addr, &strip_info->true_dev_addr, sizeof(MetricomAddress)))
2062 printk(KERN_INFO "%s: Transferred packet ownership to %s.\n",
2063 strip_info->dev.name, dev->name);
2064 read_unlock_bh(&dev_base_lock);
2065 return(dev);
2067 dev = dev->next;
2069 read_unlock_bh(&dev_base_lock);
2071 return(&strip_info->dev);
2075 * Send one completely decapsulated datagram to the next layer.
2078 static void deliver_packet(struct strip *strip_info, STRIP_Header *header, __u16 packetlen)
2080 struct sk_buff *skb = dev_alloc_skb(sizeof(STRIP_Header) + packetlen);
2081 if (!skb)
2083 printk(KERN_ERR "%s: memory squeeze, dropping packet.\n", strip_info->dev.name);
2084 strip_info->rx_dropped++;
2086 else
2088 memcpy(skb_put(skb, sizeof(STRIP_Header)), header, sizeof(STRIP_Header));
2089 memcpy(skb_put(skb, packetlen), strip_info->rx_buff, packetlen);
2090 skb->dev = get_strip_dev(strip_info);
2091 skb->protocol = header->protocol;
2092 skb->mac.raw = skb->data;
2094 /* Having put a fake header on the front of the sk_buff for the */
2095 /* benefit of tools like tcpdump, skb_pull now 'consumes' that */
2096 /* fake header before we hand the packet up to the next layer. */
2097 skb_pull(skb, sizeof(STRIP_Header));
2099 /* Finally, hand the packet up to the next layer (e.g. IP or ARP, etc.) */
2100 strip_info->rx_packets++;
2101 strip_info->rx_pps_count++;
2102 #ifdef EXT_COUNTERS
2103 strip_info->rx_bytes += packetlen;
2104 #endif
2105 netif_rx(skb);
2109 static void process_IP_packet(struct strip *strip_info, STRIP_Header *header, __u8 *ptr, __u8 *end)
2111 __u16 packetlen;
2113 /* Decode start of the IP packet header */
2114 ptr = UnStuffData(ptr, end, strip_info->rx_buff, 4);
2115 if (!ptr)
2117 RecvErr("IP Packet too short", strip_info);
2118 return;
2121 packetlen = ((__u16)strip_info->rx_buff[2] << 8) | strip_info->rx_buff[3];
2123 if (packetlen > MAX_RECV_MTU)
2125 printk(KERN_INFO "%s: Dropping oversized received IP packet: %d bytes\n",
2126 strip_info->dev.name, packetlen);
2127 strip_info->rx_dropped++;
2128 return;
2131 /*printk(KERN_INFO "%s: Got %d byte IP packet\n", strip_info->dev.name, packetlen);*/
2133 /* Decode remainder of the IP packet */
2134 ptr = UnStuffData(ptr, end, strip_info->rx_buff+4, packetlen-4);
2135 if (!ptr)
2137 RecvErr("IP Packet too short", strip_info);
2138 return;
2141 if (ptr < end)
2143 RecvErr("IP Packet too long", strip_info);
2144 return;
2147 header->protocol = htons(ETH_P_IP);
2149 deliver_packet(strip_info, header, packetlen);
2152 static void process_ARP_packet(struct strip *strip_info, STRIP_Header *header, __u8 *ptr, __u8 *end)
2154 __u16 packetlen;
2155 struct arphdr *arphdr = (struct arphdr *)strip_info->rx_buff;
2157 /* Decode start of the ARP packet */
2158 ptr = UnStuffData(ptr, end, strip_info->rx_buff, 8);
2159 if (!ptr)
2161 RecvErr("ARP Packet too short", strip_info);
2162 return;
2165 packetlen = 8 + (arphdr->ar_hln + arphdr->ar_pln) * 2;
2167 if (packetlen > MAX_RECV_MTU)
2169 printk(KERN_INFO "%s: Dropping oversized received ARP packet: %d bytes\n",
2170 strip_info->dev.name, packetlen);
2171 strip_info->rx_dropped++;
2172 return;
2175 /*printk(KERN_INFO "%s: Got %d byte ARP %s\n",
2176 strip_info->dev.name, packetlen,
2177 ntohs(arphdr->ar_op) == ARPOP_REQUEST ? "request" : "reply");*/
2179 /* Decode remainder of the ARP packet */
2180 ptr = UnStuffData(ptr, end, strip_info->rx_buff+8, packetlen-8);
2181 if (!ptr)
2183 RecvErr("ARP Packet too short", strip_info);
2184 return;
2187 if (ptr < end)
2189 RecvErr("ARP Packet too long", strip_info);
2190 return;
2193 header->protocol = htons(ETH_P_ARP);
2195 deliver_packet(strip_info, header, packetlen);
2199 * process_text_message processes a <CR>-terminated block of data received
2200 * from the radio that doesn't begin with a '*' character. All normal
2201 * Starmode communication messages with the radio begin with a '*',
2202 * so any text that does not indicates a serial port error, a radio that
2203 * is in Hayes command mode instead of Starmode, or a radio with really
2204 * old firmware that doesn't frame its Starmode responses properly.
2206 static void process_text_message(struct strip *strip_info)
2208 __u8 *msg = strip_info->sx_buff;
2209 int len = strip_info->sx_count;
2211 /* Check for anything that looks like it might be our radio name */
2212 /* (This is here for backwards compatibility with old firmware) */
2213 if (len == 9 && get_radio_address(strip_info, msg) == 0) return;
2215 if (text_equal(msg, len, "OK" )) return; /* Ignore 'OK' responses from prior commands */
2216 if (text_equal(msg, len, "ERROR" )) return; /* Ignore 'ERROR' messages */
2217 if (has_prefix(msg, len, "ate0q1" )) return; /* Ignore character echo back from the radio */
2219 /* Catch other error messages */
2220 /* (This is here for backwards compatibility with old firmware) */
2221 if (has_prefix(msg, len, "ERR_")) { RecvErr_Message(strip_info, NULL, &msg[4], len-4); return; }
2223 RecvErr("No initial *", strip_info);
2227 * process_message processes a <CR>-terminated block of data received
2228 * from the radio. If the radio is not in Starmode or has old firmware,
2229 * it may be a line of text in response to an AT command. Ideally, with
2230 * a current radio that's properly in Starmode, all data received should
2231 * be properly framed and checksummed radio message blocks, containing
2232 * either a starmode packet, or a other communication from the radio
2233 * firmware, like "INF_" Info messages and &COMMAND responses.
2235 static void process_message(struct strip *strip_info)
2237 STRIP_Header header = { zero_address, zero_address, 0 };
2238 __u8 *ptr = strip_info->sx_buff;
2239 __u8 *end = strip_info->sx_buff + strip_info->sx_count;
2240 __u8 sendername[32], *sptr = sendername;
2241 MetricomKey key;
2243 /*HexDump("Receiving", strip_info, ptr, end);*/
2245 /* Check for start of address marker, and then skip over it */
2246 if (*ptr == '*') ptr++;
2247 else { process_text_message(strip_info); return; }
2249 /* Copy out the return address */
2250 while (ptr < end && *ptr != '*' && sptr < ARRAY_END(sendername)-1) *sptr++ = *ptr++;
2251 *sptr = 0; /* Null terminate the sender name */
2253 /* Check for end of address marker, and skip over it */
2254 if (ptr >= end || *ptr != '*')
2256 RecvErr("No second *", strip_info);
2257 return;
2259 ptr++; /* Skip the second '*' */
2261 /* If the sender name is "&COMMAND", ignore this 'packet' */
2262 /* (This is here for backwards compatibility with old firmware) */
2263 if (!strcmp(sendername, "&COMMAND"))
2265 strip_info->firmware_level = NoStructure;
2266 strip_info->next_command = CompatibilityCommand;
2267 return;
2270 if (ptr+4 > end)
2272 RecvErr("No proto key", strip_info);
2273 return;
2276 /* Get the protocol key out of the buffer */
2277 key.c[0] = *ptr++;
2278 key.c[1] = *ptr++;
2279 key.c[2] = *ptr++;
2280 key.c[3] = *ptr++;
2282 /* If we're using checksums, verify the checksum at the end of the packet */
2283 if (strip_info->firmware_level >= ChecksummedMessages)
2285 end -= 4; /* Chop the last four bytes off the packet (they're the checksum) */
2286 if (ptr > end)
2288 RecvErr("Missing Checksum", strip_info);
2289 return;
2291 if (!verify_checksum(strip_info))
2293 RecvErr("Bad Checksum", strip_info);
2294 return;
2298 /*printk(KERN_INFO "%s: Got packet from \"%s\".\n", strip_info->dev.name, sendername);*/
2301 * Fill in (pseudo) source and destination addresses in the packet.
2302 * We assume that the destination address was our address (the radio does not
2303 * tell us this). If the radio supplies a source address, then we use it.
2305 header.dst_addr = strip_info->true_dev_addr;
2306 string_to_radio_address(&header.src_addr, sendername);
2308 #ifdef EXT_COUNTERS
2309 if (key.l == SIP0Key.l) {
2310 strip_info->rx_rbytes += (end - ptr);
2311 process_IP_packet(strip_info, &header, ptr, end);
2312 } else if (key.l == ARP0Key.l) {
2313 strip_info->rx_rbytes += (end - ptr);
2314 process_ARP_packet(strip_info, &header, ptr, end);
2315 } else if (key.l == ATR_Key.l) {
2316 strip_info->rx_ebytes += (end - ptr);
2317 process_AT_response(strip_info, ptr, end);
2318 } else if (key.l == ACK_Key.l) {
2319 strip_info->rx_ebytes += (end - ptr);
2320 process_ACK(strip_info, ptr, end);
2321 } else if (key.l == INF_Key.l) {
2322 strip_info->rx_ebytes += (end - ptr);
2323 process_Info(strip_info, ptr, end);
2324 } else if (key.l == ERR_Key.l) {
2325 strip_info->rx_ebytes += (end - ptr);
2326 RecvErr_Message(strip_info, sendername, ptr, end-ptr);
2327 } else RecvErr("Unrecognized protocol key", strip_info);
2328 #else
2329 if (key.l == SIP0Key.l) process_IP_packet (strip_info, &header, ptr, end);
2330 else if (key.l == ARP0Key.l) process_ARP_packet (strip_info, &header, ptr, end);
2331 else if (key.l == ATR_Key.l) process_AT_response(strip_info, ptr, end);
2332 else if (key.l == ACK_Key.l) process_ACK (strip_info, ptr, end);
2333 else if (key.l == INF_Key.l) process_Info (strip_info, ptr, end);
2334 else if (key.l == ERR_Key.l) RecvErr_Message (strip_info, sendername, ptr, end-ptr);
2335 else RecvErr("Unrecognized protocol key", strip_info);
2336 #endif
2339 #define TTYERROR(X) ((X) == TTY_BREAK ? "Break" : \
2340 (X) == TTY_FRAME ? "Framing Error" : \
2341 (X) == TTY_PARITY ? "Parity Error" : \
2342 (X) == TTY_OVERRUN ? "Hardware Overrun" : "Unknown Error")
2345 * Handle the 'receiver data ready' interrupt.
2346 * This function is called by the 'tty_io' module in the kernel when
2347 * a block of STRIP data has been received, which can now be decapsulated
2348 * and sent on to some IP layer for further processing.
2351 static void
2352 strip_receive_buf(struct tty_struct *tty, const unsigned char *cp, char *fp, int count)
2354 struct strip *strip_info = (struct strip *) tty->disc_data;
2355 const unsigned char *end = cp + count;
2357 if (!strip_info || strip_info->magic != STRIP_MAGIC || !strip_info->dev.start)
2358 return;
2360 /* Argh! mtu change time! - costs us the packet part received at the change */
2361 if (strip_info->mtu != strip_info->dev.mtu)
2362 strip_changedmtu(strip_info);
2364 #if 0
2366 struct timeval tv;
2367 do_gettimeofday(&tv);
2368 printk(KERN_INFO "**** strip_receive_buf: %3d bytes at %02d.%06d\n",
2369 count, tv.tv_sec % 100, tv.tv_usec);
2371 #endif
2373 #ifdef EXT_COUNTERS
2374 strip_info->rx_sbytes += count;
2375 #endif
2377 /* Read the characters out of the buffer */
2378 while (cp < end)
2380 if (fp && *fp) printk(KERN_INFO "%s: %s on serial port\n", strip_info->dev.name, TTYERROR(*fp));
2381 if (fp && *fp++ && !strip_info->discard) /* If there's a serial error, record it */
2383 /* If we have some characters in the buffer, discard them */
2384 strip_info->discard = strip_info->sx_count;
2385 strip_info->rx_errors++;
2388 /* Leading control characters (CR, NL, Tab, etc.) are ignored */
2389 if (strip_info->sx_count > 0 || *cp >= ' ')
2391 if (*cp == 0x0D) /* If end of packet, decide what to do with it */
2393 if (strip_info->sx_count > 3000)
2394 printk(KERN_INFO "%s: Cut a %d byte packet (%d bytes remaining)%s\n",
2395 strip_info->dev.name, strip_info->sx_count, end-cp-1,
2396 strip_info->discard ? " (discarded)" : "");
2397 if (strip_info->sx_count > strip_info->sx_size)
2399 strip_info->rx_over_errors++;
2400 printk(KERN_INFO "%s: sx_buff overflow (%d bytes total)\n",
2401 strip_info->dev.name, strip_info->sx_count);
2403 else if (strip_info->discard)
2404 printk(KERN_INFO "%s: Discarding bad packet (%d/%d)\n",
2405 strip_info->dev.name, strip_info->discard, strip_info->sx_count);
2406 else process_message(strip_info);
2407 strip_info->discard = 0;
2408 strip_info->sx_count = 0;
2410 else
2412 /* Make sure we have space in the buffer */
2413 if (strip_info->sx_count < strip_info->sx_size)
2414 strip_info->sx_buff[strip_info->sx_count] = *cp;
2415 strip_info->sx_count++;
2418 cp++;
2423 /************************************************************************/
2424 /* General control routines */
2426 static int set_mac_address(struct strip *strip_info, MetricomAddress *addr)
2429 * We're using a manually specified address if the address is set
2430 * to anything other than all ones. Setting the address to all ones
2431 * disables manual mode and goes back to automatic address determination
2432 * (tracking the true address that the radio has).
2434 strip_info->manual_dev_addr = memcmp(addr->c, broadcast_address.c, sizeof(broadcast_address));
2435 if (strip_info->manual_dev_addr)
2436 *(MetricomAddress*)strip_info->dev.dev_addr = *addr;
2437 else *(MetricomAddress*)strip_info->dev.dev_addr = strip_info->true_dev_addr;
2438 return 0;
2441 static int dev_set_mac_address(struct net_device *dev, void *addr)
2443 struct strip *strip_info = (struct strip *)(dev->priv);
2444 struct sockaddr *sa = addr;
2445 printk(KERN_INFO "%s: strip_set_dev_mac_address called\n", dev->name);
2446 set_mac_address(strip_info, (MetricomAddress *)sa->sa_data);
2447 return 0;
2450 static struct enet_statistics *strip_get_stats(struct net_device *dev)
2452 static struct enet_statistics stats;
2453 struct strip *strip_info = (struct strip *)(dev->priv);
2455 memset(&stats, 0, sizeof(struct enet_statistics));
2457 stats.rx_packets = strip_info->rx_packets;
2458 stats.tx_packets = strip_info->tx_packets;
2459 stats.rx_dropped = strip_info->rx_dropped;
2460 stats.tx_dropped = strip_info->tx_dropped;
2461 stats.tx_errors = strip_info->tx_errors;
2462 stats.rx_errors = strip_info->rx_errors;
2463 stats.rx_over_errors = strip_info->rx_over_errors;
2464 return(&stats);
2468 /************************************************************************/
2469 /* Opening and closing */
2472 * Here's the order things happen:
2473 * When the user runs "slattach -p strip ..."
2474 * 1. The TTY module calls strip_open
2475 * 2. strip_open calls strip_alloc
2476 * 3. strip_alloc calls register_netdev
2477 * 4. register_netdev calls strip_dev_init
2478 * 5. then strip_open finishes setting up the strip_info
2480 * When the user runs "ifconfig st<x> up address netmask ..."
2481 * 6. strip_open_low gets called
2483 * When the user runs "ifconfig st<x> down"
2484 * 7. strip_close_low gets called
2486 * When the user kills the slattach process
2487 * 8. strip_close gets called
2488 * 9. strip_close calls dev_close
2489 * 10. if the device is still up, then dev_close calls strip_close_low
2490 * 11. strip_close calls strip_free
2493 /* Open the low-level part of the STRIP channel. Easy! */
2495 static int strip_open_low(struct net_device *dev)
2497 struct strip *strip_info = (struct strip *)(dev->priv);
2498 #if 0
2499 struct in_device *in_dev = dev->ip_ptr;
2500 #endif
2502 if (strip_info->tty == NULL)
2503 return(-ENODEV);
2505 if (!allocate_buffers(strip_info))
2506 return(-ENOMEM);
2508 strip_info->sx_count = 0;
2509 strip_info->tx_left = 0;
2511 strip_info->discard = 0;
2512 strip_info->working = FALSE;
2513 strip_info->firmware_level = NoStructure;
2514 strip_info->next_command = CompatibilityCommand;
2515 strip_info->user_baud = get_baud(strip_info->tty);
2517 #if 0
2519 * Needed because address '0' is special
2521 * --ANK Needed it or not needed, it does not matter at all.
2522 * Make it at user level, guys.
2525 if (in_dev->ifa_list->ifa_address == 0)
2526 in_dev->ifa_list->ifa_address = ntohl(0xC0A80001);
2527 #endif
2528 dev->tbusy = 0;
2529 dev->start = 1;
2531 printk(KERN_INFO "%s: Initializing Radio.\n", strip_info->dev.name);
2532 ResetRadio(strip_info);
2533 strip_info->idle_timer.expires = jiffies + 1*HZ;
2534 add_timer(&strip_info->idle_timer);
2535 return(0);
2540 * Close the low-level part of the STRIP channel. Easy!
2543 static int strip_close_low(struct net_device *dev)
2545 struct strip *strip_info = (struct strip *)(dev->priv);
2547 if (strip_info->tty == NULL)
2548 return -EBUSY;
2549 strip_info->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
2550 dev->tbusy = 1;
2551 dev->start = 0;
2554 * Free all STRIP frame buffers.
2556 if (strip_info->rx_buff)
2558 kfree(strip_info->rx_buff);
2559 strip_info->rx_buff = NULL;
2561 if (strip_info->sx_buff)
2563 kfree(strip_info->sx_buff);
2564 strip_info->sx_buff = NULL;
2566 if (strip_info->tx_buff)
2568 kfree(strip_info->tx_buff);
2569 strip_info->tx_buff = NULL;
2571 del_timer(&strip_info->idle_timer);
2572 return 0;
2576 * This routine is called by DDI when the
2577 * (dynamically assigned) device is registered
2580 static int strip_dev_init(struct net_device *dev)
2583 * Finish setting up the DEVICE info.
2586 dev->trans_start = 0;
2587 dev->last_rx = 0;
2588 dev->tx_queue_len = 30; /* Drop after 30 frames queued */
2590 dev->flags = 0;
2591 dev->mtu = DEFAULT_STRIP_MTU;
2592 dev->type = ARPHRD_METRICOM; /* dtang */
2593 dev->hard_header_len = sizeof(STRIP_Header);
2595 * dev->priv Already holds a pointer to our struct strip
2598 *(MetricomAddress*)&dev->broadcast = broadcast_address;
2599 dev->dev_addr[0] = 0;
2600 dev->addr_len = sizeof(MetricomAddress);
2603 * Pointers to interface service routines.
2606 dev->open = strip_open_low;
2607 dev->stop = strip_close_low;
2608 dev->hard_start_xmit = strip_xmit;
2609 dev->hard_header = strip_header;
2610 dev->rebuild_header = strip_rebuild_header;
2611 /* dev->type_trans unused */
2612 /* dev->set_multicast_list unused */
2613 dev->set_mac_address = dev_set_mac_address;
2614 /* dev->do_ioctl unused */
2615 /* dev->set_config unused */
2616 dev->get_stats = strip_get_stats;
2617 return 0;
2621 * Free a STRIP channel.
2624 static void strip_free(struct strip *strip_info)
2626 *(strip_info->referrer) = strip_info->next;
2627 if (strip_info->next)
2628 strip_info->next->referrer = strip_info->referrer;
2629 strip_info->magic = 0;
2630 kfree(strip_info);
2634 * Allocate a new free STRIP channel
2637 static struct strip *strip_alloc(void)
2639 int channel_id = 0;
2640 struct strip **s = &struct_strip_list;
2641 struct strip *strip_info = (struct strip *)
2642 kmalloc(sizeof(struct strip), GFP_KERNEL);
2644 if (!strip_info)
2645 return(NULL); /* If no more memory, return */
2648 * Clear the allocated memory
2651 memset(strip_info, 0, sizeof(struct strip));
2654 * Search the list to find where to put our new entry
2655 * (and in the process decide what channel number it is
2656 * going to be)
2659 while (*s && (*s)->dev.base_addr == channel_id)
2661 channel_id++;
2662 s = &(*s)->next;
2666 * Fill in the link pointers
2669 strip_info->next = *s;
2670 if (*s)
2671 (*s)->referrer = &strip_info->next;
2672 strip_info->referrer = s;
2673 *s = strip_info;
2675 strip_info->magic = STRIP_MAGIC;
2676 strip_info->tty = NULL;
2678 strip_info->gratuitous_arp = jiffies + LongTime;
2679 strip_info->arp_interval = 0;
2680 init_timer(&strip_info->idle_timer);
2681 strip_info->idle_timer.data = (long)&strip_info->dev;
2682 strip_info->idle_timer.function = strip_IdleTask;
2684 /* Note: strip_info->if_name is currently 8 characters long */
2685 sprintf(strip_info->if_name.c, "st%d", channel_id);
2686 strip_info->dev.name = strip_info->if_name.c;
2687 strip_info->dev.base_addr = channel_id;
2688 strip_info->dev.priv = (void*)strip_info;
2689 strip_info->dev.next = NULL;
2690 strip_info->dev.init = strip_dev_init;
2692 return(strip_info);
2696 * Open the high-level part of the STRIP channel.
2697 * This function is called by the TTY module when the
2698 * STRIP line discipline is called for. Because we are
2699 * sure the tty line exists, we only have to link it to
2700 * a free STRIP channel...
2703 static int strip_open(struct tty_struct *tty)
2705 struct strip *strip_info = (struct strip *) tty->disc_data;
2708 * First make sure we're not already connected.
2711 if (strip_info && strip_info->magic == STRIP_MAGIC)
2712 return -EEXIST;
2715 * OK. Find a free STRIP channel to use.
2717 if ((strip_info = strip_alloc()) == NULL)
2718 return -ENFILE;
2721 * Register our newly created device so it can be ifconfig'd
2722 * strip_dev_init() will be called as a side-effect
2725 if (register_netdev(&strip_info->dev) != 0)
2727 printk(KERN_ERR "strip: register_netdev() failed.\n");
2728 strip_free(strip_info);
2729 return -ENFILE;
2732 strip_info->tty = tty;
2733 tty->disc_data = strip_info;
2734 if (tty->driver.flush_buffer)
2735 tty->driver.flush_buffer(tty);
2736 if (tty->ldisc.flush_buffer)
2737 tty->ldisc.flush_buffer(tty);
2740 * Restore default settings
2743 strip_info->dev.type = ARPHRD_METRICOM; /* dtang */
2746 * Set tty options
2749 tty->termios->c_iflag |= IGNBRK |IGNPAR;/* Ignore breaks and parity errors. */
2750 tty->termios->c_cflag |= CLOCAL; /* Ignore modem control signals. */
2751 tty->termios->c_cflag &= ~HUPCL; /* Don't close on hup */
2753 #ifdef MODULE
2754 MOD_INC_USE_COUNT;
2755 #endif
2757 printk(KERN_INFO "STRIP: device \"%s\" activated\n", strip_info->if_name.c);
2760 * Done. We have linked the TTY line to a channel.
2762 return(strip_info->dev.base_addr);
2766 * Close down a STRIP channel.
2767 * This means flushing out any pending queues, and then restoring the
2768 * TTY line discipline to what it was before it got hooked to STRIP
2769 * (which usually is TTY again).
2772 static void strip_close(struct tty_struct *tty)
2774 struct strip *strip_info = (struct strip *) tty->disc_data;
2777 * First make sure we're connected.
2780 if (!strip_info || strip_info->magic != STRIP_MAGIC)
2781 return;
2783 dev_close(&strip_info->dev);
2784 unregister_netdev(&strip_info->dev);
2786 tty->disc_data = 0;
2787 strip_info->tty = NULL;
2788 printk(KERN_INFO "STRIP: device \"%s\" closed down\n", strip_info->if_name.c);
2789 strip_free(strip_info);
2790 tty->disc_data = NULL;
2791 #ifdef MODULE
2792 MOD_DEC_USE_COUNT;
2793 #endif
2797 /************************************************************************/
2798 /* Perform I/O control calls on an active STRIP channel. */
2800 static int strip_ioctl(struct tty_struct *tty, struct file *file,
2801 unsigned int cmd, unsigned long arg)
2803 struct strip *strip_info = (struct strip *) tty->disc_data;
2806 * First make sure we're connected.
2809 if (!strip_info || strip_info->magic != STRIP_MAGIC)
2810 return -EINVAL;
2812 switch(cmd)
2814 case SIOCGIFNAME:
2815 return copy_to_user((void*)arg, strip_info->dev.name,
2816 strlen(strip_info->dev.name) + 1) ?
2817 -EFAULT : 0;
2818 break;
2819 case SIOCSIFHWADDR:
2821 MetricomAddress addr;
2822 printk(KERN_INFO "%s: SIOCSIFHWADDR\n", strip_info->dev.name);
2823 return copy_from_user(&addr, (void*)arg, sizeof(MetricomAddress)) ?
2824 -EFAULT : set_mac_address(strip_info, &addr);
2825 break;
2828 * Allow stty to read, but not set, the serial port
2831 case TCGETS:
2832 case TCGETA:
2833 return n_tty_ioctl(tty, (struct file *) file, cmd,
2834 (unsigned long) arg);
2835 break;
2836 default:
2837 return -ENOIOCTLCMD;
2838 break;
2843 /************************************************************************/
2844 /* Initialization */
2847 * Initialize the STRIP driver.
2848 * This routine is called at boot time, to bootstrap the multi-channel
2849 * STRIP driver
2852 #ifdef MODULE
2853 static
2854 #endif
2855 int strip_init_ctrl_dev(struct net_device *dummy)
2857 static struct tty_ldisc strip_ldisc;
2858 int status;
2860 printk(KERN_INFO "STRIP: Version %s (unlimited channels)\n", StripVersion);
2863 * Fill in our line protocol discipline, and register it
2866 memset(&strip_ldisc, 0, sizeof(strip_ldisc));
2867 strip_ldisc.magic = TTY_LDISC_MAGIC;
2868 strip_ldisc.flags = 0;
2869 strip_ldisc.open = strip_open;
2870 strip_ldisc.close = strip_close;
2871 strip_ldisc.read = NULL;
2872 strip_ldisc.write = NULL;
2873 strip_ldisc.ioctl = strip_ioctl;
2874 strip_ldisc.poll = NULL;
2875 strip_ldisc.receive_buf = strip_receive_buf;
2876 strip_ldisc.receive_room = strip_receive_room;
2877 strip_ldisc.write_wakeup = strip_write_some_more;
2878 status = tty_register_ldisc(N_STRIP, &strip_ldisc);
2879 if (status != 0)
2881 printk(KERN_ERR "STRIP: can't register line discipline (err = %d)\n", status);
2885 * Register the status file with /proc
2887 #ifdef CONFIG_PROC_FS
2888 if (proc_net_register(&proc_strip_get_status_info) != 0)
2890 printk(KERN_ERR "strip: status proc_net_register() failed.\n");
2892 #endif
2894 #ifdef MODULE
2895 return status;
2896 #else
2898 /* Return "not found", so that dev_init() will unlink
2899 * the placeholder device entry for us.
2901 return ENODEV;
2902 #endif
2906 /************************************************************************/
2907 /* From here down is only used when compiled as an external module */
2909 #ifdef MODULE
2911 int init_module(void)
2913 return strip_init_ctrl_dev(0);
2916 void cleanup_module(void)
2918 int i;
2919 while (struct_strip_list)
2920 strip_free(struct_strip_list);
2922 /* Unregister with the /proc/net file here. */
2923 #ifdef CONFIG_PROC_FS
2924 proc_net_unregister(PROC_NET_STRIP_STATUS);
2925 #endif
2927 if ((i = tty_register_ldisc(N_STRIP, NULL)))
2928 printk(KERN_ERR "STRIP: can't unregister line discipline (err = %d)\n", i);
2930 printk(KERN_INFO "STRIP: Module Unloaded\n");
2932 #endif /* MODULE */