/*
- * Copyright (c) 2008 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2004-2011 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
@constant IFNET_FAMILY_STF A 6to4 interface.
@constant IFNET_FAMILY_FIREWIRE An IEEE 1394 (firewire) interface.
@constant IFNET_FAMILY_BOND A virtual bonded interface.
+ @constant IFNET_FAMILY_CELLULAR A cellular interface.
*/
enum {
IFNET_FAMILY_FAITH = 11,
IFNET_FAMILY_STF = 12,
IFNET_FAMILY_FIREWIRE = 13,
- IFNET_FAMILY_BOND = 14
+ IFNET_FAMILY_BOND = 14,
+ IFNET_FAMILY_CELLULAR = 15
};
/*!
@typedef ifnet_family_t
@constant IFNET_CSUM_UDP Hardware will calculate UDP checksums.
@constant IFNET_CSUM_FRAGMENT Hardware will checksum IP fragments.
@constant IFNET_IP_FRAGMENT Hardware will fragment IP packets.
+ @constant IFNET_CSUM_TCPIPV6 Hardware will calculate TCP IPv6 checksums.
+ @constant IFNET_CSUM_UDPIPV6 Hardware will calculate UDP IPv6 checksums.
+ @constant IFNET_IPV6_FRAGMENT Hardware will fragment IPv6 packets.
@constant IFNET_VLAN_TAGGING Hardware will generate VLAN headers.
@constant IFNET_VLAN_MTU Hardware supports VLAN MTU.
@constant IFNET_MULTIPAGES Driver is capable of handling packets
If the Interface driver sets this flag, TCP will send larger frames (up to 64KB) as one
frame to the adapter which will perform the final packetization. The maximum TSO segment
supported by the interface can be set with "ifnet_set_tso_mtu". To retreive the real MTU
- for the TCP connection the function "mbuf_get_tso_requested" is used by the driver.
+ for the TCP connection the function "mbuf_get_tso_requested" is used by the driver. Note
+ that if TSO is active, all the packets will be flagged for TSO, not just large packets.
@constant IFNET_TSO_IPV6 Hardware supports IPv6 TCP Segment Offloading.
+ If the Interface driver sets this flag, TCP IPv6 will send larger frames (up to 64KB) as one
+ frame to the adapter which will perform the final packetization. The maximum TSO segment
+ supported by the interface can be set with "ifnet_set_tso_mtu". To retreive the real MTU
+ for the TCP IPv6 connection the function "mbuf_get_tso_requested" is used by the driver.
+ Note that if TSO is active, all the packets will be flagged for TSO, not just large packets.
+
*/
enum {
IFNET_CSUM_UDP = 0x00000004,
IFNET_CSUM_FRAGMENT = 0x00000008,
IFNET_IP_FRAGMENT = 0x00000010,
+ IFNET_CSUM_TCPIPV6 = 0x00000020,
+ IFNET_CSUM_UDPIPV6 = 0x00000040,
+ IFNET_IPV6_FRAGMENT = 0x00000080,
#ifdef KERNEL_PRIVATE
IFNET_CSUM_SUM16 = 0x00001000,
#endif /* KERNEL_PRIVATE */
@function ifnet_family
@discussion Returns the family of the interface.
@param interface Interface to retrieve the unit number from.
- @result Unit number.
+ @result Interface family type.
*/
extern ifnet_family_t ifnet_family(ifnet_t interface);
@result Extended flags. These flags are defined in net/if.h
*/
extern u_int32_t ifnet_eflags(ifnet_t interface);
+
+/*!
+ @function ifnet_set_idle_flags
+ @discussion Sets the if_idle_flags to new_flags. This function
+ lets you specify which flags you want to change using the
+ mask. The kernel will effectively take the lock, then set
+ the interface's idle flags to:
+ (if_idle_flags & ~mask) | (new_flags & mask).
+ Setting the flags to any non-zero value will cause the
+ networking stack to aggressively purge expired objects,
+ such as route entries, etc.
+ @param interface The interface.
+ @param new_flags The new set of flags that should be set. These
+ flags are defined in net/if.h
+ @param mask The mask of flags to be modified.
+ @result 0 on success otherwise the errno error. ENOTSUP is returned
+ when this call is made on non-supporting platforms.
+*/
+extern errno_t ifnet_set_idle_flags(ifnet_t interface, u_int32_t new_flags,
+ u_int32_t mask);
+
+/*!
+ @function ifnet_idle_flags
+ @discussion Returns the value of if_idle_flags.
+ @param interface Interface to retrieve the flags from.
+ @result if_idle_flags. These flags are defined in net/if.h
+*/
+extern u_int32_t ifnet_idle_flags(ifnet_t interface);
+
#endif /* KERNEL_PRIVATE */
+/*!
+ @function ifnet_set_capabilities_supported
+ @discussion Specify the capabilities supported by the interface.
+ @discussion This function lets you specify which capabilities are supported
+ by the interface. Typically this function is called by the driver when
+ the interface gets attached to the system.
+ The mask allows to control which capability to set or unset.
+ The kernel will effectively take the lock, then set the
+ interface's flags to (if_capabilities & ~mask) | (new_caps & mask).
+
+ This function is intended to be called by the driver. A kext
+ must not call this function on an interface the kext does not
+ own.
+ @param interface Interface to set the capabilities on.
+ @param new_caps The value of the capabilities that should be set or unset. These
+ flags are defined in net/if.h
+ @param mask Which capabilities that should be affected. These
+ flags are defined in net/if.h
+ @result 0 on success otherwise the errno error.
+ */
+extern errno_t ifnet_set_capabilities_supported(ifnet_t interface, u_int32_t new_caps,
+ u_int32_t mask);
+
+/*!
+ @function ifnet_capabilities_supported
+ @discussion Retrieve the interface capabilities supported by the interface.
+ @param interface Interface to retrieve the capabilities from.
+ @result Flags. Capabilities flags are defined in net/if.h
+ */
+extern u_int32_t ifnet_capabilities_supported(ifnet_t interface);
+
+/*!
+ @function ifnet_set_capabilities_enabled
+ @discussion Enable and/or disable the interface capabilities to match new_caps.
+ @discussion Sets the interface capabilities to new_caps. This function
+ lets you specify which capabilities you want to change using the mask.
+ The kernel will effectively take the lock, then set the
+ interface's flags to (if_capenable & ~mask) | (new_caps & mask).
+
+ This function is intended to be called by the driver. A kext
+ must not call this function on an interface the kext does not
+ own.
+
+ Typically this function is called by the driver when the interface is
+ created to specify which of the supported capabilities are enabled by
+ default. This function is also meant to be called when the driver handles
+ the interface ioctl SIOCSIFCAP.
+
+ The driver should call ifnet_set_offlad() to indicate the corresponding
+ hardware offload bits that will be used by the networking stack.
+
+ It is an error to enable a capability that is not marked as
+ supported by the interface.
+ @param interface Interface to set the capabilities on.
+ @param new_caps The value of the capabilities that should be set or unset. These
+ flags are defined in net/if.h
+ @param mask Which capabilities that should be affected. These
+ flags are defined in net/if.h
+ @result 0 on success otherwise the errno error.
+ */
+extern errno_t ifnet_set_capabilities_enabled(ifnet_t interface, u_int32_t new_caps,
+ u_int32_t mask);
+
+/*!
+ @function ifnet_capabilities_enabled
+ @discussion Retrieve the interface capabilities enabled on the interface.
+ @param interface Interface to retrieve the capabilities from.
+ @result Flags. Capabilities flags are defined in net/if.h
+ */
+extern u_int32_t ifnet_capabilities_enabled(ifnet_t interface);
+
+
/*!
@function ifnet_set_offload
@discussion Sets a bitfield to indicate special hardware offload
support provided by the interface such as hardware checksums and
VLAN. This replaces the if_hwassist flags field. Any flags
unrecognized by the stack will not be set.
+
+ Note the system will automatically set the interface capabilities
+ that correspond to the offload flags modified -- i.e. the driver
+ does not have to call ifnet_set_capabilities_enabled() and
+ ifnet_set_capabilities_supported().
@param interface The interface.
@param offload The new set of flags indicating which offload options
the device supports.
- @param mask The mask of flags to be modified.
@result 0 on success otherwise the errno error.
*/
extern errno_t ifnet_set_offload(ifnet_t interface, ifnet_offload_t offload);
extern errno_t ifnet_get_address_list_family(ifnet_t interface,
ifaddr_t **addresses, sa_family_t family);
+#ifdef KERNEL_PRIVATE
+__private_extern__ errno_t ifnet_get_address_list_family_internal(ifnet_t,
+ ifaddr_t **, sa_family_t, int, int);
+#endif /* KERNEL_PRIVATE */
+
/*!
@function ifnet_free_address_list
@discussion Free a list of addresses returned from
ifnet_remove_multicast and making sure you no longer have any
references to the multicast.
@param interface The interface.
- @param maddr The multicast address to join. Either a physical
- address or logical address to be translated to a physical
- address.
+ @param maddr The multicast address (AF_UNSPEC/AF_LINK) to join. Either
+ a physical address or logical address to be translated to a
+ physical address.
@param multicast The resulting ifmultiaddr_t multicast address.
@result 0 on success otherwise the errno error.
*/
*/
extern ifnet_t ifmaddr_ifnet(ifmultiaddr_t ifmaddr);
+#ifdef KERNEL_PRIVATE
+/******************************************************************************/
+/* interface cloner */
+/******************************************************************************/
+
+/*
+ @typedef ifnet_clone_create_func
+ @discussion ifnet_clone_create_func is called to create an interface.
+ @param ifcloner The interface cloner.
+ @param unit The interface unit number to create.
+ @param params Additional information specific to the interface cloner.
+ @result Return zero on success or an errno error value on failure.
+ */
+typedef errno_t (*ifnet_clone_create_func)(if_clone_t ifcloner, u_int32_t unit, void *params);
+
+/*
+ @typedef ifnet_clone_destroy_func
+ @discussion ifnet_clone_create_func is called to destroy an interface created
+ by an interface cloner.
+ @param interface The interface to destroy.
+ @result Return zero on success or an errno error value on failure.
+ */
+typedef errno_t (*ifnet_clone_destroy_func)(ifnet_t interface);
+
+/*
+ @struct ifnet_clone_params
+ @discussion This structure is used to represent an interface cloner.
+ @field ifc_name The interface name handled by this interface cloner.
+ @field ifc_create The function to create an interface.
+ @field ifc_destroy The function to destroy an interface.
+*/
+struct ifnet_clone_params {
+ const char *ifc_name;
+ ifnet_clone_create_func ifc_create;
+ ifnet_clone_destroy_func ifc_destroy;
+};
+
+/*
+ @function ifnet_clone_attach
+ @discussion Attaches a new interface cloner.
+ @param cloner_params The structure that defines an interface cloner.
+ @param interface A pointer to an opaque handle that represent the interface cloner
+ that is attached upon success.
+ @result Returns 0 on success.
+ May return ENOBUFS if there is insufficient memory.
+ May return EEXIST if an interface cloner with the same name is already attached.
+ */
+extern errno_t ifnet_clone_attach(struct ifnet_clone_params *cloner_params, if_clone_t *ifcloner);
+
+/*
+ @function ifnet_clone_detach
+ @discussion Detaches a previously attached interface cloner.
+ @param ifcloner The opaque handle returned when the interface cloner was attached.
+ @result Returns 0 on success.
+ */
+extern errno_t ifnet_clone_detach(if_clone_t ifcloner);
+
+#endif /* KERNEL_PRIVATE */
+
__END_DECLS
#endif /* __KPI_INTERFACE__ */
+
projects / apple / xnu.git / blobdiff