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