FreeBSD/Linux Kernel Cross Reference
sys/arm/ti/ti_prcm.c

     /*-
      * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
      *
      * Copyright (c) 2012 Damjan Marion <dmarion@Freebsd.org>
      * All rights reserved.
      *
      * Copyright (c) 2020 Oskar Holmlund <oskar.holmlund@ohdata.se>
      *
      * 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.
     *
     * $FreeBSD$
     */
    
    /* Based on sys/arm/ti/am335x/am335x_prcm.c */
    
    #include <sys/cdefs.h>
    __FBSDID("$FreeBSD$");
    
    #include <sys/param.h>
    #include <sys/systm.h>
    #include <sys/bus.h>
    #include <sys/kernel.h>
    #include <sys/module.h>
    #include <sys/malloc.h>
    #include <sys/rman.h>
    #include <sys/timeet.h>
    #include <sys/timetc.h>
    #include <sys/watchdog.h>
    #include <machine/bus.h>
    #include <machine/cpu.h>
    #include <machine/intr.h>
    
    #include <arm/ti/ti_cpuid.h>
    #include <arm/ti/ti_prcm.h>
    #include <arm/ti/tivar.h>
    
    #include <dev/fdt/simplebus.h>
    
    #include <dev/ofw/openfirm.h>
    #include <dev/ofw/ofw_bus.h>
    #include <dev/ofw/ofw_bus_subr.h>
    
    #include "clkdev_if.h"
    
    #if 0
    #define DPRINTF(dev, msg...) device_printf(dev, msg)
    #else
    #define DPRINTF(dev, msg...)
    #endif
    
    struct ti_prcm_softc {
            struct simplebus_softc  sc_simplebus;
            device_t                dev;
            struct resource *       mem_res;
            bus_space_tag_t         bst;
            bus_space_handle_t      bsh;
            int                     attach_done;
            struct mtx              mtx;
    };
    
    static struct ti_prcm_softc *ti_prcm_sc = NULL;
    static void omap4_prcm_reset(void);
    static void am335x_prcm_reset(void);
    
    #define TI_AM3_PRCM             18
    #define TI_AM4_PRCM             17
    #define TI_OMAP2_PRCM           16
    #define TI_OMAP3_PRM            15
    #define TI_OMAP3_CM             14
    #define TI_OMAP4_CM1            13
    #define TI_OMAP4_PRM            12
    #define TI_OMAP4_CM2            11
    #define TI_OMAP4_SCRM           10
    #define TI_OMAP5_PRM            9
    #define TI_OMAP5_CM_CORE_AON    8
    #define TI_OMAP5_SCRM           7
    #define TI_OMAP5_CM_CORE        6
    #define TI_DRA7_PRM             5
    #define TI_DRA7_CM_CORE_AON     4
    #define TI_DRA7_CM_CORE         3
   #define TI_DM814_PRCM           2
   #define TI_DM816_PRCM           1
   #define TI_PRCM_END             0
   
   static struct ofw_compat_data compat_data[] = {
           { "ti,am3-prcm",                TI_AM3_PRCM },
           { "ti,am4-prcm",                TI_AM4_PRCM },
           { "ti,omap2-prcm",              TI_OMAP2_PRCM },
           { "ti,omap3-prm",               TI_OMAP3_PRM },
           { "ti,omap3-cm",                TI_OMAP3_CM },
           { "ti,omap4-cm1",               TI_OMAP4_CM1 },
           { "ti,omap4-prm",               TI_OMAP4_PRM },
           { "ti,omap4-cm2",               TI_OMAP4_CM2 },
           { "ti,omap4-scrm",              TI_OMAP4_SCRM },
           { "ti,omap5-prm",               TI_OMAP5_PRM },
           { "ti,omap5-cm-core-aon",       TI_OMAP5_CM_CORE_AON },
           { "ti,omap5-scrm",              TI_OMAP5_SCRM },
           { "ti,omap5-cm-core",           TI_OMAP5_CM_CORE },
           { "ti,dra7-prm",                TI_DRA7_PRM },
           { "ti,dra7-cm-core-aon",        TI_DRA7_CM_CORE_AON },
           { "ti,dra7-cm-core",            TI_DRA7_CM_CORE },
           { "ti,dm814-prcm",              TI_DM814_PRCM },
           { "ti,dm816-prcm",              TI_DM816_PRCM },
           { NULL,                         TI_PRCM_END}
   };
   
   static int
   ti_prcm_probe(device_t dev)
   {
           if (!ofw_bus_status_okay(dev))
                   return (ENXIO);
   
           if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0) {
                   return (ENXIO);
           }
   
           device_set_desc(dev, "TI Power and Clock Management");
           return(BUS_PROBE_DEFAULT);
   }
   
   static int
   ti_prcm_attach(device_t dev)
   {
           struct ti_prcm_softc *sc;
           phandle_t node, child;
           int rid;
   
           sc = device_get_softc(dev);
           sc->dev = dev;
   
           node = ofw_bus_get_node(sc->dev);
           simplebus_init(sc->dev, node);
   
           if (simplebus_fill_ranges(node, &sc->sc_simplebus) < 0) {
                   device_printf(sc->dev, "could not get ranges\n");
                   return (ENXIO);
           }
           if (sc->sc_simplebus.nranges == 0) {
                   device_printf(sc->dev, "nranges == 0\n");
                   return (ENXIO);
           }
   
           sc->mem_res = bus_alloc_resource(sc->dev, SYS_RES_MEMORY, &rid,
                   sc->sc_simplebus.ranges[0].host,
                   (sc->sc_simplebus.ranges[0].host +
                           sc->sc_simplebus.ranges[0].size - 1),
                   sc->sc_simplebus.ranges[0].size,
                   RF_ACTIVE | RF_SHAREABLE);
   
           if (sc->mem_res == NULL) {
                   return (ENXIO);
           }
   
           sc->bst = rman_get_bustag(sc->mem_res);
           sc->bsh = rman_get_bushandle(sc->mem_res);
   
           mtx_init(&sc->mtx, device_get_nameunit(dev), NULL, MTX_DEF);
   
           /* Fixme: for xxx_prcm_reset functions.
            * Get rid of global variables?
            */
           ti_prcm_sc = sc;
   
           switch(ti_chip()) {
   #ifdef SOC_OMAP4
           case CHIP_OMAP_4:
                   ti_cpu_reset = omap4_prcm_reset;
                   break;
   #endif
   #ifdef SOC_TI_AM335X
           case CHIP_AM335X:
                   ti_cpu_reset = am335x_prcm_reset;
                   break;
   #endif
           }
   
           bus_generic_probe(sc->dev);
           for (child = OF_child(node); child != 0; child = OF_peer(child)) {
                   simplebus_add_device(dev, child, 0, NULL, -1, NULL);
           }
   
           return (bus_generic_attach(sc->dev));
   }
   
   int
   ti_prcm_write_4(device_t dev, bus_addr_t addr, uint32_t val)
   {
           struct ti_prcm_softc *sc;
   
           sc = device_get_softc(dev);
           DPRINTF(sc->dev, "offset=%lx write %x\n", addr, val);
           bus_space_write_4(sc->bst, sc->bsh, addr, val);
           return (0);
   }
   int
   ti_prcm_read_4(device_t dev, bus_addr_t addr, uint32_t *val)
   {
           struct ti_prcm_softc *sc;
   
           sc = device_get_softc(dev);
   
           *val = bus_space_read_4(sc->bst, sc->bsh, addr);
           DPRINTF(sc->dev, "offset=%lx Read %x\n", addr, *val);
           return (0);
   }
   
   int
   ti_prcm_modify_4(device_t dev, bus_addr_t addr, uint32_t clr, uint32_t set)
   {
           struct ti_prcm_softc *sc;
           uint32_t reg;
   
           sc = device_get_softc(dev);
   
           reg = bus_space_read_4(sc->bst, sc->bsh, addr);
           reg &= ~clr;
           reg |= set;
           bus_space_write_4(sc->bst, sc->bsh, addr, reg);
           DPRINTF(sc->dev, "offset=%lx reg: %x (clr %x set %x)\n", addr, reg, clr, set);
   
           return (0);
   }
   
   void
   ti_prcm_device_lock(device_t dev)
   {
           struct ti_prcm_softc *sc;
   
           sc = device_get_softc(dev);
           mtx_lock(&sc->mtx);
   }
   
   void
   ti_prcm_device_unlock(device_t dev)
   {
           struct ti_prcm_softc *sc;
   
           sc = device_get_softc(dev);
           mtx_unlock(&sc->mtx);
   }
   
   static device_method_t ti_prcm_methods[] = {
           DEVMETHOD(device_probe,         ti_prcm_probe),
           DEVMETHOD(device_attach,        ti_prcm_attach),
   
           /* clkdev interface */
           DEVMETHOD(clkdev_write_4,       ti_prcm_write_4),
           DEVMETHOD(clkdev_read_4,        ti_prcm_read_4),
           DEVMETHOD(clkdev_modify_4,      ti_prcm_modify_4),
           DEVMETHOD(clkdev_device_lock,   ti_prcm_device_lock),
           DEVMETHOD(clkdev_device_unlock, ti_prcm_device_unlock),
   
           DEVMETHOD_END
   };
   
   DEFINE_CLASS_1(ti_prcm, ti_prcm_driver, ti_prcm_methods,
       sizeof(struct ti_prcm_softc), simplebus_driver);
   
   static devclass_t ti_prcm_devclass;
   
   EARLY_DRIVER_MODULE(ti_prcm, ofwbus, ti_prcm_driver,
           ti_prcm_devclass, 0, 0, BUS_PASS_BUS);
   EARLY_DRIVER_MODULE(ti_prcm, simplebus, ti_prcm_driver,
           ti_prcm_devclass, 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
   MODULE_VERSION(ti_prcm, 1);
   MODULE_DEPEND(ti_prcm, ti_scm, 1, 1, 1);
   
   /* From sys/arm/ti/am335x/am335x_prcm.c
    * Copyright (c) 2012 Damjan Marion <dmarion@Freebsd.org>
    */
   #define PRM_DEVICE_OFFSET               0xF00
   #define AM335x_PRM_RSTCTRL              (PRM_DEVICE_OFFSET + 0x00)
   
   static void
   am335x_prcm_reset(void)
   {
           ti_prcm_write_4(ti_prcm_sc->dev, AM335x_PRM_RSTCTRL, (1<<1));
   }
   
   /* FIXME: Is this correct - or should the license part be ontop? */
   
   /* From sys/arm/ti/omap4/omap4_prcm_clks.c */
   /*-
    * SPDX-License-Identifier: BSD-3-Clause
    *
    * Copyright (c) 2011
    *      Ben Gray <ben.r.gray@gmail.com>.
    * All rights reserved.
    *
    * 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.
    * 3. The name of the company nor the name of the author may be used to
    *    endorse or promote products derived from this software without specific
    *    prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY BEN GRAY ``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 BEN GRAY 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.
    */
   #define PRM_RSTCTRL             0x1b00
   #define PRM_RSTCTRL_RESET       0x2
   
   static void
   omap4_prcm_reset(void)
   {
           uint32_t reg;
   
           ti_prcm_read_4(ti_prcm_sc->dev, PRM_RSTCTRL, &reg);
           reg = reg | PRM_RSTCTRL_RESET;
           ti_prcm_write_4(ti_prcm_sc->dev, PRM_RSTCTRL, reg);
           ti_prcm_read_4(ti_prcm_sc->dev, PRM_RSTCTRL, &reg);
   }

Cache object: dee651ffb888f8854c144ea08db8c1cf