virpci.h 9.3 KB
Newer Older
1
/*
2 3
 * virpci.h: helper APIs for managing host PCI devices
 *
4
 * Copyright (C) 2009, 2011-2015 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
19 20 21 22 23 24
 *
 * Authors:
 *     Mark McLoughlin <markmc@redhat.com>
 */

#ifndef __VIR_PCI_H__
25
# define __VIR_PCI_H__
26

27
# include "internal.h"
28
# include "virobject.h"
29
# include "virutil.h"
30

31 32 33 34 35 36 37 38
typedef struct _virPCIDevice virPCIDevice;
typedef virPCIDevice *virPCIDevicePtr;
typedef struct _virPCIDeviceAddress virPCIDeviceAddress;
typedef virPCIDeviceAddress *virPCIDeviceAddressPtr;
typedef struct _virPCIDeviceList virPCIDeviceList;
typedef virPCIDeviceList *virPCIDeviceListPtr;

struct _virPCIDeviceAddress {
39 40 41 42
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
43
    int multi; /* virTristateSwitch */
44 45
};

46 47 48 49 50 51 52 53 54 55
typedef enum {
    VIR_PCI_STUB_DRIVER_NONE = 0,
    VIR_PCI_STUB_DRIVER_XEN,
    VIR_PCI_STUB_DRIVER_KVM,
    VIR_PCI_STUB_DRIVER_VFIO,
    VIR_PCI_STUB_DRIVER_LAST
} virPCIStubDriver;

VIR_ENUM_DECL(virPCIStubDriver);

56 57 58 59 60 61 62 63 64 65
typedef enum {
    VIR_PCIE_LINK_SPEED_NA = 0,
    VIR_PCIE_LINK_SPEED_25,
    VIR_PCIE_LINK_SPEED_5,
    VIR_PCIE_LINK_SPEED_8,
    VIR_PCIE_LINK_SPEED_LAST
} virPCIELinkSpeed;

VIR_ENUM_DECL(virPCIELinkSpeed)

66 67 68 69 70 71 72 73 74 75
typedef enum {
    VIR_PCI_HEADER_ENDPOINT = 0,
    VIR_PCI_HEADER_PCI_BRIDGE,
    VIR_PCI_HEADER_CARDBUS_BRIDGE,

    VIR_PCI_HEADER_LAST
} virPCIHeaderType;

VIR_ENUM_DECL(virPCIHeader)

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
typedef struct _virPCIELink virPCIELink;
typedef virPCIELink *virPCIELinkPtr;
struct _virPCIELink {
    int port;
    virPCIELinkSpeed speed;
    unsigned int width;
};

typedef struct _virPCIEDeviceInfo virPCIEDeviceInfo;
typedef virPCIEDeviceInfo *virPCIEDeviceInfoPtr;
struct _virPCIEDeviceInfo {
    /* Not all PCI Express devices have link. For example this 'Root Complex
     * Integrated Endpoint' and 'Root Complex Event Collector' don't have it. */
    virPCIELink *link_cap;   /* PCIe device link capabilities */
    virPCIELink *link_sta;   /* Actually negotiated capabilities */
};

93 94 95 96
virPCIDevicePtr virPCIDeviceNew(unsigned int domain,
                                unsigned int bus,
                                unsigned int slot,
                                unsigned int function);
L
Laine Stump 已提交
97
virPCIDevicePtr virPCIDeviceCopy(virPCIDevicePtr dev);
98 99
void virPCIDeviceFree(virPCIDevicePtr dev);
const char *virPCIDeviceGetName(virPCIDevicePtr dev);
100
const char *virPCIDeviceGetConfigPath(virPCIDevicePtr dev);
101 102 103

int virPCIDeviceDetach(virPCIDevicePtr dev,
                       virPCIDeviceListPtr activeDevs,
104
                       virPCIDeviceListPtr inactiveDevs);
105 106
int virPCIDeviceReattach(virPCIDevicePtr dev,
                         virPCIDeviceListPtr activeDevs,
107
                         virPCIDeviceListPtr inactiveDevs);
108 109 110 111 112
int virPCIDeviceReset(virPCIDevicePtr dev,
                      virPCIDeviceListPtr activeDevs,
                      virPCIDeviceListPtr inactiveDevs);

void virPCIDeviceSetManaged(virPCIDevice *dev,
113
                            bool managed);
114
bool virPCIDeviceGetManaged(virPCIDevice *dev);
115 116 117
void virPCIDeviceSetStubDriver(virPCIDevicePtr dev,
                               virPCIStubDriver driver);
virPCIStubDriver virPCIDeviceGetStubDriver(virPCIDevicePtr dev);
118
virPCIDeviceAddressPtr virPCIDeviceGetAddress(virPCIDevicePtr dev);
C
Chunyan Liu 已提交
119 120 121 122 123 124
int virPCIDeviceSetUsedBy(virPCIDevice *dev,
                          const char *drv_name,
                          const char *dom_name);
void virPCIDeviceGetUsedBy(virPCIDevice *dev,
                           const char **drv_name,
                           const char **dom_name);
125
bool virPCIDeviceGetUnbindFromStub(virPCIDevicePtr dev);
126
void  virPCIDeviceSetUnbindFromStub(virPCIDevice *dev,
127
                                    bool unbind);
128
bool virPCIDeviceGetRemoveSlot(virPCIDevicePtr dev);
129
void virPCIDeviceSetRemoveSlot(virPCIDevice *dev,
130
                               bool remove_slot);
131
bool virPCIDeviceGetReprobe(virPCIDevicePtr dev);
132
void virPCIDeviceSetReprobe(virPCIDevice *dev,
133
                            bool reprobe);
134 135 136 137 138


virPCIDeviceListPtr virPCIDeviceListNew(void);
int  virPCIDeviceListAdd(virPCIDeviceListPtr list,
                         virPCIDevicePtr dev);
L
Laine Stump 已提交
139
int virPCIDeviceListAddCopy(virPCIDeviceListPtr list, virPCIDevicePtr dev);
140 141
virPCIDevicePtr virPCIDeviceListGet(virPCIDeviceListPtr list,
                                    int idx);
142
size_t virPCIDeviceListCount(virPCIDeviceListPtr list);
143 144 145 146 147 148 149 150
virPCIDevicePtr virPCIDeviceListSteal(virPCIDeviceListPtr list,
                                      virPCIDevicePtr dev);
virPCIDevicePtr virPCIDeviceListStealIndex(virPCIDeviceListPtr list,
                                           int idx);
void virPCIDeviceListDel(virPCIDeviceListPtr list,
                         virPCIDevicePtr dev);
virPCIDevicePtr virPCIDeviceListFind(virPCIDeviceListPtr list,
                                     virPCIDevicePtr dev);
L
Laine Stump 已提交
151 152 153 154 155 156
virPCIDevicePtr
virPCIDeviceListFindByIDs(virPCIDeviceListPtr list,
                          unsigned int domain,
                          unsigned int bus,
                          unsigned int slot,
                          unsigned int function);
157 158
int virPCIDeviceListFindIndex(virPCIDeviceListPtr list,
                              virPCIDevicePtr dev);
159

160 161 162 163 164 165 166
/*
 * Callback that will be invoked once for each file
 * associated with / used for PCI host device access.
 *
 * Should return 0 if successfully processed, or
 * -1 to indicate error and abort iteration
 */
167 168 169 170 171
typedef int (*virPCIDeviceFileActor)(virPCIDevicePtr dev,
                                     const char *path, void *opaque);
int virPCIDeviceFileIterate(virPCIDevicePtr dev,
                            virPCIDeviceFileActor actor,
                            void *opaque);
L
Laine Stump 已提交
172

173
typedef int (*virPCIDeviceAddressActor)(virPCIDeviceAddressPtr addr,
L
Laine Stump 已提交
174 175 176 177 178 179 180 181
                                        void *opaque);
int virPCIDeviceAddressIOMMUGroupIterate(virPCIDeviceAddressPtr orig,
                                         virPCIDeviceAddressActor actor,
                                         void *opaque);
virPCIDeviceListPtr virPCIDeviceGetIOMMUGroupList(virPCIDevicePtr dev);
int virPCIDeviceAddressGetIOMMUGroupAddresses(virPCIDeviceAddressPtr devAddr,
                                              virPCIDeviceAddressPtr **iommuGroupDevices,
                                              size_t *nIommuGroupDevices);
182
int virPCIDeviceAddressGetIOMMUGroupNum(virPCIDeviceAddressPtr addr);
L
Laine Stump 已提交
183
char *virPCIDeviceGetIOMMUGroupDev(virPCIDevicePtr dev);
184

185 186 187
int virPCIDeviceIsAssignable(virPCIDevicePtr dev,
                             int strict_acs_check);
int virPCIDeviceWaitForCleanup(virPCIDevicePtr dev, const char *matcher);
J
Jiri Denemark 已提交
188

189 190
int virPCIGetPhysicalFunction(const char *vf_sysfs_path,
                              virPCIDeviceAddressPtr *pf);
191

192 193
int virPCIGetVirtualFunctions(const char *sysfs_path,
                              virPCIDeviceAddressPtr **virtual_functions,
194 195
                              size_t *num_virtual_functions,
                              unsigned int *max_virtual_functions);
196

197
int virPCIIsVirtualFunction(const char *vf_sysfs_device_link);
198

199 200 201
int virPCIGetVirtualFunctionIndex(const char *pf_sysfs_device_link,
                                        const char *vf_sysfs_device_link,
                                        int *vf_index);
202

203
int virPCIDeviceAddressGetSysfsFile(virPCIDeviceAddressPtr addr,
204
                                    char **pci_sysfs_device_link);
R
Roopa Prabhu 已提交
205

206
int virPCIGetNetName(char *device_link_sysfs_path, char **netname);
207

208 209
int virPCIGetSysfsFile(char *virPCIDeviceName,
                             char **pci_sysfs_device_link)
210 211
    ATTRIBUTE_RETURN_CHECK;

212 213 214 215
int virPCIGetAddrString(unsigned int domain,
                        unsigned int bus,
                        unsigned int slot,
                        unsigned int function,
216
                        char **pciConfigAddr)
217
    ATTRIBUTE_NONNULL(5) ATTRIBUTE_RETURN_CHECK;
R
Roopa Prabhu 已提交
218

219 220
int virPCIDeviceAddressParse(char *address, virPCIDeviceAddressPtr bdf);

221 222
int virPCIGetVirtualFunctionInfo(const char *vf_sysfs_device_path,
                                 char **pfname, int *vf_index);
R
Roopa Prabhu 已提交
223

224
int virPCIDeviceUnbind(virPCIDevicePtr dev);
225 226 227 228
int virPCIDeviceGetDriverPathAndName(virPCIDevicePtr dev,
                                     char **path,
                                     char **name);

229 230 231 232 233 234 235 236
int virPCIDeviceIsPCIExpress(virPCIDevicePtr dev);
int virPCIDeviceHasPCIExpressLink(virPCIDevicePtr dev);
int virPCIDeviceGetLinkCapSta(virPCIDevicePtr dev,
                              int *ca_port,
                              unsigned int *cap_speed,
                              unsigned int *cap_width,
                              unsigned int *sta_speed,
                              unsigned int *sta_width);
237

238 239
int virPCIGetHeaderType(virPCIDevicePtr dev, int *hdrType);

240 241
void virPCIEDeviceInfoFree(virPCIEDeviceInfoPtr dev);

242
#endif /* __VIR_PCI_H__ */