xref: /openbsd/sys/arch/amd64/include/pci_machdep.h (revision 7b36286a)
1 /*	$OpenBSD: pci_machdep.h,v 1.4 2005/10/05 21:48:34 tdeval Exp $	*/
2 /*	$NetBSD: pci_machdep.h,v 1.1 2003/02/26 21:26:11 fvdl Exp $	*/
3 
4 /*
5  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
6  * Copyright (c) 1994 Charles M. 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 M. 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 x86_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 x86_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 x86_pci_tag_u pcitag_t;
65 typedef int pci_intr_handle_t;
66 
67 #define	pci_intr_line(ih)	((ih) & 0xff)
68 
69 /*
70  * i386-specific PCI variables and functions.
71  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
72  */
73 extern int pci_mode;
74 int		pci_mode_detect(void);
75 int		pci_bus_flags(void);
76 struct		pci_attach_args;
77 
78 /*
79  * Functions provided to machine-independent PCI code.
80  */
81 void		pci_attach_hook(struct device *, struct device *,
82 		    struct pcibus_attach_args *);
83 int		pci_bus_maxdevs(pci_chipset_tag_t, int);
84 pcitag_t	pci_make_tag(pci_chipset_tag_t, int, int, int);
85 void		pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
86 		    int *, int *, int *);
87 pcireg_t	pci_conf_read(pci_chipset_tag_t, pcitag_t, int);
88 void		pci_conf_write(pci_chipset_tag_t, pcitag_t, int,
89 		    pcireg_t);
90 int		pci_intr_map(struct pci_attach_args *, pci_intr_handle_t *);
91 const char	*pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t);
92 void		*pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t,
93 		    int, int (*)(void *), void *, char *);
94 void		pci_intr_disestablish(pci_chipset_tag_t, void *);
95 void		pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
96 		    int *, int *, int *);
97 
98 /*
99  * ALL OF THE FOLLOWING ARE MACHINE-DEPENDENT, AND SHOULD NOT BE USED
100  * BY PORTABLE CODE.
101  */
102 
103 /*
104  * Section 6.2.4, `Miscellaneous Functions' of the PCI Specification,
105  * says that 255 means `unknown' or `no connection' to the interrupt
106  * controller on a PC.
107  */
108 #define	X86_PCI_INTERRUPT_LINE_NO_CONNECTION	0xff
109