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

/*
 *	The PCI Library
 *
 *	Copyright (c) 1997--2008 Martin Mares <mj@ucw.cz>
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _PCI_LIB_H
#define _PCI_LIB_H

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

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

#define PCI_LIB_VERSION 0x030100

#ifndef PCI_ABI
#define PCI_ABI
#endif

/*
 *	PCI Access Structure
 */

struct pci_methods;

enum pci_access_type {
  /* Known access methods, remember to update access.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_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);	/* 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_failed;
  int id_cache_status;			/* 0=not read, 1=read, 2=dirty */
  int fd;				/* proc: fd */
  int fd_rw;				/* proc: fd opened read-write */
  struct pci_dev *cached_dev;		/* proc: device the fd is for */
  int fd_pos;				/* proc: current position */
};

/* 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;				/* PCI domain (host bridge) */
  u8 bus, dev, func;			/* Bus inside domain, device and function */

  /* These fields are set by pci_fill_info() */
  int known_fields;			/* Set of info fields already known */
  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 */
  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 */

  /* 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 *aux;				/* Auxillary data */
};

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

u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; /* Access to configuration space */
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_block(struct pci_dev *, 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;
int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;

int pci_fill_info(struct pci_dev *, int flags) PCI_ABI; /* Fill in device information */

#define PCI_FILL_IDENT		1
#define PCI_FILL_IRQ		2
#define PCI_FILL_BASES		4
#define PCI_FILL_ROM_BASE	8
#define PCI_FILL_SIZES		16
#define PCI_FILL_CLASS		32
#define PCI_FILL_CAPS		64
#define PCI_FILL_EXT_CAPS	128
#define PCI_FILL_RESCAN		0x10000

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;

/*
 *	Filters
 */

struct pci_filter {
  int domain, bus, slot, func;			/* -1 = ANY */
  int vendor, device;
};

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 */
};

#endif
Commit	Line	Data
727ce158	1	/*
727ce158 MM	2	* The PCI Library
727ce158 MM	3	*
103f074c	4	* Copyright (c) 1997--2008 Martin Mares <mj@ucw.cz>
727ce158 MM	5	*
	6	* Can be freely distributed and used under the terms of the GNU GPL.
	7	*/
	8
	9	#ifndef _PCI_LIB_H
	10	#define _PCI_LIB_H
	11
59a0211a	12	#ifndef PCI_CONFIG_H
727ce158	13	#include "config.h"
59a0211a MM	14	#endif
59a0211a MM	15
727ce158	16	#include "header.h"
489233b4	17	#include "types.h"
f3395cc5	18
89c51b98	19	#define PCI_LIB_VERSION 0x030100
043ebdee	20
2f421184 MM	21	#ifndef PCI_ABI
	22	#define PCI_ABI
	23	#endif
	24
727ce158 MM	25	/*
	26	* PCI Access Structure
	27	*/
	28
	29	struct pci_methods;
727ce158	30
d772ef15 MM	31	enum pci_access_type {
d772ef15 MM	32	/* Known access methods, remember to update access.c as well */
cb6ee324 MM	33	PCI_ACCESS_AUTO, /* Autodetection */
	34	PCI_ACCESS_SYS_BUS_PCI, /* Linux /sys/bus/pci */
	35	PCI_ACCESS_PROC_BUS_PCI, /* Linux /proc/bus/pci */
	36	PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 */
	37	PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 */
	38	PCI_ACCESS_FBSD_DEVICE, /* FreeBSD /dev/pci */
d772ef15 MM	39	PCI_ACCESS_AIX_DEVICE, /* /dev/pci0, /dev/bus0, etc. */
d772ef15 MM	40	PCI_ACCESS_NBSD_LIBPCI, /* NetBSD libpci */
b6359063	41	PCI_ACCESS_OBSD_DEVICE, /* OpenBSD /dev/pci */
cb6ee324	42	PCI_ACCESS_DUMP, /* Dump file */
d772ef15 MM	43	PCI_ACCESS_MAX
d772ef15 MM	44	};
727ce158 MM	45
	46	struct pci_access {
	47	/* Options you can change: */
	48	unsigned int method; /* Access method */
727ce158 MM	49	int writeable; /* Open in read/write mode */
727ce158 MM	50	int buscentric; /* Bus-centric view of the world */
103f074c MM	51
103f074c MM	52	char id_file_name; / Name of ID list file (use pci_set_name_list_path()) */
cc062b4a	53	int free_id_name; /* Set if id_file_name is malloced */
bc2eed2d	54	int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
103f074c MM	55
103f074c MM	56	unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */
98ccf6d6	57	/* Default: PCI_LOOKUP_CACHE */
103f074c	58
727ce158 MM	59	int debugging; /* Turn on debugging messages */
	60
	61	/* Functions you can override: */
4f6b38ca MM	62	void (error)(char msg, ...) PCI_PRINTF(1,2); /* Write error message and quit */
	63	void (warning)(char msg, ...) PCI_PRINTF(1,2); /* Write a warning message */
	64	void (debug)(char msg, ...) PCI_PRINTF(1,2); /* Write a debugging message */
727ce158 MM	65
	66	struct pci_dev devices; / Devices found on this bus */
	67
	68	/* Fields used internally: */
	69	struct pci_methods *methods;
fa182368	70	struct pci_param *params;
aeaca5d3 MM	71	struct id_entry *id_hash; / names.c */
aeaca5d3 MM	72	struct id_bucket *current_id_bucket;
103f074c MM	73	int id_load_failed;
103f074c MM	74	int id_cache_status; /* 0=not read, 1=read, 2=dirty */
727ce158 MM	75	int fd; /* proc: fd */
	76	int fd_rw; /* proc: fd opened read-write */
	77	struct pci_dev cached_dev; / proc: device the fd is for */
bc6346df	78	int fd_pos; /* proc: current position */
727ce158 MM	79	};
	80
	81	/* Initialize PCI access */
2f421184 MM	82	struct pci_access *pci_alloc(void) PCI_ABI;
	83	void pci_init(struct pci_access *) PCI_ABI;
	84	void pci_cleanup(struct pci_access *) PCI_ABI;
727ce158 MM	85
727ce158 MM	86	/* Scanning of devices */
2f421184 MM	87	void pci_scan_bus(struct pci_access *acc) PCI_ABI;
	88	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 */
	89	void pci_free_dev(struct pci_dev *) PCI_ABI;
727ce158	90
9ff67879	91	/* Names of access methods */
2f421184 MM	92	int pci_lookup_method(char name) PCI_ABI; / Returns -1 if not found */
2f421184 MM	93	char pci_get_method_name(int index) PCI_ABI; / Returns "" if unavailable, NULL if index out of range */
9ff67879	94
fa182368 MM	95	/*
	96	* Named parameters
	97	*/
	98
	99	struct pci_param {
	100	struct pci_param next; / Please use pci_walk_params() for traversing the list */
	101	char param; / Name of the parameter */
	102	char value; / Value of the parameter */
	103	int value_malloced; /* used internally */
0f24ef6f	104	char help; / Explanation of the parameter */
fa182368 MM	105	};
fa182368 MM	106
2f421184 MM	107	char pci_get_param(struct pci_access acc, char *param) PCI_ABI;
2f421184 MM	108	int pci_set_param(struct pci_access acc, char param, char value) PCI_ABI; / 0 on success, -1 if no such parameter */
fa182368	109	/* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
2f421184	110	struct pci_param pci_walk_params(struct pci_access acc, struct pci_param *prev) PCI_ABI;
fa182368	111
727ce158 MM	112	/*
	113	* Devices
	114	*/
	115
	116	struct pci_dev {
	117	struct pci_dev next; / Next device in the chain */
84c8d1bb	118	u16 domain; /* PCI domain (host bridge) */
f31412d1	119	u8 bus, dev, func; /* Bus inside domain, device and function */
727ce158 MM	120
727ce158 MM	121	/* These fields are set by pci_fill_info() */
e95c8373	122	int known_fields; /* Set of info fields already known */
f31412d1	123	u16 vendor_id, device_id; /* Identity of the device */
c2b144ef	124	u16 device_class; /* PCI device class */
727ce158	125	int irq; /* IRQ number */
f3395cc5	126	pciaddr_t base_addr[6]; /* Base addresses */
e95c8373	127	pciaddr_t size[6]; /* Region sizes */
f3395cc5	128	pciaddr_t rom_base_addr; /* Expansion ROM base address */
e95c8373	129	pciaddr_t rom_size; /* Expansion ROM size */
89c51b98	130	struct pci_cap first_cap; / List of capabilities */
727ce158 MM	131
	132	/* Fields used internally: */
	133	struct pci_access *access;
	134	struct pci_methods *methods;
f31412d1	135	u8 cache; / Cached config registers */
3430bafe	136	int cache_len;
6aa54f1b	137	int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
727ce158 MM	138	void aux; / Auxillary data */
	139	};
	140
f3395cc5 MM	141	#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
	142	#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
	143
2f421184 MM	144	u8 pci_read_byte(struct pci_dev , int pos) PCI_ABI; / Access to configuration space */
	145	u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
	146	u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
	147	int pci_read_block(struct pci_dev , int pos, u8 buf, int len) PCI_ABI;
	148	int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
	149	int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
	150	int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
	151	int pci_write_block(struct pci_dev , int pos, u8 buf, int len) PCI_ABI;
727ce158	152
2f421184	153	int pci_fill_info(struct pci_dev , int flags) PCI_ABI; / Fill in device information */
727ce158 MM	154
	155	#define PCI_FILL_IDENT 1
	156	#define PCI_FILL_IRQ 2
	157	#define PCI_FILL_BASES 4
	158	#define PCI_FILL_ROM_BASE 8
e95c8373	159	#define PCI_FILL_SIZES 16
c2b144ef	160	#define PCI_FILL_CLASS 32
6d5e39ac MM	161	#define PCI_FILL_CAPS 64
6d5e39ac MM	162	#define PCI_FILL_EXT_CAPS 128
727ce158 MM	163	#define PCI_FILL_RESCAN 0x10000
727ce158 MM	164
2f421184	165	void pci_setup_cache(struct pci_dev , u8 cache, int len) PCI_ABI;
727ce158	166
6d5e39ac MM	167	/*
	168	* Capabilities
	169	*/
	170
	171	struct pci_cap {
	172	struct pci_cap *next;
	173	u16 id; /* PCI_CAP_ID_xxx */
	174	u16 type; /* PCI_CAP_xxx */
	175	unsigned int addr; /* Position in the config space */
	176	};
	177
7831d7f9 MM	178	#define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */
7831d7f9 MM	179	#define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */
6d5e39ac MM	180
	181	struct pci_cap pci_find_cap(struct pci_dev , unsigned int id, unsigned int type) PCI_ABI;
	182
727ce158 MM	183	/*
	184	* Filters
	185	*/
	186
	187	struct pci_filter {
84c8d1bb	188	int domain, bus, slot, func; /* -1 = ANY */
727ce158 MM	189	int vendor, device;
	190	};
	191
2f421184 MM	192	void pci_filter_init(struct pci_access , struct pci_filter ) PCI_ABI;
	193	char pci_filter_parse_slot(struct pci_filter , char *) PCI_ABI;
	194	char pci_filter_parse_id(struct pci_filter , char *) PCI_ABI;
	195	int pci_filter_match(struct pci_filter , struct pci_dev ) PCI_ABI;
727ce158 MM	196
727ce158 MM	197	/*
aeaca5d3 MM	198	* Conversion of PCI ID's to names (according to the pci.ids file)
	199	*
	200	* Call pci_lookup_name() to identify different types of ID's:
	201	*
	202	* VENDOR (vendorID) -> vendor
	203	* DEVICE (vendorID, deviceID) -> device
	204	* VENDOR \| DEVICE (vendorID, deviceID) -> combined vendor and device
	205	* SUBSYSTEM \| VENDOR (subvendorID) -> subsystem vendor
	206	* SUBSYSTEM \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
	207	* SUBSYSTEM \| VENDOR \| DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
	208	* SUBSYSTEM \| ... (-1, -1, subvendorID, subdevID) -> generic subsystem
	209	* CLASS (classID) -> class
	210	* PROGIF (classID, progif) -> programming interface
727ce158 MM	211	*/
727ce158 MM	212
2f421184	213	char pci_lookup_name(struct pci_access a, char *buf, int size, int flags, ...) PCI_ABI;
727ce158	214
2f421184 MM	215	int pci_load_name_list(struct pci_access a) PCI_ABI; / Called automatically by pci_lookup_() when needed; returns success /
	216	void pci_free_name_list(struct pci_access a) PCI_ABI; / Called automatically by pci_cleanup() */
	217	void pci_set_name_list_path(struct pci_access a, char name, int to_be_freed) PCI_ABI;
	218	void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
aeaca5d3 MM	219
	220	enum pci_lookup_mode {
	221	PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
	222	PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
	223	PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
	224	PCI_LOOKUP_SUBSYSTEM = 8,
	225	PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
	226	PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
bc2eed2d MM	227	PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
bc2eed2d MM	228	PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */
103f074c MM	229	PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */
	230	PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */
	231	PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */
	232	PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */
aeaca5d3	233	};
727ce158 MM	234
727ce158 MM	235	#endif