bsd/net/kpi_interface.h

19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
167 		pages that are disjoint, depending on the interface MTU
225 	@param interface The interface being sent or received on.
239 	@param interface The interface being sent on.
277 		function that will be called on an interface. Until this
296 	@param interface The interface the packet was received on.
313 	@discussion ifnet_event_func is called when an event occurs on a
315 	@param interface The interface the event occurred on.
326 	@param interface The interface the packet is being sent on.
404 		Zero upon success, EADDRNOTAVAIL on invalid multicast,
413 		a specific protocol on a specific interface. This function is
414 		registered on an interface using ifnet_attach_protocol.
415 	@param ifp The interface the packet was received on.
431 		a specific protocol on a specific interface. This function is
432 		registered on an interface using ifnet_attach_protocolv2.
437 	@param ifp The interface the packet was received on.
455 	@param ifp The interface the packet will be sent on.
528 	@result Return zero on success or an errno error value on failure.
540 	@param ifp The interface the arp packet should be sent on.
558 	@result Return zero on success or an errno error value on failure.
566 	@discussion This structure is used increment the counters on a
664 		on the (fully formed) packet, but it is responsible for calling
666 	@param interface The interface being sent on.
684 	@param interface The interface being sent on.
728 		until the next time polling is turned on; the driver should
944 		handling operations related to the protocol on the interface as
1144 	@param interface The interface to set scheduling model on.
1159 	@param interface The interface to set the max queue length on.
1170 	@param interface The interface to get the max queue length on.
1182 	@param interface The interface to get the current queue length on.
1197 	@param interface The interface to set the max queue length on.
1210 	@param interface The interface to get the max queue length on.
1220 	@discussion Trigger the transmission at the driver layer on an
1222 	@param interface The interface to start the transmission on.
1232 		bandwidth available on that link.  The driver may choose to
1248 		system to estimate bandwidth available on that link.  The
1284 		stack will take a reference on the interface and hold it until
1288 		must not call this function on an interface the kext does not
1320 		must not call this function on an interface the kext does not
1323 	@result 0 on success, otherwise errno error.
1342 	@result 0 on success, otherwise errno error.
1352 	@discussion Returns the driver's private storage on the interface.
1401 	@param interface Interface to set the flags on.
1404 	@result 0 on success otherwise the errno error.
1430 	@result 0 on success otherwise the errno error.
1457 	@result 0 on success otherwise the errno error.  ENOTSUP is returned
1458 		when this call is made on non-supporting platforms.
1477 	@result 0 on success otherwise the errno error.  EINVAL if quality
1493 		reachability information of an on-link node.
1498 		based on the last time the system transmitted a packet to the
1506 		calculated based on the last time the system received a packet
1579 		must not call this function on an interface the kext does not
1581 	@param interface Interface to set the capabilities on.
1586 	@result 0 on success otherwise the errno error.
1608 		must not call this function on an interface the kext does not
1621 	@param interface Interface to set the capabilities on.
1626 	@result 0 on success otherwise the errno error.
1633 	@discussion Retrieve the interface capabilities enabled on the interface.
1654 	@result 0 on success otherwise the errno error.
1675 	@result 0 on success otherwise the errno error.
1689 	@result 0 on success otherwise the errno error.
1697 	@constant IFNET_WAKE_ON_MAGIC_PACKET Wake on Magic Packet.
1710 	@result 0 on success otherwise the errno error.
1716 	@discussion Returns the wake properties set on the interface.
1731 		must not call this function on an interface the kext does not
1736 	@result 0 on success otherwise the errno error.
1774 	@result 0 on success otherwise the errno error.
1789 	@result 0 on success otherwise the errno error.
1801 	@result 0 on success otherwise the errno error.
1808 	@discussion Handles an outbound packet on the interface by calling
1826 	@result 0 on success otherwise the errno error.
1834 	@discussion Handles and outbond raw packet on the interface by
1841 		pass through the filters and be sent on the interface as is.
1847 	@result 0 on success otherwise the errno error.
1864 	@result 0 on success otherwise the errno error.
1885 	@result 0 on success otherwise the errno error.
1905 	@result 0 on success otherwise the errno error.
1916 	@result 0 on success otherwise the errno error.
1927 		must not call this function on an interface the kext does not
1931 	@result 0 on success otherwise the errno error.
1953 		must not call this function on an interface the kext does not
1957 	@result 0 on success otherwise the errno error.
1972 		must not call this function on an interface the kext does not
1976 	@result 0 on success otherwise the errno error.
1991 		must not call this function on an interface the kext does not
1995 	@result 0 on success otherwise the errno error.
2010 		must not call this function on an interface the kext does not
2014 	@result 0 on success otherwise the errno error.
2037 	@result 0 on success otherwise the errno error.
2051 	@result 0 on success otherwise the errno error.
2061 		must not call this function on an interface the kext does not
2067 	@result 0 on success otherwise the errno error.
2087 	@result 0 on success otherwise the errno error.
2106 	@result 0 on success otherwise the errno error.
2115 		must not call this function on an interface the kext does not
2122 	@result 0 on success otherwise the errno error.
2131 	@result 0 on success otherwise the errno error.
2138 	@discussion Enable or disable promiscuous mode on the interface. The
2143 	@param interface The interface to toggle promiscuous mode on.
2144 	@param on If set, the number of promicuous on requests will be
2149 	@result 0 on success otherwise the errno error.
2151 extern errno_t ifnet_set_promiscuous(ifnet_t interface, int on);
2157 	@result 0 on success otherwise the errno error.
2171 	@discussion Get a list of addresses on the interface. Passing NULL
2175 		refcount and free the array. If you wish to hold on to a
2180 	@result 0 on success otherwise the errno error.
2186 	@discussion Get a list of addresses on the interface. Passing NULL
2190 		refcount and free the array. If you wish to hold on to a
2197 	@result 0 on success otherwise the errno error.
2220 		changed on.
2244 	@param interface The interface the link-layer address is on.
2269 		changed on.
2289 	@result 0 on success. EOPNOTSUPP indicates the multicast address was
2308 	@result 0 on success otherwise the errno error.
2335 	@result 0 on success otherwise the errno error.
2344 		have their reference counts bumped on your behalf. Calling
2350 	@result 0 on success otherwise the errno error.
2358 		ifnet_get_multicast_list. Decrements the refcount on each
2361 	@result 0 on success otherwise the errno error.
2368 		Caller must call ifnet_release on any non-null interface return
2374 	@result 0 on success otherwise the errno error.
2390 	@result 0 on success otherwise the errno error.
2409 	@result 0 on success otherwise the errno error.
2418 		Decrements the reference count on each interface and frees the
2463 	@result 0 on failure, address family on success.
2504 		Increments the reference count on the ifaddr before returning to
2515 		Increments the reference count on the ifaddr before returning to
2525 		network described by net. Increments the reference count on the
2536 		gateway. Increments the reference count on the ifaddr before
2551 		Increments the reference count on the ifaddr before returning to
2569 	@result 0 on success. Only error will be EINVAL if ifmaddr is not valid.
2580 	@result 0 on success. Only error will be EINVAL if ifmaddr is not valid.
2589 	@result 0 on success.
2600 	@result 0 on success.
2629 	@result Return zero on success or an errno error value on failure.
2638 	@result Return zero on success or an errno error value on failure.
2661 	@result Returns 0 on success.
2671 	@result Returns 0 on success.
2682 		open. An interface that supports waking the host on unicast traffic may
2689 	@result Returns 0 on success.
2711 	@result Returns 0 on success, or EINVAL if arguments are invalid.
2725 	@result Returns 0 on success, or EINVAL if arguments are invalid.
2732 		that the nodes with a locally detected presence on the attached
2736 	@result Returns 0 on success, or EINVAL if arguments are invalid.