Merge to Fedora kernel-2.6.18-1.2224_FC5 patched with stable patch-2.6.18.1-vs2.0...
[linux-2.6.git] / net / atm / lec.h
1 /*
2  *
3  * Lan Emulation client header file
4  *
5  * Marko Kiiskila mkiiskila@yahoo.com
6  *
7  */
8
9 #ifndef _LEC_H_
10 #define _LEC_H_
11
12 #include <linux/atmdev.h>
13 #include <linux/netdevice.h>
14 #include <linux/atmlec.h>
15
16 #define LEC_HEADER_LEN 16
17
18 struct lecdatahdr_8023 {
19   unsigned short le_header;
20   unsigned char h_dest[ETH_ALEN];
21   unsigned char h_source[ETH_ALEN];
22   unsigned short h_type;
23 };
24
25 struct lecdatahdr_8025 {
26   unsigned short le_header;
27   unsigned char ac_pad;
28   unsigned char fc;
29   unsigned char h_dest[ETH_ALEN];
30   unsigned char h_source[ETH_ALEN];
31 };
32
33 #define LEC_MINIMUM_8023_SIZE   62
34 #define LEC_MINIMUM_8025_SIZE   16
35
36 /*
37  * Operations that LANE2 capable device can do. Two first functions
38  * are used to make the device do things. See spec 3.1.3 and 3.1.4.
39  *
40  * The third function is intented for the MPOA component sitting on
41  * top of the LANE device. The MPOA component assigns it's own function
42  * to (*associate_indicator)() and the LANE device will use that
43  * function to tell about TLVs it sees floating through.
44  *
45  */
46 struct lane2_ops {
47         int  (*resolve)(struct net_device *dev, u8 *dst_mac, int force,
48                         u8 **tlvs, u32 *sizeoftlvs);
49         int  (*associate_req)(struct net_device *dev, u8 *lan_dst,
50                               u8 *tlvs, u32 sizeoftlvs);
51         void (*associate_indicator)(struct net_device *dev, u8 *mac_addr,
52                                     u8 *tlvs, u32 sizeoftlvs);
53 };
54
55 /*
56  * ATM LAN Emulation supports both LLC & Dix Ethernet EtherType
57  * frames. 
58  * 1. Dix Ethernet EtherType frames encoded by placing EtherType
59  *    field in h_type field. Data follows immediatelly after header.
60  * 2. LLC Data frames whose total length, including LLC field and data,
61  *    but not padding required to meet the minimum data frame length, 
62  *    is less than 1536(0x0600) MUST be encoded by placing that length
63  *    in the h_type field. The LLC field follows header immediatelly.
64  * 3. LLC data frames longer than this maximum MUST be encoded by placing
65  *    the value 0 in the h_type field.
66  *
67  */
68
69 /* Hash table size */
70 #define LEC_ARP_TABLE_SIZE 16
71
72 struct lec_priv {
73         struct net_device_stats stats;
74         unsigned short lecid;      /* Lecid of this client */
75         struct lec_arp_table *lec_arp_empty_ones;
76         /* Used for storing VCC's that don't have a MAC address attached yet */
77         struct lec_arp_table *lec_arp_tables[LEC_ARP_TABLE_SIZE];
78         /* Actual LE ARP table */
79         struct lec_arp_table *lec_no_forward;
80         /* Used for storing VCC's (and forward packets from) which are to
81            age out by not using them to forward packets. 
82            This is because to some LE clients there will be 2 VCCs. Only
83            one of them gets used. */
84         struct lec_arp_table *mcast_fwds;
85         /* With LANEv2 it is possible that BUS (or a special multicast server)
86            establishes multiple Multicast Forward VCCs to us. This list
87            collects all those VCCs. LANEv1 client has only one item in this
88            list. These entries are not aged out. */
89         spinlock_t lec_arp_lock;
90         struct atm_vcc *mcast_vcc; /* Default Multicast Send VCC */
91         struct atm_vcc *lecd;
92         struct timer_list lec_arp_timer;
93         /* C10 */
94         unsigned int maximum_unknown_frame_count;
95 /* Within the period of time defined by this variable, the client will send 
96    no more than C10 frames to BUS for a given unicast destination. (C11) */
97         unsigned long max_unknown_frame_time;
98 /* If no traffic has been sent in this vcc for this period of time,
99    vcc will be torn down (C12)*/
100         unsigned long vcc_timeout_period;
101 /* An LE Client MUST not retry an LE_ARP_REQUEST for a 
102    given frame's LAN Destination more than maximum retry count times,
103    after the first LEC_ARP_REQUEST (C13)*/
104         unsigned short max_retry_count;
105 /* Max time the client will maintain an entry in its arp cache in
106    absence of a verification of that relationship (C17)*/
107         unsigned long aging_time;
108 /* Max time the client will maintain an entry in cache when
109    topology change flag is true (C18) */
110         unsigned long forward_delay_time;
111 /* Topology change flag  (C19)*/
112         int topology_change;
113 /* Max time the client expects an LE_ARP_REQUEST/LE_ARP_RESPONSE
114    cycle to take (C20)*/
115         unsigned long arp_response_time;
116 /* Time limit ot wait to receive an LE_FLUSH_RESPONSE after the
117    LE_FLUSH_REQUEST has been sent before taking recover action. (C21)*/
118         unsigned long flush_timeout;
119 /* The time since sending a frame to the bus after which the
120    LE Client may assume that the frame has been either discarded or
121    delivered to the recipient (C22) */
122         unsigned long path_switching_delay;
123
124         u8 *tlvs;          /* LANE2: TLVs are new                */
125         u32 sizeoftlvs;    /* The size of the tlv array in bytes */
126         int lane_version;  /* LANE2                              */
127         int itfnum;        /* e.g. 2 for lec2, 5 for lec5        */
128         struct lane2_ops *lane2_ops; /* can be NULL for LANE v1  */
129         int is_proxy;      /* bridge between ATM and Ethernet    */
130         int is_trdev;      /* Device type, 0 = Ethernet, 1 = TokenRing */
131 };
132
133 struct lec_vcc_priv {
134         void (*old_pop)(struct atm_vcc *vcc, struct sk_buff *skb);
135         int xoff;
136 };
137
138 #define LEC_VCC_PRIV(vcc)       ((struct lec_vcc_priv *)((vcc)->user_back))
139
140 #endif /* _LEC_H_ */
141