1/*
2 * linux/drivers/video/hgafb.c -- Hercules graphics adaptor frame buffer device
3 *
4 * Created 25 Nov 1999 by Ferenc Bakonyi (fero@drama.obuda.kando.hu)
5 * Based on skeletonfb.c by Geert Uytterhoeven and
6 * mdacon.c by Andrew Apted
7 *
8 * History:
9 *
10 * - Revision 0.1.8 (23 Oct 2002): Ported to new framebuffer api.
11 *
12 * - Revision 0.1.7 (23 Jan 2001): fix crash resulting from MDA only cards
13 * being detected as Hercules. (Paul G.)
14 * - Revision 0.1.6 (17 Aug 2000): new style structs
15 * documentation
16 * - Revision 0.1.5 (13 Mar 2000): spinlocks instead of saveflags();cli();etc
17 * minor fixes
18 * - Revision 0.1.4 (24 Jan 2000): fixed a bug in hga_card_detect() for
19 * HGA-only systems
20 * - Revision 0.1.3 (22 Jan 2000): modified for the new fb_info structure
21 * screen is cleared after rmmod
22 * virtual resolutions
23 * module parameter 'nologo={0|1}'
24 * the most important: boot logo :)
25 * - Revision 0.1.0 (6 Dec 1999): faster scrolling and minor fixes
26 * - First release (25 Nov 1999)
27 *
28 * This file is subject to the terms and conditions of the GNU General Public
29 * License. See the file COPYING in the main directory of this archive
30 * for more details.
31 */
32
33#include <linux/module.h>
34#include <linux/kernel.h>
35#include <linux/errno.h>
36#include <linux/spinlock.h>
37#include <linux/string.h>
38#include <linux/mm.h>
39#include <linux/delay.h>
40#include <linux/fb.h>
41#include <linux/init.h>
42#include <linux/ioport.h>
43#include <linux/platform_device.h>
44#include <asm/io.h>
45#include <asm/vga.h>
46
47#if 0
48#define DPRINTK(args...) printk(KERN_DEBUG __FILE__": " ##args)
49#else
50#define DPRINTK(args...)
51#endif
52
53#if 0
54#define CHKINFO(ret) if (info != &fb_info) { printk(KERN_DEBUG __FILE__": This should never happen, line:%d \n", __LINE__); return ret; }
55#else
56#define CHKINFO(ret)
57#endif
58
59/* Description of the hardware layout */
60
61static void __iomem *hga_vram; /* Base of video memory */
62static unsigned long hga_vram_len; /* Size of video memory */
63
64#define HGA_ROWADDR(row) ((row%4)*8192 + (row>>2)*90)
65#define HGA_TXT 0
66#define HGA_GFX 1
67
68static inline u8 __iomem * rowaddr(struct fb_info *info, u_int row)
69{
70 return info->screen_base + HGA_ROWADDR(row);
71}
72
73static int hga_mode = -1; /* 0 = txt, 1 = gfx mode */
74
75static enum { TYPE_HERC, TYPE_HERCPLUS, TYPE_HERCCOLOR } hga_type;
76static char *hga_type_name;
77
78#define HGA_INDEX_PORT 0x3b4 /* Register select port */
79#define HGA_VALUE_PORT 0x3b5 /* Register value port */
80#define HGA_MODE_PORT 0x3b8 /* Mode control port */
81#define HGA_STATUS_PORT 0x3ba /* Status and Config port */
82#define HGA_GFX_PORT 0x3bf /* Graphics control port */
83
84/* HGA register values */
85
86#define HGA_CURSOR_BLINKING 0x00
87#define HGA_CURSOR_OFF 0x20
88#define HGA_CURSOR_SLOWBLINK 0x60
89
90#define HGA_MODE_GRAPHICS 0x02
91#define HGA_MODE_VIDEO_EN 0x08
92#define HGA_MODE_BLINK_EN 0x20
93#define HGA_MODE_GFX_PAGE1 0x80
94
95#define HGA_STATUS_HSYNC 0x01
96#define HGA_STATUS_VSYNC 0x80
97#define HGA_STATUS_VIDEO 0x08
98
99#define HGA_CONFIG_COL132 0x08
100#define HGA_GFX_MODE_EN 0x01
101#define HGA_GFX_PAGE_EN 0x02
102
103/* Global locks */
104
105static DEFINE_SPINLOCK(hga_reg_lock);
106
107/* Framebuffer driver structures */
108
109static const struct fb_var_screeninfo hga_default_var = {
110 .xres = 720,
111 .yres = 348,
112 .xres_virtual = 720,
113 .yres_virtual = 348,
114 .bits_per_pixel = 1,
115 .red = {0, 1, 0},
116 .green = {0, 1, 0},
117 .blue = {0, 1, 0},
118 .transp = {0, 0, 0},
119 .height = -1,
120 .width = -1,
121};
122
123static struct fb_fix_screeninfo hga_fix = {
124 .id = "HGA",
125 .type = FB_TYPE_PACKED_PIXELS, /* (not sure) */
126 .visual = FB_VISUAL_MONO10,
127 .xpanstep = 8,
128 .ypanstep = 8,
129 .line_length = 90,
130 .accel = FB_ACCEL_NONE
131};
132
133/* Don't assume that tty1 will be the initial current console. */
134static int release_io_port = 0;
135static int release_io_ports = 0;
136static bool = 0;
137
138/* -------------------------------------------------------------------------
139 *
140 * Low level hardware functions
141 *
142 * ------------------------------------------------------------------------- */
143
144static void write_hga_b(unsigned int val, unsigned char reg)
145{
146 outb_p(value: reg, HGA_INDEX_PORT);
147 outb_p(value: val, HGA_VALUE_PORT);
148}
149
150static void write_hga_w(unsigned int val, unsigned char reg)
151{
152 outb_p(value: reg, HGA_INDEX_PORT); outb_p(value: val >> 8, HGA_VALUE_PORT);
153 outb_p(value: reg+1, HGA_INDEX_PORT); outb_p(value: val & 0xff, HGA_VALUE_PORT);
154}
155
156static int test_hga_b(unsigned char val, unsigned char reg)
157{
158 outb_p(value: reg, HGA_INDEX_PORT);
159 outb (value: val, HGA_VALUE_PORT);
160 udelay(20); val = (inb_p(HGA_VALUE_PORT) == val);
161 return val;
162}
163
164static void hga_clear_screen(void)
165{
166 unsigned char fillchar = 0xbf; /* magic */
167 unsigned long flags;
168
169 spin_lock_irqsave(&hga_reg_lock, flags);
170 if (hga_mode == HGA_TXT)
171 fillchar = ' ';
172 else if (hga_mode == HGA_GFX)
173 fillchar = 0x00;
174 spin_unlock_irqrestore(lock: &hga_reg_lock, flags);
175 if (fillchar != 0xbf)
176 memset_io(hga_vram, fillchar, hga_vram_len);
177}
178
179static void hga_txt_mode(void)
180{
181 unsigned long flags;
182
183 spin_lock_irqsave(&hga_reg_lock, flags);
184 outb_p(HGA_MODE_VIDEO_EN | HGA_MODE_BLINK_EN, HGA_MODE_PORT);
185 outb_p(value: 0x00, HGA_GFX_PORT);
186 outb_p(value: 0x00, HGA_STATUS_PORT);
187
188 write_hga_b(val: 0x61, reg: 0x00); /* horizontal total */
189 write_hga_b(val: 0x50, reg: 0x01); /* horizontal displayed */
190 write_hga_b(val: 0x52, reg: 0x02); /* horizontal sync pos */
191 write_hga_b(val: 0x0f, reg: 0x03); /* horizontal sync width */
192
193 write_hga_b(val: 0x19, reg: 0x04); /* vertical total */
194 write_hga_b(val: 0x06, reg: 0x05); /* vertical total adjust */
195 write_hga_b(val: 0x19, reg: 0x06); /* vertical displayed */
196 write_hga_b(val: 0x19, reg: 0x07); /* vertical sync pos */
197
198 write_hga_b(val: 0x02, reg: 0x08); /* interlace mode */
199 write_hga_b(val: 0x0d, reg: 0x09); /* maximum scanline */
200 write_hga_b(val: 0x0c, reg: 0x0a); /* cursor start */
201 write_hga_b(val: 0x0d, reg: 0x0b); /* cursor end */
202
203 write_hga_w(val: 0x0000, reg: 0x0c); /* start address */
204 write_hga_w(val: 0x0000, reg: 0x0e); /* cursor location */
205
206 hga_mode = HGA_TXT;
207 spin_unlock_irqrestore(lock: &hga_reg_lock, flags);
208}
209
210static void hga_gfx_mode(void)
211{
212 unsigned long flags;
213
214 spin_lock_irqsave(&hga_reg_lock, flags);
215 outb_p(value: 0x00, HGA_STATUS_PORT);
216 outb_p(HGA_GFX_MODE_EN, HGA_GFX_PORT);
217 outb_p(HGA_MODE_VIDEO_EN | HGA_MODE_GRAPHICS, HGA_MODE_PORT);
218
219 write_hga_b(val: 0x35, reg: 0x00); /* horizontal total */
220 write_hga_b(val: 0x2d, reg: 0x01); /* horizontal displayed */
221 write_hga_b(val: 0x2e, reg: 0x02); /* horizontal sync pos */
222 write_hga_b(val: 0x07, reg: 0x03); /* horizontal sync width */
223
224 write_hga_b(val: 0x5b, reg: 0x04); /* vertical total */
225 write_hga_b(val: 0x02, reg: 0x05); /* vertical total adjust */
226 write_hga_b(val: 0x57, reg: 0x06); /* vertical displayed */
227 write_hga_b(val: 0x57, reg: 0x07); /* vertical sync pos */
228
229 write_hga_b(val: 0x02, reg: 0x08); /* interlace mode */
230 write_hga_b(val: 0x03, reg: 0x09); /* maximum scanline */
231 write_hga_b(val: 0x00, reg: 0x0a); /* cursor start */
232 write_hga_b(val: 0x00, reg: 0x0b); /* cursor end */
233
234 write_hga_w(val: 0x0000, reg: 0x0c); /* start address */
235 write_hga_w(val: 0x0000, reg: 0x0e); /* cursor location */
236
237 hga_mode = HGA_GFX;
238 spin_unlock_irqrestore(lock: &hga_reg_lock, flags);
239}
240
241static void (struct fb_info *info)
242{
243/*
244 void __iomem *dest = hga_vram;
245 char *logo = linux_logo_bw;
246 int x, y;
247
248 for (y = 134; y < 134 + 80 ; y++) * this needs some cleanup *
249 for (x = 0; x < 10 ; x++)
250 writeb(~*(logo++),(dest + HGA_ROWADDR(y) + x + 40));
251*/
252}
253
254static void hga_pan(unsigned int xoffset, unsigned int yoffset)
255{
256 unsigned int base;
257 unsigned long flags;
258
259 base = (yoffset / 8) * 90 + xoffset;
260 spin_lock_irqsave(&hga_reg_lock, flags);
261 write_hga_w(val: base, reg: 0x0c); /* start address */
262 spin_unlock_irqrestore(lock: &hga_reg_lock, flags);
263 DPRINTK("hga_pan: base:%d\n", base);
264}
265
266static void hga_blank(int blank_mode)
267{
268 unsigned long flags;
269
270 spin_lock_irqsave(&hga_reg_lock, flags);
271 if (blank_mode) {
272 outb_p(value: 0x00, HGA_MODE_PORT); /* disable video */
273 } else {
274 outb_p(HGA_MODE_VIDEO_EN | HGA_MODE_GRAPHICS, HGA_MODE_PORT);
275 }
276 spin_unlock_irqrestore(lock: &hga_reg_lock, flags);
277}
278
279static int hga_card_detect(void)
280{
281 int count = 0;
282 void __iomem *p, *q;
283 unsigned short p_save, q_save;
284
285 hga_vram_len = 0x08000;
286
287 hga_vram = ioremap(offset: 0xb0000, size: hga_vram_len);
288 if (!hga_vram)
289 return -ENOMEM;
290
291 if (request_region(0x3b0, 12, "hgafb"))
292 release_io_ports = 1;
293 if (request_region(0x3bf, 1, "hgafb"))
294 release_io_port = 1;
295
296 /* do a memory check */
297
298 p = hga_vram;
299 q = hga_vram + 0x01000;
300
301 p_save = readw(addr: p); q_save = readw(addr: q);
302
303 writew(val: 0xaa55, addr: p); if (readw(addr: p) == 0xaa55) count++;
304 writew(val: 0x55aa, addr: p); if (readw(addr: p) == 0x55aa) count++;
305 writew(val: p_save, addr: p);
306
307 if (count != 2)
308 goto error;
309
310 /* Ok, there is definitely a card registering at the correct
311 * memory location, so now we do an I/O port test.
312 */
313
314 if (!test_hga_b(val: 0x66, reg: 0x0f)) /* cursor low register */
315 goto error;
316
317 if (!test_hga_b(val: 0x99, reg: 0x0f)) /* cursor low register */
318 goto error;
319
320 /* See if the card is a Hercules, by checking whether the vsync
321 * bit of the status register is changing. This test lasts for
322 * approximately 1/10th of a second.
323 */
324
325 p_save = q_save = inb_p(HGA_STATUS_PORT) & HGA_STATUS_VSYNC;
326
327 for (count=0; count < 50000 && p_save == q_save; count++) {
328 q_save = inb(HGA_STATUS_PORT) & HGA_STATUS_VSYNC;
329 udelay(2);
330 }
331
332 if (p_save == q_save)
333 goto error;
334
335 switch (inb_p(HGA_STATUS_PORT) & 0x70) {
336 case 0x10:
337 hga_type = TYPE_HERCPLUS;
338 hga_type_name = "HerculesPlus";
339 break;
340 case 0x50:
341 hga_type = TYPE_HERCCOLOR;
342 hga_type_name = "HerculesColor";
343 break;
344 default:
345 hga_type = TYPE_HERC;
346 hga_type_name = "Hercules";
347 break;
348 }
349 return 0;
350error:
351 if (release_io_ports)
352 release_region(0x3b0, 12);
353 if (release_io_port)
354 release_region(0x3bf, 1);
355
356 iounmap(addr: hga_vram);
357
358 pr_err("hgafb: HGA card not detected.\n");
359
360 return -EINVAL;
361}
362
363/**
364 * hgafb_open - open the framebuffer device
365 * @info: pointer to fb_info object containing info for current hga board
366 * @init: open by console system or userland.
367 *
368 * Returns: %0
369 */
370
371static int hgafb_open(struct fb_info *info, int init)
372{
373 hga_gfx_mode();
374 hga_clear_screen();
375 if (!nologo) hga_show_logo(info);
376 return 0;
377}
378
379/**
380 * hgafb_release - open the framebuffer device
381 * @info: pointer to fb_info object containing info for current hga board
382 * @init: open by console system or userland.
383 *
384 * Returns: %0
385 */
386
387static int hgafb_release(struct fb_info *info, int init)
388{
389 hga_txt_mode();
390 hga_clear_screen();
391 return 0;
392}
393
394/**
395 * hgafb_setcolreg - set color registers
396 * @regno:register index to set
397 * @red:red value, unused
398 * @green:green value, unused
399 * @blue:blue value, unused
400 * @transp:transparency value, unused
401 * @info:unused
402 *
403 * This callback function is used to set the color registers of a HGA
404 * board. Since we have only two fixed colors only @regno is checked.
405 * A zero is returned on success and 1 for failure.
406 *
407 * Returns: %0
408 */
409
410static int hgafb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
411 u_int transp, struct fb_info *info)
412{
413 if (regno > 1)
414 return 1;
415 return 0;
416}
417
418/**
419 * hgafb_pan_display - pan or wrap the display
420 * @var:contains new xoffset, yoffset and vmode values
421 * @info:pointer to fb_info object containing info for current hga board
422 *
423 * This function looks only at xoffset, yoffset and the %FB_VMODE_YWRAP
424 * flag in @var. If input parameters are correct it calls hga_pan() to
425 * program the hardware. @info->var is updated to the new values.
426 *
427 * Returns: %0 on success or %-EINVAL for failure.
428 */
429
430static int hgafb_pan_display(struct fb_var_screeninfo *var,
431 struct fb_info *info)
432{
433 if (var->vmode & FB_VMODE_YWRAP) {
434 if (var->yoffset >= info->var.yres_virtual ||
435 var->xoffset)
436 return -EINVAL;
437 } else {
438 if (var->xoffset + info->var.xres > info->var.xres_virtual
439 || var->yoffset + info->var.yres > info->var.yres_virtual
440 || var->yoffset % 8)
441 return -EINVAL;
442 }
443
444 hga_pan(xoffset: var->xoffset, yoffset: var->yoffset);
445 return 0;
446}
447
448/**
449 * hgafb_blank - (un)blank the screen
450 * @blank_mode:blanking method to use
451 * @info:unused
452 *
453 * Blank the screen if blank_mode != 0, else unblank.
454 * Implements VESA suspend and powerdown modes on hardware that supports
455 * disabling hsync/vsync:
456 * @blank_mode == 2 means suspend vsync,
457 * @blank_mode == 3 means suspend hsync,
458 * @blank_mode == 4 means powerdown.
459 *
460 * Returns: %0
461 */
462
463static int hgafb_blank(int blank_mode, struct fb_info *info)
464{
465 hga_blank(blank_mode);
466 return 0;
467}
468
469/*
470 * Accel functions
471 */
472static void hgafb_fillrect(struct fb_info *info, const struct fb_fillrect *rect)
473{
474 u_int rows, y;
475 u8 __iomem *dest;
476
477 y = rect->dy;
478
479 for (rows = rect->height; rows--; y++) {
480 dest = rowaddr(info, row: y) + (rect->dx >> 3);
481 switch (rect->rop) {
482 case ROP_COPY:
483 memset_io(dest, rect->color, (rect->width >> 3));
484 break;
485 case ROP_XOR:
486 fb_writeb(b: ~(fb_readb(addr: dest)), addr: dest);
487 break;
488 }
489 }
490}
491
492static void hgafb_copyarea(struct fb_info *info, const struct fb_copyarea *area)
493{
494 u_int rows, y1, y2;
495 u8 __iomem *src;
496 u8 __iomem *dest;
497
498 if (area->dy <= area->sy) {
499 y1 = area->sy;
500 y2 = area->dy;
501
502 for (rows = area->height; rows--; ) {
503 src = rowaddr(info, row: y1) + (area->sx >> 3);
504 dest = rowaddr(info, row: y2) + (area->dx >> 3);
505 memmove(dest, src, (area->width >> 3));
506 y1++;
507 y2++;
508 }
509 } else {
510 y1 = area->sy + area->height - 1;
511 y2 = area->dy + area->height - 1;
512
513 for (rows = area->height; rows--;) {
514 src = rowaddr(info, row: y1) + (area->sx >> 3);
515 dest = rowaddr(info, row: y2) + (area->dx >> 3);
516 memmove(dest, src, (area->width >> 3));
517 y1--;
518 y2--;
519 }
520 }
521}
522
523static void hgafb_imageblit(struct fb_info *info, const struct fb_image *image)
524{
525 u8 __iomem *dest;
526 u8 *cdat = (u8 *) image->data;
527 u_int rows, y = image->dy;
528 u_int x;
529 u8 d;
530
531 for (rows = image->height; rows--; y++) {
532 for (x = 0; x < image->width; x+= 8) {
533 d = *cdat++;
534 dest = rowaddr(info, row: y) + ((image->dx + x)>> 3);
535 fb_writeb(b: d, addr: dest);
536 }
537 }
538}
539
540static const struct fb_ops hgafb_ops = {
541 .owner = THIS_MODULE,
542 .fb_open = hgafb_open,
543 .fb_release = hgafb_release,
544 __FB_DEFAULT_IOMEM_OPS_RDWR,
545 .fb_setcolreg = hgafb_setcolreg,
546 .fb_pan_display = hgafb_pan_display,
547 .fb_blank = hgafb_blank,
548 .fb_fillrect = hgafb_fillrect,
549 .fb_copyarea = hgafb_copyarea,
550 .fb_imageblit = hgafb_imageblit,
551 __FB_DEFAULT_IOMEM_OPS_MMAP,
552};
553
554/* ------------------------------------------------------------------------- *
555 *
556 * Functions in fb_info
557 *
558 * ------------------------------------------------------------------------- */
559
560/* ------------------------------------------------------------------------- */
561
562 /*
563 * Initialization
564 */
565
566static int hgafb_probe(struct platform_device *pdev)
567{
568 struct fb_info *info;
569 int ret;
570
571 ret = hga_card_detect();
572 if (ret)
573 return ret;
574
575 printk(KERN_INFO "hgafb: %s with %ldK of memory detected.\n",
576 hga_type_name, hga_vram_len/1024);
577
578 info = framebuffer_alloc(size: 0, dev: &pdev->dev);
579 if (!info) {
580 iounmap(addr: hga_vram);
581 return -ENOMEM;
582 }
583
584 hga_fix.smem_start = (unsigned long)hga_vram;
585 hga_fix.smem_len = hga_vram_len;
586
587 info->flags = FBINFO_HWACCEL_YPAN;
588 info->var = hga_default_var;
589 info->fix = hga_fix;
590 info->monspecs.hfmin = 0;
591 info->monspecs.hfmax = 0;
592 info->monspecs.vfmin = 10000;
593 info->monspecs.vfmax = 10000;
594 info->monspecs.dpms = 0;
595 info->fbops = &hgafb_ops;
596 info->screen_base = hga_vram;
597
598 if (register_framebuffer(fb_info: info) < 0) {
599 framebuffer_release(info);
600 iounmap(addr: hga_vram);
601 return -EINVAL;
602 }
603
604 fb_info(info, "%s frame buffer device\n", info->fix.id);
605 platform_set_drvdata(pdev, data: info);
606 return 0;
607}
608
609static void hgafb_remove(struct platform_device *pdev)
610{
611 struct fb_info *info = platform_get_drvdata(pdev);
612
613 hga_txt_mode();
614 hga_clear_screen();
615
616 if (info) {
617 unregister_framebuffer(fb_info: info);
618 framebuffer_release(info);
619 }
620
621 iounmap(addr: hga_vram);
622
623 if (release_io_ports)
624 release_region(0x3b0, 12);
625
626 if (release_io_port)
627 release_region(0x3bf, 1);
628}
629
630static struct platform_driver hgafb_driver = {
631 .probe = hgafb_probe,
632 .remove_new = hgafb_remove,
633 .driver = {
634 .name = "hgafb",
635 },
636};
637
638static struct platform_device *hgafb_device;
639
640static int __init hgafb_init(void)
641{
642 int ret;
643
644 if (fb_get_options(name: "hgafb", NULL))
645 return -ENODEV;
646
647 ret = platform_driver_register(&hgafb_driver);
648
649 if (!ret) {
650 hgafb_device = platform_device_register_simple(name: "hgafb", id: 0, NULL, num: 0);
651
652 if (IS_ERR(ptr: hgafb_device)) {
653 platform_driver_unregister(&hgafb_driver);
654 ret = PTR_ERR(ptr: hgafb_device);
655 }
656 }
657
658 return ret;
659}
660
661static void __exit hgafb_exit(void)
662{
663 platform_device_unregister(hgafb_device);
664 platform_driver_unregister(&hgafb_driver);
665}
666
667/* -------------------------------------------------------------------------
668 *
669 * Modularization
670 *
671 * ------------------------------------------------------------------------- */
672
673MODULE_AUTHOR("Ferenc Bakonyi <fero@drama.obuda.kando.hu>");
674MODULE_DESCRIPTION("FBDev driver for Hercules Graphics Adaptor");
675MODULE_LICENSE("GPL");
676
677module_param(nologo, bool, 0);
678MODULE_PARM_DESC(nologo, "Disables startup logo if != 0 (default=0)");
679module_init(hgafb_init);
680module_exit(hgafb_exit);
681

source code of linux/drivers/video/fbdev/hgafb.c