sys/dev/dcons/dcons_crom.c

   1 /*-
   2  * Copyright (C) 2003
   3  *      Hidetoshi Shimokawa. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *
  16  *      This product includes software developed by Hidetoshi Shimokawa.
  17  *
  18  * 4. Neither the name of the author nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $Id: dcons_crom.c,v 1.8 2003/10/23 15:47:21 simokawa Exp $
  35  * $FreeBSD$
  36  */
  37
  38 #include <sys/param.h>
  39 #include <sys/kernel.h>
  40 #include <sys/module.h>
  41 #include <sys/systm.h>
  42 #include <sys/types.h>
  43 #include <sys/conf.h>
  44 #include <sys/malloc.h>
  45
  46 #include <sys/bus.h>
  47 #include <machine/bus.h>
  48
  49 #ifdef __DragonFly__
  50 #include <bus/firewire/firewire.h>
  51 #include <bus/firewire/firewirereg.h>
  52 #include <bus/firewire/iec13213.h>
  53 #include "dcons.h"
  54 #include "dcons_os.h"
  55 #else
  56 #include <dev/firewire/firewire.h>
  57 #include <dev/firewire/firewirereg.h>
  58 #include <dev/firewire/iec13213.h>
  59 #include <dev/dcons/dcons.h>
  60 #include <dev/dcons/dcons_os.h>
  61 #endif
  62
  63 #include <sys/cons.h>
  64
  65 static bus_addr_t dcons_paddr;
  66
  67 #if __FreeBSD_version >= 500000
  68 static int force_console = 1;
  69 TUNABLE_INT("hw.firewire.dcons_crom.force_console", &force_console);
  70 #endif
  71
  72 #ifndef CSRVAL_VENDOR_PRIVATE
  73 #define NEED_NEW_DRIVER
  74 #endif
  75
  76 #define ADDR_HI(x)      (((x) >> 24) & 0xffffff)
  77 #define ADDR_LO(x)      ((x) & 0xffffff)
  78
  79 struct dcons_crom_softc {
  80         struct firewire_dev_comm fd;
  81         struct crom_chunk unit;
  82         struct crom_chunk spec;
  83         struct crom_chunk ver;
  84         bus_dma_tag_t dma_tag;
  85         bus_dmamap_t dma_map;
  86         bus_addr_t bus_addr;
  87 };
  88
  89 static void
  90 dcons_crom_identify(driver_t *driver, device_t parent)
  91 {
  92         BUS_ADD_CHILD(parent, 0, "dcons_crom", device_get_unit(parent));
  93 }
  94
  95 static int
  96 dcons_crom_probe(device_t dev)
  97 {
  98         device_t pa;
  99
 100         pa = device_get_parent(dev);
 101         if(device_get_unit(dev) != device_get_unit(pa)){
 102                 return(ENXIO);
 103         }
 104
 105         device_set_desc(dev, "dcons configuration ROM");
 106         return (0);
 107 }
 108
 109 #ifndef NEED_NEW_DRIVER
 110 static void
 111 dcons_crom_post_busreset(void *arg)
 112 {
 113         struct dcons_crom_softc *sc;
 114         struct crom_src *src;
 115         struct crom_chunk *root;
 116
 117         sc = (struct dcons_crom_softc *) arg;
 118         src = sc->fd.fc->crom_src;
 119         root = sc->fd.fc->crom_root;
 120
 121         bzero(&sc->unit, sizeof(struct crom_chunk));
 122
 123         crom_add_chunk(src, root, &sc->unit, CROM_UDIR);
 124         crom_add_entry(&sc->unit, CSRKEY_SPEC, CSRVAL_VENDOR_PRIVATE);
 125         crom_add_simple_text(src, &sc->unit, &sc->spec, "FreeBSD");
 126         crom_add_entry(&sc->unit, CSRKEY_VER, DCONS_CSR_VAL_VER);
 127         crom_add_simple_text(src, &sc->unit, &sc->ver, "dcons");
 128         crom_add_entry(&sc->unit, DCONS_CSR_KEY_HI, ADDR_HI(dcons_paddr));
 129         crom_add_entry(&sc->unit, DCONS_CSR_KEY_LO, ADDR_LO(dcons_paddr));
 130 }
 131 #endif
 132
 133 static void
 134 dmamap_cb(void *arg, bus_dma_segment_t *segments, int seg, int error)
 135 {
 136         struct dcons_crom_softc *sc;
 137
 138         if (error)
 139                 printf("dcons_dmamap_cb: error=%d\n", error);
 140
 141         sc = (struct dcons_crom_softc *)arg;
 142         sc->bus_addr = segments[0].ds_addr;
 143
 144         bus_dmamap_sync(sc->dma_tag, sc->dma_map, BUS_DMASYNC_PREWRITE);
 145         device_printf(sc->fd.dev,
 146 #if __FreeBSD_version < 500000
 147             "bus_addr 0x%x\n", sc->bus_addr);
 148 #else
 149             "bus_addr 0x%jx\n", (uintmax_t)sc->bus_addr);
 150 #endif
 151         if (dcons_paddr != 0) {
 152                 /* XXX */
 153                 device_printf(sc->fd.dev, "dcons_paddr is already set\n");
 154                 return;
 155         }
 156         dcons_conf->dma_tag = sc->dma_tag;
 157         dcons_conf->dma_map = sc->dma_map;
 158         dcons_paddr = sc->bus_addr;
 159
 160 #if __FreeBSD_version >= 500000
 161         /* Force to be the high-level console */
 162         if (force_console)
 163                 cnselect(dcons_conf->cdev);
 164 #endif
 165 }
 166
 167 static int
 168 dcons_crom_attach(device_t dev)
 169 {
 170 #ifdef NEED_NEW_DRIVER
 171         printf("dcons_crom: you need newer firewire driver\n");
 172         return (-1);
 173 #else
 174         struct dcons_crom_softc *sc;
 175
 176         sc = (struct dcons_crom_softc *) device_get_softc(dev);
 177         sc->fd.fc = device_get_ivars(dev);
 178         sc->fd.dev = dev;
 179         sc->fd.post_explore = NULL;
 180         sc->fd.post_busreset = (void *) dcons_crom_post_busreset;
 181
 182         /* map dcons buffer */
 183         bus_dma_tag_create(
 184                 /*parent*/ sc->fd.fc->dmat,
 185                 /*alignment*/ sizeof(u_int32_t),
 186                 /*boundary*/ 0,
 187                 /*lowaddr*/ BUS_SPACE_MAXADDR,
 188                 /*highaddr*/ BUS_SPACE_MAXADDR,
 189                 /*filter*/NULL, /*filterarg*/NULL,
 190                 /*maxsize*/ dcons_conf->size,
 191                 /*nsegments*/ 1,
 192                 /*maxsegsz*/ BUS_SPACE_MAXSIZE_32BIT,
 193                 /*flags*/ BUS_DMA_ALLOCNOW,
 194 #if __FreeBSD_version >= 501102
 195                 /*lockfunc*/busdma_lock_mutex,
 196                 /*lockarg*/&Giant,
 197 #endif
 198                 &sc->dma_tag);
 199         bus_dmamap_create(sc->dma_tag, 0, &sc->dma_map);
 200         bus_dmamap_load(sc->dma_tag, sc->dma_map,
 201             (void *)dcons_conf->buf, dcons_conf->size,
 202             dmamap_cb, sc, 0);
 203         return (0);
 204 #endif
 205 }
 206
 207 static int
 208 dcons_crom_detach(device_t dev)
 209 {
 210         struct dcons_crom_softc *sc;
 211
 212         sc = (struct dcons_crom_softc *) device_get_softc(dev);
 213         sc->fd.post_busreset = NULL;
 214
 215         /* XXX */
 216         if (dcons_conf->dma_tag == sc->dma_tag)
 217                 dcons_conf->dma_tag = NULL;
 218
 219         bus_dmamap_unload(sc->dma_tag, sc->dma_map);
 220         bus_dmamap_destroy(sc->dma_tag, sc->dma_map);
 221         bus_dma_tag_destroy(sc->dma_tag);
 222
 223         return 0;
 224 }
 225
 226 static devclass_t dcons_crom_devclass;
 227
 228 static device_method_t dcons_crom_methods[] = {
 229         /* device interface */
 230         DEVMETHOD(device_identify,      dcons_crom_identify),
 231         DEVMETHOD(device_probe,         dcons_crom_probe),
 232         DEVMETHOD(device_attach,        dcons_crom_attach),
 233         DEVMETHOD(device_detach,        dcons_crom_detach),
 234         { 0, 0 }
 235 };
 236
 237 static driver_t dcons_crom_driver = {
 238         "dcons_crom",
 239         dcons_crom_methods,
 240         sizeof(struct dcons_crom_softc),
 241 };
 242
 243 DRIVER_MODULE(dcons_crom, firewire, dcons_crom_driver,
 244                                         dcons_crom_devclass, 0, 0);
 245 MODULE_VERSION(dcons_crom, 1);
 246 MODULE_DEPEND(dcons_crom, dcons,
 247         DCONS_VERSION, DCONS_VERSION, DCONS_VERSION);
 248 MODULE_DEPEND(dcons_crom, firewire, 1, 1, 1);