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