1 /*
2  * Copyright (C) 2015-2017 Netronome Systems, Inc.
3  *
4  * This software is dual licensed under the GNU General License Version 2,
5  * June 1991 as shown in the file COPYING in the top-level directory of this
6  * source tree or the BSD 2-Clause License provided below.  You have the
7  * option to license this software under the complete terms of either license.
8  *
9  * The BSD 2-Clause License:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      1. Redistributions of source code must retain the above
16  *         copyright notice, this list of conditions and the following
17  *         disclaimer.
18  *
19  *      2. Redistributions in binary form must reproduce the above
20  *         copyright notice, this list of conditions and the following
21  *         disclaimer in the documentation and/or other materials
22  *         provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 /*
35  * nfp_main.h
36  * Author: Jason McMullan <jason.mcmullan@netronome.com>
37  */
38 
39 #ifndef NFP_MAIN_H
40 #define NFP_MAIN_H
41 
42 #include <linux/ethtool.h>
43 #include <linux/list.h>
44 #include <linux/types.h>
45 #include <linux/msi.h>
46 #include <linux/mutex.h>
47 #include <linux/pci.h>
48 #include <linux/workqueue.h>
49 
50 struct dentry;
51 struct device;
52 struct devlink_ops;
53 struct pci_dev;
54 
55 struct nfp_cpp;
56 struct nfp_cpp_area;
57 struct nfp_eth_table;
58 struct nfp_hwinfo;
59 struct nfp_mip;
60 struct nfp_net;
61 struct nfp_nsp_identify;
62 struct nfp_port;
63 struct nfp_rtsym_table;
64 
65 /**
66  * struct nfp_dumpspec - NFP FW dump specification structure
67  * @size:	Size of the data
68  * @data:	Sequence of TLVs, each being an instruction to dump some data
69  *		from FW
70  */
71 struct nfp_dumpspec {
72 	u32 size;
73 	u8 data[0];
74 };
75 
76 /**
77  * struct nfp_pf - NFP PF-specific device structure
78  * @pdev:		Backpointer to PCI device
79  * @cpp:		Pointer to the CPP handle
80  * @app:		Pointer to the APP handle
81  * @data_vnic_bar:	Pointer to the CPP area for the data vNICs' BARs
82  * @ctrl_vnic_bar:	Pointer to the CPP area for the ctrl vNIC's BAR
83  * @qc_area:		Pointer to the CPP area for the queues
84  * @mac_stats_bar:	Pointer to the CPP area for the MAC stats
85  * @mac_stats_mem:	Pointer to mapped MAC stats area
86  * @vf_cfg_bar:		Pointer to the CPP area for the VF configuration BAR
87  * @vf_cfg_mem:		Pointer to mapped VF configuration area
88  * @vfcfg_tbl2_area:	Pointer to the CPP area for the VF config table
89  * @vfcfg_tbl2:		Pointer to mapped VF config table
90  * @irq_entries:	Array of MSI-X entries for all vNICs
91  * @limit_vfs:		Number of VFs supported by firmware (~0 for PCI limit)
92  * @num_vfs:		Number of SR-IOV VFs enabled
93  * @fw_loaded:		Is the firmware loaded?
94  * @ctrl_vnic:		Pointer to the control vNIC if available
95  * @mip:		MIP handle
96  * @rtbl:		RTsym table
97  * @hwinfo:		HWInfo table
98  * @dumpspec:		Debug dump specification
99  * @dump_flag:		Store dump flag between set_dump and get_dump_flag
100  * @dump_len:		Store dump length between set_dump and get_dump_flag
101  * @eth_tbl:		NSP ETH table
102  * @nspi:		NSP identification info
103  * @hwmon_dev:		pointer to hwmon device
104  * @ddir:		Per-device debugfs directory
105  * @max_data_vnics:	Number of data vNICs app firmware supports
106  * @num_vnics:		Number of vNICs spawned
107  * @vnics:		Linked list of vNIC structures (struct nfp_net)
108  * @ports:		Linked list of port structures (struct nfp_port)
109  * @wq:			Workqueue for running works which need to grab @lock
110  * @port_refresh_work:	Work entry for taking netdevs out
111  * @lock:		Protects all fields which may change after probe
112  */
113 struct nfp_pf {
114 	struct pci_dev *pdev;
115 
116 	struct nfp_cpp *cpp;
117 
118 	struct nfp_app *app;
119 
120 	struct nfp_cpp_area *data_vnic_bar;
121 	struct nfp_cpp_area *ctrl_vnic_bar;
122 	struct nfp_cpp_area *qc_area;
123 	struct nfp_cpp_area *mac_stats_bar;
124 	u8 __iomem *mac_stats_mem;
125 	struct nfp_cpp_area *vf_cfg_bar;
126 	u8 __iomem *vf_cfg_mem;
127 	struct nfp_cpp_area *vfcfg_tbl2_area;
128 	u8 __iomem *vfcfg_tbl2;
129 
130 	struct msix_entry *irq_entries;
131 
132 	unsigned int limit_vfs;
133 	unsigned int num_vfs;
134 
135 	bool fw_loaded;
136 
137 	struct nfp_net *ctrl_vnic;
138 
139 	const struct nfp_mip *mip;
140 	struct nfp_rtsym_table *rtbl;
141 	struct nfp_hwinfo *hwinfo;
142 	struct nfp_dumpspec *dumpspec;
143 	u32 dump_flag;
144 	u32 dump_len;
145 	struct nfp_eth_table *eth_tbl;
146 	struct nfp_nsp_identify *nspi;
147 
148 	struct device *hwmon_dev;
149 
150 	struct dentry *ddir;
151 
152 	unsigned int max_data_vnics;
153 	unsigned int num_vnics;
154 
155 	struct list_head vnics;
156 	struct list_head ports;
157 
158 	struct workqueue_struct *wq;
159 	struct work_struct port_refresh_work;
160 
161 	struct mutex lock;
162 };
163 
164 extern struct pci_driver nfp_netvf_pci_driver;
165 
166 extern const struct devlink_ops nfp_devlink_ops;
167 
168 int nfp_net_pci_probe(struct nfp_pf *pf);
169 void nfp_net_pci_remove(struct nfp_pf *pf);
170 
171 int nfp_hwmon_register(struct nfp_pf *pf);
172 void nfp_hwmon_unregister(struct nfp_pf *pf);
173 
174 void nfp_net_get_mac_addr(struct nfp_pf *pf, struct nfp_port *port);
175 
176 bool nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb);
177 
178 enum nfp_dump_diag {
179 	NFP_DUMP_NSP_DIAG = 0,
180 };
181 
182 struct nfp_dumpspec *
183 nfp_net_dump_load_dumpspec(struct nfp_cpp *cpp, struct nfp_rtsym_table *rtbl);
184 s64 nfp_net_dump_calculate_size(struct nfp_pf *pf, struct nfp_dumpspec *spec,
185 				u32 flag);
186 int nfp_net_dump_populate_buffer(struct nfp_pf *pf, struct nfp_dumpspec *spec,
187 				 struct ethtool_dump *dump_param, void *dest);
188 
189 #endif /* NFP_MAIN_H */
190