sys/arm64/coresight/coresight-dynamic-replicator.c

   1 /*-
   2  * Copyright (c) 2018 Ruslan Bukin <br@bsdpad.com>
   3  * All rights reserved.
   4  *
   5  * This software was developed by BAE Systems, the University of Cambridge
   6  * Computer Laboratory, and Memorial University under DARPA/AFRL contract
   7  * FA8650-15-C-7558 ("CADETS"), as part of the DARPA Transparent Computing
   8  * (TC) research program.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/bus.h>
  38 #include <sys/rman.h>
  39 #include <sys/kernel.h>
  40 #include <sys/module.h>
  41 #include <machine/bus.h>
  42
  43 #include <arm64/coresight/coresight.h>
  44
  45 #include <dev/ofw/ofw_bus.h>
  46 #include <dev/ofw/ofw_bus_subr.h>
  47
  48 #include "coresight_if.h"
  49
  50 #define REPLICATOR_IDFILTER0    0x00
  51 #define REPLICATOR_IDFILTER1    0x04
  52
  53 static struct ofw_compat_data compat_data[] = {
  54         { "arm,coresight-dynamic-replicator",   1 },
  55         { NULL,                                 0 }
  56 };
  57
  58 struct replicator_softc {
  59         struct resource                 *res;
  60         struct coresight_platform_data  *pdata;
  61 };
  62
  63 static struct resource_spec replicator_spec[] = {
  64         { SYS_RES_MEMORY,       0,      RF_ACTIVE },
  65         { -1, 0 }
  66 };
  67
  68 static int
  69 replicator_init(device_t dev)
  70 {
  71         struct replicator_softc *sc;
  72
  73         sc = device_get_softc(dev);
  74
  75         /* Unlock Coresight */
  76         bus_write_4(sc->res, CORESIGHT_LAR, CORESIGHT_UNLOCK);
  77
  78         return (0);
  79 }
  80
  81 static int
  82 replicator_enable(device_t dev, struct endpoint *endp,
  83     struct coresight_event *event)
  84 {
  85         struct replicator_softc *sc;
  86
  87         sc = device_get_softc(dev);
  88
  89         /* Enable the port. Keep the other port disabled */
  90         if (endp->reg == 0) {
  91                 bus_write_4(sc->res, REPLICATOR_IDFILTER0, 0x00);
  92                 bus_write_4(sc->res, REPLICATOR_IDFILTER1, 0xff);
  93         } else {
  94                 bus_write_4(sc->res, REPLICATOR_IDFILTER0, 0xff);
  95                 bus_write_4(sc->res, REPLICATOR_IDFILTER1, 0x00);
  96         }
  97
  98         return (0);
  99 }
 100
 101 static void
 102 replicator_disable(device_t dev, struct endpoint *endp,
 103     struct coresight_event *event)
 104 {
 105         struct replicator_softc *sc;
 106
 107         sc = device_get_softc(dev);
 108
 109         bus_write_4(sc->res, REPLICATOR_IDFILTER0, 0xff);
 110         bus_write_4(sc->res, REPLICATOR_IDFILTER1, 0xff);
 111 }
 112
 113 static int
 114 replicator_probe(device_t dev)
 115 {
 116
 117         if (!ofw_bus_status_okay(dev))
 118                 return (ENXIO);
 119
 120         if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
 121                 return (ENXIO);
 122
 123         device_set_desc(dev, "Coresight Dynamic Replicator");
 124
 125         return (BUS_PROBE_DEFAULT);
 126 }
 127
 128 static int
 129 replicator_attach(device_t dev)
 130 {
 131         struct replicator_softc *sc;
 132         struct coresight_desc desc;
 133
 134         sc = device_get_softc(dev);
 135
 136         if (bus_alloc_resources(dev, replicator_spec, &sc->res) != 0) {
 137                 device_printf(dev, "cannot allocate resources for device\n");
 138                 return (ENXIO);
 139         }
 140
 141         sc->pdata = coresight_get_platform_data(dev);
 142         desc.pdata = sc->pdata;
 143         desc.dev = dev;
 144         desc.dev_type = CORESIGHT_DYNAMIC_REPLICATOR;
 145         coresight_register(&desc);
 146
 147         return (0);
 148 }
 149
 150 static device_method_t replicator_methods[] = {
 151         /* Device interface */
 152         DEVMETHOD(device_probe,         replicator_probe),
 153         DEVMETHOD(device_attach,        replicator_attach),
 154
 155         /* Coresight interface */
 156         DEVMETHOD(coresight_init,       replicator_init),
 157         DEVMETHOD(coresight_enable,     replicator_enable),
 158         DEVMETHOD(coresight_disable,    replicator_disable),
 159         DEVMETHOD_END
 160 };
 161
 162 static driver_t replicator_driver = {
 163         "replicator",
 164         replicator_methods,
 165         sizeof(struct replicator_softc),
 166 };
 167
 168 static devclass_t replicator_devclass;
 169
 170 DRIVER_MODULE(replicator, simplebus, replicator_driver, replicator_devclass,
 171     0, 0);
 172 MODULE_VERSION(replicator, 1);