takashi yamanoue / Mbed 2 deprecated XBee_API_ex2

Xbee test 2

Dependencies:   XBee mbed

LPC1768/lwip/netif/ppp/vj.h@0:ffac63d6a7f0, 2012-07-21 (annotated)

Committer:
takashiyamanoue
Date:
Sat Jul 21 04:08:27 2012 +0000
Revision:
0:ffac63d6a7f0
xbee test 2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
takashiyamanoue 0:ffac63d6a7f0 1 /*
takashiyamanoue 0:ffac63d6a7f0 2 * Definitions for tcp compression routines.
takashiyamanoue 0:ffac63d6a7f0 3 *
takashiyamanoue 0:ffac63d6a7f0 4 * $Id: vj.h,v 1.7 2010/02/22 17:52:09 goldsimon Exp $
takashiyamanoue 0:ffac63d6a7f0 5 *
takashiyamanoue 0:ffac63d6a7f0 6 * Copyright (c) 1989 Regents of the University of California.
takashiyamanoue 0:ffac63d6a7f0 7 * All rights reserved.
takashiyamanoue 0:ffac63d6a7f0 8 *
takashiyamanoue 0:ffac63d6a7f0 9 * Redistribution and use in source and binary forms are permitted
takashiyamanoue 0:ffac63d6a7f0 10 * provided that the above copyright notice and this paragraph are
takashiyamanoue 0:ffac63d6a7f0 11 * duplicated in all such forms and that any documentation,
takashiyamanoue 0:ffac63d6a7f0 12 * advertising materials, and other materials related to such
takashiyamanoue 0:ffac63d6a7f0 13 * distribution and use acknowledge that the software was developed
takashiyamanoue 0:ffac63d6a7f0 14 * by the University of California, Berkeley. The name of the
takashiyamanoue 0:ffac63d6a7f0 15 * University may not be used to endorse or promote products derived
takashiyamanoue 0:ffac63d6a7f0 16 * from this software without specific prior written permission.
takashiyamanoue 0:ffac63d6a7f0 17 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
takashiyamanoue 0:ffac63d6a7f0 18 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
takashiyamanoue 0:ffac63d6a7f0 19 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
takashiyamanoue 0:ffac63d6a7f0 20 *
takashiyamanoue 0:ffac63d6a7f0 21 * Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
takashiyamanoue 0:ffac63d6a7f0 22 * - Initial distribution.
takashiyamanoue 0:ffac63d6a7f0 23 */
takashiyamanoue 0:ffac63d6a7f0 24
takashiyamanoue 0:ffac63d6a7f0 25 #ifndef VJ_H
takashiyamanoue 0:ffac63d6a7f0 26 #define VJ_H
takashiyamanoue 0:ffac63d6a7f0 27
takashiyamanoue 0:ffac63d6a7f0 28 #include "lwip/ip.h"
takashiyamanoue 0:ffac63d6a7f0 29 #include "lwip/tcp_impl.h"
takashiyamanoue 0:ffac63d6a7f0 30
takashiyamanoue 0:ffac63d6a7f0 31 #define MAX_SLOTS 16 /* must be > 2 and < 256 */
takashiyamanoue 0:ffac63d6a7f0 32 #define MAX_HDR 128
takashiyamanoue 0:ffac63d6a7f0 33
takashiyamanoue 0:ffac63d6a7f0 34 /*
takashiyamanoue 0:ffac63d6a7f0 35 * Compressed packet format:
takashiyamanoue 0:ffac63d6a7f0 36 *
takashiyamanoue 0:ffac63d6a7f0 37 * The first octet contains the packet type (top 3 bits), TCP
takashiyamanoue 0:ffac63d6a7f0 38 * 'push' bit, and flags that indicate which of the 4 TCP sequence
takashiyamanoue 0:ffac63d6a7f0 39 * numbers have changed (bottom 5 bits). The next octet is a
takashiyamanoue 0:ffac63d6a7f0 40 * conversation number that associates a saved IP/TCP header with
takashiyamanoue 0:ffac63d6a7f0 41 * the compressed packet. The next two octets are the TCP checksum
takashiyamanoue 0:ffac63d6a7f0 42 * from the original datagram. The next 0 to 15 octets are
takashiyamanoue 0:ffac63d6a7f0 43 * sequence number changes, one change per bit set in the header
takashiyamanoue 0:ffac63d6a7f0 44 * (there may be no changes and there are two special cases where
takashiyamanoue 0:ffac63d6a7f0 45 * the receiver implicitly knows what changed -- see below).
takashiyamanoue 0:ffac63d6a7f0 46 *
takashiyamanoue 0:ffac63d6a7f0 47 * There are 5 numbers which can change (they are always inserted
takashiyamanoue 0:ffac63d6a7f0 48 * in the following order): TCP urgent pointer, window,
takashiyamanoue 0:ffac63d6a7f0 49 * acknowlegement, sequence number and IP ID. (The urgent pointer
takashiyamanoue 0:ffac63d6a7f0 50 * is different from the others in that its value is sent, not the
takashiyamanoue 0:ffac63d6a7f0 51 * change in value.) Since typical use of SLIP links is biased
takashiyamanoue 0:ffac63d6a7f0 52 * toward small packets (see comments on MTU/MSS below), changes
takashiyamanoue 0:ffac63d6a7f0 53 * use a variable length coding with one octet for numbers in the
takashiyamanoue 0:ffac63d6a7f0 54 * range 1 - 255 and 3 octets (0, MSB, LSB) for numbers in the
takashiyamanoue 0:ffac63d6a7f0 55 * range 256 - 65535 or 0. (If the change in sequence number or
takashiyamanoue 0:ffac63d6a7f0 56 * ack is more than 65535, an uncompressed packet is sent.)
takashiyamanoue 0:ffac63d6a7f0 57 */
takashiyamanoue 0:ffac63d6a7f0 58
takashiyamanoue 0:ffac63d6a7f0 59 /*
takashiyamanoue 0:ffac63d6a7f0 60 * Packet types (must not conflict with IP protocol version)
takashiyamanoue 0:ffac63d6a7f0 61 *
takashiyamanoue 0:ffac63d6a7f0 62 * The top nibble of the first octet is the packet type. There are
takashiyamanoue 0:ffac63d6a7f0 63 * three possible types: IP (not proto TCP or tcp with one of the
takashiyamanoue 0:ffac63d6a7f0 64 * control flags set); uncompressed TCP (a normal IP/TCP packet but
takashiyamanoue 0:ffac63d6a7f0 65 * with the 8-bit protocol field replaced by an 8-bit connection id --
takashiyamanoue 0:ffac63d6a7f0 66 * this type of packet syncs the sender & receiver); and compressed
takashiyamanoue 0:ffac63d6a7f0 67 * TCP (described above).
takashiyamanoue 0:ffac63d6a7f0 68 *
takashiyamanoue 0:ffac63d6a7f0 69 * LSB of 4-bit field is TCP "PUSH" bit (a worthless anachronism) and
takashiyamanoue 0:ffac63d6a7f0 70 * is logically part of the 4-bit "changes" field that follows. Top
takashiyamanoue 0:ffac63d6a7f0 71 * three bits are actual packet type. For backward compatibility
takashiyamanoue 0:ffac63d6a7f0 72 * and in the interest of conserving bits, numbers are chosen so the
takashiyamanoue 0:ffac63d6a7f0 73 * IP protocol version number (4) which normally appears in this nibble
takashiyamanoue 0:ffac63d6a7f0 74 * means "IP packet".
takashiyamanoue 0:ffac63d6a7f0 75 */
takashiyamanoue 0:ffac63d6a7f0 76
takashiyamanoue 0:ffac63d6a7f0 77 /* packet types */
takashiyamanoue 0:ffac63d6a7f0 78 #define TYPE_IP 0x40
takashiyamanoue 0:ffac63d6a7f0 79 #define TYPE_UNCOMPRESSED_TCP 0x70
takashiyamanoue 0:ffac63d6a7f0 80 #define TYPE_COMPRESSED_TCP 0x80
takashiyamanoue 0:ffac63d6a7f0 81 #define TYPE_ERROR 0x00
takashiyamanoue 0:ffac63d6a7f0 82
takashiyamanoue 0:ffac63d6a7f0 83 /* Bits in first octet of compressed packet */
takashiyamanoue 0:ffac63d6a7f0 84 #define NEW_C 0x40 /* flag bits for what changed in a packet */
takashiyamanoue 0:ffac63d6a7f0 85 #define NEW_I 0x20
takashiyamanoue 0:ffac63d6a7f0 86 #define NEW_S 0x08
takashiyamanoue 0:ffac63d6a7f0 87 #define NEW_A 0x04
takashiyamanoue 0:ffac63d6a7f0 88 #define NEW_W 0x02
takashiyamanoue 0:ffac63d6a7f0 89 #define NEW_U 0x01
takashiyamanoue 0:ffac63d6a7f0 90
takashiyamanoue 0:ffac63d6a7f0 91 /* reserved, special-case values of above */
takashiyamanoue 0:ffac63d6a7f0 92 #define SPECIAL_I (NEW_S|NEW_W|NEW_U) /* echoed interactive traffic */
takashiyamanoue 0:ffac63d6a7f0 93 #define SPECIAL_D (NEW_S|NEW_A|NEW_W|NEW_U) /* unidirectional data */
takashiyamanoue 0:ffac63d6a7f0 94 #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
takashiyamanoue 0:ffac63d6a7f0 95
takashiyamanoue 0:ffac63d6a7f0 96 #define TCP_PUSH_BIT 0x10
takashiyamanoue 0:ffac63d6a7f0 97
takashiyamanoue 0:ffac63d6a7f0 98
takashiyamanoue 0:ffac63d6a7f0 99 /*
takashiyamanoue 0:ffac63d6a7f0 100 * "state" data for each active tcp conversation on the wire. This is
takashiyamanoue 0:ffac63d6a7f0 101 * basically a copy of the entire IP/TCP header from the last packet
takashiyamanoue 0:ffac63d6a7f0 102 * we saw from the conversation together with a small identifier
takashiyamanoue 0:ffac63d6a7f0 103 * the transmit & receive ends of the line use to locate saved header.
takashiyamanoue 0:ffac63d6a7f0 104 */
takashiyamanoue 0:ffac63d6a7f0 105 struct cstate {
takashiyamanoue 0:ffac63d6a7f0 106 struct cstate *cs_next; /* next most recently used state (xmit only) */
takashiyamanoue 0:ffac63d6a7f0 107 u_short cs_hlen; /* size of hdr (receive only) */
takashiyamanoue 0:ffac63d6a7f0 108 u_char cs_id; /* connection # associated with this state */
takashiyamanoue 0:ffac63d6a7f0 109 u_char cs_filler;
takashiyamanoue 0:ffac63d6a7f0 110 union {
takashiyamanoue 0:ffac63d6a7f0 111 char csu_hdr[MAX_HDR];
takashiyamanoue 0:ffac63d6a7f0 112 struct ip_hdr csu_ip; /* ip/tcp hdr from most recent packet */
takashiyamanoue 0:ffac63d6a7f0 113 } vjcs_u;
takashiyamanoue 0:ffac63d6a7f0 114 };
takashiyamanoue 0:ffac63d6a7f0 115 #define cs_ip vjcs_u.csu_ip
takashiyamanoue 0:ffac63d6a7f0 116 #define cs_hdr vjcs_u.csu_hdr
takashiyamanoue 0:ffac63d6a7f0 117
takashiyamanoue 0:ffac63d6a7f0 118
takashiyamanoue 0:ffac63d6a7f0 119 struct vjstat {
takashiyamanoue 0:ffac63d6a7f0 120 unsigned long vjs_packets; /* outbound packets */
takashiyamanoue 0:ffac63d6a7f0 121 unsigned long vjs_compressed; /* outbound compressed packets */
takashiyamanoue 0:ffac63d6a7f0 122 unsigned long vjs_searches; /* searches for connection state */
takashiyamanoue 0:ffac63d6a7f0 123 unsigned long vjs_misses; /* times couldn't find conn. state */
takashiyamanoue 0:ffac63d6a7f0 124 unsigned long vjs_uncompressedin; /* inbound uncompressed packets */
takashiyamanoue 0:ffac63d6a7f0 125 unsigned long vjs_compressedin; /* inbound compressed packets */
takashiyamanoue 0:ffac63d6a7f0 126 unsigned long vjs_errorin; /* inbound unknown type packets */
takashiyamanoue 0:ffac63d6a7f0 127 unsigned long vjs_tossed; /* inbound packets tossed because of error */
takashiyamanoue 0:ffac63d6a7f0 128 };
takashiyamanoue 0:ffac63d6a7f0 129
takashiyamanoue 0:ffac63d6a7f0 130 /*
takashiyamanoue 0:ffac63d6a7f0 131 * all the state data for one serial line (we need one of these per line).
takashiyamanoue 0:ffac63d6a7f0 132 */
takashiyamanoue 0:ffac63d6a7f0 133 struct vjcompress {
takashiyamanoue 0:ffac63d6a7f0 134 struct cstate *last_cs; /* most recently used tstate */
takashiyamanoue 0:ffac63d6a7f0 135 u_char last_recv; /* last rcvd conn. id */
takashiyamanoue 0:ffac63d6a7f0 136 u_char last_xmit; /* last sent conn. id */
takashiyamanoue 0:ffac63d6a7f0 137 u_short flags;
takashiyamanoue 0:ffac63d6a7f0 138 u_char maxSlotIndex;
takashiyamanoue 0:ffac63d6a7f0 139 u_char compressSlot; /* Flag indicating OK to compress slot ID. */
takashiyamanoue 0:ffac63d6a7f0 140 #if LINK_STATS
takashiyamanoue 0:ffac63d6a7f0 141 struct vjstat stats;
takashiyamanoue 0:ffac63d6a7f0 142 #endif
takashiyamanoue 0:ffac63d6a7f0 143 struct cstate tstate[MAX_SLOTS]; /* xmit connection states */
takashiyamanoue 0:ffac63d6a7f0 144 struct cstate rstate[MAX_SLOTS]; /* receive connection states */
takashiyamanoue 0:ffac63d6a7f0 145 };
takashiyamanoue 0:ffac63d6a7f0 146
takashiyamanoue 0:ffac63d6a7f0 147 /* flag values */
takashiyamanoue 0:ffac63d6a7f0 148 #define VJF_TOSS 1U /* tossing rcvd frames because of input err */
takashiyamanoue 0:ffac63d6a7f0 149
takashiyamanoue 0:ffac63d6a7f0 150 extern void vj_compress_init (struct vjcompress *comp);
takashiyamanoue 0:ffac63d6a7f0 151 extern u_int vj_compress_tcp (struct vjcompress *comp, struct pbuf *pb);
takashiyamanoue 0:ffac63d6a7f0 152 extern void vj_uncompress_err (struct vjcompress *comp);
takashiyamanoue 0:ffac63d6a7f0 153 extern int vj_uncompress_uncomp(struct pbuf *nb, struct vjcompress *comp);
takashiyamanoue 0:ffac63d6a7f0 154 extern int vj_uncompress_tcp (struct pbuf **nb, struct vjcompress *comp);
takashiyamanoue 0:ffac63d6a7f0 155
takashiyamanoue 0:ffac63d6a7f0 156 #endif /* VJ_H */