net/sfc: implement transmit path start / stop
[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 struct sfc_adapter;
43 struct sfc_evq;
44
45 struct sfc_tx_sw_desc {
46         struct rte_mbuf         *mbuf;
47 };
48
49 enum sfc_txq_state_bit {
50         SFC_TXQ_INITIALIZED_BIT = 0,
51 #define SFC_TXQ_INITIALIZED     (1 << SFC_TXQ_INITIALIZED_BIT)
52         SFC_TXQ_STARTED_BIT,
53 #define SFC_TXQ_STARTED         (1 << SFC_TXQ_STARTED_BIT)
54         SFC_TXQ_RUNNING_BIT,
55 #define SFC_TXQ_RUNNING         (1 << SFC_TXQ_RUNNING_BIT)
56         SFC_TXQ_FLUSHING_BIT,
57 #define SFC_TXQ_FLUSHING        (1 << SFC_TXQ_FLUSHING_BIT)
58         SFC_TXQ_FLUSHED_BIT,
59 #define SFC_TXQ_FLUSHED         (1 << SFC_TXQ_FLUSHED_BIT)
60 };
61
62 struct sfc_txq {
63         struct sfc_evq          *evq;
64         struct sfc_tx_sw_desc   *sw_ring;
65         unsigned int            state;
66         unsigned int            ptr_mask;
67         efx_desc_t              *pend_desc;
68         efx_txq_t               *common;
69         efsys_mem_t             mem;
70         unsigned int            added;
71         unsigned int            pending;
72         unsigned int            completed;
73
74         unsigned int            hw_index;
75         unsigned int            flags;
76 };
77
78 static inline unsigned int
79 sfc_txq_sw_index(const struct sfc_txq *txq)
80 {
81         return txq->hw_index;
82 }
83
84 struct sfc_txq_info {
85         unsigned int            entries;
86         struct sfc_txq          *txq;
87 };
88
89 int sfc_tx_init(struct sfc_adapter *sa);
90 void sfc_tx_fini(struct sfc_adapter *sa);
91
92 int sfc_tx_qinit(struct sfc_adapter *sa, unsigned int sw_index,
93                  uint16_t nb_tx_desc, unsigned int socket_id,
94                  const struct rte_eth_txconf *tx_conf);
95 void sfc_tx_qfini(struct sfc_adapter *sa, unsigned int sw_index);
96
97 void sfc_tx_qflush_done(struct sfc_txq *txq);
98 int sfc_tx_qstart(struct sfc_adapter *sa, unsigned int sw_index);
99 void sfc_tx_qstop(struct sfc_adapter *sa, unsigned int sw_index);
100 int sfc_tx_start(struct sfc_adapter *sa);
101 void sfc_tx_stop(struct sfc_adapter *sa);
102
103 #ifdef __cplusplus
104 }
105 #endif
106 #endif  /* _SFC_TX_H */