1/*
2 * Copyright (c) 2017-2018 Cavium, Inc.
3 * All rights reserved.
4 *
5 *  Redistribution and use in source and binary forms, with or without
6 *  modification, are permitted provided that the following conditions
7 *  are met:
8 *
9 *  1. Redistributions of source code must retain the above copyright
10 *     notice, this list of conditions and the following disclaimer.
11 *  2. Redistributions in binary form must reproduce the above copyright
12 *     notice, this list of conditions and the following disclaimer in the
13 *     documentation and/or other materials provided with the distribution.
14 *
15 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 *  POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD: stable/11/sys/dev/qlnx/qlnxe/ecore_hsi_init_func.h 337517 2018-08-09 01:17:35Z davidcs $
28 *
29 */
30
31#ifndef __ECORE_HSI_INIT_FUNC__
32#define __ECORE_HSI_INIT_FUNC__
33/********************************/
34/* HSI Init Functions constants */
35/********************************/
36
37/* Number of VLAN priorities */
38#define NUM_OF_VLAN_PRIORITIES			8
39
40/* Size of CRC8 lookup table */
41#ifndef LINUX_REMOVE
42#define CRC8_TABLE_SIZE					256
43#endif
44
45/*
46 * BRB RAM init requirements
47 */
48struct init_brb_ram_req
49{
50	u32 guranteed_per_tc /* guaranteed size per TC, in bytes */;
51	u32 headroom_per_tc /* headroom size per TC, in bytes */;
52	u32 min_pkt_size /* min packet size, in bytes */;
53	u32 max_ports_per_engine /* min packet size, in bytes */;
54	u8 num_active_tcs[MAX_NUM_PORTS] /* number of active TCs per port */;
55};
56
57
58/*
59 * ETS per-TC init requirements
60 */
61struct init_ets_tc_req
62{
63	u8 use_sp /* if set, this TC participates in the arbitration with a strict priority (the priority is equal to the TC ID) */;
64	u8 use_wfq /* if set, this TC participates in the arbitration with a WFQ weight (indicated by the weight field) */;
65	u16 weight /* An arbitration weight. Valid only if use_wfq is set. */;
66};
67
68/*
69 * ETS init requirements
70 */
71struct init_ets_req
72{
73	u32 mtu /* Max packet size (in bytes) */;
74	struct init_ets_tc_req tc_req[NUM_OF_TCS] /* ETS initialization requirements per TC. */;
75};
76
77
78
79/*
80 * NIG LB RL init requirements
81 */
82struct init_nig_lb_rl_req
83{
84	u16 lb_mac_rate /* Global MAC+LB RL rate (in Mbps). If set to 0, the RL will be disabled. */;
85	u16 lb_rate /* Global LB RL rate (in Mbps). If set to 0, the RL will be disabled. */;
86	u32 mtu /* Max packet size (in bytes) */;
87	u16 tc_rate[NUM_OF_PHYS_TCS] /* RL rate per physical TC (in Mbps). If set to 0, the RL will be disabled. */;
88};
89
90
91/*
92 * NIG TC mapping for each priority
93 */
94struct init_nig_pri_tc_map_entry
95{
96	u8 tc_id /* the mapped TC ID */;
97	u8 valid /* indicates if the mapping entry is valid */;
98};
99
100
101/*
102 * NIG priority to TC map init requirements
103 */
104struct init_nig_pri_tc_map_req
105{
106	struct init_nig_pri_tc_map_entry pri[NUM_OF_VLAN_PRIORITIES];
107};
108
109
110/*
111 * QM per-port init parameters
112 */
113struct init_qm_port_params
114{
115	u8 active /* Indicates if this port is active */;
116	u8 active_phys_tcs /* Vector of valid bits for active TCs used by this port */;
117	u16 num_pbf_cmd_lines /* number of PBF command lines that can be used by this port */;
118	u16 num_btb_blocks /* number of BTB blocks that can be used by this port */;
119	u16 reserved;
120};
121
122
123/*
124 * QM per-PQ init parameters
125 */
126struct init_qm_pq_params
127{
128	u8 vport_id /* VPORT ID */;
129	u8 tc_id /* TC ID */;
130	u8 wrr_group /* WRR group */;
131	u8 rl_valid /* Indicates if a rate limiter should be allocated for the PQ (0/1) */;
132};
133
134
135/*
136 * QM per-vport init parameters
137 */
138struct init_qm_vport_params
139{
140	u32 vport_rl /* rate limit in Mb/sec units. a value of 0 means dont configure. ignored if VPORT RL is globally disabled. */;
141	u16 vport_wfq /* WFQ weight. A value of 0 means dont configure. ignored if VPORT WFQ is globally disabled. */;
142	u16 first_tx_pq_id[NUM_OF_TCS] /* the first Tx PQ ID associated with this VPORT for each TC. */;
143};
144
145#endif /* __ECORE_HSI_INIT_FUNC__ */
146