sys/dev/pci/pcivar.h

   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$
  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 } pcicfgregs;
  97
  98 /* additional type 1 device config header information (PCI to PCI bridge) */
  99
 100 #ifdef PCI_A64
 101 #define PCI_PPBMEMBASE(h,l)  ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff)
 102 #define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff)
 103 #else
 104 #define PCI_PPBMEMBASE(h,l)  (((l)<<16) & ~0xfffff)
 105 #define PCI_PPBMEMLIMIT(h,l) (((l)<<16) | 0xfffff)
 106 #endif /* PCI_A64 */
 107
 108 #define PCI_PPBIOBASE(h,l)   ((((h)<<16) + ((l)<<8)) & ~0xfff)
 109 #define PCI_PPBIOLIMIT(h,l)  ((((h)<<16) + ((l)<<8)) | 0xfff)
 110
 111 typedef struct {
 112     pci_addr_t  pmembase;       /* base address of prefetchable memory */
 113     pci_addr_t  pmemlimit;      /* topmost address of prefetchable memory */
 114     u_int32_t   membase;        /* base address of memory window */
 115     u_int32_t   memlimit;       /* topmost address of memory window */
 116     u_int32_t   iobase;         /* base address of port window */
 117     u_int32_t   iolimit;        /* topmost address of port window */
 118     u_int16_t   secstat;        /* secondary bus status register */
 119     u_int16_t   bridgectl;      /* bridge control register */
 120     u_int8_t    seclat;         /* CardBus latency timer */
 121 } pcih1cfgregs;
 122
 123 /* additional type 2 device config header information (CardBus bridge) */
 124
 125 typedef struct {
 126     u_int32_t   membase0;       /* base address of memory window */
 127     u_int32_t   memlimit0;      /* topmost address of memory window */
 128     u_int32_t   membase1;       /* base address of memory window */
 129     u_int32_t   memlimit1;      /* topmost address of memory window */
 130     u_int32_t   iobase0;        /* base address of port window */
 131     u_int32_t   iolimit0;       /* topmost address of port window */
 132     u_int32_t   iobase1;        /* base address of port window */
 133     u_int32_t   iolimit1;       /* topmost address of port window */
 134     u_int32_t   pccardif;       /* PC Card 16bit IF legacy more base addr. */
 135     u_int16_t   secstat;        /* secondary bus status register */
 136     u_int16_t   bridgectl;      /* bridge control register */
 137     u_int8_t    seclat;         /* CardBus latency timer */
 138 } pcih2cfgregs;
 139
 140 extern u_int32_t pci_numdevs;
 141
 142
 143 /* externally visible functions */
 144
 145 const char *pci_ata_match(struct device *dev);
 146 const char *pci_usb_match(struct device *dev);
 147 const char *pci_vga_match(struct device *dev);
 148
 149 /* low level PCI config register functions provided by pcibus.c */
 150
 151 int pci_cfgread (pcicfgregs *cfg, int reg, int bytes);
 152 void pci_cfgwrite (pcicfgregs *cfg, int reg, int data, int bytes);
 153 #ifdef __alpha__
 154 vm_offset_t pci_cvt_to_dense (vm_offset_t);
 155 vm_offset_t pci_cvt_to_bwx (vm_offset_t);
 156 #endif /* __alpha__ */
 157
 158 /* low level devlist operations for the 2.2 compatibility code in pci.c */
 159 pcicfgregs * pci_devlist_get_parent(pcicfgregs *cfg);
 160
 161 #ifdef _SYS_BUS_H_
 162
 163 #include "pci_if.h"
 164
 165 /*
 166  * Define pci-specific resource flags for accessing memory via dense
 167  * or bwx memory spaces. These flags are ignored on i386.
 168  */
 169 #define PCI_RF_DENSE    0x10000
 170 #define PCI_RF_BWX      0x20000
 171
 172 enum pci_device_ivars {
 173         PCI_IVAR_SUBVENDOR,
 174         PCI_IVAR_SUBDEVICE,
 175         PCI_IVAR_VENDOR,
 176         PCI_IVAR_DEVICE,
 177         PCI_IVAR_DEVID,
 178         PCI_IVAR_CLASS,
 179         PCI_IVAR_SUBCLASS,
 180         PCI_IVAR_PROGIF,
 181         PCI_IVAR_REVID,
 182         PCI_IVAR_INTPIN,
 183         PCI_IVAR_IRQ,
 184         PCI_IVAR_BUS,
 185         PCI_IVAR_SLOT,
 186         PCI_IVAR_FUNCTION,
 187         PCI_IVAR_SECONDARYBUS,
 188         PCI_IVAR_SUBORDINATEBUS,
 189         PCI_IVAR_HOSE,
 190 };
 191
 192 /*
 193  * Simplified accessors for pci devices
 194  */
 195 #define PCI_ACCESSOR(A, B, T)                                           \
 196                                                                         \
 197 static __inline T pci_get_ ## A(device_t dev)                           \
 198 {                                                                       \
 199         uintptr_t v;                                                    \
 200         BUS_READ_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, &v); \
 201         return (T) v;                                                   \
 202 }                                                                       \
 203                                                                         \
 204 static __inline void pci_set_ ## A(device_t dev, T t)                   \
 205 {                                                                       \
 206         u_long v = (u_long) t;                                          \
 207         BUS_WRITE_IVAR(device_get_parent(dev), dev, PCI_IVAR_ ## B, v); \
 208 }
 209
 210 PCI_ACCESSOR(subvendor,         SUBVENDOR,      u_int16_t)
 211 PCI_ACCESSOR(subdevice,         SUBDEVICE,      u_int16_t)
 212 PCI_ACCESSOR(vendor,            VENDOR,         u_int16_t)
 213 PCI_ACCESSOR(device,            DEVICE,         u_int16_t)
 214 PCI_ACCESSOR(devid,             DEVID,          u_int32_t)
 215 PCI_ACCESSOR(class,             CLASS,          u_int8_t)
 216 PCI_ACCESSOR(subclass,          SUBCLASS,       u_int8_t)
 217 PCI_ACCESSOR(progif,            PROGIF,         u_int8_t)
 218 PCI_ACCESSOR(revid,             REVID,          u_int8_t)
 219 PCI_ACCESSOR(intpin,            INTPIN,         u_int8_t)
 220 PCI_ACCESSOR(irq,               IRQ,            u_int8_t)
 221 PCI_ACCESSOR(bus,               BUS,            u_int8_t)
 222 PCI_ACCESSOR(slot,              SLOT,           u_int8_t)
 223 PCI_ACCESSOR(function,          FUNCTION,       u_int8_t)
 224 PCI_ACCESSOR(secondarybus,      SECONDARYBUS,   u_int8_t)
 225 PCI_ACCESSOR(subordinatebus,    SUBORDINATEBUS, u_int8_t)
 226 PCI_ACCESSOR(hose,              HOSE,           u_int32_t)
 227
 228 static __inline u_int32_t
 229 pci_read_config(device_t dev, int reg, int width)
 230 {
 231     return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width);
 232 }
 233
 234 static __inline void
 235 pci_write_config(device_t dev, int reg, u_int32_t val, int width)
 236 {
 237     PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width);
 238 }
 239
 240 /*
 241  * Ivars for pci bridges.
 242  */
 243
 244 /*typedef enum pci_device_ivars pcib_device_ivars;*/
 245 enum pcib_device_ivars {
 246         PCIB_IVAR_HOSE,
 247 };
 248
 249 #define PCIB_ACCESSOR(A, B, T)                                           \
 250                                                                          \
 251 static __inline T pcib_get_ ## A(device_t dev)                           \
 252 {                                                                        \
 253         uintptr_t v;                                                     \
 254         BUS_READ_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, &v); \
 255         return (T) v;                                                    \
 256 }                                                                        \
 257                                                                          \
 258 static __inline void pcib_set_ ## A(device_t dev, T t)                   \
 259 {                                                                        \
 260         u_long v = (u_long) t;                                           \
 261         BUS_WRITE_IVAR(device_get_parent(dev), dev, PCIB_IVAR_ ## B, v); \
 262 }
 263
 264 PCIB_ACCESSOR(hose,             HOSE,           u_int32_t)
 265
 266 #endif
 267
 268 /* for compatibility to FreeBSD-2.2 version of PCI code */
 269
 270 #ifdef PCI_COMPAT
 271
 272 #if defined(_KERNEL) && !defined(KLD_MODULE)
 273 #include "opt_compat_oldpci.h"
 274 #endif
 275
 276 /* all this is going some day */
 277
 278 typedef pcicfgregs *pcici_t;
 279 typedef unsigned pcidi_t;
 280 typedef void pci_inthand_t(void *arg);
 281
 282 #define pci_max_burst_len (3)
 283
 284 /* just copied from old PCI code for now ... */
 285
 286 #ifdef COMPAT_OLDPCI
 287 struct 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 #endif
 295
 296 #ifdef __i386__
 297 typedef u_short pci_port_t;
 298 #else
 299 typedef u_int pci_port_t;
 300 #endif
 301
 302 u_long pci_conf_read (pcici_t tag, u_long reg);
 303 void pci_conf_write (pcici_t tag, u_long reg, u_long data);
 304 int pci_map_port (pcici_t tag, u_long reg, pci_port_t* pa);
 305 int pci_map_mem (pcici_t tag, u_long reg, vm_offset_t* va, vm_offset_t* pa);
 306 int pci_map_int (pcici_t tag, pci_inthand_t *handler, void *arg,
 307                  intrmask_t *maskptr);
 308 int pci_map_int_right(pcici_t cfg, pci_inthand_t *handler, void *arg,
 309                       intrmask_t *maskptr, u_int flags);
 310 int pci_unmap_int (pcici_t tag);
 311
 312 pcici_t pci_get_parent_from_tag(pcici_t tag);
 313 int     pci_get_bus_from_tag(pcici_t tag);
 314
 315 #ifdef COMPAT_OLDPCI
 316 struct module;
 317 int compat_pci_handler (struct module *, int, void *);
 318 #define COMPAT_PCI_DRIVER(name, pcidata)                                \
 319 static moduledata_t name##_mod = {                                      \
 320         #name,                                                          \
 321         compat_pci_handler,                                             \
 322         &pcidata                                                        \
 323 };                                                                      \
 324 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY)
 325 #endif
 326
 327
 328 #endif /* PCI_COMPAT */
 329 #endif /* _PCIVAR_H_ */