pcivar.h revision 1.24 1 /* $NetBSD: pcivar.h,v 1.24 1997/07/17 01:01:06 jtk Exp $ */
2
3 /*
4 * Copyright (c) 1996, 1997 Christopher G. Demetriou. All rights reserved.
5 * Copyright (c) 1994 Charles Hannum. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Charles Hannum.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef _DEV_PCI_PCIVAR_H_
34 #define _DEV_PCI_PCIVAR_H_
35
36 /*
37 * Definitions for PCI autoconfiguration.
38 *
39 * This file describes types and functions which are used for PCI
40 * configuration. Some of this information is machine-specific, and is
41 * provided by pci_machdep.h.
42 */
43
44 #include <machine/bus.h>
45 #include <dev/pci/pcireg.h>
46
47 /*
48 * Structures and definitions needed by the machine-dependent header.
49 */
50 typedef u_int32_t pcireg_t; /* configuration space register XXX */
51 struct pcibus_attach_args;
52
53 /*
54 * Machine-dependent definitions.
55 */
56 #if (alpha + atari + i386 != 1)
57 ERROR: COMPILING FOR UNSUPPORTED MACHINE, OR MORE THAN ONE.
58 #endif
59 #if alpha
60 #include <alpha/pci/pci_machdep.h>
61 #endif
62 #if atari
63 #include <atari/pci/pci_machdep.h>
64 #endif
65 #if i386
66 #include <i386/pci/pci_machdep.h>
67 #endif
68
69 /*
70 * PCI bus attach arguments.
71 */
72 struct pcibus_attach_args {
73 char *pba_busname; /* XXX should be common */
74 bus_space_tag_t pba_iot; /* pci i/o space tag */
75 bus_space_tag_t pba_memt; /* pci mem space tag */
76 bus_dma_tag_t pba_dmat; /* DMA tag */
77 pci_chipset_tag_t pba_pc;
78 int pba_flags; /* flags; see below */
79
80 int pba_bus; /* PCI bus number */
81
82 /*
83 * Interrupt swizzling information. These fields
84 * are only used by secondary busses.
85 */
86 u_int pba_intrswiz; /* how to swizzle pins */
87 pcitag_t pba_intrtag; /* intr. appears to come from here */
88 };
89
90 /*
91 * PCI device attach arguments.
92 */
93 struct pci_attach_args {
94 bus_space_tag_t pa_iot; /* pci i/o space tag */
95 bus_space_tag_t pa_memt; /* pci mem space tag */
96 bus_dma_tag_t pa_dmat; /* DMA tag */
97 pci_chipset_tag_t pa_pc;
98 int pa_flags; /* flags; see below */
99
100 u_int pa_device;
101 u_int pa_function;
102 pcitag_t pa_tag;
103 pcireg_t pa_id, pa_class;
104
105 /*
106 * Interrupt information.
107 *
108 * "Intrline" is used on systems whose firmware puts
109 * the right routing data into the line register in
110 * configuration space. The rest are used on systems
111 * that do not.
112 */
113 u_int pa_intrswiz; /* how to swizzle pins if ppb */
114 pcitag_t pa_intrtag; /* intr. appears to come from here */
115 pci_intr_pin_t pa_intrpin; /* intr. appears on this pin */
116 pci_intr_line_t pa_intrline; /* intr. routing information */
117 };
118
119 /*
120 * Flags given in the bus and device attachment args.
121 */
122 #define PCI_FLAGS_IO_ENABLED 0x01 /* I/O space is enabled */
123 #define PCI_FLAGS_MEM_ENABLED 0x02 /* memory space is enabled */
124
125 #include "locators.h"
126
127 /*
128 * Locators devices that attach to 'pcibus', as specified to config.
129 */
130 #define pcibuscf_bus cf_loc[PCIBUSCF_BUS]
131 #define PCIBUS_UNK_BUS PCIBUSCF_BUS_DEFAULT /* wildcarded 'bus' */
132
133 /*
134 * Locators for PCI devices, as specified to config.
135 */
136 #define pcicf_dev cf_loc[PCICF_DEV]
137 #define PCI_UNK_DEV PCICF_DEV_DEFAULT /* wildcarded 'dev' */
138
139 #define pcicf_function cf_loc[PCICF_FUNCTION]
140 #define PCI_UNK_FUNCTION PCICF_FUNCTION_DEFAULT /* wildcarded 'function' */
141
142 /*
143 * Configuration space access and utility functions. (Note that most,
144 * e.g. make_tag, conf_read, conf_write are declared by pci_machdep.h.)
145 */
146 int pci_mapreg_info __P((pci_chipset_tag_t, pcitag_t, int, pcireg_t,
147 bus_addr_t *, bus_size_t *, int *));
148 int pci_mapreg_map __P((struct pci_attach_args *, int, pcireg_t, int,
149 bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *,
150 bus_size_t *));
151
152 /*
153 * Helper functions for autoconfiguration.
154 */
155 void pci_devinfo __P((pcireg_t, pcireg_t, int, char *));
156 void set_pci_isa_bridge_callback __P((void (*)(void *), void *));
157
158 /*
159 * Backward compatibility functions. NO NEW CODE SHOULD USE THESE.
160 *
161 * pci_io_find() and pci_mem_find() deprecated as of April 13, 1997.
162 */
163 int pci_io_find __P((pci_chipset_tag_t, pcitag_t, int, bus_addr_t *,
164 bus_size_t *));
165 int pci_mem_find __P((pci_chipset_tag_t, pcitag_t, int, bus_addr_t *,
166 bus_size_t *, int *));
167
168 #endif /* _DEV_PCI_PCIVAR_H_ */
169