New upstream version 18.02
[deb_dpdk.git] / drivers / net / ark / ark_rqp.h
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright (c) 2015-2017 Atomic Rules LLC
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _ARK_RQP_H_
35 #define _ARK_RQP_H_
36
37 #include <stdint.h>
38
39 #include <rte_memory.h>
40
41 /* The RQP or ReQuest Pacer is an internal Arkville hardware module
42  * which limits the PCIE data flow to insure correct operation for the
43  * particular hardware PCIE endpoint.
44  * This module is *not* intended for end-user manipulation, hence
45  * there is minimal documentation.
46  */
47
48 /*
49  * RQ Pacing core hardware structure
50  * This is an overlay structures to a memory mapped FPGA device.  These
51  * structs will never be instantiated in ram memory
52  */
53 struct ark_rqpace_t {
54         volatile uint32_t ctrl;
55         volatile uint32_t stats_clear;
56         volatile uint32_t cplh_max;
57         volatile uint32_t cpld_max;
58         volatile uint32_t err_cnt;
59         volatile uint32_t stall_ps;
60         volatile uint32_t stall_ps_min;
61         volatile uint32_t stall_ps_max;
62         volatile uint32_t req_ps;
63         volatile uint32_t req_ps_min;
64         volatile uint32_t req_ps_max;
65         volatile uint32_t req_dw_ps;
66         volatile uint32_t req_dw_ps_min;
67         volatile uint32_t req_dw_ps_max;
68         volatile uint32_t cpl_ps;
69         volatile uint32_t cpl_ps_min;
70         volatile uint32_t cpl_ps_max;
71         volatile uint32_t cpl_dw_ps;
72         volatile uint32_t cpl_dw_ps_min;
73         volatile uint32_t cpl_dw_ps_max;
74         volatile uint32_t cplh_pending;
75         volatile uint32_t cpld_pending;
76         volatile uint32_t cplh_pending_max;
77         volatile uint32_t cpld_pending_max;
78         volatile uint32_t err_count_other;
79         char eval[4];
80         volatile int lasped;
81 };
82
83 void ark_rqp_dump(struct ark_rqpace_t *rqp);
84 void ark_rqp_stats_reset(struct ark_rqpace_t *rqp);
85 int ark_rqp_lasped(struct ark_rqpace_t *rqp);
86 #endif