virpci.h 6.0 KB
Newer Older
1
/*
2 3
 * virpci.h: helper APIs for managing host PCI devices
 *
4
 * Copyright (C) 2009, 2011-2013 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

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

struct _virPCIDeviceAddress {
38 39 40 41 42 43
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
};

44 45 46 47
virPCIDevicePtr virPCIDeviceNew(unsigned int domain,
                                unsigned int bus,
                                unsigned int slot,
                                unsigned int function);
48 49 50 51 52 53 54 55 56
void virPCIDeviceFree(virPCIDevicePtr dev);
const char *virPCIDeviceGetName(virPCIDevicePtr dev);

int virPCIDeviceDetach(virPCIDevicePtr dev,
                       virPCIDeviceListPtr activeDevs,
                       virPCIDeviceListPtr inactiveDevs,
                       const char *driver);
int virPCIDeviceReattach(virPCIDevicePtr dev,
                         virPCIDeviceListPtr activeDevs,
57
                         virPCIDeviceListPtr inactiveDevs);
58 59 60 61 62
int virPCIDeviceReset(virPCIDevicePtr dev,
                      virPCIDeviceListPtr activeDevs,
                      virPCIDeviceListPtr inactiveDevs);

void virPCIDeviceSetManaged(virPCIDevice *dev,
63
                            bool managed);
64
unsigned int virPCIDeviceGetManaged(virPCIDevice *dev);
65 66 67
void virPCIDeviceSetStubDriver(virPCIDevicePtr dev,
                               const char *driver);
const char *virPCIDeviceGetStubDriver(virPCIDevicePtr dev);
68 69 70
void virPCIDeviceSetUsedBy(virPCIDevice *dev,
                           const char *used_by);
const char *virPCIDeviceGetUsedBy(virPCIDevice *dev);
71
unsigned int virPCIDeviceGetUnbindFromStub(virPCIDevicePtr dev);
72
void  virPCIDeviceSetUnbindFromStub(virPCIDevice *dev,
73
                                    bool unbind);
74
unsigned int virPCIDeviceGetRemoveSlot(virPCIDevicePtr dev);
75
void virPCIDeviceSetRemoveSlot(virPCIDevice *dev,
76
                               bool remove_slot);
77
unsigned int virPCIDeviceGetReprobe(virPCIDevicePtr dev);
78
void virPCIDeviceSetReprobe(virPCIDevice *dev,
79
                            bool reprobe);
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
void virPCIDeviceReattachInit(virPCIDevice *dev);


virPCIDeviceListPtr virPCIDeviceListNew(void);
int  virPCIDeviceListAdd(virPCIDeviceListPtr list,
                         virPCIDevicePtr dev);
virPCIDevicePtr virPCIDeviceListGet(virPCIDeviceListPtr list,
                                    int idx);
int virPCIDeviceListCount(virPCIDeviceListPtr list);
virPCIDevicePtr virPCIDeviceListSteal(virPCIDeviceListPtr list,
                                      virPCIDevicePtr dev);
virPCIDevicePtr virPCIDeviceListStealIndex(virPCIDeviceListPtr list,
                                           int idx);
void virPCIDeviceListDel(virPCIDeviceListPtr list,
                         virPCIDevicePtr dev);
virPCIDevicePtr virPCIDeviceListFind(virPCIDeviceListPtr list,
                                     virPCIDevicePtr dev);
int virPCIDeviceListFindIndex(virPCIDeviceListPtr list,
                              virPCIDevicePtr dev);
99

100 101 102 103 104 105 106
/*
 * 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
 */
107 108
typedef int (*virPCIDeviceFileActor)(virPCIDevicePtr dev,
                                     const char *path, void *opaque);
109

110 111 112
int virPCIDeviceFileIterate(virPCIDevicePtr dev,
                            virPCIDeviceFileActor actor,
                            void *opaque);
113 114
char *
virPCIDeviceGetVFIOGroupDev(virPCIDevicePtr dev);
115

116 117 118
int virPCIDeviceIsAssignable(virPCIDevicePtr dev,
                             int strict_acs_check);
int virPCIDeviceWaitForCleanup(virPCIDevicePtr dev, const char *matcher);
J
Jiri Denemark 已提交
119

120 121
int virPCIGetPhysicalFunction(const char *sysfs_path,
                              virPCIDeviceAddressPtr *phys_fn);
122

123 124 125
int virPCIGetVirtualFunctions(const char *sysfs_path,
                              virPCIDeviceAddressPtr **virtual_functions,
                              unsigned int *num_virtual_functions);
126

127
int virPCIIsVirtualFunction(const char *vf_sysfs_device_link);
128

129 130 131
int virPCIGetVirtualFunctionIndex(const char *pf_sysfs_device_link,
                                        const char *vf_sysfs_device_link,
                                        int *vf_index);
132

133 134
int virPCIDeviceAddressGetSysfsFile(virPCIDeviceAddressPtr dev,
                                    char **pci_sysfs_device_link);
R
Roopa Prabhu 已提交
135

136
int virPCIGetNetName(char *device_link_sysfs_path, char **netname);
137

138 139
int virPCIGetSysfsFile(char *virPCIDeviceName,
                             char **pci_sysfs_device_link)
140 141
    ATTRIBUTE_RETURN_CHECK;

142 143 144 145
int virPCIGetAddrString(unsigned int domain,
                        unsigned int bus,
                        unsigned int slot,
                        unsigned int function,
146
                        char **pciConfigAddr)
147
    ATTRIBUTE_NONNULL(5) ATTRIBUTE_RETURN_CHECK;
R
Roopa Prabhu 已提交
148

149 150
int virPCIGetVirtualFunctionInfo(const char *vf_sysfs_device_path,
                                 char **pfname, int *vf_index);
R
Roopa Prabhu 已提交
151

152
#endif /* __VIR_PCI_H__ */