/*      $NetBSD: ohci_plb.c,v 1.2 2026/06/19 18:55:23 rkujawa Exp $     */

/*
 * Copyright (c) 2026 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Radoslaw Kujawa.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * OHCI companion of on-chip EHCI
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ohci_plb.c,v 1.2 2026/06/19 18:55:23 rkujawa Exp $");

#include "opt_ppc4xx.h"

#include <sys/param.h>
#include <sys/bus.h>
#include <sys/device.h>
#include <sys/extent.h>

#include <powerpc/ibm4xx/cpu.h>
#include <powerpc/ibm4xx/dev/plbvar.h>
#ifdef PPC4XX_L2CACHE
#include <powerpc/ibm4xx/ibm4xx_460ex_l2.h>
#endif

#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdivar.h>
#include <dev/usb/usb_mem.h>
#include <dev/usb/ohcireg.h>
#include <dev/usb/ohcivar.h>

#define OHCI_PLB_SIZE   0x400   /* EHCI follows at +0x400 */

#include "locators.h"

static int      ohci_plb_match(device_t, cfdata_t, void *);
static void     ohci_plb_attach(device_t, device_t, void *);

CFATTACH_DECL_NEW(ohci_plb, sizeof(struct ohci_softc),
    ohci_plb_match, ohci_plb_attach, NULL, NULL);

static struct powerpc_bus_space ohci_plb_tag = {
        _BUS_SPACE_LITTLE_ENDIAN | _BUS_SPACE_MEM_TYPE,
        0x00000000,
};
static char ohci_ex_storage[EXTENT_FIXED_STORAGE_SIZE(8)]
    __attribute__((aligned(8)));

static int
ohci_plb_match(device_t parent, cfdata_t match, void *aux)
{
        struct plb_attach_args *paa = aux;

        if (strcmp(paa->plb_name, match->cf_name) != 0)
                return 0;

        if (match->cf_loc[PLBCF_ADDR] == PLBCF_ADDR_DEFAULT)
                panic("ohci_plb_match: wildcard addr not allowed");
        if (match->cf_loc[PLBCF_IRQ] == PLBCF_IRQ_DEFAULT)
                panic("ohci_plb_match: wildcard IRQ not allowed");

        paa->plb_addr = match->cf_loc[PLBCF_ADDR];
        paa->plb_irq = match->cf_loc[PLBCF_IRQ];
        return 1;
}

static void
ohci_plb_attach(device_t parent, device_t self, void *aux)
{
        struct ohci_softc *sc = device_private(self);
        struct plb_attach_args *paa = aux;
        int error;

        sc->sc_dev = self;
        sc->sc_bus.ub_hcpriv = sc;
#ifdef PPC4XX_L2CACHE
        /* USB DMA needs software L2 invalidation (hardware snoop misses it). */
        sc->sc_bus.ub_dmatag = ibm4xx_460ex_l2_dmatag();
#else
        sc->sc_bus.ub_dmatag = paa->plb_dmat;
#endif
        sc->sc_bus.ub_revision = USBREV_1_0;

        ohci_plb_tag.pbs_base = paa->plb_addr;
        ohci_plb_tag.pbs_limit = paa->plb_addr + OHCI_PLB_SIZE;
        sc->iot = &ohci_plb_tag;

        if (bus_space_init(&ohci_plb_tag, "ohciplb", ohci_ex_storage,
              sizeof(ohci_ex_storage)) ||
            bus_space_map(sc->iot, paa->plb_addr, OHCI_PLB_SIZE, 0,
              &sc->ioh)) {
                aprint_error(": can't map registers\n");
                return;
        }
        sc->sc_size = OHCI_PLB_SIZE;

        aprint_normal(": OHCI USB controller\n");

        bus_space_write_4(sc->iot, sc->ioh, OHCI_INTERRUPT_DISABLE,
            OHCI_ALL_INTRS);

        intr_establish_xname(paa->plb_irq, IST_LEVEL, IPL_USB, ohci_intr,
            sc, device_xname(self));

        error = ohci_init(sc);
        if (error) {
                aprint_error_dev(self, "init failed, error=%d\n", error);
                return;
        }

        sc->sc_child = config_found(self, &sc->sc_bus, usbctlprint,
            CFARGS_NONE);
}