sys/arm/ti/ti_prm.c

   1 /*-
   2  * Copyright (c) 2020 Oskar Holmlund <oskar.holmlund@ohdata.se>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  18  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  20  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  21  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25 /*
  26  * Power management - simple driver to handle reset and give access to
  27  * memory space region for other drivers through prcm driver.
  28  * Documentation/devicetree/binding/arm/omap/prm-inst.txt
  29  */
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/kernel.h>
  34 #include <sys/module.h>
  35
  36 #include <dev/fdt/simplebus.h>
  37
  38 #include <dev/ofw/ofw_bus_subr.h>
  39
  40 #include <arm/ti/ti_prcm.h>
  41 #include <arm/ti/ti_prm.h>
  42
  43 #if 0
  44 #define DPRINTF(dev, msg...) device_printf(dev, msg)
  45 #else
  46 #define DPRINTF(dev, msg...)
  47 #endif
  48
  49 /* relative to prcm address range */
  50 #define TI_PRM_PER_RSTCTRL      0xC00
  51
  52 struct ti_prm_softc {
  53         device_t                dev;
  54         uint8_t                 type;
  55         bool                    has_reset;
  56 };
  57
  58 /* Device */
  59 #define TI_OMAP_PRM_INST        10
  60
  61 #define TI_AM3_PRM_INST         5
  62 #define TI_AM4_PRM_INST         4
  63 #define TI_OMAP4_PRM_INST       3
  64 #define TI_OMAP5_PRM_INST       2
  65 #define TI_DRA7_PRM_INST        1
  66 #define TI_END                  0
  67
  68 static struct ofw_compat_data compat_data[] = {
  69         { "ti,am3-prm-inst",    TI_AM3_PRM_INST },
  70         { "ti,am4-prm-inst",    TI_AM4_PRM_INST },
  71         { "ti,omap4-prm-inst",  TI_OMAP4_PRM_INST },
  72         { "ti,omap5-prm-inst",  TI_OMAP5_PRM_INST },
  73         { "ti,dra7-prm-inst",   TI_DRA7_PRM_INST },
  74         { NULL,         TI_END }
  75 };
  76
  77 static struct ofw_compat_data required_data[] = {
  78         { "ti,omap-prm-inst", TI_OMAP_PRM_INST },
  79         { NULL, TI_END }
  80 };
  81
  82 /* device interface */
  83 static int
  84 ti_prm_probe(device_t dev)
  85 {
  86         if (!ofw_bus_status_okay(dev))
  87                 return (ENXIO);
  88
  89         if (ofw_bus_search_compatible(dev, required_data)->ocd_data == 0)
  90                 return (ENXIO);
  91
  92         if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
  93                 return (ENXIO);
  94
  95         device_set_desc(dev, "TI OMAP Power Management");
  96         return(BUS_PROBE_DEFAULT);
  97 }
  98
  99 static int
 100 ti_prm_attach(device_t dev)
 101 {
 102         struct ti_prm_softc *sc;
 103         phandle_t node;
 104
 105         sc = device_get_softc(dev);
 106         sc->dev = dev;
 107         sc->type = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
 108
 109         node = ofw_bus_get_node(sc->dev);
 110
 111         if (OF_hasprop(node, "#reset-cells")) {
 112                 sc->has_reset = true;
 113         } else
 114                 sc->has_reset = false;
 115
 116         /* Make device visible for other drivers */
 117         OF_device_register_xref(OF_xref_from_node(node), sc->dev);
 118
 119         return (0);
 120 }
 121
 122 static int
 123 ti_prm_detach(device_t dev) {
 124         return (EBUSY);
 125 }
 126
 127 int
 128 ti_prm_reset(device_t dev)
 129 {
 130         struct ti_prm_softc *sc;
 131         int err;
 132
 133         sc = device_get_softc(dev);
 134         if (sc->has_reset == false)
 135                 return 1;
 136
 137         err = ti_prm_modify_4(dev, TI_PRM_PER_RSTCTRL, 0x2, 0x00);
 138         return (err);
 139 }
 140
 141 int
 142 ti_prm_write_4(device_t dev, bus_addr_t addr, uint32_t val)
 143 {
 144         device_t parent;
 145
 146         parent = device_get_parent(dev);
 147         DPRINTF(dev, "offset=%lx write %x\n", addr, val);
 148         ti_prcm_device_lock(parent);
 149         ti_prcm_write_4(parent, addr, val);
 150         ti_prcm_device_unlock(parent);
 151         return (0);
 152 }
 153
 154 int
 155 ti_prm_read_4(device_t dev, bus_addr_t addr, uint32_t *val)
 156 {
 157         device_t parent;
 158
 159         parent = device_get_parent(dev);
 160
 161         ti_prcm_device_lock(parent);
 162         ti_prcm_read_4(parent, addr, val);
 163         ti_prcm_device_unlock(parent);
 164         DPRINTF(dev, "offset=%lx Read %x\n", addr, *val);
 165         return (0);
 166 }
 167
 168 int
 169 ti_prm_modify_4(device_t dev, bus_addr_t addr, uint32_t clr, uint32_t set)
 170 {
 171         device_t parent;
 172
 173         parent = device_get_parent(dev);
 174
 175         ti_prcm_device_lock(parent);
 176         ti_prcm_modify_4(parent, addr, clr, set);
 177         ti_prcm_device_unlock(parent);
 178         DPRINTF(dev, "offset=%lx (clr %x set %x)\n", addr, clr, set);
 179
 180         return (0);
 181 }
 182
 183 static device_method_t ti_prm_methods[] = {
 184         DEVMETHOD(device_probe,         ti_prm_probe),
 185         DEVMETHOD(device_attach,        ti_prm_attach),
 186         DEVMETHOD(device_detach,        ti_prm_detach),
 187
 188         DEVMETHOD_END
 189 };
 190
 191 DEFINE_CLASS_1(ti_prm, ti_prm_driver, ti_prm_methods,
 192     sizeof(struct ti_prm_softc), simplebus_driver);
 193
 194 EARLY_DRIVER_MODULE(ti_prm, simplebus, ti_prm_driver, 0, 0,
 195     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
 196 MODULE_VERSION(ti_prm, 1);
 197 MODULE_DEPEND(ti_prm, ti_sysc, 1, 1, 1);