Samsung SoC Framebuffer driver: add Alpha Channel support
[linux-2.6.git] / drivers / video / s3c-fb.c
1 /* linux/drivers/video/s3c-fb.c
2  *
3  * Copyright 2008 Openmoko Inc.
4  * Copyright 2008 Simtec Electronics
5  *      Ben Dooks <ben@simtec.co.uk>
6  *      http://armlinux.simtec.co.uk/
7  *
8  * Samsung SoC Framebuffer driver
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13 */
14
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/init.h>
20 #include <linux/gfp.h>
21 #include <linux/clk.h>
22 #include <linux/fb.h>
23 #include <linux/io.h>
24
25 #include <mach/map.h>
26 #include <mach/regs-fb.h>
27 #include <plat/fb.h>
28
29 /* This driver will export a number of framebuffer interfaces depending
30  * on the configuration passed in via the platform data. Each fb instance
31  * maps to a hardware window. Currently there is no support for runtime
32  * setting of the alpha-blending functions that each window has, so only
33  * window 0 is actually useful.
34  *
35  * Window 0 is treated specially, it is used for the basis of the LCD
36  * output timings and as the control for the output power-down state.
37 */
38
39 /* note, some of the functions that get called are derived from including
40  * <mach/regs-fb.h> as they are specific to the architecture that the code
41  * is being built for.
42 */
43
44 #ifdef CONFIG_FB_S3C_DEBUG_REGWRITE
45 #undef writel
46 #define writel(v, r) do { \
47         printk(KERN_DEBUG "%s: %08x => %p\n", __func__, (unsigned int)v, r); \
48         __raw_writel(v, r); } while(0)
49 #endif /* FB_S3C_DEBUG_REGWRITE */
50
51 struct s3c_fb;
52
53 /**
54  * struct s3c_fb_win - per window private data for each framebuffer.
55  * @windata: The platform data supplied for the window configuration.
56  * @parent: The hardware that this window is part of.
57  * @fbinfo: Pointer pack to the framebuffer info for this window.
58  * @palette_buffer: Buffer/cache to hold palette entries.
59  * @pseudo_palette: For use in TRUECOLOUR modes for entries 0..15/
60  * @index: The window number of this window.
61  * @palette: The bitfields for changing r/g/b into a hardware palette entry.
62  */
63 struct s3c_fb_win {
64         struct s3c_fb_pd_win    *windata;
65         struct s3c_fb           *parent;
66         struct fb_info          *fbinfo;
67         struct s3c_fb_palette    palette;
68
69         u32                     *palette_buffer;
70         u32                      pseudo_palette[16];
71         unsigned int             index;
72 };
73
74 /**
75  * struct s3c_fb - overall hardware state of the hardware
76  * @dev: The device that we bound to, for printing, etc.
77  * @regs_res: The resource we claimed for the IO registers.
78  * @bus_clk: The clk (hclk) feeding our interface and possibly pixclk.
79  * @regs: The mapped hardware registers.
80  * @enabled: A bitmask of enabled hardware windows.
81  * @pdata: The platform configuration data passed with the device.
82  * @windows: The hardware windows that have been claimed.
83  */
84 struct s3c_fb {
85         struct device           *dev;
86         struct resource         *regs_res;
87         struct clk              *bus_clk;
88         void __iomem            *regs;
89
90         unsigned char            enabled;
91
92         struct s3c_fb_platdata  *pdata;
93         struct s3c_fb_win       *windows[S3C_FB_MAX_WIN];
94 };
95
96 /**
97  * s3c_fb_win_has_palette() - determine if a mode has a palette
98  * @win: The window number being queried.
99  * @bpp: The number of bits per pixel to test.
100  *
101  * Work out if the given window supports palletised data at the specified bpp.
102  */
103 static int s3c_fb_win_has_palette(unsigned int win, unsigned int bpp)
104 {
105         return s3c_fb_win_pal_size(win) <= (1 << bpp);
106 }
107
108 /**
109  * s3c_fb_check_var() - framebuffer layer request to verify a given mode.
110  * @var: The screen information to verify.
111  * @info: The framebuffer device.
112  *
113  * Framebuffer layer call to verify the given information and allow us to
114  * update various information depending on the hardware capabilities.
115  */
116 static int s3c_fb_check_var(struct fb_var_screeninfo *var,
117                             struct fb_info *info)
118 {
119         struct s3c_fb_win *win = info->par;
120         struct s3c_fb_pd_win *windata = win->windata;
121         struct s3c_fb *sfb = win->parent;
122
123         dev_dbg(sfb->dev, "checking parameters\n");
124
125         var->xres_virtual = max((unsigned int)windata->virtual_x, var->xres);
126         var->yres_virtual = max((unsigned int)windata->virtual_y, var->yres);
127
128         if (!s3c_fb_validate_win_bpp(win->index, var->bits_per_pixel)) {
129                 dev_dbg(sfb->dev, "win %d: unsupported bpp %d\n",
130                         win->index, var->bits_per_pixel);
131                 return -EINVAL;
132         }
133
134         /* always ensure these are zero, for drop through cases below */
135         var->transp.offset = 0;
136         var->transp.length = 0;
137
138         switch (var->bits_per_pixel) {
139         case 1:
140         case 2:
141         case 4:
142         case 8:
143                 if (!s3c_fb_win_has_palette(win->index, var->bits_per_pixel)) {
144                         /* non palletised, A:1,R:2,G:3,B:2 mode */
145                         var->red.offset         = 4;
146                         var->green.offset       = 2;
147                         var->blue.offset        = 0;
148                         var->red.length         = 5;
149                         var->green.length       = 3;
150                         var->blue.length        = 2;
151                         var->transp.offset      = 7;
152                         var->transp.length      = 1;
153                 } else {
154                         var->red.offset = 0;
155                         var->red.length = var->bits_per_pixel;
156                         var->green      = var->red;
157                         var->blue       = var->red;
158                 }
159                 break;
160
161         case 19:
162                 /* 666 with one bit alpha/transparency */
163                 var->transp.offset      = 18;
164                 var->transp.length      = 1;
165         case 18:
166                 var->bits_per_pixel     = 32;
167
168                 /* 666 format */
169                 var->red.offset         = 12;
170                 var->green.offset       = 6;
171                 var->blue.offset        = 0;
172                 var->red.length         = 6;
173                 var->green.length       = 6;
174                 var->blue.length        = 6;
175                 break;
176
177         case 16:
178                 /* 16 bpp, 565 format */
179                 var->red.offset         = 11;
180                 var->green.offset       = 5;
181                 var->blue.offset        = 0;
182                 var->red.length         = 5;
183                 var->green.length       = 6;
184                 var->blue.length        = 5;
185                 break;
186
187         case 28:
188         case 25:
189                 var->transp.length      = var->bits_per_pixel - 24;
190                 var->transp.offset      = 24;
191                 /* drop through */
192         case 24:
193                 /* our 24bpp is unpacked, so 32bpp */
194                 var->bits_per_pixel     = 32;
195         case 32:
196                 var->red.offset         = 16;
197                 var->red.length         = 8;
198                 var->green.offset       = 8;
199                 var->green.length       = 8;
200                 var->blue.offset        = 0;
201                 var->blue.length        = 8;
202                 break;
203
204         default:
205                 dev_err(sfb->dev, "invalid bpp\n");
206         }
207
208         dev_dbg(sfb->dev, "%s: verified parameters\n", __func__);
209         return 0;
210 }
211
212 /**
213  * s3c_fb_calc_pixclk() - calculate the divider to create the pixel clock.
214  * @sfb: The hardware state.
215  * @pixclock: The pixel clock wanted, in picoseconds.
216  *
217  * Given the specified pixel clock, work out the necessary divider to get
218  * close to the output frequency.
219  */
220 static int s3c_fb_calc_pixclk(struct s3c_fb *sfb, unsigned int pixclk)
221 {
222         unsigned long clk = clk_get_rate(sfb->bus_clk);
223         unsigned long long tmp;
224         unsigned int result;
225
226         tmp = (unsigned long long)clk;
227         tmp *= pixclk;
228
229         do_div(tmp, 1000000000UL);
230         result = (unsigned int)tmp / 1000;
231
232         dev_dbg(sfb->dev, "pixclk=%u, clk=%lu, div=%d (%lu)\n",
233                 pixclk, clk, result, clk / result);
234
235         return result;
236 }
237
238 /**
239  * s3c_fb_align_word() - align pixel count to word boundary
240  * @bpp: The number of bits per pixel
241  * @pix: The value to be aligned.
242  *
243  * Align the given pixel count so that it will start on an 32bit word
244  * boundary.
245  */
246 static int s3c_fb_align_word(unsigned int bpp, unsigned int pix)
247 {
248         int pix_per_word;
249
250         if (bpp > 16)
251                 return pix;
252
253         pix_per_word = (8 * 32) / bpp;
254         return ALIGN(pix, pix_per_word);
255 }
256
257 /**
258  * s3c_fb_set_par() - framebuffer request to set new framebuffer state.
259  * @info: The framebuffer to change.
260  *
261  * Framebuffer layer request to set a new mode for the specified framebuffer
262  */
263 static int s3c_fb_set_par(struct fb_info *info)
264 {
265         struct fb_var_screeninfo *var = &info->var;
266         struct s3c_fb_win *win = info->par;
267         struct s3c_fb *sfb = win->parent;
268         void __iomem *regs = sfb->regs;
269         int win_no = win->index;
270         u32 data;
271         u32 pagewidth;
272         int clkdiv;
273
274         dev_dbg(sfb->dev, "setting framebuffer parameters\n");
275
276         switch (var->bits_per_pixel) {
277         case 32:
278         case 24:
279         case 16:
280         case 12:
281                 info->fix.visual = FB_VISUAL_TRUECOLOR;
282                 break;
283         case 8:
284                 if (s3c_fb_win_has_palette(win_no, 8))
285                         info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
286                 else
287                         info->fix.visual = FB_VISUAL_TRUECOLOR;
288                 break;
289         case 1:
290                 info->fix.visual = FB_VISUAL_MONO01;
291                 break;
292         default:
293                 info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
294                 break;
295         }
296
297         info->fix.line_length = (var->xres_virtual * var->bits_per_pixel) / 8;
298
299         /* disable the window whilst we update it */
300         writel(0, regs + WINCON(win_no));
301
302         /* use window 0 as the basis for the lcd output timings */
303
304         if (win_no == 0) {
305                 clkdiv = s3c_fb_calc_pixclk(sfb, var->pixclock);
306
307                 data = sfb->pdata->vidcon0;
308                 data &= ~(VIDCON0_CLKVAL_F_MASK | VIDCON0_CLKDIR);
309
310                 if (clkdiv > 1)
311                         data |= VIDCON0_CLKVAL_F(clkdiv-1) | VIDCON0_CLKDIR;
312                 else
313                         data &= ~VIDCON0_CLKDIR;        /* 1:1 clock */
314
315                 /* write the timing data to the panel */
316
317                 data |= VIDCON0_ENVID | VIDCON0_ENVID_F;
318                 writel(data, regs + VIDCON0);
319
320                 data = VIDTCON0_VBPD(var->upper_margin - 1) |
321                        VIDTCON0_VFPD(var->lower_margin - 1) |
322                        VIDTCON0_VSPW(var->vsync_len - 1);
323
324                 writel(data, regs + VIDTCON0);
325
326                 data = VIDTCON1_HBPD(var->left_margin - 1) |
327                        VIDTCON1_HFPD(var->right_margin - 1) |
328                        VIDTCON1_HSPW(var->hsync_len - 1);
329
330                 writel(data, regs + VIDTCON1);
331
332                 data = VIDTCON2_LINEVAL(var->yres - 1) |
333                        VIDTCON2_HOZVAL(var->xres - 1);
334                 writel(data, regs + VIDTCON2);
335         }
336
337         /* write the buffer address */
338
339         writel(info->fix.smem_start, regs + VIDW_BUF_START(win_no));
340
341         data = info->fix.smem_start + info->fix.line_length * var->yres;
342         writel(data, regs + VIDW_BUF_END(win_no));
343
344         pagewidth = (var->xres * var->bits_per_pixel) >> 3;
345         data = VIDW_BUF_SIZE_OFFSET(info->fix.line_length - pagewidth) |
346                VIDW_BUF_SIZE_PAGEWIDTH(pagewidth);
347         writel(data, regs + VIDW_BUF_SIZE(win_no));
348
349         /* write 'OSD' registers to control position of framebuffer */
350
351         data = VIDOSDxA_TOPLEFT_X(0) | VIDOSDxA_TOPLEFT_Y(0);
352         writel(data, regs + VIDOSD_A(win_no));
353
354         data = VIDOSDxB_BOTRIGHT_X(s3c_fb_align_word(var->bits_per_pixel,
355                                                      var->xres - 1)) |
356                VIDOSDxB_BOTRIGHT_Y(var->yres - 1);
357
358         writel(data, regs + VIDOSD_B(win_no));
359
360         data = var->xres * var->yres;
361
362         u32 osdc_data = 0;
363
364         osdc_data = VIDISD14C_ALPHA1_R(0xf) |
365                 VIDISD14C_ALPHA1_G(0xf) |
366                 VIDISD14C_ALPHA1_B(0xf);
367
368         if (s3c_fb_has_osd_d(win_no)) {
369                 writel(data, regs + VIDOSD_D(win_no));
370                 writel(osdc_data, regs + VIDOSD_C(win_no));
371         } else
372                 writel(data, regs + VIDOSD_C(win_no));
373
374         data = WINCONx_ENWIN;
375
376         /* note, since we have to round up the bits-per-pixel, we end up
377          * relying on the bitfield information for r/g/b/a to work out
378          * exactly which mode of operation is intended. */
379
380         switch (var->bits_per_pixel) {
381         case 1:
382                 data |= WINCON0_BPPMODE_1BPP;
383                 data |= WINCONx_BITSWP;
384                 data |= WINCONx_BURSTLEN_4WORD;
385                 break;
386         case 2:
387                 data |= WINCON0_BPPMODE_2BPP;
388                 data |= WINCONx_BITSWP;
389                 data |= WINCONx_BURSTLEN_8WORD;
390                 break;
391         case 4:
392                 data |= WINCON0_BPPMODE_4BPP;
393                 data |= WINCONx_BITSWP;
394                 data |= WINCONx_BURSTLEN_8WORD;
395                 break;
396         case 8:
397                 if (var->transp.length != 0)
398                         data |= WINCON1_BPPMODE_8BPP_1232;
399                 else
400                         data |= WINCON0_BPPMODE_8BPP_PALETTE;
401                 data |= WINCONx_BURSTLEN_8WORD;
402                 data |= WINCONx_BYTSWP;
403                 break;
404         case 16:
405                 if (var->transp.length != 0)
406                         data |= WINCON1_BPPMODE_16BPP_A1555;
407                 else
408                         data |= WINCON0_BPPMODE_16BPP_565;
409                 data |= WINCONx_HAWSWP;
410                 data |= WINCONx_BURSTLEN_16WORD;
411                 break;
412         case 24:
413         case 32:
414                 if (var->red.length == 6) {
415                         if (var->transp.length != 0)
416                                 data |= WINCON1_BPPMODE_19BPP_A1666;
417                         else
418                                 data |= WINCON1_BPPMODE_18BPP_666;
419                 } else if (var->transp.length == 1)
420                         data |= WINCON1_BPPMODE_25BPP_A1888
421                                 | WINCON1_BLD_PIX;
422                 else if (var->transp.length == 4)
423                         data |= WINCON1_BPPMODE_28BPP_A4888
424                                 | WINCON1_BLD_PIX | WINCON1_ALPHA_SEL;
425                 else
426                         data |= WINCON0_BPPMODE_24BPP_888;
427
428                 data |= WINCONx_BURSTLEN_16WORD;
429                 break;
430         }
431
432         /* It has no color key control register for window0 */
433         if (win_no > 0) {
434                 u32 keycon0_data = 0, keycon1_data = 0;
435
436                 keycon0_data = ~(WxKEYCON0_KEYBL_EN |
437                                 WxKEYCON0_KEYEN_F |
438                                 WxKEYCON0_DIRCON) | WxKEYCON0_COMPKEY(0);
439
440                 keycon1_data = WxKEYCON1_COLVAL(0xffffff);
441
442                 writel(keycon0_data, regs + WxKEYCONy(win_no-1, 0));
443                 writel(keycon1_data, regs + WxKEYCONy(win_no-1, 1));
444         }
445
446         writel(data, regs + WINCON(win_no));
447         writel(0x0, regs + WINxMAP(win_no));
448
449         return 0;
450 }
451
452 /**
453  * s3c_fb_update_palette() - set or schedule a palette update.
454  * @sfb: The hardware information.
455  * @win: The window being updated.
456  * @reg: The palette index being changed.
457  * @value: The computed palette value.
458  *
459  * Change the value of a palette register, either by directly writing to
460  * the palette (this requires the palette RAM to be disconnected from the
461  * hardware whilst this is in progress) or schedule the update for later.
462  *
463  * At the moment, since we have no VSYNC interrupt support, we simply set
464  * the palette entry directly.
465  */
466 static void s3c_fb_update_palette(struct s3c_fb *sfb,
467                                   struct s3c_fb_win *win,
468                                   unsigned int reg,
469                                   u32 value)
470 {
471         void __iomem *palreg;
472         u32 palcon;
473
474         palreg = sfb->regs + s3c_fb_pal_reg(win->index, reg);
475
476         dev_dbg(sfb->dev, "%s: win %d, reg %d (%p): %08x\n",
477                 __func__, win->index, reg, palreg, value);
478
479         win->palette_buffer[reg] = value;
480
481         palcon = readl(sfb->regs + WPALCON);
482         writel(palcon | WPALCON_PAL_UPDATE, sfb->regs + WPALCON);
483
484         if (s3c_fb_pal_is16(win->index))
485                 writew(value, palreg);
486         else
487                 writel(value, palreg);
488
489         writel(palcon, sfb->regs + WPALCON);
490 }
491
492 static inline unsigned int chan_to_field(unsigned int chan,
493                                          struct fb_bitfield *bf)
494 {
495         chan &= 0xffff;
496         chan >>= 16 - bf->length;
497         return chan << bf->offset;
498 }
499
500 /**
501  * s3c_fb_setcolreg() - framebuffer layer request to change palette.
502  * @regno: The palette index to change.
503  * @red: The red field for the palette data.
504  * @green: The green field for the palette data.
505  * @blue: The blue field for the palette data.
506  * @trans: The transparency (alpha) field for the palette data.
507  * @info: The framebuffer being changed.
508  */
509 static int s3c_fb_setcolreg(unsigned regno,
510                             unsigned red, unsigned green, unsigned blue,
511                             unsigned transp, struct fb_info *info)
512 {
513         struct s3c_fb_win *win = info->par;
514         struct s3c_fb *sfb = win->parent;
515         unsigned int val;
516
517         dev_dbg(sfb->dev, "%s: win %d: %d => rgb=%d/%d/%d\n",
518                 __func__, win->index, regno, red, green, blue);
519
520         switch (info->fix.visual) {
521         case FB_VISUAL_TRUECOLOR:
522                 /* true-colour, use pseudo-palette */
523
524                 if (regno < 16) {
525                         u32 *pal = info->pseudo_palette;
526
527                         val  = chan_to_field(red,   &info->var.red);
528                         val |= chan_to_field(green, &info->var.green);
529                         val |= chan_to_field(blue,  &info->var.blue);
530
531                         pal[regno] = val;
532                 }
533                 break;
534
535         case FB_VISUAL_PSEUDOCOLOR:
536                 if (regno < s3c_fb_win_pal_size(win->index)) {
537                         val  = chan_to_field(red, &win->palette.r);
538                         val |= chan_to_field(green, &win->palette.g);
539                         val |= chan_to_field(blue, &win->palette.b);
540
541                         s3c_fb_update_palette(sfb, win, regno, val);
542                 }
543
544                 break;
545
546         default:
547                 return 1;       /* unknown type */
548         }
549
550         return 0;
551 }
552
553 /**
554  * s3c_fb_enable() - Set the state of the main LCD output
555  * @sfb: The main framebuffer state.
556  * @enable: The state to set.
557  */
558 static void s3c_fb_enable(struct s3c_fb *sfb, int enable)
559 {
560         u32 vidcon0 = readl(sfb->regs + VIDCON0);
561
562         if (enable)
563                 vidcon0 |= VIDCON0_ENVID | VIDCON0_ENVID_F;
564         else {
565                 /* see the note in the framebuffer datasheet about
566                  * why you cannot take both of these bits down at the
567                  * same time. */
568
569                 if (!(vidcon0 & VIDCON0_ENVID))
570                         return;
571
572                 vidcon0 |= VIDCON0_ENVID;
573                 vidcon0 &= ~VIDCON0_ENVID_F;
574         }
575
576         writel(vidcon0, sfb->regs + VIDCON0);
577 }
578
579 /**
580  * s3c_fb_blank() - blank or unblank the given window
581  * @blank_mode: The blank state from FB_BLANK_*
582  * @info: The framebuffer to blank.
583  *
584  * Framebuffer layer request to change the power state.
585  */
586 static int s3c_fb_blank(int blank_mode, struct fb_info *info)
587 {
588         struct s3c_fb_win *win = info->par;
589         struct s3c_fb *sfb = win->parent;
590         unsigned int index = win->index;
591         u32 wincon;
592
593         dev_dbg(sfb->dev, "blank mode %d\n", blank_mode);
594
595         wincon = readl(sfb->regs + WINCON(index));
596
597         switch (blank_mode) {
598         case FB_BLANK_POWERDOWN:
599                 wincon &= ~WINCONx_ENWIN;
600                 sfb->enabled &= ~(1 << index);
601                 /* fall through to FB_BLANK_NORMAL */
602
603         case FB_BLANK_NORMAL:
604                 /* disable the DMA and display 0x0 (black) */
605                 writel(WINxMAP_MAP | WINxMAP_MAP_COLOUR(0x0),
606                        sfb->regs + WINxMAP(index));
607                 break;
608
609         case FB_BLANK_UNBLANK:
610                 writel(0x0, sfb->regs + WINxMAP(index));
611                 wincon |= WINCONx_ENWIN;
612                 sfb->enabled |= (1 << index);
613                 break;
614
615         case FB_BLANK_VSYNC_SUSPEND:
616         case FB_BLANK_HSYNC_SUSPEND:
617         default:
618                 return 1;
619         }
620
621         writel(wincon, sfb->regs + WINCON(index));
622
623         /* Check the enabled state to see if we need to be running the
624          * main LCD interface, as if there are no active windows then
625          * it is highly likely that we also do not need to output
626          * anything.
627          */
628
629         /* We could do something like the following code, but the current
630          * system of using framebuffer events means that we cannot make
631          * the distinction between just window 0 being inactive and all
632          * the windows being down.
633          *
634          * s3c_fb_enable(sfb, sfb->enabled ? 1 : 0);
635         */
636
637         /* we're stuck with this until we can do something about overriding
638          * the power control using the blanking event for a single fb.
639          */
640         if (index == 0)
641                 s3c_fb_enable(sfb, blank_mode != FB_BLANK_POWERDOWN ? 1 : 0);
642
643         return 0;
644 }
645
646 static struct fb_ops s3c_fb_ops = {
647         .owner          = THIS_MODULE,
648         .fb_check_var   = s3c_fb_check_var,
649         .fb_set_par     = s3c_fb_set_par,
650         .fb_blank       = s3c_fb_blank,
651         .fb_setcolreg   = s3c_fb_setcolreg,
652         .fb_fillrect    = cfb_fillrect,
653         .fb_copyarea    = cfb_copyarea,
654         .fb_imageblit   = cfb_imageblit,
655 };
656
657 /**
658  * s3c_fb_alloc_memory() - allocate display memory for framebuffer window
659  * @sfb: The base resources for the hardware.
660  * @win: The window to initialise memory for.
661  *
662  * Allocate memory for the given framebuffer.
663  */
664 static int __devinit s3c_fb_alloc_memory(struct s3c_fb *sfb,
665                                          struct s3c_fb_win *win)
666 {
667         struct s3c_fb_pd_win *windata = win->windata;
668         unsigned int real_size, virt_size, size;
669         struct fb_info *fbi = win->fbinfo;
670         dma_addr_t map_dma;
671
672         dev_dbg(sfb->dev, "allocating memory for display\n");
673
674         real_size = windata->win_mode.xres * windata->win_mode.yres;
675         virt_size = windata->virtual_x * windata->virtual_y;
676
677         dev_dbg(sfb->dev, "real_size=%u (%u.%u), virt_size=%u (%u.%u)\n",
678                 real_size, windata->win_mode.xres, windata->win_mode.yres,
679                 virt_size, windata->virtual_x, windata->virtual_y);
680
681         size = (real_size > virt_size) ? real_size : virt_size;
682         size *= (windata->max_bpp > 16) ? 32 : windata->max_bpp;
683         size /= 8;
684
685         fbi->fix.smem_len = size;
686         size = PAGE_ALIGN(size);
687
688         dev_dbg(sfb->dev, "want %u bytes for window\n", size);
689
690         fbi->screen_base = dma_alloc_writecombine(sfb->dev, size,
691                                                   &map_dma, GFP_KERNEL);
692         if (!fbi->screen_base)
693                 return -ENOMEM;
694
695         dev_dbg(sfb->dev, "mapped %x to %p\n",
696                 (unsigned int)map_dma, fbi->screen_base);
697
698         memset(fbi->screen_base, 0x0, size);
699         fbi->fix.smem_start = map_dma;
700
701         return 0;
702 }
703
704 /**
705  * s3c_fb_free_memory() - free the display memory for the given window
706  * @sfb: The base resources for the hardware.
707  * @win: The window to free the display memory for.
708  *
709  * Free the display memory allocated by s3c_fb_alloc_memory().
710  */
711 static void s3c_fb_free_memory(struct s3c_fb *sfb, struct s3c_fb_win *win)
712 {
713         struct fb_info *fbi = win->fbinfo;
714
715         dma_free_writecombine(sfb->dev, PAGE_ALIGN(fbi->fix.smem_len),
716                               fbi->screen_base, fbi->fix.smem_start);
717 }
718
719 /**
720  * s3c_fb_release_win() - release resources for a framebuffer window.
721  * @win: The window to cleanup the resources for.
722  *
723  * Release the resources that where claimed for the hardware window,
724  * such as the framebuffer instance and any memory claimed for it.
725  */
726 static void s3c_fb_release_win(struct s3c_fb *sfb, struct s3c_fb_win *win)
727 {
728         fb_dealloc_cmap(&win->fbinfo->cmap);
729         unregister_framebuffer(win->fbinfo);
730         s3c_fb_free_memory(sfb, win);
731 }
732
733 /**
734  * s3c_fb_probe_win() - register an hardware window
735  * @sfb: The base resources for the hardware
736  * @res: Pointer to where to place the resultant window.
737  *
738  * Allocate and do the basic initialisation for one of the hardware's graphics
739  * windows.
740  */
741 static int __devinit s3c_fb_probe_win(struct s3c_fb *sfb, unsigned int win_no,
742                                       struct s3c_fb_win **res)
743 {
744         struct fb_var_screeninfo *var;
745         struct fb_videomode *initmode;
746         struct s3c_fb_pd_win *windata;
747         struct s3c_fb_win *win;
748         struct fb_info *fbinfo;
749         int palette_size;
750         int ret;
751
752         dev_dbg(sfb->dev, "probing window %d\n", win_no);
753
754         palette_size = s3c_fb_win_pal_size(win_no);
755
756         fbinfo = framebuffer_alloc(sizeof(struct s3c_fb_win) +
757                                    palette_size * sizeof(u32), sfb->dev);
758         if (!fbinfo) {
759                 dev_err(sfb->dev, "failed to allocate framebuffer\n");
760                 return -ENOENT;
761         }
762
763         windata = sfb->pdata->win[win_no];
764         initmode = &windata->win_mode;
765
766         WARN_ON(windata->max_bpp == 0);
767         WARN_ON(windata->win_mode.xres == 0);
768         WARN_ON(windata->win_mode.yres == 0);
769
770         win = fbinfo->par;
771         var = &fbinfo->var;
772         win->fbinfo = fbinfo;
773         win->parent = sfb;
774         win->windata = windata;
775         win->index = win_no;
776         win->palette_buffer = (u32 *)(win + 1);
777
778         ret = s3c_fb_alloc_memory(sfb, win);
779         if (ret) {
780                 dev_err(sfb->dev, "failed to allocate display memory\n");
781                 goto err_framebuffer;
782         }
783
784         /* setup the r/b/g positions for the window's palette */
785         s3c_fb_init_palette(win_no, &win->palette);
786
787         /* setup the initial video mode from the window */
788         fb_videomode_to_var(&fbinfo->var, initmode);
789
790         fbinfo->fix.type        = FB_TYPE_PACKED_PIXELS;
791         fbinfo->fix.accel       = FB_ACCEL_NONE;
792         fbinfo->var.activate    = FB_ACTIVATE_NOW;
793         fbinfo->var.vmode       = FB_VMODE_NONINTERLACED;
794         fbinfo->var.bits_per_pixel = windata->default_bpp;
795         fbinfo->fbops           = &s3c_fb_ops;
796         fbinfo->flags           = FBINFO_FLAG_DEFAULT;
797         fbinfo->pseudo_palette  = &win->pseudo_palette;
798
799         /* prepare to actually start the framebuffer */
800
801         ret = s3c_fb_check_var(&fbinfo->var, fbinfo);
802         if (ret < 0) {
803                 dev_err(sfb->dev, "check_var failed on initial video params\n");
804                 goto err_alloc_mem;
805         }
806
807         /* create initial colour map */
808
809         ret = fb_alloc_cmap(&fbinfo->cmap, s3c_fb_win_pal_size(win_no), 1);
810         if (ret == 0)
811                 fb_set_cmap(&fbinfo->cmap, fbinfo);
812         else
813                 dev_err(sfb->dev, "failed to allocate fb cmap\n");
814
815         s3c_fb_set_par(fbinfo);
816
817         dev_dbg(sfb->dev, "about to register framebuffer\n");
818
819         /* run the check_var and set_par on our configuration. */
820
821         ret = register_framebuffer(fbinfo);
822         if (ret < 0) {
823                 dev_err(sfb->dev, "failed to register framebuffer\n");
824                 goto err_alloc_mem;
825         }
826
827         *res = win;
828         dev_info(sfb->dev, "window %d: fb %s\n", win_no, fbinfo->fix.id);
829
830         return 0;
831
832 err_alloc_mem:
833         s3c_fb_free_memory(sfb, win);
834
835 err_framebuffer:
836         unregister_framebuffer(fbinfo);
837         return ret;
838 }
839
840 /**
841  * s3c_fb_clear_win() - clear hardware window registers.
842  * @sfb: The base resources for the hardware.
843  * @win: The window to process.
844  *
845  * Reset the specific window registers to a known state.
846  */
847 static void s3c_fb_clear_win(struct s3c_fb *sfb, int win)
848 {
849         void __iomem *regs = sfb->regs;
850
851         writel(0, regs + WINCON(win));
852         writel(0xffffff, regs + WxKEYCONy(win, 0));
853         writel(0xffffff, regs + WxKEYCONy(win, 1));
854
855         writel(0, regs + VIDOSD_A(win));
856         writel(0, regs + VIDOSD_B(win));
857         writel(0, regs + VIDOSD_C(win));
858 }
859
860 static int __devinit s3c_fb_probe(struct platform_device *pdev)
861 {
862         struct device *dev = &pdev->dev;
863         struct s3c_fb_platdata *pd;
864         struct s3c_fb *sfb;
865         struct resource *res;
866         int win;
867         int ret = 0;
868
869         pd = pdev->dev.platform_data;
870         if (!pd) {
871                 dev_err(dev, "no platform data specified\n");
872                 return -EINVAL;
873         }
874
875         sfb = kzalloc(sizeof(struct s3c_fb), GFP_KERNEL);
876         if (!sfb) {
877                 dev_err(dev, "no memory for framebuffers\n");
878                 return -ENOMEM;
879         }
880
881         sfb->dev = dev;
882         sfb->pdata = pd;
883
884         sfb->bus_clk = clk_get(dev, "lcd");
885         if (IS_ERR(sfb->bus_clk)) {
886                 dev_err(dev, "failed to get bus clock\n");
887                 goto err_sfb;
888         }
889
890         clk_enable(sfb->bus_clk);
891
892         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
893         if (!res) {
894                 dev_err(dev, "failed to find registers\n");
895                 ret = -ENOENT;
896                 goto err_clk;
897         }
898
899         sfb->regs_res = request_mem_region(res->start, resource_size(res),
900                                            dev_name(dev));
901         if (!sfb->regs_res) {
902                 dev_err(dev, "failed to claim register region\n");
903                 ret = -ENOENT;
904                 goto err_clk;
905         }
906
907         sfb->regs = ioremap(res->start, resource_size(res));
908         if (!sfb->regs) {
909                 dev_err(dev, "failed to map registers\n");
910                 ret = -ENXIO;
911                 goto err_req_region;
912         }
913
914         dev_dbg(dev, "got resources (regs %p), probing windows\n", sfb->regs);
915
916         /* setup gpio and output polarity controls */
917
918         pd->setup_gpio();
919
920         writel(pd->vidcon1, sfb->regs + VIDCON1);
921
922         /* zero all windows before we do anything */
923
924         for (win = 0; win < S3C_FB_MAX_WIN; win++)
925                 s3c_fb_clear_win(sfb, win);
926
927         /* we have the register setup, start allocating framebuffers */
928
929         for (win = 0; win < S3C_FB_MAX_WIN; win++) {
930                 if (!pd->win[win])
931                         continue;
932
933                 ret = s3c_fb_probe_win(sfb, win, &sfb->windows[win]);
934                 if (ret < 0) {
935                         dev_err(dev, "failed to create window %d\n", win);
936                         for (; win >= 0; win--)
937                                 s3c_fb_release_win(sfb, sfb->windows[win]);
938                         goto err_ioremap;
939                 }
940         }
941
942         platform_set_drvdata(pdev, sfb);
943
944         return 0;
945
946 err_ioremap:
947         iounmap(sfb->regs);
948
949 err_req_region:
950         release_resource(sfb->regs_res);
951         kfree(sfb->regs_res);
952
953 err_clk:
954         clk_disable(sfb->bus_clk);
955         clk_put(sfb->bus_clk);
956
957 err_sfb:
958         kfree(sfb);
959         return ret;
960 }
961
962 /**
963  * s3c_fb_remove() - Cleanup on module finalisation
964  * @pdev: The platform device we are bound to.
965  *
966  * Shutdown and then release all the resources that the driver allocated
967  * on initialisation.
968  */
969 static int __devexit s3c_fb_remove(struct platform_device *pdev)
970 {
971         struct s3c_fb *sfb = platform_get_drvdata(pdev);
972         int win;
973
974         for (win = 0; win <= S3C_FB_MAX_WIN; win++)
975                 if (sfb->windows[win])
976                         s3c_fb_release_win(sfb, sfb->windows[win]);
977
978         iounmap(sfb->regs);
979
980         clk_disable(sfb->bus_clk);
981         clk_put(sfb->bus_clk);
982
983         release_resource(sfb->regs_res);
984         kfree(sfb->regs_res);
985
986         kfree(sfb);
987
988         return 0;
989 }
990
991 #ifdef CONFIG_PM
992 static int s3c_fb_suspend(struct platform_device *pdev, pm_message_t state)
993 {
994         struct s3c_fb *sfb = platform_get_drvdata(pdev);
995         struct s3c_fb_win *win;
996         int win_no;
997
998         for (win_no = S3C_FB_MAX_WIN; win_no >= 0; win_no--) {
999                 win = sfb->windows[win_no];
1000                 if (!win)
1001                         continue;
1002
1003                 /* use the blank function to push into power-down */
1004                 s3c_fb_blank(FB_BLANK_POWERDOWN, win->fbinfo);
1005         }
1006
1007         clk_disable(sfb->bus_clk);
1008         return 0;
1009 }
1010
1011 static int s3c_fb_resume(struct platform_device *pdev)
1012 {
1013         struct s3c_fb *sfb = platform_get_drvdata(pdev);
1014         struct s3c_fb_platdata *pd = sfb->pdata;
1015         struct s3c_fb_win *win;
1016         int win_no;
1017
1018         clk_enable(sfb->bus_clk);
1019
1020         /* setup registers */
1021         writel(pd->vidcon1, sfb->regs + VIDCON1);
1022
1023         /* zero all windows before we do anything */
1024         for (win_no = 0; win_no < S3C_FB_MAX_WIN; win_no++)
1025                 s3c_fb_clear_win(sfb, win_no);
1026
1027         /* restore framebuffers */
1028         for (win_no = 0; win_no < S3C_FB_MAX_WIN; win_no++) {
1029                 win = sfb->windows[win_no];
1030                 if (!win)
1031                         continue;
1032
1033                 dev_dbg(&pdev->dev, "resuming window %d\n", win_no);
1034                 s3c_fb_set_par(win->fbinfo);
1035         }
1036
1037         return 0;
1038 }
1039 #else
1040 #define s3c_fb_suspend NULL
1041 #define s3c_fb_resume  NULL
1042 #endif
1043
1044 static struct platform_driver s3c_fb_driver = {
1045         .probe          = s3c_fb_probe,
1046         .remove         = s3c_fb_remove,
1047         .suspend        = s3c_fb_suspend,
1048         .resume         = s3c_fb_resume,
1049         .driver         = {
1050                 .name   = "s3c-fb",
1051                 .owner  = THIS_MODULE,
1052         },
1053 };
1054
1055 static int __init s3c_fb_init(void)
1056 {
1057         return platform_driver_register(&s3c_fb_driver);
1058 }
1059
1060 static void __exit s3c_fb_cleanup(void)
1061 {
1062         platform_driver_unregister(&s3c_fb_driver);
1063 }
1064
1065 module_init(s3c_fb_init);
1066 module_exit(s3c_fb_cleanup);
1067
1068 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
1069 MODULE_DESCRIPTION("Samsung S3C SoC Framebuffer driver");
1070 MODULE_LICENSE("GPL");
1071 MODULE_ALIAS("platform:s3c-fb");