fbdev: move FBIO_WAITFORVSYNC to linux/fb.h
[safe/jmp/linux-2.6] / drivers / video / sh_mobile_lcdcfb.c
1 /*
2  * SuperH Mobile LCDC Framebuffer
3  *
4  * Copyright (c) 2008 Magnus Damm
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
8  * for more details.
9  */
10
11 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/delay.h>
14 #include <linux/mm.h>
15 #include <linux/fb.h>
16 #include <linux/clk.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/platform_device.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/interrupt.h>
21 #include <linux/vmalloc.h>
22 #include <linux/ioctl.h>
23 #include <linux/slab.h>
24 #include <video/sh_mobile_lcdc.h>
25 #include <asm/atomic.h>
26
27 #define PALETTE_NR 16
28 #define SIDE_B_OFFSET 0x1000
29 #define MIRROR_OFFSET 0x2000
30
31 /* shared registers */
32 #define _LDDCKR 0x410
33 #define _LDDCKSTPR 0x414
34 #define _LDINTR 0x468
35 #define _LDSR 0x46c
36 #define _LDCNT1R 0x470
37 #define _LDCNT2R 0x474
38 #define _LDRCNTR 0x478
39 #define _LDDDSR 0x47c
40 #define _LDDWD0R 0x800
41 #define _LDDRDR 0x840
42 #define _LDDWAR 0x900
43 #define _LDDRAR 0x904
44
45 /* shared registers and their order for context save/restore */
46 static int lcdc_shared_regs[] = {
47         _LDDCKR,
48         _LDDCKSTPR,
49         _LDINTR,
50         _LDDDSR,
51         _LDCNT1R,
52         _LDCNT2R,
53 };
54 #define NR_SHARED_REGS ARRAY_SIZE(lcdc_shared_regs)
55
56 /* per-channel registers */
57 enum { LDDCKPAT1R, LDDCKPAT2R, LDMT1R, LDMT2R, LDMT3R, LDDFR, LDSM1R,
58        LDSM2R, LDSA1R, LDMLSR, LDHCNR, LDHSYNR, LDVLNR, LDVSYNR, LDPMR,
59        NR_CH_REGS };
60
61 static unsigned long lcdc_offs_mainlcd[NR_CH_REGS] = {
62         [LDDCKPAT1R] = 0x400,
63         [LDDCKPAT2R] = 0x404,
64         [LDMT1R] = 0x418,
65         [LDMT2R] = 0x41c,
66         [LDMT3R] = 0x420,
67         [LDDFR] = 0x424,
68         [LDSM1R] = 0x428,
69         [LDSM2R] = 0x42c,
70         [LDSA1R] = 0x430,
71         [LDMLSR] = 0x438,
72         [LDHCNR] = 0x448,
73         [LDHSYNR] = 0x44c,
74         [LDVLNR] = 0x450,
75         [LDVSYNR] = 0x454,
76         [LDPMR] = 0x460,
77 };
78
79 static unsigned long lcdc_offs_sublcd[NR_CH_REGS] = {
80         [LDDCKPAT1R] = 0x408,
81         [LDDCKPAT2R] = 0x40c,
82         [LDMT1R] = 0x600,
83         [LDMT2R] = 0x604,
84         [LDMT3R] = 0x608,
85         [LDDFR] = 0x60c,
86         [LDSM1R] = 0x610,
87         [LDSM2R] = 0x614,
88         [LDSA1R] = 0x618,
89         [LDMLSR] = 0x620,
90         [LDHCNR] = 0x624,
91         [LDHSYNR] = 0x628,
92         [LDVLNR] = 0x62c,
93         [LDVSYNR] = 0x630,
94         [LDPMR] = 0x63c,
95 };
96
97 #define START_LCDC      0x00000001
98 #define LCDC_RESET      0x00000100
99 #define DISPLAY_BEU     0x00000008
100 #define LCDC_ENABLE     0x00000001
101 #define LDINTR_FE       0x00000400
102 #define LDINTR_VSE      0x00000200
103 #define LDINTR_VEE      0x00000100
104 #define LDINTR_FS       0x00000004
105 #define LDINTR_VSS      0x00000002
106 #define LDINTR_VES      0x00000001
107 #define LDRCNTR_SRS     0x00020000
108 #define LDRCNTR_SRC     0x00010000
109 #define LDRCNTR_MRS     0x00000002
110 #define LDRCNTR_MRC     0x00000001
111 #define LDSR_MRS        0x00000100
112
113 struct sh_mobile_lcdc_priv;
114 struct sh_mobile_lcdc_chan {
115         struct sh_mobile_lcdc_priv *lcdc;
116         unsigned long *reg_offs;
117         unsigned long ldmt1r_value;
118         unsigned long enabled; /* ME and SE in LDCNT2R */
119         struct sh_mobile_lcdc_chan_cfg cfg;
120         u32 pseudo_palette[PALETTE_NR];
121         unsigned long saved_ch_regs[NR_CH_REGS];
122         struct fb_info *info;
123         dma_addr_t dma_handle;
124         struct fb_deferred_io defio;
125         struct scatterlist *sglist;
126         unsigned long frame_end;
127         unsigned long pan_offset;
128         wait_queue_head_t frame_end_wait;
129         struct completion vsync_completion;
130 };
131
132 struct sh_mobile_lcdc_priv {
133         void __iomem *base;
134         int irq;
135         atomic_t hw_usecnt;
136         struct device *dev;
137         struct clk *dot_clk;
138         unsigned long lddckr;
139         struct sh_mobile_lcdc_chan ch[2];
140         unsigned long saved_shared_regs[NR_SHARED_REGS];
141         int started;
142 };
143
144 static bool banked(int reg_nr)
145 {
146         switch (reg_nr) {
147         case LDMT1R:
148         case LDMT2R:
149         case LDMT3R:
150         case LDDFR:
151         case LDSM1R:
152         case LDSA1R:
153         case LDMLSR:
154         case LDHCNR:
155         case LDHSYNR:
156         case LDVLNR:
157         case LDVSYNR:
158                 return true;
159         }
160         return false;
161 }
162
163 static void lcdc_write_chan(struct sh_mobile_lcdc_chan *chan,
164                             int reg_nr, unsigned long data)
165 {
166         iowrite32(data, chan->lcdc->base + chan->reg_offs[reg_nr]);
167         if (banked(reg_nr))
168                 iowrite32(data, chan->lcdc->base + chan->reg_offs[reg_nr] +
169                           SIDE_B_OFFSET);
170 }
171
172 static void lcdc_write_chan_mirror(struct sh_mobile_lcdc_chan *chan,
173                             int reg_nr, unsigned long data)
174 {
175         iowrite32(data, chan->lcdc->base + chan->reg_offs[reg_nr] +
176                   MIRROR_OFFSET);
177 }
178
179 static unsigned long lcdc_read_chan(struct sh_mobile_lcdc_chan *chan,
180                                     int reg_nr)
181 {
182         return ioread32(chan->lcdc->base + chan->reg_offs[reg_nr]);
183 }
184
185 static void lcdc_write(struct sh_mobile_lcdc_priv *priv,
186                        unsigned long reg_offs, unsigned long data)
187 {
188         iowrite32(data, priv->base + reg_offs);
189 }
190
191 static unsigned long lcdc_read(struct sh_mobile_lcdc_priv *priv,
192                                unsigned long reg_offs)
193 {
194         return ioread32(priv->base + reg_offs);
195 }
196
197 static void lcdc_wait_bit(struct sh_mobile_lcdc_priv *priv,
198                           unsigned long reg_offs,
199                           unsigned long mask, unsigned long until)
200 {
201         while ((lcdc_read(priv, reg_offs) & mask) != until)
202                 cpu_relax();
203 }
204
205 static int lcdc_chan_is_sublcd(struct sh_mobile_lcdc_chan *chan)
206 {
207         return chan->cfg.chan == LCDC_CHAN_SUBLCD;
208 }
209
210 static void lcdc_sys_write_index(void *handle, unsigned long data)
211 {
212         struct sh_mobile_lcdc_chan *ch = handle;
213
214         lcdc_write(ch->lcdc, _LDDWD0R, data | 0x10000000);
215         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
216         lcdc_write(ch->lcdc, _LDDWAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
217         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
218 }
219
220 static void lcdc_sys_write_data(void *handle, unsigned long data)
221 {
222         struct sh_mobile_lcdc_chan *ch = handle;
223
224         lcdc_write(ch->lcdc, _LDDWD0R, data | 0x11000000);
225         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
226         lcdc_write(ch->lcdc, _LDDWAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
227         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
228 }
229
230 static unsigned long lcdc_sys_read_data(void *handle)
231 {
232         struct sh_mobile_lcdc_chan *ch = handle;
233
234         lcdc_write(ch->lcdc, _LDDRDR, 0x01000000);
235         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
236         lcdc_write(ch->lcdc, _LDDRAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
237         udelay(1);
238         lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
239
240         return lcdc_read(ch->lcdc, _LDDRDR) & 0x3ffff;
241 }
242
243 struct sh_mobile_lcdc_sys_bus_ops sh_mobile_lcdc_sys_bus_ops = {
244         lcdc_sys_write_index,
245         lcdc_sys_write_data,
246         lcdc_sys_read_data,
247 };
248
249 static void sh_mobile_lcdc_clk_on(struct sh_mobile_lcdc_priv *priv)
250 {
251         if (atomic_inc_and_test(&priv->hw_usecnt)) {
252                 pm_runtime_get_sync(priv->dev);
253                 if (priv->dot_clk)
254                         clk_enable(priv->dot_clk);
255         }
256 }
257
258 static void sh_mobile_lcdc_clk_off(struct sh_mobile_lcdc_priv *priv)
259 {
260         if (atomic_sub_return(1, &priv->hw_usecnt) == -1) {
261                 if (priv->dot_clk)
262                         clk_disable(priv->dot_clk);
263                 pm_runtime_put(priv->dev);
264         }
265 }
266
267 static int sh_mobile_lcdc_sginit(struct fb_info *info,
268                                   struct list_head *pagelist)
269 {
270         struct sh_mobile_lcdc_chan *ch = info->par;
271         unsigned int nr_pages_max = info->fix.smem_len >> PAGE_SHIFT;
272         struct page *page;
273         int nr_pages = 0;
274
275         sg_init_table(ch->sglist, nr_pages_max);
276
277         list_for_each_entry(page, pagelist, lru)
278                 sg_set_page(&ch->sglist[nr_pages++], page, PAGE_SIZE, 0);
279
280         return nr_pages;
281 }
282
283 static void sh_mobile_lcdc_deferred_io(struct fb_info *info,
284                                        struct list_head *pagelist)
285 {
286         struct sh_mobile_lcdc_chan *ch = info->par;
287         struct sh_mobile_lcdc_board_cfg *bcfg = &ch->cfg.board_cfg;
288
289         /* enable clocks before accessing hardware */
290         sh_mobile_lcdc_clk_on(ch->lcdc);
291
292         /*
293          * It's possible to get here without anything on the pagelist via
294          * sh_mobile_lcdc_deferred_io_touch() or via a userspace fsync()
295          * invocation. In the former case, the acceleration routines are
296          * stepped in to when using the framebuffer console causing the
297          * workqueue to be scheduled without any dirty pages on the list.
298          *
299          * Despite this, a panel update is still needed given that the
300          * acceleration routines have their own methods for writing in
301          * that still need to be updated.
302          *
303          * The fsync() and empty pagelist case could be optimized for,
304          * but we don't bother, as any application exhibiting such
305          * behaviour is fundamentally broken anyways.
306          */
307         if (!list_empty(pagelist)) {
308                 unsigned int nr_pages = sh_mobile_lcdc_sginit(info, pagelist);
309
310                 /* trigger panel update */
311                 dma_map_sg(info->dev, ch->sglist, nr_pages, DMA_TO_DEVICE);
312                 if (bcfg->start_transfer)
313                         bcfg->start_transfer(bcfg->board_data, ch,
314                                              &sh_mobile_lcdc_sys_bus_ops);
315                 lcdc_write_chan(ch, LDSM2R, 1);
316                 dma_unmap_sg(info->dev, ch->sglist, nr_pages, DMA_TO_DEVICE);
317         } else {
318                 if (bcfg->start_transfer)
319                         bcfg->start_transfer(bcfg->board_data, ch,
320                                              &sh_mobile_lcdc_sys_bus_ops);
321                 lcdc_write_chan(ch, LDSM2R, 1);
322         }
323 }
324
325 static void sh_mobile_lcdc_deferred_io_touch(struct fb_info *info)
326 {
327         struct fb_deferred_io *fbdefio = info->fbdefio;
328
329         if (fbdefio)
330                 schedule_delayed_work(&info->deferred_work, fbdefio->delay);
331 }
332
333 static irqreturn_t sh_mobile_lcdc_irq(int irq, void *data)
334 {
335         struct sh_mobile_lcdc_priv *priv = data;
336         struct sh_mobile_lcdc_chan *ch;
337         unsigned long tmp;
338         unsigned long ldintr;
339         int is_sub;
340         int k;
341
342         /* acknowledge interrupt */
343         ldintr = tmp = lcdc_read(priv, _LDINTR);
344         /*
345          * disable further VSYNC End IRQs, preserve all other enabled IRQs,
346          * write 0 to bits 0-6 to ack all triggered IRQs.
347          */
348         tmp &= 0xffffff00 & ~LDINTR_VEE;
349         lcdc_write(priv, _LDINTR, tmp);
350
351         /* figure out if this interrupt is for main or sub lcd */
352         is_sub = (lcdc_read(priv, _LDSR) & (1 << 10)) ? 1 : 0;
353
354         /* wake up channel and disable clocks */
355         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
356                 ch = &priv->ch[k];
357
358                 if (!ch->enabled)
359                         continue;
360
361                 /* Frame Start */
362                 if (ldintr & LDINTR_FS) {
363                         if (is_sub == lcdc_chan_is_sublcd(ch)) {
364                                 ch->frame_end = 1;
365                                 wake_up(&ch->frame_end_wait);
366
367                                 sh_mobile_lcdc_clk_off(priv);
368                         }
369                 }
370
371                 /* VSYNC End */
372                 if (ldintr & LDINTR_VES)
373                         complete(&ch->vsync_completion);
374         }
375
376         return IRQ_HANDLED;
377 }
378
379 static void sh_mobile_lcdc_start_stop(struct sh_mobile_lcdc_priv *priv,
380                                       int start)
381 {
382         unsigned long tmp = lcdc_read(priv, _LDCNT2R);
383         int k;
384
385         /* start or stop the lcdc */
386         if (start)
387                 lcdc_write(priv, _LDCNT2R, tmp | START_LCDC);
388         else
389                 lcdc_write(priv, _LDCNT2R, tmp & ~START_LCDC);
390
391         /* wait until power is applied/stopped on all channels */
392         for (k = 0; k < ARRAY_SIZE(priv->ch); k++)
393                 if (lcdc_read(priv, _LDCNT2R) & priv->ch[k].enabled)
394                         while (1) {
395                                 tmp = lcdc_read_chan(&priv->ch[k], LDPMR) & 3;
396                                 if (start && tmp == 3)
397                                         break;
398                                 if (!start && tmp == 0)
399                                         break;
400                                 cpu_relax();
401                         }
402
403         if (!start)
404                 lcdc_write(priv, _LDDCKSTPR, 1); /* stop dotclock */
405 }
406
407 static int sh_mobile_lcdc_start(struct sh_mobile_lcdc_priv *priv)
408 {
409         struct sh_mobile_lcdc_chan *ch;
410         struct fb_videomode *lcd_cfg;
411         struct sh_mobile_lcdc_board_cfg *board_cfg;
412         unsigned long tmp;
413         int k, m;
414         int ret = 0;
415
416         /* enable clocks before accessing the hardware */
417         for (k = 0; k < ARRAY_SIZE(priv->ch); k++)
418                 if (priv->ch[k].enabled)
419                         sh_mobile_lcdc_clk_on(priv);
420
421         /* reset */
422         lcdc_write(priv, _LDCNT2R, lcdc_read(priv, _LDCNT2R) | LCDC_RESET);
423         lcdc_wait_bit(priv, _LDCNT2R, LCDC_RESET, 0);
424
425         /* enable LCDC channels */
426         tmp = lcdc_read(priv, _LDCNT2R);
427         tmp |= priv->ch[0].enabled;
428         tmp |= priv->ch[1].enabled;
429         lcdc_write(priv, _LDCNT2R, tmp);
430
431         /* read data from external memory, avoid using the BEU for now */
432         lcdc_write(priv, _LDCNT2R, lcdc_read(priv, _LDCNT2R) & ~DISPLAY_BEU);
433
434         /* stop the lcdc first */
435         sh_mobile_lcdc_start_stop(priv, 0);
436
437         /* configure clocks */
438         tmp = priv->lddckr;
439         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
440                 ch = &priv->ch[k];
441
442                 if (!priv->ch[k].enabled)
443                         continue;
444
445                 m = ch->cfg.clock_divider;
446                 if (!m)
447                         continue;
448
449                 if (m == 1)
450                         m = 1 << 6;
451                 tmp |= m << (lcdc_chan_is_sublcd(ch) ? 8 : 0);
452
453                 lcdc_write_chan(ch, LDDCKPAT1R, 0x00000000);
454                 lcdc_write_chan(ch, LDDCKPAT2R, (1 << (m/2)) - 1);
455         }
456
457         lcdc_write(priv, _LDDCKR, tmp);
458
459         /* start dotclock again */
460         lcdc_write(priv, _LDDCKSTPR, 0);
461         lcdc_wait_bit(priv, _LDDCKSTPR, ~0, 0);
462
463         /* interrupts are disabled to begin with */
464         lcdc_write(priv, _LDINTR, 0);
465
466         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
467                 ch = &priv->ch[k];
468                 lcd_cfg = &ch->cfg.lcd_cfg;
469
470                 if (!ch->enabled)
471                         continue;
472
473                 tmp = ch->ldmt1r_value;
474                 tmp |= (lcd_cfg->sync & FB_SYNC_VERT_HIGH_ACT) ? 0 : 1 << 28;
475                 tmp |= (lcd_cfg->sync & FB_SYNC_HOR_HIGH_ACT) ? 0 : 1 << 27;
476                 tmp |= (ch->cfg.flags & LCDC_FLAGS_DWPOL) ? 1 << 26 : 0;
477                 tmp |= (ch->cfg.flags & LCDC_FLAGS_DIPOL) ? 1 << 25 : 0;
478                 tmp |= (ch->cfg.flags & LCDC_FLAGS_DAPOL) ? 1 << 24 : 0;
479                 tmp |= (ch->cfg.flags & LCDC_FLAGS_HSCNT) ? 1 << 17 : 0;
480                 tmp |= (ch->cfg.flags & LCDC_FLAGS_DWCNT) ? 1 << 16 : 0;
481                 lcdc_write_chan(ch, LDMT1R, tmp);
482
483                 /* setup SYS bus */
484                 lcdc_write_chan(ch, LDMT2R, ch->cfg.sys_bus_cfg.ldmt2r);
485                 lcdc_write_chan(ch, LDMT3R, ch->cfg.sys_bus_cfg.ldmt3r);
486
487                 /* horizontal configuration */
488                 tmp = lcd_cfg->xres + lcd_cfg->hsync_len;
489                 tmp += lcd_cfg->left_margin;
490                 tmp += lcd_cfg->right_margin;
491                 tmp /= 8; /* HTCN */
492                 tmp |= (lcd_cfg->xres / 8) << 16; /* HDCN */
493                 lcdc_write_chan(ch, LDHCNR, tmp);
494
495                 tmp = lcd_cfg->xres;
496                 tmp += lcd_cfg->right_margin;
497                 tmp /= 8; /* HSYNP */
498                 tmp |= (lcd_cfg->hsync_len / 8) << 16; /* HSYNW */
499                 lcdc_write_chan(ch, LDHSYNR, tmp);
500
501                 /* power supply */
502                 lcdc_write_chan(ch, LDPMR, 0);
503
504                 /* vertical configuration */
505                 tmp = lcd_cfg->yres + lcd_cfg->vsync_len;
506                 tmp += lcd_cfg->upper_margin;
507                 tmp += lcd_cfg->lower_margin; /* VTLN */
508                 tmp |= lcd_cfg->yres << 16; /* VDLN */
509                 lcdc_write_chan(ch, LDVLNR, tmp);
510
511                 tmp = lcd_cfg->yres;
512                 tmp += lcd_cfg->lower_margin; /* VSYNP */
513                 tmp |= lcd_cfg->vsync_len << 16; /* VSYNW */
514                 lcdc_write_chan(ch, LDVSYNR, tmp);
515
516                 board_cfg = &ch->cfg.board_cfg;
517                 if (board_cfg->setup_sys)
518                         ret = board_cfg->setup_sys(board_cfg->board_data, ch,
519                                                    &sh_mobile_lcdc_sys_bus_ops);
520                 if (ret)
521                         return ret;
522         }
523
524         /* word and long word swap */
525         lcdc_write(priv, _LDDDSR, lcdc_read(priv, _LDDDSR) | 6);
526
527         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
528                 ch = &priv->ch[k];
529
530                 if (!priv->ch[k].enabled)
531                         continue;
532
533                 /* set bpp format in PKF[4:0] */
534                 tmp = lcdc_read_chan(ch, LDDFR);
535                 tmp &= ~(0x0001001f);
536                 tmp |= (ch->info->var.bits_per_pixel == 16) ? 3 : 0;
537                 lcdc_write_chan(ch, LDDFR, tmp);
538
539                 /* point out our frame buffer */
540                 lcdc_write_chan(ch, LDSA1R, ch->info->fix.smem_start);
541
542                 /* set line size */
543                 lcdc_write_chan(ch, LDMLSR, ch->info->fix.line_length);
544
545                 /* setup deferred io if SYS bus */
546                 tmp = ch->cfg.sys_bus_cfg.deferred_io_msec;
547                 if (ch->ldmt1r_value & (1 << 12) && tmp) {
548                         ch->defio.deferred_io = sh_mobile_lcdc_deferred_io;
549                         ch->defio.delay = msecs_to_jiffies(tmp);
550                         ch->info->fbdefio = &ch->defio;
551                         fb_deferred_io_init(ch->info);
552
553                         /* one-shot mode */
554                         lcdc_write_chan(ch, LDSM1R, 1);
555
556                         /* enable "Frame End Interrupt Enable" bit */
557                         lcdc_write(priv, _LDINTR, LDINTR_FE);
558
559                 } else {
560                         /* continuous read mode */
561                         lcdc_write_chan(ch, LDSM1R, 0);
562                 }
563         }
564
565         /* display output */
566         lcdc_write(priv, _LDCNT1R, LCDC_ENABLE);
567
568         /* start the lcdc */
569         sh_mobile_lcdc_start_stop(priv, 1);
570         priv->started = 1;
571
572         /* tell the board code to enable the panel */
573         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
574                 ch = &priv->ch[k];
575                 if (!ch->enabled)
576                         continue;
577
578                 board_cfg = &ch->cfg.board_cfg;
579                 if (board_cfg->display_on)
580                         board_cfg->display_on(board_cfg->board_data);
581         }
582
583         return 0;
584 }
585
586 static void sh_mobile_lcdc_stop(struct sh_mobile_lcdc_priv *priv)
587 {
588         struct sh_mobile_lcdc_chan *ch;
589         struct sh_mobile_lcdc_board_cfg *board_cfg;
590         int k;
591
592         /* clean up deferred io and ask board code to disable panel */
593         for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
594                 ch = &priv->ch[k];
595                 if (!ch->enabled)
596                         continue;
597
598                 /* deferred io mode:
599                  * flush frame, and wait for frame end interrupt
600                  * clean up deferred io and enable clock
601                  */
602                 if (ch->info->fbdefio) {
603                         ch->frame_end = 0;
604                         schedule_delayed_work(&ch->info->deferred_work, 0);
605                         wait_event(ch->frame_end_wait, ch->frame_end);
606                         fb_deferred_io_cleanup(ch->info);
607                         ch->info->fbdefio = NULL;
608                         sh_mobile_lcdc_clk_on(priv);
609                 }
610
611                 board_cfg = &ch->cfg.board_cfg;
612                 if (board_cfg->display_off)
613                         board_cfg->display_off(board_cfg->board_data);
614         }
615
616         /* stop the lcdc */
617         if (priv->started) {
618                 sh_mobile_lcdc_start_stop(priv, 0);
619                 priv->started = 0;
620         }
621
622         /* stop clocks */
623         for (k = 0; k < ARRAY_SIZE(priv->ch); k++)
624                 if (priv->ch[k].enabled)
625                         sh_mobile_lcdc_clk_off(priv);
626 }
627
628 static int sh_mobile_lcdc_check_interface(struct sh_mobile_lcdc_chan *ch)
629 {
630         int ifm, miftyp;
631
632         switch (ch->cfg.interface_type) {
633         case RGB8: ifm = 0; miftyp = 0; break;
634         case RGB9: ifm = 0; miftyp = 4; break;
635         case RGB12A: ifm = 0; miftyp = 5; break;
636         case RGB12B: ifm = 0; miftyp = 6; break;
637         case RGB16: ifm = 0; miftyp = 7; break;
638         case RGB18: ifm = 0; miftyp = 10; break;
639         case RGB24: ifm = 0; miftyp = 11; break;
640         case SYS8A: ifm = 1; miftyp = 0; break;
641         case SYS8B: ifm = 1; miftyp = 1; break;
642         case SYS8C: ifm = 1; miftyp = 2; break;
643         case SYS8D: ifm = 1; miftyp = 3; break;
644         case SYS9: ifm = 1; miftyp = 4; break;
645         case SYS12: ifm = 1; miftyp = 5; break;
646         case SYS16A: ifm = 1; miftyp = 7; break;
647         case SYS16B: ifm = 1; miftyp = 8; break;
648         case SYS16C: ifm = 1; miftyp = 9; break;
649         case SYS18: ifm = 1; miftyp = 10; break;
650         case SYS24: ifm = 1; miftyp = 11; break;
651         default: goto bad;
652         }
653
654         /* SUBLCD only supports SYS interface */
655         if (lcdc_chan_is_sublcd(ch)) {
656                 if (ifm == 0)
657                         goto bad;
658                 else
659                         ifm = 0;
660         }
661
662         ch->ldmt1r_value = (ifm << 12) | miftyp;
663         return 0;
664  bad:
665         return -EINVAL;
666 }
667
668 static int sh_mobile_lcdc_setup_clocks(struct platform_device *pdev,
669                                        int clock_source,
670                                        struct sh_mobile_lcdc_priv *priv)
671 {
672         char *str;
673         int icksel;
674
675         switch (clock_source) {
676         case LCDC_CLK_BUS: str = "bus_clk"; icksel = 0; break;
677         case LCDC_CLK_PERIPHERAL: str = "peripheral_clk"; icksel = 1; break;
678         case LCDC_CLK_EXTERNAL: str = NULL; icksel = 2; break;
679         default:
680                 return -EINVAL;
681         }
682
683         priv->lddckr = icksel << 16;
684
685         if (str) {
686                 priv->dot_clk = clk_get(&pdev->dev, str);
687                 if (IS_ERR(priv->dot_clk)) {
688                         dev_err(&pdev->dev, "cannot get dot clock %s\n", str);
689                         return PTR_ERR(priv->dot_clk);
690                 }
691         }
692         atomic_set(&priv->hw_usecnt, -1);
693
694         /* Runtime PM support involves two step for this driver:
695          * 1) Enable Runtime PM
696          * 2) Force Runtime PM Resume since hardware is accessed from probe()
697          */
698         priv->dev = &pdev->dev;
699         pm_runtime_enable(priv->dev);
700         pm_runtime_resume(priv->dev);
701         return 0;
702 }
703
704 static int sh_mobile_lcdc_setcolreg(u_int regno,
705                                     u_int red, u_int green, u_int blue,
706                                     u_int transp, struct fb_info *info)
707 {
708         u32 *palette = info->pseudo_palette;
709
710         if (regno >= PALETTE_NR)
711                 return -EINVAL;
712
713         /* only FB_VISUAL_TRUECOLOR supported */
714
715         red >>= 16 - info->var.red.length;
716         green >>= 16 - info->var.green.length;
717         blue >>= 16 - info->var.blue.length;
718         transp >>= 16 - info->var.transp.length;
719
720         palette[regno] = (red << info->var.red.offset) |
721           (green << info->var.green.offset) |
722           (blue << info->var.blue.offset) |
723           (transp << info->var.transp.offset);
724
725         return 0;
726 }
727
728 static struct fb_fix_screeninfo sh_mobile_lcdc_fix  = {
729         .id =           "SH Mobile LCDC",
730         .type =         FB_TYPE_PACKED_PIXELS,
731         .visual =       FB_VISUAL_TRUECOLOR,
732         .accel =        FB_ACCEL_NONE,
733         .xpanstep =     0,
734         .ypanstep =     1,
735         .ywrapstep =    0,
736 };
737
738 static void sh_mobile_lcdc_fillrect(struct fb_info *info,
739                                     const struct fb_fillrect *rect)
740 {
741         sys_fillrect(info, rect);
742         sh_mobile_lcdc_deferred_io_touch(info);
743 }
744
745 static void sh_mobile_lcdc_copyarea(struct fb_info *info,
746                                     const struct fb_copyarea *area)
747 {
748         sys_copyarea(info, area);
749         sh_mobile_lcdc_deferred_io_touch(info);
750 }
751
752 static void sh_mobile_lcdc_imageblit(struct fb_info *info,
753                                      const struct fb_image *image)
754 {
755         sys_imageblit(info, image);
756         sh_mobile_lcdc_deferred_io_touch(info);
757 }
758
759 static int sh_mobile_fb_pan_display(struct fb_var_screeninfo *var,
760                                      struct fb_info *info)
761 {
762         struct sh_mobile_lcdc_chan *ch = info->par;
763         struct sh_mobile_lcdc_priv *priv = ch->lcdc;
764         unsigned long ldrcntr;
765         unsigned long new_pan_offset;
766
767         new_pan_offset = (var->yoffset * info->fix.line_length) +
768                 (var->xoffset * (info->var.bits_per_pixel / 8));
769
770         if (new_pan_offset == ch->pan_offset)
771                 return 0;       /* No change, do nothing */
772
773         ldrcntr = lcdc_read(priv, _LDRCNTR);
774
775         /* Set the source address for the next refresh */
776         lcdc_write_chan_mirror(ch, LDSA1R, ch->dma_handle + new_pan_offset);
777         if (lcdc_chan_is_sublcd(ch))
778                 lcdc_write(ch->lcdc, _LDRCNTR, ldrcntr ^ LDRCNTR_SRS);
779         else
780                 lcdc_write(ch->lcdc, _LDRCNTR, ldrcntr ^ LDRCNTR_MRS);
781
782         ch->pan_offset = new_pan_offset;
783
784         sh_mobile_lcdc_deferred_io_touch(info);
785
786         return 0;
787 }
788
789 static int sh_mobile_wait_for_vsync(struct fb_info *info)
790 {
791         struct sh_mobile_lcdc_chan *ch = info->par;
792         unsigned long ldintr;
793         int ret;
794
795         /* Enable VSync End interrupt */
796         ldintr = lcdc_read(ch->lcdc, _LDINTR);
797         ldintr |= LDINTR_VEE;
798         lcdc_write(ch->lcdc, _LDINTR, ldintr);
799
800         ret = wait_for_completion_interruptible_timeout(&ch->vsync_completion,
801                                                         msecs_to_jiffies(100));
802         if (!ret)
803                 return -ETIMEDOUT;
804
805         return 0;
806 }
807
808 static int sh_mobile_ioctl(struct fb_info *info, unsigned int cmd,
809                        unsigned long arg)
810 {
811         int retval;
812
813         switch (cmd) {
814         case FBIO_WAITFORVSYNC:
815                 retval = sh_mobile_wait_for_vsync(info);
816                 break;
817
818         default:
819                 retval = -ENOIOCTLCMD;
820                 break;
821         }
822         return retval;
823 }
824
825
826 static struct fb_ops sh_mobile_lcdc_ops = {
827         .owner          = THIS_MODULE,
828         .fb_setcolreg   = sh_mobile_lcdc_setcolreg,
829         .fb_read        = fb_sys_read,
830         .fb_write       = fb_sys_write,
831         .fb_fillrect    = sh_mobile_lcdc_fillrect,
832         .fb_copyarea    = sh_mobile_lcdc_copyarea,
833         .fb_imageblit   = sh_mobile_lcdc_imageblit,
834         .fb_pan_display = sh_mobile_fb_pan_display,
835         .fb_ioctl       = sh_mobile_ioctl,
836 };
837
838 static int sh_mobile_lcdc_set_bpp(struct fb_var_screeninfo *var, int bpp)
839 {
840         switch (bpp) {
841         case 16: /* PKF[4:0] = 00011 - RGB 565 */
842                 var->red.offset = 11;
843                 var->red.length = 5;
844                 var->green.offset = 5;
845                 var->green.length = 6;
846                 var->blue.offset = 0;
847                 var->blue.length = 5;
848                 var->transp.offset = 0;
849                 var->transp.length = 0;
850                 break;
851
852         case 32: /* PKF[4:0] = 00000 - RGB 888
853                   * sh7722 pdf says 00RRGGBB but reality is GGBB00RR
854                   * this may be because LDDDSR has word swap enabled..
855                   */
856                 var->red.offset = 0;
857                 var->red.length = 8;
858                 var->green.offset = 24;
859                 var->green.length = 8;
860                 var->blue.offset = 16;
861                 var->blue.length = 8;
862                 var->transp.offset = 0;
863                 var->transp.length = 0;
864                 break;
865         default:
866                 return -EINVAL;
867         }
868         var->bits_per_pixel = bpp;
869         var->red.msb_right = 0;
870         var->green.msb_right = 0;
871         var->blue.msb_right = 0;
872         var->transp.msb_right = 0;
873         return 0;
874 }
875
876 static int sh_mobile_lcdc_suspend(struct device *dev)
877 {
878         struct platform_device *pdev = to_platform_device(dev);
879
880         sh_mobile_lcdc_stop(platform_get_drvdata(pdev));
881         return 0;
882 }
883
884 static int sh_mobile_lcdc_resume(struct device *dev)
885 {
886         struct platform_device *pdev = to_platform_device(dev);
887
888         return sh_mobile_lcdc_start(platform_get_drvdata(pdev));
889 }
890
891 static int sh_mobile_lcdc_runtime_suspend(struct device *dev)
892 {
893         struct platform_device *pdev = to_platform_device(dev);
894         struct sh_mobile_lcdc_priv *p = platform_get_drvdata(pdev);
895         struct sh_mobile_lcdc_chan *ch;
896         int k, n;
897
898         /* save per-channel registers */
899         for (k = 0; k < ARRAY_SIZE(p->ch); k++) {
900                 ch = &p->ch[k];
901                 if (!ch->enabled)
902                         continue;
903                 for (n = 0; n < NR_CH_REGS; n++)
904                         ch->saved_ch_regs[n] = lcdc_read_chan(ch, n);
905         }
906
907         /* save shared registers */
908         for (n = 0; n < NR_SHARED_REGS; n++)
909                 p->saved_shared_regs[n] = lcdc_read(p, lcdc_shared_regs[n]);
910
911         /* turn off LCDC hardware */
912         lcdc_write(p, _LDCNT1R, 0);
913         return 0;
914 }
915
916 static int sh_mobile_lcdc_runtime_resume(struct device *dev)
917 {
918         struct platform_device *pdev = to_platform_device(dev);
919         struct sh_mobile_lcdc_priv *p = platform_get_drvdata(pdev);
920         struct sh_mobile_lcdc_chan *ch;
921         int k, n;
922
923         /* restore per-channel registers */
924         for (k = 0; k < ARRAY_SIZE(p->ch); k++) {
925                 ch = &p->ch[k];
926                 if (!ch->enabled)
927                         continue;
928                 for (n = 0; n < NR_CH_REGS; n++)
929                         lcdc_write_chan(ch, n, ch->saved_ch_regs[n]);
930         }
931
932         /* restore shared registers */
933         for (n = 0; n < NR_SHARED_REGS; n++)
934                 lcdc_write(p, lcdc_shared_regs[n], p->saved_shared_regs[n]);
935
936         return 0;
937 }
938
939 static const struct dev_pm_ops sh_mobile_lcdc_dev_pm_ops = {
940         .suspend = sh_mobile_lcdc_suspend,
941         .resume = sh_mobile_lcdc_resume,
942         .runtime_suspend = sh_mobile_lcdc_runtime_suspend,
943         .runtime_resume = sh_mobile_lcdc_runtime_resume,
944 };
945
946 static int sh_mobile_lcdc_remove(struct platform_device *pdev);
947
948 static int __devinit sh_mobile_lcdc_probe(struct platform_device *pdev)
949 {
950         struct fb_info *info;
951         struct sh_mobile_lcdc_priv *priv;
952         struct sh_mobile_lcdc_info *pdata;
953         struct sh_mobile_lcdc_chan_cfg *cfg;
954         struct resource *res;
955         int error;
956         void *buf;
957         int i, j;
958
959         if (!pdev->dev.platform_data) {
960                 dev_err(&pdev->dev, "no platform data defined\n");
961                 return -EINVAL;
962         }
963
964         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
965         i = platform_get_irq(pdev, 0);
966         if (!res || i < 0) {
967                 dev_err(&pdev->dev, "cannot get platform resources\n");
968                 return -ENOENT;
969         }
970
971         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
972         if (!priv) {
973                 dev_err(&pdev->dev, "cannot allocate device data\n");
974                 return -ENOMEM;
975         }
976
977         platform_set_drvdata(pdev, priv);
978
979         error = request_irq(i, sh_mobile_lcdc_irq, IRQF_DISABLED,
980                             dev_name(&pdev->dev), priv);
981         if (error) {
982                 dev_err(&pdev->dev, "unable to request irq\n");
983                 goto err1;
984         }
985
986         priv->irq = i;
987         pdata = pdev->dev.platform_data;
988
989         j = 0;
990         for (i = 0; i < ARRAY_SIZE(pdata->ch); i++) {
991                 priv->ch[j].lcdc = priv;
992                 memcpy(&priv->ch[j].cfg, &pdata->ch[i], sizeof(pdata->ch[i]));
993
994                 error = sh_mobile_lcdc_check_interface(&priv->ch[i]);
995                 if (error) {
996                         dev_err(&pdev->dev, "unsupported interface type\n");
997                         goto err1;
998                 }
999                 init_waitqueue_head(&priv->ch[i].frame_end_wait);
1000                 init_completion(&priv->ch[i].vsync_completion);
1001                 priv->ch[j].pan_offset = 0;
1002
1003                 switch (pdata->ch[i].chan) {
1004                 case LCDC_CHAN_MAINLCD:
1005                         priv->ch[j].enabled = 1 << 1;
1006                         priv->ch[j].reg_offs = lcdc_offs_mainlcd;
1007                         j++;
1008                         break;
1009                 case LCDC_CHAN_SUBLCD:
1010                         priv->ch[j].enabled = 1 << 2;
1011                         priv->ch[j].reg_offs = lcdc_offs_sublcd;
1012                         j++;
1013                         break;
1014                 }
1015         }
1016
1017         if (!j) {
1018                 dev_err(&pdev->dev, "no channels defined\n");
1019                 error = -EINVAL;
1020                 goto err1;
1021         }
1022
1023         error = sh_mobile_lcdc_setup_clocks(pdev, pdata->clock_source, priv);
1024         if (error) {
1025                 dev_err(&pdev->dev, "unable to setup clocks\n");
1026                 goto err1;
1027         }
1028
1029         priv->base = ioremap_nocache(res->start, (res->end - res->start) + 1);
1030
1031         for (i = 0; i < j; i++) {
1032                 cfg = &priv->ch[i].cfg;
1033
1034                 priv->ch[i].info = framebuffer_alloc(0, &pdev->dev);
1035                 if (!priv->ch[i].info) {
1036                         dev_err(&pdev->dev, "unable to allocate fb_info\n");
1037                         error = -ENOMEM;
1038                         break;
1039                 }
1040
1041                 info = priv->ch[i].info;
1042                 info->fbops = &sh_mobile_lcdc_ops;
1043                 info->var.xres = info->var.xres_virtual = cfg->lcd_cfg.xres;
1044                 info->var.yres = cfg->lcd_cfg.yres;
1045                 /* Default Y virtual resolution is 2x panel size */
1046                 info->var.yres_virtual = info->var.yres * 2;
1047                 info->var.width = cfg->lcd_size_cfg.width;
1048                 info->var.height = cfg->lcd_size_cfg.height;
1049                 info->var.activate = FB_ACTIVATE_NOW;
1050                 error = sh_mobile_lcdc_set_bpp(&info->var, cfg->bpp);
1051                 if (error)
1052                         break;
1053
1054                 info->fix = sh_mobile_lcdc_fix;
1055                 info->fix.line_length = cfg->lcd_cfg.xres * (cfg->bpp / 8);
1056                 info->fix.smem_len = info->fix.line_length *
1057                         info->var.yres_virtual;
1058
1059                 buf = dma_alloc_coherent(&pdev->dev, info->fix.smem_len,
1060                                          &priv->ch[i].dma_handle, GFP_KERNEL);
1061                 if (!buf) {
1062                         dev_err(&pdev->dev, "unable to allocate buffer\n");
1063                         error = -ENOMEM;
1064                         break;
1065                 }
1066
1067                 info->pseudo_palette = &priv->ch[i].pseudo_palette;
1068                 info->flags = FBINFO_FLAG_DEFAULT;
1069
1070                 error = fb_alloc_cmap(&info->cmap, PALETTE_NR, 0);
1071                 if (error < 0) {
1072                         dev_err(&pdev->dev, "unable to allocate cmap\n");
1073                         dma_free_coherent(&pdev->dev, info->fix.smem_len,
1074                                           buf, priv->ch[i].dma_handle);
1075                         break;
1076                 }
1077
1078                 memset(buf, 0, info->fix.smem_len);
1079                 info->fix.smem_start = priv->ch[i].dma_handle;
1080                 info->screen_base = buf;
1081                 info->device = &pdev->dev;
1082                 info->par = &priv->ch[i];
1083         }
1084
1085         if (error)
1086                 goto err1;
1087
1088         error = sh_mobile_lcdc_start(priv);
1089         if (error) {
1090                 dev_err(&pdev->dev, "unable to start hardware\n");
1091                 goto err1;
1092         }
1093
1094         for (i = 0; i < j; i++) {
1095                 struct sh_mobile_lcdc_chan *ch = priv->ch + i;
1096
1097                 info = ch->info;
1098
1099                 if (info->fbdefio) {
1100                         ch->sglist = vmalloc(sizeof(struct scatterlist) *
1101                                         info->fix.smem_len >> PAGE_SHIFT);
1102                         if (!ch->sglist) {
1103                                 dev_err(&pdev->dev, "cannot allocate sglist\n");
1104                                 goto err1;
1105                         }
1106                 }
1107
1108                 error = register_framebuffer(info);
1109                 if (error < 0)
1110                         goto err1;
1111
1112                 dev_info(info->dev,
1113                          "registered %s/%s as %dx%d %dbpp.\n",
1114                          pdev->name,
1115                          (ch->cfg.chan == LCDC_CHAN_MAINLCD) ?
1116                          "mainlcd" : "sublcd",
1117                          (int) ch->cfg.lcd_cfg.xres,
1118                          (int) ch->cfg.lcd_cfg.yres,
1119                          ch->cfg.bpp);
1120
1121                 /* deferred io mode: disable clock to save power */
1122                 if (info->fbdefio)
1123                         sh_mobile_lcdc_clk_off(priv);
1124         }
1125
1126         return 0;
1127 err1:
1128         sh_mobile_lcdc_remove(pdev);
1129
1130         return error;
1131 }
1132
1133 static int sh_mobile_lcdc_remove(struct platform_device *pdev)
1134 {
1135         struct sh_mobile_lcdc_priv *priv = platform_get_drvdata(pdev);
1136         struct fb_info *info;
1137         int i;
1138
1139         for (i = 0; i < ARRAY_SIZE(priv->ch); i++)
1140                 if (priv->ch[i].info && priv->ch[i].info->dev)
1141                         unregister_framebuffer(priv->ch[i].info);
1142
1143         sh_mobile_lcdc_stop(priv);
1144
1145         for (i = 0; i < ARRAY_SIZE(priv->ch); i++) {
1146                 info = priv->ch[i].info;
1147
1148                 if (!info || !info->device)
1149                         continue;
1150
1151                 if (priv->ch[i].sglist)
1152                         vfree(priv->ch[i].sglist);
1153
1154                 dma_free_coherent(&pdev->dev, info->fix.smem_len,
1155                                   info->screen_base, priv->ch[i].dma_handle);
1156                 fb_dealloc_cmap(&info->cmap);
1157                 framebuffer_release(info);
1158         }
1159
1160         if (priv->dot_clk)
1161                 clk_put(priv->dot_clk);
1162
1163         if (priv->dev)
1164                 pm_runtime_disable(priv->dev);
1165
1166         if (priv->base)
1167                 iounmap(priv->base);
1168
1169         if (priv->irq)
1170                 free_irq(priv->irq, priv);
1171         kfree(priv);
1172         return 0;
1173 }
1174
1175 static struct platform_driver sh_mobile_lcdc_driver = {
1176         .driver         = {
1177                 .name           = "sh_mobile_lcdc_fb",
1178                 .owner          = THIS_MODULE,
1179                 .pm             = &sh_mobile_lcdc_dev_pm_ops,
1180         },
1181         .probe          = sh_mobile_lcdc_probe,
1182         .remove         = sh_mobile_lcdc_remove,
1183 };
1184
1185 static int __init sh_mobile_lcdc_init(void)
1186 {
1187         return platform_driver_register(&sh_mobile_lcdc_driver);
1188 }
1189
1190 static void __exit sh_mobile_lcdc_exit(void)
1191 {
1192         platform_driver_unregister(&sh_mobile_lcdc_driver);
1193 }
1194
1195 module_init(sh_mobile_lcdc_init);
1196 module_exit(sh_mobile_lcdc_exit);
1197
1198 MODULE_DESCRIPTION("SuperH Mobile LCDC Framebuffer driver");
1199 MODULE_AUTHOR("Magnus Damm <damm@opensource.se>");
1200 MODULE_LICENSE("GPL v2");