xref: /netbsd-src/sys/dev/ic/ibm561.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /* $NetBSD: ibm561.c,v 1.13 2020/06/24 20:17:55 jdolecek Exp $ */
2 
3 /*-
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Roland C. Dowdeswell of Ponte, Inc.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: ibm561.c,v 1.13 2020/06/24 20:17:55 jdolecek Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/device.h>
38 #include <sys/buf.h>
39 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 
42 #include <dev/pci/pcivar.h>
43 #include <dev/ic/ibm561reg.h>
44 #include <dev/ic/ibm561var.h>
45 #include <dev/ic/ramdac.h>
46 
47 #include <dev/wscons/wsconsio.h>
48 
49 /*
50  * Functions exported via the RAMDAC configuration table.
51  */
52 void	ibm561_init(struct ramdac_cookie *);
53 int	ibm561_set_cmap(struct ramdac_cookie *, struct wsdisplay_cmap *);
54 int	ibm561_get_cmap(struct ramdac_cookie *, struct wsdisplay_cmap *);
55 int	ibm561_set_cursor(struct ramdac_cookie *, struct wsdisplay_cursor *);
56 int	ibm561_get_cursor(struct ramdac_cookie *, struct wsdisplay_cursor *);
57 int	ibm561_set_curpos(struct ramdac_cookie *, struct wsdisplay_curpos *);
58 int	ibm561_get_curpos(struct ramdac_cookie *, struct wsdisplay_curpos *);
59 int	ibm561_get_curmax(struct ramdac_cookie *, struct wsdisplay_curpos *);
60 int	ibm561_set_dotclock(struct ramdac_cookie *, unsigned);
61 
62 /* XXX const */
63 struct ramdac_funcs ibm561_funcsstruct = {
64 	"IBM561",
65 	ibm561_register,
66 	ibm561_init,
67 	ibm561_set_cmap,
68 	ibm561_get_cmap,
69 	ibm561_set_cursor,
70 	ibm561_get_cursor,
71 	ibm561_set_curpos,
72 	ibm561_get_curpos,
73 	ibm561_get_curmax,
74 	NULL,			/* check_curcmap; not needed */
75 	NULL,			/* set_curcmap; not needed */
76 	NULL,			/* get_curcmap; not needed */
77 	ibm561_set_dotclock,
78 };
79 
80 /*
81  * Private data.
82  */
83 struct ibm561data {
84 	void            *cookie;
85 
86 	int             (*ramdac_sched_update)(void *, void (*)(void *));
87 	void            (*ramdac_wr)(void *, u_int, u_int8_t);
88 	u_int8_t        (*ramdac_rd)(void *, u_int);
89 
90 #define CHANGED_CURCMAP		0x0001	/* cursor cmap */
91 #define CHANGED_CMAP		0x0002	/* color map */
92 #define CHANGED_WTYPE		0x0004	/* window types */
93 #define CHANGED_DOTCLOCK	0x0008	/* dot clock */
94 #define CHANGED_ALL		0x000f	/* or of all above */
95 	u_int8_t	changed;
96 
97 	/* dotclock parameters */
98 	u_int8_t	vco_div;
99 	u_int8_t	pll_ref;
100 	u_int8_t	div_dotclock;
101 
102 	/* colormaps et al. */
103 	u_int8_t	curcmap_r[2];
104 	u_int8_t	curcmap_g[2];
105 	u_int8_t	curcmap_b[2];
106 
107 	u_int8_t	cmap_r[IBM561_NCMAP_ENTRIES];
108 	u_int8_t	cmap_g[IBM561_NCMAP_ENTRIES];
109 	u_int8_t	cmap_b[IBM561_NCMAP_ENTRIES];
110 
111 	u_int16_t	gamma_r[IBM561_NGAMMA_ENTRIES];
112 	u_int16_t	gamma_g[IBM561_NGAMMA_ENTRIES];
113 	u_int16_t	gamma_b[IBM561_NGAMMA_ENTRIES];
114 
115 	u_int16_t	wtype[IBM561_NWTYPES];
116 };
117 
118 /*
119  * private functions
120  */
121 void	ibm561_update(void *);
122 static void ibm561_load_cmap(struct ibm561data *);
123 static void ibm561_load_dotclock(struct ibm561data *);
124 static void ibm561_regbegin(struct ibm561data *, u_int16_t);
125 static void ibm561_regcont(struct ibm561data *, u_int16_t, u_int8_t);
126 static void ibm561_regcont10bit(struct ibm561data *, u_int16_t, u_int16_t);
127 static void ibm561_regwr(struct ibm561data *, u_int16_t, u_int8_t);
128 
129 struct ramdac_funcs *
130 ibm561_funcs(void)
131 {
132 	return &ibm561_funcsstruct;
133 }
134 
135 struct ramdac_cookie *
136 ibm561_register(
137 	void *v,
138 	int (*sched_update)(void *, void (*)(void *)),
139 	void (*wr)(void *, u_int, u_int8_t),
140 	u_int8_t (*rd)(void *, u_int))
141 {
142 	struct ibm561data *data;
143 
144 	data = malloc(sizeof *data, M_DEVBUF, M_WAITOK|M_ZERO);
145 	data->cookie = v;
146 	data->ramdac_sched_update = sched_update;
147 	data->ramdac_wr = wr;
148 	data->ramdac_rd = rd;
149 	return (struct ramdac_cookie *)data;
150 }
151 
152 /*
153  * This function exists solely to provide a means to init
154  * the RAMDAC without first registering.  It is useful for
155  * initializing the console early on.
156  */
157 
158 static struct ibm561data saved_console_data;
159 
160 void
161 ibm561_cninit(
162 	void *v,
163 	int (*sched_update)(void *, void (*)(void *)),
164 	void (*wr)(void *, u_int, u_int8_t),
165 	u_int8_t (*rd)(void *, u_int),
166 	u_int dotclock)
167 {
168 	struct ibm561data *data = &saved_console_data;
169 	memset(data, 0x0, sizeof *data);
170 	data->cookie = v;
171 	data->ramdac_sched_update = sched_update;
172 	data->ramdac_wr = wr;
173 	data->ramdac_rd = rd;
174 	ibm561_set_dotclock((struct ramdac_cookie *)data, dotclock);
175 	ibm561_init((struct ramdac_cookie *)data);
176 }
177 
178 void
179 ibm561_init(struct ramdac_cookie *rc)
180 {
181 	struct	ibm561data *data = (struct ibm561data *)rc;
182 	int	i;
183 
184 	/* XXX this is _essential_ */
185 
186 	ibm561_load_dotclock(data);
187 
188 	/* XXXrcd: bunch of magic of which I have no current clue */
189 	ibm561_regwr(data, IBM561_CONFIG_REG1, 0x2a);
190 	ibm561_regwr(data, IBM561_CONFIG_REG3, 0x41);
191 	ibm561_regwr(data, IBM561_CONFIG_REG4, 0x20);
192 
193 	/* initialize the card a bit */
194 	ibm561_regwr(data, IBM561_SYNC_CNTL, 0x1);
195 	ibm561_regwr(data, IBM561_CONFIG_REG2, 0x19);
196 
197 	ibm561_regwr(data, IBM561_CONFIG_REG1, 0x2a);
198 	ibm561_regwr(data, IBM561_CONFIG_REG4, 0x20);
199 
200 	ibm561_regbegin(data, IBM561_WAT_SEG_REG);
201 	ibm561_regcont(data, IBM561_CMD, 0x00);
202 	ibm561_regcont(data, IBM561_CMD, 0x00);
203 	ibm561_regcont(data, IBM561_CMD, 0x00);
204 	ibm561_regcont(data, IBM561_CMD, 0x00);
205 	ibm561_regbegin(data, IBM561_CHROMAKEY0);
206 	ibm561_regcont(data, IBM561_CMD, 0x00);
207 	ibm561_regcont(data, IBM561_CMD, 0x00);
208 	ibm561_regcont(data, IBM561_CMD, 0x00);
209 	ibm561_regcont(data, IBM561_CMD, 0x00);
210 
211 	ibm561_regwr(data, IBM561_CURS_CNTL_REG, 0x00); /* XXX off? */
212 
213 	/* cursor `hot spot' registers */
214 	ibm561_regbegin(data, IBM561_HOTSPOT_REG);
215 	ibm561_regcont(data, IBM561_CMD, 0x00);
216 	ibm561_regcont(data, IBM561_CMD, 0x00);
217 	ibm561_regcont(data, IBM561_CMD, 0xff);
218 	ibm561_regcont(data, IBM561_CMD, 0x00);
219 	ibm561_regcont(data, IBM561_CMD, 0xff);
220 	ibm561_regcont(data, IBM561_CMD, 0x00);
221 
222 	/* VRAM Mask Registers (diagnostics) */
223 	ibm561_regbegin(data, IBM561_VRAM_MASK_REG);
224 	ibm561_regcont(data, IBM561_CMD, 0xff);
225 	ibm561_regcont(data, IBM561_CMD, 0xff);
226 	ibm561_regcont(data, IBM561_CMD, 0xff);
227 	ibm561_regcont(data, IBM561_CMD, 0xff);
228 	ibm561_regcont(data, IBM561_CMD, 0xff);
229 	ibm561_regcont(data, IBM561_CMD, 0xff);
230 	ibm561_regcont(data, IBM561_CMD, 0xff);
231 
232 	/* let's set up some decent default colour maps and gammas */
233 	for (i=0; i < IBM561_NCMAP_ENTRIES; i++)
234 		data->cmap_r[i] = data->cmap_g[i] = data->cmap_b[i] = 0xff;
235 	data->cmap_r[0]   = data->cmap_g[0]   = data->cmap_b[0]   = 0x00;
236 	data->cmap_r[256] = data->cmap_g[256] = data->cmap_b[256] = 0x00;
237 	data->cmap_r[512] = data->cmap_g[512] = data->cmap_b[512] = 0x00;
238 	data->cmap_r[768] = data->cmap_g[768] = data->cmap_b[768] = 0x00;
239 
240 	data->gamma_r[0] = data->gamma_g[0] = data->gamma_b[0] = 0x00;
241 	for (i=0; i < IBM561_NGAMMA_ENTRIES; i++)
242 		data->gamma_r[i] = data->gamma_g[i] = data->gamma_b[i] = 0xff;
243 
244 	for (i=0; i < IBM561_NWTYPES; i++)
245 		data->wtype[i] = 0x0036;
246 	data->wtype[1] = 0x0028;
247 
248 	/* the last step: */
249 	data->changed = CHANGED_ALL;
250 	data->ramdac_sched_update(data->cookie, ibm561_update);
251 }
252 
253 int
254 ibm561_set_cmap(struct ramdac_cookie *rc, struct wsdisplay_cmap *cmapp)
255 {
256 	struct ibm561data *data = (struct ibm561data *)rc;
257 	u_int count, index;
258 	uint8_t r[IBM561_NCMAP_ENTRIES];
259 	uint8_t g[IBM561_NCMAP_ENTRIES];
260 	uint8_t b[IBM561_NCMAP_ENTRIES];
261 	int s, error;
262 
263 	if (cmapp->index >= IBM561_NCMAP_ENTRIES ||
264 	    cmapp->count > IBM561_NCMAP_ENTRIES - cmapp->index)
265 		return (EINVAL);
266 
267 	index = cmapp->index;
268 	count = cmapp->count;
269 	error = copyin(cmapp->red, &r[index], count);
270 	if (error)
271 		return error;
272 	error = copyin(cmapp->green, &g[index], count);
273 	if (error)
274 		return error;
275 	error = copyin(cmapp->blue, &b[index], count);
276 	if (error)
277 		return error;
278 	s = spltty();
279 	memcpy(&data->cmap_r[index], &r[index], count);
280 	memcpy(&data->cmap_g[index], &g[index], count);
281 	memcpy(&data->cmap_b[index], &b[index], count);
282 	data->changed |= CHANGED_CMAP;
283 	data->ramdac_sched_update(data->cookie, ibm561_update);
284 	splx(s);
285 	return (0);
286 }
287 
288 int
289 ibm561_get_cmap(struct ramdac_cookie *rc, struct wsdisplay_cmap *cmapp)
290 {
291 	struct ibm561data *data = (struct ibm561data *)rc;
292 	u_int count, index;
293 	int error;
294 
295 	if (cmapp->index >= IBM561_NCMAP_ENTRIES ||
296 	    cmapp->count > IBM561_NCMAP_ENTRIES - cmapp->index)
297 		return (EINVAL);
298 	count = cmapp->count;
299 	index = cmapp->index;
300 	error = copyout(&data->cmap_r[index], cmapp->red, count);
301 	if (error)
302 		return (error);
303 	error = copyout(&data->cmap_g[index], cmapp->green, count);
304 	if (error)
305 		return (error);
306 	error = copyout(&data->cmap_b[index], cmapp->blue, count);
307 	return (error);
308 }
309 
310 /*
311  * XXX:
312  *  I am leaving these functions returning EINVAL, as they are
313  *  not strictly necessary for the correct functioning of the
314  *  card and in fact are not used on the other TGA variants, except
315  *  they are exported via ioctl(2) to userland, which does not in
316  *  fact use them.
317  */
318 
319 int
320 ibm561_set_cursor(struct ramdac_cookie *rc, struct wsdisplay_cursor *cursorp)
321 {
322 	return EINVAL;
323 }
324 
325 int
326 ibm561_get_cursor(struct ramdac_cookie *rc, struct wsdisplay_cursor *cursorp)
327 {
328 	return EINVAL;
329 }
330 
331 int
332 ibm561_set_curpos(struct ramdac_cookie *rc, struct wsdisplay_curpos *curposp)
333 {
334 	return EINVAL;
335 }
336 
337 int
338 ibm561_get_curpos(struct ramdac_cookie *rc, struct wsdisplay_curpos *curposp)
339 {
340 	return EINVAL;
341 }
342 
343 int
344 ibm561_get_curmax(struct ramdac_cookie *rc, struct wsdisplay_curpos *curposp)
345 {
346 	return EINVAL;
347 }
348 
349 int
350 ibm561_set_dotclock(struct ramdac_cookie *rc, unsigned dotclock)
351 {
352 	struct ibm561data *data = (struct ibm561data *)rc;
353 
354 	/* XXXrcd:  a couple of these are a little hazy, vis a vis
355 	 *          check 175MHz and 202MHz, which are wrong...
356 	 */
357 	switch (dotclock) {
358 	case  25175000: data->vco_div = 0x3e; data->pll_ref = 0x09; break;
359 	case  31500000: data->vco_div = 0x17; data->pll_ref = 0x05; break;
360 	case  40000000: data->vco_div = 0x42; data->pll_ref = 0x06; break;
361 	case  50000000: data->vco_div = 0x45; data->pll_ref = 0x05; break;
362 	case  65000000: data->vco_div = 0xac; data->pll_ref = 0x0c; break;
363 	case  69000000: data->vco_div = 0xa9; data->pll_ref = 0x0b; break;
364 	case  74000000: data->vco_div = 0x9c; data->pll_ref = 0x09; break;
365 	case  75000000: data->vco_div = 0x93; data->pll_ref = 0x08; break;
366 	case 103994000: data->vco_div = 0x96; data->pll_ref = 0x06; break;
367 	case 108180000: data->vco_div = 0xb8; data->pll_ref = 0x08; break;
368 	case 110000000: data->vco_div = 0xba; data->pll_ref = 0x08; break;
369 	case 119840000: data->vco_div = 0x82; data->pll_ref = 0x04; break;
370 	case 130808000: data->vco_div = 0xc8; data->pll_ref = 0x08; break;
371 	case 135000000: data->vco_div = 0xc1; data->pll_ref = 0x07; break;
372 	case 175000000: data->vco_div = 0xe2; data->pll_ref = 0x07; break;
373 	case 202500000: data->vco_div = 0xe2; data->pll_ref = 0x07; break;
374 	default:
375 		return EINVAL;
376 	}
377 
378 	data->div_dotclock = 0xb0;
379 	data->changed |= CHANGED_DOTCLOCK;
380 	return 0;
381 }
382 
383 /*
384  * Internal Functions
385  */
386 
387 void
388 ibm561_update(void *vp)
389 {
390 	struct ibm561data *data = (struct ibm561data *)vp;
391 	int	i;
392 
393 	/* XXX see comment above ibm561_cninit() */
394 	if (!data)
395 		data = &saved_console_data;
396 
397 	if (data->changed & CHANGED_WTYPE) {
398 		ibm561_regbegin(data, IBM561_FB_WINTYPE);
399 		for (i=0; i < IBM561_NWTYPES; i++)
400 			ibm561_regcont10bit(data, IBM561_CMD_FB_WAT, data->wtype[i]);
401 
402 		/* XXXrcd:  quick hack here for AUX FB table */
403 		ibm561_regbegin(data, IBM561_AUXFB_WINTYPE);
404 		for (i=0; i < IBM561_NWTYPES; i++)
405 			ibm561_regcont(data, IBM561_CMD, 0x04);
406 
407 		/* XXXrcd:  quick hack here for OL WAT table */
408 		ibm561_regbegin(data, IBM561_OL_WINTYPE);
409 		for (i=0; i < IBM561_NWTYPES; i++)
410 			ibm561_regcont10bit(data, IBM561_CMD_FB_WAT, 0x0231);
411 
412 		/* XXXrcd:  quick hack here for AUX OL WAT table */
413 		ibm561_regbegin(data, IBM561_AUXOL_WINTYPE);
414 		for (i=0; i < IBM561_NWTYPES; i++)
415 			ibm561_regcont(data, IBM561_CMD, 0x0c);
416 	}
417 
418 	if (data->changed & CHANGED_CMAP)
419 		ibm561_load_cmap(data);
420 
421 	/* XXX:  I am not sure in what situations it is safe to
422 	 *       change the dotclock---hope this is good.
423 	 */
424 	if (data->changed & CHANGED_DOTCLOCK)
425 		ibm561_load_dotclock(data);
426 }
427 
428 static void
429 ibm561_load_cmap(struct ibm561data *data)
430 {
431 	int	i;
432 
433 	ibm561_regbegin(data, IBM561_CMAP_TABLE);
434 	for (i=0; i < IBM561_NCMAP_ENTRIES; i++) {
435 		ibm561_regcont(data, IBM561_CMD_CMAP, data->cmap_r[i]);
436 		ibm561_regcont(data, IBM561_CMD_CMAP, data->cmap_g[i]);
437 		ibm561_regcont(data, IBM561_CMD_CMAP, data->cmap_b[i]);
438 	}
439 
440 	ibm561_regbegin(data, IBM561_RED_GAMMA_TABLE);
441 	for (i=0; i < 256; i++)
442 		ibm561_regcont10bit(data, IBM561_CMD_GAMMA, data->gamma_r[i]);
443 
444 	ibm561_regbegin(data, IBM561_GREEN_GAMMA_TABLE);
445 	for (i=1; i < 256; i++)
446 		ibm561_regcont10bit(data, IBM561_CMD_GAMMA, data->gamma_g[i]);
447 
448 	ibm561_regbegin(data, IBM561_BLUE_GAMMA_TABLE);
449 	for (i=1; i < 256; i++)
450 		ibm561_regcont10bit(data, IBM561_CMD_GAMMA, data->gamma_b[i]);
451 
452 }
453 
454 static void
455 ibm561_load_dotclock(struct ibm561data *data)
456 {
457 	/* XXX
458 	 * we should probably be more pro-active here, but it shouldn't
459 	 * actually happen...
460 	 */
461 	if (!data->vco_div || !data->pll_ref || ! data->div_dotclock) {
462 		panic("ibm561_load_dotclock: called uninitialized");
463 	}
464 
465 	ibm561_regwr(data, IBM561_PLL_VCO_DIV,  data->vco_div);
466 	ibm561_regwr(data, IBM561_PLL_REF_REG, data->pll_ref);
467 	ibm561_regwr(data, IBM561_DIV_DOTCLCK, data->div_dotclock);
468 }
469 
470 static void
471 ibm561_regcont10bit(struct ibm561data *data, u_int16_t reg, u_int16_t val)
472 {
473 	data->ramdac_wr(data->cookie, IBM561_CMD_GAMMA, (val >> 2) & 0xff);
474 	data->ramdac_wr(data->cookie, IBM561_CMD_GAMMA, (val & 0x3) << 6);
475 }
476 
477 static void
478 ibm561_regbegin(struct ibm561data *data, u_int16_t reg)
479 {
480 	data->ramdac_wr(data->cookie, IBM561_ADDR_LOW, reg & 0xff);
481 	data->ramdac_wr(data->cookie, IBM561_ADDR_HIGH, (reg >> 8) & 0xff);
482 }
483 
484 static void
485 ibm561_regcont(struct ibm561data *data, u_int16_t reg, u_int8_t val)
486 {
487 	data->ramdac_wr(data->cookie, reg, val);
488 }
489 
490 static void
491 ibm561_regwr(struct ibm561data *data, u_int16_t reg, u_int8_t val)
492 {
493 	ibm561_regbegin(data, reg);
494 	ibm561_regcont(data, IBM561_CMD, val);
495 }
496