X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Fpci.h;h=8b1d02454657339b318e17099274bdc469c71d9e;hb=ac357d3bb8342b2fc22980e0914cdce7758ca310;hp=37cb1be5440c84f2b3d65d753133cb4a8f753f4e;hpb=470a397143a3bd940f1e79653076206f996803be;p=pciutils.git diff --git a/lib/pci.h b/lib/pci.h index 37cb1be..8b1d024 100644 --- a/lib/pci.h +++ b/lib/pci.h @@ -1,7 +1,7 @@ /* * The PCI Library * - * Copyright (c) 1997--2007 Martin Mares + * Copyright (c) 1997--2014 Martin Mares * * Can be freely distributed and used under the terms of the GNU GPL. */ @@ -9,11 +9,18 @@ #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 0x020204 +#define PCI_LIB_VERSION 0x030200 + +#ifndef PCI_ABI +#define PCI_ABI +#endif /* * PCI Access Structure @@ -23,59 +30,88 @@ struct pci_methods; enum pci_access_type { /* Known access methods, remember to update access.c as well */ - PCI_ACCESS_AUTO, /* Autodetection (params: none) */ - PCI_ACCESS_SYS_BUS_PCI, /* Linux /sys/bus/pci (params: path) */ - PCI_ACCESS_PROC_BUS_PCI, /* Linux /proc/bus/pci (params: path) */ - PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 (params: none) */ - PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 (params: none) */ - PCI_ACCESS_FBSD_DEVICE, /* FreeBSD /dev/pci (params: path) */ + 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 (params: filename) */ + PCI_ACCESS_DUMP, /* Dump file */ + PCI_ACCESS_DARWIN, /* Darwin */ PCI_ACCESS_MAX }; struct pci_access { /* Options you can change: */ unsigned int method; /* Access method */ - char *method_params[PCI_ACCESS_MAX]; /* Parameters for the methods */ int writeable; /* Open in read/write mode */ int buscentric; /* Bus-centric view of the world */ - char *id_file_name; /* Name of ID list file */ + + 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) */ - int network_ids; /* Try DNS lookups on unknown ID's */ - char *id_domain; /* DNS domain used for the lookups */ /* FIXME: set function? */ + + 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, ...); /* Write error message and quit */ - void (*warning)(char *msg, ...); /* Write a warning message */ - void (*debug)(char *msg, ...); /* Write a debugging message */ + 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 hash_load_failed; - 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 */ + int id_load_failed; + int id_cache_status; /* 0=not read, 1=read, 2=dirty */ + 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_pos; /* proc/sys: current position */ + int fd_vpd; /* sys: fd for VPD */ + struct pci_dev *cached_dev; /* proc/sys: device the fds are for */ }; /* Initialize PCI access */ -struct pci_access *pci_alloc(void); -void pci_init(struct pci_access *); -void pci_cleanup(struct 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); -struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func); /* Raw access to specified device */ -void pci_free_dev(struct pci_dev *); +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 @@ -91,10 +127,14 @@ struct pci_dev { 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 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 */ /* Fields used internally: */ struct pci_access *access; @@ -107,17 +147,19 @@ struct pci_dev { #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3) #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf) +#define PCI_ADDR_FLAG_MASK 0xf -u8 pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */ -u16 pci_read_word(struct pci_dev *, int pos); -u32 pci_read_long(struct pci_dev *, int pos); -int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len); -int pci_write_byte(struct pci_dev *, int pos, u8 data); -int pci_write_word(struct pci_dev *, int pos, u16 data); -int pci_write_long(struct pci_dev *, int pos, u32 data); -int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len); +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_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; +int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI; -int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */ +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 @@ -125,9 +167,30 @@ int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */ #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_PHYS_SLOT 256 +#define PCI_FILL_MODULE_ALIAS 512 +#define PCI_FILL_LABEL 1024 #define PCI_FILL_RESCAN 0x10000 -void pci_setup_cache(struct pci_dev *, u8 *cache, int len); +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 @@ -138,10 +201,10 @@ struct pci_filter { int vendor, device; }; -void pci_filter_init(struct pci_access *, struct pci_filter *); -char *pci_filter_parse_slot(struct pci_filter *, char *); -char *pci_filter_parse_id(struct pci_filter *, char *); -int pci_filter_match(struct pci_filter *, struct pci_dev *); +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) @@ -159,11 +222,12 @@ int pci_filter_match(struct pci_filter *, struct pci_dev *); * PROGIF (classID, progif) -> programming interface */ -char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...); +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); /* Called automatically by pci_lookup_*() when needed; returns success */ -void pci_free_name_list(struct pci_access *a); /* Called automatically by pci_cleanup() */ -void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed); +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) */ @@ -174,6 +238,11 @@ enum pci_lookup_mode { 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 */ }; #endif