1.1 --- a/epoc32/include/stdapis/net/if.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/stdapis/net/if.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,417 @@
1.4 -if.h
1.5 +/*-
1.6 + * © Portions copyright (c) 2005-2009 Nokia Corporation. All rights reserved.
1.7 + * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved.
1.8 + * Copyright (c) 1982, 1986, 1989, 1993
1.9 + * The Regents of the University of California. All rights reserved.
1.10 + *
1.11 + * Redistribution and use in source and binary forms, with or without
1.12 + * modification, are permitted provided that the following conditions
1.13 + * are met:
1.14 + * 1. Redistributions of source code must retain the above copyright
1.15 + * notice, this list of conditions and the following disclaimer.
1.16 + * 2. Redistributions in binary form must reproduce the above copyright
1.17 + * notice, this list of conditions and the following disclaimer in the
1.18 + * documentation and/or other materials provided with the distribution.
1.19 + * 4. Neither the name of the University nor the names of its contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1.24 + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.25 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.26 + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
1.27 + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1.28 + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1.29 + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1.30 + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
1.31 + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
1.32 + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.33 + * SUCH DAMAGE.
1.34 + *
1.35 + * @(#)if.h 8.1 (Berkeley) 6/10/93
1.36 + * $FreeBSD: src/sys/net/if.h,v 1.96.2.3 2005/10/07 14:00:05 glebius Exp $
1.37 + */
1.38 +
1.39 +#ifndef _NET_IF_H_
1.40 +#define _NET_IF_H_
1.41 +
1.42 +#ifdef __SYMBIAN32__
1.43 +#ifdef __cplusplus
1.44 +extern "C" {
1.45 +#endif
1.46 +#endif
1.47 +
1.48 +#include <sys/cdefs.h>
1.49 +
1.50 +#ifdef _KERNEL
1.51 +#include <sys/queue.h>
1.52 +#endif
1.53 +
1.54 +#if __BSD_VISIBLE
1.55 +/*
1.56 + * <net/if.h> does not depend on <sys/time.h> on most other systems. This
1.57 + * helps userland compatibility. (struct timeval ifi_lastchange)
1.58 + */
1.59 +#ifndef _KERNEL
1.60 +#include <sys/time.h>
1.61 +#endif
1.62 +
1.63 +struct ifnet;
1.64 +#endif
1.65 +
1.66 +/*
1.67 + * Length of interface external name, including terminating '\0'.
1.68 + * Note: this is the same size as a generic device's external name.
1.69 + */
1.70 +#ifdef __SYMBIAN32__
1.71 +// KCommsDbSvrMaxColumnNameLength = 50
1.72 +#define IF_NAMESIZE 50
1.73 +#else
1.74 +#define IF_NAMESIZE 16
1.75 +#endif
1.76 +#if __BSD_VISIBLE
1.77 +#define IFNAMSIZ IF_NAMESIZE
1.78 +#define IF_MAXUNIT 0x7fff /* historical value */
1.79 +#endif
1.80 +#if __BSD_VISIBLE
1.81 +
1.82 +/*
1.83 + * Structure used to query names of interface cloners.
1.84 + */
1.85 +
1.86 +struct if_clonereq {
1.87 + int ifcr_total; /* total cloners (out) */
1.88 + int ifcr_count; /* room for this many in user buffer */
1.89 + char *ifcr_buffer; /* buffer for cloner names */
1.90 +};
1.91 +
1.92 +/*
1.93 + * Structure describing information about an interface
1.94 + * which may be of interest to management entities.
1.95 + */
1.96 +struct if_data {
1.97 + /* generic interface information */
1.98 + u_char ifi_type; /* ethernet, tokenring, etc */
1.99 + u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
1.100 + u_char ifi_addrlen; /* media address length */
1.101 + u_char ifi_hdrlen; /* media header length */
1.102 + u_char ifi_link_state; /* current link state */
1.103 + u_char ifi_recvquota; /* polling quota for receive intrs */
1.104 + u_char ifi_xmitquota; /* polling quota for xmit intrs */
1.105 + u_char ifi_datalen; /* length of this data struct */
1.106 + u_long ifi_mtu; /* maximum transmission unit */
1.107 + u_long ifi_metric; /* routing metric (external only) */
1.108 + u_long ifi_baudrate; /* linespeed */
1.109 + /* volatile statistics */
1.110 + u_long ifi_ipackets; /* packets received on interface */
1.111 + u_long ifi_ierrors; /* input errors on interface */
1.112 + u_long ifi_opackets; /* packets sent on interface */
1.113 + u_long ifi_oerrors; /* output errors on interface */
1.114 + u_long ifi_collisions; /* collisions on csma interfaces */
1.115 + u_long ifi_ibytes; /* total number of octets received */
1.116 + u_long ifi_obytes; /* total number of octets sent */
1.117 + u_long ifi_imcasts; /* packets received via multicast */
1.118 + u_long ifi_omcasts; /* packets sent via multicast */
1.119 + u_long ifi_iqdrops; /* dropped on input, this interface */
1.120 + u_long ifi_noproto; /* destined for unsupported protocol */
1.121 + u_long ifi_hwassist; /* HW offload capabilities */
1.122 + time_t ifi_epoch; /* uptime at attach or stat reset */
1.123 +#ifdef __alpha__
1.124 + u_int ifi_timepad; /* time_t is int, not long on alpha */
1.125 +#endif
1.126 + struct timeval ifi_lastchange; /* time of last administrative change */
1.127 +};
1.128 +
1.129 +/*-
1.130 + * Interface flags are of two types: network stack owned flags, and driver
1.131 + * owned flags. Historically, these values were stored in the same ifnet
1.132 + * flags field, but with the advent of fine-grained locking, they have been
1.133 + * broken out such that the network stack is responsible for synchronizing
1.134 + * the stack-owned fields, and the device driver the device-owned fields.
1.135 + * Both halves can perform lockless reads of the other half's field, subject
1.136 + * to accepting the involved races.
1.137 + *
1.138 + * Both sets of flags come from the same number space, and should not be
1.139 + * permitted to conflict, as they are exposed to user space via a single
1.140 + * field.
1.141 + *
1.142 + * The following symbols identify read and write requirements for fields:
1.143 + *
1.144 + * (i) if_flags field set by device driver before attach, read-only there
1.145 + * after.
1.146 + * (n) if_flags field written only by the network stack, read by either the
1.147 + * stack or driver.
1.148 + * (d) if_drv_flags field written only by the device driver, read by either
1.149 + * the stack or driver.
1.150 + */
1.151 +#define IFF_UP 0x1 /* (n) interface is up */
1.152 +#define IFF_BROADCAST 0x2 /* (i) broadcast address valid */
1.153 +#define IFF_DEBUG 0x4 /* (n) turn on debugging */
1.154 +#define IFF_LOOPBACK 0x8 /* (i) is a loopback net */
1.155 +#define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */
1.156 +#define IFF_SMART 0x20 /* (i) interface manages own routes */
1.157 +#define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */
1.158 +#define IFF_NOARP 0x80 /* (n) no address resolution protocol */
1.159 +#define IFF_PROMISC 0x100 /* (n) receive all packets */
1.160 +#define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */
1.161 +#define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */
1.162 +#define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */
1.163 +#define IFF_LINK0 0x1000 /* per link layer defined bit */
1.164 +#define IFF_LINK1 0x2000 /* per link layer defined bit */
1.165 +#define IFF_LINK2 0x4000 /* per link layer defined bit */
1.166 +#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
1.167 +#define IFF_MULTICAST 0x8000 /* (i) supports multicast */
1.168 +/* 0x10000 */
1.169 +#define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */
1.170 +#define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */
1.171 +#define IFF_STATICARP 0x80000 /* (n) static ARP */
1.172 +#define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */
1.173 +
1.174 +/*
1.175 + * Old names for driver flags so that user space tools can continue to use
1.176 + * the old (portable) names.
1.177 + */
1.178 +#ifndef _KERNEL
1.179 +#define IFF_RUNNING IFF_DRV_RUNNING
1.180 +#define IFF_OACTIVE IFF_DRV_OACTIVE
1.181 +#endif
1.182 +
1.183 +/* flags set internally only: */
1.184 +#define IFF_CANTCHANGE \
1.185 + (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
1.186 + IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC)
1.187 +
1.188 +/*
1.189 + * Values for if_link_state.
1.190 + */
1.191 +#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
1.192 +#define LINK_STATE_DOWN 1 /* link is down */
1.193 +#define LINK_STATE_UP 2 /* link is up */
1.194 +
1.195 +/*
1.196 + * Some convenience macros used for setting ifi_baudrate.
1.197 + * XXX 1000 vs. 1024? --thorpej@netbsd.org
1.198 + */
1.199 +#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
1.200 +#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
1.201 +#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
1.202 +
1.203 +/* Capabilities that interfaces can advertise. */
1.204 +#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */
1.205 +#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */
1.206 +#define IFCAP_NETCONS 0x0004 /* can be a network console */
1.207 +#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */
1.208 +#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */
1.209 +#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */
1.210 +#define IFCAP_POLLING 0x0040 /* driver supports polling */
1.211 +
1.212 +#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
1.213 +
1.214 +#define IFQ_MAXLEN 50
1.215 +#define IFNET_SLOWHZ 1 /* granularity is 1 second */
1.216 +
1.217 +/*
1.218 + * Message format for use in obtaining information about interfaces
1.219 + * from getkerninfo and the routing socket
1.220 + */
1.221 +struct if_msghdr {
1.222 + u_short ifm_msglen; /* to skip over non-understood messages */
1.223 + u_char ifm_version; /* future binary compatibility */
1.224 + u_char ifm_type; /* message type */
1.225 + int ifm_addrs; /* like rtm_addrs */
1.226 + int ifm_flags; /* value of if_flags */
1.227 + u_short ifm_index; /* index for associated ifp */
1.228 + struct if_data ifm_data;/* statistics and other data about if */
1.229 +};
1.230 +
1.231 +/*
1.232 + * Message format for use in obtaining information about interface addresses
1.233 + * from getkerninfo and the routing socket
1.234 + */
1.235 +struct ifa_msghdr {
1.236 + u_short ifam_msglen; /* to skip over non-understood messages */
1.237 + u_char ifam_version; /* future binary compatibility */
1.238 + u_char ifam_type; /* message type */
1.239 + int ifam_addrs; /* like rtm_addrs */
1.240 + int ifam_flags; /* value of ifa_flags */
1.241 + u_short ifam_index; /* index for associated ifp */
1.242 + int ifam_metric; /* value of ifa_metric */
1.243 +};
1.244 +
1.245 +/*
1.246 + * Message format for use in obtaining information about multicast addresses
1.247 + * from the routing socket
1.248 + */
1.249 +struct ifma_msghdr {
1.250 + u_short ifmam_msglen; /* to skip over non-understood messages */
1.251 + u_char ifmam_version; /* future binary compatibility */
1.252 + u_char ifmam_type; /* message type */
1.253 + int ifmam_addrs; /* like rtm_addrs */
1.254 + int ifmam_flags; /* value of ifa_flags */
1.255 + u_short ifmam_index; /* index for associated ifp */
1.256 +};
1.257 +
1.258 +/*
1.259 + * Message format announcing the arrival or departure of a network interface.
1.260 + */
1.261 +struct if_announcemsghdr {
1.262 + u_short ifan_msglen; /* to skip over non-understood messages */
1.263 + u_char ifan_version; /* future binary compatibility */
1.264 + u_char ifan_type; /* message type */
1.265 + u_short ifan_index; /* index for associated ifp */
1.266 + char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.267 + u_short ifan_what; /* what type of announcement */
1.268 +};
1.269 +
1.270 +#define IFAN_ARRIVAL 0 /* interface arrival */
1.271 +#define IFAN_DEPARTURE 1 /* interface departure */
1.272 +
1.273 +/*
1.274 + * Interface request structure used for socket
1.275 + * ioctl's. All interface ioctl's must have parameter
1.276 + * definitions which begin with ifr_name. The
1.277 + * remainder may be interface specific.
1.278 + */
1.279 +struct ifreq {
1.280 + char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.281 + union {
1.282 + struct sockaddr ifru_addr;
1.283 + struct sockaddr ifru_dstaddr;
1.284 + struct sockaddr ifru_broadaddr;
1.285 + struct sockaddr ifru_hwaddr;
1.286 + short ifru_flags[2];
1.287 + short ifru_index;
1.288 + int ifru_metric;
1.289 + int ifru_mtu;
1.290 + int ifru_phys;
1.291 + int ifru_media;
1.292 + caddr_t ifru_data;
1.293 + int ifru_cap[2];
1.294 + unsigned int snap_id;
1.295 + } ifr_ifru;
1.296 +#ifdef __SYMBIAN32__
1.297 +#define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
1.298 +#endif
1.299 +#define ifr_addr ifr_ifru.ifru_addr /* address */
1.300 +#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
1.301 +#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
1.302 +#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
1.303 +#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
1.304 +#define ifr_metric ifr_ifru.ifru_metric /* metric */
1.305 +#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
1.306 +#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
1.307 +#define ifr_media ifr_ifru.ifru_media /* physical media */
1.308 +#define ifr_data ifr_ifru.ifru_data /* for use by interface */
1.309 +#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
1.310 +#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
1.311 +#define ifr_index ifr_ifru.ifru_index /* interface index */
1.312 +};
1.313 +
1.314 +#define _SIZEOF_ADDR_IFREQ(ifr) \
1.315 + ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
1.316 + (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
1.317 + (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
1.318 +
1.319 +struct ifaliasreq {
1.320 + char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.321 + struct sockaddr ifra_addr;
1.322 + struct sockaddr ifra_broadaddr;
1.323 + struct sockaddr ifra_mask;
1.324 +};
1.325 +
1.326 +struct ifmediareq {
1.327 + char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.328 + int ifm_current; /* current media options */
1.329 + int ifm_mask; /* don't care mask */
1.330 + int ifm_status; /* media status */
1.331 + int ifm_active; /* active options */
1.332 + int ifm_count; /* # entries in ifm_ulist array */
1.333 + int *ifm_ulist; /* media words */
1.334 +};
1.335 +
1.336 +struct ifdrv {
1.337 + char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.338 + unsigned long ifd_cmd;
1.339 + size_t ifd_len;
1.340 + void *ifd_data;
1.341 +};
1.342 +
1.343 +/*
1.344 + * Structure used to retrieve aux status data from interfaces.
1.345 + * Kernel suppliers to this interface should respect the formatting
1.346 + * needed by ifconfig(8): each line starts with a TAB and ends with
1.347 + * a newline. The canonical example to copy and paste is in if_tun.c.
1.348 + */
1.349 +
1.350 +#define IFSTATMAX 800 /* 10 lines of text */
1.351 +struct ifstat {
1.352 + char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
1.353 + char ascii[IFSTATMAX + 1];
1.354 +};
1.355 +
1.356 +/*
1.357 + * Structure used in SIOCGIFCONF request.
1.358 + * Used to retrieve interface configuration
1.359 + * for machine (useful for programs which
1.360 + * must know all networks accessible).
1.361 + */
1.362 +struct ifconf {
1.363 + int ifc_len; /* size of associated buffer */
1.364 + union {
1.365 + caddr_t ifcu_buf;
1.366 + struct ifreq *ifcu_req;
1.367 + } ifc_ifcu;
1.368 +#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
1.369 +#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
1.370 +};
1.371 +
1.372 +
1.373 +/*
1.374 + * Structure for SIOC[AGD]LIFADDR
1.375 + */
1.376 +struct if_laddrreq {
1.377 + char iflr_name[IFNAMSIZ];
1.378 + u_int flags;
1.379 +#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
1.380 + u_int prefixlen; /* in/out */
1.381 + struct sockaddr_storage addr; /* in/out */
1.382 + struct sockaddr_storage dstaddr; /* out */
1.383 +};
1.384 +
1.385 +#endif /* __BSD_VISIBLE */
1.386 +
1.387 +#ifndef _KERNEL
1.388 +struct if_nameindex {
1.389 + unsigned int if_index; /* 1, 2, ... */
1.390 + char *if_name; /* null terminated name: "le0", ... */
1.391 +};
1.392 +
1.393 +__BEGIN_DECLS
1.394 +IMPORT_C void if_freenameindex(struct if_nameindex *);
1.395 +IMPORT_C char *if_indextoname(unsigned int, char *);
1.396 +IMPORT_C struct if_nameindex *if_nameindex(void);
1.397 +IMPORT_C unsigned int if_nametoindex(const char *);
1.398 +__END_DECLS
1.399 +#endif
1.400 +
1.401 +#ifdef _KERNEL
1.402 +struct thread;
1.403 +
1.404 +/* XXX - this should go away soon. */
1.405 +#include <net/if_var.h>
1.406 +#endif
1.407 +
1.408 +/*
1.409 + * Symbian specific APIs
1.410 + */
1.411 +#ifdef __SYMBIAN32__
1.412 +IMPORT_C int setdefaultif( const struct ifreq* );
1.413 +#endif
1.414 +
1.415 +#ifdef __SYMBIAN32__
1.416 +#ifdef __cplusplus
1.417 +}
1.418 +#endif
1.419 +#endif
1.420 +
1.421 +#endif /* !_NET_IF_H_ */