]> mj.ucw.cz Git - pciutils.git/blobdiff - lib/pci.h
Cleanup of the Makefile system.
[pciutils.git] / lib / pci.h
index 37cb1be5440c84f2b3d65d753133cb4a8f753f4e..851e43f8b33928912cfefa42895571574db2aa3d 100644 (file)
--- a/lib/pci.h
+++ b/lib/pci.h
@@ -1,7 +1,7 @@
 /*
  *     The PCI Library
  *
- *     Copyright (c) 1997--2007 Martin Mares <mj@ucw.cz>
+ *     Copyright (c) 1997--2008 Martin Mares <mj@ucw.cz>
  *
  *     Can be freely distributed and used under the terms of the GNU GPL.
  */
@@ -13,7 +13,7 @@
 #include "header.h"
 #include "types.h"
 
-#define PCI_LIB_VERSION 0x020204
+#define PCI_LIB_VERSION 0x020299
 
 /*
  *     PCI Access Structure
@@ -23,44 +23,48 @@ 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_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 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 */
@@ -77,6 +81,27 @@ 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 *);
 
+/* Names of access methods */
+int pci_lookup_method(char *name);     /* Returns -1 if not found */
+char *pci_get_method_name(int index);  /* 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);
+int pci_set_param(struct pci_access *acc, char *param, char *value);   /* 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);
+
 /*
  *     Devices
  */
@@ -164,6 +189,7 @@ char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...)
 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);
+void pci_id_cache_flush(struct pci_access *a);
 
 enum pci_lookup_mode {
   PCI_LOOKUP_VENDOR = 1,               /* Vendor name (args: vendorID) */
@@ -174,6 +200,10 @@ 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 */
 };
 
 #endif