vfio: generalize non PCI-specific functions
[dpdk.git] / lib / librte_eal / linuxapp / eal / eal_pci_init.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef EAL_PCI_INIT_H_
35 #define EAL_PCI_INIT_H_
36
37 #include "eal_vfio.h"
38
39 /** IO resource type: */
40 #define IORESOURCE_IO         0x00000100
41 #define IORESOURCE_MEM        0x00000200
42
43 /*
44  * Helper function to map PCI resources right after hugepages in virtual memory
45  */
46 extern void *pci_map_addr;
47 void *pci_find_max_end_va(void);
48
49 /* parse one line of the "resource" sysfs file (note that the 'line'
50  * string is modified)
51  */
52 int pci_parse_one_sysfs_resource(char *line, size_t len, uint64_t *phys_addr,
53         uint64_t *end_addr, uint64_t *flags);
54
55 int pci_uio_alloc_resource(struct rte_pci_device *dev,
56                 struct mapped_pci_resource **uio_res);
57 void pci_uio_free_resource(struct rte_pci_device *dev,
58                 struct mapped_pci_resource *uio_res);
59 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
60                 struct mapped_pci_resource *uio_res, int map_idx);
61
62 int pci_uio_read_config(const struct rte_intr_handle *intr_handle,
63                         void *buf, size_t len, off_t offs);
64 int pci_uio_write_config(const struct rte_intr_handle *intr_handle,
65                          const void *buf, size_t len, off_t offs);
66
67 int pci_uio_ioport_map(struct rte_pci_device *dev, int bar,
68                        struct rte_pci_ioport *p);
69 void pci_uio_ioport_read(struct rte_pci_ioport *p,
70                          void *data, size_t len, off_t offset);
71 void pci_uio_ioport_write(struct rte_pci_ioport *p,
72                           const void *data, size_t len, off_t offset);
73 int pci_uio_ioport_unmap(struct rte_pci_ioport *p);
74
75 #ifdef VFIO_PRESENT
76
77 int pci_vfio_enable(void);
78 int pci_vfio_is_enabled(void);
79 int pci_vfio_mp_sync_setup(void);
80
81 /* access config space */
82 int pci_vfio_read_config(const struct rte_intr_handle *intr_handle,
83                          void *buf, size_t len, off_t offs);
84 int pci_vfio_write_config(const struct rte_intr_handle *intr_handle,
85                           const void *buf, size_t len, off_t offs);
86
87 int pci_vfio_ioport_map(struct rte_pci_device *dev, int bar,
88                         struct rte_pci_ioport *p);
89 void pci_vfio_ioport_read(struct rte_pci_ioport *p,
90                           void *data, size_t len, off_t offset);
91 void pci_vfio_ioport_write(struct rte_pci_ioport *p,
92                            const void *data, size_t len, off_t offset);
93 int pci_vfio_ioport_unmap(struct rte_pci_ioport *p);
94
95 /* map VFIO resource prototype */
96 int pci_vfio_map_resource(struct rte_pci_device *dev);
97 int pci_vfio_get_group_fd(int iommu_group_fd);
98
99 #endif
100
101 #endif /* EAL_PCI_INIT_H_ */