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