net/sfc: implement Rx queue setup release operations
[dpdk.git] / drivers / net / sfc / sfc_ev.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_EV_H_
31 #define _SFC_EV_H_
32
33 #include "efx.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* Number of entries in the management event queue */
40 #define SFC_MGMT_EVQ_ENTRIES    (EFX_EVQ_MINNEVS)
41
42 struct sfc_adapter;
43 struct sfc_rxq;
44
45 enum sfc_evq_state {
46         SFC_EVQ_UNINITIALIZED = 0,
47         SFC_EVQ_INITIALIZED,
48         SFC_EVQ_STARTING,
49         SFC_EVQ_STARTED,
50
51         SFC_EVQ_NSTATES
52 };
53
54 struct sfc_evq {
55         /* Used on datapath */
56         efx_evq_t               *common;
57         unsigned int            read_ptr;
58         boolean_t               exception;
59         efsys_mem_t             mem;
60         struct sfc_rxq          *rxq;
61
62         /* Not used on datapath */
63         struct sfc_adapter      *sa;
64         unsigned int            evq_index;
65         enum sfc_evq_state      init_state;
66 };
67
68 struct sfc_evq_info {
69         /* Maximum number of EVQ entries taken into account when buffer
70          * table space is allocated.
71          */
72         unsigned int            max_entries;
73         /* Real number of EVQ entries, less or equal to max_entries */
74         unsigned int            entries;
75         /* NUMA-aware EVQ data structure used on datapath */
76         struct sfc_evq          *evq;
77 };
78
79 /*
80  * Functions below define event queue to transmit/receive queue and vice
81  * versa mapping.
82  */
83
84 static inline unsigned int
85 sfc_ev_qcount(struct sfc_adapter *sa)
86 {
87         const struct rte_eth_dev_data *dev_data = sa->eth_dev->data;
88
89         /*
90          * One management EVQ for global events.
91          * Own EVQ for each Tx and Rx queue.
92          */
93         return 1 + dev_data->nb_rx_queues + dev_data->nb_tx_queues;
94 }
95
96 static inline unsigned int
97 sfc_evq_max_entries(struct sfc_adapter *sa, unsigned int sw_index)
98 {
99         unsigned int max_entries;
100
101         if (sw_index == sa->mgmt_evq_index)
102                 max_entries = SFC_MGMT_EVQ_ENTRIES;
103         else if (sw_index <= sa->eth_dev->data->nb_rx_queues)
104                 max_entries = EFX_RXQ_MAXNDESCS;
105         else
106                 max_entries = efx_nic_cfg_get(sa->nic)->enc_txq_max_ndescs;
107
108         return max_entries;
109 }
110
111 static inline unsigned int
112 sfc_evq_index_by_rxq_sw_index(__rte_unused struct sfc_adapter *sa,
113                               unsigned int rxq_sw_index)
114 {
115         return 1 + rxq_sw_index;
116 }
117
118 static inline unsigned int
119 sfc_evq_index_by_txq_sw_index(struct sfc_adapter *sa, unsigned int txq_sw_index)
120 {
121         return 1 + sa->eth_dev->data->nb_rx_queues + txq_sw_index;
122 }
123
124 int sfc_ev_init(struct sfc_adapter *sa);
125 void sfc_ev_fini(struct sfc_adapter *sa);
126 int sfc_ev_start(struct sfc_adapter *sa);
127 void sfc_ev_stop(struct sfc_adapter *sa);
128
129 int sfc_ev_qinit(struct sfc_adapter *sa, unsigned int sw_index,
130                  unsigned int entries, int socket_id);
131 void sfc_ev_qfini(struct sfc_adapter *sa, unsigned int sw_index);
132 int sfc_ev_qstart(struct sfc_adapter *sa, unsigned int sw_index);
133 void sfc_ev_qstop(struct sfc_adapter *sa, unsigned int sw_index);
134
135 int sfc_ev_qprime(struct sfc_evq *evq);
136 void sfc_ev_qpoll(struct sfc_evq *evq);
137
138 void sfc_ev_mgmt_qpoll(struct sfc_adapter *sa);
139
140 #ifdef __cplusplus
141 }
142 #endif
143 #endif /* _SFC_EV_H_ */