xref: /freebsd/sys/dev/fb/s3_pci.c (revision c68159a6d8eede11766cf13896d0f7670dbd51aa)
1 /*-
2  * Copyright (c) 2000 Alcove - Nicolas Souchu <nsouch@freebsd.org>
3  * All rights reserved.
4  *
5  * Code based on Peter Horton <pdh@colonel-panic.com> patch.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  *
30  */
31 
32 /* Enable LFB on S3 cards that has only VESA 1.2 BIOS */
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <machine/bus_pio.h>
38 #include <machine/bus_memio.h>
39 #include <machine/bus.h>
40 
41 #include <vm/vm.h>
42 #include <vm/vm_extern.h>
43 #include <vm/vm_kern.h>
44 #include <vm/pmap.h>
45 
46 #include <sys/uio.h>
47 #include <sys/module.h>
48 #include <sys/bus.h>
49 #include <sys/rman.h>
50 #include <machine/resource.h>
51 
52 #include <sys/malloc.h>
53 #include <sys/fbio.h>
54 
55 #include <pci/pcireg.h>
56 #include <pci/pcivar.h>
57 
58 #include <machine/md_var.h>
59 #include <machine/vm86.h>
60 #include <machine/pc/bios.h>
61 #include <machine/pc/vesa.h>
62 
63 #include <dev/fb/fbreg.h>
64 #include <dev/fb/vgareg.h>
65 
66 #define S3PCI_DEBUG 1
67 
68 #define PCI_S3_VENDOR_ID	0x5333
69 
70 #define S3_CONFIG_IO		0x3c0	/* VGA standard config io ports */
71 #define S3_CONFIG_IO_SIZE	0x20
72 
73 #define S3_ENHANCED_IO		0x4ae8	/* Extended config register */
74 #define S3_ENHANCED_IO_SIZE	1
75 
76 #define S3_CRTC_ADDR		0x14
77 #define S3_CRTC_VALUE		0x15
78 
79 #define PCI_BASE_MEMORY		0x10
80 
81 #define outb_p(value, offset) bus_space_write_1(sc->st, sc->sh, offset, value)
82 #define inb_p(offset) (bus_space_read_1(sc->st, sc->sh, offset))
83 #define outb_enh(value, offset) bus_space_write_1(sc->enh_st, sc->enh_sh, \
84 								offset, value)
85 #define inb_enh(offset) (bus_space_read_1(sc->enh_st, sc->enh_sh, offset))
86 
87 struct s3pci_softc {
88 	bus_space_tag_t st;
89 	bus_space_handle_t sh;
90 	bus_space_tag_t enh_st;
91 	bus_space_handle_t enh_sh;
92 	struct resource *port_res;
93 	struct resource *enh_res;
94 	struct resource *mem_res;
95 	u_long mem_base;
96 	u_long mem_size;
97 };
98 
99 static int			s3lfb_error(void);
100 static vi_probe_t		s3lfb_probe;
101 static vi_init_t		s3lfb_init;
102 static vi_get_info_t		s3lfb_get_info;
103 static vi_query_mode_t		s3lfb_query_mode;
104 static vi_set_mode_t		s3lfb_set_mode;
105 static vi_save_font_t		s3lfb_save_font;
106 static vi_load_font_t		s3lfb_load_font;
107 static vi_show_font_t		s3lfb_show_font;
108 static vi_save_palette_t	s3lfb_save_palette;
109 static vi_load_palette_t	s3lfb_load_palette;
110 static vi_set_border_t		s3lfb_set_border;
111 static vi_save_state_t		s3lfb_save_state;
112 static vi_load_state_t		s3lfb_load_state;
113 static vi_set_win_org_t		s3lfb_set_origin;
114 static vi_read_hw_cursor_t	s3lfb_read_hw_cursor;
115 static vi_set_hw_cursor_t	s3lfb_set_hw_cursor;
116 static vi_set_hw_cursor_shape_t	s3lfb_set_hw_cursor_shape;
117 static vi_blank_display_t	s3lfb_blank_display;
118 static vi_mmap_t		s3lfb_mmap;
119 static vi_ioctl_t		s3lfb_ioctl;
120 static vi_clear_t		s3lfb_clear;
121 static vi_fill_rect_t		s3lfb_fill_rect;
122 static vi_bitblt_t		s3lfb_bitblt;
123 static vi_diag_t		s3lfb_diag;
124 
125 static video_switch_t s3lfbvidsw = {
126 	s3lfb_probe,
127 	s3lfb_init,
128 	s3lfb_get_info,
129 	s3lfb_query_mode,
130 	s3lfb_set_mode,
131 	s3lfb_save_font,
132 	s3lfb_load_font,
133 	s3lfb_show_font,
134 	s3lfb_save_palette,
135 	s3lfb_load_palette,
136 	s3lfb_set_border,
137 	s3lfb_save_state,
138 	s3lfb_load_state,
139 	s3lfb_set_origin,
140 	s3lfb_read_hw_cursor,
141 	s3lfb_set_hw_cursor,
142 	s3lfb_set_hw_cursor_shape,
143 	s3lfb_blank_display,
144 	s3lfb_mmap,
145 	s3lfb_ioctl,
146 	s3lfb_clear,
147 	s3lfb_fill_rect,
148 	s3lfb_bitblt,
149 	s3lfb_error,
150 	s3lfb_error,
151 	s3lfb_diag,
152 };
153 
154 static video_switch_t *prevvidsw;
155 static device_t s3pci_dev = NULL;
156 
157 static int
158 s3lfb_probe(int unit, video_adapter_t **adpp, void *arg, int flags)
159 {
160 	return (*prevvidsw->probe)(unit, adpp, arg, flags);
161 }
162 
163 static int
164 s3lfb_init(int unit, video_adapter_t *adp, int flags)
165 {
166 	return (*prevvidsw->init)(unit, adp, flags);
167 }
168 
169 static int
170 s3lfb_get_info(video_adapter_t *adp, int mode, video_info_t *info)
171 {
172 	device_t dev = s3pci_dev;			/* XXX */
173 	struct s3pci_softc *sc = (struct s3pci_softc *)device_get_softc(dev);
174 	int error;
175 
176 	if ((error = (*prevvidsw->get_info)(adp, mode, info)))
177 		return error;
178 
179 #if 0
180 	/* Don't use linear addressing with text modes
181 	 */
182 	if ((mode > M_VESA_BASE) &&
183 		(info->vi_flags & V_INFO_GRAPHICS) &&
184 		!(info->vi_flags & V_INFO_LINEAR)) {
185 
186 		info->vi_flags |= V_INFO_LINEAR;
187 		info->vi_buffer = sc->mem_base;
188 
189 	} else {
190 		info->vi_buffer = 0;
191 	}
192 #endif
193 
194 	return 0;
195 }
196 
197 static int
198 s3lfb_query_mode(video_adapter_t *adp, video_info_t *info)
199 {
200 	return (*prevvidsw->query_mode)(adp, info);
201 }
202 
203 static vm_offset_t
204 s3lfb_map_buffer(u_int paddr, size_t size)
205 {
206 	vm_offset_t vaddr;
207 	u_int off;
208 
209 	off = paddr - trunc_page(paddr);
210 	vaddr = (vm_offset_t)pmap_mapdev(paddr - off, size + off);
211 
212 	return (vaddr + off);
213 }
214 
215 static int
216 s3lfb_set_mode(video_adapter_t *adp, int mode)
217 {
218 	device_t dev = s3pci_dev;			/* XXX */
219 	struct s3pci_softc *sc = (struct s3pci_softc *)device_get_softc(dev);
220 	u_long cr59, cr5A;
221 	unsigned char tmp;
222 	int error;
223 
224 	/* First, set the mode as if it was a classic VESA card
225 	 */
226 	if ((error = (*prevvidsw->set_mode)(adp, mode)))
227 		return error;
228 
229 	/* If not in a linear mode (according to s3lfb_get_info() called
230 	 * by vesa_set_mode in the (*vidsw[adp->va_index]->get_info)...
231 	 * sequence, return with no error
232 	 */
233 #if 0
234 	if (!(adp->va_info.vi_flags & V_INFO_LINEAR))
235 		return 0;
236 #endif
237 
238 	if ((mode <= M_VESA_BASE) ||
239 		!(adp->va_info.vi_flags & V_INFO_GRAPHICS) ||
240 		(adp->va_info.vi_flags & V_INFO_LINEAR))
241 		return 0;
242 
243 	/* Ok, now apply the configuration to the card */
244 
245 	outb_p(0x38, S3_CRTC_ADDR); outb_p(0x48, S3_CRTC_VALUE);
246 	outb_p(0x39, S3_CRTC_ADDR); outb_p(0xa5, S3_CRTC_VALUE);
247 
248        /* check that CR47 is read/write */
249 
250 #if 0
251 	outb_p(0x47, S3_CRTC_ADDR); outb_p(0xff, S3_CRTC_VALUE);
252 	tmp = inb_p(S3_CRTC_VALUE);
253 	outb_p(0x00, S3_CRTC_VALUE);
254 	if ((tmp != 0xff) || (inb_p(S3_CRTC_VALUE)))
255 	{
256 		/* lock S3 registers */
257 
258 		outb_p(0x39, S3_CRTC_ADDR); outb_p(0x5a, S3_CRTC_VALUE);
259 		outb_p(0x38, S3_CRTC_ADDR); outb_p(0x00, S3_CRTC_VALUE);
260 
261 		return ENXIO;
262 	}
263 #endif
264 
265 	/* enable enhanced register access */
266 
267 	outb_p(0x40, S3_CRTC_ADDR);
268 	outb_p(inb_p(S3_CRTC_VALUE) | 1, S3_CRTC_VALUE);
269 
270 	/* enable enhanced functions */
271 
272 	outb_enh(inb_enh(0) | 1, 0x0);
273 
274 	/* enable enhanced mode memory mapping */
275 
276 	outb_p(0x31, S3_CRTC_ADDR);
277 	outb_p(inb_p(S3_CRTC_VALUE) | 8, S3_CRTC_VALUE);
278 
279 	/* enable linear frame buffer and set address window to max */
280 
281 	outb_p(0x58, S3_CRTC_ADDR);
282 	outb_p(inb_p(S3_CRTC_VALUE) | 0x13, S3_CRTC_VALUE);
283 
284 	/* disabled enhanced register access */
285 
286 	outb_p(0x40, S3_CRTC_ADDR);
287 	outb_p(inb_p(S3_CRTC_VALUE) & ~1, S3_CRTC_VALUE);
288 
289 	/* lock S3 registers */
290 
291 	outb_p(0x39, S3_CRTC_ADDR); outb_p(0x5a, S3_CRTC_VALUE);
292 	outb_p(0x38, S3_CRTC_ADDR); outb_p(0x00, S3_CRTC_VALUE);
293 
294 	adp->va_info.vi_flags |= V_INFO_LINEAR;
295 	adp->va_info.vi_buffer = sc->mem_base;
296 	adp->va_buffer = s3lfb_map_buffer(adp->va_info.vi_buffer,
297 				adp->va_info.vi_buffer_size);
298 	adp->va_buffer_size = adp->va_info.vi_buffer_size;
299 	adp->va_window = adp->va_buffer;
300 	adp->va_window_size = adp->va_info.vi_buffer_size/adp->va_info.vi_planes;
301 	adp->va_window_gran = adp->va_info.vi_buffer_size/adp->va_info.vi_planes;
302 
303 	return 0;
304 }
305 
306 static int
307 s3lfb_save_font(video_adapter_t *adp, int page, int fontsize, u_char *data,
308 	       int ch, int count)
309 {
310 	return (*prevvidsw->save_font)(adp, page, fontsize, data, ch, count);
311 }
312 
313 static int
314 s3lfb_load_font(video_adapter_t *adp, int page, int fontsize, u_char *data,
315 	       int ch, int count)
316 {
317 	return (*prevvidsw->load_font)(adp, page, fontsize, data, ch, count);
318 }
319 
320 static int
321 s3lfb_show_font(video_adapter_t *adp, int page)
322 {
323 	return (*prevvidsw->show_font)(adp, page);
324 }
325 
326 static int
327 s3lfb_save_palette(video_adapter_t *adp, u_char *palette)
328 {
329 	return (*prevvidsw->save_palette)(adp, palette);
330 }
331 
332 static int
333 s3lfb_load_palette(video_adapter_t *adp, u_char *palette)
334 {
335 	return (*prevvidsw->load_palette)(adp, palette);
336 }
337 
338 static int
339 s3lfb_set_border(video_adapter_t *adp, int color)
340 {
341 	return (*prevvidsw->set_border)(adp, color);
342 }
343 
344 static int
345 s3lfb_save_state(video_adapter_t *adp, void *p, size_t size)
346 {
347 	return (*prevvidsw->save_state)(adp, p, size);
348 }
349 
350 static int
351 s3lfb_load_state(video_adapter_t *adp, void *p)
352 {
353 	return (*prevvidsw->load_state)(adp, p);
354 }
355 
356 static int
357 s3lfb_set_origin(video_adapter_t *adp, off_t offset)
358 {
359 	return (*prevvidsw->set_win_org)(adp, offset);
360 }
361 
362 static int
363 s3lfb_read_hw_cursor(video_adapter_t *adp, int *col, int *row)
364 {
365 	return (*prevvidsw->read_hw_cursor)(adp, col, row);
366 }
367 
368 static int
369 s3lfb_set_hw_cursor(video_adapter_t *adp, int col, int row)
370 {
371 	return (*prevvidsw->set_hw_cursor)(adp, col, row);
372 }
373 
374 static int
375 s3lfb_set_hw_cursor_shape(video_adapter_t *adp, int base, int height,
376 			 int celsize, int blink)
377 {
378 	return (*prevvidsw->set_hw_cursor_shape)(adp, base, height,
379 			celsize, blink);
380 }
381 
382 static int
383 s3lfb_blank_display(video_adapter_t *adp, int mode)
384 {
385 	return (*prevvidsw->blank_display)(adp, mode);
386 }
387 
388 static int
389 s3lfb_mmap(video_adapter_t *adp, vm_offset_t offset, int prot)
390 {
391 	return (*prevvidsw->mmap)(adp, offset, prot);
392 }
393 
394 static int
395 s3lfb_clear(video_adapter_t *adp)
396 {
397 	return (*prevvidsw->clear)(adp);
398 }
399 
400 static int
401 s3lfb_fill_rect(video_adapter_t *adp, int val, int x, int y, int cx, int cy)
402 {
403 	return (*prevvidsw->fill_rect)(adp, val, x, y, cx, cy);
404 }
405 
406 static int
407 s3lfb_bitblt(video_adapter_t *adp,...)
408 {
409 	return (*prevvidsw->bitblt)(adp);		/* XXX */
410 }
411 
412 static int
413 s3lfb_ioctl(video_adapter_t *adp, u_long cmd, caddr_t arg)
414 {
415 	return (*prevvidsw->ioctl)(adp, cmd, arg);
416 }
417 
418 static int
419 s3lfb_diag(video_adapter_t *adp, int level)
420 {
421 	return (*prevvidsw->diag)(adp, level);
422 }
423 
424 static int
425 s3lfb_error(void)
426 {
427 	return 1;
428 }
429 
430 /***********************************/
431 /* PCI detection/attachement stuff */
432 /***********************************/
433 
434 static int
435 s3pci_probe(device_t dev)
436 {
437 	u_int32_t vendor, class, subclass, device_id;
438 
439 	device_id = pci_get_devid(dev);
440 	vendor = device_id & 0xffff;
441 	class = pci_get_class(dev);
442 	subclass = pci_get_subclass(dev);
443 
444 	if ((class != PCIC_DISPLAY) || (subclass != PCIS_DISPLAY_VGA) ||
445 		(vendor != PCI_S3_VENDOR_ID))
446 		return ENXIO;
447 
448 	device_set_desc(dev, "S3 graphic card");
449 
450 	bus_set_resource(dev, SYS_RES_IOPORT, 0,
451 				S3_CONFIG_IO, S3_CONFIG_IO_SIZE);
452 	bus_set_resource(dev, SYS_RES_IOPORT, 1,
453 				S3_ENHANCED_IO, S3_ENHANCED_IO_SIZE);
454 
455 	return 0;
456 
457 };
458 
459 static int
460 s3pci_attach(device_t dev)
461 {
462 	struct s3pci_softc* sc = (struct s3pci_softc*)device_get_softc(dev);
463 	video_adapter_t *adp;
464 
465 #if 0
466 	unsigned char tmp;
467 #endif
468 	int rid, i;
469 
470 	if (s3pci_dev) {
471 		printf("%s: driver already attached!\n", __FUNCTION__);
472 		goto error;
473 	}
474 
475 	/* Allocate resources
476 	 */
477 	rid = 0;
478 	if (!(sc->port_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
479 				0ul, ~0ul, 0, RF_ACTIVE | RF_SHAREABLE))) {
480 		printf("%s: port resource allocation failed!\n", __FUNCTION__);
481 		goto error;
482 	}
483 	sc->st = rman_get_bustag(sc->port_res);
484 	sc->sh = rman_get_bushandle(sc->port_res);
485 
486 	rid = 1;
487 	if (!(sc->enh_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
488 				0ul, ~0ul, 0, RF_ACTIVE | RF_SHAREABLE))) {
489 		printf("%s: enhanced port resource allocation failed!\n",
490 			__FUNCTION__);
491 		goto error;
492 	}
493 	sc->enh_st = rman_get_bustag(sc->enh_res);
494 	sc->enh_sh = rman_get_bushandle(sc->enh_res);
495 
496 	rid = PCI_BASE_MEMORY;
497 	if (!(sc->mem_res = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid,
498 				 0, ~0, 1, RF_ACTIVE))) {
499 
500 		printf("%s: mem resource allocation failed!\n", __FUNCTION__);
501 		goto error;
502 	}
503 
504 	/* The memory base address will be our LFB base address
505 	 */
506 	/* sc->mem_base = (u_long)rman_get_virtual(sc->mem_res); */
507 	sc->mem_base = bus_get_resource_start(dev, SYS_RES_MEMORY, rid);
508 	sc->mem_size = bus_get_resource_count(dev, SYS_RES_MEMORY, rid);
509 
510 	/* Attach the driver to the VGA/VESA framework
511 	 */
512 	for (i = 0; (adp = vid_get_adapter(i)) != NULL; ++i) {
513 		if ((adp->va_type == KD_VGA))
514 			break;
515 	}
516 
517 	/* If the VESA module hasn't been loaded, or VGA doesn't
518 	 * exist, abort
519 	 */
520 	if ((adp == NULL) || !(adp->va_flags & V_ADP_VESA)) {
521 		printf("%s: VGA adapter not found or VESA module not loaded!\n",
522 			__FUNCTION__);
523 		goto error;
524 	}
525 
526 	/* Replace the VESA video switch by owers
527 	 */
528 	prevvidsw = vidsw[adp->va_index];
529 	vidsw[adp->va_index] = &s3lfbvidsw;
530 
531 	/* Remember who we are on the bus */
532 	s3pci_dev = (void *)dev;			/* XXX */
533 
534 	return 0;
535 
536 error:
537 	if (sc->mem_res)
538 		bus_release_resource(dev, SYS_RES_MEMORY, PCI_BASE_MEMORY, sc->mem_res);
539 
540 	if (sc->enh_res)
541 		bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->enh_res);
542 
543 	if (sc->port_res)
544 		bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port_res);
545 
546 	return ENXIO;
547 };
548 
549 static device_method_t s3pci_methods[] = {
550 
551         DEVMETHOD(device_probe, s3pci_probe),
552         DEVMETHOD(device_attach, s3pci_attach),
553         {0,0}
554 };
555 
556 static driver_t s3pci_driver = {
557 	"s3pci",
558 	s3pci_methods,
559 	sizeof(struct s3pci_softc),
560 };
561 
562 static devclass_t s3pci_devclass;
563 
564 DRIVER_MODULE(s3pci, pci, s3pci_driver, s3pci_devclass, 0, 0);
565