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