1 /* 2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD: src/sys/pci/pcivar.h,v 1.41.2.2 2002/01/10 12:08:22 mdodd Exp $ 27 * 28 */ 29 30 #ifndef _PCIVAR_H_ 31 #define _PCIVAR_H_ 32 33 #ifndef PCI_COMPAT 34 #define PCI_COMPAT 35 #endif 36 37 #include <sys/queue.h> 38 39 /* some PCI bus constants */ 40 41 #define PCI_BUSMAX 255 /* highest supported bus number */ 42 #define PCI_SLOTMAX 31 /* highest supported slot number */ 43 #define PCI_FUNCMAX 7 /* highest supported function number */ 44 #define PCI_REGMAX 255 /* highest supported config register addr. */ 45 46 #define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */ 47 #define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */ 48 #define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */ 49 50 /* pci_addr_t covers this system's PCI bus address space: 32 or 64 bit */ 51 52 #ifdef PCI_A64 53 typedef u_int64_t pci_addr_t; /* u_int64_t for system with 64bit addresses */ 54 #else 55 typedef u_int32_t pci_addr_t; /* u_int64_t for system with 64bit addresses */ 56 #endif 57 58 /* config header information common to all header types */ 59 60 typedef struct pcicfg { 61 struct device *dev; /* device which owns this */ 62 void *hdrspec; /* pointer to header type specific data */ 63 64 u_int16_t subvendor; /* card vendor ID */ 65 u_int16_t subdevice; /* card device ID, assigned by card vendor */ 66 u_int16_t vendor; /* chip vendor ID */ 67 u_int16_t device; /* chip device ID, assigned by chip vendor */ 68 69 u_int16_t cmdreg; /* disable/enable chip and PCI options */ 70 u_int16_t statreg; /* supported PCI features and error state */ 71 72 u_int8_t baseclass; /* chip PCI class */ 73 u_int8_t subclass; /* chip PCI subclass */ 74 u_int8_t progif; /* chip PCI programming interface */ 75 u_int8_t revid; /* chip revision ID */ 76 77 u_int8_t hdrtype; /* chip config header type */ 78 u_int8_t cachelnsz; /* cache line size in 4byte units */ 79 u_int8_t intpin; /* PCI interrupt pin */ 80 u_int8_t intline; /* interrupt line (IRQ for PC arch) */ 81 82 u_int8_t mingnt; /* min. useful bus grant time in 250ns units */ 83 u_int8_t maxlat; /* max. tolerated bus grant latency in 250ns */ 84 u_int8_t lattimer; /* latency timer in units of 30ns bus cycles */ 85 86 u_int8_t mfdev; /* multi-function device (from hdrtype reg) */ 87 u_int8_t nummaps; /* actual number of PCI maps used */ 88 89 u_int8_t hose; /* hose which bus is attached to */ 90 u_int8_t bus; /* config space bus address */ 91 u_int8_t slot; /* config space slot address */ 92 u_int8_t func; /* config space function number */ 93 94 u_int8_t secondarybus; /* bus on secondary side of bridge, if any */ 95 u_int8_t subordinatebus; /* topmost bus number behind bridge, if any */ 96 97 u_int16_t pp_cap; /* PCI power management capabilities */ 98 u_int8_t pp_status; /* config space address of PCI power status reg */ 99 u_int8_t pp_pmcsr; /* config space address of PMCSR reg */ 100 u_int8_t pp_data; /* config space address of PCI power data reg */ 101 } pcicfgregs; 102 103 /* additional type 1 device config header information (PCI to PCI bridge) */ 104 105 #ifdef PCI_A64 106 #define PCI_PPBMEMBASE(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff) 107 #define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff) 108 #else 109 #define PCI_PPBMEMBASE(h,l) (((l)<<16) & ~0xfffff) 110 #define PCI_PPBMEMLIMIT(h,l) (((l)<<16) | 0xfffff) 111 #endif /* PCI_A64 */ 112 113 #define PCI_PPBIOBASE(h,l) ((((h)<<16) + ((l)<<8)) & ~0xfff) 114 #define PCI_PPBIOLIMIT(h,l) ((((h)<<16) + ((l)<<8)) | 0xfff) 115 116 typedef struct { 117 pci_addr_t pmembase; /* base address of prefetchable memory */ 118 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */ 119 u_int32_t membase; /* base address of memory window */ 120 u_int32_t memlimit; /* topmost address of memory window */ 121 u_int32_t iobase; /* base address of port window */ 122 u_int32_t iolimit; /* topmost address of port window */ 123 u_int16_t secstat; /* secondary bus status register */ 124 u_int16_t bridgectl; /* bridge control register */ 125 u_int8_t seclat; /* CardBus latency timer */ 126 } pcih1cfgregs; 127 128 /* additional type 2 device config header information (CardBus bridge) */ 129 130 typedef struct { 131 u_int32_t membase0; /* base address of memory window */ 132 u_int32_t memlimit0; /* topmost address of memory window */ 133 u_int32_t membase1; /* base address of memory window */ 134 u_int32_t memlimit1; /* topmost address of memory window */ 135 u_int32_t iobase0; /* base address of port window */ 136 u_int32_t iolimit0; /* topmost address of port window */ 137 u_int32_t iobase1; /* base address of port window */ 138 u_int32_t iolimit1; /* topmost address of port window */ 139 u_int32_t pccardif; /* PC Card 16bit IF legacy more base addr. */ 140 u_int16_t secstat; /* secondary bus status register */ 141 u_int16_t bridgectl; /* bridge control register */ 142 u_int8_t seclat; /* CardBus latency timer */ 143 } pcih2cfgregs; 144 145 /* PCI bus attach definitions (there could be multiple PCI bus *trees* ... */ 146 147 typedef struct pciattach { 148 int unit; 149 int pcibushigh; 150 struct pciattach *next; 151 } pciattach; 152 153 extern u_int32_t pci_numdevs; 154 155 156 /* externally visible functions */ 157 158 const char *pci_ata_match(struct device *dev); 159 const char *pci_usb_match(struct device *dev); 160 const char *pci_vga_match(struct device *dev); 161 162 /* low level PCI config register functions provided by pcibus.c */ 163 164 int pci_cfgread (pcicfgregs *cfg, int reg, int bytes); 165 void pci_cfgwrite (pcicfgregs *cfg, int reg, int data, int bytes); 166 #ifdef __alpha__ 167 vm_offset_t pci_cvt_to_dense (vm_offset_t); 168 vm_offset_t pci_cvt_to_bwx (vm_offset_t); 169 #endif /* __alpha__ */ 170 171 /* low level devlist operations for the 2.2 compatibility code in pci.c */ 172 pcicfgregs * pci_devlist_get_parent(pcicfgregs *cfg); 173 174 #ifdef _SYS_BUS_H_ 175 176 #include "pci_if.h" 177 178 /* 179 * Define pci-specific resource flags for accessing memory via dense 180 * or bwx memory spaces. These flags are ignored on i386. 181 */ 182 #define PCI_RF_DENSE 0x10000 183 #define PCI_RF_BWX 0x20000 184 185 enum pci_device_ivars { 186 PCI_IVAR_SUBVENDOR, 187 PCI_IVAR_SUBDEVICE, 188 PCI_IVAR_VENDOR, 189 PCI_IVAR_DEVICE, 190 PCI_IVAR_DEVID, 191 PCI_IVAR_CLASS, 192 PCI_IVAR_SUBCLASS, 193 PCI_IVAR_PROGIF, 194 PCI_IVAR_REVID, 195 PCI_IVAR_INTPIN, 196 PCI_IVAR_IRQ, 197 PCI_IVAR_BUS, 198 PCI_IVAR_SLOT, 199 PCI_IVAR_FUNCTION, 200 PCI_IVAR_SECONDARYBUS, 201 PCI_IVAR_SUBORDINATEBUS, 202 PCI_IVAR_HOSE, 203 }; 204 205 /* 206 * Simplified accessors for pci devices 207 */ 208 #define PCI_ACCESSOR(A, B, T) \ 209 \ 210 static __inline T pci_get_ ## A(device_t dev) \ 211 { \ 212 uintptr_t v; \ 213 BUS_READ_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, &v); \ 214 return (T) v; \ 215 } \ 216 \ 217 static __inline void pci_set_ ## A(device_t dev, T t) \ 218 { \ 219 u_long v = (u_long) t; \ 220 BUS_WRITE_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, v); \ 221 } 222 223 PCI_ACCESSOR(subvendor, SUBVENDOR, u_int16_t) 224 PCI_ACCESSOR(subdevice, SUBDEVICE, u_int16_t) 225 PCI_ACCESSOR(vendor, VENDOR, u_int16_t) 226 PCI_ACCESSOR(device, DEVICE, u_int16_t) 227 PCI_ACCESSOR(devid, DEVID, u_int32_t) 228 PCI_ACCESSOR(class, CLASS, u_int8_t) 229 PCI_ACCESSOR(subclass, SUBCLASS, u_int8_t) 230 PCI_ACCESSOR(progif, PROGIF, u_int8_t) 231 PCI_ACCESSOR(revid, REVID, u_int8_t) 232 PCI_ACCESSOR(intpin, INTPIN, u_int8_t) 233 PCI_ACCESSOR(irq, IRQ, u_int8_t) 234 PCI_ACCESSOR(bus, BUS, u_int8_t) 235 PCI_ACCESSOR(slot, SLOT, u_int8_t) 236 PCI_ACCESSOR(function, FUNCTION, u_int8_t) 237 PCI_ACCESSOR(secondarybus, SECONDARYBUS, u_int8_t) 238 PCI_ACCESSOR(subordinatebus, SUBORDINATEBUS, u_int8_t) 239 PCI_ACCESSOR(hose, HOSE, u_int32_t) 240 241 static __inline u_int32_t 242 pci_read_config(device_t dev, int reg, int width) 243 { 244 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width); 245 } 246 247 static __inline void 248 pci_write_config(device_t dev, int reg, u_int32_t val, int width) 249 { 250 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width); 251 } 252 253 /* 254 * Convenience functions. 255 * 256 * These should be used in preference to manually manipulating 257 * configuration space. 258 */ 259 static __inline void 260 pci_enable_busmaster(device_t dev) 261 { 262 PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev); 263 } 264 265 static __inline void 266 pci_disable_busmaster(device_t dev) 267 { 268 PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev); 269 } 270 271 static __inline void 272 pci_enable_io(device_t dev, int space) 273 { 274 PCI_ENABLE_IO(device_get_parent(dev), dev, space); 275 } 276 277 static __inline void 278 pci_disable_io(device_t dev, int space) 279 { 280 PCI_DISABLE_IO(device_get_parent(dev), dev, space); 281 } 282 283 /* 284 * PCI power states are as defined by ACPI: 285 * 286 * D0 State in which device is on and running. It is receiving full 287 * power from the system and delivering full functionality to the user. 288 * D1 Class-specific low-power state in which device context may or may not 289 * be lost. Buses in D1 cannot do anything to the bus that would force 290 * devices on that bus to loose context. 291 * D2 Class-specific low-power state in which device context may or may 292 * not be lost. Attains greater power savings than D1. Buses in D2 293 * can cause devices on that bus to loose some context. Devices in D2 294 * must be prepared for the bus to be in D2 or higher. 295 * D3 State in which the device is off and not running. Device context is 296 * lost. Power can be removed from the device. 297 */ 298 #define PCI_POWERSTATE_D0 0 299 #define PCI_POWERSTATE_D1 1 300 #define PCI_POWERSTATE_D2 2 301 #define PCI_POWERSTATE_D3 3 302 #define PCI_POWERSTATE_UNKNOWN -1 303 304 static __inline int 305 pci_set_powerstate(device_t dev, int state) 306 { 307 return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state); 308 } 309 310 static __inline int 311 pci_get_powerstate(device_t dev) 312 { 313 return PCI_GET_POWERSTATE(device_get_parent(dev), dev); 314 } 315 316 /* 317 * Ivars for pci bridges. 318 */ 319 320 /*typedef enum pci_device_ivars pcib_device_ivars;*/ 321 enum pcib_device_ivars { 322 PCIB_IVAR_HOSE, 323 }; 324 325 #define PCIB_ACCESSOR(A, B, T) \ 326 \ 327 static __inline T pcib_get_ ## A(device_t dev) \ 328 { \ 329 uintptr_t v; \ 330 BUS_READ_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, &v); \ 331 return (T) v; \ 332 } \ 333 \ 334 static __inline void pcib_set_ ## A(device_t dev, T t) \ 335 { \ 336 u_long v = (u_long) t; \ 337 BUS_WRITE_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, v); \ 338 } 339 340 PCIB_ACCESSOR(hose, HOSE, u_int32_t) 341 342 device_t pci_find_bsf(u_int8_t, u_int8_t, u_int8_t); 343 device_t pci_find_device(u_int16_t, u_int16_t); 344 #endif 345 346 /* for compatibility to FreeBSD-2.2 version of PCI code */ 347 348 #ifdef PCI_COMPAT 349 350 typedef pcicfgregs *pcici_t; 351 typedef unsigned pcidi_t; 352 typedef void pci_inthand_t(void *arg); 353 354 #define pci_max_burst_len (3) 355 356 /* just copied from old PCI code for now ... */ 357 358 struct pci_device { 359 char* pd_name; 360 const char* (*pd_probe ) (pcici_t tag, pcidi_t type); 361 void (*pd_attach) (pcici_t tag, int unit); 362 u_long *pd_count; 363 int (*pd_shutdown) (int, int); 364 }; 365 366 #ifdef __i386__ 367 typedef u_short pci_port_t; 368 #else 369 typedef u_int pci_port_t; 370 #endif 371 372 u_long pci_conf_read (pcici_t tag, u_long reg); 373 void pci_conf_write (pcici_t tag, u_long reg, u_long data); 374 int pci_map_port (pcici_t tag, u_long reg, pci_port_t* pa); 375 int pci_map_mem (pcici_t tag, u_long reg, vm_offset_t* va, vm_offset_t* pa); 376 int pci_map_int (pcici_t tag, pci_inthand_t *handler, void *arg, 377 intrmask_t *maskptr); 378 int pci_map_int_right(pcici_t cfg, pci_inthand_t *handler, void *arg, 379 intrmask_t *maskptr, u_int flags); 380 int pci_unmap_int (pcici_t tag); 381 382 pcici_t pci_get_parent_from_tag(pcici_t tag); 383 int pci_get_bus_from_tag(pcici_t tag); 384 385 struct module; 386 int compat_pci_handler (struct module *, int, void *); 387 #define COMPAT_PCI_DRIVER(name, pcidata) \ 388 static moduledata_t name##_mod = { \ 389 #name, \ 390 compat_pci_handler, \ 391 &pcidata \ 392 }; \ 393 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY) 394 395 396 #endif /* PCI_COMPAT */ 397 #endif /* _PCIVAR_H_ */ 398