Imported Upstream version 16.04
[deb_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 /*
40  * Helper function to map PCI resources right after hugepages in virtual memory
41  */
42 extern void *pci_map_addr;
43 void *pci_find_max_end_va(void);
44
45 int pci_uio_alloc_resource(struct rte_pci_device *dev,
46                 struct mapped_pci_resource **uio_res);
47 void pci_uio_free_resource(struct rte_pci_device *dev,
48                 struct mapped_pci_resource *uio_res);
49 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
50                 struct mapped_pci_resource *uio_res, int map_idx);
51
52 int pci_uio_read_config(const struct rte_intr_handle *intr_handle,
53                         void *buf, size_t len, off_t offs);
54 int pci_uio_write_config(const struct rte_intr_handle *intr_handle,
55                          const void *buf, size_t len, off_t offs);
56
57 int pci_uio_ioport_map(struct rte_pci_device *dev, int bar,
58                        struct rte_pci_ioport *p);
59 void pci_uio_ioport_read(struct rte_pci_ioport *p,
60                          void *data, size_t len, off_t offset);
61 void pci_uio_ioport_write(struct rte_pci_ioport *p,
62                           const void *data, size_t len, off_t offset);
63 int pci_uio_ioport_unmap(struct rte_pci_ioport *p);
64
65 #ifdef VFIO_PRESENT
66
67 #define VFIO_MAX_GROUPS 64
68
69 int pci_vfio_enable(void);
70 int pci_vfio_is_enabled(void);
71 int pci_vfio_mp_sync_setup(void);
72
73 /* access config space */
74 int pci_vfio_read_config(const struct rte_intr_handle *intr_handle,
75                          void *buf, size_t len, off_t offs);
76 int pci_vfio_write_config(const struct rte_intr_handle *intr_handle,
77                           const void *buf, size_t len, off_t offs);
78
79 int pci_vfio_ioport_map(struct rte_pci_device *dev, int bar,
80                         struct rte_pci_ioport *p);
81 void pci_vfio_ioport_read(struct rte_pci_ioport *p,
82                           void *data, size_t len, off_t offset);
83 void pci_vfio_ioport_write(struct rte_pci_ioport *p,
84                            const void *data, size_t len, off_t offset);
85 int pci_vfio_ioport_unmap(struct rte_pci_ioport *p);
86
87 /* map VFIO resource prototype */
88 int pci_vfio_map_resource(struct rte_pci_device *dev);
89 int pci_vfio_get_group_fd(int iommu_group_fd);
90 int pci_vfio_get_container_fd(void);
91
92 /*
93  * Function prototypes for VFIO multiprocess sync functions
94  */
95 int vfio_mp_sync_send_request(int socket, int req);
96 int vfio_mp_sync_receive_request(int socket);
97 int vfio_mp_sync_send_fd(int socket, int fd);
98 int vfio_mp_sync_receive_fd(int socket);
99 int vfio_mp_sync_connect_to_primary(void);
100
101 /* socket comm protocol definitions */
102 #define SOCKET_REQ_CONTAINER 0x100
103 #define SOCKET_REQ_GROUP 0x200
104 #define SOCKET_OK 0x0
105 #define SOCKET_NO_FD 0x1
106 #define SOCKET_ERR 0xFF
107
108 /*
109  * we don't need to store device fd's anywhere since they can be obtained from
110  * the group fd via an ioctl() call.
111  */
112 struct vfio_group {
113         int group_no;
114         int fd;
115 };
116
117 struct vfio_config {
118         int vfio_enabled;
119         int vfio_container_fd;
120         int vfio_container_has_dma;
121         int vfio_group_idx;
122         struct vfio_group vfio_groups[VFIO_MAX_GROUPS];
123 };
124
125 #endif
126
127 #endif /* EAL_PCI_INIT_H_ */