mk: optimize directory dependencies
[dpdk.git] / drivers / net / sfc / sfc_tx.h
1 /*-
2  * Copyright (c) 2016 Solarflare Communications Inc.
3  * All rights reserved.
4  *
5  * This software was jointly developed between OKTET Labs (under contract
6  * for Solarflare) and Solarflare Communications, Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  *    this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  *    this list of conditions and the following disclaimer in the documentation
15  *    and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef _SFC_TX_H
31 #define _SFC_TX_H
32
33 #include <rte_mbuf.h>
34 #include <rte_ethdev.h>
35
36 #include "efx.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /**
43  * A segment must not cross 4K boundary
44  * (this is a requirement of NIC TX descriptors)
45  */
46 #define SFC_TX_SEG_BOUNDARY     4096
47
48 struct sfc_adapter;
49 struct sfc_evq;
50
51 struct sfc_tx_sw_desc {
52         struct rte_mbuf         *mbuf;
53         uint8_t                 *tsoh;  /* Buffer to store TSO header */
54 };
55
56 enum sfc_txq_state_bit {
57         SFC_TXQ_INITIALIZED_BIT = 0,
58 #define SFC_TXQ_INITIALIZED     (1 << SFC_TXQ_INITIALIZED_BIT)
59         SFC_TXQ_STARTED_BIT,
60 #define SFC_TXQ_STARTED         (1 << SFC_TXQ_STARTED_BIT)
61         SFC_TXQ_RUNNING_BIT,
62 #define SFC_TXQ_RUNNING         (1 << SFC_TXQ_RUNNING_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 struct sfc_txq {
70         struct sfc_evq          *evq;
71         struct sfc_tx_sw_desc   *sw_ring;
72         unsigned int            state;
73         unsigned int            ptr_mask;
74         efx_desc_t              *pend_desc;
75         efx_txq_t               *common;
76         efsys_mem_t             mem;
77         unsigned int            added;
78         unsigned int            pending;
79         unsigned int            completed;
80         unsigned int            free_thresh;
81         uint16_t                hw_vlan_tci;
82
83         unsigned int            hw_index;
84         unsigned int            flags;
85 };
86
87 static inline unsigned int
88 sfc_txq_sw_index(const struct sfc_txq *txq)
89 {
90         return txq->hw_index;
91 }
92
93 struct sfc_txq_info {
94         unsigned int            entries;
95         struct sfc_txq          *txq;
96         boolean_t               deferred_start;
97         boolean_t               deferred_started;
98 };
99
100 int sfc_tx_init(struct sfc_adapter *sa);
101 void sfc_tx_fini(struct sfc_adapter *sa);
102
103 int sfc_tx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
104                  uint16_t nb_tx_desc, unsigned int socket_id,
105                  const struct rte_eth_txconf *tx_conf);
106 void sfc_tx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
107
108 void sfc_tx_qflush_done(struct sfc_txq *txq);
109 int sfc_tx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
110 void sfc_tx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
111 int sfc_tx_start(struct sfc_adapter *sa);
112 void sfc_tx_stop(struct sfc_adapter *sa);
113
114 uint16_t sfc_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
115                        uint16_t nb_pkts);
116
117 /* From 'sfc_tso.c' */
118 int sfc_tso_alloc_tsoh_objs(struct sfc_tx_sw_desc *sw_ring,
119                             unsigned int txq_entries, unsigned int socket_id);
120 void sfc_tso_free_tsoh_objs(struct sfc_tx_sw_desc *sw_ring,
121                             unsigned int txq_entries);
122 int sfc_tso_do(struct sfc_txq *txq, unsigned int idx, struct rte_mbuf **in_seg,
123                size_t *in_off, efx_desc_t **pend, unsigned int *pkt_descs,
124                size_t *pkt_len);
125
126 #ifdef __cplusplus
127 }
128 #endif
129 #endif  /* _SFC_TX_H */