13a9fd824SRoger Pau Monné /******************************************************************************
23a9fd824SRoger Pau Monné * netif.h
33a9fd824SRoger Pau Monné *
43a9fd824SRoger Pau Monné * Unified network-device I/O interface for Xen guest OSes.
53a9fd824SRoger Pau Monné *
63a9fd824SRoger Pau Monné * Permission is hereby granted, free of charge, to any person obtaining a copy
73a9fd824SRoger Pau Monné * of this software and associated documentation files (the "Software"), to
83a9fd824SRoger Pau Monné * deal in the Software without restriction, including without limitation the
93a9fd824SRoger Pau Monné * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
103a9fd824SRoger Pau Monné * sell copies of the Software, and to permit persons to whom the Software is
113a9fd824SRoger Pau Monné * furnished to do so, subject to the following conditions:
123a9fd824SRoger Pau Monné *
133a9fd824SRoger Pau Monné * The above copyright notice and this permission notice shall be included in
143a9fd824SRoger Pau Monné * all copies or substantial portions of the Software.
153a9fd824SRoger Pau Monné *
163a9fd824SRoger Pau Monné * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
173a9fd824SRoger Pau Monné * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
183a9fd824SRoger Pau Monné * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
193a9fd824SRoger Pau Monné * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
203a9fd824SRoger Pau Monné * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
213a9fd824SRoger Pau Monné * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
223a9fd824SRoger Pau Monné * DEALINGS IN THE SOFTWARE.
233a9fd824SRoger Pau Monné *
243a9fd824SRoger Pau Monné * Copyright (c) 2003-2004, Keir Fraser
253a9fd824SRoger Pau Monné */
263a9fd824SRoger Pau Monné
273a9fd824SRoger Pau Monné #ifndef __XEN_PUBLIC_IO_NETIF_H__
283a9fd824SRoger Pau Monné #define __XEN_PUBLIC_IO_NETIF_H__
293a9fd824SRoger Pau Monné
303a9fd824SRoger Pau Monné #include "ring.h"
313a9fd824SRoger Pau Monné #include "../grant_table.h"
323a9fd824SRoger Pau Monné
333a9fd824SRoger Pau Monné /*
343a9fd824SRoger Pau Monné * Older implementation of Xen network frontend / backend has an
353a9fd824SRoger Pau Monné * implicit dependency on the MAX_SKB_FRAGS as the maximum number of
363a9fd824SRoger Pau Monné * ring slots a skb can use. Netfront / netback may not work as
373a9fd824SRoger Pau Monné * expected when frontend and backend have different MAX_SKB_FRAGS.
383a9fd824SRoger Pau Monné *
393a9fd824SRoger Pau Monné * A better approach is to add mechanism for netfront / netback to
403a9fd824SRoger Pau Monné * negotiate this value. However we cannot fix all possible
413a9fd824SRoger Pau Monné * frontends, so we need to define a value which states the minimum
423a9fd824SRoger Pau Monné * slots backend must support.
433a9fd824SRoger Pau Monné *
443a9fd824SRoger Pau Monné * The minimum value derives from older Linux kernel's MAX_SKB_FRAGS
453a9fd824SRoger Pau Monné * (18), which is proved to work with most frontends. Any new backend
463a9fd824SRoger Pau Monné * which doesn't negotiate with frontend should expect frontend to
473a9fd824SRoger Pau Monné * send a valid packet using slots up to this value.
483a9fd824SRoger Pau Monné */
493a9fd824SRoger Pau Monné #define XEN_NETIF_NR_SLOTS_MIN 18
503a9fd824SRoger Pau Monné
513a9fd824SRoger Pau Monné /*
523a9fd824SRoger Pau Monné * Notifications after enqueuing any type of message should be conditional on
533a9fd824SRoger Pau Monné * the appropriate req_event or rsp_event field in the shared ring.
543a9fd824SRoger Pau Monné * If the client sends notification for rx requests then it should specify
553a9fd824SRoger Pau Monné * feature 'feature-rx-notify' via xenbus. Otherwise the backend will assume
563a9fd824SRoger Pau Monné * that it cannot safely queue packets (as it may not be kicked to send them).
573a9fd824SRoger Pau Monné */
583a9fd824SRoger Pau Monné
593a9fd824SRoger Pau Monné /*
603a9fd824SRoger Pau Monné * "feature-split-event-channels" is introduced to separate guest TX
613a9fd824SRoger Pau Monné * and RX notification. Backend either doesn't support this feature or
623a9fd824SRoger Pau Monné * advertises it via xenstore as 0 (disabled) or 1 (enabled).
633a9fd824SRoger Pau Monné *
643a9fd824SRoger Pau Monné * To make use of this feature, frontend should allocate two event
653a9fd824SRoger Pau Monné * channels for TX and RX, advertise them to backend as
663a9fd824SRoger Pau Monné * "event-channel-tx" and "event-channel-rx" respectively. If frontend
673a9fd824SRoger Pau Monné * doesn't want to use this feature, it just writes "event-channel"
683a9fd824SRoger Pau Monné * node as before.
693a9fd824SRoger Pau Monné */
703a9fd824SRoger Pau Monné
713a9fd824SRoger Pau Monné /*
723a9fd824SRoger Pau Monné * Multiple transmit and receive queues:
733a9fd824SRoger Pau Monné * If supported, the backend will write the key "multi-queue-max-queues" to
743a9fd824SRoger Pau Monné * the directory for that vif, and set its value to the maximum supported
753a9fd824SRoger Pau Monné * number of queues.
763a9fd824SRoger Pau Monné * Frontends that are aware of this feature and wish to use it can write the
773a9fd824SRoger Pau Monné * key "multi-queue-num-queues", set to the number they wish to use, which
783a9fd824SRoger Pau Monné * must be greater than zero, and no more than the value reported by the backend
793a9fd824SRoger Pau Monné * in "multi-queue-max-queues".
803a9fd824SRoger Pau Monné *
813a9fd824SRoger Pau Monné * Queues replicate the shared rings and event channels.
823a9fd824SRoger Pau Monné * "feature-split-event-channels" may optionally be used when using
833a9fd824SRoger Pau Monné * multiple queues, but is not mandatory.
843a9fd824SRoger Pau Monné *
853a9fd824SRoger Pau Monné * Each queue consists of one shared ring pair, i.e. there must be the same
863a9fd824SRoger Pau Monné * number of tx and rx rings.
873a9fd824SRoger Pau Monné *
883a9fd824SRoger Pau Monné * For frontends requesting just one queue, the usual event-channel and
893a9fd824SRoger Pau Monné * ring-ref keys are written as before, simplifying the backend processing
903a9fd824SRoger Pau Monné * to avoid distinguishing between a frontend that doesn't understand the
913a9fd824SRoger Pau Monné * multi-queue feature, and one that does, but requested only one queue.
923a9fd824SRoger Pau Monné *
933a9fd824SRoger Pau Monné * Frontends requesting two or more queues must not write the toplevel
943a9fd824SRoger Pau Monné * event-channel (or event-channel-{tx,rx}) and {tx,rx}-ring-ref keys,
953a9fd824SRoger Pau Monné * instead writing those keys under sub-keys having the name "queue-N" where
963a9fd824SRoger Pau Monné * N is the integer ID of the queue for which those keys belong. Queues
973a9fd824SRoger Pau Monné * are indexed from zero. For example, a frontend with two queues and split
983a9fd824SRoger Pau Monné * event channels must write the following set of queue-related keys:
993a9fd824SRoger Pau Monné *
1003a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/multi-queue-num-queues = "2"
1013a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-0 = ""
1023a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-0/tx-ring-ref = "<ring-ref-tx0>"
1033a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-0/rx-ring-ref = "<ring-ref-rx0>"
1043a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-0/event-channel-tx = "<evtchn-tx0>"
1053a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-0/event-channel-rx = "<evtchn-rx0>"
1063a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-1 = ""
1073a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-1/tx-ring-ref = "<ring-ref-tx1>"
1083a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-1/rx-ring-ref = "<ring-ref-rx1"
1093a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-1/event-channel-tx = "<evtchn-tx1>"
1103a9fd824SRoger Pau Monné * /local/domain/1/device/vif/0/queue-1/event-channel-rx = "<evtchn-rx1>"
1113a9fd824SRoger Pau Monné *
1123a9fd824SRoger Pau Monné * If there is any inconsistency in the XenStore data, the backend may
1133a9fd824SRoger Pau Monné * choose not to connect any queues, instead treating the request as an
1143a9fd824SRoger Pau Monné * error. This includes scenarios where more (or fewer) queues were
1153a9fd824SRoger Pau Monné * requested than the frontend provided details for.
1163a9fd824SRoger Pau Monné *
1173a9fd824SRoger Pau Monné * Mapping of packets to queues is considered to be a function of the
1183a9fd824SRoger Pau Monné * transmitting system (backend or frontend) and is not negotiated
1193a9fd824SRoger Pau Monné * between the two. Guests are free to transmit packets on any queue
1203a9fd824SRoger Pau Monné * they choose, provided it has been set up correctly. Guests must be
1213a9fd824SRoger Pau Monné * prepared to receive packets on any queue they have requested be set up.
1223a9fd824SRoger Pau Monné */
1233a9fd824SRoger Pau Monné
1243a9fd824SRoger Pau Monné /*
1253a9fd824SRoger Pau Monné * "feature-no-csum-offload" should be used to turn IPv4 TCP/UDP checksum
1263a9fd824SRoger Pau Monné * offload off or on. If it is missing then the feature is assumed to be on.
1273a9fd824SRoger Pau Monné * "feature-ipv6-csum-offload" should be used to turn IPv6 TCP/UDP checksum
1283a9fd824SRoger Pau Monné * offload on or off. If it is missing then the feature is assumed to be off.
1293a9fd824SRoger Pau Monné */
1303a9fd824SRoger Pau Monné
1313a9fd824SRoger Pau Monné /*
1323a9fd824SRoger Pau Monné * "feature-gso-tcpv4" and "feature-gso-tcpv6" advertise the capability to
1333a9fd824SRoger Pau Monné * handle large TCP packets (in IPv4 or IPv6 form respectively). Neither
1343a9fd824SRoger Pau Monné * frontends nor backends are assumed to be capable unless the flags are
1353a9fd824SRoger Pau Monné * present.
1363a9fd824SRoger Pau Monné */
1373a9fd824SRoger Pau Monné
1383a9fd824SRoger Pau Monné /*
1393a9fd824SRoger Pau Monné * "feature-multicast-control" and "feature-dynamic-multicast-control"
1403a9fd824SRoger Pau Monné * advertise the capability to filter ethernet multicast packets in the
1413a9fd824SRoger Pau Monné * backend. If the frontend wishes to take advantage of this feature then
1423a9fd824SRoger Pau Monné * it may set "request-multicast-control". If the backend only advertises
1433a9fd824SRoger Pau Monné * "feature-multicast-control" then "request-multicast-control" must be set
1443a9fd824SRoger Pau Monné * before the frontend moves into the connected state. The backend will
1453a9fd824SRoger Pau Monné * sample the value on this state transition and any subsequent change in
1463a9fd824SRoger Pau Monné * value will have no effect. However, if the backend also advertises
1473a9fd824SRoger Pau Monné * "feature-dynamic-multicast-control" then "request-multicast-control"
1483a9fd824SRoger Pau Monné * may be set by the frontend at any time. In this case, the backend will
1493a9fd824SRoger Pau Monné * watch the value and re-sample on watch events.
1503a9fd824SRoger Pau Monné *
1513a9fd824SRoger Pau Monné * If the sampled value of "request-multicast-control" is set then the
1523a9fd824SRoger Pau Monné * backend transmit side should no longer flood multicast packets to the
1533a9fd824SRoger Pau Monné * frontend, it should instead drop any multicast packet that does not
1543a9fd824SRoger Pau Monné * match in a filter list.
1553a9fd824SRoger Pau Monné * The list is amended by the frontend by sending dummy transmit requests
1563a9fd824SRoger Pau Monné * containing XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL} extra-info fragments as
1573a9fd824SRoger Pau Monné * specified below.
1583a9fd824SRoger Pau Monné * Note that the filter list may be amended even if the sampled value of
1593a9fd824SRoger Pau Monné * "request-multicast-control" is not set, however the filter should only
1603a9fd824SRoger Pau Monné * be applied if it is set.
1613a9fd824SRoger Pau Monné */
1623a9fd824SRoger Pau Monné
1633a9fd824SRoger Pau Monné /*
1643a9fd824SRoger Pau Monné * Control ring
1653a9fd824SRoger Pau Monné * ============
1663a9fd824SRoger Pau Monné *
1673a9fd824SRoger Pau Monné * Some features, such as hashing (detailed below), require a
1683a9fd824SRoger Pau Monné * significant amount of out-of-band data to be passed from frontend to
1693a9fd824SRoger Pau Monné * backend. Use of xenstore is not suitable for large quantities of data
1703a9fd824SRoger Pau Monné * because of quota limitations and so a dedicated 'control ring' is used.
1713a9fd824SRoger Pau Monné * The ability of the backend to use a control ring is advertised by
1723a9fd824SRoger Pau Monné * setting:
1733a9fd824SRoger Pau Monné *
1743a9fd824SRoger Pau Monné * /local/domain/X/backend/vif/<domid>/<vif>/feature-ctrl-ring = "1"
1753a9fd824SRoger Pau Monné *
1763a9fd824SRoger Pau Monné * The frontend provides a control ring to the backend by setting:
1773a9fd824SRoger Pau Monné *
1783a9fd824SRoger Pau Monné * /local/domain/<domid>/device/vif/<vif>/ctrl-ring-ref = <gref>
1793a9fd824SRoger Pau Monné * /local/domain/<domid>/device/vif/<vif>/event-channel-ctrl = <port>
1803a9fd824SRoger Pau Monné *
1813a9fd824SRoger Pau Monné * where <gref> is the grant reference of the shared page used to
1823a9fd824SRoger Pau Monné * implement the control ring and <port> is an event channel to be used
1833a9fd824SRoger Pau Monné * as a mailbox interrupt. These keys must be set before the frontend
1843a9fd824SRoger Pau Monné * moves into the connected state.
1853a9fd824SRoger Pau Monné *
1863a9fd824SRoger Pau Monné * The control ring uses a fixed request/response message size and is
1873a9fd824SRoger Pau Monné * balanced (i.e. one request to one response), so operationally it is much
1883a9fd824SRoger Pau Monné * the same as a transmit or receive ring.
1893a9fd824SRoger Pau Monné * Note that there is no requirement that responses are issued in the same
1903a9fd824SRoger Pau Monné * order as requests.
1913a9fd824SRoger Pau Monné */
1923a9fd824SRoger Pau Monné
1933a9fd824SRoger Pau Monné /*
1943a9fd824SRoger Pau Monné * Link state
1953a9fd824SRoger Pau Monné * ==========
1963a9fd824SRoger Pau Monné *
1973a9fd824SRoger Pau Monné * The backend can advertise its current link (carrier) state to the
1983a9fd824SRoger Pau Monné * frontend using the /local/domain/X/backend/vif/<domid>/<vif>/carrier
1993a9fd824SRoger Pau Monné * node. If this node is not present, then the frontend should assume that
2003a9fd824SRoger Pau Monné * the link is up (for compatibility with backends that do not implement
2013a9fd824SRoger Pau Monné * this feature). If this node is present, then a value of "0" should be
2023a9fd824SRoger Pau Monné * interpreted by the frontend as the link being down (no carrier) and a
2033a9fd824SRoger Pau Monné * value of "1" should be interpreted as the link being up (carrier
2043a9fd824SRoger Pau Monné * present).
2053a9fd824SRoger Pau Monné */
2063a9fd824SRoger Pau Monné
2073a9fd824SRoger Pau Monné /*
2083a9fd824SRoger Pau Monné * MTU
2093a9fd824SRoger Pau Monné * ===
2103a9fd824SRoger Pau Monné *
2113a9fd824SRoger Pau Monné * The toolstack may set a value of MTU for the frontend by setting the
2123a9fd824SRoger Pau Monné * /local/domain/<domid>/device/vif/<vif>/mtu node with the MTU value in
2133a9fd824SRoger Pau Monné * octets. If this node is absent the frontend should assume an MTU value
2143a9fd824SRoger Pau Monné * of 1500 octets. A frontend is also at liberty to ignore this value so
2153a9fd824SRoger Pau Monné * it is only suitable for informing the frontend that a packet payload
2163a9fd824SRoger Pau Monné * >1500 octets is permitted.
2173a9fd824SRoger Pau Monné */
2183a9fd824SRoger Pau Monné
2193a9fd824SRoger Pau Monné /*
2203a9fd824SRoger Pau Monné * Hash types
2213a9fd824SRoger Pau Monné * ==========
2223a9fd824SRoger Pau Monné *
2233a9fd824SRoger Pau Monné * For the purposes of the definitions below, 'Packet[]' is an array of
2243a9fd824SRoger Pau Monné * octets containing an IP packet without options, 'Array[X..Y]' means a
2253a9fd824SRoger Pau Monné * sub-array of 'Array' containing bytes X thru Y inclusive, and '+' is
2263a9fd824SRoger Pau Monné * used to indicate concatenation of arrays.
2273a9fd824SRoger Pau Monné */
2283a9fd824SRoger Pau Monné
2293a9fd824SRoger Pau Monné /*
2303a9fd824SRoger Pau Monné * A hash calculated over an IP version 4 header as follows:
2313a9fd824SRoger Pau Monné *
2323a9fd824SRoger Pau Monné * Buffer[0..8] = Packet[12..15] (source address) +
2333a9fd824SRoger Pau Monné * Packet[16..19] (destination address)
2343a9fd824SRoger Pau Monné *
2353a9fd824SRoger Pau Monné * Result = Hash(Buffer, 8)
2363a9fd824SRoger Pau Monné */
2373a9fd824SRoger Pau Monné #define _XEN_NETIF_CTRL_HASH_TYPE_IPV4 0
2383a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_TYPE_IPV4 \
2393a9fd824SRoger Pau Monné (1 << _XEN_NETIF_CTRL_HASH_TYPE_IPV4)
2403a9fd824SRoger Pau Monné
2413a9fd824SRoger Pau Monné /*
2423a9fd824SRoger Pau Monné * A hash calculated over an IP version 4 header and TCP header as
2433a9fd824SRoger Pau Monné * follows:
2443a9fd824SRoger Pau Monné *
2453a9fd824SRoger Pau Monné * Buffer[0..12] = Packet[12..15] (source address) +
2463a9fd824SRoger Pau Monné * Packet[16..19] (destination address) +
2473a9fd824SRoger Pau Monné * Packet[20..21] (source port) +
2483a9fd824SRoger Pau Monné * Packet[22..23] (destination port)
2493a9fd824SRoger Pau Monné *
2503a9fd824SRoger Pau Monné * Result = Hash(Buffer, 12)
2513a9fd824SRoger Pau Monné */
2523a9fd824SRoger Pau Monné #define _XEN_NETIF_CTRL_HASH_TYPE_IPV4_TCP 1
2533a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_TYPE_IPV4_TCP \
2543a9fd824SRoger Pau Monné (1 << _XEN_NETIF_CTRL_HASH_TYPE_IPV4_TCP)
2553a9fd824SRoger Pau Monné
2563a9fd824SRoger Pau Monné /*
2573a9fd824SRoger Pau Monné * A hash calculated over an IP version 6 header as follows:
2583a9fd824SRoger Pau Monné *
2593a9fd824SRoger Pau Monné * Buffer[0..32] = Packet[8..23] (source address ) +
2603a9fd824SRoger Pau Monné * Packet[24..39] (destination address)
2613a9fd824SRoger Pau Monné *
2623a9fd824SRoger Pau Monné * Result = Hash(Buffer, 32)
2633a9fd824SRoger Pau Monné */
2643a9fd824SRoger Pau Monné #define _XEN_NETIF_CTRL_HASH_TYPE_IPV6 2
2653a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_TYPE_IPV6 \
2663a9fd824SRoger Pau Monné (1 << _XEN_NETIF_CTRL_HASH_TYPE_IPV6)
2673a9fd824SRoger Pau Monné
2683a9fd824SRoger Pau Monné /*
2693a9fd824SRoger Pau Monné * A hash calculated over an IP version 6 header and TCP header as
2703a9fd824SRoger Pau Monné * follows:
2713a9fd824SRoger Pau Monné *
2723a9fd824SRoger Pau Monné * Buffer[0..36] = Packet[8..23] (source address) +
2733a9fd824SRoger Pau Monné * Packet[24..39] (destination address) +
2743a9fd824SRoger Pau Monné * Packet[40..41] (source port) +
2753a9fd824SRoger Pau Monné * Packet[42..43] (destination port)
2763a9fd824SRoger Pau Monné *
2773a9fd824SRoger Pau Monné * Result = Hash(Buffer, 36)
2783a9fd824SRoger Pau Monné */
2793a9fd824SRoger Pau Monné #define _XEN_NETIF_CTRL_HASH_TYPE_IPV6_TCP 3
2803a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_TYPE_IPV6_TCP \
2813a9fd824SRoger Pau Monné (1 << _XEN_NETIF_CTRL_HASH_TYPE_IPV6_TCP)
2823a9fd824SRoger Pau Monné
2833a9fd824SRoger Pau Monné /*
2843a9fd824SRoger Pau Monné * Hash algorithms
2853a9fd824SRoger Pau Monné * ===============
2863a9fd824SRoger Pau Monné */
2873a9fd824SRoger Pau Monné
2883a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_ALGORITHM_NONE 0
2893a9fd824SRoger Pau Monné
2903a9fd824SRoger Pau Monné /*
2913a9fd824SRoger Pau Monné * Toeplitz hash:
2923a9fd824SRoger Pau Monné */
2933a9fd824SRoger Pau Monné
2943a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_HASH_ALGORITHM_TOEPLITZ 1
2953a9fd824SRoger Pau Monné
2963a9fd824SRoger Pau Monné /*
2973a9fd824SRoger Pau Monné * This algorithm uses a 'key' as well as the data buffer itself.
2983a9fd824SRoger Pau Monné * (Buffer[] and Key[] are treated as shift-registers where the MSB of
2993a9fd824SRoger Pau Monné * Buffer/Key[0] is considered 'left-most' and the LSB of Buffer/Key[N-1]
3003a9fd824SRoger Pau Monné * is the 'right-most').
3013a9fd824SRoger Pau Monné *
3023a9fd824SRoger Pau Monné * Value = 0
3033a9fd824SRoger Pau Monné * For number of bits in Buffer[]
3043a9fd824SRoger Pau Monné * If (left-most bit of Buffer[] is 1)
3053a9fd824SRoger Pau Monné * Value ^= left-most 32 bits of Key[]
3063a9fd824SRoger Pau Monné * Key[] << 1
3073a9fd824SRoger Pau Monné * Buffer[] << 1
3083a9fd824SRoger Pau Monné *
3093a9fd824SRoger Pau Monné * The code below is provided for convenience where an operating system
3103a9fd824SRoger Pau Monné * does not already provide an implementation.
3113a9fd824SRoger Pau Monné */
3123a9fd824SRoger Pau Monné #ifdef XEN_NETIF_DEFINE_TOEPLITZ
xen_netif_toeplitz_hash(const uint8_t * key,unsigned int keylen,const uint8_t * buf,unsigned int buflen)3133a9fd824SRoger Pau Monné static uint32_t xen_netif_toeplitz_hash(const uint8_t *key,
3143a9fd824SRoger Pau Monné unsigned int keylen,
3153a9fd824SRoger Pau Monné const uint8_t *buf,
3163a9fd824SRoger Pau Monné unsigned int buflen)
3173a9fd824SRoger Pau Monné {
3183a9fd824SRoger Pau Monné unsigned int keyi, bufi;
3193a9fd824SRoger Pau Monné uint64_t prefix = 0;
3203a9fd824SRoger Pau Monné uint64_t hash = 0;
3213a9fd824SRoger Pau Monné
3223a9fd824SRoger Pau Monné /* Pre-load prefix with the first 8 bytes of the key */
3233a9fd824SRoger Pau Monné for (keyi = 0; keyi < 8; keyi++) {
3243a9fd824SRoger Pau Monné prefix <<= 8;
3253a9fd824SRoger Pau Monné prefix |= (keyi < keylen) ? key[keyi] : 0;
3263a9fd824SRoger Pau Monné }
3273a9fd824SRoger Pau Monné
3283a9fd824SRoger Pau Monné for (bufi = 0; bufi < buflen; bufi++) {
3293a9fd824SRoger Pau Monné uint8_t byte = buf[bufi];
3303a9fd824SRoger Pau Monné unsigned int bit;
3313a9fd824SRoger Pau Monné
3323a9fd824SRoger Pau Monné for (bit = 0; bit < 8; bit++) {
3333a9fd824SRoger Pau Monné if (byte & 0x80)
3343a9fd824SRoger Pau Monné hash ^= prefix;
3353a9fd824SRoger Pau Monné prefix <<= 1;
3363a9fd824SRoger Pau Monné byte <<=1;
3373a9fd824SRoger Pau Monné }
3383a9fd824SRoger Pau Monné
3393a9fd824SRoger Pau Monné /*
3403a9fd824SRoger Pau Monné * 'prefix' has now been left-shifted by 8, so
3413a9fd824SRoger Pau Monné * OR in the next byte.
3423a9fd824SRoger Pau Monné */
3433a9fd824SRoger Pau Monné prefix |= (keyi < keylen) ? key[keyi] : 0;
3443a9fd824SRoger Pau Monné keyi++;
3453a9fd824SRoger Pau Monné }
3463a9fd824SRoger Pau Monné
3473a9fd824SRoger Pau Monné /* The valid part of the hash is in the upper 32 bits. */
3483a9fd824SRoger Pau Monné return hash >> 32;
3493a9fd824SRoger Pau Monné }
3503a9fd824SRoger Pau Monné #endif /* XEN_NETIF_DEFINE_TOEPLITZ */
3513a9fd824SRoger Pau Monné
3523a9fd824SRoger Pau Monné /*
3533a9fd824SRoger Pau Monné * Control requests (struct xen_netif_ctrl_request)
3543a9fd824SRoger Pau Monné * ================================================
3553a9fd824SRoger Pau Monné *
3563a9fd824SRoger Pau Monné * All requests have the following format:
3573a9fd824SRoger Pau Monné *
3583a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
3593a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
3603a9fd824SRoger Pau Monné * | id | type | data[0] |
3613a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
3623a9fd824SRoger Pau Monné * | data[1] | data[2] |
3633a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----------------------+
3643a9fd824SRoger Pau Monné *
3653a9fd824SRoger Pau Monné * id: the request identifier, echoed in response.
3663a9fd824SRoger Pau Monné * type: the type of request (see below)
3673a9fd824SRoger Pau Monné * data[]: any data associated with the request (determined by type)
3683a9fd824SRoger Pau Monné */
3693a9fd824SRoger Pau Monné
3703a9fd824SRoger Pau Monné struct xen_netif_ctrl_request {
3713a9fd824SRoger Pau Monné uint16_t id;
3723a9fd824SRoger Pau Monné uint16_t type;
3733a9fd824SRoger Pau Monné
3743a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_INVALID 0
3753a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_GET_HASH_FLAGS 1
3763a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_SET_HASH_FLAGS 2
3773a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_SET_HASH_KEY 3
3783a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_GET_HASH_MAPPING_SIZE 4
3793a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING_SIZE 5
3803a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING 6
3813a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_SET_HASH_ALGORITHM 7
3823a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_GET_GREF_MAPPING_SIZE 8
3833a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_ADD_GREF_MAPPING 9
3843a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_TYPE_DEL_GREF_MAPPING 10
3853a9fd824SRoger Pau Monné
3863a9fd824SRoger Pau Monné uint32_t data[3];
3873a9fd824SRoger Pau Monné };
3883a9fd824SRoger Pau Monné
3893a9fd824SRoger Pau Monné /*
3903a9fd824SRoger Pau Monné * Control responses (struct xen_netif_ctrl_response)
3913a9fd824SRoger Pau Monné * ==================================================
3923a9fd824SRoger Pau Monné *
3933a9fd824SRoger Pau Monné * All responses have the following format:
3943a9fd824SRoger Pau Monné *
3953a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
3963a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
3973a9fd824SRoger Pau Monné * | id | type | status |
3983a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
3993a9fd824SRoger Pau Monné * | data |
4003a9fd824SRoger Pau Monné * +-----+-----+-----+-----+
4013a9fd824SRoger Pau Monné *
4023a9fd824SRoger Pau Monné * id: the corresponding request identifier
4033a9fd824SRoger Pau Monné * type: the type of the corresponding request
4043a9fd824SRoger Pau Monné * status: the status of request processing
4053a9fd824SRoger Pau Monné * data: any data associated with the response (determined by type and
4063a9fd824SRoger Pau Monné * status)
4073a9fd824SRoger Pau Monné */
4083a9fd824SRoger Pau Monné
4093a9fd824SRoger Pau Monné struct xen_netif_ctrl_response {
4103a9fd824SRoger Pau Monné uint16_t id;
4113a9fd824SRoger Pau Monné uint16_t type;
4123a9fd824SRoger Pau Monné uint32_t status;
4133a9fd824SRoger Pau Monné
4143a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_STATUS_SUCCESS 0
4153a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED 1
4163a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER 2
4173a9fd824SRoger Pau Monné #define XEN_NETIF_CTRL_STATUS_BUFFER_OVERFLOW 3
4183a9fd824SRoger Pau Monné
4193a9fd824SRoger Pau Monné uint32_t data;
4203a9fd824SRoger Pau Monné };
4213a9fd824SRoger Pau Monné
4223a9fd824SRoger Pau Monné /*
4233a9fd824SRoger Pau Monné * Static Grants (struct xen_netif_gref)
4243a9fd824SRoger Pau Monné * =====================================
4253a9fd824SRoger Pau Monné *
4263a9fd824SRoger Pau Monné * A frontend may provide a fixed set of grant references to be mapped on
4273a9fd824SRoger Pau Monné * the backend. The message of type XEN_NETIF_CTRL_TYPE_ADD_GREF_MAPPING
4283a9fd824SRoger Pau Monné * prior its usage in the command ring allows for creation of these mappings.
4293a9fd824SRoger Pau Monné * The backend will maintain a fixed amount of these mappings.
4303a9fd824SRoger Pau Monné *
4313a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_GET_GREF_MAPPING_SIZE lets a frontend query how many
4323a9fd824SRoger Pau Monné * of these mappings can be kept.
4333a9fd824SRoger Pau Monné *
4343a9fd824SRoger Pau Monné * Each entry in the XEN_NETIF_CTRL_TYPE_{ADD,DEL}_GREF_MAPPING input table has
4353a9fd824SRoger Pau Monné * the following format:
4363a9fd824SRoger Pau Monné *
4373a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
4383a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
4393a9fd824SRoger Pau Monné * | grant ref | flags | status |
4403a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
4413a9fd824SRoger Pau Monné *
4423a9fd824SRoger Pau Monné * grant ref: grant reference (IN)
4433a9fd824SRoger Pau Monné * flags: flags describing the control operation (IN)
4443a9fd824SRoger Pau Monné * status: XEN_NETIF_CTRL_STATUS_* (OUT)
4453a9fd824SRoger Pau Monné *
4463a9fd824SRoger Pau Monné * 'status' is an output parameter which does not require to be set to zero
4473a9fd824SRoger Pau Monné * prior to its usage in the corresponding control messages.
4483a9fd824SRoger Pau Monné */
4493a9fd824SRoger Pau Monné
4503a9fd824SRoger Pau Monné struct xen_netif_gref {
4513a9fd824SRoger Pau Monné grant_ref_t ref;
4523a9fd824SRoger Pau Monné uint16_t flags;
4533a9fd824SRoger Pau Monné
4543a9fd824SRoger Pau Monné #define _XEN_NETIF_CTRLF_GREF_readonly 0
4553a9fd824SRoger Pau Monné #define XEN_NETIF_CTRLF_GREF_readonly (1U<<_XEN_NETIF_CTRLF_GREF_readonly)
4563a9fd824SRoger Pau Monné
4573a9fd824SRoger Pau Monné uint16_t status;
4583a9fd824SRoger Pau Monné };
4593a9fd824SRoger Pau Monné
4603a9fd824SRoger Pau Monné /*
4613a9fd824SRoger Pau Monné * Control messages
4623a9fd824SRoger Pau Monné * ================
4633a9fd824SRoger Pau Monné *
4643a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_SET_HASH_ALGORITHM
4653a9fd824SRoger Pau Monné * --------------------------------------
4663a9fd824SRoger Pau Monné *
4673a9fd824SRoger Pau Monné * This is sent by the frontend to set the desired hash algorithm.
4683a9fd824SRoger Pau Monné *
4693a9fd824SRoger Pau Monné * Request:
4703a9fd824SRoger Pau Monné *
4713a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_SET_HASH_ALGORITHM
4723a9fd824SRoger Pau Monné * data[0] = a XEN_NETIF_CTRL_HASH_ALGORITHM_* value
4733a9fd824SRoger Pau Monné * data[1] = 0
4743a9fd824SRoger Pau Monné * data[2] = 0
4753a9fd824SRoger Pau Monné *
4763a9fd824SRoger Pau Monné * Response:
4773a9fd824SRoger Pau Monné *
4783a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
4793a9fd824SRoger Pau Monné * supported
4803a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - The algorithm is not
4813a9fd824SRoger Pau Monné * supported
4823a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
4833a9fd824SRoger Pau Monné *
4843a9fd824SRoger Pau Monné * NOTE: Setting data[0] to XEN_NETIF_CTRL_HASH_ALGORITHM_NONE disables
4853a9fd824SRoger Pau Monné * hashing and the backend is free to choose how it steers packets
4863a9fd824SRoger Pau Monné * to queues (which is the default behaviour).
4873a9fd824SRoger Pau Monné *
4883a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_GET_HASH_FLAGS
4893a9fd824SRoger Pau Monné * ----------------------------------
4903a9fd824SRoger Pau Monné *
4913a9fd824SRoger Pau Monné * This is sent by the frontend to query the types of hash supported by
4923a9fd824SRoger Pau Monné * the backend.
4933a9fd824SRoger Pau Monné *
4943a9fd824SRoger Pau Monné * Request:
4953a9fd824SRoger Pau Monné *
4963a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_GET_HASH_FLAGS
4973a9fd824SRoger Pau Monné * data[0] = 0
4983a9fd824SRoger Pau Monné * data[1] = 0
4993a9fd824SRoger Pau Monné * data[2] = 0
5003a9fd824SRoger Pau Monné *
5013a9fd824SRoger Pau Monné * Response:
5023a9fd824SRoger Pau Monné *
5033a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not supported
5043a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
5053a9fd824SRoger Pau Monné * data = supported hash types (if operation was successful)
5063a9fd824SRoger Pau Monné *
5073a9fd824SRoger Pau Monné * NOTE: A valid hash algorithm must be selected before this operation can
5083a9fd824SRoger Pau Monné * succeed.
5093a9fd824SRoger Pau Monné *
5103a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_SET_HASH_FLAGS
5113a9fd824SRoger Pau Monné * ----------------------------------
5123a9fd824SRoger Pau Monné *
5133a9fd824SRoger Pau Monné * This is sent by the frontend to set the types of hash that the backend
5143a9fd824SRoger Pau Monné * should calculate. (See above for hash type definitions).
5153a9fd824SRoger Pau Monné * Note that the 'maximal' type of hash should always be chosen. For
5163a9fd824SRoger Pau Monné * example, if the frontend sets both IPV4 and IPV4_TCP hash types then
5173a9fd824SRoger Pau Monné * the latter hash type should be calculated for any TCP packet and the
5183a9fd824SRoger Pau Monné * former only calculated for non-TCP packets.
5193a9fd824SRoger Pau Monné *
5203a9fd824SRoger Pau Monné * Request:
5213a9fd824SRoger Pau Monné *
5223a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_SET_HASH_FLAGS
5233a9fd824SRoger Pau Monné * data[0] = bitwise OR of XEN_NETIF_CTRL_HASH_TYPE_* values
5243a9fd824SRoger Pau Monné * data[1] = 0
5253a9fd824SRoger Pau Monné * data[2] = 0
5263a9fd824SRoger Pau Monné *
5273a9fd824SRoger Pau Monné * Response:
5283a9fd824SRoger Pau Monné *
5293a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
5303a9fd824SRoger Pau Monné * supported
5313a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - One or more flag
5323a9fd824SRoger Pau Monné * value is invalid or
5333a9fd824SRoger Pau Monné * unsupported
5343a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
5353a9fd824SRoger Pau Monné * data = 0
5363a9fd824SRoger Pau Monné *
5373a9fd824SRoger Pau Monné * NOTE: A valid hash algorithm must be selected before this operation can
5383a9fd824SRoger Pau Monné * succeed.
5393a9fd824SRoger Pau Monné * Also, setting data[0] to zero disables hashing and the backend
5403a9fd824SRoger Pau Monné * is free to choose how it steers packets to queues.
5413a9fd824SRoger Pau Monné *
5423a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_SET_HASH_KEY
5433a9fd824SRoger Pau Monné * --------------------------------
5443a9fd824SRoger Pau Monné *
5453a9fd824SRoger Pau Monné * This is sent by the frontend to set the key of the hash if the algorithm
5463a9fd824SRoger Pau Monné * requires it. (See hash algorithms above).
5473a9fd824SRoger Pau Monné *
5483a9fd824SRoger Pau Monné * Request:
5493a9fd824SRoger Pau Monné *
5503a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_SET_HASH_KEY
5513a9fd824SRoger Pau Monné * data[0] = grant reference of page containing the key (assumed to
5523a9fd824SRoger Pau Monné * start at beginning of grant)
5533a9fd824SRoger Pau Monné * data[1] = size of key in octets
5543a9fd824SRoger Pau Monné * data[2] = 0
5553a9fd824SRoger Pau Monné *
5563a9fd824SRoger Pau Monné * Response:
5573a9fd824SRoger Pau Monné *
5583a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
5593a9fd824SRoger Pau Monné * supported
5603a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - Key size is invalid
5613a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_BUFFER_OVERFLOW - Key size is larger
5623a9fd824SRoger Pau Monné * than the backend
5633a9fd824SRoger Pau Monné * supports
5643a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
5653a9fd824SRoger Pau Monné * data = 0
5663a9fd824SRoger Pau Monné *
5673a9fd824SRoger Pau Monné * NOTE: Any key octets not specified are assumed to be zero (the key
5683a9fd824SRoger Pau Monné * is assumed to be empty by default) and specifying a new key
5693a9fd824SRoger Pau Monné * invalidates any previous key, hence specifying a key size of
5703a9fd824SRoger Pau Monné * zero will clear the key (which ensures that the calculated hash
5713a9fd824SRoger Pau Monné * will always be zero).
5723a9fd824SRoger Pau Monné * The maximum size of key is algorithm and backend specific, but
5733a9fd824SRoger Pau Monné * is also limited by the single grant reference.
5743a9fd824SRoger Pau Monné * The grant reference may be read-only and must remain valid until
5753a9fd824SRoger Pau Monné * the response has been processed.
5763a9fd824SRoger Pau Monné *
5773a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_GET_HASH_MAPPING_SIZE
5783a9fd824SRoger Pau Monné * -----------------------------------------
5793a9fd824SRoger Pau Monné *
5803a9fd824SRoger Pau Monné * This is sent by the frontend to query the maximum size of mapping
5813a9fd824SRoger Pau Monné * table supported by the backend. The size is specified in terms of
5823a9fd824SRoger Pau Monné * table entries.
5833a9fd824SRoger Pau Monné *
5843a9fd824SRoger Pau Monné * Request:
5853a9fd824SRoger Pau Monné *
5863a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_GET_HASH_MAPPING_SIZE
5873a9fd824SRoger Pau Monné * data[0] = 0
5883a9fd824SRoger Pau Monné * data[1] = 0
5893a9fd824SRoger Pau Monné * data[2] = 0
5903a9fd824SRoger Pau Monné *
5913a9fd824SRoger Pau Monné * Response:
5923a9fd824SRoger Pau Monné *
5933a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not supported
5943a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
5953a9fd824SRoger Pau Monné * data = maximum number of entries allowed in the mapping table
5963a9fd824SRoger Pau Monné * (if operation was successful) or zero if a mapping table is
5973a9fd824SRoger Pau Monné * not supported (i.e. hash mapping is done only by modular
5983a9fd824SRoger Pau Monné * arithmetic).
5993a9fd824SRoger Pau Monné *
6003a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING_SIZE
6013a9fd824SRoger Pau Monné * -------------------------------------
6023a9fd824SRoger Pau Monné *
6033a9fd824SRoger Pau Monné * This is sent by the frontend to set the actual size of the mapping
6043a9fd824SRoger Pau Monné * table to be used by the backend. The size is specified in terms of
6053a9fd824SRoger Pau Monné * table entries.
6063a9fd824SRoger Pau Monné * Any previous table is invalidated by this message and any new table
6073a9fd824SRoger Pau Monné * is assumed to be zero filled.
6083a9fd824SRoger Pau Monné *
6093a9fd824SRoger Pau Monné * Request:
6103a9fd824SRoger Pau Monné *
6113a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING_SIZE
6123a9fd824SRoger Pau Monné * data[0] = number of entries in mapping table
6133a9fd824SRoger Pau Monné * data[1] = 0
6143a9fd824SRoger Pau Monné * data[2] = 0
6153a9fd824SRoger Pau Monné *
6163a9fd824SRoger Pau Monné * Response:
6173a9fd824SRoger Pau Monné *
6183a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
6193a9fd824SRoger Pau Monné * supported
6203a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - Table size is invalid
6213a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
6223a9fd824SRoger Pau Monné * data = 0
6233a9fd824SRoger Pau Monné *
6243a9fd824SRoger Pau Monné * NOTE: Setting data[0] to 0 means that hash mapping should be done
6253a9fd824SRoger Pau Monné * using modular arithmetic.
6263a9fd824SRoger Pau Monné *
6273a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING
6283a9fd824SRoger Pau Monné * ------------------------------------
6293a9fd824SRoger Pau Monné *
6303a9fd824SRoger Pau Monné * This is sent by the frontend to set the content of the table mapping
6313a9fd824SRoger Pau Monné * hash value to queue number. The backend should calculate the hash from
6323a9fd824SRoger Pau Monné * the packet header, use it as an index into the table (modulo the size
6333a9fd824SRoger Pau Monné * of the table) and then steer the packet to the queue number found at
6343a9fd824SRoger Pau Monné * that index.
6353a9fd824SRoger Pau Monné *
6363a9fd824SRoger Pau Monné * Request:
6373a9fd824SRoger Pau Monné *
6383a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING
6393a9fd824SRoger Pau Monné * data[0] = grant reference of page containing the mapping (sub-)table
6403a9fd824SRoger Pau Monné * (assumed to start at beginning of grant)
6413a9fd824SRoger Pau Monné * data[1] = size of (sub-)table in entries
6423a9fd824SRoger Pau Monné * data[2] = offset, in entries, of sub-table within overall table
6433a9fd824SRoger Pau Monné *
6443a9fd824SRoger Pau Monné * Response:
6453a9fd824SRoger Pau Monné *
6463a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
6473a9fd824SRoger Pau Monné * supported
6483a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - Table size or content
6493a9fd824SRoger Pau Monné * is invalid
6503a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_BUFFER_OVERFLOW - Table size is larger
6513a9fd824SRoger Pau Monné * than the backend
6523a9fd824SRoger Pau Monné * supports
6533a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
6543a9fd824SRoger Pau Monné * data = 0
6553a9fd824SRoger Pau Monné *
6563a9fd824SRoger Pau Monné * NOTE: The overall table has the following format:
6573a9fd824SRoger Pau Monné *
6583a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
6593a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
6603a9fd824SRoger Pau Monné * | mapping[0] | mapping[1] |
6613a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
6623a9fd824SRoger Pau Monné * | . |
6633a9fd824SRoger Pau Monné * | . |
6643a9fd824SRoger Pau Monné * | . |
6653a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
6663a9fd824SRoger Pau Monné * | mapping[N-2] | mapping[N-1] |
6673a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
6683a9fd824SRoger Pau Monné *
6693a9fd824SRoger Pau Monné * where N is specified by a XEN_NETIF_CTRL_TYPE_SET_HASH_MAPPING_SIZE
6703a9fd824SRoger Pau Monné * message and each mapping must specifies a queue between 0 and
6713a9fd824SRoger Pau Monné * "multi-queue-num-queues" (see above).
6723a9fd824SRoger Pau Monné * The backend may support a mapping table larger than can be
6733a9fd824SRoger Pau Monné * mapped by a single grant reference. Thus sub-tables within a
6743a9fd824SRoger Pau Monné * larger table can be individually set by sending multiple messages
6753a9fd824SRoger Pau Monné * with differing offset values. Specifying a new sub-table does not
6763a9fd824SRoger Pau Monné * invalidate any table data outside that range.
6773a9fd824SRoger Pau Monné * The grant reference may be read-only and must remain valid until
6783a9fd824SRoger Pau Monné * the response has been processed.
6793a9fd824SRoger Pau Monné *
6803a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_GET_GREF_MAPPING_SIZE
6813a9fd824SRoger Pau Monné * -----------------------------------------
6823a9fd824SRoger Pau Monné *
6833a9fd824SRoger Pau Monné * This is sent by the frontend to fetch the number of grefs that can be kept
6843a9fd824SRoger Pau Monné * mapped in the backend.
6853a9fd824SRoger Pau Monné *
6863a9fd824SRoger Pau Monné * Request:
6873a9fd824SRoger Pau Monné *
6883a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_GET_GREF_MAPPING_SIZE
6893a9fd824SRoger Pau Monné * data[0] = queue index (assumed 0 for single queue)
6903a9fd824SRoger Pau Monné * data[1] = 0
6913a9fd824SRoger Pau Monné * data[2] = 0
6923a9fd824SRoger Pau Monné *
6933a9fd824SRoger Pau Monné * Response:
6943a9fd824SRoger Pau Monné *
6953a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
6963a9fd824SRoger Pau Monné * supported
6973a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - The queue index is
6983a9fd824SRoger Pau Monné * out of range
6993a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
7003a9fd824SRoger Pau Monné * data = maximum number of entries allowed in the gref mapping table
7013a9fd824SRoger Pau Monné * (if operation was successful) or zero if it is not supported.
7023a9fd824SRoger Pau Monné *
7033a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_ADD_GREF_MAPPING
7043a9fd824SRoger Pau Monné * ------------------------------------
7053a9fd824SRoger Pau Monné *
7063a9fd824SRoger Pau Monné * This is sent by the frontend for backend to map a list of grant
7073a9fd824SRoger Pau Monné * references.
7083a9fd824SRoger Pau Monné *
7093a9fd824SRoger Pau Monné * Request:
7103a9fd824SRoger Pau Monné *
7113a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_ADD_GREF_MAPPING
7123a9fd824SRoger Pau Monné * data[0] = queue index
7133a9fd824SRoger Pau Monné * data[1] = grant reference of page containing the mapping list
7143a9fd824SRoger Pau Monné * (r/w and assumed to start at beginning of page)
7153a9fd824SRoger Pau Monné * data[2] = size of list in entries
7163a9fd824SRoger Pau Monné *
7173a9fd824SRoger Pau Monné * Response:
7183a9fd824SRoger Pau Monné *
7193a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
7203a9fd824SRoger Pau Monné * supported
7213a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - Operation failed
7223a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
7233a9fd824SRoger Pau Monné *
7243a9fd824SRoger Pau Monné * NOTE: Each entry in the input table has the format outlined
7253a9fd824SRoger Pau Monné * in struct xen_netif_gref.
7263a9fd824SRoger Pau Monné * Contrary to XEN_NETIF_CTRL_TYPE_DEL_GREF_MAPPING, the struct
7273a9fd824SRoger Pau Monné * xen_netif_gref 'status' field is not used and therefore the response
7283a9fd824SRoger Pau Monné * 'status' determines the success of this operation. In case of
7293a9fd824SRoger Pau Monné * failure none of grants mappings get added in the backend.
7303a9fd824SRoger Pau Monné *
7313a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_TYPE_DEL_GREF_MAPPING
7323a9fd824SRoger Pau Monné * ------------------------------------
7333a9fd824SRoger Pau Monné *
7343a9fd824SRoger Pau Monné * This is sent by the frontend for backend to unmap a list of grant
7353a9fd824SRoger Pau Monné * references.
7363a9fd824SRoger Pau Monné *
7373a9fd824SRoger Pau Monné * Request:
7383a9fd824SRoger Pau Monné *
7393a9fd824SRoger Pau Monné * type = XEN_NETIF_CTRL_TYPE_DEL_GREF_MAPPING
7403a9fd824SRoger Pau Monné * data[0] = queue index
7413a9fd824SRoger Pau Monné * data[1] = grant reference of page containing the mapping list
7423a9fd824SRoger Pau Monné * (r/w and assumed to start at beginning of page)
7433a9fd824SRoger Pau Monné * data[2] = size of list in entries
7443a9fd824SRoger Pau Monné *
7453a9fd824SRoger Pau Monné * Response:
7463a9fd824SRoger Pau Monné *
7473a9fd824SRoger Pau Monné * status = XEN_NETIF_CTRL_STATUS_NOT_SUPPORTED - Operation not
7483a9fd824SRoger Pau Monné * supported
7493a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER - Operation failed
7503a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_SUCCESS - Operation successful
7513a9fd824SRoger Pau Monné * data = number of entries that were unmapped
7523a9fd824SRoger Pau Monné *
7533a9fd824SRoger Pau Monné * NOTE: Each entry in the input table has the format outlined in struct
7543a9fd824SRoger Pau Monné * xen_netif_gref.
7553a9fd824SRoger Pau Monné * The struct xen_netif_gref 'status' field determines if the entry
7563a9fd824SRoger Pau Monné * was successfully removed.
7573a9fd824SRoger Pau Monné * The entries used are only the ones representing grant references that
7583a9fd824SRoger Pau Monné * were previously the subject of a XEN_NETIF_CTRL_TYPE_ADD_GREF_MAPPING
7593a9fd824SRoger Pau Monné * operation. Any other entries will have their status set to
7603a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_STATUS_INVALID_PARAMETER upon completion.
7613a9fd824SRoger Pau Monné */
7623a9fd824SRoger Pau Monné
7633a9fd824SRoger Pau Monné DEFINE_RING_TYPES(xen_netif_ctrl,
7643a9fd824SRoger Pau Monné struct xen_netif_ctrl_request,
7653a9fd824SRoger Pau Monné struct xen_netif_ctrl_response);
7663a9fd824SRoger Pau Monné
7673a9fd824SRoger Pau Monné /*
7683a9fd824SRoger Pau Monné * Guest transmit
7693a9fd824SRoger Pau Monné * ==============
7703a9fd824SRoger Pau Monné *
7713a9fd824SRoger Pau Monné * This is the 'wire' format for transmit (frontend -> backend) packets:
7723a9fd824SRoger Pau Monné *
7733a9fd824SRoger Pau Monné * Fragment 1: netif_tx_request_t - flags = NETTXF_*
7743a9fd824SRoger Pau Monné * size = total packet size
7753a9fd824SRoger Pau Monné * [Extra 1: netif_extra_info_t] - (only if fragment 1 flags include
7763a9fd824SRoger Pau Monné * NETTXF_extra_info)
7773a9fd824SRoger Pau Monné * ...
7783a9fd824SRoger Pau Monné * [Extra N: netif_extra_info_t] - (only if extra N-1 flags include
7793a9fd824SRoger Pau Monné * XEN_NETIF_EXTRA_MORE)
7803a9fd824SRoger Pau Monné * ...
7813a9fd824SRoger Pau Monné * Fragment N: netif_tx_request_t - (only if fragment N-1 flags include
7823a9fd824SRoger Pau Monné * NETTXF_more_data - flags on preceding
7833a9fd824SRoger Pau Monné * extras are not relevant here)
7843a9fd824SRoger Pau Monné * flags = 0
7853a9fd824SRoger Pau Monné * size = fragment size
7863a9fd824SRoger Pau Monné *
7873a9fd824SRoger Pau Monné * NOTE:
7883a9fd824SRoger Pau Monné *
7893a9fd824SRoger Pau Monné * This format slightly is different from that used for receive
7903a9fd824SRoger Pau Monné * (backend -> frontend) packets. Specifically, in a multi-fragment
7913a9fd824SRoger Pau Monné * packet the actual size of fragment 1 can only be determined by
7923a9fd824SRoger Pau Monné * subtracting the sizes of fragments 2..N from the total packet size.
7933a9fd824SRoger Pau Monné *
7943a9fd824SRoger Pau Monné * Ring slot size is 12 octets, however not all request/response
7953a9fd824SRoger Pau Monné * structs use the full size.
7963a9fd824SRoger Pau Monné *
7973a9fd824SRoger Pau Monné * tx request data (netif_tx_request_t)
7983a9fd824SRoger Pau Monné * ------------------------------------
7993a9fd824SRoger Pau Monné *
8003a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
8013a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8023a9fd824SRoger Pau Monné * | grant ref | offset | flags |
8033a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8043a9fd824SRoger Pau Monné * | id | size |
8053a9fd824SRoger Pau Monné * +-----+-----+-----+-----+
8063a9fd824SRoger Pau Monné *
8073a9fd824SRoger Pau Monné * grant ref: Reference to buffer page.
8083a9fd824SRoger Pau Monné * offset: Offset within buffer page.
8093a9fd824SRoger Pau Monné * flags: NETTXF_*.
8103a9fd824SRoger Pau Monné * id: request identifier, echoed in response.
8113a9fd824SRoger Pau Monné * size: packet size in bytes.
8123a9fd824SRoger Pau Monné *
8133a9fd824SRoger Pau Monné * tx response (netif_tx_response_t)
8143a9fd824SRoger Pau Monné * ---------------------------------
8153a9fd824SRoger Pau Monné *
8163a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
8173a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8183a9fd824SRoger Pau Monné * | id | status | unused |
8193a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8203a9fd824SRoger Pau Monné * | unused |
8213a9fd824SRoger Pau Monné * +-----+-----+-----+-----+
8223a9fd824SRoger Pau Monné *
8233a9fd824SRoger Pau Monné * id: reflects id in transmit request
8243a9fd824SRoger Pau Monné * status: NETIF_RSP_*
8253a9fd824SRoger Pau Monné *
8263a9fd824SRoger Pau Monné * Guest receive
8273a9fd824SRoger Pau Monné * =============
8283a9fd824SRoger Pau Monné *
8293a9fd824SRoger Pau Monné * This is the 'wire' format for receive (backend -> frontend) packets:
8303a9fd824SRoger Pau Monné *
8313a9fd824SRoger Pau Monné * Fragment 1: netif_rx_request_t - flags = NETRXF_*
8323a9fd824SRoger Pau Monné * size = fragment size
8333a9fd824SRoger Pau Monné * [Extra 1: netif_extra_info_t] - (only if fragment 1 flags include
8343a9fd824SRoger Pau Monné * NETRXF_extra_info)
8353a9fd824SRoger Pau Monné * ...
8363a9fd824SRoger Pau Monné * [Extra N: netif_extra_info_t] - (only if extra N-1 flags include
8373a9fd824SRoger Pau Monné * XEN_NETIF_EXTRA_MORE)
8383a9fd824SRoger Pau Monné * ...
8393a9fd824SRoger Pau Monné * Fragment N: netif_rx_request_t - (only if fragment N-1 flags include
8403a9fd824SRoger Pau Monné * NETRXF_more_data - flags on preceding
8413a9fd824SRoger Pau Monné * extras are not relevant here)
8423a9fd824SRoger Pau Monné * flags = 0
8433a9fd824SRoger Pau Monné * size = fragment size
8443a9fd824SRoger Pau Monné *
8453a9fd824SRoger Pau Monné * NOTE:
8463a9fd824SRoger Pau Monné *
8473a9fd824SRoger Pau Monné * This format slightly is different from that used for transmit
8483a9fd824SRoger Pau Monné * (frontend -> backend) packets. Specifically, in a multi-fragment
8493a9fd824SRoger Pau Monné * packet the size of the packet can only be determined by summing the
8503a9fd824SRoger Pau Monné * sizes of fragments 1..N.
8513a9fd824SRoger Pau Monné *
8523a9fd824SRoger Pau Monné * Ring slot size is 8 octets.
8533a9fd824SRoger Pau Monné *
8543a9fd824SRoger Pau Monné * rx request (netif_rx_request_t)
8553a9fd824SRoger Pau Monné * -------------------------------
8563a9fd824SRoger Pau Monné *
8573a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
8583a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8593a9fd824SRoger Pau Monné * | id | pad | gref |
8603a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8613a9fd824SRoger Pau Monné *
8623a9fd824SRoger Pau Monné * id: request identifier, echoed in response.
8633a9fd824SRoger Pau Monné * gref: reference to incoming granted frame.
8643a9fd824SRoger Pau Monné *
8653a9fd824SRoger Pau Monné * rx response (netif_rx_response_t)
8663a9fd824SRoger Pau Monné * ---------------------------------
8673a9fd824SRoger Pau Monné *
8683a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
8693a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8703a9fd824SRoger Pau Monné * | id | offset | flags | status |
8713a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
8723a9fd824SRoger Pau Monné *
8733a9fd824SRoger Pau Monné * id: reflects id in receive request
8743a9fd824SRoger Pau Monné * offset: offset in page of start of received packet
8753a9fd824SRoger Pau Monné * flags: NETRXF_*
8763a9fd824SRoger Pau Monné * status: -ve: NETIF_RSP_*; +ve: Rx'ed pkt size.
8773a9fd824SRoger Pau Monné *
8783a9fd824SRoger Pau Monné * NOTE: Historically, to support GSO on the frontend receive side, Linux
8793a9fd824SRoger Pau Monné * netfront does not make use of the rx response id (because, as
8803a9fd824SRoger Pau Monné * described below, extra info structures overlay the id field).
8813a9fd824SRoger Pau Monné * Instead it assumes that responses always appear in the same ring
8823a9fd824SRoger Pau Monné * slot as their corresponding request. Thus, to maintain
8833a9fd824SRoger Pau Monné * compatibility, backends must make sure this is the case.
8843a9fd824SRoger Pau Monné *
8853a9fd824SRoger Pau Monné * Extra Info
8863a9fd824SRoger Pau Monné * ==========
8873a9fd824SRoger Pau Monné *
8883a9fd824SRoger Pau Monné * Can be present if initial request or response has NET{T,R}XF_extra_info,
8893a9fd824SRoger Pau Monné * or previous extra request has XEN_NETIF_EXTRA_MORE.
8903a9fd824SRoger Pau Monné *
8913a9fd824SRoger Pau Monné * The struct therefore needs to fit into either a tx or rx slot and
8923a9fd824SRoger Pau Monné * is therefore limited to 8 octets.
8933a9fd824SRoger Pau Monné *
8943a9fd824SRoger Pau Monné * NOTE: Because extra info data overlays the usual request/response
8953a9fd824SRoger Pau Monné * structures, there is no id information in the opposite direction.
8963a9fd824SRoger Pau Monné * So, if an extra info overlays an rx response the frontend can
8973a9fd824SRoger Pau Monné * assume that it is in the same ring slot as the request that was
8983a9fd824SRoger Pau Monné * consumed to make the slot available, and the backend must ensure
8993a9fd824SRoger Pau Monné * this assumption is true.
9003a9fd824SRoger Pau Monné *
9013a9fd824SRoger Pau Monné * extra info (netif_extra_info_t)
9023a9fd824SRoger Pau Monné * -------------------------------
9033a9fd824SRoger Pau Monné *
9043a9fd824SRoger Pau Monné * General format:
9053a9fd824SRoger Pau Monné *
9063a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
9073a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9083a9fd824SRoger Pau Monné * |type |flags| type specific data |
9093a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9103a9fd824SRoger Pau Monné * | padding for tx |
9113a9fd824SRoger Pau Monné * +-----+-----+-----+-----+
9123a9fd824SRoger Pau Monné *
9133a9fd824SRoger Pau Monné * type: XEN_NETIF_EXTRA_TYPE_*
9143a9fd824SRoger Pau Monné * flags: XEN_NETIF_EXTRA_FLAG_*
9153a9fd824SRoger Pau Monné * padding for tx: present only in the tx case due to 8 octet limit
9163a9fd824SRoger Pau Monné * from rx case. Not shown in type specific entries
9173a9fd824SRoger Pau Monné * below.
9183a9fd824SRoger Pau Monné *
9193a9fd824SRoger Pau Monné * XEN_NETIF_EXTRA_TYPE_GSO:
9203a9fd824SRoger Pau Monné *
9213a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
9223a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9233a9fd824SRoger Pau Monné * |type |flags| size |type | pad | features |
9243a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9253a9fd824SRoger Pau Monné *
9263a9fd824SRoger Pau Monné * type: Must be XEN_NETIF_EXTRA_TYPE_GSO
9273a9fd824SRoger Pau Monné * flags: XEN_NETIF_EXTRA_FLAG_*
9283a9fd824SRoger Pau Monné * size: Maximum payload size of each segment. For example,
9293a9fd824SRoger Pau Monné * for TCP this is just the path MSS.
9303a9fd824SRoger Pau Monné * type: XEN_NETIF_GSO_TYPE_*: This determines the protocol of
9313a9fd824SRoger Pau Monné * the packet and any extra features required to segment the
9323a9fd824SRoger Pau Monné * packet properly.
9333a9fd824SRoger Pau Monné * features: EN_NETIF_GSO_FEAT_*: This specifies any extra GSO
9343a9fd824SRoger Pau Monné * features required to process this packet, such as ECN
9353a9fd824SRoger Pau Monné * support for TCPv4.
9363a9fd824SRoger Pau Monné *
9373a9fd824SRoger Pau Monné * XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}:
9383a9fd824SRoger Pau Monné *
9393a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
9403a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9413a9fd824SRoger Pau Monné * |type |flags| addr |
9423a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9433a9fd824SRoger Pau Monné *
9443a9fd824SRoger Pau Monné * type: Must be XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}
9453a9fd824SRoger Pau Monné * flags: XEN_NETIF_EXTRA_FLAG_*
9463a9fd824SRoger Pau Monné * addr: address to add/remove
9473a9fd824SRoger Pau Monné *
9483a9fd824SRoger Pau Monné * XEN_NETIF_EXTRA_TYPE_HASH:
9493a9fd824SRoger Pau Monné *
9503a9fd824SRoger Pau Monné * A backend that supports teoplitz hashing is assumed to accept
9513a9fd824SRoger Pau Monné * this type of extra info in transmit packets.
9523a9fd824SRoger Pau Monné * A frontend that enables hashing is assumed to accept
9533a9fd824SRoger Pau Monné * this type of extra info in receive packets.
9543a9fd824SRoger Pau Monné *
9553a9fd824SRoger Pau Monné * 0 1 2 3 4 5 6 7 octet
9563a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9573a9fd824SRoger Pau Monné * |type |flags|htype| alg |LSB ---- value ---- MSB|
9583a9fd824SRoger Pau Monné * +-----+-----+-----+-----+-----+-----+-----+-----+
9593a9fd824SRoger Pau Monné *
9603a9fd824SRoger Pau Monné * type: Must be XEN_NETIF_EXTRA_TYPE_HASH
9613a9fd824SRoger Pau Monné * flags: XEN_NETIF_EXTRA_FLAG_*
9623a9fd824SRoger Pau Monné * htype: Hash type (one of _XEN_NETIF_CTRL_HASH_TYPE_* - see above)
9633a9fd824SRoger Pau Monné * alg: The algorithm used to calculate the hash (one of
9643a9fd824SRoger Pau Monné * XEN_NETIF_CTRL_HASH_TYPE_ALGORITHM_* - see above)
9653a9fd824SRoger Pau Monné * value: Hash value
9663a9fd824SRoger Pau Monné */
9673a9fd824SRoger Pau Monné
9683a9fd824SRoger Pau Monné /* Protocol checksum field is blank in the packet (hardware offload)? */
9693a9fd824SRoger Pau Monné #define _NETTXF_csum_blank (0)
9703a9fd824SRoger Pau Monné #define NETTXF_csum_blank (1U<<_NETTXF_csum_blank)
9713a9fd824SRoger Pau Monné
9723a9fd824SRoger Pau Monné /* Packet data has been validated against protocol checksum. */
9733a9fd824SRoger Pau Monné #define _NETTXF_data_validated (1)
9743a9fd824SRoger Pau Monné #define NETTXF_data_validated (1U<<_NETTXF_data_validated)
9753a9fd824SRoger Pau Monné
9763a9fd824SRoger Pau Monné /* Packet continues in the next request descriptor. */
9773a9fd824SRoger Pau Monné #define _NETTXF_more_data (2)
9783a9fd824SRoger Pau Monné #define NETTXF_more_data (1U<<_NETTXF_more_data)
9793a9fd824SRoger Pau Monné
9803a9fd824SRoger Pau Monné /* Packet to be followed by extra descriptor(s). */
9813a9fd824SRoger Pau Monné #define _NETTXF_extra_info (3)
9823a9fd824SRoger Pau Monné #define NETTXF_extra_info (1U<<_NETTXF_extra_info)
9833a9fd824SRoger Pau Monné
9843a9fd824SRoger Pau Monné #define XEN_NETIF_MAX_TX_SIZE 0xFFFF
9853a9fd824SRoger Pau Monné struct netif_tx_request {
9863a9fd824SRoger Pau Monné grant_ref_t gref;
9873a9fd824SRoger Pau Monné uint16_t offset;
9883a9fd824SRoger Pau Monné uint16_t flags;
9893a9fd824SRoger Pau Monné uint16_t id;
9903a9fd824SRoger Pau Monné uint16_t size;
9913a9fd824SRoger Pau Monné };
9923a9fd824SRoger Pau Monné typedef struct netif_tx_request netif_tx_request_t;
9933a9fd824SRoger Pau Monné
9943a9fd824SRoger Pau Monné /* Types of netif_extra_info descriptors. */
9953a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_NONE (0) /* Never used - invalid */
9963a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_GSO (1) /* u.gso */
9973a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_MCAST_ADD (2) /* u.mcast */
9983a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_MCAST_DEL (3) /* u.mcast */
9993a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_HASH (4) /* u.hash */
10003a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_TYPE_MAX (5)
10013a9fd824SRoger Pau Monné
10023a9fd824SRoger Pau Monné /* netif_extra_info_t flags. */
10033a9fd824SRoger Pau Monné #define _XEN_NETIF_EXTRA_FLAG_MORE (0)
10043a9fd824SRoger Pau Monné #define XEN_NETIF_EXTRA_FLAG_MORE (1U<<_XEN_NETIF_EXTRA_FLAG_MORE)
10053a9fd824SRoger Pau Monné
10063a9fd824SRoger Pau Monné /* GSO types */
10073a9fd824SRoger Pau Monné #define XEN_NETIF_GSO_TYPE_NONE (0)
10083a9fd824SRoger Pau Monné #define XEN_NETIF_GSO_TYPE_TCPV4 (1)
10093a9fd824SRoger Pau Monné #define XEN_NETIF_GSO_TYPE_TCPV6 (2)
10103a9fd824SRoger Pau Monné
10113a9fd824SRoger Pau Monné /*
10123a9fd824SRoger Pau Monné * This structure needs to fit within both netif_tx_request_t and
10133a9fd824SRoger Pau Monné * netif_rx_response_t for compatibility.
10143a9fd824SRoger Pau Monné */
10153a9fd824SRoger Pau Monné struct netif_extra_info {
10163a9fd824SRoger Pau Monné uint8_t type;
10173a9fd824SRoger Pau Monné uint8_t flags;
10183a9fd824SRoger Pau Monné union {
10193a9fd824SRoger Pau Monné struct {
10203a9fd824SRoger Pau Monné uint16_t size;
10213a9fd824SRoger Pau Monné uint8_t type;
10223a9fd824SRoger Pau Monné uint8_t pad;
10233a9fd824SRoger Pau Monné uint16_t features;
10243a9fd824SRoger Pau Monné } gso;
10253a9fd824SRoger Pau Monné struct {
10263a9fd824SRoger Pau Monné uint8_t addr[6];
10273a9fd824SRoger Pau Monné } mcast;
10283a9fd824SRoger Pau Monné struct {
10293a9fd824SRoger Pau Monné uint8_t type;
10303a9fd824SRoger Pau Monné uint8_t algorithm;
10313a9fd824SRoger Pau Monné uint8_t value[4];
10323a9fd824SRoger Pau Monné } hash;
10333a9fd824SRoger Pau Monné uint16_t pad[3];
10343a9fd824SRoger Pau Monné } u;
10353a9fd824SRoger Pau Monné };
10363a9fd824SRoger Pau Monné typedef struct netif_extra_info netif_extra_info_t;
10373a9fd824SRoger Pau Monné
10383a9fd824SRoger Pau Monné struct netif_tx_response {
10393a9fd824SRoger Pau Monné uint16_t id;
10403a9fd824SRoger Pau Monné int16_t status;
10413a9fd824SRoger Pau Monné };
10423a9fd824SRoger Pau Monné typedef struct netif_tx_response netif_tx_response_t;
10433a9fd824SRoger Pau Monné
10443a9fd824SRoger Pau Monné struct netif_rx_request {
10453a9fd824SRoger Pau Monné uint16_t id; /* Echoed in response message. */
10463a9fd824SRoger Pau Monné uint16_t pad;
10473a9fd824SRoger Pau Monné grant_ref_t gref;
10483a9fd824SRoger Pau Monné };
10493a9fd824SRoger Pau Monné typedef struct netif_rx_request netif_rx_request_t;
10503a9fd824SRoger Pau Monné
10513a9fd824SRoger Pau Monné /* Packet data has been validated against protocol checksum. */
10523a9fd824SRoger Pau Monné #define _NETRXF_data_validated (0)
10533a9fd824SRoger Pau Monné #define NETRXF_data_validated (1U<<_NETRXF_data_validated)
10543a9fd824SRoger Pau Monné
10553a9fd824SRoger Pau Monné /* Protocol checksum field is blank in the packet (hardware offload)? */
10563a9fd824SRoger Pau Monné #define _NETRXF_csum_blank (1)
10573a9fd824SRoger Pau Monné #define NETRXF_csum_blank (1U<<_NETRXF_csum_blank)
10583a9fd824SRoger Pau Monné
10593a9fd824SRoger Pau Monné /* Packet continues in the next request descriptor. */
10603a9fd824SRoger Pau Monné #define _NETRXF_more_data (2)
10613a9fd824SRoger Pau Monné #define NETRXF_more_data (1U<<_NETRXF_more_data)
10623a9fd824SRoger Pau Monné
10633a9fd824SRoger Pau Monné /* Packet to be followed by extra descriptor(s). */
10643a9fd824SRoger Pau Monné #define _NETRXF_extra_info (3)
10653a9fd824SRoger Pau Monné #define NETRXF_extra_info (1U<<_NETRXF_extra_info)
10663a9fd824SRoger Pau Monné
10673a9fd824SRoger Pau Monné /* Packet has GSO prefix. Deprecated but included for compatibility */
10683a9fd824SRoger Pau Monné #define _NETRXF_gso_prefix (4)
10693a9fd824SRoger Pau Monné #define NETRXF_gso_prefix (1U<<_NETRXF_gso_prefix)
10703a9fd824SRoger Pau Monné
10713a9fd824SRoger Pau Monné struct netif_rx_response {
10723a9fd824SRoger Pau Monné uint16_t id;
10733a9fd824SRoger Pau Monné uint16_t offset;
10743a9fd824SRoger Pau Monné uint16_t flags;
10753a9fd824SRoger Pau Monné int16_t status;
10763a9fd824SRoger Pau Monné };
10773a9fd824SRoger Pau Monné typedef struct netif_rx_response netif_rx_response_t;
10783a9fd824SRoger Pau Monné
10793a9fd824SRoger Pau Monné /*
10803a9fd824SRoger Pau Monné * Generate netif ring structures and types.
10813a9fd824SRoger Pau Monné */
10823a9fd824SRoger Pau Monné
10833a9fd824SRoger Pau Monné DEFINE_RING_TYPES(netif_tx, struct netif_tx_request, struct netif_tx_response);
10843a9fd824SRoger Pau Monné DEFINE_RING_TYPES(netif_rx, struct netif_rx_request, struct netif_rx_response);
10853a9fd824SRoger Pau Monné
10863a9fd824SRoger Pau Monné #define NETIF_RSP_DROPPED -2
10873a9fd824SRoger Pau Monné #define NETIF_RSP_ERROR -1
10883a9fd824SRoger Pau Monné #define NETIF_RSP_OKAY 0
10893a9fd824SRoger Pau Monné /* No response: used for auxiliary requests (e.g., netif_extra_info_t). */
10903a9fd824SRoger Pau Monné #define NETIF_RSP_NULL 1
10913a9fd824SRoger Pau Monné
10923a9fd824SRoger Pau Monné #endif
10933a9fd824SRoger Pau Monné
10943a9fd824SRoger Pau Monné /*
10953a9fd824SRoger Pau Monné * Local variables:
10963a9fd824SRoger Pau Monné * mode: C
10973a9fd824SRoger Pau Monné * c-file-style: "BSD"
10983a9fd824SRoger Pau Monné * c-basic-offset: 4
10993a9fd824SRoger Pau Monné * tab-width: 4
11003a9fd824SRoger Pau Monné * indent-tabs-mode: nil
11013a9fd824SRoger Pau Monné * End:
11023a9fd824SRoger Pau Monné */
1103