xref: /openbsd/sys/arch/i386/pci/pci_machdep.h (revision a6445c1d)
1 /*	$OpenBSD: pci_machdep.h,v 1.26 2013/11/06 10:40:36 mpi Exp $	*/
2 /*	$NetBSD: pci_machdep.h,v 1.7 1997/06/06 23:29:18 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
6  * Copyright (c) 1994 Charles Hannum.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by Charles Hannum.
19  * 4. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Machine-specific definitions for PCI autoconfiguration.
36  */
37 
38 /*
39  * i386-specific PCI structure and type definitions.
40  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
41  *
42  * Configuration tag; created from a {bus,device,function} triplet by
43  * pci_make_tag(), and passed to pci_conf_read() and pci_conf_write().
44  * We could instead always pass the {bus,device,function} triplet to
45  * the read and write routines, but this would cause extra overhead.
46  *
47  * Mode 2 is historical and deprecated by the Revision 2.0 specification.
48  */
49 union i386_pci_tag_u {
50 	u_int32_t mode1;
51 	struct {
52 		u_int16_t port;
53 		u_int8_t enable;
54 		u_int8_t forward;
55 	} mode2;
56 };
57 
58 extern struct bus_dma_tag pci_bus_dma_tag;
59 
60 /*
61  * Types provided to machine-independent PCI code
62  */
63 typedef void *pci_chipset_tag_t;
64 typedef union i386_pci_tag_u pcitag_t;
65 
66 typedef
67 struct {
68 	pcitag_t tag;
69 	int line, pin;
70 	void *link;
71 } pci_intr_handle_t;
72 
73 /*
74  * i386-specific PCI variables and functions.
75  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
76  */
77 extern int pci_mode;
78 extern bus_addr_t pci_mcfg_addr;
79 extern int pci_mcfg_min_bus, pci_mcfg_max_bus;
80 
81 int		pci_mode_detect(void);
82 
83 extern struct extent *pciio_ex;
84 extern struct extent *pcimem_ex;
85 extern struct extent *pcibus_ex;
86 void		pci_init_extents(void);
87 
88 /*
89  * Functions provided to machine-independent PCI code.
90  */
91 void		pci_attach_hook(struct device *, struct device *,
92 		    struct pcibus_attach_args *);
93 int		pci_bus_maxdevs(pci_chipset_tag_t, int);
94 pcitag_t	pci_make_tag(pci_chipset_tag_t, int, int, int);
95 int		pci_conf_size(pci_chipset_tag_t, pcitag_t);
96 pcireg_t	pci_conf_read(pci_chipset_tag_t, pcitag_t, int);
97 void		pci_conf_write(pci_chipset_tag_t, pcitag_t, int,
98 		    pcireg_t);
99 struct pci_attach_args;
100 int		pci_intr_map_msi(struct pci_attach_args *, pci_intr_handle_t *);
101 int		pci_intr_map(struct pci_attach_args *, pci_intr_handle_t *);
102 #define		pci_intr_line(c, ih)	((ih).line)
103 const char	*pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t);
104 void		*pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t,
105 		    int, int (*)(void *), void *, const char *);
106 void		pci_intr_disestablish(pci_chipset_tag_t, void *);
107 void		pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
108 		    int *, int *, int *);
109 #define	pci_probe_device_hook(c, a)	(0)
110 
111 void 		pci_dev_postattach(struct device *, struct pci_attach_args *);
112 
113 pcireg_t	pci_min_powerstate(pci_chipset_tag_t, pcitag_t);
114 void		pci_set_powerstate_md(pci_chipset_tag_t, pcitag_t, int, int);
115 
116 /*
117  * Section 6.2.4, `Miscellaneous Functions' of the PIC Specification,
118  * says that 255 means `unknown' or `no connection' to the interrupt
119  * controller on a PC.
120  */
121 #define	I386_PCI_INTERRUPT_LINE_NO_CONNECTION	0xff
122 
123 /*
124  * PCI address space is shared with ISA, so avoid legacy ISA I/O
125  * registers.
126  */
127 #define PCI_IO_START	0x400
128 #define PCI_IO_END	0xffff
129