]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - android-sdk/kernel-video.git/blob - drivers/video/fbdev/smscufx.c
OMAPDSS: Add methods for skipping display initialization
[android-sdk/kernel-video.git] / drivers / video / fbdev / smscufx.c
1 /*
2  * smscufx.c -- Framebuffer driver for SMSC UFX USB controller
3  *
4  * Copyright (C) 2011 Steve Glendinning <steve.glendinning@shawell.net>
5  * Copyright (C) 2009 Roberto De Ioris <roberto@unbit.it>
6  * Copyright (C) 2009 Jaya Kumar <jayakumar.lkml@gmail.com>
7  * Copyright (C) 2009 Bernie Thompson <bernie@plugable.com>
8  *
9  * This file is subject to the terms and conditions of the GNU General Public
10  * License v2. See the file COPYING in the main directory of this archive for
11  * more details.
12  *
13  * Based on udlfb, with work from Florian Echtler, Henrik Bjerregaard Pedersen,
14  * and others.
15  *
16  * Works well with Bernie Thompson's X DAMAGE patch to xf86-video-fbdev
17  * available from http://git.plugable.com
18  *
19  * Layout is based on skeletonfb by James Simmons and Geert Uytterhoeven,
20  * usb-skeleton by GregKH.
21  */
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/usb.h>
29 #include <linux/uaccess.h>
30 #include <linux/mm.h>
31 #include <linux/fb.h>
32 #include <linux/vmalloc.h>
33 #include <linux/slab.h>
34 #include <linux/delay.h>
35 #include "edid.h"
37 #define check_warn(status, fmt, args...) \
38         ({ if (status < 0) pr_warn(fmt, ##args); })
40 #define check_warn_return(status, fmt, args...) \
41         ({ if (status < 0) { pr_warn(fmt, ##args); return status; } })
43 #define check_warn_goto_error(status, fmt, args...) \
44         ({ if (status < 0) { pr_warn(fmt, ##args); goto error; } })
46 #define all_bits_set(x, bits) (((x) & (bits)) == (bits))
48 #define USB_VENDOR_REQUEST_WRITE_REGISTER       0xA0
49 #define USB_VENDOR_REQUEST_READ_REGISTER        0xA1
51 /*
52  * TODO: Propose standard fb.h ioctl for reporting damage,
53  * using _IOWR() and one of the existing area structs from fb.h
54  * Consider these ioctls deprecated, but they're still used by the
55  * DisplayLink X server as yet - need both to be modified in tandem
56  * when new ioctl(s) are ready.
57  */
58 #define UFX_IOCTL_RETURN_EDID   (0xAD)
59 #define UFX_IOCTL_REPORT_DAMAGE (0xAA)
61 /* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
62 #define BULK_SIZE               (512)
63 #define MAX_TRANSFER            (PAGE_SIZE*16 - BULK_SIZE)
64 #define WRITES_IN_FLIGHT        (4)
66 #define GET_URB_TIMEOUT         (HZ)
67 #define FREE_URB_TIMEOUT        (HZ*2)
69 #define BPP                     2
71 #define UFX_DEFIO_WRITE_DELAY   5 /* fb_deferred_io.delay in jiffies */
72 #define UFX_DEFIO_WRITE_DISABLE (HZ*60) /* "disable" with long delay */
74 struct dloarea {
75         int x, y;
76         int w, h;
77 };
79 struct urb_node {
80         struct list_head entry;
81         struct ufx_data *dev;
82         struct delayed_work release_urb_work;
83         struct urb *urb;
84 };
86 struct urb_list {
87         struct list_head list;
88         spinlock_t lock;
89         struct semaphore limit_sem;
90         int available;
91         int count;
92         size_t size;
93 };
95 struct ufx_data {
96         struct usb_device *udev;
97         struct device *gdev; /* &udev->dev */
98         struct fb_info *info;
99         struct urb_list urbs;
100         struct kref kref;
101         int fb_count;
102         bool virtualized; /* true when physical usb device not present */
103         struct delayed_work free_framebuffer_work;
104         atomic_t usb_active; /* 0 = update virtual buffer, but no usb traffic */
105         atomic_t lost_pixels; /* 1 = a render op failed. Need screen refresh */
106         u8 *edid; /* null until we read edid from hw or get from sysfs */
107         size_t edid_size;
108         u32 pseudo_palette[256];
109 };
111 static struct fb_fix_screeninfo ufx_fix = {
112         .id =           "smscufx",
113         .type =         FB_TYPE_PACKED_PIXELS,
114         .visual =       FB_VISUAL_TRUECOLOR,
115         .xpanstep =     0,
116         .ypanstep =     0,
117         .ywrapstep =    0,
118         .accel =        FB_ACCEL_NONE,
119 };
121 static const u32 smscufx_info_flags = FBINFO_DEFAULT | FBINFO_READS_FAST |
122         FBINFO_VIRTFB | FBINFO_HWACCEL_IMAGEBLIT | FBINFO_HWACCEL_FILLRECT |
123         FBINFO_HWACCEL_COPYAREA | FBINFO_MISC_ALWAYS_SETPAR;
125 static struct usb_device_id id_table[] = {
126         {USB_DEVICE(0x0424, 0x9d00),},
127         {USB_DEVICE(0x0424, 0x9d01),},
128         {},
129 };
130 MODULE_DEVICE_TABLE(usb, id_table);
132 /* module options */
133 static bool console;   /* Optionally allow fbcon to consume first framebuffer */
134 static bool fb_defio = true;  /* Optionally enable fb_defio mmap support */
136 /* ufx keeps a list of urbs for efficient bulk transfers */
137 static void ufx_urb_completion(struct urb *urb);
138 static struct urb *ufx_get_urb(struct ufx_data *dev);
139 static int ufx_submit_urb(struct ufx_data *dev, struct urb * urb, size_t len);
140 static int ufx_alloc_urb_list(struct ufx_data *dev, int count, size_t size);
141 static void ufx_free_urb_list(struct ufx_data *dev);
143 /* reads a control register */
144 static int ufx_reg_read(struct ufx_data *dev, u32 index, u32 *data)
146         u32 *buf = kmalloc(4, GFP_KERNEL);
147         int ret;
149         BUG_ON(!dev);
151         if (!buf)
152                 return -ENOMEM;
154         ret = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
155                 USB_VENDOR_REQUEST_READ_REGISTER,
156                 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
157                 00, index, buf, 4, USB_CTRL_GET_TIMEOUT);
159         le32_to_cpus(buf);
160         *data = *buf;
161         kfree(buf);
163         if (unlikely(ret < 0))
164                 pr_warn("Failed to read register index 0x%08x\n", index);
166         return ret;
169 /* writes a control register */
170 static int ufx_reg_write(struct ufx_data *dev, u32 index, u32 data)
172         u32 *buf = kmalloc(4, GFP_KERNEL);
173         int ret;
175         BUG_ON(!dev);
177         if (!buf)
178                 return -ENOMEM;
180         *buf = data;
181         cpu_to_le32s(buf);
183         ret = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
184                 USB_VENDOR_REQUEST_WRITE_REGISTER,
185                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
186                 00, index, buf, 4, USB_CTRL_SET_TIMEOUT);
188         kfree(buf);
190         if (unlikely(ret < 0))
191                 pr_warn("Failed to write register index 0x%08x with value "
192                         "0x%08x\n", index, data);
194         return ret;
197 static int ufx_reg_clear_and_set_bits(struct ufx_data *dev, u32 index,
198         u32 bits_to_clear, u32 bits_to_set)
200         u32 data;
201         int status = ufx_reg_read(dev, index, &data);
202         check_warn_return(status, "ufx_reg_clear_and_set_bits error reading "
203                 "0x%x", index);
205         data &= (~bits_to_clear);
206         data |= bits_to_set;
208         status = ufx_reg_write(dev, index, data);
209         check_warn_return(status, "ufx_reg_clear_and_set_bits error writing "
210                 "0x%x", index);
212         return 0;
215 static int ufx_reg_set_bits(struct ufx_data *dev, u32 index, u32 bits)
217         return ufx_reg_clear_and_set_bits(dev, index, 0, bits);
220 static int ufx_reg_clear_bits(struct ufx_data *dev, u32 index, u32 bits)
222         return ufx_reg_clear_and_set_bits(dev, index, bits, 0);
225 static int ufx_lite_reset(struct ufx_data *dev)
227         int status;
228         u32 value;
230         status = ufx_reg_write(dev, 0x3008, 0x00000001);
231         check_warn_return(status, "ufx_lite_reset error writing 0x3008");
233         status = ufx_reg_read(dev, 0x3008, &value);
234         check_warn_return(status, "ufx_lite_reset error reading 0x3008");
236         return (value == 0) ? 0 : -EIO;
239 /* If display is unblanked, then blank it */
240 static int ufx_blank(struct ufx_data *dev, bool wait)
242         u32 dc_ctrl, dc_sts;
243         int i;
245         int status = ufx_reg_read(dev, 0x2004, &dc_sts);
246         check_warn_return(status, "ufx_blank error reading 0x2004");
248         status = ufx_reg_read(dev, 0x2000, &dc_ctrl);
249         check_warn_return(status, "ufx_blank error reading 0x2000");
251         /* return success if display is already blanked */
252         if ((dc_sts & 0x00000100) || (dc_ctrl & 0x00000100))
253                 return 0;
255         /* request the DC to blank the display */
256         dc_ctrl |= 0x00000100;
257         status = ufx_reg_write(dev, 0x2000, dc_ctrl);
258         check_warn_return(status, "ufx_blank error writing 0x2000");
260         /* return success immediately if we don't have to wait */
261         if (!wait)
262                 return 0;
264         for (i = 0; i < 250; i++) {
265                 status = ufx_reg_read(dev, 0x2004, &dc_sts);
266                 check_warn_return(status, "ufx_blank error reading 0x2004");
268                 if (dc_sts & 0x00000100)
269                         return 0;
270         }
272         /* timed out waiting for display to blank */
273         return -EIO;
276 /* If display is blanked, then unblank it */
277 static int ufx_unblank(struct ufx_data *dev, bool wait)
279         u32 dc_ctrl, dc_sts;
280         int i;
282         int status = ufx_reg_read(dev, 0x2004, &dc_sts);
283         check_warn_return(status, "ufx_unblank error reading 0x2004");
285         status = ufx_reg_read(dev, 0x2000, &dc_ctrl);
286         check_warn_return(status, "ufx_unblank error reading 0x2000");
288         /* return success if display is already unblanked */
289         if (((dc_sts & 0x00000100) == 0) || ((dc_ctrl & 0x00000100) == 0))
290                 return 0;
292         /* request the DC to unblank the display */
293         dc_ctrl &= ~0x00000100;
294         status = ufx_reg_write(dev, 0x2000, dc_ctrl);
295         check_warn_return(status, "ufx_unblank error writing 0x2000");
297         /* return success immediately if we don't have to wait */
298         if (!wait)
299                 return 0;
301         for (i = 0; i < 250; i++) {
302                 status = ufx_reg_read(dev, 0x2004, &dc_sts);
303                 check_warn_return(status, "ufx_unblank error reading 0x2004");
305                 if ((dc_sts & 0x00000100) == 0)
306                         return 0;
307         }
309         /* timed out waiting for display to unblank */
310         return -EIO;
313 /* If display is enabled, then disable it */
314 static int ufx_disable(struct ufx_data *dev, bool wait)
316         u32 dc_ctrl, dc_sts;
317         int i;
319         int status = ufx_reg_read(dev, 0x2004, &dc_sts);
320         check_warn_return(status, "ufx_disable error reading 0x2004");
322         status = ufx_reg_read(dev, 0x2000, &dc_ctrl);
323         check_warn_return(status, "ufx_disable error reading 0x2000");
325         /* return success if display is already disabled */
326         if (((dc_sts & 0x00000001) == 0) || ((dc_ctrl & 0x00000001) == 0))
327                 return 0;
329         /* request the DC to disable the display */
330         dc_ctrl &= ~(0x00000001);
331         status = ufx_reg_write(dev, 0x2000, dc_ctrl);
332         check_warn_return(status, "ufx_disable error writing 0x2000");
334         /* return success immediately if we don't have to wait */
335         if (!wait)
336                 return 0;
338         for (i = 0; i < 250; i++) {
339                 status = ufx_reg_read(dev, 0x2004, &dc_sts);
340                 check_warn_return(status, "ufx_disable error reading 0x2004");
342                 if ((dc_sts & 0x00000001) == 0)
343                         return 0;
344         }
346         /* timed out waiting for display to disable */
347         return -EIO;
350 /* If display is disabled, then enable it */
351 static int ufx_enable(struct ufx_data *dev, bool wait)
353         u32 dc_ctrl, dc_sts;
354         int i;
356         int status = ufx_reg_read(dev, 0x2004, &dc_sts);
357         check_warn_return(status, "ufx_enable error reading 0x2004");
359         status = ufx_reg_read(dev, 0x2000, &dc_ctrl);
360         check_warn_return(status, "ufx_enable error reading 0x2000");
362         /* return success if display is already enabled */
363         if ((dc_sts & 0x00000001) || (dc_ctrl & 0x00000001))
364                 return 0;
366         /* request the DC to enable the display */
367         dc_ctrl |= 0x00000001;
368         status = ufx_reg_write(dev, 0x2000, dc_ctrl);
369         check_warn_return(status, "ufx_enable error writing 0x2000");
371         /* return success immediately if we don't have to wait */
372         if (!wait)
373                 return 0;
375         for (i = 0; i < 250; i++) {
376                 status = ufx_reg_read(dev, 0x2004, &dc_sts);
377                 check_warn_return(status, "ufx_enable error reading 0x2004");
379                 if (dc_sts & 0x00000001)
380                         return 0;
381         }
383         /* timed out waiting for display to enable */
384         return -EIO;
387 static int ufx_config_sys_clk(struct ufx_data *dev)
389         int status = ufx_reg_write(dev, 0x700C, 0x8000000F);
390         check_warn_return(status, "error writing 0x700C");
392         status = ufx_reg_write(dev, 0x7014, 0x0010024F);
393         check_warn_return(status, "error writing 0x7014");
395         status = ufx_reg_write(dev, 0x7010, 0x00000000);
396         check_warn_return(status, "error writing 0x7010");
398         status = ufx_reg_clear_bits(dev, 0x700C, 0x0000000A);
399         check_warn_return(status, "error clearing PLL1 bypass in 0x700C");
400         msleep(1);
402         status = ufx_reg_clear_bits(dev, 0x700C, 0x80000000);
403         check_warn_return(status, "error clearing output gate in 0x700C");
405         return 0;
408 static int ufx_config_ddr2(struct ufx_data *dev)
410         int status, i = 0;
411         u32 tmp;
413         status = ufx_reg_write(dev, 0x0004, 0x001F0F77);
414         check_warn_return(status, "error writing 0x0004");
416         status = ufx_reg_write(dev, 0x0008, 0xFFF00000);
417         check_warn_return(status, "error writing 0x0008");
419         status = ufx_reg_write(dev, 0x000C, 0x0FFF2222);
420         check_warn_return(status, "error writing 0x000C");
422         status = ufx_reg_write(dev, 0x0010, 0x00030814);
423         check_warn_return(status, "error writing 0x0010");
425         status = ufx_reg_write(dev, 0x0014, 0x00500019);
426         check_warn_return(status, "error writing 0x0014");
428         status = ufx_reg_write(dev, 0x0018, 0x020D0F15);
429         check_warn_return(status, "error writing 0x0018");
431         status = ufx_reg_write(dev, 0x001C, 0x02532305);
432         check_warn_return(status, "error writing 0x001C");
434         status = ufx_reg_write(dev, 0x0020, 0x0B030905);
435         check_warn_return(status, "error writing 0x0020");
437         status = ufx_reg_write(dev, 0x0024, 0x00000827);
438         check_warn_return(status, "error writing 0x0024");
440         status = ufx_reg_write(dev, 0x0028, 0x00000000);
441         check_warn_return(status, "error writing 0x0028");
443         status = ufx_reg_write(dev, 0x002C, 0x00000042);
444         check_warn_return(status, "error writing 0x002C");
446         status = ufx_reg_write(dev, 0x0030, 0x09520000);
447         check_warn_return(status, "error writing 0x0030");
449         status = ufx_reg_write(dev, 0x0034, 0x02223314);
450         check_warn_return(status, "error writing 0x0034");
452         status = ufx_reg_write(dev, 0x0038, 0x00430043);
453         check_warn_return(status, "error writing 0x0038");
455         status = ufx_reg_write(dev, 0x003C, 0xF00F000F);
456         check_warn_return(status, "error writing 0x003C");
458         status = ufx_reg_write(dev, 0x0040, 0xF380F00F);
459         check_warn_return(status, "error writing 0x0040");
461         status = ufx_reg_write(dev, 0x0044, 0xF00F0496);
462         check_warn_return(status, "error writing 0x0044");
464         status = ufx_reg_write(dev, 0x0048, 0x03080406);
465         check_warn_return(status, "error writing 0x0048");
467         status = ufx_reg_write(dev, 0x004C, 0x00001000);
468         check_warn_return(status, "error writing 0x004C");
470         status = ufx_reg_write(dev, 0x005C, 0x00000007);
471         check_warn_return(status, "error writing 0x005C");
473         status = ufx_reg_write(dev, 0x0100, 0x54F00012);
474         check_warn_return(status, "error writing 0x0100");
476         status = ufx_reg_write(dev, 0x0104, 0x00004012);
477         check_warn_return(status, "error writing 0x0104");
479         status = ufx_reg_write(dev, 0x0118, 0x40404040);
480         check_warn_return(status, "error writing 0x0118");
482         status = ufx_reg_write(dev, 0x0000, 0x00000001);
483         check_warn_return(status, "error writing 0x0000");
485         while (i++ < 500) {
486                 status = ufx_reg_read(dev, 0x0000, &tmp);
487                 check_warn_return(status, "error reading 0x0000");
489                 if (all_bits_set(tmp, 0xC0000000))
490                         return 0;
491         }
493         pr_err("DDR2 initialisation timed out, reg 0x0000=0x%08x", tmp);
494         return -ETIMEDOUT;
497 struct pll_values {
498         u32 div_r0;
499         u32 div_f0;
500         u32 div_q0;
501         u32 range0;
502         u32 div_r1;
503         u32 div_f1;
504         u32 div_q1;
505         u32 range1;
506 };
508 static u32 ufx_calc_range(u32 ref_freq)
510         if (ref_freq >= 88000000)
511                 return 7;
513         if (ref_freq >= 54000000)
514                 return 6;
516         if (ref_freq >= 34000000)
517                 return 5;
519         if (ref_freq >= 21000000)
520                 return 4;
522         if (ref_freq >= 13000000)
523                 return 3;
525         if (ref_freq >= 8000000)
526                 return 2;
528         return 1;
531 /* calculates PLL divider settings for a desired target frequency */
532 static void ufx_calc_pll_values(const u32 clk_pixel_pll, struct pll_values *asic_pll)
534         const u32 ref_clk = 25000000;
535         u32 div_r0, div_f0, div_q0, div_r1, div_f1, div_q1;
536         u32 min_error = clk_pixel_pll;
538         for (div_r0 = 1; div_r0 <= 32; div_r0++) {
539                 u32 ref_freq0 = ref_clk / div_r0;
540                 if (ref_freq0 < 5000000)
541                         break;
543                 if (ref_freq0 > 200000000)
544                         continue;
546                 for (div_f0 = 1; div_f0 <= 256; div_f0++) {
547                         u32 vco_freq0 = ref_freq0 * div_f0;
549                         if (vco_freq0 < 350000000)
550                                 continue;
552                         if (vco_freq0 > 700000000)
553                                 break;
555                         for (div_q0 = 0; div_q0 < 7; div_q0++) {
556                                 u32 pllout_freq0 = vco_freq0 / (1 << div_q0);
558                                 if (pllout_freq0 < 5000000)
559                                         break;
561                                 if (pllout_freq0 > 200000000)
562                                         continue;
564                                 for (div_r1 = 1; div_r1 <= 32; div_r1++) {
565                                         u32 ref_freq1 = pllout_freq0 / div_r1;
567                                         if (ref_freq1 < 5000000)
568                                                 break;
570                                         for (div_f1 = 1; div_f1 <= 256; div_f1++) {
571                                                 u32 vco_freq1 = ref_freq1 * div_f1;
573                                                 if (vco_freq1 < 350000000)
574                                                         continue;
576                                                 if (vco_freq1 > 700000000)
577                                                         break;
579                                                 for (div_q1 = 0; div_q1 < 7; div_q1++) {
580                                                         u32 pllout_freq1 = vco_freq1 / (1 << div_q1);
581                                                         int error = abs(pllout_freq1 - clk_pixel_pll);
583                                                         if (pllout_freq1 < 5000000)
584                                                                 break;
586                                                         if (pllout_freq1 > 700000000)
587                                                                 continue;
589                                                         if (error < min_error) {
590                                                                 min_error = error;
592                                                                 /* final returned value is equal to calculated value - 1
593                                                                  * because a value of 0 = divide by 1 */
594                                                                 asic_pll->div_r0 = div_r0 - 1;
595                                                                 asic_pll->div_f0 = div_f0 - 1;
596                                                                 asic_pll->div_q0 = div_q0;
597                                                                 asic_pll->div_r1 = div_r1 - 1;
598                                                                 asic_pll->div_f1 = div_f1 - 1;
599                                                                 asic_pll->div_q1 = div_q1;
601                                                                 asic_pll->range0 = ufx_calc_range(ref_freq0);
602                                                                 asic_pll->range1 = ufx_calc_range(ref_freq1);
604                                                                 if (min_error == 0)
605                                                                         return;
606                                                         }
607                                                 }
608                                         }
609                                 }
610                         }
611                 }
612         }
615 /* sets analog bit PLL configuration values */
616 static int ufx_config_pix_clk(struct ufx_data *dev, u32 pixclock)
618         struct pll_values asic_pll = {0};
619         u32 value, clk_pixel, clk_pixel_pll;
620         int status;
622         /* convert pixclock (in ps) to frequency (in Hz) */
623         clk_pixel = PICOS2KHZ(pixclock) * 1000;
624         pr_debug("pixclock %d ps = clk_pixel %d Hz", pixclock, clk_pixel);
626         /* clk_pixel = 1/2 clk_pixel_pll */
627         clk_pixel_pll = clk_pixel * 2;
629         ufx_calc_pll_values(clk_pixel_pll, &asic_pll);
631         /* Keep BYPASS and RESET signals asserted until configured */
632         status = ufx_reg_write(dev, 0x7000, 0x8000000F);
633         check_warn_return(status, "error writing 0x7000");
635         value = (asic_pll.div_f1 | (asic_pll.div_r1 << 8) |
636                 (asic_pll.div_q1 << 16) | (asic_pll.range1 << 20));
637         status = ufx_reg_write(dev, 0x7008, value);
638         check_warn_return(status, "error writing 0x7008");
640         value = (asic_pll.div_f0 | (asic_pll.div_r0 << 8) |
641                 (asic_pll.div_q0 << 16) | (asic_pll.range0 << 20));
642         status = ufx_reg_write(dev, 0x7004, value);
643         check_warn_return(status, "error writing 0x7004");
645         status = ufx_reg_clear_bits(dev, 0x7000, 0x00000005);
646         check_warn_return(status,
647                 "error clearing PLL0 bypass bits in 0x7000");
648         msleep(1);
650         status = ufx_reg_clear_bits(dev, 0x7000, 0x0000000A);
651         check_warn_return(status,
652                 "error clearing PLL1 bypass bits in 0x7000");
653         msleep(1);
655         status = ufx_reg_clear_bits(dev, 0x7000, 0x80000000);
656         check_warn_return(status, "error clearing gate bits in 0x7000");
658         return 0;
661 static int ufx_set_vid_mode(struct ufx_data *dev, struct fb_var_screeninfo *var)
663         u32 temp;
664         u16 h_total, h_active, h_blank_start, h_blank_end, h_sync_start, h_sync_end;
665         u16 v_total, v_active, v_blank_start, v_blank_end, v_sync_start, v_sync_end;
667         int status = ufx_reg_write(dev, 0x8028, 0);
668         check_warn_return(status, "ufx_set_vid_mode error disabling RGB pad");
670         status = ufx_reg_write(dev, 0x8024, 0);
671         check_warn_return(status, "ufx_set_vid_mode error disabling VDAC");
673         /* shut everything down before changing timing */
674         status = ufx_blank(dev, true);
675         check_warn_return(status, "ufx_set_vid_mode error blanking display");
677         status = ufx_disable(dev, true);
678         check_warn_return(status, "ufx_set_vid_mode error disabling display");
680         status = ufx_config_pix_clk(dev, var->pixclock);
681         check_warn_return(status, "ufx_set_vid_mode error configuring pixclock");
683         status = ufx_reg_write(dev, 0x2000, 0x00000104);
684         check_warn_return(status, "ufx_set_vid_mode error writing 0x2000");
686         /* set horizontal timings */
687         h_total = var->xres + var->right_margin + var->hsync_len + var->left_margin;
688         h_active = var->xres;
689         h_blank_start = var->xres + var->right_margin;
690         h_blank_end = var->xres + var->right_margin + var->hsync_len;
691         h_sync_start = var->xres + var->right_margin;
692         h_sync_end = var->xres + var->right_margin + var->hsync_len;
694         temp = ((h_total - 1) << 16) | (h_active - 1);
695         status = ufx_reg_write(dev, 0x2008, temp);
696         check_warn_return(status, "ufx_set_vid_mode error writing 0x2008");
698         temp = ((h_blank_start - 1) << 16) | (h_blank_end - 1);
699         status = ufx_reg_write(dev, 0x200C, temp);
700         check_warn_return(status, "ufx_set_vid_mode error writing 0x200C");
702         temp = ((h_sync_start - 1) << 16) | (h_sync_end - 1);
703         status = ufx_reg_write(dev, 0x2010, temp);
704         check_warn_return(status, "ufx_set_vid_mode error writing 0x2010");
706         /* set vertical timings */
707         v_total = var->upper_margin + var->yres + var->lower_margin + var->vsync_len;
708         v_active = var->yres;
709         v_blank_start = var->yres + var->lower_margin;
710         v_blank_end = var->yres + var->lower_margin + var->vsync_len;
711         v_sync_start = var->yres + var->lower_margin;
712         v_sync_end = var->yres + var->lower_margin + var->vsync_len;
714         temp = ((v_total - 1) << 16) | (v_active - 1);
715         status = ufx_reg_write(dev, 0x2014, temp);
716         check_warn_return(status, "ufx_set_vid_mode error writing 0x2014");
718         temp = ((v_blank_start - 1) << 16) | (v_blank_end - 1);
719         status = ufx_reg_write(dev, 0x2018, temp);
720         check_warn_return(status, "ufx_set_vid_mode error writing 0x2018");
722         temp = ((v_sync_start - 1) << 16) | (v_sync_end - 1);
723         status = ufx_reg_write(dev, 0x201C, temp);
724         check_warn_return(status, "ufx_set_vid_mode error writing 0x201C");
726         status = ufx_reg_write(dev, 0x2020, 0x00000000);
727         check_warn_return(status, "ufx_set_vid_mode error writing 0x2020");
729         status = ufx_reg_write(dev, 0x2024, 0x00000000);
730         check_warn_return(status, "ufx_set_vid_mode error writing 0x2024");
732         /* Set the frame length register (#pix * 2 bytes/pixel) */
733         temp = var->xres * var->yres * 2;
734         temp = (temp + 7) & (~0x7);
735         status = ufx_reg_write(dev, 0x2028, temp);
736         check_warn_return(status, "ufx_set_vid_mode error writing 0x2028");
738         /* enable desired output interface & disable others */
739         status = ufx_reg_write(dev, 0x2040, 0);
740         check_warn_return(status, "ufx_set_vid_mode error writing 0x2040");
742         status = ufx_reg_write(dev, 0x2044, 0);
743         check_warn_return(status, "ufx_set_vid_mode error writing 0x2044");
745         status = ufx_reg_write(dev, 0x2048, 0);
746         check_warn_return(status, "ufx_set_vid_mode error writing 0x2048");
748         /* set the sync polarities & enable bit */
749         temp = 0x00000001;
750         if (var->sync & FB_SYNC_HOR_HIGH_ACT)
751                 temp |= 0x00000010;
753         if (var->sync & FB_SYNC_VERT_HIGH_ACT)
754                 temp |= 0x00000008;
756         status = ufx_reg_write(dev, 0x2040, temp);
757         check_warn_return(status, "ufx_set_vid_mode error writing 0x2040");
759         /* start everything back up */
760         status = ufx_enable(dev, true);
761         check_warn_return(status, "ufx_set_vid_mode error enabling display");
763         /* Unblank the display */
764         status = ufx_unblank(dev, true);
765         check_warn_return(status, "ufx_set_vid_mode error unblanking display");
767         /* enable RGB pad */
768         status = ufx_reg_write(dev, 0x8028, 0x00000003);
769         check_warn_return(status, "ufx_set_vid_mode error enabling RGB pad");
771         /* enable VDAC */
772         status = ufx_reg_write(dev, 0x8024, 0x00000007);
773         check_warn_return(status, "ufx_set_vid_mode error enabling VDAC");
775         return 0;
778 static int ufx_ops_mmap(struct fb_info *info, struct vm_area_struct *vma)
780         unsigned long start = vma->vm_start;
781         unsigned long size = vma->vm_end - vma->vm_start;
782         unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
783         unsigned long page, pos;
785         if (vma->vm_pgoff > (~0UL >> PAGE_SHIFT))
786                 return -EINVAL;
787         if (size > info->fix.smem_len)
788                 return -EINVAL;
789         if (offset > info->fix.smem_len - size)
790                 return -EINVAL;
792         pos = (unsigned long)info->fix.smem_start + offset;
794         pr_debug("mmap() framebuffer addr:%lu size:%lu\n",
795                   pos, size);
797         while (size > 0) {
798                 page = vmalloc_to_pfn((void *)pos);
799                 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
800                         return -EAGAIN;
802                 start += PAGE_SIZE;
803                 pos += PAGE_SIZE;
804                 if (size > PAGE_SIZE)
805                         size -= PAGE_SIZE;
806                 else
807                         size = 0;
808         }
810         return 0;
813 static void ufx_raw_rect(struct ufx_data *dev, u16 *cmd, int x, int y,
814         int width, int height)
816         size_t packed_line_len = ALIGN((width * 2), 4);
817         size_t packed_rect_len = packed_line_len * height;
818         int line;
820         BUG_ON(!dev);
821         BUG_ON(!dev->info);
823         /* command word */
824         *((u32 *)&cmd[0]) = cpu_to_le32(0x01);
826         /* length word */
827         *((u32 *)&cmd[2]) = cpu_to_le32(packed_rect_len + 16);
829         cmd[4] = cpu_to_le16(x);
830         cmd[5] = cpu_to_le16(y);
831         cmd[6] = cpu_to_le16(width);
832         cmd[7] = cpu_to_le16(height);
834         /* frame base address */
835         *((u32 *)&cmd[8]) = cpu_to_le32(0);
837         /* color mode and horizontal resolution */
838         cmd[10] = cpu_to_le16(0x4000 | dev->info->var.xres);
840         /* vertical resolution */
841         cmd[11] = cpu_to_le16(dev->info->var.yres);
843         /* packed data */
844         for (line = 0; line < height; line++) {
845                 const int line_offset = dev->info->fix.line_length * (y + line);
846                 const int byte_offset = line_offset + (x * BPP);
847                 memcpy(&cmd[(24 + (packed_line_len * line)) / 2],
848                         (char *)dev->info->fix.smem_start + byte_offset, width * BPP);
849         }
852 static int ufx_handle_damage(struct ufx_data *dev, int x, int y,
853         int width, int height)
855         size_t packed_line_len = ALIGN((width * 2), 4);
856         int len, status, urb_lines, start_line = 0;
858         if ((width <= 0) || (height <= 0) ||
859             (x + width > dev->info->var.xres) ||
860             (y + height > dev->info->var.yres))
861                 return -EINVAL;
863         if (!atomic_read(&dev->usb_active))
864                 return 0;
866         while (start_line < height) {
867                 struct urb *urb = ufx_get_urb(dev);
868                 if (!urb) {
869                         pr_warn("ufx_handle_damage unable to get urb");
870                         return 0;
871                 }
873                 /* assume we have enough space to transfer at least one line */
874                 BUG_ON(urb->transfer_buffer_length < (24 + (width * 2)));
876                 /* calculate the maximum number of lines we could fit in */
877                 urb_lines = (urb->transfer_buffer_length - 24) / packed_line_len;
879                 /* but we might not need this many */
880                 urb_lines = min(urb_lines, (height - start_line));
882                 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
884                 ufx_raw_rect(dev, urb->transfer_buffer, x, (y + start_line), width, urb_lines);
885                 len = 24 + (packed_line_len * urb_lines);
887                 status = ufx_submit_urb(dev, urb, len);
888                 check_warn_return(status, "Error submitting URB");
890                 start_line += urb_lines;
891         }
893         return 0;
896 /* Path triggered by usermode clients who write to filesystem
897  * e.g. cat filename > /dev/fb1
898  * Not used by X Windows or text-mode console. But useful for testing.
899  * Slow because of extra copy and we must assume all pixels dirty. */
900 static ssize_t ufx_ops_write(struct fb_info *info, const char __user *buf,
901                           size_t count, loff_t *ppos)
903         ssize_t result;
904         struct ufx_data *dev = info->par;
905         u32 offset = (u32) *ppos;
907         result = fb_sys_write(info, buf, count, ppos);
909         if (result > 0) {
910                 int start = max((int)(offset / info->fix.line_length), 0);
911                 int lines = min((u32)((result / info->fix.line_length) + 1),
912                                 (u32)info->var.yres);
914                 ufx_handle_damage(dev, 0, start, info->var.xres, lines);
915         }
917         return result;
920 static void ufx_ops_copyarea(struct fb_info *info,
921                                 const struct fb_copyarea *area)
924         struct ufx_data *dev = info->par;
926         sys_copyarea(info, area);
928         ufx_handle_damage(dev, area->dx, area->dy,
929                         area->width, area->height);
932 static void ufx_ops_imageblit(struct fb_info *info,
933                                 const struct fb_image *image)
935         struct ufx_data *dev = info->par;
937         sys_imageblit(info, image);
939         ufx_handle_damage(dev, image->dx, image->dy,
940                         image->width, image->height);
943 static void ufx_ops_fillrect(struct fb_info *info,
944                           const struct fb_fillrect *rect)
946         struct ufx_data *dev = info->par;
948         sys_fillrect(info, rect);
950         ufx_handle_damage(dev, rect->dx, rect->dy, rect->width,
951                               rect->height);
954 /* NOTE: fb_defio.c is holding info->fbdefio.mutex
955  *   Touching ANY framebuffer memory that triggers a page fault
956  *   in fb_defio will cause a deadlock, when it also tries to
957  *   grab the same mutex. */
958 static void ufx_dpy_deferred_io(struct fb_info *info,
959                                 struct list_head *pagelist)
961         struct page *cur;
962         struct fb_deferred_io *fbdefio = info->fbdefio;
963         struct ufx_data *dev = info->par;
965         if (!fb_defio)
966                 return;
968         if (!atomic_read(&dev->usb_active))
969                 return;
971         /* walk the written page list and render each to device */
972         list_for_each_entry(cur, &fbdefio->pagelist, lru) {
973                 /* create a rectangle of full screen width that encloses the
974                  * entire dirty framebuffer page */
975                 const int x = 0;
976                 const int width = dev->info->var.xres;
977                 const int y = (cur->index << PAGE_SHIFT) / (width * 2);
978                 int height = (PAGE_SIZE / (width * 2)) + 1;
979                 height = min(height, (int)(dev->info->var.yres - y));
981                 BUG_ON(y >= dev->info->var.yres);
982                 BUG_ON((y + height) > dev->info->var.yres);
984                 ufx_handle_damage(dev, x, y, width, height);
985         }
988 static int ufx_ops_ioctl(struct fb_info *info, unsigned int cmd,
989                          unsigned long arg)
991         struct ufx_data *dev = info->par;
992         struct dloarea *area = NULL;
994         if (!atomic_read(&dev->usb_active))
995                 return 0;
997         /* TODO: Update X server to get this from sysfs instead */
998         if (cmd == UFX_IOCTL_RETURN_EDID) {
999                 u8 __user *edid = (u8 __user *)arg;
1000                 if (copy_to_user(edid, dev->edid, dev->edid_size))
1001                         return -EFAULT;
1002                 return 0;
1003         }
1005         /* TODO: Help propose a standard fb.h ioctl to report mmap damage */
1006         if (cmd == UFX_IOCTL_REPORT_DAMAGE) {
1007                 /* If we have a damage-aware client, turn fb_defio "off"
1008                  * To avoid perf imact of unnecessary page fault handling.
1009                  * Done by resetting the delay for this fb_info to a very
1010                  * long period. Pages will become writable and stay that way.
1011                  * Reset to normal value when all clients have closed this fb.
1012                  */
1013                 if (info->fbdefio)
1014                         info->fbdefio->delay = UFX_DEFIO_WRITE_DISABLE;
1016                 area = (struct dloarea *)arg;
1018                 if (area->x < 0)
1019                         area->x = 0;
1021                 if (area->x > info->var.xres)
1022                         area->x = info->var.xres;
1024                 if (area->y < 0)
1025                         area->y = 0;
1027                 if (area->y > info->var.yres)
1028                         area->y = info->var.yres;
1030                 ufx_handle_damage(dev, area->x, area->y, area->w, area->h);
1031         }
1033         return 0;
1036 /* taken from vesafb */
1037 static int
1038 ufx_ops_setcolreg(unsigned regno, unsigned red, unsigned green,
1039                unsigned blue, unsigned transp, struct fb_info *info)
1041         int err = 0;
1043         if (regno >= info->cmap.len)
1044                 return 1;
1046         if (regno < 16) {
1047                 if (info->var.red.offset == 10) {
1048                         /* 1:5:5:5 */
1049                         ((u32 *) (info->pseudo_palette))[regno] =
1050                             ((red & 0xf800) >> 1) |
1051                             ((green & 0xf800) >> 6) | ((blue & 0xf800) >> 11);
1052                 } else {
1053                         /* 0:5:6:5 */
1054                         ((u32 *) (info->pseudo_palette))[regno] =
1055                             ((red & 0xf800)) |
1056                             ((green & 0xfc00) >> 5) | ((blue & 0xf800) >> 11);
1057                 }
1058         }
1060         return err;
1063 /* It's common for several clients to have framebuffer open simultaneously.
1064  * e.g. both fbcon and X. Makes things interesting.
1065  * Assumes caller is holding info->lock (for open and release at least) */
1066 static int ufx_ops_open(struct fb_info *info, int user)
1068         struct ufx_data *dev = info->par;
1070         /* fbcon aggressively connects to first framebuffer it finds,
1071          * preventing other clients (X) from working properly. Usually
1072          * not what the user wants. Fail by default with option to enable. */
1073         if (user == 0 && !console)
1074                 return -EBUSY;
1076         /* If the USB device is gone, we don't accept new opens */
1077         if (dev->virtualized)
1078                 return -ENODEV;
1080         dev->fb_count++;
1082         kref_get(&dev->kref);
1084         if (fb_defio && (info->fbdefio == NULL)) {
1085                 /* enable defio at last moment if not disabled by client */
1087                 struct fb_deferred_io *fbdefio;
1089                 fbdefio = kzalloc(sizeof(struct fb_deferred_io), GFP_KERNEL);
1091                 if (fbdefio) {
1092                         fbdefio->delay = UFX_DEFIO_WRITE_DELAY;
1093                         fbdefio->deferred_io = ufx_dpy_deferred_io;
1094                 }
1096                 info->fbdefio = fbdefio;
1097                 fb_deferred_io_init(info);
1098         }
1100         pr_debug("open /dev/fb%d user=%d fb_info=%p count=%d",
1101                 info->node, user, info, dev->fb_count);
1103         return 0;
1106 /*
1107  * Called when all client interfaces to start transactions have been disabled,
1108  * and all references to our device instance (ufx_data) are released.
1109  * Every transaction must have a reference, so we know are fully spun down
1110  */
1111 static void ufx_free(struct kref *kref)
1113         struct ufx_data *dev = container_of(kref, struct ufx_data, kref);
1115         /* this function will wait for all in-flight urbs to complete */
1116         if (dev->urbs.count > 0)
1117                 ufx_free_urb_list(dev);
1119         pr_debug("freeing ufx_data %p", dev);
1121         kfree(dev);
1124 static void ufx_release_urb_work(struct work_struct *work)
1126         struct urb_node *unode = container_of(work, struct urb_node,
1127                                               release_urb_work.work);
1129         up(&unode->dev->urbs.limit_sem);
1132 static void ufx_free_framebuffer_work(struct work_struct *work)
1134         struct ufx_data *dev = container_of(work, struct ufx_data,
1135                                             free_framebuffer_work.work);
1136         struct fb_info *info = dev->info;
1137         int node = info->node;
1139         unregister_framebuffer(info);
1141         if (info->cmap.len != 0)
1142                 fb_dealloc_cmap(&info->cmap);
1143         if (info->monspecs.modedb)
1144                 fb_destroy_modedb(info->monspecs.modedb);
1145         if (info->screen_base)
1146                 vfree(info->screen_base);
1148         fb_destroy_modelist(&info->modelist);
1150         dev->info = NULL;
1152         /* Assume info structure is freed after this point */
1153         framebuffer_release(info);
1155         pr_debug("fb_info for /dev/fb%d has been freed", node);
1157         /* ref taken in probe() as part of registering framebfufer */
1158         kref_put(&dev->kref, ufx_free);
1161 /*
1162  * Assumes caller is holding info->lock mutex (for open and release at least)
1163  */
1164 static int ufx_ops_release(struct fb_info *info, int user)
1166         struct ufx_data *dev = info->par;
1168         dev->fb_count--;
1170         /* We can't free fb_info here - fbmem will touch it when we return */
1171         if (dev->virtualized && (dev->fb_count == 0))
1172                 schedule_delayed_work(&dev->free_framebuffer_work, HZ);
1174         if ((dev->fb_count == 0) && (info->fbdefio)) {
1175                 fb_deferred_io_cleanup(info);
1176                 kfree(info->fbdefio);
1177                 info->fbdefio = NULL;
1178                 info->fbops->fb_mmap = ufx_ops_mmap;
1179         }
1181         pr_debug("released /dev/fb%d user=%d count=%d",
1182                   info->node, user, dev->fb_count);
1184         kref_put(&dev->kref, ufx_free);
1186         return 0;
1189 /* Check whether a video mode is supported by the chip
1190  * We start from monitor's modes, so don't need to filter that here */
1191 static int ufx_is_valid_mode(struct fb_videomode *mode,
1192                 struct fb_info *info)
1194         if ((mode->xres * mode->yres) > (2048 * 1152)) {
1195                 pr_debug("%dx%d too many pixels",
1196                        mode->xres, mode->yres);
1197                 return 0;
1198         }
1200         if (mode->pixclock < 5000) {
1201                 pr_debug("%dx%d %dps pixel clock too fast",
1202                        mode->xres, mode->yres, mode->pixclock);
1203                 return 0;
1204         }
1206         pr_debug("%dx%d (pixclk %dps %dMHz) valid mode", mode->xres, mode->yres,
1207                 mode->pixclock, (1000000 / mode->pixclock));
1208         return 1;
1211 static void ufx_var_color_format(struct fb_var_screeninfo *var)
1213         const struct fb_bitfield red = { 11, 5, 0 };
1214         const struct fb_bitfield green = { 5, 6, 0 };
1215         const struct fb_bitfield blue = { 0, 5, 0 };
1217         var->bits_per_pixel = 16;
1218         var->red = red;
1219         var->green = green;
1220         var->blue = blue;
1223 static int ufx_ops_check_var(struct fb_var_screeninfo *var,
1224                                 struct fb_info *info)
1226         struct fb_videomode mode;
1228         /* TODO: support dynamically changing framebuffer size */
1229         if ((var->xres * var->yres * 2) > info->fix.smem_len)
1230                 return -EINVAL;
1232         /* set device-specific elements of var unrelated to mode */
1233         ufx_var_color_format(var);
1235         fb_var_to_videomode(&mode, var);
1237         if (!ufx_is_valid_mode(&mode, info))
1238                 return -EINVAL;
1240         return 0;
1243 static int ufx_ops_set_par(struct fb_info *info)
1245         struct ufx_data *dev = info->par;
1246         int result;
1247         u16 *pix_framebuffer;
1248         int i;
1250         pr_debug("set_par mode %dx%d", info->var.xres, info->var.yres);
1251         result = ufx_set_vid_mode(dev, &info->var);
1253         if ((result == 0) && (dev->fb_count == 0)) {
1254                 /* paint greenscreen */
1255                 pix_framebuffer = (u16 *) info->screen_base;
1256                 for (i = 0; i < info->fix.smem_len / 2; i++)
1257                         pix_framebuffer[i] = 0x37e6;
1259                 ufx_handle_damage(dev, 0, 0, info->var.xres, info->var.yres);
1260         }
1262         /* re-enable defio if previously disabled by damage tracking */
1263         if (info->fbdefio)
1264                 info->fbdefio->delay = UFX_DEFIO_WRITE_DELAY;
1266         return result;
1269 /* In order to come back from full DPMS off, we need to set the mode again */
1270 static int ufx_ops_blank(int blank_mode, struct fb_info *info)
1272         struct ufx_data *dev = info->par;
1273         ufx_set_vid_mode(dev, &info->var);
1274         return 0;
1277 static struct fb_ops ufx_ops = {
1278         .owner = THIS_MODULE,
1279         .fb_read = fb_sys_read,
1280         .fb_write = ufx_ops_write,
1281         .fb_setcolreg = ufx_ops_setcolreg,
1282         .fb_fillrect = ufx_ops_fillrect,
1283         .fb_copyarea = ufx_ops_copyarea,
1284         .fb_imageblit = ufx_ops_imageblit,
1285         .fb_mmap = ufx_ops_mmap,
1286         .fb_ioctl = ufx_ops_ioctl,
1287         .fb_open = ufx_ops_open,
1288         .fb_release = ufx_ops_release,
1289         .fb_blank = ufx_ops_blank,
1290         .fb_check_var = ufx_ops_check_var,
1291         .fb_set_par = ufx_ops_set_par,
1292 };
1294 /* Assumes &info->lock held by caller
1295  * Assumes no active clients have framebuffer open */
1296 static int ufx_realloc_framebuffer(struct ufx_data *dev, struct fb_info *info)
1298         int retval = -ENOMEM;
1299         int old_len = info->fix.smem_len;
1300         int new_len;
1301         unsigned char *old_fb = info->screen_base;
1302         unsigned char *new_fb;
1304         pr_debug("Reallocating framebuffer. Addresses will change!");
1306         new_len = info->fix.line_length * info->var.yres;
1308         if (PAGE_ALIGN(new_len) > old_len) {
1309                 /*
1310                  * Alloc system memory for virtual framebuffer
1311                  */
1312                 new_fb = vmalloc(new_len);
1313                 if (!new_fb) {
1314                         pr_err("Virtual framebuffer alloc failed");
1315                         goto error;
1316                 }
1318                 if (info->screen_base) {
1319                         memcpy(new_fb, old_fb, old_len);
1320                         vfree(info->screen_base);
1321                 }
1323                 info->screen_base = new_fb;
1324                 info->fix.smem_len = PAGE_ALIGN(new_len);
1325                 info->fix.smem_start = (unsigned long) new_fb;
1326                 info->flags = smscufx_info_flags;
1327         }
1329         retval = 0;
1331 error:
1332         return retval;
1335 /* sets up I2C Controller for 100 Kbps, std. speed, 7-bit addr, master,
1336  * restart enabled, but no start byte, enable controller */
1337 static int ufx_i2c_init(struct ufx_data *dev)
1339         u32 tmp;
1341         /* disable the controller before it can be reprogrammed */
1342         int status = ufx_reg_write(dev, 0x106C, 0x00);
1343         check_warn_return(status, "failed to disable I2C");
1345         /* Setup the clock count registers
1346          * (12+1) = 13 clks @ 2.5 MHz = 5.2 uS */
1347         status = ufx_reg_write(dev, 0x1018, 12);
1348         check_warn_return(status, "error writing 0x1018");
1350         /* (6+8) = 14 clks @ 2.5 MHz = 5.6 uS */
1351         status = ufx_reg_write(dev, 0x1014, 6);
1352         check_warn_return(status, "error writing 0x1014");
1354         status = ufx_reg_read(dev, 0x1000, &tmp);
1355         check_warn_return(status, "error reading 0x1000");
1357         /* set speed to std mode */
1358         tmp &= ~(0x06);
1359         tmp |= 0x02;
1361         /* 7-bit (not 10-bit) addressing */
1362         tmp &= ~(0x10);
1364         /* enable restart conditions and master mode */
1365         tmp |= 0x21;
1367         status = ufx_reg_write(dev, 0x1000, tmp);
1368         check_warn_return(status, "error writing 0x1000");
1370         /* Set normal tx using target address 0 */
1371         status = ufx_reg_clear_and_set_bits(dev, 0x1004, 0xC00, 0x000);
1372         check_warn_return(status, "error setting TX mode bits in 0x1004");
1374         /* Enable the controller */
1375         status = ufx_reg_write(dev, 0x106C, 0x01);
1376         check_warn_return(status, "failed to enable I2C");
1378         return 0;
1381 /* sets the I2C port mux and target address */
1382 static int ufx_i2c_configure(struct ufx_data *dev)
1384         int status = ufx_reg_write(dev, 0x106C, 0x00);
1385         check_warn_return(status, "failed to disable I2C");
1387         status = ufx_reg_write(dev, 0x3010, 0x00000000);
1388         check_warn_return(status, "failed to write 0x3010");
1390         /* A0h is std for any EDID, right shifted by one */
1391         status = ufx_reg_clear_and_set_bits(dev, 0x1004, 0x3FF, (0xA0 >> 1));
1392         check_warn_return(status, "failed to set TAR bits in 0x1004");
1394         status = ufx_reg_write(dev, 0x106C, 0x01);
1395         check_warn_return(status, "failed to enable I2C");
1397         return 0;
1400 /* wait for BUSY to clear, with a timeout of 50ms with 10ms sleeps. if no
1401  * monitor is connected, there is no error except for timeout */
1402 static int ufx_i2c_wait_busy(struct ufx_data *dev)
1404         u32 tmp;
1405         int i, status;
1407         for (i = 0; i < 15; i++) {
1408                 status = ufx_reg_read(dev, 0x1100, &tmp);
1409                 check_warn_return(status, "0x1100 read failed");
1411                 /* if BUSY is clear, check for error */
1412                 if ((tmp & 0x80000000) == 0) {
1413                         if (tmp & 0x20000000) {
1414                                 pr_warn("I2C read failed, 0x1100=0x%08x", tmp);
1415                                 return -EIO;
1416                         }
1418                         return 0;
1419                 }
1421                 /* perform the first 10 retries without delay */
1422                 if (i >= 10)
1423                         msleep(10);
1424         }
1426         pr_warn("I2C access timed out, resetting I2C hardware");
1427         status =  ufx_reg_write(dev, 0x1100, 0x40000000);
1428         check_warn_return(status, "0x1100 write failed");
1430         return -ETIMEDOUT;
1433 /* reads a 128-byte EDID block from the currently selected port and TAR */
1434 static int ufx_read_edid(struct ufx_data *dev, u8 *edid, int edid_len)
1436         int i, j, status;
1437         u32 *edid_u32 = (u32 *)edid;
1439         BUG_ON(edid_len != EDID_LENGTH);
1441         status = ufx_i2c_configure(dev);
1442         if (status < 0) {
1443                 pr_err("ufx_i2c_configure failed");
1444                 return status;
1445         }
1447         memset(edid, 0xff, EDID_LENGTH);
1449         /* Read the 128-byte EDID as 2 bursts of 64 bytes */
1450         for (i = 0; i < 2; i++) {
1451                 u32 temp = 0x28070000 | (63 << 20) | (((u32)(i * 64)) << 8);
1452                 status = ufx_reg_write(dev, 0x1100, temp);
1453                 check_warn_return(status, "Failed to write 0x1100");
1455                 temp |= 0x80000000;
1456                 status = ufx_reg_write(dev, 0x1100, temp);
1457                 check_warn_return(status, "Failed to write 0x1100");
1459                 status = ufx_i2c_wait_busy(dev);
1460                 check_warn_return(status, "Timeout waiting for I2C BUSY to clear");
1462                 for (j = 0; j < 16; j++) {
1463                         u32 data_reg_addr = 0x1110 + (j * 4);
1464                         status = ufx_reg_read(dev, data_reg_addr, edid_u32++);
1465                         check_warn_return(status, "Error reading i2c data");
1466                 }
1467         }
1469         /* all FF's in the first 16 bytes indicates nothing is connected */
1470         for (i = 0; i < 16; i++) {
1471                 if (edid[i] != 0xFF) {
1472                         pr_debug("edid data read successfully");
1473                         return EDID_LENGTH;
1474                 }
1475         }
1477         pr_warn("edid data contains all 0xff");
1478         return -ETIMEDOUT;
1481 /* 1) use sw default
1482  * 2) Parse into various fb_info structs
1483  * 3) Allocate virtual framebuffer memory to back highest res mode
1484  *
1485  * Parses EDID into three places used by various parts of fbdev:
1486  * fb_var_screeninfo contains the timing of the monitor's preferred mode
1487  * fb_info.monspecs is full parsed EDID info, including monspecs.modedb
1488  * fb_info.modelist is a linked list of all monitor & VESA modes which work
1489  *
1490  * If EDID is not readable/valid, then modelist is all VESA modes,
1491  * monspecs is NULL, and fb_var_screeninfo is set to safe VESA mode
1492  * Returns 0 if successful */
1493 static int ufx_setup_modes(struct ufx_data *dev, struct fb_info *info,
1494         char *default_edid, size_t default_edid_size)
1496         const struct fb_videomode *default_vmode = NULL;
1497         u8 *edid;
1498         int i, result = 0, tries = 3;
1500         if (info->dev) /* only use mutex if info has been registered */
1501                 mutex_lock(&info->lock);
1503         edid = kmalloc(EDID_LENGTH, GFP_KERNEL);
1504         if (!edid) {
1505                 result = -ENOMEM;
1506                 goto error;
1507         }
1509         fb_destroy_modelist(&info->modelist);
1510         memset(&info->monspecs, 0, sizeof(info->monspecs));
1512         /* Try to (re)read EDID from hardware first
1513          * EDID data may return, but not parse as valid
1514          * Try again a few times, in case of e.g. analog cable noise */
1515         while (tries--) {
1516                 i = ufx_read_edid(dev, edid, EDID_LENGTH);
1518                 if (i >= EDID_LENGTH)
1519                         fb_edid_to_monspecs(edid, &info->monspecs);
1521                 if (info->monspecs.modedb_len > 0) {
1522                         dev->edid = edid;
1523                         dev->edid_size = i;
1524                         break;
1525                 }
1526         }
1528         /* If that fails, use a previously returned EDID if available */
1529         if (info->monspecs.modedb_len == 0) {
1530                 pr_err("Unable to get valid EDID from device/display\n");
1532                 if (dev->edid) {
1533                         fb_edid_to_monspecs(dev->edid, &info->monspecs);
1534                         if (info->monspecs.modedb_len > 0)
1535                                 pr_err("Using previously queried EDID\n");
1536                 }
1537         }
1539         /* If that fails, use the default EDID we were handed */
1540         if (info->monspecs.modedb_len == 0) {
1541                 if (default_edid_size >= EDID_LENGTH) {
1542                         fb_edid_to_monspecs(default_edid, &info->monspecs);
1543                         if (info->monspecs.modedb_len > 0) {
1544                                 memcpy(edid, default_edid, default_edid_size);
1545                                 dev->edid = edid;
1546                                 dev->edid_size = default_edid_size;
1547                                 pr_err("Using default/backup EDID\n");
1548                         }
1549                 }
1550         }
1552         /* If we've got modes, let's pick a best default mode */
1553         if (info->monspecs.modedb_len > 0) {
1555                 for (i = 0; i < info->monspecs.modedb_len; i++) {
1556                         if (ufx_is_valid_mode(&info->monspecs.modedb[i], info))
1557                                 fb_add_videomode(&info->monspecs.modedb[i],
1558                                         &info->modelist);
1559                         else /* if we've removed top/best mode */
1560                                 info->monspecs.misc &= ~FB_MISC_1ST_DETAIL;
1561                 }
1563                 default_vmode = fb_find_best_display(&info->monspecs,
1564                                                      &info->modelist);
1565         }
1567         /* If everything else has failed, fall back to safe default mode */
1568         if (default_vmode == NULL) {
1570                 struct fb_videomode fb_vmode = {0};
1572                 /* Add the standard VESA modes to our modelist
1573                  * Since we don't have EDID, there may be modes that
1574                  * overspec monitor and/or are incorrect aspect ratio, etc.
1575                  * But at least the user has a chance to choose
1576                  */
1577                 for (i = 0; i < VESA_MODEDB_SIZE; i++) {
1578                         if (ufx_is_valid_mode((struct fb_videomode *)
1579                                                 &vesa_modes[i], info))
1580                                 fb_add_videomode(&vesa_modes[i],
1581                                                  &info->modelist);
1582                 }
1584                 /* default to resolution safe for projectors
1585                  * (since they are most common case without EDID)
1586                  */
1587                 fb_vmode.xres = 800;
1588                 fb_vmode.yres = 600;
1589                 fb_vmode.refresh = 60;
1590                 default_vmode = fb_find_nearest_mode(&fb_vmode,
1591                                                      &info->modelist);
1592         }
1594         /* If we have good mode and no active clients */
1595         if ((default_vmode != NULL) && (dev->fb_count == 0)) {
1597                 fb_videomode_to_var(&info->var, default_vmode);
1598                 ufx_var_color_format(&info->var);
1600                 /* with mode size info, we can now alloc our framebuffer */
1601                 memcpy(&info->fix, &ufx_fix, sizeof(ufx_fix));
1602                 info->fix.line_length = info->var.xres *
1603                         (info->var.bits_per_pixel / 8);
1605                 result = ufx_realloc_framebuffer(dev, info);
1607         } else
1608                 result = -EINVAL;
1610 error:
1611         if (edid && (dev->edid != edid))
1612                 kfree(edid);
1614         if (info->dev)
1615                 mutex_unlock(&info->lock);
1617         return result;
1620 static int ufx_usb_probe(struct usb_interface *interface,
1621                         const struct usb_device_id *id)
1623         struct usb_device *usbdev;
1624         struct ufx_data *dev;
1625         struct fb_info *info = NULL;
1626         int retval = -ENOMEM;
1627         u32 id_rev, fpga_rev;
1629         /* usb initialization */
1630         usbdev = interface_to_usbdev(interface);
1631         BUG_ON(!usbdev);
1633         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1634         if (dev == NULL) {
1635                 dev_err(&usbdev->dev, "ufx_usb_probe: failed alloc of dev struct\n");
1636                 goto error;
1637         }
1639         /* we need to wait for both usb and fbdev to spin down on disconnect */
1640         kref_init(&dev->kref); /* matching kref_put in usb .disconnect fn */
1641         kref_get(&dev->kref); /* matching kref_put in free_framebuffer_work */
1643         dev->udev = usbdev;
1644         dev->gdev = &usbdev->dev; /* our generic struct device * */
1645         usb_set_intfdata(interface, dev);
1647         dev_dbg(dev->gdev, "%s %s - serial #%s\n",
1648                 usbdev->manufacturer, usbdev->product, usbdev->serial);
1649         dev_dbg(dev->gdev, "vid_%04x&pid_%04x&rev_%04x driver's ufx_data struct at %p\n",
1650                 usbdev->descriptor.idVendor, usbdev->descriptor.idProduct,
1651                 usbdev->descriptor.bcdDevice, dev);
1652         dev_dbg(dev->gdev, "console enable=%d\n", console);
1653         dev_dbg(dev->gdev, "fb_defio enable=%d\n", fb_defio);
1655         if (!ufx_alloc_urb_list(dev, WRITES_IN_FLIGHT, MAX_TRANSFER)) {
1656                 retval = -ENOMEM;
1657                 dev_err(dev->gdev, "ufx_alloc_urb_list failed\n");
1658                 goto error;
1659         }
1661         /* We don't register a new USB class. Our client interface is fbdev */
1663         /* allocates framebuffer driver structure, not framebuffer memory */
1664         info = framebuffer_alloc(0, &usbdev->dev);
1665         if (!info) {
1666                 retval = -ENOMEM;
1667                 dev_err(dev->gdev, "framebuffer_alloc failed\n");
1668                 goto error;
1669         }
1671         dev->info = info;
1672         info->par = dev;
1673         info->pseudo_palette = dev->pseudo_palette;
1674         info->fbops = &ufx_ops;
1676         retval = fb_alloc_cmap(&info->cmap, 256, 0);
1677         if (retval < 0) {
1678                 dev_err(dev->gdev, "fb_alloc_cmap failed %x\n", retval);
1679                 goto error;
1680         }
1682         INIT_DELAYED_WORK(&dev->free_framebuffer_work,
1683                           ufx_free_framebuffer_work);
1685         INIT_LIST_HEAD(&info->modelist);
1687         retval = ufx_reg_read(dev, 0x3000, &id_rev);
1688         check_warn_goto_error(retval, "error %d reading 0x3000 register from device", retval);
1689         dev_dbg(dev->gdev, "ID_REV register value 0x%08x", id_rev);
1691         retval = ufx_reg_read(dev, 0x3004, &fpga_rev);
1692         check_warn_goto_error(retval, "error %d reading 0x3004 register from device", retval);
1693         dev_dbg(dev->gdev, "FPGA_REV register value 0x%08x", fpga_rev);
1695         dev_dbg(dev->gdev, "resetting device");
1696         retval = ufx_lite_reset(dev);
1697         check_warn_goto_error(retval, "error %d resetting device", retval);
1699         dev_dbg(dev->gdev, "configuring system clock");
1700         retval = ufx_config_sys_clk(dev);
1701         check_warn_goto_error(retval, "error %d configuring system clock", retval);
1703         dev_dbg(dev->gdev, "configuring DDR2 controller");
1704         retval = ufx_config_ddr2(dev);
1705         check_warn_goto_error(retval, "error %d initialising DDR2 controller", retval);
1707         dev_dbg(dev->gdev, "configuring I2C controller");
1708         retval = ufx_i2c_init(dev);
1709         check_warn_goto_error(retval, "error %d initialising I2C controller", retval);
1711         dev_dbg(dev->gdev, "selecting display mode");
1712         retval = ufx_setup_modes(dev, info, NULL, 0);
1713         check_warn_goto_error(retval, "unable to find common mode for display and adapter");
1715         retval = ufx_reg_set_bits(dev, 0x4000, 0x00000001);
1716         check_warn_goto_error(retval, "error %d enabling graphics engine", retval);
1718         /* ready to begin using device */
1719         atomic_set(&dev->usb_active, 1);
1721         dev_dbg(dev->gdev, "checking var");
1722         retval = ufx_ops_check_var(&info->var, info);
1723         check_warn_goto_error(retval, "error %d ufx_ops_check_var", retval);
1725         dev_dbg(dev->gdev, "setting par");
1726         retval = ufx_ops_set_par(info);
1727         check_warn_goto_error(retval, "error %d ufx_ops_set_par", retval);
1729         dev_dbg(dev->gdev, "registering framebuffer");
1730         retval = register_framebuffer(info);
1731         check_warn_goto_error(retval, "error %d register_framebuffer", retval);
1733         dev_info(dev->gdev, "SMSC UDX USB device /dev/fb%d attached. %dx%d resolution."
1734                 " Using %dK framebuffer memory\n", info->node,
1735                 info->var.xres, info->var.yres, info->fix.smem_len >> 10);
1737         return 0;
1739 error:
1740         if (dev) {
1741                 if (info) {
1742                         if (info->cmap.len != 0)
1743                                 fb_dealloc_cmap(&info->cmap);
1744                         if (info->monspecs.modedb)
1745                                 fb_destroy_modedb(info->monspecs.modedb);
1746                         if (info->screen_base)
1747                                 vfree(info->screen_base);
1749                         fb_destroy_modelist(&info->modelist);
1751                         framebuffer_release(info);
1752                 }
1754                 kref_put(&dev->kref, ufx_free); /* ref for framebuffer */
1755                 kref_put(&dev->kref, ufx_free); /* last ref from kref_init */
1757                 /* dev has been deallocated. Do not dereference */
1758         }
1760         return retval;
1763 static void ufx_usb_disconnect(struct usb_interface *interface)
1765         struct ufx_data *dev;
1766         struct fb_info *info;
1768         dev = usb_get_intfdata(interface);
1769         info = dev->info;
1771         pr_debug("USB disconnect starting\n");
1773         /* we virtualize until all fb clients release. Then we free */
1774         dev->virtualized = true;
1776         /* When non-active we'll update virtual framebuffer, but no new urbs */
1777         atomic_set(&dev->usb_active, 0);
1779         usb_set_intfdata(interface, NULL);
1781         /* if clients still have us open, will be freed on last close */
1782         if (dev->fb_count == 0)
1783                 schedule_delayed_work(&dev->free_framebuffer_work, 0);
1785         /* release reference taken by kref_init in probe() */
1786         kref_put(&dev->kref, ufx_free);
1788         /* consider ufx_data freed */
1791 static struct usb_driver ufx_driver = {
1792         .name = "smscufx",
1793         .probe = ufx_usb_probe,
1794         .disconnect = ufx_usb_disconnect,
1795         .id_table = id_table,
1796 };
1798 module_usb_driver(ufx_driver);
1800 static void ufx_urb_completion(struct urb *urb)
1802         struct urb_node *unode = urb->context;
1803         struct ufx_data *dev = unode->dev;
1804         unsigned long flags;
1806         /* sync/async unlink faults aren't errors */
1807         if (urb->status) {
1808                 if (!(urb->status == -ENOENT ||
1809                     urb->status == -ECONNRESET ||
1810                     urb->status == -ESHUTDOWN)) {
1811                         pr_err("%s - nonzero write bulk status received: %d\n",
1812                                 __func__, urb->status);
1813                         atomic_set(&dev->lost_pixels, 1);
1814                 }
1815         }
1817         urb->transfer_buffer_length = dev->urbs.size; /* reset to actual */
1819         spin_lock_irqsave(&dev->urbs.lock, flags);
1820         list_add_tail(&unode->entry, &dev->urbs.list);
1821         dev->urbs.available++;
1822         spin_unlock_irqrestore(&dev->urbs.lock, flags);
1824         /* When using fb_defio, we deadlock if up() is called
1825          * while another is waiting. So queue to another process */
1826         if (fb_defio)
1827                 schedule_delayed_work(&unode->release_urb_work, 0);
1828         else
1829                 up(&dev->urbs.limit_sem);
1832 static void ufx_free_urb_list(struct ufx_data *dev)
1834         int count = dev->urbs.count;
1835         struct list_head *node;
1836         struct urb_node *unode;
1837         struct urb *urb;
1838         int ret;
1839         unsigned long flags;
1841         pr_debug("Waiting for completes and freeing all render urbs\n");
1843         /* keep waiting and freeing, until we've got 'em all */
1844         while (count--) {
1845                 /* Getting interrupted means a leak, but ok at shutdown*/
1846                 ret = down_interruptible(&dev->urbs.limit_sem);
1847                 if (ret)
1848                         break;
1850                 spin_lock_irqsave(&dev->urbs.lock, flags);
1852                 node = dev->urbs.list.next; /* have reserved one with sem */
1853                 list_del_init(node);
1855                 spin_unlock_irqrestore(&dev->urbs.lock, flags);
1857                 unode = list_entry(node, struct urb_node, entry);
1858                 urb = unode->urb;
1860                 /* Free each separately allocated piece */
1861                 usb_free_coherent(urb->dev, dev->urbs.size,
1862                                   urb->transfer_buffer, urb->transfer_dma);
1863                 usb_free_urb(urb);
1864                 kfree(node);
1865         }
1868 static int ufx_alloc_urb_list(struct ufx_data *dev, int count, size_t size)
1870         int i = 0;
1871         struct urb *urb;
1872         struct urb_node *unode;
1873         char *buf;
1875         spin_lock_init(&dev->urbs.lock);
1877         dev->urbs.size = size;
1878         INIT_LIST_HEAD(&dev->urbs.list);
1880         while (i < count) {
1881                 unode = kzalloc(sizeof(struct urb_node), GFP_KERNEL);
1882                 if (!unode)
1883                         break;
1884                 unode->dev = dev;
1886                 INIT_DELAYED_WORK(&unode->release_urb_work,
1887                           ufx_release_urb_work);
1889                 urb = usb_alloc_urb(0, GFP_KERNEL);
1890                 if (!urb) {
1891                         kfree(unode);
1892                         break;
1893                 }
1894                 unode->urb = urb;
1896                 buf = usb_alloc_coherent(dev->udev, size, GFP_KERNEL,
1897                                          &urb->transfer_dma);
1898                 if (!buf) {
1899                         kfree(unode);
1900                         usb_free_urb(urb);
1901                         break;
1902                 }
1904                 /* urb->transfer_buffer_length set to actual before submit */
1905                 usb_fill_bulk_urb(urb, dev->udev, usb_sndbulkpipe(dev->udev, 1),
1906                         buf, size, ufx_urb_completion, unode);
1907                 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1909                 list_add_tail(&unode->entry, &dev->urbs.list);
1911                 i++;
1912         }
1914         sema_init(&dev->urbs.limit_sem, i);
1915         dev->urbs.count = i;
1916         dev->urbs.available = i;
1918         pr_debug("allocated %d %d byte urbs\n", i, (int) size);
1920         return i;
1923 static struct urb *ufx_get_urb(struct ufx_data *dev)
1925         int ret = 0;
1926         struct list_head *entry;
1927         struct urb_node *unode;
1928         struct urb *urb = NULL;
1929         unsigned long flags;
1931         /* Wait for an in-flight buffer to complete and get re-queued */
1932         ret = down_timeout(&dev->urbs.limit_sem, GET_URB_TIMEOUT);
1933         if (ret) {
1934                 atomic_set(&dev->lost_pixels, 1);
1935                 pr_warn("wait for urb interrupted: %x available: %d\n",
1936                        ret, dev->urbs.available);
1937                 goto error;
1938         }
1940         spin_lock_irqsave(&dev->urbs.lock, flags);
1942         BUG_ON(list_empty(&dev->urbs.list)); /* reserved one with limit_sem */
1943         entry = dev->urbs.list.next;
1944         list_del_init(entry);
1945         dev->urbs.available--;
1947         spin_unlock_irqrestore(&dev->urbs.lock, flags);
1949         unode = list_entry(entry, struct urb_node, entry);
1950         urb = unode->urb;
1952 error:
1953         return urb;
1956 static int ufx_submit_urb(struct ufx_data *dev, struct urb *urb, size_t len)
1958         int ret;
1960         BUG_ON(len > dev->urbs.size);
1962         urb->transfer_buffer_length = len; /* set to actual payload len */
1963         ret = usb_submit_urb(urb, GFP_KERNEL);
1964         if (ret) {
1965                 ufx_urb_completion(urb); /* because no one else will */
1966                 atomic_set(&dev->lost_pixels, 1);
1967                 pr_err("usb_submit_urb error %x\n", ret);
1968         }
1969         return ret;
1972 module_param(console, bool, S_IWUSR | S_IRUSR | S_IWGRP | S_IRGRP);
1973 MODULE_PARM_DESC(console, "Allow fbcon to be used on this display");
1975 module_param(fb_defio, bool, S_IWUSR | S_IRUSR | S_IWGRP | S_IRGRP);
1976 MODULE_PARM_DESC(fb_defio, "Enable fb_defio mmap support");
1978 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
1979 MODULE_DESCRIPTION("SMSC UFX kernel framebuffer driver");
1980 MODULE_LICENSE("GPL");