pci_machdep.h revision 1.14 1 /* $NetBSD: pci_machdep.h,v 1.14 2018/10/21 00:42:06 jmcneill Exp $ */
2
3 /*
4 * Modified for arm32 by Mark Brinicombe
5 *
6 * from: sys/arch/alpha/pci/pci_machdep.h
7 *
8 * Copyright (c) 1996 Carnegie-Mellon University.
9 * All rights reserved.
10 *
11 * Author: Chris G. Demetriou
12 *
13 * Permission to use, copy, modify and distribute this software and
14 * its documentation is hereby granted, provided that both the copyright
15 * notice and this permission notice appear in all copies of the
16 * software, derivative works or modified versions, and any portions
17 * thereof, and that both notices appear in supporting documentation.
18 *
19 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
20 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
21 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
22 *
23 * Carnegie Mellon requests users of this software to return to
24 *
25 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
26 * School of Computer Science
27 * Carnegie Mellon University
28 * Pittsburgh PA 15213-3890
29 *
30 * any improvements or extensions that they make and grant Carnegie the
31 * rights to redistribute these changes.
32 */
33
34 #ifndef _ARM_PCI_MACHDEP_H_
35 #define _ARM_PCI_MACHDEP_H_
36 /*
37 * Machine-specific definitions for PCI autoconfiguration.
38 */
39
40 #ifdef __aarch64__
41 #define _PCI_HAVE_DMA64
42 #endif
43
44 #include <sys/errno.h>
45
46 /*
47 * Types provided to machine-independent PCI code
48 */
49 typedef struct arm32_pci_chipset *pci_chipset_tag_t;
50 typedef u_long pcitag_t;
51 typedef uint64_t pci_intr_handle_t;
52
53 /*
54 * pci_intr_handle_t fields
55 */
56 #define ARM_PCI_INTR_MSI_VEC 0x000007ff00000000ULL
57 #define ARM_PCI_INTR_MPSAFE 0x0000000080000000ULL
58 #define ARM_PCI_INTR_MSIX 0x0000000040000000ULL
59 #define ARM_PCI_INTR_MSI 0x0000000020000000ULL
60 #define ARM_PCI_INTR_FRAME 0x0000000000ff0000ULL
61 #define ARM_PCI_INTR_IRQ 0x000000000000ffffULL
62
63 #ifdef __HAVE_PCI_MSI_MSIX
64 /*
65 * PCI MSI/MSI-X support
66 */
67 typedef enum {
68 PCI_INTR_TYPE_INTX = 0,
69 PCI_INTR_TYPE_MSI,
70 PCI_INTR_TYPE_MSIX,
71 PCI_INTR_TYPE_SIZE,
72 } pci_intr_type_t;
73 #endif /* __HAVE_PCI_MSI_MSIX */
74
75 /*
76 * Forward declarations.
77 */
78 struct pci_attach_args;
79
80 /*
81 * arm32-specific PCI structure and type definitions.
82 * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
83 */
84 struct arm32_pci_chipset {
85 void *pc_conf_v;
86 void (*pc_attach_hook)(device_t, device_t,
87 struct pcibus_attach_args *);
88 int (*pc_bus_maxdevs)(void *, int);
89 pcitag_t (*pc_make_tag)(void *, int, int, int);
90 void (*pc_decompose_tag)(void *, pcitag_t, int *,
91 int *, int *);
92 pcireg_t (*pc_conf_read)(void *, pcitag_t, int);
93 void (*pc_conf_write)(void *, pcitag_t, int, pcireg_t);
94
95 void *pc_intr_v;
96 int (*pc_intr_map)(const struct pci_attach_args *,
97 pci_intr_handle_t *);
98 const char *(*pc_intr_string)(void *, pci_intr_handle_t,
99 char *, size_t);
100 const struct evcnt *(*pc_intr_evcnt)(void *, pci_intr_handle_t);
101 int (*pc_intr_setattr)(void *, pci_intr_handle_t *,
102 int, uint64_t);
103 void *(*pc_intr_establish)(void *, pci_intr_handle_t,
104 int, int (*)(void *), void *);
105 void (*pc_intr_disestablish)(void *, void *);
106
107 #ifdef __HAVE_PCI_CONF_HOOK
108 int (*pc_conf_hook)(void *, int, int, int, pcireg_t);
109 #endif
110 void (*pc_conf_interrupt)(void *, int, int, int, int, int *);
111
112 #ifdef __HAVE_PCI_MSI_MSIX
113 void *pc_msi_v;
114 pci_intr_type_t (*pc_intr_type)(void *, pci_intr_handle_t);
115 int (*pc_intr_alloc)(const struct pci_attach_args *,
116 pci_intr_handle_t **, int *, pci_intr_type_t);
117 void (*pc_intr_release)(void *, pci_intr_handle_t *, int);
118 int (*pc_intx_alloc)(const struct pci_attach_args *,
119 pci_intr_handle_t **);
120 int (*pc_msi_alloc)(const struct pci_attach_args *,
121 pci_intr_handle_t **, int *);
122 int (*pc_msi_alloc_exact)(const struct pci_attach_args *,
123 pci_intr_handle_t **, int);
124 int (*pc_msix_alloc)(const struct pci_attach_args *,
125 pci_intr_handle_t **, int *);
126 int (*pc_msix_alloc_exact)(const struct pci_attach_args *,
127 pci_intr_handle_t **, int);
128 int (*pc_msix_alloc_map)(const struct pci_attach_args *,
129 pci_intr_handle_t **, u_int *, int);
130 #endif
131
132 uint32_t pc_cfg_cmd;
133 };
134
135 /*
136 * Functions provided to machine-independent PCI code.
137 */
138 #define pci_attach_hook(p, s, pba) \
139 (*(pba)->pba_pc->pc_attach_hook)((p), (s), (pba))
140 #define pci_bus_maxdevs(c, b) \
141 (*(c)->pc_bus_maxdevs)((c)->pc_conf_v, (b))
142 #define pci_make_tag(c, b, d, f) \
143 (*(c)->pc_make_tag)((c)->pc_conf_v, (b), (d), (f))
144 #define pci_decompose_tag(c, t, bp, dp, fp) \
145 (*(c)->pc_decompose_tag)((c)->pc_conf_v, (t), (bp), (dp), (fp))
146 #define pci_conf_read(c, t, r) \
147 (*(c)->pc_conf_read)((c)->pc_conf_v, (t), (r))
148 #define pci_conf_write(c, t, r, v) \
149 (*(c)->pc_conf_write)((c)->pc_conf_v, (t), (r), (v))
150 #define pci_intr_map(pa, ihp) \
151 (*(pa)->pa_pc->pc_intr_map)((pa), (ihp))
152 #define pci_intr_string(c, ih, buf, len) \
153 (*(c)->pc_intr_string)((c)->pc_intr_v, (ih), (buf), (len))
154 #define pci_intr_evcnt(c, ih) \
155 (*(c)->pc_intr_evcnt)((c)->pc_intr_v, (ih))
156 #define pci_intr_establish(c, ih, l, h, a) \
157 (*(c)->pc_intr_establish)((c)->pc_intr_v, (ih), (l), (h), (a))
158 #define pci_intr_disestablish(c, iv) \
159 (*(c)->pc_intr_disestablish)((c)->pc_intr_v, (iv))
160 #ifdef __HAVE_PCI_CONF_HOOK
161 #define pci_conf_hook(c, b, d, f, id) \
162 (*(c)->pc_conf_hook)((c)->pc_conf_v, (b), (d), (f), (id))
163 #endif
164 #define pci_conf_interrupt(c, b, d, i, s, p) \
165 (*(c)->pc_conf_interrupt)((c)->pc_conf_v, (b), (d), (i), (s), (p))
166
167 static inline int
168 pci_intr_setattr(pci_chipset_tag_t pc, pci_intr_handle_t *ihp,
169 int attr, uint64_t data)
170 {
171 if (!pc->pc_intr_setattr)
172 return ENODEV;
173 return pc->pc_intr_setattr(pc, ihp, attr, data);
174 }
175
176 #ifdef __HAVE_PCI_MSI_MSIX
177 pci_intr_type_t pci_intr_type(pci_chipset_tag_t, pci_intr_handle_t);
178 int pci_intr_alloc(const struct pci_attach_args *, pci_intr_handle_t **,
179 int *, pci_intr_type_t);
180 void pci_intr_release(pci_chipset_tag_t, pci_intr_handle_t *, int);
181 int pci_intx_alloc(const struct pci_attach_args *, pci_intr_handle_t **);
182 int pci_msi_alloc(const struct pci_attach_args *, pci_intr_handle_t **,
183 int *);
184 int pci_msi_alloc_exact(const struct pci_attach_args *,
185 pci_intr_handle_t **, int);
186 int pci_msix_alloc(const struct pci_attach_args *, pci_intr_handle_t **,
187 int *);
188 int pci_msix_alloc_exact(const struct pci_attach_args *,
189 pci_intr_handle_t **, int);
190 int pci_msix_alloc_map(const struct pci_attach_args *, pci_intr_handle_t **,
191 u_int *, int);
192 #endif /* __HAVE_PCI_MSI_MSIX */
193
194 #endif /* _ARM_PCI_MACHDEP_H_ */
195