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