]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/pci/pci_host_generic_fdt.c
Fix OpenSSL remote denial of service vulnerability.
[FreeBSD/FreeBSD.git] / sys / dev / pci / pci_host_generic_fdt.c
1 /*-
2  * Copyright (c) 2015 Ruslan Bukin <br@bsdpad.com>
3  * Copyright (c) 2014,2016 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Andrew Turner under
7  * the sponsorship of the FreeBSD Foundation.
8  *
9  * This software was developed by Semihalf under
10  * the sponsorship of the FreeBSD Foundation.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  * notice, this list of conditions and the following disclaimer in the
19  * documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 /* Generic ECAM PCIe driver FDT attachment */
35
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38
39 #include "opt_platform.h"
40
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/bus.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
47 #include <sys/rman.h>
48
49 #if defined(INTRNG)
50 #include <machine/intr.h>
51 #endif
52
53 #include <dev/ofw/openfirm.h>
54 #include <dev/ofw/ofw_bus.h>
55 #include <dev/ofw/ofw_bus_subr.h>
56 #include <dev/ofw/ofw_pci.h>
57
58 #include <dev/pci/pcivar.h>
59 #include <dev/pci/pcireg.h>
60 #include <dev/pci/pcib_private.h>
61 #include <dev/pci/pci_host_generic.h>
62 #include <dev/pci/pci_host_generic_fdt.h>
63
64 #include <machine/intr.h>
65
66 #include "pcib_if.h"
67
68 #define PCI_IO_WINDOW_OFFSET    0x1000
69
70 #define SPACE_CODE_SHIFT        24
71 #define SPACE_CODE_MASK         0x3
72 #define SPACE_CODE_IO_SPACE     0x1
73 #define PROPS_CELL_SIZE         1
74 #define PCI_ADDR_CELL_SIZE      2
75
76 /* OFW bus interface */
77 struct generic_pcie_ofw_devinfo {
78         struct ofw_bus_devinfo  di_dinfo;
79         struct resource_list    di_rl;
80 };
81
82 /* Forward prototypes */
83
84 static int generic_pcie_fdt_probe(device_t dev);
85 static int parse_pci_mem_ranges(device_t, struct generic_pcie_core_softc *);
86 static int generic_pcie_fdt_release_resource(device_t dev, device_t child,
87     int type, int rid, struct resource *res);
88 static int generic_pcie_ofw_bus_attach(device_t);
89 static const struct ofw_bus_devinfo *generic_pcie_ofw_get_devinfo(device_t,
90     device_t);
91
92 static __inline void
93 get_addr_size_cells(phandle_t node, pcell_t *addr_cells, pcell_t *size_cells)
94 {
95
96         *addr_cells = 2;
97         /* Find address cells if present */
98         OF_getencprop(node, "#address-cells", addr_cells, sizeof(*addr_cells));
99
100         *size_cells = 2;
101         /* Find size cells if present */
102         OF_getencprop(node, "#size-cells", size_cells, sizeof(*size_cells));
103 }
104
105 static int
106 generic_pcie_fdt_probe(device_t dev)
107 {
108
109         if (!ofw_bus_status_okay(dev))
110                 return (ENXIO);
111
112         if (ofw_bus_is_compatible(dev, "pci-host-ecam-generic")) {
113                 device_set_desc(dev, "Generic PCI host controller");
114                 return (BUS_PROBE_GENERIC);
115         }
116         if (ofw_bus_is_compatible(dev, "arm,gem5_pcie")) {
117                 device_set_desc(dev, "GEM5 PCIe host controller");
118                 return (BUS_PROBE_DEFAULT);
119         }
120
121         return (ENXIO);
122 }
123
124 int
125 pci_host_generic_attach(device_t dev)
126 {
127         struct generic_pcie_fdt_softc *sc;
128         uint64_t phys_base;
129         uint64_t pci_base;
130         uint64_t size;
131         phandle_t node;
132         int error;
133         int tuple;
134
135         sc = device_get_softc(dev);
136
137         /* Retrieve 'ranges' property from FDT */
138         if (bootverbose)
139                 device_printf(dev, "parsing FDT for ECAM%d:\n", sc->base.ecam);
140         if (parse_pci_mem_ranges(dev, &sc->base))
141                 return (ENXIO);
142
143         /* Attach OFW bus */
144         if (generic_pcie_ofw_bus_attach(dev) != 0)
145                 return (ENXIO);
146
147         node = ofw_bus_get_node(dev);
148         if (sc->base.coherent == 0) {
149                 sc->base.coherent = OF_hasprop(node, "dma-coherent");
150         }
151         if (bootverbose)
152                 device_printf(dev, "Bus is%s cache-coherent\n",
153                     sc->base.coherent ? "" : " not");
154
155         /* TODO parse FDT bus ranges */
156         sc->base.bus_start = 0;
157         sc->base.bus_end = 0xFF;
158         error = pci_host_generic_core_attach(dev);
159         if (error != 0)
160                 return (error);
161
162         for (tuple = 0; tuple < MAX_RANGES_TUPLES; tuple++) {
163                 phys_base = sc->base.ranges[tuple].phys_base;
164                 pci_base = sc->base.ranges[tuple].pci_base;
165                 size = sc->base.ranges[tuple].size;
166                 if (phys_base == 0 || size == 0)
167                         continue; /* empty range element */
168                 if (sc->base.ranges[tuple].flags & FLAG_MEM) {
169                         error = rman_manage_region(&sc->base.mem_rman,
170                            phys_base, phys_base + size - 1);
171                 } else if (sc->base.ranges[tuple].flags & FLAG_IO) {
172                         error = rman_manage_region(&sc->base.io_rman,
173                            pci_base + PCI_IO_WINDOW_OFFSET,
174                            pci_base + PCI_IO_WINDOW_OFFSET + size - 1);
175                 } else
176                         continue;
177                 if (error) {
178                         device_printf(dev, "rman_manage_region() failed."
179                                                 "error = %d\n", error);
180                         rman_fini(&sc->base.mem_rman);
181                         return (error);
182                 }
183         }
184
185         ofw_bus_setup_iinfo(node, &sc->pci_iinfo, sizeof(cell_t));
186
187         device_add_child(dev, "pci", -1);
188         return (bus_generic_attach(dev));
189 }
190
191 static int
192 parse_pci_mem_ranges(device_t dev, struct generic_pcie_core_softc *sc)
193 {
194         pcell_t pci_addr_cells, parent_addr_cells;
195         pcell_t attributes, size_cells;
196         cell_t *base_ranges;
197         int nbase_ranges;
198         phandle_t node;
199         int i, j, k;
200         int tuple;
201
202         node = ofw_bus_get_node(dev);
203
204         OF_getencprop(node, "#address-cells", &pci_addr_cells,
205                                         sizeof(pci_addr_cells));
206         OF_getencprop(node, "#size-cells", &size_cells,
207                                         sizeof(size_cells));
208         OF_getencprop(OF_parent(node), "#address-cells", &parent_addr_cells,
209                                         sizeof(parent_addr_cells));
210
211         if (parent_addr_cells > 2 || pci_addr_cells != 3 || size_cells > 2) {
212                 device_printf(dev,
213                     "Unexpected number of address or size cells in FDT\n");
214                 return (ENXIO);
215         }
216
217         nbase_ranges = OF_getproplen(node, "ranges");
218         sc->nranges = nbase_ranges / sizeof(cell_t) /
219             (parent_addr_cells + pci_addr_cells + size_cells);
220         base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
221         OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
222
223         for (i = 0, j = 0; i < sc->nranges; i++) {
224                 attributes = (base_ranges[j++] >> SPACE_CODE_SHIFT) & \
225                                                         SPACE_CODE_MASK;
226                 if (attributes == SPACE_CODE_IO_SPACE) {
227                         sc->ranges[i].flags |= FLAG_IO;
228                 } else {
229                         sc->ranges[i].flags |= FLAG_MEM;
230                 }
231
232                 sc->ranges[i].pci_base = 0;
233                 for (k = 0; k < (pci_addr_cells - 1); k++) {
234                         sc->ranges[i].pci_base <<= 32;
235                         sc->ranges[i].pci_base |= base_ranges[j++];
236                 }
237                 sc->ranges[i].phys_base = 0;
238                 for (k = 0; k < parent_addr_cells; k++) {
239                         sc->ranges[i].phys_base <<= 32;
240                         sc->ranges[i].phys_base |= base_ranges[j++];
241                 }
242                 sc->ranges[i].size = 0;
243                 for (k = 0; k < size_cells; k++) {
244                         sc->ranges[i].size <<= 32;
245                         sc->ranges[i].size |= base_ranges[j++];
246                 }
247         }
248
249         for (; i < MAX_RANGES_TUPLES; i++) {
250                 /* zero-fill remaining tuples to mark empty elements in array */
251                 sc->ranges[i].pci_base = 0;
252                 sc->ranges[i].phys_base = 0;
253                 sc->ranges[i].size = 0;
254         }
255
256         if (bootverbose) {
257                 for (tuple = 0; tuple < MAX_RANGES_TUPLES; tuple++) {
258                         device_printf(dev,
259                             "\tPCI addr: 0x%jx, CPU addr: 0x%jx, Size: 0x%jx\n",
260                             sc->ranges[tuple].pci_base,
261                             sc->ranges[tuple].phys_base,
262                             sc->ranges[tuple].size);
263                 }
264         }
265
266         free(base_ranges, M_DEVBUF);
267         return (0);
268 }
269
270 static int
271 generic_pcie_fdt_route_interrupt(device_t bus, device_t dev, int pin)
272 {
273         struct generic_pcie_fdt_softc *sc;
274         struct ofw_pci_register reg;
275         uint32_t pintr, mintr[4];
276         phandle_t iparent;
277         int intrcells;
278
279         sc = device_get_softc(bus);
280         pintr = pin;
281
282         bzero(&reg, sizeof(reg));
283         reg.phys_hi = (pci_get_bus(dev) << OFW_PCI_PHYS_HI_BUSSHIFT) |
284             (pci_get_slot(dev) << OFW_PCI_PHYS_HI_DEVICESHIFT) |
285             (pci_get_function(dev) << OFW_PCI_PHYS_HI_FUNCTIONSHIFT);
286
287         intrcells = ofw_bus_lookup_imap(ofw_bus_get_node(dev),
288             &sc->pci_iinfo, &reg, sizeof(reg), &pintr, sizeof(pintr),
289             mintr, sizeof(mintr), &iparent);
290         if (intrcells) {
291                 pintr = ofw_bus_map_intr(dev, iparent, intrcells, mintr);
292                 return (pintr);
293         }
294
295         device_printf(bus, "could not route pin %d for device %d.%d\n",
296             pin, pci_get_slot(dev), pci_get_function(dev));
297         return (PCI_INVALID_IRQ);
298 }
299
300 static int
301 generic_pcie_fdt_release_resource(device_t dev, device_t child, int type,
302     int rid, struct resource *res)
303 {
304
305 #if defined(NEW_PCIB) && defined(PCI_RES_BUS)
306         if (type == PCI_RES_BUS) {
307                 return (pci_host_generic_core_release_resource(dev, child, type,
308                     rid, res));
309         }
310 #endif
311
312         /* For PCIe devices that do not have FDT nodes, use PCIB method */
313         if ((int)ofw_bus_get_node(child) <= 0) {
314                 return (pci_host_generic_core_release_resource(dev, child, type,
315                     rid, res));
316         }
317
318         /* For other devices use OFW method */
319         return (bus_generic_release_resource(dev, child, type, rid, res));
320 }
321
322 struct resource *
323 pci_host_generic_alloc_resource(device_t dev, device_t child, int type,
324     int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
325 {
326         struct generic_pcie_fdt_softc *sc;
327         struct generic_pcie_ofw_devinfo *di;
328         struct resource_list_entry *rle;
329         int i;
330
331 #if defined(NEW_PCIB) && defined(PCI_RES_BUS)
332         if (type == PCI_RES_BUS) {
333                 return (pci_host_generic_core_alloc_resource(dev, child, type, rid,
334                     start, end, count, flags));
335         }
336 #endif
337
338         /* For PCIe devices that do not have FDT nodes, use PCIB method */
339         if ((int)ofw_bus_get_node(child) <= 0)
340                 return (pci_host_generic_core_alloc_resource(dev, child, type,
341                     rid, start, end, count, flags));
342
343         /* For other devices use OFW method */
344         sc = device_get_softc(dev);
345
346         if (RMAN_IS_DEFAULT_RANGE(start, end)) {
347                 if ((di = device_get_ivars(child)) == NULL)
348                         return (NULL);
349                 if (type == SYS_RES_IOPORT)
350                     type = SYS_RES_MEMORY;
351
352                 /* Find defaults for this rid */
353                 rle = resource_list_find(&di->di_rl, type, *rid);
354                 if (rle == NULL)
355                         return (NULL);
356
357                 start = rle->start;
358                 end = rle->end;
359                 count = rle->count;
360         }
361
362         if (type == SYS_RES_MEMORY) {
363                 /* Remap through ranges property */
364                 for (i = 0; i < MAX_RANGES_TUPLES; i++) {
365                         if (start >= sc->base.ranges[i].phys_base &&
366                             end < (sc->base.ranges[i].pci_base +
367                             sc->base.ranges[i].size)) {
368                                 start -= sc->base.ranges[i].phys_base;
369                                 start += sc->base.ranges[i].pci_base;
370                                 end -= sc->base.ranges[i].phys_base;
371                                 end += sc->base.ranges[i].pci_base;
372                                 break;
373                         }
374                 }
375
376                 if (i == MAX_RANGES_TUPLES) {
377                         device_printf(dev, "Could not map resource "
378                             "%#jx-%#jx\n", start, end);
379                         return (NULL);
380                 }
381         }
382
383         return (bus_generic_alloc_resource(dev, child, type, rid, start,
384             end, count, flags));
385 }
386
387 static int
388 generic_pcie_fdt_alloc_msi(device_t pci, device_t child, int count,
389     int maxcount, int *irqs)
390 {
391 #if defined(INTRNG)
392         phandle_t msi_parent;
393         int err;
394
395         err = ofw_bus_msimap(ofw_bus_get_node(pci), pci_get_rid(child),
396             &msi_parent, NULL);
397         if (err != 0)
398                 return (err);
399         return (intr_alloc_msi(pci, child, msi_parent, count, maxcount,
400             irqs));
401 #else
402         return (ENXIO);
403 #endif
404 }
405
406 static int
407 generic_pcie_fdt_release_msi(device_t pci, device_t child, int count, int *irqs)
408 {
409 #if defined(INTRNG)
410         phandle_t msi_parent;
411         int err;
412
413         err = ofw_bus_msimap(ofw_bus_get_node(pci), pci_get_rid(child),
414             &msi_parent, NULL);
415         if (err != 0)
416                 return (err);
417         return (intr_release_msi(pci, child, msi_parent, count, irqs));
418 #else
419         return (ENXIO);
420 #endif
421 }
422
423 static int
424 generic_pcie_fdt_map_msi(device_t pci, device_t child, int irq, uint64_t *addr,
425     uint32_t *data)
426 {
427 #if defined(INTRNG)
428         phandle_t msi_parent;
429         int err;
430
431         err = ofw_bus_msimap(ofw_bus_get_node(pci), pci_get_rid(child),
432             &msi_parent, NULL);
433         if (err != 0)
434                 return (err);
435         return (intr_map_msi(pci, child, msi_parent, irq, addr, data));
436 #else
437         return (ENXIO);
438 #endif
439 }
440
441 static int
442 generic_pcie_fdt_alloc_msix(device_t pci, device_t child, int *irq)
443 {
444 #if defined(INTRNG)
445         phandle_t msi_parent;
446         int err;
447
448         err = ofw_bus_msimap(ofw_bus_get_node(pci), pci_get_rid(child),
449             &msi_parent, NULL);
450         if (err != 0)
451                 return (err);
452         return (intr_alloc_msix(pci, child, msi_parent, irq));
453 #else
454         return (ENXIO);
455 #endif
456 }
457
458 static int
459 generic_pcie_fdt_release_msix(device_t pci, device_t child, int irq)
460 {
461 #if defined(INTRNG)
462         phandle_t msi_parent;
463         int err;
464
465         err = ofw_bus_msimap(ofw_bus_get_node(pci), pci_get_rid(child),
466             &msi_parent, NULL);
467         if (err != 0)
468                 return (err);
469         return (intr_release_msix(pci, child, msi_parent, irq));
470 #else
471         return (ENXIO);
472 #endif
473 }
474
475 int
476 generic_pcie_get_id(device_t pci, device_t child, enum pci_id_type type,
477     uintptr_t *id)
478 {
479         phandle_t node;
480         int err;
481         uint32_t rid;
482         uint16_t pci_rid;
483
484         if (type != PCI_ID_MSI)
485                 return (pcib_get_id(pci, child, type, id));
486
487         node = ofw_bus_get_node(pci);
488         pci_rid = pci_get_rid(child);
489
490         err = ofw_bus_msimap(node, pci_rid, NULL, &rid);
491         if (err != 0)
492                 return (err);
493         *id = rid;
494
495         return (0);
496 }
497
498 static const struct ofw_bus_devinfo *
499 generic_pcie_ofw_get_devinfo(device_t bus __unused, device_t child)
500 {
501         struct generic_pcie_ofw_devinfo *di;
502
503         di = device_get_ivars(child);
504         return (&di->di_dinfo);
505 }
506
507 /* Helper functions */
508
509 static int
510 generic_pcie_ofw_bus_attach(device_t dev)
511 {
512         struct generic_pcie_ofw_devinfo *di;
513         device_t child;
514         phandle_t parent, node;
515         pcell_t addr_cells, size_cells;
516
517         parent = ofw_bus_get_node(dev);
518         if (parent > 0) {
519                 get_addr_size_cells(parent, &addr_cells, &size_cells);
520                 /* Iterate through all bus subordinates */
521                 for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
522
523                         /* Allocate and populate devinfo. */
524                         di = malloc(sizeof(*di), M_DEVBUF, M_WAITOK | M_ZERO);
525                         if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node) != 0) {
526                                 free(di, M_DEVBUF);
527                                 continue;
528                         }
529
530                         /* Initialize and populate resource list. */
531                         resource_list_init(&di->di_rl);
532                         ofw_bus_reg_to_rl(dev, node, addr_cells, size_cells,
533                             &di->di_rl);
534                         ofw_bus_intr_to_rl(dev, node, &di->di_rl, NULL);
535
536                         /* Add newbus device for this FDT node */
537                         child = device_add_child(dev, NULL, -1);
538                         if (child == NULL) {
539                                 resource_list_free(&di->di_rl);
540                                 ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
541                                 free(di, M_DEVBUF);
542                                 continue;
543                         }
544
545                         device_set_ivars(child, di);
546                 }
547         }
548
549         return (0);
550 }
551
552 static device_method_t generic_pcie_fdt_methods[] = {
553         DEVMETHOD(device_probe,         generic_pcie_fdt_probe),
554         DEVMETHOD(device_attach,        pci_host_generic_attach),
555         DEVMETHOD(bus_alloc_resource,   pci_host_generic_alloc_resource),
556         DEVMETHOD(bus_release_resource, generic_pcie_fdt_release_resource),
557
558         /* pcib interface */
559         DEVMETHOD(pcib_route_interrupt, generic_pcie_fdt_route_interrupt),
560         DEVMETHOD(pcib_alloc_msi,       generic_pcie_fdt_alloc_msi),
561         DEVMETHOD(pcib_release_msi,     generic_pcie_fdt_release_msi),
562         DEVMETHOD(pcib_alloc_msix,      generic_pcie_fdt_alloc_msix),
563         DEVMETHOD(pcib_release_msix,    generic_pcie_fdt_release_msix),
564         DEVMETHOD(pcib_map_msi,         generic_pcie_fdt_map_msi),
565         DEVMETHOD(pcib_get_id,          generic_pcie_get_id),
566         DEVMETHOD(pcib_request_feature, pcib_request_feature_allow),
567
568         /* ofw_bus interface */
569         DEVMETHOD(ofw_bus_get_devinfo,  generic_pcie_ofw_get_devinfo),
570         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
571         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
572         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
573         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
574         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
575
576         DEVMETHOD_END
577 };
578
579 DEFINE_CLASS_1(pcib, generic_pcie_fdt_driver, generic_pcie_fdt_methods,
580     sizeof(struct generic_pcie_fdt_softc), generic_pcie_core_driver);
581
582 static devclass_t generic_pcie_fdt_devclass;
583
584 DRIVER_MODULE(pcib, simplebus, generic_pcie_fdt_driver,
585     generic_pcie_fdt_devclass, 0, 0);
586 DRIVER_MODULE(pcib, ofwbus, generic_pcie_fdt_driver, generic_pcie_fdt_devclass,
587     0, 0);