4 * Copyright (c) 2010 Isaku Yamahata <yamahata at valinux co jp>
5 * VA Linux Systems Japan K.K.
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.
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.
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/>.
23 #include "pci_bridge.h"
27 #include "pci_internals.h"
28 #include "pcie_regs.h"
33 # define PCIE_DPRINTF(fmt, ...) \
34 fprintf(stderr, "%s:%d " fmt, __func__, __LINE__, ## __VA_ARGS__)
36 # define PCIE_DPRINTF(fmt, ...) do {} while (0)
38 #define PCIE_DEV_PRINTF(dev, fmt, ...) \
39 PCIE_DPRINTF("%s:%x "fmt, (dev)->name, (dev)->devfn, ## __VA_ARGS__)
42 /***************************************************************************
43 * pci express capability helper functions
45 int pcie_cap_init(PCIDevice
*dev
, uint8_t offset
, uint8_t type
, uint8_t port
)
50 assert(pci_is_express(dev
));
52 pos
= pci_add_capability(dev
, PCI_CAP_ID_EXP
, offset
,
57 dev
->exp
.exp_cap
= pos
;
58 exp_cap
= dev
->config
+ pos
;
60 /* capability register
61 interrupt message number defaults to 0 */
62 pci_set_word(exp_cap
+ PCI_EXP_FLAGS
,
63 ((type
<< PCI_EXP_FLAGS_TYPE_SHIFT
) & PCI_EXP_FLAGS_TYPE
) |
66 /* device capability register
68 * roll based error reporting bit must be set by all
69 * Functions conforming to the ECN, PCI Express Base
70 * Specification, Revision 1.1., or subsequent PCI Express Base
71 * Specification revisions.
73 pci_set_long(exp_cap
+ PCI_EXP_DEVCAP
, PCI_EXP_DEVCAP_RBER
);
75 pci_set_long(exp_cap
+ PCI_EXP_LNKCAP
,
76 (port
<< PCI_EXP_LNKCAP_PN_SHIFT
) |
77 PCI_EXP_LNKCAP_ASPMS_0S
|
81 pci_set_word(exp_cap
+ PCI_EXP_LNKSTA
,
82 PCI_EXP_LNK_MLW_1
| PCI_EXP_LNK_LS_25
);
84 pci_set_long(exp_cap
+ PCI_EXP_DEVCAP2
,
85 PCI_EXP_DEVCAP2_EFF
| PCI_EXP_DEVCAP2_EETLPP
);
87 pci_set_word(dev
->wmask
+ pos
, PCI_EXP_DEVCTL2_EETLPPB
);
91 void pcie_cap_exit(PCIDevice
*dev
)
93 pci_del_capability(dev
, PCI_CAP_ID_EXP
, PCI_EXP_VER2_SIZEOF
);
96 uint8_t pcie_cap_get_type(const PCIDevice
*dev
)
98 uint32_t pos
= dev
->exp
.exp_cap
;
100 return (pci_get_word(dev
->config
+ pos
+ PCI_EXP_FLAGS
) &
101 PCI_EXP_FLAGS_TYPE
) >> PCI_EXP_FLAGS_TYPE_SHIFT
;
105 /* pci express interrupt message number */
106 /* 7.8.2 PCI Express Capabilities Register: Interrupt Message Number */
107 void pcie_cap_flags_set_vector(PCIDevice
*dev
, uint8_t vector
)
109 uint8_t *exp_cap
= dev
->config
+ dev
->exp
.exp_cap
;
111 pci_word_test_and_clear_mask(exp_cap
+ PCI_EXP_FLAGS
, PCI_EXP_FLAGS_IRQ
);
112 pci_word_test_and_set_mask(exp_cap
+ PCI_EXP_FLAGS
,
113 vector
<< PCI_EXP_FLAGS_IRQ_SHIFT
);
116 uint8_t pcie_cap_flags_get_vector(PCIDevice
*dev
)
118 return (pci_get_word(dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_FLAGS
) &
119 PCI_EXP_FLAGS_IRQ
) >> PCI_EXP_FLAGS_IRQ_SHIFT
;
122 void pcie_cap_deverr_init(PCIDevice
*dev
)
124 uint32_t pos
= dev
->exp
.exp_cap
;
125 pci_long_test_and_set_mask(dev
->config
+ pos
+ PCI_EXP_DEVCAP
,
126 PCI_EXP_DEVCAP_RBER
);
127 pci_long_test_and_set_mask(dev
->wmask
+ pos
+ PCI_EXP_DEVCTL
,
128 PCI_EXP_DEVCTL_CERE
| PCI_EXP_DEVCTL_NFERE
|
129 PCI_EXP_DEVCTL_FERE
| PCI_EXP_DEVCTL_URRE
);
130 pci_long_test_and_set_mask(dev
->w1cmask
+ pos
+ PCI_EXP_DEVSTA
,
131 PCI_EXP_DEVSTA_CED
| PCI_EXP_DEVSTA_NFED
|
132 PCI_EXP_DEVSTA_URD
| PCI_EXP_DEVSTA_URD
);
135 void pcie_cap_deverr_reset(PCIDevice
*dev
)
137 uint8_t *devctl
= dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCTL
;
138 pci_long_test_and_clear_mask(devctl
,
139 PCI_EXP_DEVCTL_CERE
| PCI_EXP_DEVCTL_NFERE
|
140 PCI_EXP_DEVCTL_FERE
| PCI_EXP_DEVCTL_URRE
);
143 static void hotplug_event_update_event_status(PCIDevice
*dev
)
145 uint32_t pos
= dev
->exp
.exp_cap
;
146 uint8_t *exp_cap
= dev
->config
+ pos
;
147 uint16_t sltctl
= pci_get_word(exp_cap
+ PCI_EXP_SLTCTL
);
148 uint16_t sltsta
= pci_get_word(exp_cap
+ PCI_EXP_SLTSTA
);
150 dev
->exp
.hpev_notified
= (sltctl
& PCI_EXP_SLTCTL_HPIE
) &&
151 (sltsta
& sltctl
& PCI_EXP_HP_EV_SUPPORTED
);
154 static void hotplug_event_notify(PCIDevice
*dev
)
156 bool prev
= dev
->exp
.hpev_notified
;
158 hotplug_event_update_event_status(dev
);
160 if (prev
== dev
->exp
.hpev_notified
) {
164 /* Note: the logic above does not take into account whether interrupts
165 * are masked. The result is that interrupt will be sent when it is
166 * subsequently unmasked. This appears to be legal: Section 6.7.3.4:
167 * The Port may optionally send an MSI when there are hot-plug events that
168 * occur while interrupt generation is disabled, and interrupt generation is
169 * subsequently enabled. */
170 if (!pci_msi_enabled(dev
)) {
171 qemu_set_irq(dev
->irq
[dev
->exp
.hpev_intx
], dev
->exp
.hpev_notified
);
172 } else if (dev
->exp
.hpev_notified
) {
173 pci_msi_notify(dev
, pcie_cap_flags_get_vector(dev
));
178 * A PCI Express Hot-Plug Event has occured, so update slot status register
179 * and notify OS of the event if necessary.
181 * 6.7.3 PCI Express Hot-Plug Events
182 * 6.7.3.4 Software Notification of Hot-Plug Events
184 static void pcie_cap_slot_event(PCIDevice
*dev
, PCIExpressHotPlugEvent event
)
186 /* Minor optimization: if nothing changed - no event is needed. */
187 if (pci_word_test_and_set_mask(dev
->config
+ dev
->exp
.exp_cap
+
188 PCI_EXP_SLTSTA
, event
)) {
191 hotplug_event_notify(dev
);
194 static int pcie_cap_slot_hotplug(DeviceState
*qdev
,
195 PCIDevice
*pci_dev
, int state
)
197 PCIDevice
*d
= DO_UPCAST(PCIDevice
, qdev
, qdev
);
198 uint8_t *exp_cap
= d
->config
+ d
->exp
.exp_cap
;
199 uint16_t sltsta
= pci_get_word(exp_cap
+ PCI_EXP_SLTSTA
);
201 if (!pci_dev
->qdev
.hotplugged
) {
202 assert(state
); /* this case only happens at machine creation. */
203 pci_word_test_and_set_mask(exp_cap
+ PCI_EXP_SLTSTA
,
208 PCIE_DEV_PRINTF(pci_dev
, "hotplug state: %d\n", state
);
209 if (sltsta
& PCI_EXP_SLTSTA_EIS
) {
210 /* the slot is electromechanically locked.
211 * This error is propagated up to qdev and then to HMP/QMP.
216 /* TODO: multifunction hot-plug.
217 * Right now, only a device of function = 0 is allowed to be
218 * hot plugged/unplugged.
220 assert(PCI_FUNC(pci_dev
->devfn
) == 0);
223 pci_word_test_and_set_mask(exp_cap
+ PCI_EXP_SLTSTA
,
225 pcie_cap_slot_event(d
, PCI_EXP_HP_EV_PDC
);
227 qdev_free(&pci_dev
->qdev
);
228 pci_word_test_and_clear_mask(exp_cap
+ PCI_EXP_SLTSTA
,
230 pcie_cap_slot_event(d
, PCI_EXP_HP_EV_PDC
);
235 /* pci express slot for pci express root/downstream port
236 PCI express capability slot registers */
237 void pcie_cap_slot_init(PCIDevice
*dev
, uint16_t slot
)
239 uint32_t pos
= dev
->exp
.exp_cap
;
241 pci_word_test_and_set_mask(dev
->config
+ pos
+ PCI_EXP_FLAGS
,
244 pci_long_test_and_clear_mask(dev
->config
+ pos
+ PCI_EXP_SLTCAP
,
245 ~PCI_EXP_SLTCAP_PSN
);
246 pci_long_test_and_set_mask(dev
->config
+ pos
+ PCI_EXP_SLTCAP
,
247 (slot
<< PCI_EXP_SLTCAP_PSN_SHIFT
) |
255 pci_word_test_and_clear_mask(dev
->config
+ pos
+ PCI_EXP_SLTCTL
,
258 pci_word_test_and_set_mask(dev
->config
+ pos
+ PCI_EXP_SLTCTL
,
259 PCI_EXP_SLTCTL_PIC_OFF
|
260 PCI_EXP_SLTCTL_AIC_OFF
);
261 pci_word_test_and_set_mask(dev
->wmask
+ pos
+ PCI_EXP_SLTCTL
,
264 PCI_EXP_SLTCTL_HPIE
|
265 PCI_EXP_SLTCTL_CCIE
|
266 PCI_EXP_SLTCTL_PDCE
|
267 PCI_EXP_SLTCTL_ABPE
);
268 /* Although reading PCI_EXP_SLTCTL_EIC returns always 0,
269 * make the bit writable here in order to detect 1b is written.
270 * pcie_cap_slot_write_config() test-and-clear the bit, so
271 * this bit always returns 0 to the guest.
273 pci_word_test_and_set_mask(dev
->wmask
+ pos
+ PCI_EXP_SLTCTL
,
276 pci_word_test_and_set_mask(dev
->w1cmask
+ pos
+ PCI_EXP_SLTSTA
,
277 PCI_EXP_HP_EV_SUPPORTED
);
279 dev
->exp
.hpev_notified
= false;
281 pci_bus_hotplug(pci_bridge_get_sec_bus(DO_UPCAST(PCIBridge
, dev
, dev
)),
282 pcie_cap_slot_hotplug
, &dev
->qdev
);
285 void pcie_cap_slot_reset(PCIDevice
*dev
)
287 uint8_t *exp_cap
= dev
->config
+ dev
->exp
.exp_cap
;
289 PCIE_DEV_PRINTF(dev
, "reset\n");
291 pci_word_test_and_clear_mask(exp_cap
+ PCI_EXP_SLTCTL
,
295 PCI_EXP_SLTCTL_HPIE
|
296 PCI_EXP_SLTCTL_CCIE
|
297 PCI_EXP_SLTCTL_PDCE
|
298 PCI_EXP_SLTCTL_ABPE
);
299 pci_word_test_and_set_mask(exp_cap
+ PCI_EXP_SLTCTL
,
300 PCI_EXP_SLTCTL_PIC_OFF
|
301 PCI_EXP_SLTCTL_AIC_OFF
);
303 pci_word_test_and_clear_mask(exp_cap
+ PCI_EXP_SLTSTA
,
304 PCI_EXP_SLTSTA_EIS
|/* on reset,
305 the lock is released */
310 hotplug_event_update_event_status(dev
);
313 void pcie_cap_slot_write_config(PCIDevice
*dev
,
314 uint32_t addr
, uint32_t val
, int len
)
316 uint32_t pos
= dev
->exp
.exp_cap
;
317 uint8_t *exp_cap
= dev
->config
+ pos
;
318 uint16_t sltsta
= pci_get_word(exp_cap
+ PCI_EXP_SLTSTA
);
320 if (!ranges_overlap(addr
, len
, pos
+ PCI_EXP_SLTCTL
, 2)) {
324 if (pci_word_test_and_clear_mask(exp_cap
+ PCI_EXP_SLTCTL
,
325 PCI_EXP_SLTCTL_EIC
)) {
326 sltsta
^= PCI_EXP_SLTSTA_EIS
; /* toggle PCI_EXP_SLTSTA_EIS bit */
327 pci_set_word(exp_cap
+ PCI_EXP_SLTSTA
, sltsta
);
328 PCIE_DEV_PRINTF(dev
, "PCI_EXP_SLTCTL_EIC: "
329 "sltsta -> 0x%02"PRIx16
"\n",
333 hotplug_event_notify(dev
);
336 * 6.7.3.2 Command Completed Events
338 * Software issues a command to a hot-plug capable Downstream Port by
339 * issuing a write transaction that targets any portion of the Port’s Slot
340 * Control register. A single write to the Slot Control register is
341 * considered to be a single command, even if the write affects more than
342 * one field in the Slot Control register. In response to this transaction,
343 * the Port must carry out the requested actions and then set the
344 * associated status field for the command completed event. */
346 /* Real hardware might take a while to complete requested command because
347 * physical movement would be involved like locking the electromechanical
348 * lock. However in our case, command is completed instantaneously above,
349 * so send a command completion event right now.
351 pcie_cap_slot_event(dev
, PCI_EXP_HP_EV_CCI
);
354 int pcie_cap_slot_post_load(void *opaque
, int version_id
)
356 PCIDevice
*dev
= opaque
;
357 hotplug_event_update_event_status(dev
);
361 void pcie_cap_slot_push_attention_button(PCIDevice
*dev
)
363 pcie_cap_slot_event(dev
, PCI_EXP_HP_EV_ABP
);
366 /* root control/capabilities/status. PME isn't emulated for now */
367 void pcie_cap_root_init(PCIDevice
*dev
)
369 pci_set_word(dev
->wmask
+ dev
->exp
.exp_cap
+ PCI_EXP_RTCTL
,
370 PCI_EXP_RTCTL_SECEE
| PCI_EXP_RTCTL_SENFEE
|
371 PCI_EXP_RTCTL_SEFEE
);
374 void pcie_cap_root_reset(PCIDevice
*dev
)
376 pci_set_word(dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_RTCTL
, 0);
380 * TODO: implement FLR:
381 * Right now sets the bit which indicates FLR is supported.
383 /* function level reset(FLR) */
384 void pcie_cap_flr_init(PCIDevice
*dev
)
386 pci_long_test_and_set_mask(dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCAP
,
389 /* Although reading BCR_FLR returns always 0,
390 * the bit is made writable here in order to detect the 1b is written
391 * pcie_cap_flr_write_config() test-and-clear the bit, so
392 * this bit always returns 0 to the guest.
394 pci_word_test_and_set_mask(dev
->wmask
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCTL
,
395 PCI_EXP_DEVCTL_BCR_FLR
);
398 void pcie_cap_flr_write_config(PCIDevice
*dev
,
399 uint32_t addr
, uint32_t val
, int len
)
401 uint8_t *devctl
= dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCTL
;
402 if (pci_word_test_and_clear_mask(devctl
, PCI_EXP_DEVCTL_BCR_FLR
)) {
403 /* TODO: implement FLR */
407 /* Alternative Routing-ID Interpretation (ARI) */
408 /* ari forwarding support for down stream port */
409 void pcie_cap_ari_init(PCIDevice
*dev
)
411 uint32_t pos
= dev
->exp
.exp_cap
;
412 pci_long_test_and_set_mask(dev
->config
+ pos
+ PCI_EXP_DEVCAP2
,
413 PCI_EXP_DEVCAP2_ARI
);
414 pci_long_test_and_set_mask(dev
->wmask
+ pos
+ PCI_EXP_DEVCTL2
,
415 PCI_EXP_DEVCTL2_ARI
);
418 void pcie_cap_ari_reset(PCIDevice
*dev
)
420 uint8_t *devctl2
= dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCTL2
;
421 pci_long_test_and_clear_mask(devctl2
, PCI_EXP_DEVCTL2_ARI
);
424 bool pcie_cap_is_ari_enabled(const PCIDevice
*dev
)
426 if (!pci_is_express(dev
)) {
429 if (!dev
->exp
.exp_cap
) {
433 return pci_get_long(dev
->config
+ dev
->exp
.exp_cap
+ PCI_EXP_DEVCTL2
) &
437 /**************************************************************************
438 * pci express extended capability allocation functions
439 * uint16_t ext_cap_id (16 bit)
440 * uint8_t cap_ver (4 bit)
441 * uint16_t cap_offset (12 bit)
442 * uint16_t ext_cap_size
445 static uint16_t pcie_find_capability_list(PCIDevice
*dev
, uint16_t cap_id
,
450 uint32_t header
= pci_get_long(dev
->config
+ PCI_CONFIG_SPACE_SIZE
);
453 /* no extended capability */
457 for (next
= PCI_CONFIG_SPACE_SIZE
; next
;
458 prev
= next
, next
= PCI_EXT_CAP_NEXT(header
)) {
460 assert(next
>= PCI_CONFIG_SPACE_SIZE
);
461 assert(next
<= PCIE_CONFIG_SPACE_SIZE
- 8);
463 header
= pci_get_long(dev
->config
+ next
);
464 if (PCI_EXT_CAP_ID(header
) == cap_id
) {
476 uint16_t pcie_find_capability(PCIDevice
*dev
, uint16_t cap_id
)
478 return pcie_find_capability_list(dev
, cap_id
, NULL
);
481 static void pcie_ext_cap_set_next(PCIDevice
*dev
, uint16_t pos
, uint16_t next
)
483 uint16_t header
= pci_get_long(dev
->config
+ pos
);
484 assert(!(next
& (PCI_EXT_CAP_ALIGN
- 1)));
485 header
= (header
& ~PCI_EXT_CAP_NEXT_MASK
) |
486 ((next
<< PCI_EXT_CAP_NEXT_SHIFT
) & PCI_EXT_CAP_NEXT_MASK
);
487 pci_set_long(dev
->config
+ pos
, header
);
491 * caller must supply valid (offset, size) * such that the range shouldn't
492 * overlap with other capability or other registers.
493 * This function doesn't check it.
495 void pcie_add_capability(PCIDevice
*dev
,
496 uint16_t cap_id
, uint8_t cap_ver
,
497 uint16_t offset
, uint16_t size
)
502 assert(offset
>= PCI_CONFIG_SPACE_SIZE
);
503 assert(offset
< offset
+ size
);
504 assert(offset
+ size
< PCIE_CONFIG_SPACE_SIZE
);
506 assert(pci_is_express(dev
));
508 if (offset
== PCI_CONFIG_SPACE_SIZE
) {
509 header
= pci_get_long(dev
->config
+ offset
);
510 next
= PCI_EXT_CAP_NEXT(header
);
514 /* 0 is reserved cap id. use internally to find the last capability
515 in the linked list */
516 next
= pcie_find_capability_list(dev
, 0, &prev
);
518 assert(prev
>= PCI_CONFIG_SPACE_SIZE
);
520 pcie_ext_cap_set_next(dev
, prev
, offset
);
522 pci_set_long(dev
->config
+ offset
, PCI_EXT_CAP(cap_id
, cap_ver
, next
));
524 /* Make capability read-only by default */
525 memset(dev
->wmask
+ offset
, 0, size
);
526 memset(dev
->w1cmask
+ offset
, 0, size
);
527 /* Check capability by default */
528 memset(dev
->cmask
+ offset
, 0xFF, size
);
531 /**************************************************************************
532 * pci express extended capability helper functions
536 void pcie_ari_init(PCIDevice
*dev
, uint16_t offset
, uint16_t nextfn
)
538 pcie_add_capability(dev
, PCI_EXT_CAP_ID_ARI
, PCI_ARI_VER
,
539 offset
, PCI_ARI_SIZEOF
);
540 pci_set_long(dev
->config
+ offset
+ PCI_ARI_CAP
, PCI_ARI_CAP_NFN(nextfn
));