Merge branch 'fix/hda' into for-linus
[pandora-kernel.git] / drivers / video / atmel_lcdfb.c
1 /*
2  *  Driver for AT91/AT32 LCD Controller
3  *
4  *  Copyright (C) 2007 Atmel Corporation
5  *
6  * This file is subject to the terms and conditions of the GNU General Public
7  * License.  See the file COPYING in the main directory of this archive for
8  * more details.
9  */
10
11 #include <linux/kernel.h>
12 #include <linux/platform_device.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/interrupt.h>
15 #include <linux/clk.h>
16 #include <linux/fb.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/backlight.h>
20
21 #include <mach/board.h>
22 #include <mach/cpu.h>
23 #include <mach/gpio.h>
24
25 #include <video/atmel_lcdc.h>
26
27 #define lcdc_readl(sinfo, reg)          __raw_readl((sinfo)->mmio+(reg))
28 #define lcdc_writel(sinfo, reg, val)    __raw_writel((val), (sinfo)->mmio+(reg))
29
30 /* configurable parameters */
31 #define ATMEL_LCDC_CVAL_DEFAULT         0xc8
32 #define ATMEL_LCDC_DMA_BURST_LEN        8       /* words */
33 #define ATMEL_LCDC_FIFO_SIZE            512     /* words */
34
35 #if defined(CONFIG_ARCH_AT91)
36 #define ATMEL_LCDFB_FBINFO_DEFAULT      (FBINFO_DEFAULT \
37                                          | FBINFO_PARTIAL_PAN_OK \
38                                          | FBINFO_HWACCEL_YPAN)
39
40 static inline void atmel_lcdfb_update_dma2d(struct atmel_lcdfb_info *sinfo,
41                                         struct fb_var_screeninfo *var)
42 {
43
44 }
45 #elif defined(CONFIG_AVR32)
46 #define ATMEL_LCDFB_FBINFO_DEFAULT      (FBINFO_DEFAULT \
47                                         | FBINFO_PARTIAL_PAN_OK \
48                                         | FBINFO_HWACCEL_XPAN \
49                                         | FBINFO_HWACCEL_YPAN)
50
51 static void atmel_lcdfb_update_dma2d(struct atmel_lcdfb_info *sinfo,
52                                      struct fb_var_screeninfo *var)
53 {
54         u32 dma2dcfg;
55         u32 pixeloff;
56
57         pixeloff = (var->xoffset * var->bits_per_pixel) & 0x1f;
58
59         dma2dcfg = ((var->xres_virtual - var->xres) * var->bits_per_pixel) / 8;
60         dma2dcfg |= pixeloff << ATMEL_LCDC_PIXELOFF_OFFSET;
61         lcdc_writel(sinfo, ATMEL_LCDC_DMA2DCFG, dma2dcfg);
62
63         /* Update configuration */
64         lcdc_writel(sinfo, ATMEL_LCDC_DMACON,
65                     lcdc_readl(sinfo, ATMEL_LCDC_DMACON)
66                     | ATMEL_LCDC_DMAUPDT);
67 }
68 #endif
69
70 static const u32 contrast_ctr = ATMEL_LCDC_PS_DIV8
71                 | ATMEL_LCDC_POL_POSITIVE
72                 | ATMEL_LCDC_ENA_PWMENABLE;
73
74 #ifdef CONFIG_BACKLIGHT_ATMEL_LCDC
75
76 /* some bl->props field just changed */
77 static int atmel_bl_update_status(struct backlight_device *bl)
78 {
79         struct atmel_lcdfb_info *sinfo = bl_get_data(bl);
80         int                     power = sinfo->bl_power;
81         int                     brightness = bl->props.brightness;
82
83         /* REVISIT there may be a meaningful difference between
84          * fb_blank and power ... there seem to be some cases
85          * this doesn't handle correctly.
86          */
87         if (bl->props.fb_blank != sinfo->bl_power)
88                 power = bl->props.fb_blank;
89         else if (bl->props.power != sinfo->bl_power)
90                 power = bl->props.power;
91
92         if (brightness < 0 && power == FB_BLANK_UNBLANK)
93                 brightness = lcdc_readl(sinfo, ATMEL_LCDC_CONTRAST_VAL);
94         else if (power != FB_BLANK_UNBLANK)
95                 brightness = 0;
96
97         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_VAL, brightness);
98         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_CTR,
99                         brightness ? contrast_ctr : 0);
100
101         bl->props.fb_blank = bl->props.power = sinfo->bl_power = power;
102
103         return 0;
104 }
105
106 static int atmel_bl_get_brightness(struct backlight_device *bl)
107 {
108         struct atmel_lcdfb_info *sinfo = bl_get_data(bl);
109
110         return lcdc_readl(sinfo, ATMEL_LCDC_CONTRAST_VAL);
111 }
112
113 static struct backlight_ops atmel_lcdc_bl_ops = {
114         .update_status = atmel_bl_update_status,
115         .get_brightness = atmel_bl_get_brightness,
116 };
117
118 static void init_backlight(struct atmel_lcdfb_info *sinfo)
119 {
120         struct backlight_device *bl;
121
122         sinfo->bl_power = FB_BLANK_UNBLANK;
123
124         if (sinfo->backlight)
125                 return;
126
127         bl = backlight_device_register("backlight", &sinfo->pdev->dev,
128                         sinfo, &atmel_lcdc_bl_ops);
129         if (IS_ERR(bl)) {
130                 dev_err(&sinfo->pdev->dev, "error %ld on backlight register\n",
131                                 PTR_ERR(bl));
132                 return;
133         }
134         sinfo->backlight = bl;
135
136         bl->props.power = FB_BLANK_UNBLANK;
137         bl->props.fb_blank = FB_BLANK_UNBLANK;
138         bl->props.max_brightness = 0xff;
139         bl->props.brightness = atmel_bl_get_brightness(bl);
140 }
141
142 static void exit_backlight(struct atmel_lcdfb_info *sinfo)
143 {
144         if (sinfo->backlight)
145                 backlight_device_unregister(sinfo->backlight);
146 }
147
148 #else
149
150 static void init_backlight(struct atmel_lcdfb_info *sinfo)
151 {
152         dev_warn(&sinfo->pdev->dev, "backlight control is not available\n");
153 }
154
155 static void exit_backlight(struct atmel_lcdfb_info *sinfo)
156 {
157 }
158
159 #endif
160
161 static void init_contrast(struct atmel_lcdfb_info *sinfo)
162 {
163         /* have some default contrast/backlight settings */
164         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_CTR, contrast_ctr);
165         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_VAL, ATMEL_LCDC_CVAL_DEFAULT);
166
167         if (sinfo->lcdcon_is_backlight)
168                 init_backlight(sinfo);
169 }
170
171
172 static struct fb_fix_screeninfo atmel_lcdfb_fix __initdata = {
173         .type           = FB_TYPE_PACKED_PIXELS,
174         .visual         = FB_VISUAL_TRUECOLOR,
175         .xpanstep       = 0,
176         .ypanstep       = 1,
177         .ywrapstep      = 0,
178         .accel          = FB_ACCEL_NONE,
179 };
180
181 static unsigned long compute_hozval(unsigned long xres, unsigned long lcdcon2)
182 {
183         unsigned long value;
184
185         if (!(cpu_is_at91sam9261() || cpu_is_at32ap7000()))
186                 return xres;
187
188         value = xres;
189         if ((lcdcon2 & ATMEL_LCDC_DISTYPE) != ATMEL_LCDC_DISTYPE_TFT) {
190                 /* STN display */
191                 if ((lcdcon2 & ATMEL_LCDC_DISTYPE) == ATMEL_LCDC_DISTYPE_STNCOLOR) {
192                         value *= 3;
193                 }
194                 if ( (lcdcon2 & ATMEL_LCDC_IFWIDTH) == ATMEL_LCDC_IFWIDTH_4
195                    || ( (lcdcon2 & ATMEL_LCDC_IFWIDTH) == ATMEL_LCDC_IFWIDTH_8
196                       && (lcdcon2 & ATMEL_LCDC_SCANMOD) == ATMEL_LCDC_SCANMOD_DUAL ))
197                         value = DIV_ROUND_UP(value, 4);
198                 else
199                         value = DIV_ROUND_UP(value, 8);
200         }
201
202         return value;
203 }
204
205 static void atmel_lcdfb_stop_nowait(struct atmel_lcdfb_info *sinfo)
206 {
207         /* Turn off the LCD controller and the DMA controller */
208         lcdc_writel(sinfo, ATMEL_LCDC_PWRCON,
209                         sinfo->guard_time << ATMEL_LCDC_GUARDT_OFFSET);
210
211         /* Wait for the LCDC core to become idle */
212         while (lcdc_readl(sinfo, ATMEL_LCDC_PWRCON) & ATMEL_LCDC_BUSY)
213                 msleep(10);
214
215         lcdc_writel(sinfo, ATMEL_LCDC_DMACON, 0);
216 }
217
218 static void atmel_lcdfb_stop(struct atmel_lcdfb_info *sinfo)
219 {
220         atmel_lcdfb_stop_nowait(sinfo);
221
222         /* Wait for DMA engine to become idle... */
223         while (lcdc_readl(sinfo, ATMEL_LCDC_DMACON) & ATMEL_LCDC_DMABUSY)
224                 msleep(10);
225 }
226
227 static void atmel_lcdfb_start(struct atmel_lcdfb_info *sinfo)
228 {
229         lcdc_writel(sinfo, ATMEL_LCDC_DMACON, sinfo->default_dmacon);
230         lcdc_writel(sinfo, ATMEL_LCDC_PWRCON,
231                 (sinfo->guard_time << ATMEL_LCDC_GUARDT_OFFSET)
232                 | ATMEL_LCDC_PWR);
233 }
234
235 static void atmel_lcdfb_update_dma(struct fb_info *info,
236                                struct fb_var_screeninfo *var)
237 {
238         struct atmel_lcdfb_info *sinfo = info->par;
239         struct fb_fix_screeninfo *fix = &info->fix;
240         unsigned long dma_addr;
241
242         dma_addr = (fix->smem_start + var->yoffset * fix->line_length
243                     + var->xoffset * var->bits_per_pixel / 8);
244
245         dma_addr &= ~3UL;
246
247         /* Set framebuffer DMA base address and pixel offset */
248         lcdc_writel(sinfo, ATMEL_LCDC_DMABADDR1, dma_addr);
249
250         atmel_lcdfb_update_dma2d(sinfo, var);
251 }
252
253 static inline void atmel_lcdfb_free_video_memory(struct atmel_lcdfb_info *sinfo)
254 {
255         struct fb_info *info = sinfo->info;
256
257         dma_free_writecombine(info->device, info->fix.smem_len,
258                                 info->screen_base, info->fix.smem_start);
259 }
260
261 /**
262  *      atmel_lcdfb_alloc_video_memory - Allocate framebuffer memory
263  *      @sinfo: the frame buffer to allocate memory for
264  *      
265  *      This function is called only from the atmel_lcdfb_probe()
266  *      so no locking by fb_info->mm_lock around smem_len setting is needed.
267  */
268 static int atmel_lcdfb_alloc_video_memory(struct atmel_lcdfb_info *sinfo)
269 {
270         struct fb_info *info = sinfo->info;
271         struct fb_var_screeninfo *var = &info->var;
272         unsigned int smem_len;
273
274         smem_len = (var->xres_virtual * var->yres_virtual
275                     * ((var->bits_per_pixel + 7) / 8));
276         info->fix.smem_len = max(smem_len, sinfo->smem_len);
277
278         info->screen_base = dma_alloc_writecombine(info->device, info->fix.smem_len,
279                                         (dma_addr_t *)&info->fix.smem_start, GFP_KERNEL);
280
281         if (!info->screen_base) {
282                 return -ENOMEM;
283         }
284
285         memset(info->screen_base, 0, info->fix.smem_len);
286
287         return 0;
288 }
289
290 static const struct fb_videomode *atmel_lcdfb_choose_mode(struct fb_var_screeninfo *var,
291                                                      struct fb_info *info)
292 {
293         struct fb_videomode varfbmode;
294         const struct fb_videomode *fbmode = NULL;
295
296         fb_var_to_videomode(&varfbmode, var);
297         fbmode = fb_find_nearest_mode(&varfbmode, &info->modelist);
298         if (fbmode)
299                 fb_videomode_to_var(var, fbmode);
300         return fbmode;
301 }
302
303
304 /**
305  *      atmel_lcdfb_check_var - Validates a var passed in.
306  *      @var: frame buffer variable screen structure
307  *      @info: frame buffer structure that represents a single frame buffer
308  *
309  *      Checks to see if the hardware supports the state requested by
310  *      var passed in. This function does not alter the hardware
311  *      state!!!  This means the data stored in struct fb_info and
312  *      struct atmel_lcdfb_info do not change. This includes the var
313  *      inside of struct fb_info.  Do NOT change these. This function
314  *      can be called on its own if we intent to only test a mode and
315  *      not actually set it. The stuff in modedb.c is a example of
316  *      this. If the var passed in is slightly off by what the
317  *      hardware can support then we alter the var PASSED in to what
318  *      we can do. If the hardware doesn't support mode change a
319  *      -EINVAL will be returned by the upper layers. You don't need
320  *      to implement this function then. If you hardware doesn't
321  *      support changing the resolution then this function is not
322  *      needed. In this case the driver would just provide a var that
323  *      represents the static state the screen is in.
324  *
325  *      Returns negative errno on error, or zero on success.
326  */
327 static int atmel_lcdfb_check_var(struct fb_var_screeninfo *var,
328                              struct fb_info *info)
329 {
330         struct device *dev = info->device;
331         struct atmel_lcdfb_info *sinfo = info->par;
332         unsigned long clk_value_khz;
333
334         clk_value_khz = clk_get_rate(sinfo->lcdc_clk) / 1000;
335
336         dev_dbg(dev, "%s:\n", __func__);
337
338         if (!(var->pixclock && var->bits_per_pixel)) {
339                 /* choose a suitable mode if possible */
340                 if (!atmel_lcdfb_choose_mode(var, info)) {
341                         dev_err(dev, "needed value not specified\n");
342                         return -EINVAL;
343                 }
344         }
345
346         dev_dbg(dev, "  resolution: %ux%u\n", var->xres, var->yres);
347         dev_dbg(dev, "  pixclk:     %lu KHz\n", PICOS2KHZ(var->pixclock));
348         dev_dbg(dev, "  bpp:        %u\n", var->bits_per_pixel);
349         dev_dbg(dev, "  clk:        %lu KHz\n", clk_value_khz);
350
351         if (PICOS2KHZ(var->pixclock) > clk_value_khz) {
352                 dev_err(dev, "%lu KHz pixel clock is too fast\n", PICOS2KHZ(var->pixclock));
353                 return -EINVAL;
354         }
355
356         /* Do not allow to have real resoulution larger than virtual */
357         if (var->xres > var->xres_virtual)
358                 var->xres_virtual = var->xres;
359
360         if (var->yres > var->yres_virtual)
361                 var->yres_virtual = var->yres;
362
363         /* Force same alignment for each line */
364         var->xres = (var->xres + 3) & ~3UL;
365         var->xres_virtual = (var->xres_virtual + 3) & ~3UL;
366
367         var->red.msb_right = var->green.msb_right = var->blue.msb_right = 0;
368         var->transp.msb_right = 0;
369         var->transp.offset = var->transp.length = 0;
370         var->xoffset = var->yoffset = 0;
371
372         if (info->fix.smem_len) {
373                 unsigned int smem_len = (var->xres_virtual * var->yres_virtual
374                                          * ((var->bits_per_pixel + 7) / 8));
375                 if (smem_len > info->fix.smem_len)
376                         return -EINVAL;
377         }
378
379         /* Saturate vertical and horizontal timings at maximum values */
380         var->vsync_len = min_t(u32, var->vsync_len,
381                         (ATMEL_LCDC_VPW >> ATMEL_LCDC_VPW_OFFSET) + 1);
382         var->upper_margin = min_t(u32, var->upper_margin,
383                         ATMEL_LCDC_VBP >> ATMEL_LCDC_VBP_OFFSET);
384         var->lower_margin = min_t(u32, var->lower_margin,
385                         ATMEL_LCDC_VFP);
386         var->right_margin = min_t(u32, var->right_margin,
387                         (ATMEL_LCDC_HFP >> ATMEL_LCDC_HFP_OFFSET) + 1);
388         var->hsync_len = min_t(u32, var->hsync_len,
389                         (ATMEL_LCDC_HPW >> ATMEL_LCDC_HPW_OFFSET) + 1);
390         var->left_margin = min_t(u32, var->left_margin,
391                         ATMEL_LCDC_HBP + 1);
392
393         /* Some parameters can't be zero */
394         var->vsync_len = max_t(u32, var->vsync_len, 1);
395         var->right_margin = max_t(u32, var->right_margin, 1);
396         var->hsync_len = max_t(u32, var->hsync_len, 1);
397         var->left_margin = max_t(u32, var->left_margin, 1);
398
399         switch (var->bits_per_pixel) {
400         case 1:
401         case 2:
402         case 4:
403         case 8:
404                 var->red.offset = var->green.offset = var->blue.offset = 0;
405                 var->red.length = var->green.length = var->blue.length
406                         = var->bits_per_pixel;
407                 break;
408         case 15:
409         case 16:
410                 if (sinfo->lcd_wiring_mode == ATMEL_LCDC_WIRING_RGB) {
411                         /* RGB:565 mode */
412                         var->red.offset = 11;
413                         var->blue.offset = 0;
414                         var->green.length = 6;
415                 } else if (sinfo->lcd_wiring_mode == ATMEL_LCDC_WIRING_RGB555) {
416                         var->red.offset = 10;
417                         var->blue.offset = 0;
418                         var->green.length = 5;
419                 } else {
420                         /* BGR:555 mode */
421                         var->red.offset = 0;
422                         var->blue.offset = 10;
423                         var->green.length = 5;
424                 }
425                 var->green.offset = 5;
426                 var->red.length = var->blue.length = 5;
427                 break;
428         case 32:
429                 var->transp.offset = 24;
430                 var->transp.length = 8;
431                 /* fall through */
432         case 24:
433                 if (sinfo->lcd_wiring_mode == ATMEL_LCDC_WIRING_RGB) {
434                         /* RGB:888 mode */
435                         var->red.offset = 16;
436                         var->blue.offset = 0;
437                 } else {
438                         /* BGR:888 mode */
439                         var->red.offset = 0;
440                         var->blue.offset = 16;
441                 }
442                 var->green.offset = 8;
443                 var->red.length = var->green.length = var->blue.length = 8;
444                 break;
445         default:
446                 dev_err(dev, "color depth %d not supported\n",
447                                         var->bits_per_pixel);
448                 return -EINVAL;
449         }
450
451         return 0;
452 }
453
454 /*
455  * LCD reset sequence
456  */
457 static void atmel_lcdfb_reset(struct atmel_lcdfb_info *sinfo)
458 {
459         might_sleep();
460
461         atmel_lcdfb_stop(sinfo);
462         atmel_lcdfb_start(sinfo);
463 }
464
465 /**
466  *      atmel_lcdfb_set_par - Alters the hardware state.
467  *      @info: frame buffer structure that represents a single frame buffer
468  *
469  *      Using the fb_var_screeninfo in fb_info we set the resolution
470  *      of the this particular framebuffer. This function alters the
471  *      par AND the fb_fix_screeninfo stored in fb_info. It doesn't
472  *      not alter var in fb_info since we are using that data. This
473  *      means we depend on the data in var inside fb_info to be
474  *      supported by the hardware.  atmel_lcdfb_check_var is always called
475  *      before atmel_lcdfb_set_par to ensure this.  Again if you can't
476  *      change the resolution you don't need this function.
477  *
478  */
479 static int atmel_lcdfb_set_par(struct fb_info *info)
480 {
481         struct atmel_lcdfb_info *sinfo = info->par;
482         unsigned long hozval_linesz;
483         unsigned long value;
484         unsigned long clk_value_khz;
485         unsigned long bits_per_line;
486
487         might_sleep();
488
489         dev_dbg(info->device, "%s:\n", __func__);
490         dev_dbg(info->device, "  * resolution: %ux%u (%ux%u virtual)\n",
491                  info->var.xres, info->var.yres,
492                  info->var.xres_virtual, info->var.yres_virtual);
493
494         atmel_lcdfb_stop_nowait(sinfo);
495
496         if (info->var.bits_per_pixel == 1)
497                 info->fix.visual = FB_VISUAL_MONO01;
498         else if (info->var.bits_per_pixel <= 8)
499                 info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
500         else
501                 info->fix.visual = FB_VISUAL_TRUECOLOR;
502
503         bits_per_line = info->var.xres_virtual * info->var.bits_per_pixel;
504         info->fix.line_length = DIV_ROUND_UP(bits_per_line, 8);
505
506         /* Re-initialize the DMA engine... */
507         dev_dbg(info->device, "  * update DMA engine\n");
508         atmel_lcdfb_update_dma(info, &info->var);
509
510         /* ...set frame size and burst length = 8 words (?) */
511         value = (info->var.yres * info->var.xres * info->var.bits_per_pixel) / 32;
512         value |= ((ATMEL_LCDC_DMA_BURST_LEN - 1) << ATMEL_LCDC_BLENGTH_OFFSET);
513         lcdc_writel(sinfo, ATMEL_LCDC_DMAFRMCFG, value);
514
515         /* Now, the LCDC core... */
516
517         /* Set pixel clock */
518         clk_value_khz = clk_get_rate(sinfo->lcdc_clk) / 1000;
519
520         value = DIV_ROUND_UP(clk_value_khz, PICOS2KHZ(info->var.pixclock));
521
522         if (value < 2) {
523                 dev_notice(info->device, "Bypassing pixel clock divider\n");
524                 lcdc_writel(sinfo, ATMEL_LCDC_LCDCON1, ATMEL_LCDC_BYPASS);
525         } else {
526                 value = (value / 2) - 1;
527                 dev_dbg(info->device, "  * programming CLKVAL = 0x%08lx\n",
528                                 value);
529                 lcdc_writel(sinfo, ATMEL_LCDC_LCDCON1,
530                                 value << ATMEL_LCDC_CLKVAL_OFFSET);
531                 info->var.pixclock = KHZ2PICOS(clk_value_khz / (2 * (value + 1)));
532                 dev_dbg(info->device, "  updated pixclk:     %lu KHz\n",
533                                         PICOS2KHZ(info->var.pixclock));
534         }
535
536
537         /* Initialize control register 2 */
538         value = sinfo->default_lcdcon2;
539
540         if (!(info->var.sync & FB_SYNC_HOR_HIGH_ACT))
541                 value |= ATMEL_LCDC_INVLINE_INVERTED;
542         if (!(info->var.sync & FB_SYNC_VERT_HIGH_ACT))
543                 value |= ATMEL_LCDC_INVFRAME_INVERTED;
544
545         switch (info->var.bits_per_pixel) {
546                 case 1: value |= ATMEL_LCDC_PIXELSIZE_1; break;
547                 case 2: value |= ATMEL_LCDC_PIXELSIZE_2; break;
548                 case 4: value |= ATMEL_LCDC_PIXELSIZE_4; break;
549                 case 8: value |= ATMEL_LCDC_PIXELSIZE_8; break;
550                 case 15: /* fall through */
551                 case 16: value |= ATMEL_LCDC_PIXELSIZE_16; break;
552                 case 24: value |= ATMEL_LCDC_PIXELSIZE_24; break;
553                 case 32: value |= ATMEL_LCDC_PIXELSIZE_32; break;
554                 default: BUG(); break;
555         }
556         dev_dbg(info->device, "  * LCDCON2 = %08lx\n", value);
557         lcdc_writel(sinfo, ATMEL_LCDC_LCDCON2, value);
558
559         /* Vertical timing */
560         value = (info->var.vsync_len - 1) << ATMEL_LCDC_VPW_OFFSET;
561         value |= info->var.upper_margin << ATMEL_LCDC_VBP_OFFSET;
562         value |= info->var.lower_margin;
563         dev_dbg(info->device, "  * LCDTIM1 = %08lx\n", value);
564         lcdc_writel(sinfo, ATMEL_LCDC_TIM1, value);
565
566         /* Horizontal timing */
567         value = (info->var.right_margin - 1) << ATMEL_LCDC_HFP_OFFSET;
568         value |= (info->var.hsync_len - 1) << ATMEL_LCDC_HPW_OFFSET;
569         value |= (info->var.left_margin - 1);
570         dev_dbg(info->device, "  * LCDTIM2 = %08lx\n", value);
571         lcdc_writel(sinfo, ATMEL_LCDC_TIM2, value);
572
573         /* Horizontal value (aka line size) */
574         hozval_linesz = compute_hozval(info->var.xres,
575                                         lcdc_readl(sinfo, ATMEL_LCDC_LCDCON2));
576
577         /* Display size */
578         value = (hozval_linesz - 1) << ATMEL_LCDC_HOZVAL_OFFSET;
579         value |= info->var.yres - 1;
580         dev_dbg(info->device, "  * LCDFRMCFG = %08lx\n", value);
581         lcdc_writel(sinfo, ATMEL_LCDC_LCDFRMCFG, value);
582
583         /* FIFO Threshold: Use formula from data sheet */
584         value = ATMEL_LCDC_FIFO_SIZE - (2 * ATMEL_LCDC_DMA_BURST_LEN + 3);
585         lcdc_writel(sinfo, ATMEL_LCDC_FIFO, value);
586
587         /* Toggle LCD_MODE every frame */
588         lcdc_writel(sinfo, ATMEL_LCDC_MVAL, 0);
589
590         /* Disable all interrupts */
591         lcdc_writel(sinfo, ATMEL_LCDC_IDR, ~0UL);
592         /* Enable FIFO & DMA errors */
593         lcdc_writel(sinfo, ATMEL_LCDC_IER, ATMEL_LCDC_UFLWI | ATMEL_LCDC_OWRI | ATMEL_LCDC_MERI);
594
595         /* ...wait for DMA engine to become idle... */
596         while (lcdc_readl(sinfo, ATMEL_LCDC_DMACON) & ATMEL_LCDC_DMABUSY)
597                 msleep(10);
598
599         atmel_lcdfb_start(sinfo);
600
601         dev_dbg(info->device, "  * DONE\n");
602
603         return 0;
604 }
605
606 static inline unsigned int chan_to_field(unsigned int chan, const struct fb_bitfield *bf)
607 {
608         chan &= 0xffff;
609         chan >>= 16 - bf->length;
610         return chan << bf->offset;
611 }
612
613 /**
614  *      atmel_lcdfb_setcolreg - Optional function. Sets a color register.
615  *      @regno: Which register in the CLUT we are programming
616  *      @red: The red value which can be up to 16 bits wide
617  *      @green: The green value which can be up to 16 bits wide
618  *      @blue:  The blue value which can be up to 16 bits wide.
619  *      @transp: If supported the alpha value which can be up to 16 bits wide.
620  *      @info: frame buffer info structure
621  *
622  *      Set a single color register. The values supplied have a 16 bit
623  *      magnitude which needs to be scaled in this function for the hardware.
624  *      Things to take into consideration are how many color registers, if
625  *      any, are supported with the current color visual. With truecolor mode
626  *      no color palettes are supported. Here a psuedo palette is created
627  *      which we store the value in pseudo_palette in struct fb_info. For
628  *      pseudocolor mode we have a limited color palette. To deal with this
629  *      we can program what color is displayed for a particular pixel value.
630  *      DirectColor is similar in that we can program each color field. If
631  *      we have a static colormap we don't need to implement this function.
632  *
633  *      Returns negative errno on error, or zero on success. In an
634  *      ideal world, this would have been the case, but as it turns
635  *      out, the other drivers return 1 on failure, so that's what
636  *      we're going to do.
637  */
638 static int atmel_lcdfb_setcolreg(unsigned int regno, unsigned int red,
639                              unsigned int green, unsigned int blue,
640                              unsigned int transp, struct fb_info *info)
641 {
642         struct atmel_lcdfb_info *sinfo = info->par;
643         unsigned int val;
644         u32 *pal;
645         int ret = 1;
646
647         if (info->var.grayscale)
648                 red = green = blue = (19595 * red + 38470 * green
649                                       + 7471 * blue) >> 16;
650
651         switch (info->fix.visual) {
652         case FB_VISUAL_TRUECOLOR:
653                 if (regno < 16) {
654                         pal = info->pseudo_palette;
655
656                         val  = chan_to_field(red, &info->var.red);
657                         val |= chan_to_field(green, &info->var.green);
658                         val |= chan_to_field(blue, &info->var.blue);
659
660                         pal[regno] = val;
661                         ret = 0;
662                 }
663                 break;
664
665         case FB_VISUAL_PSEUDOCOLOR:
666                 if (regno < 256) {
667                         val  = ((red   >> 11) & 0x001f);
668                         val |= ((green >>  6) & 0x03e0);
669                         val |= ((blue  >>  1) & 0x7c00);
670
671                         /*
672                          * TODO: intensity bit. Maybe something like
673                          *   ~(red[10] ^ green[10] ^ blue[10]) & 1
674                          */
675
676                         lcdc_writel(sinfo, ATMEL_LCDC_LUT(regno), val);
677                         ret = 0;
678                 }
679                 break;
680
681         case FB_VISUAL_MONO01:
682                 if (regno < 2) {
683                         val = (regno == 0) ? 0x00 : 0x1F;
684                         lcdc_writel(sinfo, ATMEL_LCDC_LUT(regno), val);
685                         ret = 0;
686                 }
687                 break;
688
689         }
690
691         return ret;
692 }
693
694 static int atmel_lcdfb_pan_display(struct fb_var_screeninfo *var,
695                                struct fb_info *info)
696 {
697         dev_dbg(info->device, "%s\n", __func__);
698
699         atmel_lcdfb_update_dma(info, var);
700
701         return 0;
702 }
703
704 static struct fb_ops atmel_lcdfb_ops = {
705         .owner          = THIS_MODULE,
706         .fb_check_var   = atmel_lcdfb_check_var,
707         .fb_set_par     = atmel_lcdfb_set_par,
708         .fb_setcolreg   = atmel_lcdfb_setcolreg,
709         .fb_pan_display = atmel_lcdfb_pan_display,
710         .fb_fillrect    = cfb_fillrect,
711         .fb_copyarea    = cfb_copyarea,
712         .fb_imageblit   = cfb_imageblit,
713 };
714
715 static irqreturn_t atmel_lcdfb_interrupt(int irq, void *dev_id)
716 {
717         struct fb_info *info = dev_id;
718         struct atmel_lcdfb_info *sinfo = info->par;
719         u32 status;
720
721         status = lcdc_readl(sinfo, ATMEL_LCDC_ISR);
722         if (status & ATMEL_LCDC_UFLWI) {
723                 dev_warn(info->device, "FIFO underflow %#x\n", status);
724                 /* reset DMA and FIFO to avoid screen shifting */
725                 schedule_work(&sinfo->task);
726         }
727         lcdc_writel(sinfo, ATMEL_LCDC_ICR, status);
728         return IRQ_HANDLED;
729 }
730
731 /*
732  * LCD controller task (to reset the LCD)
733  */
734 static void atmel_lcdfb_task(struct work_struct *work)
735 {
736         struct atmel_lcdfb_info *sinfo =
737                 container_of(work, struct atmel_lcdfb_info, task);
738
739         atmel_lcdfb_reset(sinfo);
740 }
741
742 static int __init atmel_lcdfb_init_fbinfo(struct atmel_lcdfb_info *sinfo)
743 {
744         struct fb_info *info = sinfo->info;
745         int ret = 0;
746
747         info->var.activate |= FB_ACTIVATE_FORCE | FB_ACTIVATE_NOW;
748
749         dev_info(info->device,
750                "%luKiB frame buffer at %08lx (mapped at %p)\n",
751                (unsigned long)info->fix.smem_len / 1024,
752                (unsigned long)info->fix.smem_start,
753                info->screen_base);
754
755         /* Allocate colormap */
756         ret = fb_alloc_cmap(&info->cmap, 256, 0);
757         if (ret < 0)
758                 dev_err(info->device, "Alloc color map failed\n");
759
760         return ret;
761 }
762
763 static void atmel_lcdfb_start_clock(struct atmel_lcdfb_info *sinfo)
764 {
765         if (sinfo->bus_clk)
766                 clk_enable(sinfo->bus_clk);
767         clk_enable(sinfo->lcdc_clk);
768 }
769
770 static void atmel_lcdfb_stop_clock(struct atmel_lcdfb_info *sinfo)
771 {
772         if (sinfo->bus_clk)
773                 clk_disable(sinfo->bus_clk);
774         clk_disable(sinfo->lcdc_clk);
775 }
776
777
778 static int __init atmel_lcdfb_probe(struct platform_device *pdev)
779 {
780         struct device *dev = &pdev->dev;
781         struct fb_info *info;
782         struct atmel_lcdfb_info *sinfo;
783         struct atmel_lcdfb_info *pdata_sinfo;
784         struct fb_videomode fbmode;
785         struct resource *regs = NULL;
786         struct resource *map = NULL;
787         int ret;
788
789         dev_dbg(dev, "%s BEGIN\n", __func__);
790
791         ret = -ENOMEM;
792         info = framebuffer_alloc(sizeof(struct atmel_lcdfb_info), dev);
793         if (!info) {
794                 dev_err(dev, "cannot allocate memory\n");
795                 goto out;
796         }
797
798         sinfo = info->par;
799
800         if (dev->platform_data) {
801                 pdata_sinfo = (struct atmel_lcdfb_info *)dev->platform_data;
802                 sinfo->default_bpp = pdata_sinfo->default_bpp;
803                 sinfo->default_dmacon = pdata_sinfo->default_dmacon;
804                 sinfo->default_lcdcon2 = pdata_sinfo->default_lcdcon2;
805                 sinfo->default_monspecs = pdata_sinfo->default_monspecs;
806                 sinfo->atmel_lcdfb_power_control = pdata_sinfo->atmel_lcdfb_power_control;
807                 sinfo->guard_time = pdata_sinfo->guard_time;
808                 sinfo->smem_len = pdata_sinfo->smem_len;
809                 sinfo->lcdcon_is_backlight = pdata_sinfo->lcdcon_is_backlight;
810                 sinfo->lcd_wiring_mode = pdata_sinfo->lcd_wiring_mode;
811         } else {
812                 dev_err(dev, "cannot get default configuration\n");
813                 goto free_info;
814         }
815         sinfo->info = info;
816         sinfo->pdev = pdev;
817
818         strcpy(info->fix.id, sinfo->pdev->name);
819         info->flags = ATMEL_LCDFB_FBINFO_DEFAULT;
820         info->pseudo_palette = sinfo->pseudo_palette;
821         info->fbops = &atmel_lcdfb_ops;
822
823         memcpy(&info->monspecs, sinfo->default_monspecs, sizeof(info->monspecs));
824         info->fix = atmel_lcdfb_fix;
825
826         /* Enable LCDC Clocks */
827         if (cpu_is_at91sam9261() || cpu_is_at32ap7000()) {
828                 sinfo->bus_clk = clk_get(dev, "hck1");
829                 if (IS_ERR(sinfo->bus_clk)) {
830                         ret = PTR_ERR(sinfo->bus_clk);
831                         goto free_info;
832                 }
833         }
834         sinfo->lcdc_clk = clk_get(dev, "lcdc_clk");
835         if (IS_ERR(sinfo->lcdc_clk)) {
836                 ret = PTR_ERR(sinfo->lcdc_clk);
837                 goto put_bus_clk;
838         }
839         atmel_lcdfb_start_clock(sinfo);
840
841         ret = fb_find_mode(&info->var, info, NULL, info->monspecs.modedb,
842                         info->monspecs.modedb_len, info->monspecs.modedb,
843                         sinfo->default_bpp);
844         if (!ret) {
845                 dev_err(dev, "no suitable video mode found\n");
846                 goto stop_clk;
847         }
848
849
850         regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
851         if (!regs) {
852                 dev_err(dev, "resources unusable\n");
853                 ret = -ENXIO;
854                 goto stop_clk;
855         }
856
857         sinfo->irq_base = platform_get_irq(pdev, 0);
858         if (sinfo->irq_base < 0) {
859                 dev_err(dev, "unable to get irq\n");
860                 ret = sinfo->irq_base;
861                 goto stop_clk;
862         }
863
864         /* Initialize video memory */
865         map = platform_get_resource(pdev, IORESOURCE_MEM, 1);
866         if (map) {
867                 /* use a pre-allocated memory buffer */
868                 info->fix.smem_start = map->start;
869                 info->fix.smem_len = map->end - map->start + 1;
870                 if (!request_mem_region(info->fix.smem_start,
871                                         info->fix.smem_len, pdev->name)) {
872                         ret = -EBUSY;
873                         goto stop_clk;
874                 }
875
876                 info->screen_base = ioremap(info->fix.smem_start, info->fix.smem_len);
877                 if (!info->screen_base)
878                         goto release_intmem;
879
880                 /*
881                  * Don't clear the framebuffer -- someone may have set
882                  * up a splash image.
883                  */
884         } else {
885                 /* alocate memory buffer */
886                 ret = atmel_lcdfb_alloc_video_memory(sinfo);
887                 if (ret < 0) {
888                         dev_err(dev, "cannot allocate framebuffer: %d\n", ret);
889                         goto stop_clk;
890                 }
891         }
892
893         /* LCDC registers */
894         info->fix.mmio_start = regs->start;
895         info->fix.mmio_len = regs->end - regs->start + 1;
896
897         if (!request_mem_region(info->fix.mmio_start,
898                                 info->fix.mmio_len, pdev->name)) {
899                 ret = -EBUSY;
900                 goto free_fb;
901         }
902
903         sinfo->mmio = ioremap(info->fix.mmio_start, info->fix.mmio_len);
904         if (!sinfo->mmio) {
905                 dev_err(dev, "cannot map LCDC registers\n");
906                 goto release_mem;
907         }
908
909         /* Initialize PWM for contrast or backlight ("off") */
910         init_contrast(sinfo);
911
912         /* interrupt */
913         ret = request_irq(sinfo->irq_base, atmel_lcdfb_interrupt, 0, pdev->name, info);
914         if (ret) {
915                 dev_err(dev, "request_irq failed: %d\n", ret);
916                 goto unmap_mmio;
917         }
918
919         /* Some operations on the LCDC might sleep and
920          * require a preemptible task context */
921         INIT_WORK(&sinfo->task, atmel_lcdfb_task);
922
923         ret = atmel_lcdfb_init_fbinfo(sinfo);
924         if (ret < 0) {
925                 dev_err(dev, "init fbinfo failed: %d\n", ret);
926                 goto unregister_irqs;
927         }
928
929         /*
930          * This makes sure that our colour bitfield
931          * descriptors are correctly initialised.
932          */
933         atmel_lcdfb_check_var(&info->var, info);
934
935         ret = fb_set_var(info, &info->var);
936         if (ret) {
937                 dev_warn(dev, "unable to set display parameters\n");
938                 goto free_cmap;
939         }
940
941         dev_set_drvdata(dev, info);
942
943         /*
944          * Tell the world that we're ready to go
945          */
946         ret = register_framebuffer(info);
947         if (ret < 0) {
948                 dev_err(dev, "failed to register framebuffer device: %d\n", ret);
949                 goto reset_drvdata;
950         }
951
952         /* add selected videomode to modelist */
953         fb_var_to_videomode(&fbmode, &info->var);
954         fb_add_videomode(&fbmode, &info->modelist);
955
956         /* Power up the LCDC screen */
957         if (sinfo->atmel_lcdfb_power_control)
958                 sinfo->atmel_lcdfb_power_control(1);
959
960         dev_info(dev, "fb%d: Atmel LCDC at 0x%08lx (mapped at %p), irq %lu\n",
961                        info->node, info->fix.mmio_start, sinfo->mmio, sinfo->irq_base);
962
963         return 0;
964
965 reset_drvdata:
966         dev_set_drvdata(dev, NULL);
967 free_cmap:
968         fb_dealloc_cmap(&info->cmap);
969 unregister_irqs:
970         cancel_work_sync(&sinfo->task);
971         free_irq(sinfo->irq_base, info);
972 unmap_mmio:
973         exit_backlight(sinfo);
974         iounmap(sinfo->mmio);
975 release_mem:
976         release_mem_region(info->fix.mmio_start, info->fix.mmio_len);
977 free_fb:
978         if (map)
979                 iounmap(info->screen_base);
980         else
981                 atmel_lcdfb_free_video_memory(sinfo);
982
983 release_intmem:
984         if (map)
985                 release_mem_region(info->fix.smem_start, info->fix.smem_len);
986 stop_clk:
987         atmel_lcdfb_stop_clock(sinfo);
988         clk_put(sinfo->lcdc_clk);
989 put_bus_clk:
990         if (sinfo->bus_clk)
991                 clk_put(sinfo->bus_clk);
992 free_info:
993         framebuffer_release(info);
994 out:
995         dev_dbg(dev, "%s FAILED\n", __func__);
996         return ret;
997 }
998
999 static int __exit atmel_lcdfb_remove(struct platform_device *pdev)
1000 {
1001         struct device *dev = &pdev->dev;
1002         struct fb_info *info = dev_get_drvdata(dev);
1003         struct atmel_lcdfb_info *sinfo;
1004
1005         if (!info || !info->par)
1006                 return 0;
1007         sinfo = info->par;
1008
1009         cancel_work_sync(&sinfo->task);
1010         exit_backlight(sinfo);
1011         if (sinfo->atmel_lcdfb_power_control)
1012                 sinfo->atmel_lcdfb_power_control(0);
1013         unregister_framebuffer(info);
1014         atmel_lcdfb_stop_clock(sinfo);
1015         clk_put(sinfo->lcdc_clk);
1016         if (sinfo->bus_clk)
1017                 clk_put(sinfo->bus_clk);
1018         fb_dealloc_cmap(&info->cmap);
1019         free_irq(sinfo->irq_base, info);
1020         iounmap(sinfo->mmio);
1021         release_mem_region(info->fix.mmio_start, info->fix.mmio_len);
1022         if (platform_get_resource(pdev, IORESOURCE_MEM, 1)) {
1023                 iounmap(info->screen_base);
1024                 release_mem_region(info->fix.smem_start, info->fix.smem_len);
1025         } else {
1026                 atmel_lcdfb_free_video_memory(sinfo);
1027         }
1028
1029         dev_set_drvdata(dev, NULL);
1030         framebuffer_release(info);
1031
1032         return 0;
1033 }
1034
1035 #ifdef CONFIG_PM
1036
1037 static int atmel_lcdfb_suspend(struct platform_device *pdev, pm_message_t mesg)
1038 {
1039         struct fb_info *info = platform_get_drvdata(pdev);
1040         struct atmel_lcdfb_info *sinfo = info->par;
1041
1042         /*
1043          * We don't want to handle interrupts while the clock is
1044          * stopped. It may take forever.
1045          */
1046         lcdc_writel(sinfo, ATMEL_LCDC_IDR, ~0UL);
1047
1048         sinfo->saved_lcdcon = lcdc_readl(sinfo, ATMEL_LCDC_CONTRAST_VAL);
1049         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_CTR, 0);
1050         if (sinfo->atmel_lcdfb_power_control)
1051                 sinfo->atmel_lcdfb_power_control(0);
1052
1053         atmel_lcdfb_stop(sinfo);
1054         atmel_lcdfb_stop_clock(sinfo);
1055
1056         return 0;
1057 }
1058
1059 static int atmel_lcdfb_resume(struct platform_device *pdev)
1060 {
1061         struct fb_info *info = platform_get_drvdata(pdev);
1062         struct atmel_lcdfb_info *sinfo = info->par;
1063
1064         atmel_lcdfb_start_clock(sinfo);
1065         atmel_lcdfb_start(sinfo);
1066         if (sinfo->atmel_lcdfb_power_control)
1067                 sinfo->atmel_lcdfb_power_control(1);
1068         lcdc_writel(sinfo, ATMEL_LCDC_CONTRAST_CTR, sinfo->saved_lcdcon);
1069
1070         /* Enable FIFO & DMA errors */
1071         lcdc_writel(sinfo, ATMEL_LCDC_IER, ATMEL_LCDC_UFLWI
1072                         | ATMEL_LCDC_OWRI | ATMEL_LCDC_MERI);
1073
1074         return 0;
1075 }
1076
1077 #else
1078 #define atmel_lcdfb_suspend     NULL
1079 #define atmel_lcdfb_resume      NULL
1080 #endif
1081
1082 static struct platform_driver atmel_lcdfb_driver = {
1083         .remove         = __exit_p(atmel_lcdfb_remove),
1084         .suspend        = atmel_lcdfb_suspend,
1085         .resume         = atmel_lcdfb_resume,
1086
1087         .driver         = {
1088                 .name   = "atmel_lcdfb",
1089                 .owner  = THIS_MODULE,
1090         },
1091 };
1092
1093 static int __init atmel_lcdfb_init(void)
1094 {
1095         return platform_driver_probe(&atmel_lcdfb_driver, atmel_lcdfb_probe);
1096 }
1097
1098 static void __exit atmel_lcdfb_exit(void)
1099 {
1100         platform_driver_unregister(&atmel_lcdfb_driver);
1101 }
1102
1103 module_init(atmel_lcdfb_init);
1104 module_exit(atmel_lcdfb_exit);
1105
1106 MODULE_DESCRIPTION("AT91/AT32 LCD Controller framebuffer driver");
1107 MODULE_AUTHOR("Nicolas Ferre <nicolas.ferre@atmel.com>");
1108 MODULE_LICENSE("GPL");