[thirdparty/pciutils.git] / lib / pci.h

/*
 *	The PCI Library
 *
 *	Copyright (c) 1997--2025 Martin Mares <mj@ucw.cz>
 *
 *	Can be freely distributed and used under the terms of the GNU GPL v2+
 *
 *	SPDX-License-Identifier: GPL-2.0-or-later
 */

#ifndef _PCI_LIB_H
#define _PCI_LIB_H

#ifdef  __cplusplus
extern "C" {
#endif

#ifndef PCI_CONFIG_H
#include "config.h"
#endif

#include "header.h"
#include "types.h"

#define PCI_LIB_VERSION 0x030e00

#ifndef PCI_ABI
#define PCI_ABI
#endif

/*
 *	PCI Access Structure
 */

struct pci_methods;

enum pci_access_type {
  /* Known access methods, remember to update init.c as well */
  PCI_ACCESS_AUTO,			/* Autodetection */
  PCI_ACCESS_SYS_BUS_PCI,		/* Linux /sys/bus/pci */
  PCI_ACCESS_PROC_BUS_PCI,		/* Linux /proc/bus/pci */
  PCI_ACCESS_I386_TYPE1,		/* i386 ports, type 1 */
  PCI_ACCESS_I386_TYPE2,		/* i386 ports, type 2 */
  PCI_ACCESS_FBSD_DEVICE,		/* FreeBSD /dev/pci */
  PCI_ACCESS_AIX_DEVICE,		/* /dev/pci0, /dev/bus0, etc. */
  PCI_ACCESS_NBSD_LIBPCI,		/* NetBSD libpci */
  PCI_ACCESS_OBSD_DEVICE,		/* OpenBSD /dev/pci */
  PCI_ACCESS_DUMP,			/* Dump file */
  PCI_ACCESS_DARWIN,			/* Darwin */
  PCI_ACCESS_SYLIXOS_DEVICE,		/* SylixOS pci */
  PCI_ACCESS_HURD,			/* GNU/Hurd */
  PCI_ACCESS_WIN32_CFGMGR32,		/* Win32 cfgmgr32.dll */
  PCI_ACCESS_WIN32_KLDBG,		/* Win32 kldbgdrv.sys */
  PCI_ACCESS_WIN32_SYSDBG,		/* Win32 NT SysDbg */
  PCI_ACCESS_MMIO_TYPE1,		/* MMIO ports, type 1 */
  PCI_ACCESS_MMIO_TYPE1_EXT,		/* MMIO ports, type 1 extended */
  PCI_ACCESS_ECAM,			/* PCIe ECAM via /dev/mem */
  PCI_ACCESS_AOS_EXPANSION,		/* AmigaOS Expansion library */
  PCI_ACCESS_RT_THREAD_SMART_DM,	/* RT-Thread Smart pci */
  PCI_ACCESS_MAX
};

struct pci_access {
  /* Options you can change: */
  unsigned int method;			/* Access method */
  int writeable;			/* Open in read/write mode */
  int buscentric;			/* Bus-centric view of the world */

  char *id_file_name;			/* Name of ID list file (use pci_set_name_list_path()) */
  int free_id_name;			/* Set if id_file_name is malloced */
  int numeric_ids;			/* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */

  unsigned int id_lookup_mode;		/* pci_lookup_mode flags which are set automatically */
					/* Default: PCI_LOOKUP_CACHE */

  int debugging;			/* Turn on debugging messages */

  /* Functions you can override: */
  void (*error)(char *msg, ...) PCI_PRINTF(1,2) PCI_NONRET;	/* Write error message and quit */
  void (*warning)(char *msg, ...) PCI_PRINTF(1,2);	/* Write a warning message */
  void (*debug)(char *msg, ...) PCI_PRINTF(1,2);	/* Write a debugging message */

  struct pci_dev *devices;		/* Devices found on this bus */

  /* Fields used internally: */
  struct pci_methods *methods;
  struct pci_param *params;
  struct id_entry **id_hash;		/* names.c */
  struct id_bucket *current_id_bucket;
  int id_load_attempted;
  int id_cache_status;			/* 0=not read, 1=read, 2=dirty */
  char *id_cache_name;
  struct udev *id_udev;			/* names-hwdb.c */
  struct udev_hwdb *id_udev_hwdb;
  int fd;				/* proc/sys: fd for config space */
  int fd_rw;				/* proc/sys: fd opened read-write */
  int fd_vpd;				/* sys: fd for VPD */
  struct pci_dev *cached_dev;		/* proc/sys: device the fds are for */
  void *backend_data;			/* Private data of the back end */
};

/* Initialize PCI access */
struct pci_access *pci_alloc(void) PCI_ABI;
void pci_init(struct pci_access *) PCI_ABI;
void pci_cleanup(struct pci_access *) PCI_ABI;

/* Scanning of devices */
void pci_scan_bus(struct pci_access *acc) PCI_ABI;
struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func) PCI_ABI; /* Raw access to specified device */
void pci_free_dev(struct pci_dev *) PCI_ABI;

/* Names of access methods */
int pci_lookup_method(char *name) PCI_ABI;	/* Returns -1 if not found */
char *pci_get_method_name(int index) PCI_ABI;	/* Returns "" if unavailable, NULL if index out of range */

/*
 *	Named parameters
 */

struct pci_param {
  struct pci_param *next;		/* Please use pci_walk_params() for traversing the list */
  char *param;				/* Name of the parameter */
  char *value;				/* Value of the parameter */
  int value_malloced;			/* used internally */
  char *help;				/* Explanation of the parameter */
};

char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI;
int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI;	/* 0 on success, -1 if no such parameter */
/* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI;

/*
 *	Devices
 */

struct pci_dev {
  struct pci_dev *next;			/* Next device in the chain */
  u16 domain_16;			/* 16-bit version of the PCI domain for backward compatibility */
					/* 0xffff if the real domain doesn't fit in 16 bits */
  u8 bus, dev, func;			/* Bus inside domain, device and function */

  /* These fields are set by pci_fill_info() */
  unsigned int known_fields;		/* Set of info fields already known (see pci_fill_info()) */
  u16 vendor_id, device_id;		/* Identity of the device */
  u16 device_class;			/* PCI device class */
  int irq;				/* IRQ number */
  pciaddr_t base_addr[6];		/* Base addresses including flags in lower bits */
  pciaddr_t size[6];			/* Region sizes */
  pciaddr_t rom_base_addr;		/* Expansion ROM base address */
  pciaddr_t rom_size;			/* Expansion ROM size */
  struct pci_cap *first_cap;		/* List of capabilities */
  char *phy_slot;			/* Physical slot */
  char *module_alias;			/* Linux kernel module alias */
  char *label;				/* Device name as exported by BIOS */
  int numa_node;			/* NUMA node */
  pciaddr_t flags[6];			/* PCI_IORESOURCE_* flags for regions */
  pciaddr_t rom_flags;			/* PCI_IORESOURCE_* flags for expansion ROM */
  int domain;				/* PCI domain (host bridge) */
  pciaddr_t bridge_base_addr[4];	/* Bridge base addresses (without flags) */
  pciaddr_t bridge_size[4];		/* Bridge sizes */
  pciaddr_t bridge_flags[4];		/* PCI_IORESOURCE_* flags for bridge addresses */
  u8 prog_if, rev_id;			/* Programming interface for device_class and revision id */
  u16 subsys_vendor_id, subsys_id;	/* Subsystem vendor id and subsystem id */
  struct pci_dev *parent;		/* Parent device, does not have to be always accessible */
  int no_config_access;			/* No access to config space for this device */
  u32 rcd_link_cap;     		/* Link Capabilities register for Restricted CXL Devices */
  u16 rcd_link_status;  		/* Link Status register for RCD */
  u16 rcd_link_ctrl;    		/* Link Control register for RCD */

  /* Fields used internally */
  struct pci_access *access;
  struct pci_methods *methods;
  u8 *cache;				/* Cached config registers */
  int cache_len;
  int hdrtype;				/* Cached low 7 bits of header type, -1 if unknown */
  void *backend_data;			/* Private data for of the back end */
  struct pci_property *properties;	/* A linked list of extra properties */
  struct pci_cap *last_cap;		/* Last capability in the list */
};

#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
#define PCI_ADDR_FLAG_MASK 0xf

/* Access to configuration space */
u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI;
u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI;
int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;

/* Configuration space as a sequence of bytes (little-endian) */
int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;

/*
 * Most device properties take some effort to obtain, so libpci does not
 * initialize them during default bus scan. Instead, you have to call
 * pci_fill_info() with the proper PCI_FILL_xxx constants OR'ed together.
 *
 * Some properties are stored directly in the pci_dev structure.
 * The remaining ones can be accessed through pci_get_string_property().
 *
 * pci_fill_info() returns the current value of pci_dev->known_fields.
 * This is a bit mask of all fields, which were already obtained during
 * the lifetime of the device. This includes fields which are not supported
 * by the particular device -- in that case, the field is left at its default
 * value, which is 0 for integer fields and NULL for pointers. On the other
 * hand, we never consider known fields unsupported by the current back-end;
 * such fields always contain the default value.
 *
 * XXX: flags and the result should be unsigned, but we do not want to break the ABI.
 */

int pci_fill_info(struct pci_dev *, int flags) PCI_ABI;
char *pci_get_string_property(struct pci_dev *d, u32 prop) PCI_ABI;

#define PCI_FILL_IDENT		0x0001		/* vendor and device ID */
#define PCI_FILL_IRQ		0x0002
#define PCI_FILL_BASES		0x0004
#define PCI_FILL_ROM_BASE	0x0008
#define PCI_FILL_SIZES		0x0010
#define PCI_FILL_CLASS		0x0020
#define PCI_FILL_CAPS		0x0040		/* capabilities */
#define PCI_FILL_EXT_CAPS	0x0080		/* extended capabilities */
#define PCI_FILL_PHYS_SLOT	0x0100		/* physical slot (string property) */
#define PCI_FILL_MODULE_ALIAS	0x0200		/* Linux kernel module alias (string property) */
#define PCI_FILL_LABEL		0x0400		/* (string property) */
#define PCI_FILL_NUMA_NODE	0x0800
#define PCI_FILL_IO_FLAGS	0x1000
#define PCI_FILL_DT_NODE	0x2000		/* Device tree node (string property) */
#define PCI_FILL_IOMMU_GROUP	0x4000		/* (string property) */
#define PCI_FILL_BRIDGE_BASES	0x8000
#define PCI_FILL_RESCAN		0x00010000	/* force re-scan of cached properties */
#define PCI_FILL_CLASS_EXT	0x00020000      /* prog_if and rev_id */
#define PCI_FILL_SUBSYS		0x00040000      /* subsys_vendor_id and subsys_id */
#define PCI_FILL_PARENT		0x00080000
#define PCI_FILL_DRIVER		0x00100000      /* OS driver currently in use (string property) */
#define PCI_FILL_RCD_LNK	0x00200000      /* CXL RCD Link status properties (rcd_*) */

void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI;

/*
 *	Capabilities
 */

struct pci_cap {
  struct pci_cap *next;
  u16 id;				/* PCI_CAP_ID_xxx */
  u16 type;				/* PCI_CAP_xxx */
  unsigned int addr;			/* Position in the config space */
};

#define PCI_CAP_NORMAL		1	/* Traditional PCI capabilities */
#define PCI_CAP_EXTENDED	2	/* PCIe extended capabilities */

struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI;
struct pci_cap *pci_find_cap_nr(struct pci_dev *, unsigned int id, unsigned int type,
                                unsigned int *cap_number) PCI_ABI;

/*
 *	Filters
 */

struct pci_filter {
  int domain, bus, slot, func;			/* -1 = ANY */
  int vendor, device;
  int device_class;
  unsigned int device_class_mask;		/* Which bits of the device_class are compared, default=all */
  int prog_if;
  int rfu[1];
};

void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI;
char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI;
char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI;
int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI;

/*
 *	Conversion of PCI ID's to names (according to the pci.ids file)
 *
 *	Call pci_lookup_name() to identify different types of ID's:
 *
 *	VENDOR				(vendorID) -> vendor
 *	DEVICE				(vendorID, deviceID) -> device
 *	VENDOR | DEVICE			(vendorID, deviceID) -> combined vendor and device
 *	SUBSYSTEM | VENDOR		(subvendorID) -> subsystem vendor
 *	SUBSYSTEM | DEVICE		(vendorID, deviceID, subvendorID, subdevID) -> subsystem device
 *	SUBSYSTEM | VENDOR | DEVICE	(vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
 *	SUBSYSTEM | ...			(-1, -1, subvendorID, subdevID) -> generic subsystem
 *	CLASS				(classID) -> class
 *	PROGIF				(classID, progif) -> programming interface
 */

char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI;

int pci_load_name_list(struct pci_access *a) PCI_ABI;	/* Called automatically by pci_lookup_*() when needed; returns success */
void pci_free_name_list(struct pci_access *a) PCI_ABI;	/* Called automatically by pci_cleanup() */
void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI;
void pci_id_cache_flush(struct pci_access *a) PCI_ABI;

enum pci_lookup_mode {
  PCI_LOOKUP_VENDOR = 1,		/* Vendor name (args: vendorID) */
  PCI_LOOKUP_DEVICE = 2,		/* Device name (args: vendorID, deviceID) */
  PCI_LOOKUP_CLASS = 4,			/* Device class (args: classID) */
  PCI_LOOKUP_SUBSYSTEM = 8,
  PCI_LOOKUP_PROGIF = 16,		/* Programming interface (args: classID, prog_if) */
  PCI_LOOKUP_NUMERIC = 0x10000,		/* Want only formatted numbers; default if access->numeric_ids is set */
  PCI_LOOKUP_NO_NUMBERS = 0x20000,	/* Return NULL if not found in the database; default is to print numerically */
  PCI_LOOKUP_MIXED = 0x40000,		/* Include both numbers and names */
  PCI_LOOKUP_NETWORK = 0x80000,		/* Try to resolve unknown ID's by DNS */
  PCI_LOOKUP_SKIP_LOCAL = 0x100000,	/* Do not consult local database */
  PCI_LOOKUP_CACHE = 0x200000,		/* Consult the local cache before using DNS */
  PCI_LOOKUP_REFRESH_CACHE = 0x400000,	/* Forget all previously cached entries, but still allow updating the cache */
  PCI_LOOKUP_NO_HWDB = 0x800000,	/* Do not ask udev's hwdb */
};

#ifdef  __cplusplus
}
#endif

#endif
Commit	Line	Data
727ce158	1	/*
727ce158 MM	2	* The PCI Library
727ce158 MM	3	*
0fb1f314	4	* Copyright (c) 1997--2025 Martin Mares <mj@ucw.cz>
727ce158	5	*
61829219 MM	6	* Can be freely distributed and used under the terms of the GNU GPL v2+
	7	*
	8	* SPDX-License-Identifier: GPL-2.0-or-later
727ce158 MM	9	*/
	10
	11	#ifndef _PCI_LIB_H
	12	#define _PCI_LIB_H
	13
0fb1f314 MM	14	#ifdef __cplusplus
	15	extern "C" {
	16	#endif
	17
59a0211a	18	#ifndef PCI_CONFIG_H
727ce158	19	#include "config.h"
59a0211a MM	20	#endif
59a0211a MM	21
727ce158	22	#include "header.h"
489233b4	23	#include "types.h"
f3395cc5	24
6f6d842e	25	#define PCI_LIB_VERSION 0x030e00
043ebdee	26
2f421184 MM	27	#ifndef PCI_ABI
	28	#define PCI_ABI
	29	#endif
	30
727ce158 MM	31	/*
	32	* PCI Access Structure
	33	*/
	34
	35	struct pci_methods;
727ce158	36
d772ef15	37	enum pci_access_type {
59cfe93d	38	/* Known access methods, remember to update init.c as well */
cb6ee324 MM	39	PCI_ACCESS_AUTO, /* Autodetection */
	40	PCI_ACCESS_SYS_BUS_PCI, /* Linux /sys/bus/pci */
	41	PCI_ACCESS_PROC_BUS_PCI, /* Linux /proc/bus/pci */
	42	PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 */
	43	PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 */
	44	PCI_ACCESS_FBSD_DEVICE, /* FreeBSD /dev/pci */
d772ef15 MM	45	PCI_ACCESS_AIX_DEVICE, /* /dev/pci0, /dev/bus0, etc. */
d772ef15 MM	46	PCI_ACCESS_NBSD_LIBPCI, /* NetBSD libpci */
b6359063	47	PCI_ACCESS_OBSD_DEVICE, /* OpenBSD /dev/pci */
5bdd27f6	48	PCI_ACCESS_DUMP, /* Dump file */
7cb1afbe	49	PCI_ACCESS_DARWIN, /* Darwin */
0a913370 JL	50	PCI_ACCESS_SYLIXOS_DEVICE, /* SylixOS pci */
0a913370 JL	51	PCI_ACCESS_HURD, /* GNU/Hurd */
26c8b543	52	PCI_ACCESS_WIN32_CFGMGR32, /* Win32 cfgmgr32.dll */
aa5a16ef	53	PCI_ACCESS_WIN32_KLDBG, /* Win32 kldbgdrv.sys */
2d0af6fc	54	PCI_ACCESS_WIN32_SYSDBG, /* Win32 NT SysDbg */
0a7350fb	55	PCI_ACCESS_MMIO_TYPE1, /* MMIO ports, type 1 */
e2d9340b	56	PCI_ACCESS_MMIO_TYPE1_EXT, /* MMIO ports, type 1 extended */
2ba0f6f4	57	PCI_ACCESS_ECAM, /* PCIe ECAM via /dev/mem */
5b52ae79	58	PCI_ACCESS_AOS_EXPANSION, /* AmigaOS Expansion library */
021d41cf	59	PCI_ACCESS_RT_THREAD_SMART_DM, /* RT-Thread Smart pci */
d772ef15 MM	60	PCI_ACCESS_MAX
d772ef15 MM	61	};
727ce158 MM	62
	63	struct pci_access {
	64	/* Options you can change: */
	65	unsigned int method; /* Access method */
727ce158 MM	66	int writeable; /* Open in read/write mode */
727ce158 MM	67	int buscentric; /* Bus-centric view of the world */
103f074c MM	68
103f074c MM	69	char id_file_name; / Name of ID list file (use pci_set_name_list_path()) */
cc062b4a	70	int free_id_name; /* Set if id_file_name is malloced */
bc2eed2d	71	int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
103f074c MM	72
103f074c MM	73	unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */
98ccf6d6	74	/* Default: PCI_LOOKUP_CACHE */
103f074c	75
727ce158 MM	76	int debugging; /* Turn on debugging messages */
	77
	78	/* Functions you can override: */
eeef8fed	79	void (error)(char msg, ...) PCI_PRINTF(1,2) PCI_NONRET; /* Write error message and quit */
4f6b38ca MM	80	void (warning)(char msg, ...) PCI_PRINTF(1,2); /* Write a warning message */
4f6b38ca MM	81	void (debug)(char msg, ...) PCI_PRINTF(1,2); /* Write a debugging message */
727ce158 MM	82
	83	struct pci_dev devices; / Devices found on this bus */
	84
	85	/* Fields used internally: */
	86	struct pci_methods *methods;
fa182368	87	struct pci_param *params;
aeaca5d3 MM	88	struct id_entry *id_hash; / names.c */
aeaca5d3 MM	89	struct id_bucket *current_id_bucket;
06f9ecf3	90	int id_load_attempted;
103f074c	91	int id_cache_status; /* 0=not read, 1=read, 2=dirty */
f022f467	92	char *id_cache_name;
ac357d3b MM	93	struct udev id_udev; / names-hwdb.c */
ac357d3b MM	94	struct udev_hwdb *id_udev_hwdb;
9bd5b1cf BH	95	int fd; /* proc/sys: fd for config space */
9bd5b1cf BH	96	int fd_rw; /* proc/sys: fd opened read-write */
9bd5b1cf BH	97	int fd_vpd; /* sys: fd for VPD */
9bd5b1cf BH	98	struct pci_dev cached_dev; / proc/sys: device the fds are for */
a997ef13	99	void backend_data; / Private data of the back end */
727ce158 MM	100	};
	101
	102	/* Initialize PCI access */
2f421184 MM	103	struct pci_access *pci_alloc(void) PCI_ABI;
	104	void pci_init(struct pci_access *) PCI_ABI;
	105	void pci_cleanup(struct pci_access *) PCI_ABI;
727ce158 MM	106
727ce158 MM	107	/* Scanning of devices */
2f421184 MM	108	void pci_scan_bus(struct pci_access *acc) PCI_ABI;
	109	struct pci_dev pci_get_dev(struct pci_access acc, int domain, int bus, int dev, int func) PCI_ABI; /* Raw access to specified device */
	110	void pci_free_dev(struct pci_dev *) PCI_ABI;
727ce158	111
9ff67879	112	/* Names of access methods */
2f421184 MM	113	int pci_lookup_method(char name) PCI_ABI; / Returns -1 if not found */
2f421184 MM	114	char pci_get_method_name(int index) PCI_ABI; / Returns "" if unavailable, NULL if index out of range */
9ff67879	115
fa182368 MM	116	/*
	117	* Named parameters
	118	*/
	119
	120	struct pci_param {
	121	struct pci_param next; / Please use pci_walk_params() for traversing the list */
	122	char param; / Name of the parameter */
	123	char value; / Value of the parameter */
	124	int value_malloced; /* used internally */
0f24ef6f	125	char help; / Explanation of the parameter */
fa182368 MM	126	};
fa182368 MM	127
2f421184 MM	128	char pci_get_param(struct pci_access acc, char *param) PCI_ABI;
2f421184 MM	129	int pci_set_param(struct pci_access acc, char param, char value) PCI_ABI; / 0 on success, -1 if no such parameter */
fa182368	130	/* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
2f421184	131	struct pci_param pci_walk_params(struct pci_access acc, struct pci_param *prev) PCI_ABI;
fa182368	132
727ce158 MM	133	/*
	134	* Devices
	135	*/
	136
	137	struct pci_dev {
	138	struct pci_dev next; / Next device in the chain */
4186391b MM	139	u16 domain_16; /* 16-bit version of the PCI domain for backward compatibility */
4186391b MM	140	/* 0xffff if the real domain doesn't fit in 16 bits */
f31412d1	141	u8 bus, dev, func; /* Bus inside domain, device and function */
727ce158 MM	142
727ce158 MM	143	/* These fields are set by pci_fill_info() */
82c06b47	144	unsigned int known_fields; /* Set of info fields already known (see pci_fill_info()) */
f31412d1	145	u16 vendor_id, device_id; /* Identity of the device */
c2b144ef	146	u16 device_class; /* PCI device class */
727ce158	147	int irq; /* IRQ number */
f3d91991	148	pciaddr_t base_addr[6]; /* Base addresses including flags in lower bits */
e95c8373	149	pciaddr_t size[6]; /* Region sizes */
f3395cc5	150	pciaddr_t rom_base_addr; /* Expansion ROM base address */
e95c8373	151	pciaddr_t rom_size; /* Expansion ROM size */
89c51b98	152	struct pci_cap first_cap; / List of capabilities */
2849a165	153	char phy_slot; / Physical slot */
b1861a8d	154	char module_alias; / Linux kernel module alias */
aecf5b35	155	char label; / Device name as exported by BIOS */
7ef7f3ec	156	int numa_node; /* NUMA node */
3d0a6d88 MM	157	pciaddr_t flags[6]; /* PCI_IORESOURCE_* flags for regions */
3d0a6d88 MM	158	pciaddr_t rom_flags; /* PCI_IORESOURCE_* flags for expansion ROM */
4186391b	159	int domain; /* PCI domain (host bridge) */
119c1376 PR	160	pciaddr_t bridge_base_addr[4]; /* Bridge base addresses (without flags) */
	161	pciaddr_t bridge_size[4]; /* Bridge sizes */
	162	pciaddr_t bridge_flags[4]; /* PCI_IORESOURCE_* flags for bridge addresses */
b84f2154 PR	163	u8 prog_if, rev_id; /* Programming interface for device_class and revision id */
b84f2154 PR	164	u16 subsys_vendor_id, subsys_id; /* Subsystem vendor id and subsystem id */
5e9714ac	165	struct pci_dev parent; / Parent device, does not have to be always accessible */
08609192	166	int no_config_access; /* No access to config space for this device */
a8a0f810 MM	167	u32 rcd_link_cap; /* Link Capabilities register for Restricted CXL Devices */
	168	u16 rcd_link_status; /* Link Status register for RCD */
	169	u16 rcd_link_ctrl; /* Link Control register for RCD */
727ce158	170
c02d903c	171	/* Fields used internally */
727ce158 MM	172	struct pci_access *access;
727ce158 MM	173	struct pci_methods *methods;
f31412d1	174	u8 cache; / Cached config registers */
3430bafe	175	int cache_len;
6aa54f1b	176	int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
a997ef13	177	void backend_data; / Private data for of the back end */
c02d903c	178	struct pci_property properties; / A linked list of extra properties */
9c48ed23	179	struct pci_cap last_cap; / Last capability in the list */
727ce158 MM	180	};
727ce158 MM	181
f3395cc5 MM	182	#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
f3395cc5 MM	183	#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
6d143c32	184	#define PCI_ADDR_FLAG_MASK 0xf
f3395cc5	185
bca04128 MM	186	/* Access to configuration space */
bca04128 MM	187	u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI;
2f421184 MM	188	u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
2f421184 MM	189	u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
52c81519	190	int pci_read_vpd(struct pci_dev d, int pos, u8 buf, int len) PCI_ABI;
2f421184 MM	191	int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
	192	int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
	193	int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
bca04128 MM	194
	195	/* Configuration space as a sequence of bytes (little-endian) */
	196	int pci_read_block(struct pci_dev , int pos, u8 buf, int len) PCI_ABI;
2f421184	197	int pci_write_block(struct pci_dev , int pos, u8 buf, int len) PCI_ABI;
727ce158	198
c02d903c MM	199	/*
	200	* Most device properties take some effort to obtain, so libpci does not
	201	* initialize them during default bus scan. Instead, you have to call
	202	* pci_fill_info() with the proper PCI_FILL_xxx constants OR'ed together.
	203	*
	204	* Some properties are stored directly in the pci_dev structure.
	205	* The remaining ones can be accessed through pci_get_string_property().
82c06b47 MM	206	*
	207	* pci_fill_info() returns the current value of pci_dev->known_fields.
	208	* This is a bit mask of all fields, which were already obtained during
	209	* the lifetime of the device. This includes fields which are not supported
	210	* by the particular device -- in that case, the field is left at its default
	211	* value, which is 0 for integer fields and NULL for pointers. On the other
	212	* hand, we never consider known fields unsupported by the current back-end;
	213	* such fields always contain the default value.
	214	*
	215	* XXX: flags and the result should be unsigned, but we do not want to break the ABI.
c02d903c MM	216	*/
	217
	218	int pci_fill_info(struct pci_dev *, int flags) PCI_ABI;
	219	char pci_get_string_property(struct pci_dev d, u32 prop) PCI_ABI;
727ce158	220
4c392dc3	221	#define PCI_FILL_IDENT 0x0001 /* vendor and device ID */
7ef7f3ec MM	222	#define PCI_FILL_IRQ 0x0002
	223	#define PCI_FILL_BASES 0x0004
	224	#define PCI_FILL_ROM_BASE 0x0008
	225	#define PCI_FILL_SIZES 0x0010
	226	#define PCI_FILL_CLASS 0x0020
4c392dc3 MM	227	#define PCI_FILL_CAPS 0x0040 /* capabilities */
	228	#define PCI_FILL_EXT_CAPS 0x0080 /* extended capabilities */
	229	#define PCI_FILL_PHYS_SLOT 0x0100 /* physical slot (string property) */
	230	#define PCI_FILL_MODULE_ALIAS 0x0200 /* Linux kernel module alias (string property) */
	231	#define PCI_FILL_LABEL 0x0400 /* (string property) */
7ef7f3ec	232	#define PCI_FILL_NUMA_NODE 0x0800
558f736b	233	#define PCI_FILL_IO_FLAGS 0x1000
4c392dc3 MM	234	#define PCI_FILL_DT_NODE 0x2000 /* Device tree node (string property) */
4c392dc3 MM	235	#define PCI_FILL_IOMMU_GROUP 0x4000 /* (string property) */
119c1376	236	#define PCI_FILL_BRIDGE_BASES 0x8000
4c392dc3	237	#define PCI_FILL_RESCAN 0x00010000 /* force re-scan of cached properties */
b84f2154 PR	238	#define PCI_FILL_CLASS_EXT 0x00020000 /* prog_if and rev_id */
b84f2154 PR	239	#define PCI_FILL_SUBSYS 0x00040000 /* subsys_vendor_id and subsys_id */
5e9714ac	240	#define PCI_FILL_PARENT 0x00080000
2b883e3f	241	#define PCI_FILL_DRIVER 0x00100000 /* OS driver currently in use (string property) */
a8a0f810	242	#define PCI_FILL_RCD_LNK 0x00200000 /* CXL RCD Link status properties (rcd_) /
727ce158	243
2f421184	244	void pci_setup_cache(struct pci_dev , u8 cache, int len) PCI_ABI;
727ce158	245
6d5e39ac MM	246	/*
	247	* Capabilities
	248	*/
	249
	250	struct pci_cap {
	251	struct pci_cap *next;
	252	u16 id; /* PCI_CAP_ID_xxx */
	253	u16 type; /* PCI_CAP_xxx */
	254	unsigned int addr; /* Position in the config space */
	255	};
	256
7831d7f9 MM	257	#define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */
7831d7f9 MM	258	#define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */
6d5e39ac MM	259
6d5e39ac MM	260	struct pci_cap pci_find_cap(struct pci_dev , unsigned int id, unsigned int type) PCI_ABI;
c22c314a	261	struct pci_cap pci_find_cap_nr(struct pci_dev , unsigned int id, unsigned int type,
d7d9e305	262	unsigned int *cap_number) PCI_ABI;
6d5e39ac	263
727ce158 MM	264	/*
	265	* Filters
	266	*/
	267
	268	struct pci_filter {
84c8d1bb	269	int domain, bus, slot, func; /* -1 = ANY */
511122b8 MM	270	int vendor, device;
	271	int device_class;
	272	unsigned int device_class_mask; /* Which bits of the device_class are compared, default=all */
	273	int prog_if;
	274	int rfu[1];
727ce158 MM	275	};
727ce158 MM	276
2f421184 MM	277	void pci_filter_init(struct pci_access , struct pci_filter ) PCI_ABI;
	278	char pci_filter_parse_slot(struct pci_filter , char *) PCI_ABI;
	279	char pci_filter_parse_id(struct pci_filter , char *) PCI_ABI;
	280	int pci_filter_match(struct pci_filter , struct pci_dev ) PCI_ABI;
727ce158 MM	281
727ce158 MM	282	/*
aeaca5d3 MM	283	* Conversion of PCI ID's to names (according to the pci.ids file)
	284	*
	285	* Call pci_lookup_name() to identify different types of ID's:
	286	*
	287	* VENDOR (vendorID) -> vendor
	288	* DEVICE (vendorID, deviceID) -> device
	289	* VENDOR \| DEVICE (vendorID, deviceID) -> combined vendor and device
	290	* SUBSYSTEM \| VENDOR (subvendorID) -> subsystem vendor
	291	* SUBSYSTEM \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
	292	* SUBSYSTEM \| VENDOR \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
	293	* SUBSYSTEM \| ... (-1, -1, subvendorID, subdevID) -> generic subsystem
	294	* CLASS (classID) -> class
	295	* PROGIF (classID, progif) -> programming interface
727ce158 MM	296	*/
727ce158 MM	297
2f421184	298	char pci_lookup_name(struct pci_access a, char *buf, int size, int flags, ...) PCI_ABI;
727ce158	299
2f421184 MM	300	int pci_load_name_list(struct pci_access a) PCI_ABI; / Called automatically by pci_lookup_() when needed; returns success /
	301	void pci_free_name_list(struct pci_access a) PCI_ABI; / Called automatically by pci_cleanup() */
	302	void pci_set_name_list_path(struct pci_access a, char name, int to_be_freed) PCI_ABI;
	303	void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
aeaca5d3 MM	304
	305	enum pci_lookup_mode {
	306	PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
	307	PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
	308	PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
	309	PCI_LOOKUP_SUBSYSTEM = 8,
	310	PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
	311	PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
bc2eed2d MM	312	PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
bc2eed2d MM	313	PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */
103f074c MM	314	PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */
	315	PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */
	316	PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */
	317	PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */
ac357d3b	318	PCI_LOOKUP_NO_HWDB = 0x800000, /* Do not ask udev's hwdb */
aeaca5d3	319	};
727ce158	320
0fb1f314 MM	321	#ifdef __cplusplus
	322	}
	323	#endif
	324
727ce158	325	#endif