[ATM]: [lec] header indent, comment and whitespace cleanup
[linux-2.6.22.y-op.git] / net / atm / lec.h
blobc700472f64dfbb1184f7fffc24114da2acec7c21
1 /*
2 * Lan Emulation client header file
4 * Marko Kiiskila <mkiiskila@yahoo.com>
5 */
7 #ifndef _LEC_H_
8 #define _LEC_H_
10 #include <linux/config.h>
11 #include <linux/atmdev.h>
12 #include <linux/netdevice.h>
13 #include <linux/atmlec.h>
15 #define LEC_HEADER_LEN 16
17 struct lecdatahdr_8023 {
18 unsigned short le_header;
19 unsigned char h_dest[ETH_ALEN];
20 unsigned char h_source[ETH_ALEN];
21 unsigned short h_type;
24 struct lecdatahdr_8025 {
25 unsigned short le_header;
26 unsigned char ac_pad;
27 unsigned char fc;
28 unsigned char h_dest[ETH_ALEN];
29 unsigned char h_source[ETH_ALEN];
32 #define LEC_MINIMUM_8023_SIZE 62
33 #define LEC_MINIMUM_8025_SIZE 16
36 * Operations that LANE2 capable device can do. Two first functions
37 * are used to make the device do things. See spec 3.1.3 and 3.1.4.
39 * The third function is intented for the MPOA component sitting on
40 * top of the LANE device. The MPOA component assigns it's own function
41 * to (*associate_indicator)() and the LANE device will use that
42 * function to tell about TLVs it sees floating through.
45 struct lane2_ops {
46 int (*resolve) (struct net_device *dev, u8 *dst_mac, int force,
47 u8 **tlvs, u32 *sizeoftlvs);
48 int (*associate_req) (struct net_device *dev, u8 *lan_dst,
49 u8 *tlvs, u32 sizeoftlvs);
50 void (*associate_indicator) (struct net_device *dev, u8 *mac_addr,
51 u8 *tlvs, u32 sizeoftlvs);
55 * ATM LAN Emulation supports both LLC & Dix Ethernet EtherType
56 * 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.
69 /* Hash table size */
70 #define LEC_ARP_TABLE_SIZE 16
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;
81 * Used for storing VCC's (and forward packets from) which are to
82 * age out by not using them to forward packets.
83 * This is because to some LE clients there will be 2 VCCs. Only
84 * one of them gets used.
86 struct lec_arp_table *mcast_fwds;
88 * With LANEv2 it is possible that BUS (or a special multicast server)
89 * establishes multiple Multicast Forward VCCs to us. This list
90 * collects all those VCCs. LANEv1 client has only one item in this
91 * list. These entries are not aged out.
93 spinlock_t lec_arp_lock;
94 struct atm_vcc *mcast_vcc; /* Default Multicast Send VCC */
95 struct atm_vcc *lecd;
96 struct timer_list lec_arp_timer; /* C10 */
97 unsigned int maximum_unknown_frame_count;
99 * Within the period of time defined by this variable, the client will send
100 * no more than C10 frames to BUS for a given unicast destination. (C11)
102 unsigned long max_unknown_frame_time;
104 * If no traffic has been sent in this vcc for this period of time,
105 * vcc will be torn down (C12)
107 unsigned long vcc_timeout_period;
109 * An LE Client MUST not retry an LE_ARP_REQUEST for a
110 * given frame's LAN Destination more than maximum retry count times,
111 * after the first LEC_ARP_REQUEST (C13)
113 unsigned short max_retry_count;
115 * Max time the client will maintain an entry in its arp cache in
116 * absence of a verification of that relationship (C17)
118 unsigned long aging_time;
120 * Max time the client will maintain an entry in cache when
121 * topology change flag is true (C18)
123 unsigned long forward_delay_time; /* Topology change flag (C19) */
124 int topology_change;
126 * Max time the client expects an LE_ARP_REQUEST/LE_ARP_RESPONSE
127 * cycle to take (C20)
129 unsigned long arp_response_time;
131 * Time limit ot wait to receive an LE_FLUSH_RESPONSE after the
132 * LE_FLUSH_REQUEST has been sent before taking recover action. (C21)
134 unsigned long flush_timeout;
135 /* The time since sending a frame to the bus after which the
136 * LE Client may assume that the frame has been either discarded or
137 * delivered to the recipient (C22)
139 unsigned long path_switching_delay;
141 u8 *tlvs; /* LANE2: TLVs are new */
142 u32 sizeoftlvs; /* The size of the tlv array in bytes */
143 int lane_version; /* LANE2 */
144 int itfnum; /* e.g. 2 for lec2, 5 for lec5 */
145 struct lane2_ops *lane2_ops; /* can be NULL for LANE v1 */
146 int is_proxy; /* bridge between ATM and Ethernet */
147 int is_trdev; /* Device type, 0 = Ethernet, 1 = TokenRing */
150 struct lec_vcc_priv {
151 void (*old_pop) (struct atm_vcc *vcc, struct sk_buff *skb);
152 int xoff;
155 #define LEC_VCC_PRIV(vcc) ((struct lec_vcc_priv *)((vcc)->user_back))
157 #endif /* _LEC_H_ */