bsd/net/kpi_interface.h

165 		clusters.  In this case, the data area of a packet in the
168 		and the packet size.  Such a use of larger than system page
226 	@param data The packet to be transmitted or received.
240 	@param data The packet to be sent.
289 	@discussion ifnet_demux_func is called for each inbound packet to
290 		determine which protocol family the packet belongs to. This
292 		protocol to pass the packet to.  This function may return
295 		packet will be discarded.
296 	@param interface The interface the packet was received on.
297 	@param packet The mbuf containing the packet.
300 		packet should be stored here.
304 			packet will not be freed.
306 			the packet will be freed.
308 typedef errno_t (*ifnet_demux_func)(ifnet_t interface, mbuf_t packet,
323 	@discussion ifnet_framer_func is called for each outbound packet to
326 	@param interface The interface the packet is being sent on.
327 	@param packet Pointer to the mbuf containing the packet, caller may
343 			packet will not be freed.
345 			the packet will be freed.
347 typedef errno_t (*ifnet_framer_func)(ifnet_t interface, mbuf_t *packet,
415 	@param ifp The interface the packet was received on.
416 	@param protocol_family The protocol of the packet received.
417 	@param packet The packet being input.
420 		If the result is zero, the caller will assume the packet was
423 			free the packet.
426     mbuf_t packet, char *header);
435 		individual packet. The frame header can be retrieved using
437 	@param ifp The interface the packet was received on.
438 	@param protocol_family The protocol of the packet received.
439 	@param packet The packet being input.
447     mbuf_t packet);
451 	@discussion proto_media_preout is called just before the packet
455 	@param ifp The interface the packet will be sent on.
456 	@param protocol_family The protocol of the packet being sent
458 	@param packet The packet being sent.
460 	@param route A pointer to the routing structure for the packet.
466 		non-zero and not EJUSTRETURN, the packet will be freed by the
470     mbuf_t *packet, const struct sockaddr *dest, void *route, char *frame_type,
537 		an ARP packet. This field is currently only used with IP. This
539 		packet using the information passed in.
540 	@param ifp The interface the arp packet should be sent on.
551 		If this is NULL, the target hardware address in the ARP packet
604 	@field output The output function for the interface. Every packet the
608 		incoming packet.
662 	@discussion ifnet_pre_enqueue_func is called for each outgoing packet
664 		on the (fully formed) packet, but it is responsible for calling
665 		ifnet_enqueue() to enqueue the packet upon completion.
667 	@param data The packet to be sent.
696 	@param first_packet Pointer to the first packet being dequeued.
697 	@param last_packet Pointer to the last packet being dequeued.
798 	@field output The output function for the interface. Every packet the
825 		incoming packet.
924 		ETHER_DESC_SNAP. The type defines the offset in the packet where
927 		only in the 5 bytes will only be matched when the packet header
928 		indicates that the packet is a SNAP packet.
932 		packet.
1041 	@discussion Enqueue a packet to the output queue of an interface
1043 	@param interface The interface to enqueue the packet to.
1044 	@param packet The packet being enqueued; only one packet is allowed
1050 		or consumes the packet; the caller must not modify or free
1052 		than one packet will cause the entire packet chain to be freed.
1054 extern errno_t ifnet_enqueue(ifnet_t interface, mbuf_t packet);
1058 	@discussion Dequeue a packet from the output queue of an interface
1061 	@param interface The interface to dequeue the packet from.
1062 	@param packet Pointer to the packet being dequeued.
1066 		or EAGAIN if there is currently no packet available to
1069 extern errno_t ifnet_dequeue(ifnet_t interface, mbuf_t *packet);
1073 	@discussion Dequeue a packet of a particular service class from the
1077 	@param interface The interface to dequeue the packet from.
1079 	@param packet Pointer to the packet being dequeued.
1084 		is currently no packet available to be dequeued.
1087     mbuf_svc_class_t tc, mbuf_t *packet);
1094 		The returned packet chain is traversable with mbuf_nextpkt().
1096 	@param first_packet Pointer to the first packet being dequeued.
1097 	@param last_packet Pointer to the last packet being dequeued.  Caller
1107 		or EAGAIN if there is currently no packet available to
1119 		The returned packet chain is traversable with mbuf_nextpkt().
1122 	@param first_packet Pointer to the first packet being dequeued.
1123 	@param last_packet Pointer to the last packet being dequeued.  Caller
1134 		is currently no packet available to be dequeued.
1238 	@param mbuf_t The first packet in a burst of packets that has been
1254 	@param mbuf_t The last packet in the burst that has been successfully
1498 		based on the last time the system transmitted a packet to the
1499 		node.  A zero value indicates that a packet has not been sent
1506 		calculated based on the last time the system received a packet
1507 		from the node.  A zero value indicates that a packet has not
1784 	    for packet chains which improve performance.
1808 	@discussion Handles an outbound packet on the interface by calling
1818 		packet (i.e. AF_INET).
1819 	@param packet The packet to be transmitted.
1820 	@param route A pointer to a routing structure for this packet. The
1829     protocol_family_t protocol_family, mbuf_t packet, void *route,
1834 	@discussion Handles and outbond raw packet on the interface by
1836 		protocol_family may be zero. If the packet is from a specific
1839 		packet. Processing, such as calling the protocol preoutput and
1840 		interface framer functions will be bypassed. The packet will
1842 		ifnet_output_raw will always free the packet chain.
1845 		packet (i.e. AF_INET).
1846 	@param packet The fully formed packet to be transmitted.
1850     protocol_family_t protocol_family, mbuf_t packet);
1857 		called. From there, the packet will be passed to the registered
1860 	@param first_packet The first packet in a chain of packets.
1875 		called. From there, the packet will be passed to the registered
1878 	@param first_packet The first packet in a chain of packets.
1879 	@param last_packet The last packet in a chain of packets.  This may be