| 1 | /*
|
|---|
| 2 | * The PCI Library
|
|---|
| 3 | *
|
|---|
| 4 | * Copyright (c) 1997--2005 Martin Mares <mj@ucw.cz>
|
|---|
| 5 | *
|
|---|
| 6 | * May 8, 2006 - Modified and ported to HelenOS by Jakub Jermar.
|
|---|
| 7 | *
|
|---|
| 8 | * Can be freely distributed and used under the terms of the GNU GPL.
|
|---|
| 9 | */
|
|---|
| 10 |
|
|---|
| 11 | #ifndef _PCI_LIB_H
|
|---|
| 12 | #define _PCI_LIB_H
|
|---|
| 13 |
|
|---|
| 14 | #include "header.h"
|
|---|
| 15 | #include "types.h"
|
|---|
| 16 |
|
|---|
| 17 | #define PCI_LIB_VERSION 0x020200
|
|---|
| 18 |
|
|---|
| 19 | /*
|
|---|
| 20 | * PCI Access Structure
|
|---|
| 21 | */
|
|---|
| 22 |
|
|---|
| 23 | struct pci_methods;
|
|---|
| 24 |
|
|---|
| 25 | enum pci_access_type {
|
|---|
| 26 | /* Known access methods, remember to update access.c as well */
|
|---|
| 27 | PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 (params: none) */
|
|---|
| 28 | PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 (params: none) */
|
|---|
| 29 | PCI_ACCESS_MAX
|
|---|
| 30 | };
|
|---|
| 31 |
|
|---|
| 32 | struct pci_access {
|
|---|
| 33 | /* Options you can change: */
|
|---|
| 34 | unsigned int method; /* Access method */
|
|---|
| 35 | char *method_params[PCI_ACCESS_MAX]; /* Parameters for the methods */
|
|---|
| 36 | int writeable; /* Open in read/write mode */
|
|---|
| 37 | int buscentric; /* Bus-centric view of the world */
|
|---|
| 38 | int numeric_ids; /* Don't resolve device IDs to names */
|
|---|
| 39 | int debugging; /* Turn on debugging messages */
|
|---|
| 40 |
|
|---|
| 41 | /* Functions you can override: */
|
|---|
| 42 | void (*error) (char *msg, ...); /* Write error message and quit */
|
|---|
| 43 | void (*warning) (char *msg, ...); /* Write a warning message */
|
|---|
| 44 | void (*debug) (char *msg, ...); /* Write a debugging message */
|
|---|
| 45 |
|
|---|
| 46 | struct pci_dev *devices; /* Devices found on this bus */
|
|---|
| 47 |
|
|---|
| 48 | /* Fields used internally: */
|
|---|
| 49 | struct pci_methods *methods;
|
|---|
| 50 | struct id_entry **id_hash; /* names.c */
|
|---|
| 51 | struct id_bucket *current_id_bucket;
|
|---|
| 52 | int fd; /* proc: fd */
|
|---|
| 53 | int fd_rw; /* proc: fd opened read-write */
|
|---|
| 54 | struct pci_dev *cached_dev; /* proc: device the fd is for */
|
|---|
| 55 | int fd_pos; /* proc: current position */
|
|---|
| 56 | };
|
|---|
| 57 |
|
|---|
| 58 | /* Initialize PCI access */
|
|---|
| 59 | struct pci_access *pci_alloc(void);
|
|---|
| 60 | void pci_init(struct pci_access *);
|
|---|
| 61 | void pci_cleanup(struct pci_access *);
|
|---|
| 62 |
|
|---|
| 63 | /* Scanning of devices */
|
|---|
| 64 | void pci_scan_bus(struct pci_access *acc);
|
|---|
| 65 | struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func); /* Raw access to specified device */
|
|---|
| 66 | void pci_free_dev(struct pci_dev *);
|
|---|
| 67 |
|
|---|
| 68 | /*
|
|---|
| 69 | * Devices
|
|---|
| 70 | */
|
|---|
| 71 |
|
|---|
| 72 | struct pci_dev {
|
|---|
| 73 | struct pci_dev *next; /* Next device in the chain */
|
|---|
| 74 | u16 domain; /* PCI domain (host bridge) */
|
|---|
| 75 | u8 bus, dev, func; /* Bus inside domain, device and function */
|
|---|
| 76 |
|
|---|
| 77 | /* These fields are set by pci_fill_info() */
|
|---|
| 78 | int known_fields; /* Set of info fields already known */
|
|---|
| 79 | u16 vendor_id, device_id; /* Identity of the device */
|
|---|
| 80 | int irq; /* IRQ number */
|
|---|
| 81 | pciaddr_t base_addr[6]; /* Base addresses */
|
|---|
| 82 | pciaddr_t size[6]; /* Region sizes */
|
|---|
| 83 | pciaddr_t rom_base_addr; /* Expansion ROM base address */
|
|---|
| 84 | pciaddr_t rom_size; /* Expansion ROM size */
|
|---|
| 85 |
|
|---|
| 86 | /* Fields used internally: */
|
|---|
| 87 | struct pci_access *access;
|
|---|
| 88 | struct pci_methods *methods;
|
|---|
| 89 | u8 *cache; /* Cached config registers */
|
|---|
| 90 | int cache_len;
|
|---|
| 91 | int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
|
|---|
| 92 | void *aux; /* Auxillary data */
|
|---|
| 93 | };
|
|---|
| 94 |
|
|---|
| 95 | #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
|
|---|
| 96 | #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
|
|---|
| 97 |
|
|---|
| 98 | u8 pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */
|
|---|
| 99 | u16 pci_read_word(struct pci_dev *, int pos);
|
|---|
| 100 | u32 pci_read_long(struct pci_dev *, int pos);
|
|---|
| 101 | int pci_read_block(struct pci_dev *, int pos, u8 * buf, int len);
|
|---|
| 102 | int pci_write_byte(struct pci_dev *, int pos, u8 data);
|
|---|
| 103 | int pci_write_word(struct pci_dev *, int pos, u16 data);
|
|---|
| 104 | int pci_write_long(struct pci_dev *, int pos, u32 data);
|
|---|
| 105 | int pci_write_block(struct pci_dev *, int pos, u8 * buf, int len);
|
|---|
| 106 |
|
|---|
| 107 | int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
|
|---|
| 108 |
|
|---|
| 109 | #define PCI_FILL_IDENT 1
|
|---|
| 110 | #define PCI_FILL_IRQ 2
|
|---|
| 111 | #define PCI_FILL_BASES 4
|
|---|
| 112 | #define PCI_FILL_ROM_BASE 8
|
|---|
| 113 | #define PCI_FILL_SIZES 16
|
|---|
| 114 | #define PCI_FILL_RESCAN 0x10000
|
|---|
| 115 |
|
|---|
| 116 | void pci_setup_cache(struct pci_dev *, u8 * cache, int len);
|
|---|
| 117 |
|
|---|
| 118 | /*
|
|---|
| 119 | * Filters
|
|---|
| 120 | */
|
|---|
| 121 |
|
|---|
| 122 | struct pci_filter {
|
|---|
| 123 | int domain, bus, slot, func; /* -1 = ANY */
|
|---|
| 124 | int vendor, device;
|
|---|
| 125 | };
|
|---|
| 126 |
|
|---|
| 127 | void pci_filter_init(struct pci_access *, struct pci_filter *);
|
|---|
| 128 | char *pci_filter_parse_slot(struct pci_filter *, char *);
|
|---|
| 129 | char *pci_filter_parse_id(struct pci_filter *, char *);
|
|---|
| 130 | int pci_filter_match(struct pci_filter *, struct pci_dev *);
|
|---|
| 131 |
|
|---|
| 132 | /*
|
|---|
| 133 | * Conversion of PCI ID's to names (according to the pci.ids file)
|
|---|
| 134 | *
|
|---|
| 135 | * Call pci_lookup_name() to identify different types of ID's:
|
|---|
| 136 | *
|
|---|
| 137 | * VENDOR (vendorID) -> vendor
|
|---|
| 138 | * DEVICE (vendorID, deviceID) -> device
|
|---|
| 139 | * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
|
|---|
| 140 | * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
|
|---|
| 141 | * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
|
|---|
| 142 | * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
|
|---|
| 143 | * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
|
|---|
| 144 | * CLASS (classID) -> class
|
|---|
| 145 | * PROGIF (classID, progif) -> programming interface
|
|---|
| 146 | */
|
|---|
| 147 |
|
|---|
| 148 | char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags,
|
|---|
| 149 | ...);
|
|---|
| 150 |
|
|---|
| 151 | int pci_load_name_list(struct pci_access *a); /* Called automatically by pci_lookup_*() when needed; returns success */
|
|---|
| 152 | void pci_free_name_list(struct pci_access *a); /* Called automatically by pci_cleanup() */
|
|---|
| 153 |
|
|---|
| 154 | enum pci_lookup_mode {
|
|---|
| 155 | PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
|
|---|
| 156 | PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
|
|---|
| 157 | PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
|
|---|
| 158 | PCI_LOOKUP_SUBSYSTEM = 8,
|
|---|
| 159 | PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
|
|---|
| 160 | PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
|
|---|
| 161 | PCI_LOOKUP_NO_NUMBERS = 0x20000 /* Return NULL if not found in the database; default is to print numerically */
|
|---|
| 162 | };
|
|---|
| 163 |
|
|---|
| 164 | #endif
|
|---|
