LXR qemu/include/hw/pci/pcie.h

   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/hw.h"
  25#include "hw/pci/pci_regs.h"
  26#include "hw/pci/pcie_regs.h"
  27#include "hw/pci/pcie_aer.h"
  28#include "hw/hotplug.h"
  29
  30typedef enum {
  31    /* for attention and power indicator */
  32    PCI_EXP_HP_IND_RESERVED     = PCI_EXP_SLTCTL_IND_RESERVED,
  33    PCI_EXP_HP_IND_ON           = PCI_EXP_SLTCTL_IND_ON,
  34    PCI_EXP_HP_IND_BLINK        = PCI_EXP_SLTCTL_IND_BLINK,
  35    PCI_EXP_HP_IND_OFF          = PCI_EXP_SLTCTL_IND_OFF,
  36} PCIExpressIndicator;
  37
  38typedef enum {
  39    /* these bits must match the bits in Slot Control/Status registers.
  40     * PCI_EXP_HP_EV_xxx = PCI_EXP_SLTCTL_xxxE = PCI_EXP_SLTSTA_xxx
  41     *
  42     * Not all the bits of slot control register match with the ones of
  43     * slot status. Not some bits of slot status register is used to
  44     * show status, not to report event occurrence.
  45     * So such bits must be masked out when checking the software
  46     * notification condition.
  47     */
  48    PCI_EXP_HP_EV_ABP           = PCI_EXP_SLTCTL_ABPE,
  49                                        /* attention button pressed */
  50    PCI_EXP_HP_EV_PDC           = PCI_EXP_SLTCTL_PDCE,
  51                                        /* presence detect changed */
  52    PCI_EXP_HP_EV_CCI           = PCI_EXP_SLTCTL_CCIE,
  53                                        /* command completed */
  54
  55    PCI_EXP_HP_EV_SUPPORTED     = PCI_EXP_HP_EV_ABP |
  56                                  PCI_EXP_HP_EV_PDC |
  57                                  PCI_EXP_HP_EV_CCI,
  58                                                /* supported event mask  */
  59
  60    /* events not listed aren't supported */
  61} PCIExpressHotPlugEvent;
  62
  63struct PCIExpressDevice {
  64    /* Offset of express capability in config space */
  65    uint8_t exp_cap;
  66    /* Offset of Power Management capability in config space */
  67    uint8_t pm_cap;
  68
  69    /* SLOT */
  70    bool hpev_notified; /* Logical AND of conditions for hot plug event.
  71                         Following 6.7.3.4:
  72                         Software Notification of Hot-Plug Events, an interrupt
  73                         is sent whenever the logical and of these conditions
  74                         transitions from false to true. */
  75
  76    /* AER */
  77    uint16_t aer_cap;
  78    PCIEAERLog aer_log;
  79
  80    /* Offset of ATS capability in config space */
  81    uint16_t ats_cap;
  82
  83    /* ACS */
  84    uint16_t acs_cap;
  85};
  86
  87#define COMPAT_PROP_PCP "power_controller_present"
  88
  89/* PCI express capability helper functions */
  90int pcie_cap_init(PCIDevice *dev, uint8_t offset, uint8_t type,
  91                  uint8_t port, Error **errp);
  92int pcie_cap_v1_init(PCIDevice *dev, uint8_t offset,
  93                     uint8_t type, uint8_t port);
  94int pcie_endpoint_cap_init(PCIDevice *dev, uint8_t offset);
  95void pcie_cap_exit(PCIDevice *dev);
  96int pcie_endpoint_cap_v1_init(PCIDevice *dev, uint8_t offset);
  97void pcie_cap_v1_exit(PCIDevice *dev);
  98uint8_t pcie_cap_get_type(const PCIDevice *dev);
  99void pcie_cap_flags_set_vector(PCIDevice *dev, uint8_t vector);
 100uint8_t pcie_cap_flags_get_vector(PCIDevice *dev);
 101
 102void pcie_cap_deverr_init(PCIDevice *dev);
 103void pcie_cap_deverr_reset(PCIDevice *dev);
 104
 105void pcie_cap_lnkctl_init(PCIDevice *dev);
 106void pcie_cap_lnkctl_reset(PCIDevice *dev);
 107
 108void pcie_cap_slot_init(PCIDevice *dev, uint16_t slot);
 109void pcie_cap_slot_reset(PCIDevice *dev);
 110void pcie_cap_slot_get(PCIDevice *dev, uint16_t *slt_ctl, uint16_t *slt_sta);
 111void pcie_cap_slot_write_config(PCIDevice *dev,
 112                                uint16_t old_slt_ctl, uint16_t old_slt_sta,
 113                                uint32_t addr, uint32_t val, int len);
 114int pcie_cap_slot_post_load(void *opaque, int version_id);
 115void pcie_cap_slot_push_attention_button(PCIDevice *dev);
 116
 117void pcie_cap_root_init(PCIDevice *dev);
 118void pcie_cap_root_reset(PCIDevice *dev);
 119
 120void pcie_cap_flr_init(PCIDevice *dev);
 121void pcie_cap_flr_write_config(PCIDevice *dev,
 122                           uint32_t addr, uint32_t val, int len);
 123
 124/* ARI forwarding capability and control */
 125void pcie_cap_arifwd_init(PCIDevice *dev);
 126void pcie_cap_arifwd_reset(PCIDevice *dev);
 127bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev);
 128
 129/* PCI express extended capability helper functions */
 130uint16_t pcie_find_capability(PCIDevice *dev, uint16_t cap_id);
 131void pcie_add_capability(PCIDevice *dev,
 132                         uint16_t cap_id, uint8_t cap_ver,
 133                         uint16_t offset, uint16_t size);
 134void pcie_sync_bridge_lnk(PCIDevice *dev);
 135
 136void pcie_acs_init(PCIDevice *dev, uint16_t offset);
 137void pcie_acs_reset(PCIDevice *dev);
 138
 139void pcie_ari_init(PCIDevice *dev, uint16_t offset, uint16_t nextfn);
 140void pcie_dev_ser_num_init(PCIDevice *dev, uint16_t offset, uint64_t ser_num);
 141void pcie_ats_init(PCIDevice *dev, uint16_t offset);
 142
 143void pcie_cap_slot_pre_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
 144                               Error **errp);
 145void pcie_cap_slot_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
 146                           Error **errp);
 147void pcie_cap_slot_unplug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
 148                             Error **errp);
 149void pcie_cap_slot_unplug_request_cb(HotplugHandler *hotplug_dev,
 150                                     DeviceState *dev, Error **errp);
 151#endif /* QEMU_PCIE_H */
 152