ethdev: fix comments for filters

This patch fixes comments for tunnel filters and flow director flows.
e.g. states fields which are in big endian.

Fixes: 7b1312891b69 ("ethdev: add IP in GRE tunnel")
Fixes: d69be32d4d78 ("ethdev: structures to add or delete flow director")

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
This commit is contained in:
Jingjing Wu 2016-03-29 11:04:28 +08:00 committed by Thomas Monjalon
parent 6ac91f938c
commit 6354f576d8

View File

@ -283,19 +283,22 @@ enum rte_tunnel_iptype {
* Tunneling Packet filter configuration.
*/
struct rte_eth_tunnel_filter_conf {
struct ether_addr outer_mac; /**< Outer MAC address filter. */
struct ether_addr inner_mac; /**< Inner MAC address filter. */
uint16_t inner_vlan; /**< Inner VLAN filter. */
struct ether_addr outer_mac; /**< Outer MAC address to match. */
struct ether_addr inner_mac; /**< Inner MAC address to match. */
uint16_t inner_vlan; /**< Inner VLAN to match. */
enum rte_tunnel_iptype ip_type; /**< IP address type. */
/** Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
is set in filter_type, or inner destination IP address to match
if ETH_TUNNEL_FILTER_IIP is set in filter_type . */
union {
uint32_t ipv4_addr; /**< IPv4 source address to match. */
uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
} ip_addr; /**< IPv4/IPv6 source address to match (union of above). */
uint16_t filter_type; /**< Filter type. */
uint32_t ipv4_addr; /**< IPv4 address in big endian. */
uint32_t ipv6_addr[4]; /**< IPv6 address in big endian. */
} ip_addr;
/** Flags from ETH_TUNNEL_FILTER_XX - see above. */
uint16_t filter_type;
enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
uint32_t tenant_id; /**< Tenant number. */
uint16_t queue_id; /**< Queue number. */
uint32_t tenant_id; /**< Tenant ID to match. VNI, GRE key... */
uint16_t queue_id; /**< Queue assigned to if match. */
};
/**
@ -403,18 +406,18 @@ struct rte_eth_input_set_conf {
* A structure used to define the input for L2 flow
*/
struct rte_eth_l2_flow {
uint16_t ether_type; /**< Ether type to match */
uint16_t ether_type; /**< Ether type in big endian */
};
/**
* A structure used to define the input for IPV4 flow
*/
struct rte_eth_ipv4_flow {
uint32_t src_ip; /**< IPv4 source address to match. */
uint32_t dst_ip; /**< IPv4 destination address to match. */
uint32_t src_ip; /**< IPv4 source address in big endian. */
uint32_t dst_ip; /**< IPv4 destination address in big endian. */
uint8_t tos; /**< Type of service to match. */
uint8_t ttl; /**< Time to live to match. */
uint8_t proto; /**< Protocol, next header to match. */
uint8_t proto; /**< Protocol, next header in big endian. */
};
/**
@ -422,8 +425,8 @@ struct rte_eth_ipv4_flow {
*/
struct rte_eth_udpv4_flow {
struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
uint16_t src_port; /**< UDP source port to match. */
uint16_t dst_port; /**< UDP destination port to match. */
uint16_t src_port; /**< UDP source port in big endian. */
uint16_t dst_port; /**< UDP destination port in big endian. */
};
/**
@ -431,8 +434,8 @@ struct rte_eth_udpv4_flow {
*/
struct rte_eth_tcpv4_flow {
struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
uint16_t src_port; /**< TCP source port to match. */
uint16_t dst_port; /**< TCP destination port to match. */
uint16_t src_port; /**< TCP source port in big endian. */
uint16_t dst_port; /**< TCP destination port in big endian. */
};
/**
@ -440,17 +443,17 @@ struct rte_eth_tcpv4_flow {
*/
struct rte_eth_sctpv4_flow {
struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
uint16_t src_port; /**< SCTP source port to match. */
uint16_t dst_port; /**< SCTP destination port to match. */
uint32_t verify_tag; /**< Verify tag to match */
uint16_t src_port; /**< SCTP source port in big endian. */
uint16_t dst_port; /**< SCTP destination port in big endian. */
uint32_t verify_tag; /**< Verify tag in big endian */
};
/**
* A structure used to define the input for IPV6 flow
*/
struct rte_eth_ipv6_flow {
uint32_t src_ip[4]; /**< IPv6 source address to match. */
uint32_t dst_ip[4]; /**< IPv6 destination address to match. */
uint32_t src_ip[4]; /**< IPv6 source address in big endian. */
uint32_t dst_ip[4]; /**< IPv6 destination address in big endian. */
uint8_t tc; /**< Traffic class to match. */
uint8_t proto; /**< Protocol, next header to match. */
uint8_t hop_limits; /**< Hop limits to match. */
@ -461,8 +464,8 @@ struct rte_eth_ipv6_flow {
*/
struct rte_eth_udpv6_flow {
struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
uint16_t src_port; /**< UDP source port to match. */
uint16_t dst_port; /**< UDP destination port to match. */
uint16_t src_port; /**< UDP source port in big endian. */
uint16_t dst_port; /**< UDP destination port in big endian. */
};
/**
@ -470,8 +473,8 @@ struct rte_eth_udpv6_flow {
*/
struct rte_eth_tcpv6_flow {
struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
uint16_t src_port; /**< TCP source port to match. */
uint16_t dst_port; /**< TCP destination port to match. */
uint16_t src_port; /**< TCP source port to in big endian. */
uint16_t dst_port; /**< TCP destination port in big endian. */
};
/**
@ -479,9 +482,9 @@ struct rte_eth_tcpv6_flow {
*/
struct rte_eth_sctpv6_flow {
struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
uint16_t src_port; /**< SCTP source port to match. */
uint16_t dst_port; /**< SCTP destination port to match. */
uint32_t verify_tag; /**< Verify tag to match */
uint16_t src_port; /**< SCTP source port in big endian. */
uint16_t dst_port; /**< SCTP destination port in big endian. */
uint32_t verify_tag; /**< Verify tag in big endian. */
};
/**
@ -506,7 +509,8 @@ enum rte_eth_fdir_tunnel_type {
*/
struct rte_eth_tunnel_flow {
enum rte_eth_fdir_tunnel_type tunnel_type; /**< Tunnel type to match. */
uint32_t tunnel_id; /**< Tunnel ID to match. TNI, VNI... */
/** Tunnel ID to match. TNI, VNI... in big endian. */
uint32_t tunnel_id;
struct ether_addr mac_addr; /**< Mac address to match. */
};