47ec373f3532012420426c98edcd3f72212e3560
[dragonfly.git] / sys / dev / misc / 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: src/sys/dev/dcons/dcons_crom.c,v 1.5 2004/10/13 05:38:42 simokawa Exp $
36  * $DragonFly: src/sys/dev/misc/dcons/dcons_crom.c,v 1.5 2006/12/22 23:26:17 swildner Exp $
37  */
38
39 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
42 #include <sys/systm.h>
43 #include <sys/types.h>
44 #include <sys/conf.h>
45 #include <sys/malloc.h>
46 #include <sys/bus.h>
47
48 #ifdef __DragonFly__
49 #include <bus/firewire/firewire.h>
50 #include <bus/firewire/firewirereg.h>
51 #include <bus/firewire/iec13213.h>
52 #include "dcons.h"
53 #include "dcons_os.h"
54 #else
55 #include <dev/firewire/firewire.h>
56 #include <dev/firewire/firewirereg.h>
57 #include <dev/firewire/iec13213.h>
58 #include <dev/dcons/dcons.h>
59 #include <dev/dcons/dcons_os.h>
60 #endif
61
62 #include <sys/cons.h>
63
64 static bus_addr_t dcons_paddr;
65
66 #if __FreeBSD_version >= 500000
67 static int force_console = 1;
68 TUNABLE_INT("hw.firewire.dcons_crom.force_console", &force_console);
69 #endif
70
71 #ifndef CSRVAL_VENDOR_PRIVATE
72 #define NEED_NEW_DRIVER
73 #endif
74
75 #define ADDR_HI(x)      (((x) >> 24) & 0xffffff)
76 #define ADDR_LO(x)      ((x) & 0xffffff)
77
78 struct dcons_crom_softc {
79         struct firewire_dev_comm fd;
80         struct crom_chunk unit;
81         struct crom_chunk spec;
82         struct crom_chunk ver;
83         bus_dma_tag_t dma_tag;
84         bus_dmamap_t dma_map;
85         bus_addr_t bus_addr;
86 };
87
88 static int
89 dcons_crom_probe(device_t dev)
90 {
91         device_t pa;
92
93         pa = device_get_parent(dev);
94         if(device_get_unit(dev) != device_get_unit(pa)){
95                 return(ENXIO);
96         }
97
98         device_set_desc(dev, "dcons configuration ROM");
99         return (0);
100 }
101
102 #ifndef NEED_NEW_DRIVER
103 static void
104 dcons_crom_post_busreset(void *arg)
105 {
106         struct dcons_crom_softc *sc;
107         struct crom_src *src;
108         struct crom_chunk *root;
109
110         sc = (struct dcons_crom_softc *) arg;
111         src = sc->fd.fc->crom_src;
112         root = sc->fd.fc->crom_root;
113
114         bzero(&sc->unit, sizeof(struct crom_chunk));
115
116         crom_add_chunk(src, root, &sc->unit, CROM_UDIR);
117         crom_add_entry(&sc->unit, CSRKEY_SPEC, CSRVAL_VENDOR_PRIVATE);
118         crom_add_simple_text(src, &sc->unit, &sc->spec, "FreeBSD");
119         crom_add_entry(&sc->unit, CSRKEY_VER, DCONS_CSR_VAL_VER);
120         crom_add_simple_text(src, &sc->unit, &sc->ver, "dcons");
121         crom_add_entry(&sc->unit, DCONS_CSR_KEY_HI, ADDR_HI(dcons_paddr));
122         crom_add_entry(&sc->unit, DCONS_CSR_KEY_LO, ADDR_LO(dcons_paddr));
123 }
124 #endif
125
126 static void
127 dmamap_cb(void *arg, bus_dma_segment_t *segments, int seg, int error)
128 {
129         struct dcons_crom_softc *sc;
130
131         if (error)
132                 kprintf("dcons_dmamap_cb: error=%d\n", error);
133
134         sc = (struct dcons_crom_softc *)arg;
135         sc->bus_addr = segments[0].ds_addr;
136
137         bus_dmamap_sync(sc->dma_tag, sc->dma_map, BUS_DMASYNC_PREWRITE);
138         device_printf(sc->fd.dev,
139 #if __FreeBSD_version < 500000
140             "bus_addr 0x%x\n", sc->bus_addr);
141 #else
142             "bus_addr 0x%jx\n", (uintmax_t)sc->bus_addr);
143 #endif
144         if (dcons_paddr != 0) {
145                 /* XXX */
146                 device_printf(sc->fd.dev, "dcons_paddr is already set\n");
147                 return;
148         }
149         dcons_conf->dma_tag = sc->dma_tag;
150         dcons_conf->dma_map = sc->dma_map;
151         dcons_paddr = sc->bus_addr;
152
153 #if __FreeBSD_version >= 500000
154         /* Force to be the high-level console */
155         if (force_console)
156                 cnselect(dcons_conf->cdev);
157 #endif
158 }
159
160 static int
161 dcons_crom_attach(device_t dev)
162 {
163 #ifdef NEED_NEW_DRIVER
164         kprintf("dcons_crom: you need newer firewire driver\n");
165         return (-1);
166 #else
167         struct dcons_crom_softc *sc;
168
169         sc = (struct dcons_crom_softc *) device_get_softc(dev);
170         sc->fd.fc = device_get_ivars(dev);
171         sc->fd.dev = dev;
172         sc->fd.post_explore = NULL;
173         sc->fd.post_busreset = (void *) dcons_crom_post_busreset;
174
175         /* map dcons buffer */
176         bus_dma_tag_create(
177                 /*parent*/ sc->fd.fc->dmat,
178                 /*alignment*/ sizeof(u_int32_t),
179                 /*boundary*/ 0,
180                 /*lowaddr*/ BUS_SPACE_MAXADDR,
181                 /*highaddr*/ BUS_SPACE_MAXADDR,
182                 /*filter*/NULL, /*filterarg*/NULL,
183                 /*maxsize*/ dcons_conf->size,
184                 /*nsegments*/ 1,
185                 /*maxsegsz*/ BUS_SPACE_MAXSIZE_32BIT,
186                 /*flags*/ BUS_DMA_ALLOCNOW,
187 #if __FreeBSD_version >= 501102
188                 /*lockfunc*/busdma_lock_mutex,
189                 /*lockarg*/&Giant,
190 #endif
191                 &sc->dma_tag);
192         bus_dmamap_create(sc->dma_tag, 0, &sc->dma_map);
193         bus_dmamap_load(sc->dma_tag, sc->dma_map,
194             (void *)dcons_conf->buf, dcons_conf->size,
195             dmamap_cb, sc, 0);
196         return (0);
197 #endif
198 }
199
200 static int
201 dcons_crom_detach(device_t dev)
202 {
203         struct dcons_crom_softc *sc;
204
205         sc = (struct dcons_crom_softc *) device_get_softc(dev);
206         sc->fd.post_busreset = NULL;
207
208         /* XXX */
209         if (dcons_conf->dma_tag == sc->dma_tag)
210                 dcons_conf->dma_tag = NULL;
211
212         bus_dmamap_unload(sc->dma_tag, sc->dma_map);
213         bus_dmamap_destroy(sc->dma_tag, sc->dma_map);
214         bus_dma_tag_destroy(sc->dma_tag);
215
216         return 0;
217 }
218
219 /*
220  * Because dcons_crom is a static device that always exists under any attached
221  * firewire device, and not scanned by the firewire device, we need an 
222  * identify function to install the device.  For our sanity we want
223  * the sbp device to have the same unit number as the fireweire device.
224  */
225 static devclass_t dcons_crom_devclass;
226
227 static device_method_t dcons_crom_methods[] = {
228         /* device interface */
229         DEVMETHOD(device_identify,      bus_generic_identify_sameunit),
230         DEVMETHOD(device_probe,         dcons_crom_probe),
231         DEVMETHOD(device_attach,        dcons_crom_attach),
232         DEVMETHOD(device_detach,        dcons_crom_detach),
233         { 0, 0 }
234 };
235
236 static driver_t dcons_crom_driver = {
237         "dcons_crom",
238         dcons_crom_methods,
239         sizeof(struct dcons_crom_softc),
240 };
241
242 DRIVER_MODULE(dcons_crom, firewire, dcons_crom_driver,
243                                         dcons_crom_devclass, 0, 0);
244 MODULE_VERSION(dcons_crom, 1);
245 MODULE_DEPEND(dcons_crom, dcons,
246         DCONS_VERSION, DCONS_VERSION, DCONS_VERSION);
247 MODULE_DEPEND(dcons_crom, firewire, 1, 1, 1);