2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (C) 2010 Nathan Whitehorn
5 * Copyright (C) 2011 glevand (geoffrey.levand@mail.ru)
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
33 #include <sys/malloc.h>
35 #include <sys/clock.h>
38 #include <sys/mutex.h>
39 #include <sys/resource.h>
45 #include <machine/bus.h>
46 #include <machine/platform.h>
47 #include <machine/resource.h>
50 #include "ps3-hvcall.h"
54 static void ps3bus_identify(driver_t *, device_t);
55 static int ps3bus_probe(device_t);
56 static int ps3bus_attach(device_t);
57 static int ps3bus_print_child(device_t dev, device_t child);
58 static int ps3bus_read_ivar(device_t bus, device_t child, int which,
60 static struct resource *ps3bus_alloc_resource(device_t bus, device_t child,
61 int type, int *rid, rman_res_t start, rman_res_t end,
62 rman_res_t count, u_int flags);
63 static int ps3bus_activate_resource(device_t bus, device_t child, int type,
64 int rid, struct resource *res);
65 static bus_dma_tag_t ps3bus_get_dma_tag(device_t dev, device_t child);
66 static int ps3_iommu_map(device_t dev, bus_dma_segment_t *segs, int *nsegs, bus_addr_t min, bus_addr_t max, bus_size_t alignment,
67 bus_addr_t boundary, void *cookie);
68 static int ps3_iommu_unmap(device_t dev, bus_dma_segment_t *segs,
69 int nsegs, void *cookie);
70 static int ps3_gettime(device_t dev, struct timespec *ts);
71 static int ps3_settime(device_t dev, struct timespec *ts);
73 struct ps3bus_devinfo {
81 struct resource_list resources;
82 bus_dma_tag_t dma_tag;
85 bus_addr_t dma_base[4];
88 static MALLOC_DEFINE(M_PS3BUS, "ps3bus", "PS3 system bus device information");
90 enum ps3bus_irq_type {
96 enum ps3bus_reg_type {
101 static device_method_t ps3bus_methods[] = {
102 /* Device interface */
103 DEVMETHOD(device_identify, ps3bus_identify),
104 DEVMETHOD(device_probe, ps3bus_probe),
105 DEVMETHOD(device_attach, ps3bus_attach),
108 DEVMETHOD(bus_add_child, bus_generic_add_child),
109 DEVMETHOD(bus_get_dma_tag, ps3bus_get_dma_tag),
110 DEVMETHOD(bus_print_child, ps3bus_print_child),
111 DEVMETHOD(bus_read_ivar, ps3bus_read_ivar),
112 DEVMETHOD(bus_alloc_resource, ps3bus_alloc_resource),
113 DEVMETHOD(bus_activate_resource, ps3bus_activate_resource),
114 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
115 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
117 /* IOMMU interface */
118 DEVMETHOD(iommu_map, ps3_iommu_map),
119 DEVMETHOD(iommu_unmap, ps3_iommu_unmap),
121 /* Clock interface */
122 DEVMETHOD(clock_gettime, ps3_gettime),
123 DEVMETHOD(clock_settime, ps3_settime),
128 struct ps3bus_softc {
129 struct rman sc_mem_rman;
130 struct rman sc_intr_rman;
131 struct mem_region *regions;
135 static driver_t ps3bus_driver = {
138 sizeof(struct ps3bus_softc)
141 DRIVER_MODULE(ps3bus, nexus, ps3bus_driver, 0, 0);
144 ps3bus_identify(driver_t *driver, device_t parent)
146 if (strcmp(installed_platform(), "ps3") != 0)
149 if (device_find_child(parent, "ps3bus", -1) == NULL)
150 BUS_ADD_CHILD(parent, 0, "ps3bus", 0);
154 ps3bus_probe(device_t dev)
156 /* Do not attach to any OF nodes that may be present */
158 device_set_desc(dev, "Playstation 3 System Bus");
160 return (BUS_PROBE_NOWILDCARD);
164 ps3bus_resources_init(struct rman *rm, int bus_index, int dev_index,
165 struct ps3bus_devinfo *dinfo)
167 uint64_t irq_type, irq, outlet;
168 uint64_t reg_type, paddr, len;
173 resource_list_init(&dinfo->resources);
175 lv1_get_logical_ppe_id(&ppe);
176 thread = 32 - fls(mfctrl());
178 /* Scan for interrupts */
179 for (i = 0; i < 10; i++) {
180 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
181 (lv1_repository_string("bus") >> 32) | bus_index,
182 lv1_repository_string("dev") | dev_index,
183 lv1_repository_string("intr") | i, 0, &irq_type, &irq);
190 lv1_construct_event_receive_port(&outlet);
191 lv1_connect_irq_plug_ext(ppe, thread, outlet, outlet,
193 lv1_connect_interrupt_event_receive_port(dinfo->bus,
194 dinfo->dev, outlet, irq);
198 lv1_construct_io_irq_outlet(irq, &outlet);
199 lv1_connect_irq_plug_ext(ppe, thread, outlet, outlet,
203 printf("Unknown IRQ type %ld for device %d.%d\n",
204 irq_type, dinfo->bus, dinfo->dev);
208 resource_list_add(&dinfo->resources, SYS_RES_IRQ, i,
212 /* Scan for registers */
213 for (i = 0; i < 10; i++) {
214 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
215 (lv1_repository_string("bus") >> 32) | bus_index,
216 lv1_repository_string("dev") | dev_index,
217 lv1_repository_string("reg") | i,
218 lv1_repository_string("type"), ®_type, &junk);
223 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
224 (lv1_repository_string("bus") >> 32) | bus_index,
225 lv1_repository_string("dev") | dev_index,
226 lv1_repository_string("reg") | i,
227 lv1_repository_string("data"), &paddr, &len);
229 result = lv1_map_device_mmio_region(dinfo->bus, dinfo->dev,
230 paddr, len, 12 /* log_2(4 KB) */, &paddr);
233 printf("Mapping registers failed for device "
234 "%d.%d (%ld.%ld): %d\n", dinfo->bus, dinfo->dev,
235 dinfo->bustype, dinfo->devtype, result);
239 rman_manage_region(rm, paddr, paddr + len - 1);
240 resource_list_add(&dinfo->resources, SYS_RES_MEMORY, i,
241 paddr, paddr + len, len);
246 ps3bus_resources_init_by_type(struct rman *rm, int bus_index, int dev_index,
247 uint64_t irq_type, uint64_t reg_type, struct ps3bus_devinfo *dinfo)
249 uint64_t _irq_type, irq, outlet;
250 uint64_t _reg_type, paddr, len;
255 resource_list_init(&dinfo->resources);
257 lv1_get_logical_ppe_id(&ppe);
258 thread = 32 - fls(mfctrl());
260 /* Scan for interrupts */
261 for (i = 0; i < 10; i++) {
262 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
263 (lv1_repository_string("bus") >> 32) | bus_index,
264 lv1_repository_string("dev") | dev_index,
265 lv1_repository_string("intr") | i, 0, &_irq_type, &irq);
270 if (_irq_type != irq_type)
273 lv1_construct_io_irq_outlet(irq, &outlet);
274 lv1_connect_irq_plug_ext(ppe, thread, outlet, outlet,
276 resource_list_add(&dinfo->resources, SYS_RES_IRQ, i,
280 /* Scan for registers */
281 for (i = 0; i < 10; i++) {
282 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
283 (lv1_repository_string("bus") >> 32) | bus_index,
284 lv1_repository_string("dev") | dev_index,
285 lv1_repository_string("reg") | i,
286 lv1_repository_string("type"), &_reg_type, &junk);
291 if (_reg_type != reg_type)
294 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
295 (lv1_repository_string("bus") >> 32) | bus_index,
296 lv1_repository_string("dev") | dev_index,
297 lv1_repository_string("reg") | i,
298 lv1_repository_string("data"), &paddr, &len);
300 result = lv1_map_device_mmio_region(dinfo->bus, dinfo->dev,
301 paddr, len, 12 /* log_2(4 KB) */, &paddr);
304 printf("Mapping registers failed for device "
305 "%d.%d (%ld.%ld): %d\n", dinfo->bus, dinfo->dev,
306 dinfo->bustype, dinfo->devtype, result);
310 rman_manage_region(rm, paddr, paddr + len - 1);
311 resource_list_add(&dinfo->resources, SYS_RES_MEMORY, i,
312 paddr, paddr + len, len);
317 ps3bus_attach(device_t self)
319 struct ps3bus_softc *sc;
320 struct ps3bus_devinfo *dinfo;
321 int bus_index, dev_index, result;
322 uint64_t bustype, bus, devs;
323 uint64_t dev, devtype;
327 sc = device_get_softc(self);
328 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
329 sc->sc_mem_rman.rm_descr = "PS3Bus Memory Mapped I/O";
330 sc->sc_intr_rman.rm_type = RMAN_ARRAY;
331 sc->sc_intr_rman.rm_descr = "PS3Bus Interrupts";
332 rman_init(&sc->sc_mem_rman);
333 rman_init(&sc->sc_intr_rman);
334 rman_manage_region(&sc->sc_intr_rman, 0, ~0);
336 /* Get memory regions for DMA */
337 mem_regions(&sc->regions, &sc->rcount, NULL, NULL);
340 * Probe all the PS3's buses.
343 for (bus_index = 0; bus_index < 5; bus_index++) {
344 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
345 (lv1_repository_string("bus") >> 32) | bus_index,
346 lv1_repository_string("type"), 0, 0, &bustype, &junk);
351 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
352 (lv1_repository_string("bus") >> 32) | bus_index,
353 lv1_repository_string("id"), 0, 0, &bus, &junk);
358 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
359 (lv1_repository_string("bus") >> 32) | bus_index,
360 lv1_repository_string("num_dev"), 0, 0, &devs, &junk);
362 for (dev_index = 0; dev_index < devs; dev_index++) {
363 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
364 (lv1_repository_string("bus") >> 32) | bus_index,
365 lv1_repository_string("dev") | dev_index,
366 lv1_repository_string("type"), 0, &devtype, &junk);
371 result = lv1_get_repository_node_value(PS3_LPAR_ID_PME,
372 (lv1_repository_string("bus") >> 32) | bus_index,
373 lv1_repository_string("dev") | dev_index,
374 lv1_repository_string("id"), 0, &dev, &junk);
380 case PS3_DEVTYPE_USB:
381 /* USB device has OHCI and EHCI USB host controllers */
383 lv1_open_device(bus, dev, 0);
385 /* OHCI host controller */
387 dinfo = malloc(sizeof(*dinfo), M_PS3BUS,
392 dinfo->bustype = bustype;
393 dinfo->devtype = devtype;
394 dinfo->busidx = bus_index;
395 dinfo->devidx = dev_index;
397 ps3bus_resources_init_by_type(&sc->sc_mem_rman, bus_index,
398 dev_index, OHCI_IRQ, OHCI_REG, dinfo);
400 cdev = device_add_child(self, "ohci", -1);
403 "device_add_child failed\n");
404 free(dinfo, M_PS3BUS);
408 mtx_init(&dinfo->iommu_mtx, "iommu", NULL, MTX_DEF);
409 device_set_ivars(cdev, dinfo);
411 /* EHCI host controller */
413 dinfo = malloc(sizeof(*dinfo), M_PS3BUS,
418 dinfo->bustype = bustype;
419 dinfo->devtype = devtype;
420 dinfo->busidx = bus_index;
421 dinfo->devidx = dev_index;
423 ps3bus_resources_init_by_type(&sc->sc_mem_rman, bus_index,
424 dev_index, EHCI_IRQ, EHCI_REG, dinfo);
426 cdev = device_add_child(self, "ehci", -1);
429 "device_add_child failed\n");
430 free(dinfo, M_PS3BUS);
434 mtx_init(&dinfo->iommu_mtx, "iommu", NULL, MTX_DEF);
435 device_set_ivars(cdev, dinfo);
438 dinfo = malloc(sizeof(*dinfo), M_PS3BUS,
443 dinfo->bustype = bustype;
444 dinfo->devtype = devtype;
445 dinfo->busidx = bus_index;
446 dinfo->devidx = dev_index;
448 if (dinfo->bustype == PS3_BUSTYPE_SYSBUS ||
449 dinfo->bustype == PS3_BUSTYPE_STORAGE)
450 lv1_open_device(bus, dev, 0);
452 ps3bus_resources_init(&sc->sc_mem_rman, bus_index,
455 cdev = device_add_child(self, NULL, -1);
458 "device_add_child failed\n");
459 free(dinfo, M_PS3BUS);
463 mtx_init(&dinfo->iommu_mtx, "iommu", NULL, MTX_DEF);
464 device_set_ivars(cdev, dinfo);
469 clock_register(self, 1000);
471 return (bus_generic_attach(self));
475 ps3bus_print_child(device_t dev, device_t child)
477 struct ps3bus_devinfo *dinfo = device_get_ivars(child);
480 retval += bus_print_child_header(dev, child);
481 retval += resource_list_print_type(&dinfo->resources, "mem",
482 SYS_RES_MEMORY, "%#jx");
483 retval += resource_list_print_type(&dinfo->resources, "irq",
486 retval += bus_print_child_footer(dev, child);
492 ps3bus_read_ivar(device_t bus, device_t child, int which, uintptr_t *result)
494 struct ps3bus_devinfo *dinfo = device_get_ivars(child);
497 case PS3BUS_IVAR_BUS:
498 *result = dinfo->bus;
500 case PS3BUS_IVAR_DEVICE:
501 *result = dinfo->dev;
503 case PS3BUS_IVAR_BUSTYPE:
504 *result = dinfo->bustype;
506 case PS3BUS_IVAR_DEVTYPE:
507 *result = dinfo->devtype;
509 case PS3BUS_IVAR_BUSIDX:
510 *result = dinfo->busidx;
512 case PS3BUS_IVAR_DEVIDX:
513 *result = dinfo->devidx;
522 static struct resource *
523 ps3bus_alloc_resource(device_t bus, device_t child, int type, int *rid,
524 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
526 struct ps3bus_devinfo *dinfo;
527 struct ps3bus_softc *sc;
531 rman_res_t adjstart, adjend, adjcount;
532 struct resource_list_entry *rle;
534 sc = device_get_softc(bus);
535 dinfo = device_get_ivars(child);
536 needactivate = flags & RF_ACTIVE;
541 rle = resource_list_find(&dinfo->resources, SYS_RES_MEMORY,
544 device_printf(bus, "no rle for %s memory %d\n",
545 device_get_nameunit(child), *rid);
549 if (start < rle->start)
550 adjstart = rle->start;
551 else if (start > rle->end)
556 if (end < rle->start)
558 else if (end > rle->end)
563 adjcount = adjend - adjstart;
565 rm = &sc->sc_mem_rman;
568 rle = resource_list_find(&dinfo->resources, SYS_RES_IRQ,
570 rm = &sc->sc_intr_rman;
571 adjstart = rle->start;
572 adjcount = ulmax(count, rle->count);
573 adjend = ulmax(rle->end, rle->start + adjcount - 1);
576 device_printf(bus, "unknown resource request from %s\n",
577 device_get_nameunit(child));
581 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags,
585 "failed to reserve resource %#lx - %#lx (%#lx)"
586 " for %s\n", adjstart, adjend, adjcount,
587 device_get_nameunit(child));
591 rman_set_rid(rv, *rid);
594 if (bus_activate_resource(child, type, *rid, rv) != 0) {
596 "failed to activate resource for %s\n",
597 device_get_nameunit(child));
598 rman_release_resource(rv);
607 ps3bus_activate_resource(device_t bus, device_t child, int type, int rid,
608 struct resource *res)
612 if (type == SYS_RES_IRQ)
613 return (bus_activate_resource(bus, type, rid, res));
615 if (type == SYS_RES_MEMORY) {
618 start = (vm_offset_t) rman_get_start(res);
621 printf("ps3 mapdev: start %zx, len %ld\n", start,
624 p = pmap_mapdev(start, (vm_size_t) rman_get_size(res));
627 rman_set_virtual(res, p);
628 rman_set_bustag(res, &bs_be_tag);
629 rman_set_bushandle(res, (rman_res_t)p);
632 return (rman_activate_resource(res));
636 ps3bus_get_dma_tag(device_t dev, device_t child)
638 struct ps3bus_devinfo *dinfo = device_get_ivars(child);
639 struct ps3bus_softc *sc = device_get_softc(dev);
640 int i, err, flags, pagesize;
642 if (dinfo->bustype != PS3_BUSTYPE_SYSBUS &&
643 dinfo->bustype != PS3_BUSTYPE_STORAGE)
644 return (bus_get_dma_tag(dev));
646 mtx_lock(&dinfo->iommu_mtx);
647 if (dinfo->dma_tag != NULL) {
648 mtx_unlock(&dinfo->iommu_mtx);
649 return (dinfo->dma_tag);
652 flags = 0; /* 32-bit mode */
653 if (dinfo->bustype == PS3_BUSTYPE_SYSBUS &&
654 dinfo->devtype == PS3_DEVTYPE_USB)
655 flags = 2; /* 8-bit mode */
657 pagesize = 24; /* log_2(16 MB) */
658 if (dinfo->bustype == PS3_BUSTYPE_STORAGE)
659 pagesize = 12; /* 4 KB */
661 for (i = 0; i < sc->rcount; i++) {
662 err = lv1_allocate_device_dma_region(dinfo->bus, dinfo->dev,
663 sc->regions[i].mr_size, pagesize, flags,
664 &dinfo->dma_base[i]);
667 "could not allocate DMA region %d: %d\n", i, err);
671 err = lv1_map_device_dma_region(dinfo->bus, dinfo->dev,
672 sc->regions[i].mr_start, dinfo->dma_base[i],
673 sc->regions[i].mr_size,
674 0xf800000000000800UL /* Cell Handbook Figure 7.3.4.1 */);
677 "could not map DMA region %d: %d\n", i, err);
682 err = bus_dma_tag_create(bus_get_dma_tag(dev),
683 1, 0, BUS_SPACE_MAXADDR, BUS_SPACE_MAXADDR,
684 NULL, NULL, BUS_SPACE_MAXSIZE, 0, BUS_SPACE_MAXSIZE,
685 0, NULL, NULL, &dinfo->dma_tag);
688 * Note: storage devices have IOMMU mappings set up by the hypervisor,
689 * but use physical, non-translated addresses. The above IOMMU
690 * initialization is necessary for the hypervisor to be able to set up
691 * the mappings, but actual DMA mappings should not use the IOMMU
694 if (dinfo->bustype != PS3_BUSTYPE_STORAGE)
695 bus_dma_tag_set_iommu(dinfo->dma_tag, dev, dinfo);
698 mtx_unlock(&dinfo->iommu_mtx);
703 return (dinfo->dma_tag);
707 ps3_iommu_map(device_t dev, bus_dma_segment_t *segs, int *nsegs,
708 bus_addr_t min, bus_addr_t max, bus_size_t alignment, bus_addr_t boundary,
711 struct ps3bus_devinfo *dinfo = cookie;
712 struct ps3bus_softc *sc = device_get_softc(dev);
715 for (i = 0; i < *nsegs; i++) {
716 for (j = 0; j < sc->rcount; j++) {
717 if (segs[i].ds_addr >= sc->regions[j].mr_start &&
718 segs[i].ds_addr < sc->regions[j].mr_start +
719 sc->regions[j].mr_size)
722 KASSERT(j < sc->rcount,
723 ("Trying to map address %#lx not in physical memory",
726 segs[i].ds_addr = dinfo->dma_base[j] +
727 (segs[i].ds_addr - sc->regions[j].mr_start);
734 ps3_iommu_unmap(device_t dev, bus_dma_segment_t *segs, int nsegs, void *cookie)
740 #define Y2K 946684800
743 ps3_gettime(device_t dev, struct timespec *ts)
748 result = lv1_get_rtc(&rtc, &tb);
752 ts->tv_sec = rtc + Y2K;
758 ps3_settime(device_t dev, struct timespec *ts)