xref: /netbsd-src/sys/arch/sandpoint/include/pci_machdep.h (revision c38e7cc395b1472a774ff828e46123de44c628e9)
1 /*	$NetBSD: pci_machdep.h,v 1.10 2016/10/19 00:08:42 nonaka Exp $	*/
2 
3 /*
4  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
5  * Copyright (c) 1994 Charles M. 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 M. 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 /*
34  * Machine-specific definitions for PCI autoconfiguration.
35  */
36 
37 #define	__HAVE_PCIIDE_MACHDEP_COMPAT_INTR_ESTABLISH
38 #define	__HAVE_PCI_MSI_MSIX
39 
40 /*
41  * be-specific PCI structure and type definitions.
42  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
43  *
44  * Configuration tag; created from a {bus,device,function} triplet by
45  * pci_make_tag(), and passed to pci_conf_read() and pci_conf_write().
46  * We could instead always pass the {bus,device,function} triplet to
47  * the read and write routines, but this would cause extra overhead.
48  */
49 
50 struct pci_attach_args;	/* Forward declaration */
51 
52 /*
53  * Types provided to machine-independent PCI code
54  */
55 typedef void *pci_chipset_tag_t;
56 typedef int pcitag_t;
57 typedef int pci_intr_handle_t;
58 extern struct powerpc_bus_dma_tag pci_bus_dma_tag;
59 
60 typedef enum {
61 	PCI_INTR_TYPE_INTX = 0,
62 	PCI_INTR_TYPE_MSI,
63 	PCI_INTR_TYPE_MSIX,
64 	PCI_INTR_TYPE_SIZE,
65 } pci_intr_type_t;
66 
67 /*
68  * Functions provided to machine-independent PCI code.
69  */
70 void		pci_attach_hook(device_t, device_t,
71 		    struct pcibus_attach_args *);
72 int		pci_bus_maxdevs(pci_chipset_tag_t, int);
73 pcitag_t	pci_make_tag(pci_chipset_tag_t, int, int, int);
74 void		pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
75 		    int *, int *, int *);
76 pcireg_t	pci_conf_read(pci_chipset_tag_t, pcitag_t, int);
77 void		pci_conf_write(pci_chipset_tag_t, pcitag_t, int,
78 		    pcireg_t);
79 int		pci_intr_map(const struct pci_attach_args *,
80 		    pci_intr_handle_t *);
81 const char	*pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t,
82 		    char *, size_t);
83 const struct evcnt *pci_intr_evcnt(pci_chipset_tag_t, pci_intr_handle_t);
84 void		*pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t,
85 		    int, int (*)(void *), void *);
86 void		*pci_intr_establish_xname(pci_chipset_tag_t, pci_intr_handle_t,
87 		    int, int (*)(void *), void *, const char *);
88 void		pci_intr_disestablish(pci_chipset_tag_t, void *);
89 
90 pci_intr_type_t	pci_intr_type(pci_chipset_tag_t, pci_intr_handle_t);
91 int		pci_intr_alloc(const struct pci_attach_args *,
92 		    pci_intr_handle_t **, int *, pci_intr_type_t);
93 void		pci_intr_release(pci_chipset_tag_t, pci_intr_handle_t *, int);
94 int		pci_intx_alloc(const struct pci_attach_args *,
95 		    pci_intr_handle_t **);
96 
97 /* experimental MSI support */
98 int		pci_msi_alloc(const struct pci_attach_args *,
99 		    pci_intr_handle_t **, int *);
100 int		pci_msi_alloc_exact(const struct pci_attach_args *,
101 		    pci_intr_handle_t **, int);
102 
103 /* experimental MSI-X support */
104 int		pci_msix_alloc(const struct pci_attach_args *,
105 		    pci_intr_handle_t **, int *);
106 int		pci_msix_alloc_exact(const struct pci_attach_args *,
107 		    pci_intr_handle_t **, int);
108 int		pci_msix_alloc_map(const struct pci_attach_args *,
109 		    pci_intr_handle_t **, u_int *, int);
110 
111 void		pci_conf_interrupt(pci_chipset_tag_t, int, int, int,
112 		    int, int *);
113 int		pci_conf_hook(pci_chipset_tag_t, int, int, int, pcireg_t);
114