8c33835e5ee93b62e633c5b6f9670bf03984aea9
[dpdk.git] / drivers / net / nfp / nfp_nspu.h
1 /*
2  * Copyright (c) 2017 Netronome Systems, 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 are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *  this list of conditions and the following disclaimer.
10  *
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  * 3. Neither the name of the copyright holder nor the names of its
16  *  contributors may be used to endorse or promote products derived from this
17  *  software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 /*
33  * vim:shiftwidth=8:noexpandtab
34  *
35  * @file dpdk/pmd/nfp_nspu.h
36  *
37  * Netronome NFP_NET PDM driver
38  */
39
40 /*
41  * NSP is the NFP Service Processor. NSPU is NSP Userspace interface.
42  *
43  * NFP NSP helps with firmware/hardware configuration. NSP is another component
44  * in NFP programmable processor and accessing it from host requires to firstly
45  * configure a specific NFP PCI expansion BAR.
46  *
47  * Once access is ready, configuration can be done reading and writing
48  * from/to a specific PF PCI BAR window. This same interface will allow to
49  * create other PCI BAR windows for accessing other NFP components.
50  *
51  * This file includes low-level functions, using the NSPU interface, and high
52  * level functions, invoked by the PMD for using NSP services. This allows
53  * firmware upload, vNIC PCI BARs mapping and other low-level configurations
54  * like link setup.
55  *
56  * NSP access is done during initialization and it is not involved at all with
57  * the fast path.
58  */
59
60 #include <rte_spinlock.h>
61 #include "nfp_net_eth.h"
62
63 typedef struct {
64         int nfp;        /* NFP device */
65         int pcie_bar;   /* PF PCI BAR to work with */
66         int exp_bar;    /* Expansion BAR number used by NSPU */
67         int barsz;      /* PCIE BAR log2 size */
68         uint64_t bufaddr;  /* commands buffer address */
69         size_t buf_size;   /* commands buffer size */
70         uint64_t windowsz; /* NSPU BAR window size */
71         void *cfg_base; /* Expansion BARs address */
72         void *mem_base; /* NSP interface */
73         rte_spinlock_t nsp_lock;
74 } nspu_desc_t;
75
76 int nfp_nspu_init(nspu_desc_t *desc, int nfp, int pcie_bar, size_t pcie_barsz,
77                   int exp_bar, void *exp_bar_cfg_base, void *exp_bar_mmap);
78 int nfp_nsp_get_abi_version(nspu_desc_t *desc, int *major, int *minor);
79 int nfp_nsp_fw_setup(nspu_desc_t *desc, const char *sym, uint64_t *pcie_offset);
80 int nfp_nsp_map_ctrl_bar(nspu_desc_t *desc, uint64_t *pcie_offset);
81 void nfp_nsp_map_queues_bar(nspu_desc_t *desc, uint64_t *pcie_offset);
82 int nfp_nsp_eth_config(nspu_desc_t *desc, int port, int up);
83 int nfp_nsp_eth_read_table(nspu_desc_t *desc, union eth_table_entry **table);