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