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/list.h>
43 #include <linux/types.h>
44 #include <linux/msi.h>
45 #include <linux/mutex.h>
46 #include <linux/pci.h>
47 #include <linux/workqueue.h>
48 
49 struct dentry;
50 struct pci_dev;
51 
52 struct nfp_cpp;
53 struct nfp_cpp_area;
54 struct nfp_eth_table;
55 
56 /**
57  * struct nfp_pf - NFP PF-specific device structure
58  * @pdev:		Backpointer to PCI device
59  * @cpp:		Pointer to the CPP handle
60  * @ctrl_area:		Pointer to the CPP area for the control BAR
61  * @tx_area:		Pointer to the CPP area for the TX queues
62  * @rx_area:		Pointer to the CPP area for the FL/RX queues
63  * @irq_entries:	Array of MSI-X entries for all ports
64  * @limit_vfs:		Number of VFs supported by firmware (~0 for PCI limit)
65  * @num_vfs:		Number of SR-IOV VFs enabled
66  * @fw_loaded:		Is the firmware loaded?
67  * @eth_tbl:		NSP ETH table
68  * @ddir:		Per-device debugfs directory
69  * @num_ports:		Number of adapter ports app firmware supports
70  * @num_netdevs:	Number of netdevs spawned
71  * @ports:		Linked list of port structures (struct nfp_net)
72  * @port_lock:		Protects @ports, @num_ports, @num_netdevs
73  * @port_refresh_work:	Work entry for taking netdevs out
74  */
75 struct nfp_pf {
76 	struct pci_dev *pdev;
77 
78 	struct nfp_cpp *cpp;
79 
80 	struct nfp_cpp_area *ctrl_area;
81 	struct nfp_cpp_area *tx_area;
82 	struct nfp_cpp_area *rx_area;
83 
84 	struct msix_entry *irq_entries;
85 
86 	unsigned int limit_vfs;
87 	unsigned int num_vfs;
88 
89 	bool fw_loaded;
90 
91 	struct nfp_eth_table *eth_tbl;
92 
93 	struct dentry *ddir;
94 
95 	unsigned int num_ports;
96 	unsigned int num_netdevs;
97 
98 	struct list_head ports;
99 	struct work_struct port_refresh_work;
100 	struct mutex port_lock;
101 };
102 
103 extern struct pci_driver nfp_netvf_pci_driver;
104 
105 int nfp_net_pci_probe(struct nfp_pf *pf);
106 void nfp_net_pci_remove(struct nfp_pf *pf);
107 
108 #endif /* NFP_MAIN_H */
109