New upstream version 18.02
[deb_dpdk.git] / drivers / net / sfc / base / siena_impl.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  *
3  * Copyright (c) 2009-2018 Solarflare Communications Inc.
4  * All rights reserved.
5  */
6
7 #ifndef _SYS_SIENA_IMPL_H
8 #define _SYS_SIENA_IMPL_H
9
10 #include "efx.h"
11 #include "efx_regs.h"
12 #include "efx_mcdi.h"
13 #include "siena_flash.h"
14
15 #ifdef  __cplusplus
16 extern "C" {
17 #endif
18
19 #ifndef EFX_TXQ_DC_SIZE
20 #define EFX_TXQ_DC_SIZE 1 /* 16 descriptors */
21 #endif
22 #ifndef EFX_RXQ_DC_SIZE
23 #define EFX_RXQ_DC_SIZE 3 /* 64 descriptors */
24 #endif
25 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << (_dcsize))
26
27 #define SIENA_NVRAM_CHUNK 0x80
28
29
30 extern  __checkReturn   efx_rc_t
31 siena_nic_probe(
32         __in            efx_nic_t *enp);
33
34 extern  __checkReturn   efx_rc_t
35 siena_nic_reset(
36         __in            efx_nic_t *enp);
37
38 extern  __checkReturn   efx_rc_t
39 siena_nic_init(
40         __in            efx_nic_t *enp);
41
42 #if EFSYS_OPT_DIAG
43
44 extern  efx_sram_pattern_fn_t   __efx_sram_pattern_fns[];
45
46 typedef struct siena_register_set_s {
47         unsigned int            address;
48         unsigned int            step;
49         unsigned int            rows;
50         efx_oword_t             mask;
51 } siena_register_set_t;
52
53 extern  __checkReturn   efx_rc_t
54 siena_nic_register_test(
55         __in            efx_nic_t *enp);
56
57 #endif  /* EFSYS_OPT_DIAG */
58
59 extern                  void
60 siena_nic_fini(
61         __in            efx_nic_t *enp);
62
63 extern                  void
64 siena_nic_unprobe(
65         __in            efx_nic_t *enp);
66
67 #define SIENA_SRAM_ROWS 0x12000
68
69 extern                  void
70 siena_sram_init(
71         __in            efx_nic_t *enp);
72
73 #if EFSYS_OPT_DIAG
74
75 extern  __checkReturn   efx_rc_t
76 siena_sram_test(
77         __in            efx_nic_t *enp,
78         __in            efx_sram_pattern_fn_t func);
79
80 #endif  /* EFSYS_OPT_DIAG */
81
82 #if EFSYS_OPT_MCDI
83
84 extern  __checkReturn   efx_rc_t
85 siena_mcdi_init(
86         __in            efx_nic_t *enp,
87         __in            const efx_mcdi_transport_t *mtp);
88
89 extern                  void
90 siena_mcdi_send_request(
91         __in                    efx_nic_t *enp,
92         __in_bcount(hdr_len)    void *hdrp,
93         __in                    size_t hdr_len,
94         __in_bcount(sdu_len)    void *sdup,
95         __in                    size_t sdu_len);
96
97 extern  __checkReturn   boolean_t
98 siena_mcdi_poll_response(
99         __in            efx_nic_t *enp);
100
101 extern                  void
102 siena_mcdi_read_response(
103         __in                    efx_nic_t *enp,
104         __out_bcount(length)    void *bufferp,
105         __in                    size_t offset,
106         __in                    size_t length);
107
108 extern                  efx_rc_t
109 siena_mcdi_poll_reboot(
110         __in            efx_nic_t *enp);
111
112 extern                  void
113 siena_mcdi_fini(
114         __in            efx_nic_t *enp);
115
116 extern  __checkReturn   efx_rc_t
117 siena_mcdi_feature_supported(
118         __in            efx_nic_t *enp,
119         __in            efx_mcdi_feature_id_t id,
120         __out           boolean_t *supportedp);
121
122 extern                  void
123 siena_mcdi_get_timeout(
124         __in            efx_nic_t *enp,
125         __in            efx_mcdi_req_t *emrp,
126         __out           uint32_t *timeoutp);
127
128 #endif /* EFSYS_OPT_MCDI */
129
130 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
131
132 extern  __checkReturn           efx_rc_t
133 siena_nvram_partn_lock(
134         __in                    efx_nic_t *enp,
135         __in                    uint32_t partn);
136
137 extern  __checkReturn           efx_rc_t
138 siena_nvram_partn_unlock(
139         __in                    efx_nic_t *enp,
140         __in                    uint32_t partn,
141         __out_opt               uint32_t *verify_resultp);
142
143 extern  __checkReturn           efx_rc_t
144 siena_nvram_get_dynamic_cfg(
145         __in                    efx_nic_t *enp,
146         __in                    uint32_t partn,
147         __in                    boolean_t vpd,
148         __out                   siena_mc_dynamic_config_hdr_t **dcfgp,
149         __out                   size_t *sizep);
150
151 #endif  /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
152
153 #if EFSYS_OPT_NVRAM
154
155 #if EFSYS_OPT_DIAG
156
157 extern  __checkReturn           efx_rc_t
158 siena_nvram_test(
159         __in                    efx_nic_t *enp);
160
161 #endif  /* EFSYS_OPT_DIAG */
162
163 extern  __checkReturn           efx_rc_t
164 siena_nvram_get_subtype(
165         __in                    efx_nic_t *enp,
166         __in                    uint32_t partn,
167         __out                   uint32_t *subtypep);
168
169 extern  __checkReturn           efx_rc_t
170 siena_nvram_type_to_partn(
171         __in                    efx_nic_t *enp,
172         __in                    efx_nvram_type_t type,
173         __out                   uint32_t *partnp);
174
175 extern  __checkReturn           efx_rc_t
176 siena_nvram_partn_size(
177         __in                    efx_nic_t *enp,
178         __in                    uint32_t partn,
179         __out                   size_t *sizep);
180
181 extern  __checkReturn           efx_rc_t
182 siena_nvram_partn_rw_start(
183         __in                    efx_nic_t *enp,
184         __in                    uint32_t partn,
185         __out                   size_t *chunk_sizep);
186
187 extern  __checkReturn           efx_rc_t
188 siena_nvram_partn_read(
189         __in                    efx_nic_t *enp,
190         __in                    uint32_t partn,
191         __in                    unsigned int offset,
192         __out_bcount(size)      caddr_t data,
193         __in                    size_t size);
194
195 extern  __checkReturn           efx_rc_t
196 siena_nvram_partn_erase(
197         __in                    efx_nic_t *enp,
198         __in                    uint32_t partn,
199         __in                    unsigned int offset,
200         __in                    size_t size);
201
202 extern  __checkReturn           efx_rc_t
203 siena_nvram_partn_write(
204         __in                    efx_nic_t *enp,
205         __in                    uint32_t partn,
206         __in                    unsigned int offset,
207         __out_bcount(size)      caddr_t data,
208         __in                    size_t size);
209
210 extern  __checkReturn           efx_rc_t
211 siena_nvram_partn_rw_finish(
212         __in                    efx_nic_t *enp,
213         __in                    uint32_t partn,
214         __out_opt               uint32_t *verify_resultp);
215
216 extern  __checkReturn           efx_rc_t
217 siena_nvram_partn_get_version(
218         __in                    efx_nic_t *enp,
219         __in                    uint32_t partn,
220         __out                   uint32_t *subtypep,
221         __out_ecount(4)         uint16_t version[4]);
222
223 extern  __checkReturn           efx_rc_t
224 siena_nvram_partn_set_version(
225         __in                    efx_nic_t *enp,
226         __in                    uint32_t partn,
227         __in_ecount(4)          uint16_t version[4]);
228
229 #endif  /* EFSYS_OPT_NVRAM */
230
231 #if EFSYS_OPT_VPD
232
233 extern  __checkReturn           efx_rc_t
234 siena_vpd_init(
235         __in                    efx_nic_t *enp);
236
237 extern  __checkReturn           efx_rc_t
238 siena_vpd_size(
239         __in                    efx_nic_t *enp,
240         __out                   size_t *sizep);
241
242 extern  __checkReturn           efx_rc_t
243 siena_vpd_read(
244         __in                    efx_nic_t *enp,
245         __out_bcount(size)      caddr_t data,
246         __in                    size_t size);
247
248 extern  __checkReturn           efx_rc_t
249 siena_vpd_verify(
250         __in                    efx_nic_t *enp,
251         __in_bcount(size)       caddr_t data,
252         __in                    size_t size);
253
254 extern  __checkReturn           efx_rc_t
255 siena_vpd_reinit(
256         __in                    efx_nic_t *enp,
257         __in_bcount(size)       caddr_t data,
258         __in                    size_t size);
259
260 extern  __checkReturn           efx_rc_t
261 siena_vpd_get(
262         __in                    efx_nic_t *enp,
263         __in_bcount(size)       caddr_t data,
264         __in                    size_t size,
265         __inout                 efx_vpd_value_t *evvp);
266
267 extern  __checkReturn           efx_rc_t
268 siena_vpd_set(
269         __in                    efx_nic_t *enp,
270         __in_bcount(size)       caddr_t data,
271         __in                    size_t size,
272         __in                    efx_vpd_value_t *evvp);
273
274 extern  __checkReturn           efx_rc_t
275 siena_vpd_next(
276         __in                    efx_nic_t *enp,
277         __in_bcount(size)       caddr_t data,
278         __in                    size_t size,
279         __out                   efx_vpd_value_t *evvp,
280         __inout                 unsigned int *contp);
281
282 extern __checkReturn            efx_rc_t
283 siena_vpd_write(
284         __in                    efx_nic_t *enp,
285         __in_bcount(size)       caddr_t data,
286         __in                    size_t size);
287
288 extern                          void
289 siena_vpd_fini(
290         __in                    efx_nic_t *enp);
291
292 #endif  /* EFSYS_OPT_VPD */
293
294 typedef struct siena_link_state_s {
295         uint32_t                sls_adv_cap_mask;
296         uint32_t                sls_lp_cap_mask;
297         unsigned int            sls_fcntl;
298         efx_link_mode_t         sls_link_mode;
299 #if EFSYS_OPT_LOOPBACK
300         efx_loopback_type_t     sls_loopback;
301 #endif
302         boolean_t               sls_mac_up;
303 } siena_link_state_t;
304
305 extern                  void
306 siena_phy_link_ev(
307         __in            efx_nic_t *enp,
308         __in            efx_qword_t *eqp,
309         __out           efx_link_mode_t *link_modep);
310
311 extern  __checkReturn   efx_rc_t
312 siena_phy_get_link(
313         __in            efx_nic_t *enp,
314         __out           siena_link_state_t *slsp);
315
316 extern  __checkReturn   efx_rc_t
317 siena_phy_power(
318         __in            efx_nic_t *enp,
319         __in            boolean_t on);
320
321 extern  __checkReturn   efx_rc_t
322 siena_phy_reconfigure(
323         __in            efx_nic_t *enp);
324
325 extern  __checkReturn   efx_rc_t
326 siena_phy_verify(
327         __in            efx_nic_t *enp);
328
329 extern  __checkReturn   efx_rc_t
330 siena_phy_oui_get(
331         __in            efx_nic_t *enp,
332         __out           uint32_t *ouip);
333
334 #if EFSYS_OPT_PHY_STATS
335
336 extern                                          void
337 siena_phy_decode_stats(
338         __in                                    efx_nic_t *enp,
339         __in                                    uint32_t vmask,
340         __in_opt                                efsys_mem_t *esmp,
341         __out_opt                               uint64_t *smaskp,
342         __inout_ecount_opt(EFX_PHY_NSTATS)      uint32_t *stat);
343
344 extern  __checkReturn                   efx_rc_t
345 siena_phy_stats_update(
346         __in                            efx_nic_t *enp,
347         __in                            efsys_mem_t *esmp,
348         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
349
350 #endif  /* EFSYS_OPT_PHY_STATS */
351
352 #if EFSYS_OPT_BIST
353
354 extern  __checkReturn           efx_rc_t
355 siena_phy_bist_start(
356         __in                    efx_nic_t *enp,
357         __in                    efx_bist_type_t type);
358
359 extern  __checkReturn           efx_rc_t
360 siena_phy_bist_poll(
361         __in                    efx_nic_t *enp,
362         __in                    efx_bist_type_t type,
363         __out                   efx_bist_result_t *resultp,
364         __out_opt __drv_when(count > 0, __notnull)
365         uint32_t        *value_maskp,
366         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
367         unsigned long   *valuesp,
368         __in                    size_t count);
369
370 extern                          void
371 siena_phy_bist_stop(
372         __in                    efx_nic_t *enp,
373         __in                    efx_bist_type_t type);
374
375 #endif  /* EFSYS_OPT_BIST */
376
377 extern  __checkReturn   efx_rc_t
378 siena_mac_poll(
379         __in            efx_nic_t *enp,
380         __out           efx_link_mode_t *link_modep);
381
382 extern  __checkReturn   efx_rc_t
383 siena_mac_up(
384         __in            efx_nic_t *enp,
385         __out           boolean_t *mac_upp);
386
387 extern  __checkReturn   efx_rc_t
388 siena_mac_reconfigure(
389         __in    efx_nic_t *enp);
390
391 extern  __checkReturn   efx_rc_t
392 siena_mac_pdu_get(
393         __in    efx_nic_t *enp,
394         __out   size_t *pdu);
395
396 #if EFSYS_OPT_LOOPBACK
397
398 extern  __checkReturn   efx_rc_t
399 siena_mac_loopback_set(
400         __in            efx_nic_t *enp,
401         __in            efx_link_mode_t link_mode,
402         __in            efx_loopback_type_t loopback_type);
403
404 #endif  /* EFSYS_OPT_LOOPBACK */
405
406 #if EFSYS_OPT_MAC_STATS
407
408 extern  __checkReturn                   efx_rc_t
409 siena_mac_stats_get_mask(
410         __in                            efx_nic_t *enp,
411         __inout_bcount(mask_size)       uint32_t *maskp,
412         __in                            size_t mask_size);
413
414 extern  __checkReturn                   efx_rc_t
415 siena_mac_stats_update(
416         __in                            efx_nic_t *enp,
417         __in                            efsys_mem_t *esmp,
418         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
419         __inout_opt                     uint32_t *generationp);
420
421 #endif  /* EFSYS_OPT_MAC_STATS */
422
423 #ifdef  __cplusplus
424 }
425 #endif
426
427 #endif  /* _SYS_SIENA_IMPL_H */