net/sfc: add missing BSD license line and update year
[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 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct sfc_adapter;
45 struct sfc_evq;
46
47 struct sfc_tx_sw_desc {
48         struct rte_mbuf         *mbuf;
49         uint8_t                 *tsoh;  /* Buffer to store TSO header */
50 };
51
52 enum sfc_txq_state_bit {
53         SFC_TXQ_INITIALIZED_BIT = 0,
54 #define SFC_TXQ_INITIALIZED     (1 << SFC_TXQ_INITIALIZED_BIT)
55         SFC_TXQ_STARTED_BIT,
56 #define SFC_TXQ_STARTED         (1 << SFC_TXQ_STARTED_BIT)
57         SFC_TXQ_RUNNING_BIT,
58 #define SFC_TXQ_RUNNING         (1 << SFC_TXQ_RUNNING_BIT)
59         SFC_TXQ_FLUSHING_BIT,
60 #define SFC_TXQ_FLUSHING        (1 << SFC_TXQ_FLUSHING_BIT)
61         SFC_TXQ_FLUSHED_BIT,
62 #define SFC_TXQ_FLUSHED         (1 << SFC_TXQ_FLUSHED_BIT)
63 };
64
65 struct sfc_txq {
66         struct sfc_evq          *evq;
67         struct sfc_tx_sw_desc   *sw_ring;
68         unsigned int            state;
69         unsigned int            ptr_mask;
70         efx_desc_t              *pend_desc;
71         efx_txq_t               *common;
72         efsys_mem_t             mem;
73         unsigned int            added;
74         unsigned int            pending;
75         unsigned int            completed;
76         unsigned int            free_thresh;
77         uint16_t                hw_vlan_tci;
78         uint16_t                dma_desc_size_max;
79
80         unsigned int            hw_index;
81         unsigned int            flags;
82 };
83
84 static inline unsigned int
85 sfc_txq_sw_index(const struct sfc_txq *txq)
86 {
87         return txq->hw_index;
88 }
89
90 struct sfc_txq_info {
91         unsigned int            entries;
92         struct sfc_txq          *txq;
93         boolean_t               deferred_start;
94         boolean_t               deferred_started;
95 };
96
97 int sfc_tx_init(struct sfc_adapter *sa);
98 void sfc_tx_fini(struct sfc_adapter *sa);
99
100 int sfc_tx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
101                  uint16_t nb_tx_desc, unsigned int socket_id,
102                  const struct rte_eth_txconf *tx_conf);
103 void sfc_tx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
104
105 void sfc_tx_qflush_done(struct sfc_txq *txq);
106 int sfc_tx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
107 void sfc_tx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
108 int sfc_tx_start(struct sfc_adapter *sa);
109 void sfc_tx_stop(struct sfc_adapter *sa);
110
111 uint16_t sfc_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
112                        uint16_t nb_pkts);
113
114 /* From 'sfc_tso.c' */
115 int sfc_tso_alloc_tsoh_objs(struct sfc_tx_sw_desc *sw_ring,
116                             unsigned int txq_entries, unsigned int socket_id);
117 void sfc_tso_free_tsoh_objs(struct sfc_tx_sw_desc *sw_ring,
118                             unsigned int txq_entries);
119 int sfc_tso_do(struct sfc_txq *txq, unsigned int idx, struct rte_mbuf **in_seg,
120                size_t *in_off, efx_desc_t **pend, unsigned int *pkt_descs,
121                size_t *pkt_len);
122
123 #ifdef __cplusplus
124 }
125 #endif
126 #endif  /* _SFC_TX_H */