audio: deprecate -soundhw sb16
[qemu/ar7.git] / hw / net / net_rx_pkt.h
blob048e3461f004fb0c1cbe9df8551ad36b6febaff6
1 /*
2 * QEMU RX packets abstraction
4 * Copyright (c) 2012 Ravello Systems LTD (http://ravellosystems.com)
6 * Developed by Daynix Computing LTD (http://www.daynix.com)
8 * Authors:
9 * Dmitry Fleytman <dmitry@daynix.com>
10 * Tamir Shomer <tamirs@daynix.com>
11 * Yan Vugenfirer <yan@daynix.com>
13 * This work is licensed under the terms of the GNU GPL, version 2 or later.
14 * See the COPYING file in the top-level directory.
18 #ifndef NET_RX_PKT_H
19 #define NET_RX_PKT_H
21 #include "net/eth.h"
23 /* defines to enable packet dump functions */
24 /*#define NET_RX_PKT_DEBUG*/
26 struct NetRxPkt;
28 /**
29 * Clean all rx packet resources
31 * @pkt: packet
34 void net_rx_pkt_uninit(struct NetRxPkt *pkt);
36 /**
37 * Init function for rx packet functionality
39 * @pkt: packet pointer
40 * @has_virt_hdr: device uses virtio header
43 void net_rx_pkt_init(struct NetRxPkt **pkt, bool has_virt_hdr);
45 /**
46 * returns total length of data attached to rx context
48 * @pkt: packet
50 * Return: nothing
53 size_t net_rx_pkt_get_total_len(struct NetRxPkt *pkt);
55 /**
56 * parse and set packet analysis results
58 * @pkt: packet
59 * @data: pointer to the data buffer to be parsed
60 * @len: data length
63 void net_rx_pkt_set_protocols(struct NetRxPkt *pkt, const void *data,
64 size_t len);
66 /**
67 * fetches packet analysis results
69 * @pkt: packet
70 * @isip4: whether the packet given is IPv4
71 * @isip6: whether the packet given is IPv6
72 * @isudp: whether the packet given is UDP
73 * @istcp: whether the packet given is TCP
76 void net_rx_pkt_get_protocols(struct NetRxPkt *pkt,
77 bool *isip4, bool *isip6,
78 bool *isudp, bool *istcp);
80 /**
81 * fetches L3 header offset
83 * @pkt: packet
86 size_t net_rx_pkt_get_l3_hdr_offset(struct NetRxPkt *pkt);
88 /**
89 * fetches L4 header offset
91 * @pkt: packet
94 size_t net_rx_pkt_get_l4_hdr_offset(struct NetRxPkt *pkt);
96 /**
97 * fetches L5 header offset
99 * @pkt: packet
102 size_t net_rx_pkt_get_l5_hdr_offset(struct NetRxPkt *pkt);
105 * fetches IP6 header analysis results
107 * Return: pointer to analysis results structure which is stored in internal
108 * packet area.
111 eth_ip6_hdr_info *net_rx_pkt_get_ip6_info(struct NetRxPkt *pkt);
114 * fetches IP4 header analysis results
116 * Return: pointer to analysis results structure which is stored in internal
117 * packet area.
120 eth_ip4_hdr_info *net_rx_pkt_get_ip4_info(struct NetRxPkt *pkt);
123 * fetches L4 header analysis results
125 * Return: pointer to analysis results structure which is stored in internal
126 * packet area.
129 eth_l4_hdr_info *net_rx_pkt_get_l4_info(struct NetRxPkt *pkt);
131 typedef enum {
132 NetPktRssIpV4,
133 NetPktRssIpV4Tcp,
134 NetPktRssIpV6Tcp,
135 NetPktRssIpV6,
136 NetPktRssIpV6Ex,
137 NetPktRssIpV6TcpEx,
138 NetPktRssIpV4Udp,
139 NetPktRssIpV6Udp,
140 NetPktRssIpV6UdpEx,
141 } NetRxPktRssType;
144 * calculates RSS hash for packet
146 * @pkt: packet
147 * @type: RSS hash type
149 * Return: Toeplitz RSS hash.
152 uint32_t
153 net_rx_pkt_calc_rss_hash(struct NetRxPkt *pkt,
154 NetRxPktRssType type,
155 uint8_t *key);
158 * fetches IP identification for the packet
160 * @pkt: packet
163 uint16_t net_rx_pkt_get_ip_id(struct NetRxPkt *pkt);
166 * check if given packet is a TCP ACK packet
168 * @pkt: packet
171 bool net_rx_pkt_is_tcp_ack(struct NetRxPkt *pkt);
174 * check if given packet contains TCP data
176 * @pkt: packet
179 bool net_rx_pkt_has_tcp_data(struct NetRxPkt *pkt);
182 * returns virtio header stored in rx context
184 * @pkt: packet
185 * @ret: virtio header
188 struct virtio_net_hdr *net_rx_pkt_get_vhdr(struct NetRxPkt *pkt);
191 * returns packet type
193 * @pkt: packet
194 * @ret: packet type
197 eth_pkt_types_e net_rx_pkt_get_packet_type(struct NetRxPkt *pkt);
200 * returns vlan tag
202 * @pkt: packet
203 * @ret: VLAN tag
206 uint16_t net_rx_pkt_get_vlan_tag(struct NetRxPkt *pkt);
209 * tells whether vlan was stripped from the packet
211 * @pkt: packet
212 * @ret: VLAN stripped sign
215 bool net_rx_pkt_is_vlan_stripped(struct NetRxPkt *pkt);
218 * notifies caller if the packet has virtio header
220 * @pkt: packet
221 * @ret: true if packet has virtio header, false otherwize
224 bool net_rx_pkt_has_virt_hdr(struct NetRxPkt *pkt);
227 * attach scatter-gather data to rx packet
229 * @pkt: packet
230 * @iov: received data scatter-gather list
231 * @iovcnt number of elements in iov
232 * @iovoff data start offset in the iov
233 * @strip_vlan: should the module strip vlan from data
236 void net_rx_pkt_attach_iovec(struct NetRxPkt *pkt,
237 const struct iovec *iov,
238 int iovcnt, size_t iovoff,
239 bool strip_vlan);
242 * attach scatter-gather data to rx packet
244 * @pkt: packet
245 * @iov: received data scatter-gather list
246 * @iovcnt number of elements in iov
247 * @iovoff data start offset in the iov
248 * @strip_vlan: should the module strip vlan from data
249 * @vet: VLAN tag Ethernet type
252 void net_rx_pkt_attach_iovec_ex(struct NetRxPkt *pkt,
253 const struct iovec *iov, int iovcnt,
254 size_t iovoff, bool strip_vlan,
255 uint16_t vet);
258 * attach data to rx packet
260 * @pkt: packet
261 * @data: pointer to the data buffer
262 * @len: data length
263 * @strip_vlan: should the module strip vlan from data
266 static inline void
267 net_rx_pkt_attach_data(struct NetRxPkt *pkt, const void *data,
268 size_t len, bool strip_vlan)
270 const struct iovec iov = {
271 .iov_base = (void *) data,
272 .iov_len = len
275 net_rx_pkt_attach_iovec(pkt, &iov, 1, 0, strip_vlan);
279 * returns io vector that holds the attached data
281 * @pkt: packet
282 * @ret: pointer to IOVec
285 struct iovec *net_rx_pkt_get_iovec(struct NetRxPkt *pkt);
288 * returns io vector length that holds the attached data
290 * @pkt: packet
291 * @ret: IOVec length
294 uint16_t net_rx_pkt_get_iovec_len(struct NetRxPkt *pkt);
297 * prints rx packet data if debug is enabled
299 * @pkt: packet
302 void net_rx_pkt_dump(struct NetRxPkt *pkt);
305 * copy passed vhdr data to packet context
307 * @pkt: packet
308 * @vhdr: VHDR buffer
311 void net_rx_pkt_set_vhdr(struct NetRxPkt *pkt,
312 struct virtio_net_hdr *vhdr);
315 * copy passed vhdr data to packet context
317 * @pkt: packet
318 * @iov: VHDR iov
319 * @iovcnt: VHDR iov array size
322 void net_rx_pkt_set_vhdr_iovec(struct NetRxPkt *pkt,
323 const struct iovec *iov, int iovcnt);
326 * save packet type in packet context
328 * @pkt: packet
329 * @packet_type: the packet type
332 void net_rx_pkt_set_packet_type(struct NetRxPkt *pkt,
333 eth_pkt_types_e packet_type);
336 * validate TCP/UDP checksum of the packet
338 * @pkt: packet
339 * @csum_valid: checksum validation result
340 * @ret: true if validation was performed, false in case packet is
341 * not TCP/UDP or checksum validation is not possible
344 bool net_rx_pkt_validate_l4_csum(struct NetRxPkt *pkt, bool *csum_valid);
347 * validate IPv4 checksum of the packet
349 * @pkt: packet
350 * @csum_valid: checksum validation result
351 * @ret: true if validation was performed, false in case packet is
352 * not TCP/UDP or checksum validation is not possible
355 bool net_rx_pkt_validate_l3_csum(struct NetRxPkt *pkt, bool *csum_valid);
358 * fix IPv4 checksum of the packet
360 * @pkt: packet
361 * @ret: true if checksum was fixed, false in case packet is
362 * not TCP/UDP or checksum correction is not possible
365 bool net_rx_pkt_fix_l4_csum(struct NetRxPkt *pkt);
367 #endif