b3aae3dda1e1ebec4f24b9ad015a829f624788be
[dragonfly.git] / sys / dev / drm / include / linux / pci.h
1 /*
2  * Copyright (c) 2014-2018 François Tigeot <ftigeot@wolfpond.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef LINUX_PCI_H
28 #define LINUX_PCI_H
29
30 #define PCI_ANY_ID      (~0u)
31
32 #include <sys/param.h>
33 #include <sys/bus.h>
34 #include <sys/pciio.h>
35 #include <sys/rman.h>
36 #include <bus/pci/pcivar.h>
37 #include <bus/pci/pcireg.h>
38
39 #include <linux/types.h>
40 #include <linux/list.h>
41 #include <linux/compiler.h>
42 #include <linux/errno.h>
43 #include <linux/kobject.h>
44 #include <linux/atomic.h>
45 #include <linux/device.h>
46 #include <linux/io.h>
47 #include <uapi/linux/pci.h>
48
49 #include <linux/pci_ids.h>
50
51 struct pci_bus;
52
53 struct pci_device_id {
54         uint32_t vendor;
55         uint32_t device;
56         uint32_t subvendor;
57         uint32_t subdevice;
58         uint32_t class;
59         uint32_t class_mask;
60         unsigned long driver_data;
61 };
62
63 struct pci_dev {
64         struct pci_bus *bus;            /* bus device is nailed to */
65         struct device dev;
66
67         uint32_t devfn;
68         uint16_t vendor;                /* vendor ID */
69         uint16_t device;                /* device ID */
70         uint16_t subsystem_vendor;
71         uint16_t subsystem_device;
72
73         uint8_t revision;               /* revision ID */
74
75         unsigned int irq;               /* handle with care */
76         void *pci_dev_data;
77
78         /* DragonFly-specific data */
79         int             _irq_type;
80         struct resource *_irqr;
81         int             _irqrid;
82 };
83
84 struct pci_bus {
85         struct pci_dev *self;           /* handle to pdev self */
86         struct device *dev;             /* handle to dev */
87
88         unsigned char number;           /* bus addr number */
89 };
90
91 struct pci_driver {
92 };
93
94 /* XXX: should be in uapi/linux/pci.h */
95 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
96 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
97 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
98
99 #define PCI_DMA_BIDIRECTIONAL   0
100
101 /* extracted from radeon/si.c radeon/cik.c */
102 #define PCI_EXP_LNKCTL PCIER_LINKCTRL /* 16 */
103 #define PCI_EXP_LNKCTL2 48
104 #define PCI_EXP_LNKCTL_HAWD PCIEM_LNKCTL_HAWD /* 0x0200 */
105 #define PCI_EXP_DEVSTA PCIER_DEVSTS /* 10 */
106 #define PCI_EXP_DEVSTA_TRPND 0x0020
107 #define PCI_EXP_LNKCAP_CLKPM 0x00040000
108
109 static inline int
110 pci_read_config_byte(struct pci_dev *pdev, int where, u8 *val)
111 {
112         *val = (u8)pci_read_config(pdev->dev.bsddev, where, 1);
113         return 0;
114 }
115
116 static inline int
117 pci_read_config_word(struct pci_dev *pdev, int where, u16 *val)
118 {
119         *val = (u16)pci_read_config(pdev->dev.bsddev, where, 2);
120         return 0;
121 }
122
123 static inline int
124 pci_read_config_dword(struct pci_dev *pdev, int where, u32 *val)
125 {
126         *val = (u32)pci_read_config(pdev->dev.bsddev, where, 4);
127         return 0;
128 }
129
130 static inline int
131 pci_write_config_byte(struct pci_dev *pdev, int where, u8 val)
132 {
133         pci_write_config(pdev->dev.bsddev, where, val, 1);
134         return 0;
135 }
136
137 static inline int
138 pci_write_config_word(struct pci_dev *pdev, int where, u16 val)
139 {
140         pci_write_config(pdev->dev.bsddev, where, val, 2);
141         return 0;
142 }
143
144 static inline int
145 pci_write_config_dword(struct pci_dev *pdev, int where, u32 val)
146 {
147         pci_write_config(pdev->dev.bsddev, where, val, 4);
148         return 0;
149 }
150
151 /* extracted from drm/radeon/evergreen.c */
152 static inline int
153 pcie_get_readrq(struct pci_dev *pdev)
154 {
155         u16 ctl;
156         int err, cap;
157
158         err = pci_find_extcap(pdev->dev.bsddev, PCIY_EXPRESS, &cap);
159
160         cap += PCIER_DEVCTRL;
161
162         ctl = pci_read_config(pdev->dev.bsddev, cap, 2);
163
164         return 128 << ((ctl & PCIEM_DEVCTL_MAX_READRQ_MASK) >> 12);
165 }
166
167 /* valid rq sizes: 128, 256, 512, 1024, 2048, 4096 (^2N) */
168 static inline int
169 pcie_set_readrq(struct pci_dev *pdev, int rq)
170 {
171         u16 ctl;
172         int err, cap;
173
174         if (rq < 128 || rq > 4096 || !is_power_of_2(rq))
175                 return -EINVAL;
176
177         err = pci_find_extcap(pdev->dev.bsddev, PCIY_EXPRESS, &cap);
178         if (err)
179                 return (-1);
180
181         cap += PCIER_DEVCTRL;
182
183         ctl = pci_read_config(pdev->dev.bsddev, cap, 2);
184         ctl &= ~PCIEM_DEVCTL_MAX_READRQ_MASK;
185         ctl |= ((ffs(rq) - 8) << 12);
186         pci_write_config(pdev->dev.bsddev, cap, ctl, 2);
187         return 0;
188 }
189
190 static inline struct pci_dev *
191 pci_dev_get(struct pci_dev *dev)
192 {
193         /* Linux increments a reference count here */
194         return dev;
195 }
196
197 static inline struct pci_dev *
198 pci_dev_put(struct pci_dev *dev)
199 {
200         /* Linux decrements a reference count here */
201         return dev;
202 }
203
204
205 static inline int
206 pci_set_dma_mask(struct pci_dev *dev, u64 mask)
207 {
208         return -EIO;
209 }
210
211 static inline int
212 pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
213 {
214         return -EIO;
215 }
216
217 typedef int pci_power_t;
218
219 #define PCI_D0          0
220 #define PCI_D1          1
221 #define PCI_D2          2
222 #define PCI_D3hot       3
223 #define PCI_D3cold      4
224
225 #include <asm/pci.h>
226
227 static inline struct resource_list_entry*
228 _pci_get_rle(struct pci_dev *pdev, int bar)
229 {
230         struct pci_devinfo *dinfo;
231         device_t dev = pdev->dev.bsddev;
232         struct resource_list_entry *rle;
233
234         dinfo = device_get_ivars(dev);
235
236         /* Some child devices don't have registered resources, they
237          * are only present in the parent */
238         if (dinfo == NULL)
239                 dev = device_get_parent(dev);
240         dinfo = device_get_ivars(dev);
241         if (dinfo == NULL)
242                 return NULL;
243
244         rle = resource_list_find(&dinfo->resources, SYS_RES_MEMORY, PCIR_BAR(bar));
245         if (rle == NULL) {
246                 rle = resource_list_find(&dinfo->resources,
247                                          SYS_RES_IOPORT, PCIR_BAR(bar));
248         }
249
250         return rle;
251 }
252
253 /*
254  * Returns the first address (memory address or I/O port number)
255  * associated with one of the PCI I/O regions.The region is selected by
256  * the integer bar (the base address register), ranging from 0–5 (inclusive).
257  * The return value can be used by ioremap()
258  */
259 static inline phys_addr_t
260 pci_resource_start(struct pci_dev *pdev, int bar)
261 {
262         struct resource *res;
263         int rid;
264
265         rid = PCIR_BAR(bar);
266         res = bus_alloc_resource_any(pdev->dev.bsddev, SYS_RES_MEMORY, &rid, RF_SHAREABLE);
267         if (res == NULL) {
268                 kprintf("pci_resource_start(0x%p, 0x%x) failed\n", pdev, PCIR_BAR(bar));
269                 return -1;
270         }
271
272         return rman_get_start(res);
273 }
274
275 static inline phys_addr_t
276 pci_resource_len(struct pci_dev *pdev, int bar)
277 {
278         struct resource_list_entry *rle;
279
280         rle = _pci_get_rle(pdev, bar);
281         if (rle == NULL)
282                 return -1;
283
284         return  rman_get_size(rle->res);
285 }
286
287 static inline void __iomem *pci_iomap(struct pci_dev *dev, int bar, unsigned long maxlen)
288 {
289         resource_size_t base, size;
290
291         base = pci_resource_start(dev, bar);
292         size = pci_resource_len(dev, bar);
293
294         if (base == 0)
295                 return NULL;
296
297         if (maxlen && size > maxlen)
298                 size = maxlen;
299
300         return ioremap(base, size);
301 }
302
303 static inline int
304 pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn, int where, u8 *val)
305 {
306         const struct pci_dev *pdev = container_of(&bus, struct pci_dev, bus);
307
308         *val = (u8)pci_read_config(pdev->dev.bsddev, where, 1);
309         return 0;
310 }
311
312 static inline int
313 pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn, int where, u16 *val)
314 {
315         const struct pci_dev *pdev = container_of(&bus, struct pci_dev, bus);
316
317         *val = (u16)pci_read_config(pdev->dev.bsddev, where, 2);
318         return 0;
319 }
320
321 static inline void *
322 pci_get_drvdata(struct pci_dev *pdev)
323 {
324         return pdev->pci_dev_data;
325 }
326
327 static inline void
328 pci_set_drvdata(struct pci_dev *pdev, void *data)
329 {
330         pdev->pci_dev_data = data;
331 }
332
333 static inline int
334 pci_register_driver(struct pci_driver *drv)
335 {
336         return 0;
337 }
338
339 #endif /* LINUX_PCI_H */