6c3ac3b619732d2cb250f6bede2c8889ce193436
[deb_dpdk.git] / drivers / net / sfc / sfc_tx.h
1 /*-
2  *   BSD LICENSE
3  *
4  * Copyright (c) 2016-2017 Solarflare Communications Inc.
5  * All rights reserved.
6  *
7  * This software was jointly developed between OKTET Labs (under contract
8  * for Solarflare) and Solarflare Communications, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
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.
18  *
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.
30  */
31
32 #ifndef _SFC_TX_H
33 #define _SFC_TX_H
34
35 #include <rte_mbuf.h>
36 #include <rte_ethdev.h>
37
38 #include "efx.h"
39
40 #include "sfc_dp_tx.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 struct sfc_adapter;
47 struct sfc_evq;
48
49 /**
50  * Software Tx descriptor information associated with hardware Tx
51  * descriptor.
52  */
53 struct sfc_efx_tx_sw_desc {
54         struct rte_mbuf         *mbuf;
55         uint8_t                 *tsoh;  /* Buffer to store TSO header */
56 };
57
58 enum sfc_txq_state_bit {
59         SFC_TXQ_INITIALIZED_BIT = 0,
60 #define SFC_TXQ_INITIALIZED     (1 << SFC_TXQ_INITIALIZED_BIT)
61         SFC_TXQ_STARTED_BIT,
62 #define SFC_TXQ_STARTED         (1 << SFC_TXQ_STARTED_BIT)
63         SFC_TXQ_FLUSHING_BIT,
64 #define SFC_TXQ_FLUSHING        (1 << SFC_TXQ_FLUSHING_BIT)
65         SFC_TXQ_FLUSHED_BIT,
66 #define SFC_TXQ_FLUSHED         (1 << SFC_TXQ_FLUSHED_BIT)
67 };
68
69 /**
70  * Transmit queue control information. Not used on datapath.
71  * Allocated on the socket specified on the queue setup.
72  */
73 struct sfc_txq {
74         unsigned int                    state;
75         unsigned int                    hw_index;
76         struct sfc_evq                  *evq;
77         efsys_mem_t                     mem;
78         struct sfc_dp_txq               *dp;
79         efx_txq_t                       *common;
80         unsigned int                    free_thresh;
81         unsigned int                    flags;
82 };
83
84 static inline unsigned int
85 sfc_txq_sw_index_by_hw_index(unsigned int hw_index)
86 {
87         return hw_index;
88 }
89
90 static inline unsigned int
91 sfc_txq_sw_index(const struct sfc_txq *txq)
92 {
93         return sfc_txq_sw_index_by_hw_index(txq->hw_index);
94 }
95
96 struct sfc_txq *sfc_txq_by_dp_txq(const struct sfc_dp_txq *dp_txq);
97
98 /**
99  * Transmit queue information used on libefx-based data path.
100  * Allocated on the socket specified on the queue setup.
101  */
102 struct sfc_efx_txq {
103         struct sfc_evq                  *evq;
104         struct sfc_efx_tx_sw_desc       *sw_ring;
105         unsigned int                    ptr_mask;
106         efx_desc_t                      *pend_desc;
107         efx_txq_t                       *common;
108         unsigned int                    added;
109         unsigned int                    pending;
110         unsigned int                    completed;
111         unsigned int                    free_thresh;
112         uint16_t                        hw_vlan_tci;
113         uint16_t                        dma_desc_size_max;
114
115         unsigned int                    hw_index;
116         unsigned int                    flags;
117 #define SFC_EFX_TXQ_FLAG_STARTED        0x1
118 #define SFC_EFX_TXQ_FLAG_RUNNING        0x2
119
120         /* Datapath transmit queue anchor */
121         struct sfc_dp_txq               dp;
122 };
123
124 static inline struct sfc_efx_txq *
125 sfc_efx_txq_by_dp_txq(struct sfc_dp_txq *dp_txq)
126 {
127         return container_of(dp_txq, struct sfc_efx_txq, dp);
128 }
129
130 struct sfc_txq_info {
131         unsigned int            entries;
132         struct sfc_txq          *txq;
133         boolean_t               deferred_start;
134         boolean_t               deferred_started;
135 };
136
137 int sfc_tx_configure(struct sfc_adapter *sa);
138 void sfc_tx_close(struct sfc_adapter *sa);
139
140 int sfc_tx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
141                  uint16_t nb_tx_desc, unsigned int socket_id,
142                  const struct rte_eth_txconf *tx_conf);
143 void sfc_tx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
144
145 void sfc_tx_qflush_done(struct sfc_txq *txq);
146 int sfc_tx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
147 void sfc_tx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
148 int sfc_tx_start(struct sfc_adapter *sa);
149 void sfc_tx_stop(struct sfc_adapter *sa);
150
151 /* From 'sfc_tso.c' */
152 int sfc_efx_tso_alloc_tsoh_objs(struct sfc_efx_tx_sw_desc *sw_ring,
153                                 unsigned int txq_entries,
154                                 unsigned int socket_id);
155 void sfc_efx_tso_free_tsoh_objs(struct sfc_efx_tx_sw_desc *sw_ring,
156                                 unsigned int txq_entries);
157 int sfc_efx_tso_do(struct sfc_efx_txq *txq, unsigned int idx,
158                    struct rte_mbuf **in_seg, size_t *in_off, efx_desc_t **pend,
159                    unsigned int *pkt_descs, size_t *pkt_len);
160
161 #ifdef __cplusplus
162 }
163 #endif
164 #endif  /* _SFC_TX_H */