drivers/video/of_display_timing.c

   1 /*
   2  * OF helpers for parsing display timings
   3  *
   4  * Copyright (c) 2012 Steffen Trumtrar <s.trumtrar@pengutronix.de>, Pengutronix
   5  *
   6  * based on of_videomode.c by Sascha Hauer <s.hauer@pengutronix.de>
   7  *
   8  * This file is released under the GPLv2
   9  */
  10 #include <linux/export.h>
  11 #include <linux/of.h>
  12 #include <linux/slab.h>
  13 #include <video/display_timing.h>
  14 #include <video/of_display_timing.h>
  15
  16 /**
  17  * parse_timing_property - parse timing_entry from device_node
  18  * @np: device_node with the property
  19  * @name: name of the property
  20  * @result: will be set to the return value
  21  *
  22  * DESCRIPTION:
  23  * Every display_timing can be specified with either just the typical value or
  24  * a range consisting of min/typ/max. This function helps handling this
  25  **/
  26 static int parse_timing_property(struct device_node *np, const char *name,
  27                           struct timing_entry *result)
  28 {
  29         struct property *prop;
  30         int length, cells, ret;
  31
  32         prop = of_find_property(np, name, &length);
  33         if (!prop) {
  34                 pr_err("%s: could not find property %s\n",
  35                         of_node_full_name(np), name);
  36                 return -EINVAL;
  37         }
  38
  39         cells = length / sizeof(u32);
  40         if (cells == 1) {
  41                 ret = of_property_read_u32(np, name, &result->typ);
  42                 result->min = result->typ;
  43                 result->max = result->typ;
  44         } else if (cells == 3) {
  45                 ret = of_property_read_u32_array(np, name, &result->min, cells);
  46         } else {
  47                 pr_err("%s: illegal timing specification in %s\n",
  48                         of_node_full_name(np), name);
  49                 return -EINVAL;
  50         }
  51
  52         return ret;
  53 }
  54
  55 /**
  56  * of_get_display_timing - parse display_timing entry from device_node
  57  * @np: device_node with the properties
  58  **/
  59 static struct display_timing *of_get_display_timing(struct device_node *np)
  60 {
  61         struct display_timing *dt;
  62         u32 val = 0;
  63         int ret = 0;
  64
  65         dt = kzalloc(sizeof(*dt), GFP_KERNEL);
  66         if (!dt) {
  67                 pr_err("%s: could not allocate display_timing struct\n",
  68                         of_node_full_name(np));
  69                 return NULL;
  70         }
  71
  72         ret |= parse_timing_property(np, "hback-porch", &dt->hback_porch);
  73         ret |= parse_timing_property(np, "hfront-porch", &dt->hfront_porch);
  74         ret |= parse_timing_property(np, "hactive", &dt->hactive);
  75         ret |= parse_timing_property(np, "hsync-len", &dt->hsync_len);
  76         ret |= parse_timing_property(np, "vback-porch", &dt->vback_porch);
  77         ret |= parse_timing_property(np, "vfront-porch", &dt->vfront_porch);
  78         ret |= parse_timing_property(np, "vactive", &dt->vactive);
  79         ret |= parse_timing_property(np, "vsync-len", &dt->vsync_len);
  80         ret |= parse_timing_property(np, "clock-frequency", &dt->pixelclock);
  81
  82         dt->flags = 0;
  83         if (!of_property_read_u32(np, "vsync-active", &val))
  84                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
  85                                 DISPLAY_FLAGS_VSYNC_LOW;
  86         if (!of_property_read_u32(np, "hsync-active", &val))
  87                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
  88                                 DISPLAY_FLAGS_HSYNC_LOW;
  89         if (!of_property_read_u32(np, "de-active", &val))
  90                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
  91                                 DISPLAY_FLAGS_DE_LOW;
  92         if (!of_property_read_u32(np, "pixelclk-active", &val))
  93                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
  94                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
  95
  96         if (of_property_read_bool(np, "interlaced"))
  97                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
  98         if (of_property_read_bool(np, "doublescan"))
  99                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
 100
 101 #if defined(CONFIG_FB_ROCKCHIP) || defined(CONFIG_DRM_ROCKCHIP)
 102         if (!of_property_read_u32(np, "swap-rg", &val))
 103                 dt->flags |= val ? DISPLAY_FLAGS_SWAP_RG : 0;
 104         if (!of_property_read_u32(np, "swap-gb", &val))
 105                 dt->flags |= val ? DISPLAY_FLAGS_SWAP_GB : 0;
 106         if (!of_property_read_u32(np, "swap-rb", &val))
 107                 dt->flags |= val ? DISPLAY_FLAGS_SWAP_RB : 0;
 108         if (!of_property_read_u32(np, "screen-type", &val))
 109                 dt->screen_type = val;
 110         if (!of_property_read_u32(np, "lvds-format", &val))
 111                 dt->lvds_format = val;
 112         if (!of_property_read_u32(np, "out-face", &val))
 113                 dt->face = val;
 114 #endif
 115
 116         if (ret) {
 117                 pr_err("%s: error reading timing properties\n",
 118                         of_node_full_name(np));
 119                 kfree(dt);
 120                 return NULL;
 121         }
 122
 123         return dt;
 124 }
 125
 126 /**
 127  * of_get_display_timings - parse all display_timing entries from a device_node
 128  * @np: device_node with the subnodes
 129  **/
 130 struct display_timings *of_get_display_timings(struct device_node *np)
 131 {
 132         struct device_node *timings_np;
 133         struct device_node *entry;
 134         struct device_node *native_mode;
 135         struct display_timings *disp;
 136
 137         if (!np) {
 138                 pr_err("%s: no devicenode given\n", of_node_full_name(np));
 139                 return NULL;
 140         }
 141
 142         timings_np = of_find_node_by_name(np, "display-timings");
 143         if (!timings_np) {
 144                 pr_err("%s: could not find display-timings node\n",
 145                         of_node_full_name(np));
 146                 return NULL;
 147         }
 148
 149         disp = kzalloc(sizeof(*disp), GFP_KERNEL);
 150         if (!disp) {
 151                 pr_err("%s: could not allocate struct disp'\n",
 152                         of_node_full_name(np));
 153                 goto dispfail;
 154         }
 155
 156         entry = of_parse_phandle(timings_np, "native-mode", 0);
 157         /* assume first child as native mode if none provided */
 158         if (!entry)
 159                 entry = of_get_next_child(np, NULL);
 160         /* if there is no child, it is useless to go on */
 161         if (!entry) {
 162                 pr_err("%s: no timing specifications given\n",
 163                         of_node_full_name(np));
 164                 goto entryfail;
 165         }
 166
 167         pr_debug("%s: using %s as default timing\n",
 168                 of_node_full_name(np), entry->name);
 169
 170         native_mode = entry;
 171
 172         disp->num_timings = of_get_child_count(timings_np);
 173         if (disp->num_timings == 0) {
 174                 /* should never happen, as entry was already found above */
 175                 pr_err("%s: no timings specified\n", of_node_full_name(np));
 176                 goto entryfail;
 177         }
 178
 179         disp->timings = kzalloc(sizeof(struct display_timing *) *
 180                                 disp->num_timings, GFP_KERNEL);
 181         if (!disp->timings) {
 182                 pr_err("%s: could not allocate timings array\n",
 183                         of_node_full_name(np));
 184                 goto entryfail;
 185         }
 186
 187         disp->num_timings = 0;
 188         disp->native_mode = 0;
 189
 190         for_each_child_of_node(timings_np, entry) {
 191                 struct display_timing *dt;
 192
 193                 dt = of_get_display_timing(entry);
 194                 if (!dt) {
 195                         /*
 196                          * to not encourage wrong devicetrees, fail in case of
 197                          * an error
 198                          */
 199                         pr_err("%s: error in timing %d\n",
 200                                 of_node_full_name(np), disp->num_timings + 1);
 201                         goto timingfail;
 202                 }
 203
 204                 if (native_mode == entry)
 205                         disp->native_mode = disp->num_timings;
 206
 207                 disp->timings[disp->num_timings] = dt;
 208                 disp->num_timings++;
 209         }
 210         of_node_put(timings_np);
 211         /*
 212          * native_mode points to the device_node returned by of_parse_phandle
 213          * therefore call of_node_put on it
 214          */
 215         of_node_put(native_mode);
 216
 217         pr_debug("%s: got %d timings. Using timing #%d as default\n",
 218                 of_node_full_name(np), disp->num_timings,
 219                 disp->native_mode + 1);
 220
 221         return disp;
 222
 223 timingfail:
 224         if (native_mode)
 225                 of_node_put(native_mode);
 226         display_timings_release(disp);
 227 entryfail:
 228         kfree(disp);
 229 dispfail:
 230         of_node_put(timings_np);
 231         return NULL;
 232 }
 233 EXPORT_SYMBOL_GPL(of_get_display_timings);
 234
 235 /**
 236  * of_display_timings_exist - check if a display-timings node is provided
 237  * @np: device_node with the timing
 238  **/
 239 int of_display_timings_exist(struct device_node *np)
 240 {
 241         struct device_node *timings_np;
 242
 243         if (!np)
 244                 return -EINVAL;
 245
 246         timings_np = of_parse_phandle(np, "display-timings", 0);
 247         if (!timings_np)
 248                 return -EINVAL;
 249
 250         of_node_put(timings_np);
 251         return 1;
 252 }
 253 EXPORT_SYMBOL_GPL(of_display_timings_exist);