xref: /qemu/include/hw/pci/pcie.h (revision 6ff5da16000f908140723e164d33a0b51a6c4162)
1 /*
2  * pcie.h
3  *
4  * Copyright (c) 2010 Isaku Yamahata <yamahata at valinux co jp>
5  *                    VA Linux Systems Japan K.K.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef QEMU_PCIE_H
22 #define QEMU_PCIE_H
23 
24 #include "hw/pci/pci_regs.h"
25 #include "hw/pci/pcie_regs.h"
26 #include "hw/pci/pcie_aer.h"
27 #include "hw/pci/pcie_sriov.h"
28 #include "hw/hotplug.h"
29 
30 typedef struct PCIEPort PCIEPort;
31 typedef struct PCIESlot PCIESlot;
32 
33 typedef enum {
34     /* these bits must match the bits in Slot Control/Status registers.
35      * PCI_EXP_HP_EV_xxx = PCI_EXP_SLTCTL_xxxE = PCI_EXP_SLTSTA_xxx
36      *
37      * Not all the bits of slot control register match with the ones of
38      * slot status. Not some bits of slot status register is used to
39      * show status, not to report event occurrence.
40      * So such bits must be masked out when checking the software
41      * notification condition.
42      */
43     PCI_EXP_HP_EV_ABP           = PCI_EXP_SLTCTL_ABPE,
44                                         /* attention button pressed */
45     PCI_EXP_HP_EV_PDC           = PCI_EXP_SLTCTL_PDCE,
46                                         /* presence detect changed */
47     PCI_EXP_HP_EV_CCI           = PCI_EXP_SLTCTL_CCIE,
48                                         /* command completed */
49 
50     PCI_EXP_HP_EV_SUPPORTED     = PCI_EXP_HP_EV_ABP |
51                                   PCI_EXP_HP_EV_PDC |
52                                   PCI_EXP_HP_EV_CCI,
53                                                 /* supported event mask  */
54 
55     /* events not listed aren't supported */
56 } PCIExpressHotPlugEvent;
57 
58 struct PCIExpressDevice {
59     /* Offset of express capability in config space */
60     uint8_t exp_cap;
61 
62     /* SLOT */
63     bool hpev_notified; /* Logical AND of conditions for hot plug event.
64                          Following 6.7.3.4:
65                          Software Notification of Hot-Plug Events, an interrupt
66                          is sent whenever the logical and of these conditions
67                          transitions from false to true. */
68 
69     /* AER */
70     uint16_t aer_cap;
71     PCIEAERLog aer_log;
72 
73     /* Offset of ATS capability in config space */
74     uint16_t ats_cap;
75 
76     /* ACS */
77     uint16_t acs_cap;
78 
79     /* SR/IOV */
80     uint16_t sriov_cap;
81     PCIESriovPF sriov_pf;
82     PCIESriovVF sriov_vf;
83 };
84 
85 #define COMPAT_PROP_PCP "power_controller_present"
86 
87 /* PCI express capability helper functions */
88 int pcie_cap_init(PCIDevice *dev, uint8_t offset, uint8_t type,
89                   uint8_t port, Error **errp);
90 int pcie_cap_v1_init(PCIDevice *dev, uint8_t offset,
91                      uint8_t type, uint8_t port);
92 int pcie_endpoint_cap_init(PCIDevice *dev, uint8_t offset);
93 void pcie_cap_exit(PCIDevice *dev);
94 int pcie_endpoint_cap_v1_init(PCIDevice *dev, uint8_t offset);
95 void pcie_cap_v1_exit(PCIDevice *dev);
96 uint8_t pcie_cap_get_type(const PCIDevice *dev);
97 uint8_t pcie_cap_get_version(const PCIDevice *dev);
98 void pcie_cap_flags_set_vector(PCIDevice *dev, uint8_t vector);
99 uint8_t pcie_cap_flags_get_vector(PCIDevice *dev);
100 
101 void pcie_cap_deverr_init(PCIDevice *dev);
102 void pcie_cap_deverr_reset(PCIDevice *dev);
103 
104 void pcie_cap_lnkctl_init(PCIDevice *dev);
105 void pcie_cap_lnkctl_reset(PCIDevice *dev);
106 
107 void pcie_cap_slot_init(PCIDevice *dev, PCIESlot *s);
108 void pcie_cap_slot_reset(PCIDevice *dev);
109 void pcie_cap_slot_get(PCIDevice *dev, uint16_t *slt_ctl, uint16_t *slt_sta);
110 void pcie_cap_slot_write_config(PCIDevice *dev,
111                                 uint16_t old_slt_ctl, uint16_t old_slt_sta,
112                                 uint32_t addr, uint32_t val, int len);
113 int pcie_cap_slot_post_load(void *opaque, int version_id);
114 void pcie_cap_slot_push_attention_button(PCIDevice *dev);
115 void pcie_cap_slot_enable_power(PCIDevice *dev);
116 
117 void pcie_cap_root_init(PCIDevice *dev);
118 void pcie_cap_root_reset(PCIDevice *dev);
119 
120 void pcie_cap_flr_init(PCIDevice *dev);
121 void pcie_cap_flr_write_config(PCIDevice *dev,
122                            uint32_t addr, uint32_t val, int len);
123 
124 /* ARI forwarding capability and control */
125 void pcie_cap_arifwd_init(PCIDevice *dev);
126 void pcie_cap_arifwd_reset(PCIDevice *dev);
127 bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev);
128 
129 /* PCI express extended capability helper functions */
130 uint16_t pcie_find_capability(PCIDevice *dev, uint16_t cap_id);
131 void pcie_add_capability(PCIDevice *dev,
132                          uint16_t cap_id, uint8_t cap_ver,
133                          uint16_t offset, uint16_t size);
134 void pcie_sync_bridge_lnk(PCIDevice *dev);
135 
136 void pcie_acs_init(PCIDevice *dev, uint16_t offset);
137 void pcie_acs_reset(PCIDevice *dev);
138 
139 void pcie_ari_init(PCIDevice *dev, uint16_t offset);
140 void pcie_dev_ser_num_init(PCIDevice *dev, uint16_t offset, uint64_t ser_num);
141 void pcie_ats_init(PCIDevice *dev, uint16_t offset, bool aligned);
142 void pcie_cap_fill_link_ep_usp(PCIDevice *dev, PCIExpLinkWidth width,
143                                PCIExpLinkSpeed speed);
144 
145 void pcie_cap_slot_pre_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
146                                Error **errp);
147 void pcie_cap_slot_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
148                            Error **errp);
149 void pcie_cap_slot_unplug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
150                              Error **errp);
151 void pcie_cap_slot_unplug_request_cb(HotplugHandler *hotplug_dev,
152                                      DeviceState *dev, Error **errp);
153 #endif /* QEMU_PCIE_H */
154