of_display_timing.c 6.7 KB

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