/* $OpenBSD: com_fdt.c,v 1.10 2026/04/06 10:27:53 kettenis Exp $ */
/*
 * Copyright (c) 2016 Patrick Wildt <patrick@blueri.se>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/tty.h>

#include <machine/intr.h>
#include <machine/bus.h>
#include <machine/fdt.h>

#include <dev/ic/comreg.h>
#include <dev/ic/comvar.h>
#include <dev/cons.h>

#include <dev/ofw/fdt.h>
#include <dev/ofw/openfirm.h>
#include <dev/ofw/ofw_clock.h>
#include <dev/ofw/ofw_pinctrl.h>

int     com_fdt_match(struct device *, void *, void *);
void    com_fdt_attach(struct device *, struct device *, void *);
int     com_fdt_intr_designware(void *);

const struct cfattach com_fdt_ca = {
        sizeof (struct com_softc), com_fdt_match, com_fdt_attach
};

struct consdev com_fdt_cons = {
        NULL, NULL, comcngetc, comcnputc, comcnpollc, NULL,
        NODEV, CN_LOWPRI
};

void
com_fdt_init_cons(void)
{
        struct fdt_reg reg;
        uint32_t width, shift;
        void *node;

        if ((node = fdt_find_cons("brcm,bcm2835-aux-uart")) == NULL &&
            (node = fdt_find_cons("intel,xscale-uart")) == NULL &&
            (node = fdt_find_cons("marvell,armada-38x-uart")) == NULL &&
            (node = fdt_find_cons("mediatek,mt6577-uart")) == NULL &&
            (node = fdt_find_cons("ns16550a")) == NULL &&
            (node = fdt_find_cons("snps,dw-apb-uart")) == NULL &&
            (node = fdt_find_cons("ti,omap3-uart")) == NULL &&
            (node = fdt_find_cons("ti,omap4-uart")) == NULL)
                        return;
        if (fdt_get_reg(node, 0, &reg))
                return;

        /*
         * Figuring out the clock frequency is rather complicated as
         * on many SoCs this requires traversing a fair amount of the
         * clock tree.  Instead we rely on the firmware to set up the
         * console for us and bypass the cominit() call that
         * comcnattach() does by doing the minimal setup here.
         */

        if (OF_is_compatible(stdout_node, "ns16550a")) {
                width = 1;
                shift = 0;
        } else {
                width = 4;
                shift = 2;
        }

        comcons_reg_width = OF_getpropint(stdout_node, "reg-io-width", width);
        comcons_reg_shift = OF_getpropint(stdout_node, "reg-shift", shift);

        comconsiot = fdt_cons_bs_tag;
        if (bus_space_map(comconsiot, reg.addr, reg.size, 0, &comconsioh))
                return;

        cn_tab = &com_fdt_cons;
}

int
com_fdt_match(struct device *parent, void *match, void *aux)
{
        struct fdt_attach_args *faa = aux;

        return (OF_is_compatible(faa->fa_node, "brcm,bcm2835-aux-uart") ||
            OF_is_compatible(faa->fa_node, "intel,xscale-uart") ||
            OF_is_compatible(faa->fa_node, "marvell,armada-38x-uart") ||
            OF_is_compatible(faa->fa_node, "mediatek,mt6577-uart") ||
            OF_is_compatible(faa->fa_node, "ns16550a") ||
            OF_is_compatible(faa->fa_node, "snps,dw-apb-uart") ||
            OF_is_compatible(faa->fa_node, "ti,omap3-uart") ||
            OF_is_compatible(faa->fa_node, "ti,omap4-uart"));
}

void
com_fdt_attach(struct device *parent, struct device *self, void *aux)
{
        struct com_softc *sc = (struct com_softc *)self;
        struct fdt_attach_args *faa = aux;
        int (*intr)(void *) = comintr;
        uint32_t freq, width, shift;

        if (faa->fa_nreg < 1)
                return;

        clock_enable(faa->fa_node, NULL);
        reset_deassert_all(faa->fa_node);

        /*
         * Determine the clock frequency after enabling the clock.
         * This gives the clock code a chance to configure the
         * appropriate frequency for us.
         */
        freq = OF_getpropint(faa->fa_node, "clock-frequency", 0);
        if (freq == 0)
                freq = clock_get_frequency(faa->fa_node, NULL);

        sc->sc_iot = faa->fa_iot;
        sc->sc_iobase = faa->fa_reg[0].addr;
        sc->sc_uarttype = COM_UART_16550;
        sc->sc_frequency = freq ? freq : COM_FREQ;

        if (OF_is_compatible(faa->fa_node, "ns16550a")) {
                width = 1;
                shift = 0;
        } else {
                width = 4;
                shift = 2;
        }

        sc->sc_reg_width = OF_getpropint(faa->fa_node, "reg-io-width", width);
        sc->sc_reg_shift = OF_getpropint(faa->fa_node, "reg-shift", shift);

        if (OF_is_compatible(faa->fa_node, "intel,xscale-uart"))
                sc->sc_uarttype = COM_UART_PXA2X0;

        if (OF_is_compatible(faa->fa_node, "mediatek,mt6577-uart"))
                sc->sc_uarttype = COM_UART_16550A;

        if (OF_is_compatible(faa->fa_node, "snps,dw-apb-uart") ||
            OF_is_compatible(faa->fa_node, "marvell,armada-38x-uart")) {
                sc->sc_uarttype = COM_UART_DW_APB;
                intr = com_fdt_intr_designware;
        }

        if (OF_is_compatible(faa->fa_node, "ti,omap3-uart") ||
            OF_is_compatible(faa->fa_node, "ti,omap4-uart"))
                sc->sc_uarttype = COM_UART_TI16750;

        if (stdout_node == faa->fa_node) {
                SET(sc->sc_hwflags, COM_HW_CONSOLE);
                SET(sc->sc_swflags, COM_SW_SOFTCAR);
                comconsfreq = sc->sc_frequency;
                comconsrate = stdout_speed ? stdout_speed : B115200;
        }

        if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr,
            faa->fa_reg[0].size, 0, &sc->sc_ioh)) {
                printf("%s: bus_space_map failed\n", __func__);
                return;
        }

        pinctrl_byname(faa->fa_node, "default");

        com_attach_subr(sc);

        fdt_intr_establish(faa->fa_node, IPL_TTY, intr,
            sc, sc->sc_dev.dv_xname);
}

int
com_fdt_intr_designware(void *cookie)
{
        struct com_softc *sc = cookie;

        com_read_reg(sc, com_usr);

        return comintr(sc);
}