258 lines
6.8 KiB
C
258 lines
6.8 KiB
C
/*-
|
|
* Copyright (c) 1997, Stefan Esser <se@freebsd.org>
|
|
* Copyright (c) 2011 NetApp, Inc.
|
|
* Copyright (c) 2018 Intel Corporation
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef PCI_H_
|
|
#define PCI_H_
|
|
|
|
/*
|
|
* PCIM_xxx: mask to locate subfield in register
|
|
* PCIR_xxx: config register offset
|
|
* PCIC_xxx: device class
|
|
* PCIS_xxx: device subclass
|
|
* PCIP_xxx: device programming interface
|
|
* PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
|
|
* PCID_xxx: device ID
|
|
* PCIY_xxx: capability identification number
|
|
* PCIZ_xxx: extended capability identification number
|
|
*/
|
|
|
|
/* some PCI bus constants */
|
|
#define PCI_BUSMAX 0xFFU
|
|
#define PCI_SLOTMAX 0x1FU
|
|
#define PCI_FUNCMAX 0x7U
|
|
#define PCI_BAR_COUNT 0x6U
|
|
#define PCI_REGMAX 0xFFU
|
|
|
|
/* I/O ports */
|
|
#define PCI_CONFIG_ADDR 0xCF8U
|
|
#define PCI_CONFIG_DATA 0xCFCU
|
|
|
|
#define PCI_CFG_ENABLE 0x80000000U
|
|
|
|
/* PCI config header registers for all devices */
|
|
#define PCIR_VENDOR 0x00U
|
|
#define PCIR_DEVICE 0x02U
|
|
#define PCIR_COMMAND 0x04U
|
|
#define PCIM_CMD_PORTEN 0x01U
|
|
#define PCIM_CMD_MEMEN 0x02U
|
|
#define PCIM_CMD_INTxDIS 0x400U
|
|
#define PCIR_STATUS 0x06U
|
|
#define PCIM_STATUS_CAPPRESENT 0x0010U
|
|
#define PCIR_REVID 0x08U
|
|
#define PCIR_SUBCLASS 0x0AU
|
|
#define PCIR_CLASS 0x0BU
|
|
#define PCIR_HDRTYPE 0x0EU
|
|
#define PCIM_HDRTYPE 0x7FU
|
|
#define PCIM_HDRTYPE_NORMAL 0x00U
|
|
#define PCIM_HDRTYPE_BRIDGE 0x01U
|
|
#define PCIM_HDRTYPE_CARDBUS 0x02U
|
|
#define PCIM_MFDEV 0x80U
|
|
#define PCIR_BARS 0x10U
|
|
#define PCIM_BAR_SPACE 0x01U
|
|
#define PCIM_BAR_IO_SPACE 0x01U
|
|
#define PCIM_BAR_MEM_TYPE 0x06U
|
|
#define PCIM_BAR_MEM_32 0x00U
|
|
#define PCIM_BAR_MEM_1MB 0x02U
|
|
#define PCIM_BAR_MEM_64 0x04U
|
|
#define PCIM_BAR_MEM_BASE 0xFFFFFFF0U
|
|
#define PCIR_CAP_PTR 0x34U
|
|
|
|
/* config registers for header type 1 (PCI-to-PCI bridge) devices */
|
|
#define PCIR_PRIBUS_1 0x18U
|
|
#define PCIR_SECBUS_1 0x19U
|
|
#define PCIR_SUBBUS_1 0x1AU
|
|
|
|
/* Capability Register Offsets */
|
|
#define PCICAP_ID 0x0U
|
|
#define PCICAP_NEXTPTR 0x1U
|
|
|
|
/* Capability Identification Numbers */
|
|
#define PCIY_MSI 0x05U
|
|
#define PCIY_MSIX 0x11U
|
|
|
|
/* PCI Message Signalled Interrupts (MSI) */
|
|
#define PCIR_MSI_CTRL 0x02U
|
|
#define PCIM_MSICTRL_64BIT 0x80U
|
|
#define PCIM_MSICTRL_MSI_ENABLE 0x01U
|
|
#define PCIR_MSI_ADDR 0x4U
|
|
#define PCIR_MSI_ADDR_HIGH 0x8U
|
|
#define PCIR_MSI_DATA 0x8U
|
|
#define PCIR_MSI_DATA_64BIT 0xCU
|
|
#define PCIR_MSI_MASK 0x10U
|
|
#define PCIM_MSICTRL_MMC_MASK 0x000EU
|
|
#define PCIM_MSICTRL_MME_MASK 0x0070U
|
|
|
|
/* PCI device class */
|
|
#define PCIC_BRIDGE 0x06U
|
|
#define PCIS_BRIDGE_HOST 0x00U
|
|
|
|
/* MSI-X definitions */
|
|
#define PCIR_MSIX_CTRL 0x2U
|
|
#define PCIR_MSIX_TABLE 0x4U
|
|
#define PCIR_MSIX_PBA 0x8U
|
|
|
|
#define PCIM_MSIXCTRL_MSIX_ENABLE 0x8000U
|
|
#define PCIM_MSIXCTRL_FUNCTION_MASK 0x4000U
|
|
#define PCIM_MSIXCTRL_TABLE_SIZE 0x07FFU
|
|
#define PCIM_MSIX_BIR_MASK 0x7U
|
|
#define PCIM_MSIX_VCTRL_MASK 0x1U
|
|
|
|
#define MSI_MAX_CAPLEN 14U
|
|
#define MSIX_CAPLEN 12U
|
|
#define MSIX_TABLE_ENTRY_SIZE 16U
|
|
|
|
union pci_bdf {
|
|
uint16_t value;
|
|
struct {
|
|
uint8_t f : 3; /* BITs 0-2 */
|
|
uint8_t d : 5; /* BITs 3-7 */
|
|
uint8_t b; /* BITs 8-15 */
|
|
} bits;
|
|
};
|
|
|
|
enum pci_bar_type {
|
|
PCIBAR_NONE = 0,
|
|
PCIBAR_IO_SPACE,
|
|
PCIBAR_MEM32,
|
|
PCIBAR_MEM64,
|
|
};
|
|
|
|
struct pci_bar {
|
|
uint64_t base;
|
|
uint64_t size;
|
|
enum pci_bar_type type;
|
|
};
|
|
|
|
/* Basic MSI capability info */
|
|
struct pci_msi_cap {
|
|
uint32_t capoff;
|
|
uint32_t caplen;
|
|
uint8_t cap[MSI_MAX_CAPLEN];
|
|
};
|
|
|
|
/* Basic MSIX capability info */
|
|
struct pci_msix_cap {
|
|
uint32_t capoff;
|
|
uint32_t caplen;
|
|
uint8_t table_bar;
|
|
uint32_t table_offset;
|
|
uint32_t table_count;
|
|
uint8_t cap[MSIX_CAPLEN];
|
|
};
|
|
|
|
struct pci_pdev {
|
|
/* The bar info of the physical PCI device. */
|
|
struct pci_bar bar[PCI_BAR_COUNT];
|
|
|
|
/* The bus/device/function triple of the physical PCI device. */
|
|
union pci_bdf bdf;
|
|
|
|
struct pci_msi_cap msi;
|
|
|
|
struct pci_msix_cap msix;
|
|
};
|
|
|
|
typedef void (*pci_pdev_enumeration_cb)(struct pci_pdev *pdev, const void *data);
|
|
|
|
static inline uint32_t pci_bar_offset(uint32_t idx)
|
|
{
|
|
return PCIR_BARS + (idx << 2U);
|
|
}
|
|
|
|
static inline bool pci_bar_access(uint32_t offset)
|
|
{
|
|
bool ret;
|
|
|
|
if ((offset >= pci_bar_offset(0U))
|
|
&& (offset < pci_bar_offset(PCI_BAR_COUNT))) {
|
|
ret = true;
|
|
} else {
|
|
ret = false;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
static inline uint8_t pci_bus(uint16_t bdf)
|
|
{
|
|
return (uint8_t)((bdf >> 8U) & 0xFFU);
|
|
}
|
|
|
|
static inline uint8_t pci_slot(uint16_t bdf)
|
|
{
|
|
return (uint8_t)((bdf >> 3U) & 0x1FU);
|
|
}
|
|
|
|
static inline uint8_t pci_func(uint16_t bdf)
|
|
{
|
|
return (uint8_t)(bdf & 0x7U);
|
|
}
|
|
|
|
static inline uint8_t pci_devfn(uint16_t bdf)
|
|
{
|
|
return (uint8_t)(bdf & 0xFFU);
|
|
}
|
|
|
|
/**
|
|
* @pre a != NULL
|
|
* @pre b != NULL
|
|
*/
|
|
static inline bool bdf_is_equal(const union pci_bdf *a, const union pci_bdf *b)
|
|
{
|
|
return (a->value == b->value);
|
|
}
|
|
|
|
/**
|
|
* @pre bar != NULL
|
|
*/
|
|
static inline bool is_mmio_bar(const struct pci_bar *bar)
|
|
{
|
|
return (bar->type == PCIBAR_MEM32) || (bar->type == PCIBAR_MEM64);
|
|
}
|
|
|
|
/**
|
|
* @pre bar != NULL
|
|
*/
|
|
static inline bool is_valid_bar_size(const struct pci_bar *bar)
|
|
{
|
|
return (bar->size > 0UL) && (bar->size <= 0xffffffffU);
|
|
}
|
|
|
|
uint32_t pci_pdev_read_cfg(union pci_bdf bdf, uint32_t offset, uint32_t bytes);
|
|
void pci_pdev_write_cfg(union pci_bdf bdf, uint32_t offset, uint32_t bytes, uint32_t val);
|
|
void enable_disable_pci_intx(union pci_bdf bdf, bool enable);
|
|
|
|
void pci_pdev_foreach(pci_pdev_enumeration_cb cb, const void *ctx);
|
|
struct pci_pdev *find_pci_pdev(union pci_bdf pbdf);
|
|
void init_pci_pdev_list(void);
|
|
|
|
|
|
#endif /* PCI_H_ */
|