pcivar.h revision 69783
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: head/sys/dev/pci/pcivar.h 69783 2000-12-08 22:11:23Z msmith $ 27 * 28 */ 29 30#ifndef _PCIVAR_H_ 31#define _PCIVAR_H_ 32 33#include <sys/queue.h> 34 35/* some PCI bus constants */ 36 37#define PCI_BUSMAX 255 /* highest supported bus number */ 38#define PCI_SLOTMAX 31 /* highest supported slot number */ 39#define PCI_FUNCMAX 7 /* highest supported function number */ 40#define PCI_REGMAX 255 /* highest supported config register addr. */ 41 42#define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */ 43#define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */ 44#define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */ 45 46/* pci_addr_t covers this system's PCI bus address space: 32 or 64 bit */ 47 48#ifdef PCI_A64 49typedef u_int64_t pci_addr_t; /* u_int64_t for system with 64bit addresses */ 50#else 51typedef u_int32_t pci_addr_t; /* u_int64_t for system with 64bit addresses */ 52#endif 53 54/* config header information common to all header types */ 55 56typedef struct pcicfg { 57 struct device *dev; /* device which owns this */ 58 void *hdrspec; /* pointer to header type specific data */ 59 60 u_int16_t subvendor; /* card vendor ID */ 61 u_int16_t subdevice; /* card device ID, assigned by card vendor */ 62 u_int16_t vendor; /* chip vendor ID */ 63 u_int16_t device; /* chip device ID, assigned by chip vendor */ 64 65 u_int16_t cmdreg; /* disable/enable chip and PCI options */ 66 u_int16_t statreg; /* supported PCI features and error state */ 67 68 u_int8_t baseclass; /* chip PCI class */ 69 u_int8_t subclass; /* chip PCI subclass */ 70 u_int8_t progif; /* chip PCI programming interface */ 71 u_int8_t revid; /* chip revision ID */ 72 73 u_int8_t hdrtype; /* chip config header type */ 74 u_int8_t cachelnsz; /* cache line size in 4byte units */ 75 u_int8_t intpin; /* PCI interrupt pin */ 76 u_int8_t intline; /* interrupt line (IRQ for PC arch) */ 77 78 u_int8_t mingnt; /* min. useful bus grant time in 250ns units */ 79 u_int8_t maxlat; /* max. tolerated bus grant latency in 250ns */ 80 u_int8_t lattimer; /* latency timer in units of 30ns bus cycles */ 81 82 u_int8_t mfdev; /* multi-function device (from hdrtype reg) */ 83 u_int8_t nummaps; /* actual number of PCI maps used */ 84 85 u_int8_t bus; /* config space bus address */ 86 u_int8_t slot; /* config space slot address */ 87 u_int8_t func; /* config space function number */ 88 89 u_int8_t secondarybus; /* bus on secondary side of bridge, if any */ 90 u_int8_t subordinatebus; /* topmost bus number behind bridge, if any */ 91} pcicfgregs; 92 93/* additional type 1 device config header information (PCI to PCI bridge) */ 94 95#ifdef PCI_A64 96#define PCI_PPBMEMBASE(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff) 97#define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff) 98#else 99#define PCI_PPBMEMBASE(h,l) (((l)<<16) & ~0xfffff) 100#define PCI_PPBMEMLIMIT(h,l) (((l)<<16) | 0xfffff) 101#endif /* PCI_A64 */ 102 103#define PCI_PPBIOBASE(h,l) ((((h)<<16) + ((l)<<8)) & ~0xfff) 104#define PCI_PPBIOLIMIT(h,l) ((((h)<<16) + ((l)<<8)) | 0xfff) 105 106typedef struct { 107 pci_addr_t pmembase; /* base address of prefetchable memory */ 108 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */ 109 u_int32_t membase; /* base address of memory window */ 110 u_int32_t memlimit; /* topmost address of memory window */ 111 u_int32_t iobase; /* base address of port window */ 112 u_int32_t iolimit; /* topmost address of port window */ 113 u_int16_t secstat; /* secondary bus status register */ 114 u_int16_t bridgectl; /* bridge control register */ 115 u_int8_t seclat; /* CardBus latency timer */ 116} pcih1cfgregs; 117 118/* additional type 2 device config header information (CardBus bridge) */ 119 120typedef struct { 121 u_int32_t membase0; /* base address of memory window */ 122 u_int32_t memlimit0; /* topmost address of memory window */ 123 u_int32_t membase1; /* base address of memory window */ 124 u_int32_t memlimit1; /* topmost address of memory window */ 125 u_int32_t iobase0; /* base address of port window */ 126 u_int32_t iolimit0; /* topmost address of port window */ 127 u_int32_t iobase1; /* base address of port window */ 128 u_int32_t iolimit1; /* topmost address of port window */ 129 u_int32_t pccardif; /* PC Card 16bit IF legacy more base addr. */ 130 u_int16_t secstat; /* secondary bus status register */ 131 u_int16_t bridgectl; /* bridge control register */ 132 u_int8_t seclat; /* CardBus latency timer */ 133} pcih2cfgregs; 134 135extern u_int32_t pci_numdevs; 136 137/* Only if the prerequisites are present */ 138#if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_) 139struct pci_devinfo { 140 STAILQ_ENTRY(pci_devinfo) pci_links; 141 struct resource_list resources; 142 pcicfgregs cfg; 143 struct pci_conf conf; 144}; 145#endif 146 147/* low level PCI config register functions provided by pcibus.c */ 148 149int pci_cfgread (pcicfgregs *cfg, int reg, int bytes); 150void pci_cfgwrite (pcicfgregs *cfg, int reg, int data, int bytes); 151 152#ifdef __alpha__ 153vm_offset_t pci_cvt_to_dense (vm_offset_t); 154vm_offset_t pci_cvt_to_bwx (vm_offset_t); 155#endif /* __alpha__ */ 156 157/* low level devlist operations for the 2.2 compatibility code in pci.c */ 158pcicfgregs * pci_devlist_get_parent(pcicfgregs *cfg); 159 160#ifdef _SYS_BUS_H_ 161 162#include "pci_if.h" 163 164/* 165 * Define pci-specific resource flags for accessing memory via dense 166 * or bwx memory spaces. These flags are ignored on i386. 167 */ 168#define PCI_RF_DENSE 0x10000 169#define PCI_RF_BWX 0x20000 170 171enum pci_device_ivars { 172 PCI_IVAR_SUBVENDOR, 173 PCI_IVAR_SUBDEVICE, 174 PCI_IVAR_VENDOR, 175 PCI_IVAR_DEVICE, 176 PCI_IVAR_DEVID, 177 PCI_IVAR_CLASS, 178 PCI_IVAR_SUBCLASS, 179 PCI_IVAR_PROGIF, 180 PCI_IVAR_REVID, 181 PCI_IVAR_INTPIN, 182 PCI_IVAR_IRQ, 183 PCI_IVAR_BUS, 184 PCI_IVAR_SLOT, 185 PCI_IVAR_FUNCTION, 186 PCI_IVAR_SECONDARYBUS, 187 PCI_IVAR_SUBORDINATEBUS, 188}; 189 190/* 191 * Simplified accessors for pci devices 192 */ 193#define PCI_ACCESSOR(A, B, T) \ 194 \ 195static __inline T pci_get_ ## A(device_t dev) \ 196{ \ 197 uintptr_t v; \ 198 BUS_READ_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, &v); \ 199 return (T) v; \ 200} \ 201 \ 202static __inline void pci_set_ ## A(device_t dev, T t) \ 203{ \ 204 uintptr_t v = (uintptr_t) t; \ 205 BUS_WRITE_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, v); \ 206} 207 208PCI_ACCESSOR(subvendor, SUBVENDOR, u_int16_t) 209PCI_ACCESSOR(subdevice, SUBDEVICE, u_int16_t) 210PCI_ACCESSOR(vendor, VENDOR, u_int16_t) 211PCI_ACCESSOR(device, DEVICE, u_int16_t) 212PCI_ACCESSOR(devid, DEVID, u_int32_t) 213PCI_ACCESSOR(class, CLASS, u_int8_t) 214PCI_ACCESSOR(subclass, SUBCLASS, u_int8_t) 215PCI_ACCESSOR(progif, PROGIF, u_int8_t) 216PCI_ACCESSOR(revid, REVID, u_int8_t) 217PCI_ACCESSOR(intpin, INTPIN, u_int8_t) 218PCI_ACCESSOR(irq, IRQ, u_int8_t) 219PCI_ACCESSOR(bus, BUS, u_int8_t) 220PCI_ACCESSOR(slot, SLOT, u_int8_t) 221PCI_ACCESSOR(function, FUNCTION, u_int8_t) 222PCI_ACCESSOR(secondarybus, SECONDARYBUS, u_int8_t) 223PCI_ACCESSOR(subordinatebus, SUBORDINATEBUS, u_int8_t) 224 225#undef PCI_ACCESSOR 226 227static __inline u_int32_t 228pci_read_config(device_t dev, int reg, int width) 229{ 230 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width); 231} 232 233static __inline void 234pci_write_config(device_t dev, int reg, u_int32_t val, int width) 235{ 236 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width); 237} 238 239/* 240 * Ivars for pci bridges. 241 */ 242 243/*typedef enum pci_device_ivars pcib_device_ivars;*/ 244enum pcib_device_ivars { 245 PCIB_IVAR_BUS 246}; 247 248#define PCIB_ACCESSOR(A, B, T) \ 249 \ 250static __inline T pcib_get_ ## A(device_t dev) \ 251{ \ 252 uintptr_t v; \ 253 BUS_READ_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, &v); \ 254 return (T) v; \ 255} \ 256 \ 257static __inline void pcib_set_ ## A(device_t dev, T t) \ 258{ \ 259 uintptr_t v = (uintptr_t) t; \ 260 BUS_WRITE_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, v); \ 261} 262 263PCIB_ACCESSOR(bus, BUS, u_int32_t) 264 265#undef PCIB_ACCESSOR 266 267#endif 268 269/* for compatibility to FreeBSD-2.2 and 3.x versions of PCI code */ 270 271#if defined(_KERNEL) && !defined(KLD_MODULE) 272#include "opt_compat_oldpci.h" 273#endif 274 275#ifdef COMPAT_OLDPCI 276 277/* all this is going some day */ 278 279typedef pcicfgregs *pcici_t; 280typedef unsigned pcidi_t; 281typedef void pci_inthand_t(void *arg); 282 283#define pci_max_burst_len (3) 284 285/* just copied from old PCI code for now ... */ 286 287struct pci_device { 288 char* pd_name; 289 const char* (*pd_probe ) (pcici_t tag, pcidi_t type); 290 void (*pd_attach) (pcici_t tag, int unit); 291 u_long *pd_count; 292 int (*pd_shutdown) (int, int); 293}; 294 295#ifdef __i386__ 296typedef u_short pci_port_t; 297#else 298typedef u_int pci_port_t; 299#endif 300 301u_long pci_conf_read (pcici_t tag, u_long reg); 302void pci_conf_write (pcici_t tag, u_long reg, u_long data); 303int pci_map_port (pcici_t tag, u_long reg, pci_port_t* pa); 304int pci_map_mem (pcici_t tag, u_long reg, vm_offset_t* va, vm_offset_t* pa); 305int pci_map_int (pcici_t tag, pci_inthand_t *handler, void *arg, 306 intrmask_t *maskptr); 307int pci_map_int_right(pcici_t cfg, pci_inthand_t *handler, void *arg, 308 intrmask_t *maskptr, u_int flags); 309int pci_unmap_int (pcici_t tag); 310 311pcici_t pci_get_parent_from_tag(pcici_t tag); 312int pci_get_bus_from_tag(pcici_t tag); 313 314struct module; 315int compat_pci_handler (struct module *, int, void *); 316#define COMPAT_PCI_DRIVER(name, pcidata) \ 317static moduledata_t name##_mod = { \ 318 #name, \ 319 compat_pci_handler, \ 320 &pcidata \ 321}; \ 322DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY) 323#endif /* COMPAT_OLDPCI */ 324 325#endif /* _PCIVAR_H_ */ 326