1 if.h |
1 /*- |
|
2 * © Portions copyright (c) 2005-2009 Nokia Corporation. All rights reserved. |
|
3 * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved. |
|
4 * Copyright (c) 1982, 1986, 1989, 1993 |
|
5 * The Regents of the University of California. All rights reserved. |
|
6 * |
|
7 * Redistribution and use in source and binary forms, with or without |
|
8 * modification, are permitted provided that the following conditions |
|
9 * are met: |
|
10 * 1. Redistributions of source code must retain the above copyright |
|
11 * notice, this list of conditions and the following disclaimer. |
|
12 * 2. Redistributions in binary form must reproduce the above copyright |
|
13 * notice, this list of conditions and the following disclaimer in the |
|
14 * documentation and/or other materials provided with the distribution. |
|
15 * 4. Neither the name of the University nor the names of its contributors |
|
16 * may be used to endorse or promote products derived from this software |
|
17 * without specific prior written permission. |
|
18 * |
|
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
|
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
|
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
29 * SUCH DAMAGE. |
|
30 * |
|
31 * @(#)if.h 8.1 (Berkeley) 6/10/93 |
|
32 * $FreeBSD: src/sys/net/if.h,v 1.96.2.3 2005/10/07 14:00:05 glebius Exp $ |
|
33 */ |
|
34 |
|
35 #ifndef _NET_IF_H_ |
|
36 #define _NET_IF_H_ |
|
37 |
|
38 #ifdef __SYMBIAN32__ |
|
39 #ifdef __cplusplus |
|
40 extern "C" { |
|
41 #endif |
|
42 #endif |
|
43 |
|
44 #include <sys/cdefs.h> |
|
45 |
|
46 #ifdef _KERNEL |
|
47 #include <sys/queue.h> |
|
48 #endif |
|
49 |
|
50 #if __BSD_VISIBLE |
|
51 /* |
|
52 * <net/if.h> does not depend on <sys/time.h> on most other systems. This |
|
53 * helps userland compatibility. (struct timeval ifi_lastchange) |
|
54 */ |
|
55 #ifndef _KERNEL |
|
56 #include <sys/time.h> |
|
57 #endif |
|
58 |
|
59 struct ifnet; |
|
60 #endif |
|
61 |
|
62 /* |
|
63 * Length of interface external name, including terminating '\0'. |
|
64 * Note: this is the same size as a generic device's external name. |
|
65 */ |
|
66 #ifdef __SYMBIAN32__ |
|
67 // KCommsDbSvrMaxColumnNameLength = 50 |
|
68 #define IF_NAMESIZE 50 |
|
69 #else |
|
70 #define IF_NAMESIZE 16 |
|
71 #endif |
|
72 #if __BSD_VISIBLE |
|
73 #define IFNAMSIZ IF_NAMESIZE |
|
74 #define IF_MAXUNIT 0x7fff /* historical value */ |
|
75 #endif |
|
76 #if __BSD_VISIBLE |
|
77 |
|
78 /* |
|
79 * Structure used to query names of interface cloners. |
|
80 */ |
|
81 |
|
82 struct if_clonereq { |
|
83 int ifcr_total; /* total cloners (out) */ |
|
84 int ifcr_count; /* room for this many in user buffer */ |
|
85 char *ifcr_buffer; /* buffer for cloner names */ |
|
86 }; |
|
87 |
|
88 /* |
|
89 * Structure describing information about an interface |
|
90 * which may be of interest to management entities. |
|
91 */ |
|
92 struct if_data { |
|
93 /* generic interface information */ |
|
94 u_char ifi_type; /* ethernet, tokenring, etc */ |
|
95 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ |
|
96 u_char ifi_addrlen; /* media address length */ |
|
97 u_char ifi_hdrlen; /* media header length */ |
|
98 u_char ifi_link_state; /* current link state */ |
|
99 u_char ifi_recvquota; /* polling quota for receive intrs */ |
|
100 u_char ifi_xmitquota; /* polling quota for xmit intrs */ |
|
101 u_char ifi_datalen; /* length of this data struct */ |
|
102 u_long ifi_mtu; /* maximum transmission unit */ |
|
103 u_long ifi_metric; /* routing metric (external only) */ |
|
104 u_long ifi_baudrate; /* linespeed */ |
|
105 /* volatile statistics */ |
|
106 u_long ifi_ipackets; /* packets received on interface */ |
|
107 u_long ifi_ierrors; /* input errors on interface */ |
|
108 u_long ifi_opackets; /* packets sent on interface */ |
|
109 u_long ifi_oerrors; /* output errors on interface */ |
|
110 u_long ifi_collisions; /* collisions on csma interfaces */ |
|
111 u_long ifi_ibytes; /* total number of octets received */ |
|
112 u_long ifi_obytes; /* total number of octets sent */ |
|
113 u_long ifi_imcasts; /* packets received via multicast */ |
|
114 u_long ifi_omcasts; /* packets sent via multicast */ |
|
115 u_long ifi_iqdrops; /* dropped on input, this interface */ |
|
116 u_long ifi_noproto; /* destined for unsupported protocol */ |
|
117 u_long ifi_hwassist; /* HW offload capabilities */ |
|
118 time_t ifi_epoch; /* uptime at attach or stat reset */ |
|
119 #ifdef __alpha__ |
|
120 u_int ifi_timepad; /* time_t is int, not long on alpha */ |
|
121 #endif |
|
122 struct timeval ifi_lastchange; /* time of last administrative change */ |
|
123 }; |
|
124 |
|
125 /*- |
|
126 * Interface flags are of two types: network stack owned flags, and driver |
|
127 * owned flags. Historically, these values were stored in the same ifnet |
|
128 * flags field, but with the advent of fine-grained locking, they have been |
|
129 * broken out such that the network stack is responsible for synchronizing |
|
130 * the stack-owned fields, and the device driver the device-owned fields. |
|
131 * Both halves can perform lockless reads of the other half's field, subject |
|
132 * to accepting the involved races. |
|
133 * |
|
134 * Both sets of flags come from the same number space, and should not be |
|
135 * permitted to conflict, as they are exposed to user space via a single |
|
136 * field. |
|
137 * |
|
138 * The following symbols identify read and write requirements for fields: |
|
139 * |
|
140 * (i) if_flags field set by device driver before attach, read-only there |
|
141 * after. |
|
142 * (n) if_flags field written only by the network stack, read by either the |
|
143 * stack or driver. |
|
144 * (d) if_drv_flags field written only by the device driver, read by either |
|
145 * the stack or driver. |
|
146 */ |
|
147 #define IFF_UP 0x1 /* (n) interface is up */ |
|
148 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ |
|
149 #define IFF_DEBUG 0x4 /* (n) turn on debugging */ |
|
150 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ |
|
151 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ |
|
152 #define IFF_SMART 0x20 /* (i) interface manages own routes */ |
|
153 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ |
|
154 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */ |
|
155 #define IFF_PROMISC 0x100 /* (n) receive all packets */ |
|
156 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ |
|
157 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ |
|
158 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ |
|
159 #define IFF_LINK0 0x1000 /* per link layer defined bit */ |
|
160 #define IFF_LINK1 0x2000 /* per link layer defined bit */ |
|
161 #define IFF_LINK2 0x4000 /* per link layer defined bit */ |
|
162 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ |
|
163 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */ |
|
164 /* 0x10000 */ |
|
165 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ |
|
166 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ |
|
167 #define IFF_STATICARP 0x80000 /* (n) static ARP */ |
|
168 #define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */ |
|
169 |
|
170 /* |
|
171 * Old names for driver flags so that user space tools can continue to use |
|
172 * the old (portable) names. |
|
173 */ |
|
174 #ifndef _KERNEL |
|
175 #define IFF_RUNNING IFF_DRV_RUNNING |
|
176 #define IFF_OACTIVE IFF_DRV_OACTIVE |
|
177 #endif |
|
178 |
|
179 /* flags set internally only: */ |
|
180 #define IFF_CANTCHANGE \ |
|
181 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ |
|
182 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC) |
|
183 |
|
184 /* |
|
185 * Values for if_link_state. |
|
186 */ |
|
187 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ |
|
188 #define LINK_STATE_DOWN 1 /* link is down */ |
|
189 #define LINK_STATE_UP 2 /* link is up */ |
|
190 |
|
191 /* |
|
192 * Some convenience macros used for setting ifi_baudrate. |
|
193 * XXX 1000 vs. 1024? --thorpej@netbsd.org |
|
194 */ |
|
195 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ |
|
196 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ |
|
197 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ |
|
198 |
|
199 /* Capabilities that interfaces can advertise. */ |
|
200 #define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ |
|
201 #define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ |
|
202 #define IFCAP_NETCONS 0x0004 /* can be a network console */ |
|
203 #define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ |
|
204 #define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ |
|
205 #define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */ |
|
206 #define IFCAP_POLLING 0x0040 /* driver supports polling */ |
|
207 |
|
208 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) |
|
209 |
|
210 #define IFQ_MAXLEN 50 |
|
211 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ |
|
212 |
|
213 /* |
|
214 * Message format for use in obtaining information about interfaces |
|
215 * from getkerninfo and the routing socket |
|
216 */ |
|
217 struct if_msghdr { |
|
218 u_short ifm_msglen; /* to skip over non-understood messages */ |
|
219 u_char ifm_version; /* future binary compatibility */ |
|
220 u_char ifm_type; /* message type */ |
|
221 int ifm_addrs; /* like rtm_addrs */ |
|
222 int ifm_flags; /* value of if_flags */ |
|
223 u_short ifm_index; /* index for associated ifp */ |
|
224 struct if_data ifm_data;/* statistics and other data about if */ |
|
225 }; |
|
226 |
|
227 /* |
|
228 * Message format for use in obtaining information about interface addresses |
|
229 * from getkerninfo and the routing socket |
|
230 */ |
|
231 struct ifa_msghdr { |
|
232 u_short ifam_msglen; /* to skip over non-understood messages */ |
|
233 u_char ifam_version; /* future binary compatibility */ |
|
234 u_char ifam_type; /* message type */ |
|
235 int ifam_addrs; /* like rtm_addrs */ |
|
236 int ifam_flags; /* value of ifa_flags */ |
|
237 u_short ifam_index; /* index for associated ifp */ |
|
238 int ifam_metric; /* value of ifa_metric */ |
|
239 }; |
|
240 |
|
241 /* |
|
242 * Message format for use in obtaining information about multicast addresses |
|
243 * from the routing socket |
|
244 */ |
|
245 struct ifma_msghdr { |
|
246 u_short ifmam_msglen; /* to skip over non-understood messages */ |
|
247 u_char ifmam_version; /* future binary compatibility */ |
|
248 u_char ifmam_type; /* message type */ |
|
249 int ifmam_addrs; /* like rtm_addrs */ |
|
250 int ifmam_flags; /* value of ifa_flags */ |
|
251 u_short ifmam_index; /* index for associated ifp */ |
|
252 }; |
|
253 |
|
254 /* |
|
255 * Message format announcing the arrival or departure of a network interface. |
|
256 */ |
|
257 struct if_announcemsghdr { |
|
258 u_short ifan_msglen; /* to skip over non-understood messages */ |
|
259 u_char ifan_version; /* future binary compatibility */ |
|
260 u_char ifan_type; /* message type */ |
|
261 u_short ifan_index; /* index for associated ifp */ |
|
262 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
263 u_short ifan_what; /* what type of announcement */ |
|
264 }; |
|
265 |
|
266 #define IFAN_ARRIVAL 0 /* interface arrival */ |
|
267 #define IFAN_DEPARTURE 1 /* interface departure */ |
|
268 |
|
269 /* |
|
270 * Interface request structure used for socket |
|
271 * ioctl's. All interface ioctl's must have parameter |
|
272 * definitions which begin with ifr_name. The |
|
273 * remainder may be interface specific. |
|
274 */ |
|
275 struct ifreq { |
|
276 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
277 union { |
|
278 struct sockaddr ifru_addr; |
|
279 struct sockaddr ifru_dstaddr; |
|
280 struct sockaddr ifru_broadaddr; |
|
281 struct sockaddr ifru_hwaddr; |
|
282 short ifru_flags[2]; |
|
283 short ifru_index; |
|
284 int ifru_metric; |
|
285 int ifru_mtu; |
|
286 int ifru_phys; |
|
287 int ifru_media; |
|
288 caddr_t ifru_data; |
|
289 int ifru_cap[2]; |
|
290 unsigned int snap_id; |
|
291 } ifr_ifru; |
|
292 #ifdef __SYMBIAN32__ |
|
293 #define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */ |
|
294 #endif |
|
295 #define ifr_addr ifr_ifru.ifru_addr /* address */ |
|
296 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ |
|
297 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ |
|
298 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ |
|
299 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ |
|
300 #define ifr_metric ifr_ifru.ifru_metric /* metric */ |
|
301 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ |
|
302 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ |
|
303 #define ifr_media ifr_ifru.ifru_media /* physical media */ |
|
304 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ |
|
305 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ |
|
306 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ |
|
307 #define ifr_index ifr_ifru.ifru_index /* interface index */ |
|
308 }; |
|
309 |
|
310 #define _SIZEOF_ADDR_IFREQ(ifr) \ |
|
311 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ |
|
312 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ |
|
313 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) |
|
314 |
|
315 struct ifaliasreq { |
|
316 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
317 struct sockaddr ifra_addr; |
|
318 struct sockaddr ifra_broadaddr; |
|
319 struct sockaddr ifra_mask; |
|
320 }; |
|
321 |
|
322 struct ifmediareq { |
|
323 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
324 int ifm_current; /* current media options */ |
|
325 int ifm_mask; /* don't care mask */ |
|
326 int ifm_status; /* media status */ |
|
327 int ifm_active; /* active options */ |
|
328 int ifm_count; /* # entries in ifm_ulist array */ |
|
329 int *ifm_ulist; /* media words */ |
|
330 }; |
|
331 |
|
332 struct ifdrv { |
|
333 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
334 unsigned long ifd_cmd; |
|
335 size_t ifd_len; |
|
336 void *ifd_data; |
|
337 }; |
|
338 |
|
339 /* |
|
340 * Structure used to retrieve aux status data from interfaces. |
|
341 * Kernel suppliers to this interface should respect the formatting |
|
342 * needed by ifconfig(8): each line starts with a TAB and ends with |
|
343 * a newline. The canonical example to copy and paste is in if_tun.c. |
|
344 */ |
|
345 |
|
346 #define IFSTATMAX 800 /* 10 lines of text */ |
|
347 struct ifstat { |
|
348 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
|
349 char ascii[IFSTATMAX + 1]; |
|
350 }; |
|
351 |
|
352 /* |
|
353 * Structure used in SIOCGIFCONF request. |
|
354 * Used to retrieve interface configuration |
|
355 * for machine (useful for programs which |
|
356 * must know all networks accessible). |
|
357 */ |
|
358 struct ifconf { |
|
359 int ifc_len; /* size of associated buffer */ |
|
360 union { |
|
361 caddr_t ifcu_buf; |
|
362 struct ifreq *ifcu_req; |
|
363 } ifc_ifcu; |
|
364 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ |
|
365 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ |
|
366 }; |
|
367 |
|
368 |
|
369 /* |
|
370 * Structure for SIOC[AGD]LIFADDR |
|
371 */ |
|
372 struct if_laddrreq { |
|
373 char iflr_name[IFNAMSIZ]; |
|
374 u_int flags; |
|
375 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ |
|
376 u_int prefixlen; /* in/out */ |
|
377 struct sockaddr_storage addr; /* in/out */ |
|
378 struct sockaddr_storage dstaddr; /* out */ |
|
379 }; |
|
380 |
|
381 #endif /* __BSD_VISIBLE */ |
|
382 |
|
383 #ifndef _KERNEL |
|
384 struct if_nameindex { |
|
385 unsigned int if_index; /* 1, 2, ... */ |
|
386 char *if_name; /* null terminated name: "le0", ... */ |
|
387 }; |
|
388 |
|
389 __BEGIN_DECLS |
|
390 IMPORT_C void if_freenameindex(struct if_nameindex *); |
|
391 IMPORT_C char *if_indextoname(unsigned int, char *); |
|
392 IMPORT_C struct if_nameindex *if_nameindex(void); |
|
393 IMPORT_C unsigned int if_nametoindex(const char *); |
|
394 __END_DECLS |
|
395 #endif |
|
396 |
|
397 #ifdef _KERNEL |
|
398 struct thread; |
|
399 |
|
400 /* XXX - this should go away soon. */ |
|
401 #include <net/if_var.h> |
|
402 #endif |
|
403 |
|
404 /* |
|
405 * Symbian specific APIs |
|
406 */ |
|
407 #ifdef __SYMBIAN32__ |
|
408 IMPORT_C int setdefaultif( const struct ifreq* ); |
|
409 #endif |
|
410 |
|
411 #ifdef __SYMBIAN32__ |
|
412 #ifdef __cplusplus |
|
413 } |
|
414 #endif |
|
415 #endif |
|
416 |
|
417 #endif /* !_NET_IF_H_ */ |