xref: /freebsd/sys/dev/bxe/ecore_mfw_req.h (revision 685dc743dc3b5645e34836464128e1c0558b404b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2007-2017 QLogic Corporation. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  * THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 #ifndef ECORE_MFW_REQ_H
31 #define ECORE_MFW_REQ_H
32 
33 
34 
35 #define PORT_0              0
36 #define PORT_1              1
37 #define PORT_MAX            2
38 #define NVM_PATH_MAX        2
39 
40 /* FCoE capabilities required from the driver */
41 struct fcoe_capabilities {
42 	uint32_t capability1;
43 	/* Maximum number of I/Os per connection */
44 	#define FCOE_IOS_PER_CONNECTION_MASK    0x0000ffff
45 	#define FCOE_IOS_PER_CONNECTION_SHIFT   0
46 	/* Maximum number of Logins per port */
47 	#define FCOE_LOGINS_PER_PORT_MASK       0xffff0000
48 	#define FCOE_LOGINS_PER_PORT_SHIFT   16
49 
50 	uint32_t capability2;
51 	/* Maximum number of exchanges */
52 	#define FCOE_NUMBER_OF_EXCHANGES_MASK   0x0000ffff
53 	#define FCOE_NUMBER_OF_EXCHANGES_SHIFT  0
54 	/* Maximum NPIV WWN per port */
55 	#define FCOE_NPIV_WWN_PER_PORT_MASK     0xffff0000
56 	#define FCOE_NPIV_WWN_PER_PORT_SHIFT    16
57 
58 	uint32_t capability3;
59 	/* Maximum number of targets supported */
60 	#define FCOE_TARGETS_SUPPORTED_MASK     0x0000ffff
61 	#define FCOE_TARGETS_SUPPORTED_SHIFT    0
62 	/* Maximum number of outstanding commands across all connections */
63 	#define FCOE_OUTSTANDING_COMMANDS_MASK  0xffff0000
64 	#define FCOE_OUTSTANDING_COMMANDS_SHIFT 16
65 
66 	uint32_t capability4;
67 	#define FCOE_CAPABILITY4_STATEFUL       		0x00000001
68 	#define FCOE_CAPABILITY4_STATELESS      		0x00000002
69 	#define FCOE_CAPABILITY4_CAPABILITIES_REPORTED_VALID   	0x00000004
70 };
71 
72 struct glob_ncsi_oem_data
73 {
74 	uint32_t driver_version;
75 	uint32_t unused[3];
76 	struct fcoe_capabilities fcoe_features[NVM_PATH_MAX][PORT_MAX];
77 };
78 
79 /* current drv_info version */
80 #define DRV_INFO_CUR_VER 2
81 
82 /* drv_info op codes supported */
83 enum drv_info_opcode {
84 	ETH_STATS_OPCODE,
85 	FCOE_STATS_OPCODE,
86 	ISCSI_STATS_OPCODE
87 };
88 
89 #define ETH_STAT_INFO_VERSION_LEN	12
90 /*  Per PCI Function Ethernet Statistics required from the driver */
91 struct eth_stats_info {
92 	/* Function's Driver Version. padded to 12 */
93 	uint8_t version[ETH_STAT_INFO_VERSION_LEN];
94 	/* Locally Admin Addr. BigEndian EIU48. Actual size is 6 bytes */
95 	uint8_t mac_local[8];
96 	uint8_t mac_add1[8];		/* Additional Programmed MAC Addr 1. */
97 	uint8_t mac_add2[8];		/* Additional Programmed MAC Addr 2. */
98 	uint32_t mtu_size;		/* MTU Size. Note   : Negotiated MTU */
99 	uint32_t feature_flags;	/* Feature_Flags. */
100 #define FEATURE_ETH_CHKSUM_OFFLOAD_MASK		0x01
101 #define FEATURE_ETH_LSO_MASK			0x02
102 #define FEATURE_ETH_BOOTMODE_MASK		0x1C
103 #define FEATURE_ETH_BOOTMODE_SHIFT		2
104 #define FEATURE_ETH_BOOTMODE_NONE		(0x0 << 2)
105 #define FEATURE_ETH_BOOTMODE_PXE		(0x1 << 2)
106 #define FEATURE_ETH_BOOTMODE_ISCSI		(0x2 << 2)
107 #define FEATURE_ETH_BOOTMODE_FCOE		(0x3 << 2)
108 #define FEATURE_ETH_TOE_MASK			0x20
109 	uint32_t lso_max_size;	/* LSO MaxOffloadSize. */
110 	uint32_t lso_min_seg_cnt;	/* LSO MinSegmentCount. */
111 	/* Num Offloaded Connections TCP_IPv4. */
112 	uint32_t ipv4_ofld_cnt;
113 	/* Num Offloaded Connections TCP_IPv6. */
114 	uint32_t ipv6_ofld_cnt;
115 	uint32_t promiscuous_mode;	/* Promiscuous Mode. non-zero true */
116 	uint32_t txq_size;		/* TX Descriptors Queue Size */
117 	uint32_t rxq_size;		/* RX Descriptors Queue Size */
118 	/* TX Descriptor Queue Avg Depth. % Avg Queue Depth since last poll */
119 	uint32_t txq_avg_depth;
120 	/* RX Descriptors Queue Avg Depth. % Avg Queue Depth since last poll */
121 	uint32_t rxq_avg_depth;
122 	/* IOV_Offload. 0=none; 1=MultiQueue, 2=VEB 3= VEPA*/
123 	uint32_t iov_offload;
124 	/* Number of NetQueue/VMQ Config'd. */
125 	uint32_t netq_cnt;
126 	uint32_t vf_cnt;		/* Num VF assigned to this PF. */
127 };
128 
129 /*  Per PCI Function FCOE Statistics required from the driver */
130 struct fcoe_stats_info {
131 	uint8_t version[12];		/* Function's Driver Version. */
132 	uint8_t mac_local[8];	/* Locally Admin Addr. */
133 	uint8_t mac_add1[8];		/* Additional Programmed MAC Addr 1. */
134 	uint8_t mac_add2[8];		/* Additional Programmed MAC Addr 2. */
135 	/* QoS Priority (per 802.1p). 0-7255 */
136 	uint32_t qos_priority;
137 	uint32_t txq_size;		/* FCoE TX Descriptors Queue Size. */
138 	uint32_t rxq_size;		/* FCoE RX Descriptors Queue Size. */
139 	/* FCoE TX Descriptor Queue Avg Depth. */
140 	uint32_t txq_avg_depth;
141 	/* FCoE RX Descriptors Queue Avg Depth. */
142 	uint32_t rxq_avg_depth;
143 	uint32_t rx_frames_lo;	/* FCoE RX Frames received. */
144 	uint32_t rx_frames_hi;	/* FCoE RX Frames received. */
145 	uint32_t rx_bytes_lo;	/* FCoE RX Bytes received. */
146 	uint32_t rx_bytes_hi;	/* FCoE RX Bytes received. */
147 	uint32_t tx_frames_lo;	/* FCoE TX Frames sent. */
148 	uint32_t tx_frames_hi;	/* FCoE TX Frames sent. */
149 	uint32_t tx_bytes_lo;	/* FCoE TX Bytes sent. */
150 	uint32_t tx_bytes_hi;	/* FCoE TX Bytes sent. */
151 	uint32_t rx_fcs_errors;	/* number of receive packets with FCS errors */
152 	uint32_t rx_fc_crc_errors;	/* number of FC frames with CRC errors*/
153 	uint32_t fip_login_failures;	/* number of FCoE/FIP Login failures */
154 };
155 
156 /* Per PCI  Function iSCSI Statistics required from the driver*/
157 struct iscsi_stats_info {
158 	uint8_t version[12];		/* Function's Driver Version. */
159 	uint8_t mac_local[8];	/* Locally Admin iSCSI MAC Addr. */
160 	uint8_t mac_add1[8];		/* Additional Programmed MAC Addr 1. */
161 	/* QoS Priority (per 802.1p). 0-7255 */
162 	uint32_t qos_priority;
163 
164 	uint8_t initiator_name[64];	/* iSCSI Boot Initiator Node name. */
165 
166 	uint8_t ww_port_name[64];	/* iSCSI World wide port name */
167 
168 	uint8_t boot_target_name[64];/* iSCSI Boot Target Name. */
169 
170 	uint8_t boot_target_ip[16];	/* iSCSI Boot Target IP. */
171 	uint32_t boot_target_portal;	/* iSCSI Boot Target Portal. */
172 	uint8_t boot_init_ip[16];	/* iSCSI Boot Initiator IP Address. */
173 	uint32_t max_frame_size;	/* Max Frame Size. bytes */
174 	uint32_t txq_size;		/* PDU TX Descriptors Queue Size. */
175 	uint32_t rxq_size;		/* PDU RX Descriptors Queue Size. */
176 
177 	uint32_t txq_avg_depth;	/*PDU TX Descriptor Queue Avg Depth. */
178 	uint32_t rxq_avg_depth;	/*PDU RX Descriptors Queue Avg Depth. */
179 	uint32_t rx_pdus_lo;		/* iSCSI PDUs received. */
180 	uint32_t rx_pdus_hi;		/* iSCSI PDUs received. */
181 
182 	uint32_t rx_bytes_lo;	/* iSCSI RX Bytes received. */
183 	uint32_t rx_bytes_hi;	/* iSCSI RX Bytes received. */
184 	uint32_t tx_pdus_lo;		/* iSCSI PDUs sent. */
185 	uint32_t tx_pdus_hi;		/* iSCSI PDUs sent. */
186 
187 	uint32_t tx_bytes_lo;	/* iSCSI PDU TX Bytes sent. */
188 	uint32_t tx_bytes_hi;	/* iSCSI PDU TX Bytes sent. */
189 	uint32_t pcp_prior_map_tbl;	/*C-PCP to S-PCP Priority MapTable.
190 				9 nibbles, the position of each nibble
191 				represents the C-PCP value, the value
192 				of the nibble = S-PCP value.*/
193 };
194 
195 union drv_info_to_mcp {
196 	struct eth_stats_info		ether_stat;
197 	struct fcoe_stats_info		fcoe_stat;
198 	struct iscsi_stats_info		iscsi_stat;
199 };
200 
201 
202 #endif /* ECORE_MFW_REQ_H */
203 
204