dsi_phy.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2016-2020, The Linux Foundation. All rights reserved.
  4. */
  5. #ifndef _DSI_PHY_H_
  6. #define _DSI_PHY_H_
  7. #include "dsi_defs.h"
  8. #include "dsi_clk.h"
  9. #include "dsi_pwr.h"
  10. #include "dsi_phy_hw.h"
  11. #include "dsi_pll.h"
  12. struct dsi_ver_spec_info {
  13. enum dsi_phy_version version;
  14. u32 lane_cfg_count;
  15. u32 strength_cfg_count;
  16. u32 regulator_cfg_count;
  17. u32 timing_cfg_count;
  18. };
  19. /**
  20. * struct dsi_phy_power_info - digital and analog power supplies for DSI PHY
  21. * @digital: Digital power supply for DSI PHY.
  22. * @phy_pwr: Analog power supplies for DSI PHY to work.
  23. */
  24. struct dsi_phy_power_info {
  25. struct dsi_regulator_info digital;
  26. struct dsi_regulator_info phy_pwr;
  27. };
  28. /**
  29. * enum phy_engine_state - define engine status for dsi phy.
  30. * @DSI_PHY_ENGINE_OFF: Engine is turned off.
  31. * @DSI_PHY_ENGINE_ON: Engine is turned on.
  32. * @DSI_PHY_ENGINE_MAX: Maximum value.
  33. */
  34. enum phy_engine_state {
  35. DSI_PHY_ENGINE_OFF = 0,
  36. DSI_PHY_ENGINE_ON,
  37. DSI_PHY_ENGINE_MAX,
  38. };
  39. /**
  40. * enum phy_ulps_return_type - define set_ulps return type for dsi phy.
  41. * @DSI_PHY_ULPS_HANDLED: ulps is handled in phy.
  42. * @DSI_PHY_ULPS_NOT_HANDLED: ulps is not handled in phy.
  43. * @DSI_PHY_ULPS_ERROR: ulps request failed in phy.
  44. */
  45. enum phy_ulps_return_type {
  46. DSI_PHY_ULPS_HANDLED = 0,
  47. DSI_PHY_ULPS_NOT_HANDLED,
  48. DSI_PHY_ULPS_ERROR,
  49. };
  50. /**
  51. * struct msm_dsi_phy - DSI PHY object
  52. * @pdev: Pointer to platform device.
  53. * @index: Instance id.
  54. * @name: Name of the PHY instance.
  55. * @refcount: Reference count.
  56. * @phy_lock: Mutex for hardware and object access.
  57. * @ver_info: Version specific phy parameters.
  58. * @hw: DSI PHY hardware object.
  59. * @pwr_info: Power information.
  60. * @cfg: DSI phy configuration.
  61. * @clk_cb: structure containing call backs for clock control
  62. * @power_state: True if PHY is powered on.
  63. * @dsi_phy_state: PHY state information.
  64. * @mode: Current mode.
  65. * @data_lanes: Number of data lanes used.
  66. * @dst_format: Destination format.
  67. * @pll: Pointer to PLL resource.
  68. * @allow_phy_power_off: True if PHY is allowed to power off when idle
  69. * @regulator_min_datarate_bps: Minimum per lane data rate to turn on regulator
  70. * @regulator_required: True if phy regulator is required
  71. */
  72. struct msm_dsi_phy {
  73. struct platform_device *pdev;
  74. int index;
  75. const char *name;
  76. u32 refcount;
  77. struct mutex phy_lock;
  78. const struct dsi_ver_spec_info *ver_info;
  79. struct dsi_phy_hw hw;
  80. struct dsi_phy_power_info pwr_info;
  81. struct dsi_phy_cfg cfg;
  82. struct clk_ctrl_cb clk_cb;
  83. enum phy_engine_state dsi_phy_state;
  84. bool power_state;
  85. struct dsi_mode_info mode;
  86. enum dsi_data_lanes data_lanes;
  87. enum dsi_pixel_format dst_format;
  88. struct dsi_pll_resource *pll;
  89. bool allow_phy_power_off;
  90. u32 regulator_min_datarate_bps;
  91. bool regulator_required;
  92. };
  93. /**
  94. * dsi_phy_get() - get a dsi phy handle from device node
  95. * @of_node: device node for dsi phy controller
  96. *
  97. * Gets the DSI PHY handle for the corresponding of_node. The ref count is
  98. * incremented to one all subsequents get will fail until the original client
  99. * calls a put.
  100. *
  101. * Return: DSI PHY handle or an error code.
  102. */
  103. struct msm_dsi_phy *dsi_phy_get(struct device_node *of_node);
  104. /**
  105. * dsi_phy_put() - release dsi phy handle
  106. * @dsi_phy: DSI PHY handle.
  107. *
  108. * Release the DSI PHY hardware. Driver will clean up all resources and puts
  109. * back the DSI PHY into reset state.
  110. */
  111. void dsi_phy_put(struct msm_dsi_phy *dsi_phy);
  112. /**
  113. * dsi_phy_get_version() - returns dsi phy version
  114. * @dsi_phy: DSI PHY handle.
  115. *
  116. * Return: phy version
  117. */
  118. int dsi_phy_get_version(struct msm_dsi_phy *phy);
  119. /**
  120. * dsi_phy_drv_init() - initialize dsi phy driver
  121. * @dsi_phy: DSI PHY handle.
  122. *
  123. * Initializes DSI PHY driver. Should be called after dsi_phy_get().
  124. *
  125. * Return: error code.
  126. */
  127. int dsi_phy_drv_init(struct msm_dsi_phy *dsi_phy);
  128. /**
  129. * dsi_phy_drv_deinit() - de-initialize dsi phy driver
  130. * @dsi_phy: DSI PHY handle.
  131. *
  132. * Release all resources acquired by dsi_phy_drv_init().
  133. *
  134. * Return: error code.
  135. */
  136. int dsi_phy_drv_deinit(struct msm_dsi_phy *dsi_phy);
  137. /**
  138. * dsi_phy_validate_mode() - validate a display mode
  139. * @dsi_phy: DSI PHY handle.
  140. * @mode: Mode information.
  141. *
  142. * Validation will fail if the mode cannot be supported by the PHY driver or
  143. * hardware.
  144. *
  145. * Return: error code.
  146. */
  147. int dsi_phy_validate_mode(struct msm_dsi_phy *dsi_phy,
  148. struct dsi_mode_info *mode);
  149. /**
  150. * dsi_phy_set_power_state() - enable/disable dsi phy power supplies
  151. * @dsi_phy: DSI PHY handle.
  152. * @enable: Boolean flag to enable/disable.
  153. *
  154. * Return: error code.
  155. */
  156. int dsi_phy_set_power_state(struct msm_dsi_phy *dsi_phy, bool enable);
  157. /**
  158. * dsi_phy_enable() - enable DSI PHY hardware
  159. * @dsi_phy: DSI PHY handle.
  160. * @config: DSI host configuration.
  161. * @pll_source: Source PLL for PHY clock.
  162. * @skip_validation: Validation will not be performed on parameters.
  163. * @skip_op: Skip re-enabling dsi phy hw during usecases like
  164. * cont-splash/trusted-vm if set to true.
  165. *
  166. * Validates and enables DSI PHY.
  167. *
  168. * Return: error code.
  169. */
  170. int dsi_phy_enable(struct msm_dsi_phy *dsi_phy,
  171. struct dsi_host_config *config,
  172. enum dsi_phy_pll_source pll_source,
  173. bool skip_validation,
  174. bool skip_op);
  175. /**
  176. * dsi_phy_disable() - disable DSI PHY hardware.
  177. * @phy: DSI PHY handle.
  178. * @skip_op: Skip disabling dsi phy hw during usecases like
  179. * trusted-vm if set to true.
  180. *
  181. * Return: error code.
  182. */
  183. int dsi_phy_disable(struct msm_dsi_phy *phy, bool skip_op);
  184. /**
  185. * dsi_phy_set_ulps() - set ulps state for DSI pHY
  186. * @phy: DSI PHY handle
  187. * @config: DSi host configuration information.
  188. * @enable: Enable/Disable
  189. * @clamp_enabled: mmss_clamp enabled/disabled
  190. *
  191. * Return: error code.
  192. */
  193. int dsi_phy_set_ulps(struct msm_dsi_phy *phy, struct dsi_host_config *config,
  194. bool enable, bool clamp_enabled);
  195. /**
  196. * dsi_phy_clk_cb_register() - Register PHY clock control callback
  197. * @phy: DSI PHY handle
  198. * @clk_cb: Structure containing call back for clock control
  199. *
  200. * Return: error code.
  201. */
  202. int dsi_phy_clk_cb_register(struct msm_dsi_phy *phy,
  203. struct clk_ctrl_cb *clk_cb);
  204. /**
  205. * dsi_phy_idle_ctrl() - enable/disable DSI PHY during idle screen
  206. * @phy: DSI PHY handle
  207. * @enable: boolean to specify PHY enable/disable.
  208. *
  209. * Return: error code.
  210. */
  211. int dsi_phy_idle_ctrl(struct msm_dsi_phy *phy, bool enable);
  212. /**
  213. * dsi_phy_set_clamp_state() - configure clamps for DSI lanes
  214. * @phy: DSI PHY handle.
  215. * @enable: boolean to specify clamp enable/disable.
  216. *
  217. * Return: error code.
  218. */
  219. int dsi_phy_set_clamp_state(struct msm_dsi_phy *phy, bool enable);
  220. /**
  221. * dsi_phy_set_clk_freq() - set DSI PHY clock frequency setting
  222. * @phy: DSI PHY handle
  223. * @clk_freq: link clock frequency
  224. *
  225. * Return: error code.
  226. */
  227. int dsi_phy_set_clk_freq(struct msm_dsi_phy *phy,
  228. struct link_clk_freq *clk_freq);
  229. /**
  230. * dsi_phy_set_timing_params() - timing parameters for the panel
  231. * @phy: DSI PHY handle
  232. * @timing: array holding timing params.
  233. * @size: size of the array.
  234. * @commit: boolean to indicate if programming PHY HW registers is
  235. * required
  236. *
  237. * When PHY timing calculator is not implemented, this array will be used to
  238. * pass PHY timing information.
  239. *
  240. * Return: error code.
  241. */
  242. int dsi_phy_set_timing_params(struct msm_dsi_phy *phy,
  243. u32 *timing, u32 size, bool commit);
  244. /**
  245. * dsi_phy_lane_reset() - Reset DSI PHY lanes in case of error
  246. * @phy: DSI PHY handle
  247. *
  248. * Return: error code.
  249. */
  250. int dsi_phy_lane_reset(struct msm_dsi_phy *phy);
  251. /**
  252. * dsi_phy_toggle_resync_fifo() - toggle resync retime FIFO
  253. * @phy: DSI PHY handle
  254. *
  255. * Toggle the resync retime FIFO to synchronize the data paths.
  256. * This should be done everytime there is a change in the link clock
  257. * rate
  258. */
  259. void dsi_phy_toggle_resync_fifo(struct msm_dsi_phy *phy);
  260. /**
  261. * dsi_phy_reset_clk_en_sel() - reset clk_en_select on cmn_clk_cfg1 register
  262. * @phy: DSI PHY handle
  263. *
  264. * After toggling resync fifo regiater, clk_en_sel bit on cmn_clk_cfg1
  265. * register has to be reset
  266. */
  267. void dsi_phy_reset_clk_en_sel(struct msm_dsi_phy *phy);
  268. /**
  269. * dsi_phy_drv_register() - register platform driver for dsi phy
  270. */
  271. void dsi_phy_drv_register(void);
  272. /**
  273. * dsi_phy_drv_unregister() - unregister platform driver
  274. */
  275. void dsi_phy_drv_unregister(void);
  276. /**
  277. * dsi_phy_update_phy_timings() - Update dsi phy timings
  278. * @phy: DSI PHY handle
  279. * @config: DSI Host config parameters
  280. *
  281. * Return: error code.
  282. */
  283. int dsi_phy_update_phy_timings(struct msm_dsi_phy *phy,
  284. struct dsi_host_config *config);
  285. /**
  286. * dsi_phy_config_dynamic_refresh() - Configure dynamic refresh registers
  287. * @phy: DSI PHY handle
  288. * @delay: pipe delays for dynamic refresh
  289. * @is_master: Boolean to indicate if for master or slave
  290. */
  291. void dsi_phy_config_dynamic_refresh(struct msm_dsi_phy *phy,
  292. struct dsi_dyn_clk_delay *delay,
  293. bool is_master);
  294. /**
  295. * dsi_phy_dynamic_refresh_trigger() - trigger dynamic refresh
  296. * @phy: DSI PHY handle
  297. * @is_master: Boolean to indicate if for master or slave.
  298. */
  299. void dsi_phy_dynamic_refresh_trigger(struct msm_dsi_phy *phy, bool is_master);
  300. /**
  301. * dsi_phy_dynamic_refresh_clear() - clear dynamic refresh config
  302. * @phy: DSI PHY handle
  303. */
  304. void dsi_phy_dynamic_refresh_clear(struct msm_dsi_phy *phy);
  305. /**
  306. * dsi_phy_dyn_refresh_cache_phy_timings - cache the phy timings calculated
  307. * as part of dynamic refresh.
  308. * @phy: DSI PHY Handle.
  309. * @dst: Pointer to cache location.
  310. * @size: Number of phy lane settings.
  311. */
  312. int dsi_phy_dyn_refresh_cache_phy_timings(struct msm_dsi_phy *phy,
  313. u32 *dst, u32 size);
  314. /**
  315. * dsi_phy_set_continuous_clk() - API to set/unset force clock lane HS request.
  316. * @phy: DSI PHY Handle.
  317. * @enable: variable to control continuous clock.
  318. */
  319. void dsi_phy_set_continuous_clk(struct msm_dsi_phy *phy, bool enable);
  320. #endif /* _DSI_PHY_H_ */