drivers/net/ethernet/netronome/nfp/nfp_main.h

   1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
   2 /* Copyright (C) 2015-2018 Netronome Systems, Inc. */
   3
   4 /*
   5  * nfp_main.h
   6  * Author: Jason McMullan <jason.mcmullan@netronome.com>
   7  */
   8
   9 #ifndef NFP_MAIN_H
  10 #define NFP_MAIN_H
  11
  12 #include <linux/ethtool.h>
  13 #include <linux/list.h>
  14 #include <linux/types.h>
  15 #include <linux/msi.h>
  16 #include <linux/mutex.h>
  17 #include <linux/pci.h>
  18 #include <linux/workqueue.h>
  19 #include <net/devlink.h>
  20
  21 struct dentry;
  22 struct device;
  23 struct pci_dev;
  24
  25 struct nfp_cpp;
  26 struct nfp_cpp_area;
  27 struct nfp_eth_table;
  28 struct nfp_hwinfo;
  29 struct nfp_mip;
  30 struct nfp_net;
  31 struct nfp_nsp_identify;
  32 struct nfp_port;
  33 struct nfp_rtsym;
  34 struct nfp_rtsym_table;
  35 struct nfp_shared_buf;
  36
  37 /**
  38  * struct nfp_dumpspec - NFP FW dump specification structure
  39  * @size:       Size of the data
  40  * @data:       Sequence of TLVs, each being an instruction to dump some data
  41  *              from FW
  42  */
  43 struct nfp_dumpspec {
  44         u32 size;
  45         u8 data[];
  46 };
  47
  48 /**
  49  * struct nfp_pf - NFP PF-specific device structure
  50  * @pdev:               Backpointer to PCI device
  51  * @cpp:                Pointer to the CPP handle
  52  * @app:                Pointer to the APP handle
  53  * @data_vnic_bar:      Pointer to the CPP area for the data vNICs' BARs
  54  * @ctrl_vnic_bar:      Pointer to the CPP area for the ctrl vNIC's BAR
  55  * @qc_area:            Pointer to the CPP area for the queues
  56  * @mac_stats_bar:      Pointer to the CPP area for the MAC stats
  57  * @mac_stats_mem:      Pointer to mapped MAC stats area
  58  * @vf_cfg_bar:         Pointer to the CPP area for the VF configuration BAR
  59  * @vf_cfg_mem:         Pointer to mapped VF configuration area
  60  * @vfcfg_tbl2_area:    Pointer to the CPP area for the VF config table
  61  * @vfcfg_tbl2:         Pointer to mapped VF config table
  62  * @mbox:               RTSym of per-PCI PF mailbox (under devlink lock)
  63  * @irq_entries:        Array of MSI-X entries for all vNICs
  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  * @unload_fw_on_remove:Do we need to unload firmware on driver removal?
  68  * @ctrl_vnic:          Pointer to the control vNIC if available
  69  * @mip:                MIP handle
  70  * @rtbl:               RTsym table
  71  * @hwinfo:             HWInfo table
  72  * @dumpspec:           Debug dump specification
  73  * @dump_flag:          Store dump flag between set_dump and get_dump_flag
  74  * @dump_len:           Store dump length between set_dump and get_dump_flag
  75  * @eth_tbl:            NSP ETH table
  76  * @nspi:               NSP identification info
  77  * @hwmon_dev:          pointer to hwmon device
  78  * @ddir:               Per-device debugfs directory
  79  * @max_data_vnics:     Number of data vNICs app firmware supports
  80  * @num_vnics:          Number of vNICs spawned
  81  * @vnics:              Linked list of vNIC structures (struct nfp_net)
  82  * @ports:              Linked list of port structures (struct nfp_port)
  83  * @wq:                 Workqueue for running works which need to grab @lock
  84  * @port_refresh_work:  Work entry for taking netdevs out
  85  * @shared_bufs:        Array of shared buffer structures if FW has any SBs
  86  * @num_shared_bufs:    Number of elements in @shared_bufs
  87  * @lock:               Protects all fields which may change after probe
  88  */
  89 struct nfp_pf {
  90         struct pci_dev *pdev;
  91
  92         struct nfp_cpp *cpp;
  93
  94         struct nfp_app *app;
  95
  96         struct nfp_cpp_area *data_vnic_bar;
  97         struct nfp_cpp_area *ctrl_vnic_bar;
  98         struct nfp_cpp_area *qc_area;
  99         struct nfp_cpp_area *mac_stats_bar;
 100         u8 __iomem *mac_stats_mem;
 101         struct nfp_cpp_area *vf_cfg_bar;
 102         u8 __iomem *vf_cfg_mem;
 103         struct nfp_cpp_area *vfcfg_tbl2_area;
 104         u8 __iomem *vfcfg_tbl2;
 105
 106         const struct nfp_rtsym *mbox;
 107
 108         struct msix_entry *irq_entries;
 109
 110         unsigned int limit_vfs;
 111         unsigned int num_vfs;
 112
 113         bool fw_loaded;
 114         bool unload_fw_on_remove;
 115
 116         struct nfp_net *ctrl_vnic;
 117
 118         const struct nfp_mip *mip;
 119         struct nfp_rtsym_table *rtbl;
 120         struct nfp_hwinfo *hwinfo;
 121         struct nfp_dumpspec *dumpspec;
 122         u32 dump_flag;
 123         u32 dump_len;
 124         struct nfp_eth_table *eth_tbl;
 125         struct nfp_nsp_identify *nspi;
 126
 127         struct device *hwmon_dev;
 128
 129         struct dentry *ddir;
 130
 131         unsigned int max_data_vnics;
 132         unsigned int num_vnics;
 133
 134         struct list_head vnics;
 135         struct list_head ports;
 136
 137         struct workqueue_struct *wq;
 138         struct work_struct port_refresh_work;
 139
 140         struct nfp_shared_buf *shared_bufs;
 141         unsigned int num_shared_bufs;
 142
 143         struct mutex lock;
 144 };
 145
 146 extern struct pci_driver nfp_netvf_pci_driver;
 147
 148 extern const struct devlink_ops nfp_devlink_ops;
 149
 150 int nfp_net_pci_probe(struct nfp_pf *pf);
 151 void nfp_net_pci_remove(struct nfp_pf *pf);
 152
 153 int nfp_hwmon_register(struct nfp_pf *pf);
 154 void nfp_hwmon_unregister(struct nfp_pf *pf);
 155
 156 void
 157 nfp_net_get_mac_addr(struct nfp_pf *pf, struct net_device *netdev,
 158                      struct nfp_port *port);
 159
 160 bool nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb);
 161
 162 int nfp_pf_rtsym_read_optional(struct nfp_pf *pf, const char *format,
 163                                unsigned int default_val);
 164 u8 __iomem *
 165 nfp_pf_map_rtsym(struct nfp_pf *pf, const char *name, const char *sym_fmt,
 166                  unsigned int min_size, struct nfp_cpp_area **area);
 167 int nfp_mbox_cmd(struct nfp_pf *pf, u32 cmd, void *in_data, u64 in_length,
 168                  void *out_data, u64 out_length);
 169 int nfp_flash_update_common(struct nfp_pf *pf, const struct firmware *fw,
 170                             struct netlink_ext_ack *extack);
 171
 172 enum nfp_dump_diag {
 173         NFP_DUMP_NSP_DIAG = 0,
 174 };
 175
 176 struct nfp_dumpspec *
 177 nfp_net_dump_load_dumpspec(struct nfp_cpp *cpp, struct nfp_rtsym_table *rtbl);
 178 s64 nfp_net_dump_calculate_size(struct nfp_pf *pf, struct nfp_dumpspec *spec,
 179                                 u32 flag);
 180 int nfp_net_dump_populate_buffer(struct nfp_pf *pf, struct nfp_dumpspec *spec,
 181                                  struct ethtool_dump *dump_param, void *dest);
 182
 183 int nfp_shared_buf_register(struct nfp_pf *pf);
 184 void nfp_shared_buf_unregister(struct nfp_pf *pf);
 185 int nfp_shared_buf_pool_get(struct nfp_pf *pf, unsigned int sb, u16 pool_index,
 186                             struct devlink_sb_pool_info *pool_info);
 187 int nfp_shared_buf_pool_set(struct nfp_pf *pf, unsigned int sb,
 188                             u16 pool_index, u32 size,
 189                             enum devlink_sb_threshold_type threshold_type);
 190
 191 int nfp_devlink_params_register(struct nfp_pf *pf);
 192 void nfp_devlink_params_unregister(struct nfp_pf *pf);
 193 #endif /* NFP_MAIN_H */