4 * Copyright (c) 2017 Solarflare Communications Inc.
7 * This software was jointly developed between OKTET Labs (under contract
8 * for Solarflare) and Solarflare Communications, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions are met:
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
29 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <rte_mempool.h>
36 #include <rte_ethdev.h>
45 * Generic receive queue information used on data path.
46 * It must be kept as small as it is possible since it is built into
47 * the structure used on datapath.
50 struct sfc_dp_queue dpq;
54 * Datapath receive queue creation information.
56 * The structure is used just to pass information from control path to
57 * datapath. It could be just function arguments, but it would be hardly
60 struct sfc_dp_rx_qcreate_info {
61 /** Memory pool to allocate Rx buffer from */
62 struct rte_mempool *refill_mb_pool;
63 /** Minimum number of unused Rx descriptors to do refill */
64 unsigned int refill_threshold;
66 * Usable mbuf data space in accordance with alignment and
67 * padding requirements imposed by HW.
69 unsigned int buf_size;
72 * Maximum number of Rx descriptors completed in one Rx event.
73 * Just for sanity checks if datapath would like to do.
75 unsigned int batch_max;
77 /** Pseudo-header size */
78 unsigned int prefix_size;
80 /** Receive queue flags initializer */
82 #define SFC_RXQ_FLAG_RSS_HASH 0x1
85 unsigned int rxq_entries;
89 * Allocate and initialize datapath receive queue.
91 * @param port_id The port identifier
92 * @param queue_id The queue identifier
93 * @param pci_addr PCI function address
94 * @param socket_id Socket identifier to allocate memory
95 * @param info Receive queue information
96 * @param dp_rxqp Location for generic datapath receive queue pointer
98 * @return 0 or positive errno.
100 typedef int (sfc_dp_rx_qcreate_t)(uint16_t port_id, uint16_t queue_id,
101 const struct rte_pci_addr *pci_addr,
103 const struct sfc_dp_rx_qcreate_info *info,
104 struct sfc_dp_rxq **dp_rxqp);
107 * Free resources allocated for datapath recevie queue.
109 typedef void (sfc_dp_rx_qdestroy_t)(struct sfc_dp_rxq *dp_rxq);
112 * Receive queue start callback.
114 * It handovers EvQ to the datapath.
116 typedef int (sfc_dp_rx_qstart_t)(struct sfc_dp_rxq *dp_rxq,
117 unsigned int evq_read_ptr);
120 * Receive queue stop function called before flush.
122 typedef void (sfc_dp_rx_qstop_t)(struct sfc_dp_rxq *dp_rxq,
123 unsigned int *evq_read_ptr);
126 * Receive queue purge function called after queue flush.
128 * Should be used to free unused recevie buffers.
130 typedef void (sfc_dp_rx_qpurge_t)(struct sfc_dp_rxq *dp_rxq);
132 /** Get packet types recognized/classified */
133 typedef const uint32_t * (sfc_dp_rx_supported_ptypes_get_t)(void);
135 /** Get number of pending Rx descriptors */
136 typedef unsigned int (sfc_dp_rx_qdesc_npending_t)(struct sfc_dp_rxq *dp_rxq);
138 /** Receive datapath definition */
142 unsigned int features;
143 #define SFC_DP_RX_FEAT_SCATTER 0x1
144 sfc_dp_rx_qcreate_t *qcreate;
145 sfc_dp_rx_qdestroy_t *qdestroy;
146 sfc_dp_rx_qstart_t *qstart;
147 sfc_dp_rx_qstop_t *qstop;
148 sfc_dp_rx_qpurge_t *qpurge;
149 sfc_dp_rx_supported_ptypes_get_t *supported_ptypes_get;
150 sfc_dp_rx_qdesc_npending_t *qdesc_npending;
151 eth_rx_burst_t pkt_burst;
154 static inline struct sfc_dp_rx *
155 sfc_dp_find_rx_by_name(struct sfc_dp_list *head, const char *name)
157 struct sfc_dp *p = sfc_dp_find_by_name(head, SFC_DP_RX, name);
159 return (p == NULL) ? NULL : container_of(p, struct sfc_dp_rx, dp);
162 static inline struct sfc_dp_rx *
163 sfc_dp_find_rx_by_caps(struct sfc_dp_list *head, unsigned int avail_caps)
165 struct sfc_dp *p = sfc_dp_find_by_caps(head, SFC_DP_RX, avail_caps);
167 return (p == NULL) ? NULL : container_of(p, struct sfc_dp_rx, dp);
170 extern struct sfc_dp_rx sfc_efx_rx;
175 #endif /* _SFC_DP_RX_H */