sde_connector.h 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2016-2020, The Linux Foundation. All rights reserved.
  4. */
  5. #ifndef _SDE_CONNECTOR_H_
  6. #define _SDE_CONNECTOR_H_
  7. #include <drm/msm_drm_pp.h>
  8. #include <drm/drmP.h>
  9. #include <drm/drm_atomic.h>
  10. #include <drm/drm_panel.h>
  11. #include "msm_drv.h"
  12. #include "msm_prop.h"
  13. #include "sde_kms.h"
  14. #include "sde_fence.h"
  15. #define SDE_CONNECTOR_NAME_SIZE 16
  16. #define SDE_CONNECTOR_DHDR_MEMPOOL_MAX_SIZE SZ_32
  17. #define MAX_CMD_RECEIVE_SIZE 256
  18. struct sde_connector;
  19. struct sde_connector_state;
  20. /**
  21. * struct sde_connector_ops - callback functions for generic sde connector
  22. * Individual callbacks documented below.
  23. */
  24. struct sde_connector_ops {
  25. /**
  26. * post_init - perform additional initialization steps
  27. * @connector: Pointer to drm connector structure
  28. * @display: Pointer to private display handle
  29. * Returns: Zero on success
  30. */
  31. int (*post_init)(struct drm_connector *connector,
  32. void *display);
  33. /**
  34. * set_info_blob - initialize given info blob
  35. * @connector: Pointer to drm connector structure
  36. * @info: Pointer to sde connector info structure
  37. * @display: Pointer to private display handle
  38. * @mode_info: Pointer to mode info structure
  39. * Returns: Zero on success
  40. */
  41. int (*set_info_blob)(struct drm_connector *connector,
  42. void *info,
  43. void *display,
  44. struct msm_mode_info *mode_info);
  45. /**
  46. * detect - determine if connector is connected
  47. * @connector: Pointer to drm connector structure
  48. * @force: Force detect setting from drm framework
  49. * @display: Pointer to private display handle
  50. * Returns: Connector 'is connected' status
  51. */
  52. enum drm_connector_status (*detect)(struct drm_connector *connector,
  53. bool force,
  54. void *display);
  55. /**
  56. * get_modes - add drm modes via drm_mode_probed_add()
  57. * @connector: Pointer to drm connector structure
  58. * @display: Pointer to private display handle
  59. * @avail_res: Pointer with current available resources
  60. * Returns: Number of modes added
  61. */
  62. int (*get_modes)(struct drm_connector *connector,
  63. void *display,
  64. const struct msm_resource_caps_info *avail_res);
  65. /**
  66. * update_pps - update pps command for the display panel
  67. * @connector: Pointer to drm connector structure
  68. * @pps_cmd: Pointer to pps command
  69. * @display: Pointer to private display handle
  70. * Returns: Zero on success
  71. */
  72. int (*update_pps)(struct drm_connector *connector,
  73. char *pps_cmd, void *display);
  74. /**
  75. * mode_valid - determine if specified mode is valid
  76. * @connector: Pointer to drm connector structure
  77. * @mode: Pointer to drm mode structure
  78. * @display: Pointer to private display handle
  79. * @avail_res: Pointer with curr available resources
  80. * Returns: Validity status for specified mode
  81. */
  82. enum drm_mode_status (*mode_valid)(struct drm_connector *connector,
  83. struct drm_display_mode *mode,
  84. void *display,
  85. const struct msm_resource_caps_info *avail_res);
  86. /**
  87. * set_property - set property value
  88. * @connector: Pointer to drm connector structure
  89. * @state: Pointer to drm connector state structure
  90. * @property_index: DRM property index
  91. * @value: Incoming property value
  92. * @display: Pointer to private display structure
  93. * Returns: Zero on success
  94. */
  95. int (*set_property)(struct drm_connector *connector,
  96. struct drm_connector_state *state,
  97. int property_index,
  98. uint64_t value,
  99. void *display);
  100. /**
  101. * get_property - get property value
  102. * @connector: Pointer to drm connector structure
  103. * @state: Pointer to drm connector state structure
  104. * @property_index: DRM property index
  105. * @value: Pointer to variable for accepting property value
  106. * @display: Pointer to private display structure
  107. * Returns: Zero on success
  108. */
  109. int (*get_property)(struct drm_connector *connector,
  110. struct drm_connector_state *state,
  111. int property_index,
  112. uint64_t *value,
  113. void *display);
  114. /**
  115. * get_info - get display information
  116. * @connector: Pointer to drm connector structure
  117. * @info: Pointer to msm display info structure
  118. * @display: Pointer to private display structure
  119. * Returns: Zero on success
  120. */
  121. int (*get_info)(struct drm_connector *connector,
  122. struct msm_display_info *info, void *display);
  123. /**
  124. * get_mode_info - retrieve mode information
  125. * @connector: Pointer to drm connector structure
  126. * @drm_mode: Display mode set for the display
  127. * @mode_info: Out parameter. information of the display mode
  128. * @display: Pointer to private display structure
  129. * @avail_res: Pointer with curr available resources
  130. * Returns: Zero on success
  131. */
  132. int (*get_mode_info)(struct drm_connector *connector,
  133. const struct drm_display_mode *drm_mode,
  134. struct msm_mode_info *mode_info,
  135. void *display,
  136. const struct msm_resource_caps_info *avail_res);
  137. /**
  138. * enable_event - notify display of event registration/unregistration
  139. * @connector: Pointer to drm connector structure
  140. * @event_idx: SDE connector event index
  141. * @enable: Whether the event is being enabled/disabled
  142. * @display: Pointer to private display structure
  143. */
  144. void (*enable_event)(struct drm_connector *connector,
  145. uint32_t event_idx, bool enable, void *display);
  146. /**
  147. * set_backlight - set backlight level
  148. * @connector: Pointer to drm connector structure
  149. * @display: Pointer to private display structure
  150. * @bl_lvel: Backlight level
  151. */
  152. int (*set_backlight)(struct drm_connector *connector,
  153. void *display, u32 bl_lvl);
  154. /**
  155. * set_colorspace - set colorspace for connector
  156. * @connector: Pointer to drm connector structure
  157. * @display: Pointer to private display structure
  158. */
  159. int (*set_colorspace)(struct drm_connector *connector,
  160. void *display);
  161. /**
  162. * soft_reset - perform a soft reset on the connector
  163. * @display: Pointer to private display structure
  164. * Return: Zero on success, -ERROR otherwise
  165. */
  166. int (*soft_reset)(void *display);
  167. /**
  168. * pre_kickoff - trigger display to program kickoff-time features
  169. * @connector: Pointer to drm connector structure
  170. * @display: Pointer to private display structure
  171. * @params: Parameter bundle of connector-stored information for
  172. * kickoff-time programming into the display
  173. * Returns: Zero on success
  174. */
  175. int (*pre_kickoff)(struct drm_connector *connector,
  176. void *display,
  177. struct msm_display_kickoff_params *params);
  178. /**
  179. * clk_ctrl - perform clk enable/disable on the connector
  180. * @handle: Pointer to clk handle
  181. * @type: Type of clks
  182. * @enable: State of clks
  183. */
  184. int (*clk_ctrl)(void *handle, u32 type, u32 state);
  185. /**
  186. * set_power - update dpms setting
  187. * @connector: Pointer to drm connector structure
  188. * @power_mode: One of the following,
  189. * SDE_MODE_DPMS_ON
  190. * SDE_MODE_DPMS_LP1
  191. * SDE_MODE_DPMS_LP2
  192. * SDE_MODE_DPMS_OFF
  193. * @display: Pointer to private display structure
  194. * Returns: Zero on success
  195. */
  196. int (*set_power)(struct drm_connector *connector,
  197. int power_mode, void *display);
  198. /**
  199. * get_dst_format - get dst_format from display
  200. * @connector: Pointer to drm connector structure
  201. * @display: Pointer to private display handle
  202. * Returns: dst_format of display
  203. */
  204. enum dsi_pixel_format (*get_dst_format)(struct drm_connector *connector,
  205. void *display);
  206. /**
  207. * post_kickoff - display to program post kickoff-time features
  208. * @connector: Pointer to drm connector structure
  209. * @params: Parameter bundle of connector-stored information for
  210. * post kickoff programming into the display
  211. * Returns: Zero on success
  212. */
  213. int (*post_kickoff)(struct drm_connector *connector,
  214. struct msm_display_conn_params *params);
  215. /**
  216. * post_open - calls connector to process post open functionalities
  217. * @display: Pointer to private display structure
  218. */
  219. void (*post_open)(struct drm_connector *connector, void *display);
  220. /**
  221. * check_status - check status of connected display panel
  222. * @connector: Pointer to drm connector structure
  223. * @display: Pointer to private display handle
  224. * @te_check_override: Whether check TE from panel or default check
  225. * Returns: positive value for success, negetive or zero for failure
  226. */
  227. int (*check_status)(struct drm_connector *connector, void *display,
  228. bool te_check_override);
  229. /**
  230. * cmd_transfer - Transfer command to the connected display panel
  231. * @connector: Pointer to drm connector structure
  232. * @display: Pointer to private display handle
  233. * @cmd_buf: Command buffer
  234. * @cmd_buf_len: Command buffer length in bytes
  235. * Returns: Zero for success, negetive for failure
  236. */
  237. int (*cmd_transfer)(struct drm_connector *connector,
  238. void *display, const char *cmd_buf,
  239. u32 cmd_buf_len);
  240. /**
  241. * cmd_receive - Receive the response from the connected display panel
  242. * @display: Pointer to private display handle
  243. * @cmd_buf: Command buffer
  244. * @cmd_buf_len: Command buffer length in bytes
  245. * @recv_buf: rx buffer
  246. * @recv_buf_len: rx buffer length
  247. * Returns: number of bytes read, if successful, negative for failure
  248. */
  249. int (*cmd_receive)(void *display, const char *cmd_buf,
  250. u32 cmd_buf_len, u8 *recv_buf, u32 recv_buf_len);
  251. /**
  252. * config_hdr - configure HDR
  253. * @connector: Pointer to drm connector structure
  254. * @display: Pointer to private display handle
  255. * @c_state: Pointer to connector state
  256. * Returns: Zero on success, negative error code for failures
  257. */
  258. int (*config_hdr)(struct drm_connector *connector, void *display,
  259. struct sde_connector_state *c_state);
  260. /**
  261. * atomic_best_encoder - atomic best encoder selection for connector
  262. * @connector: Pointer to drm connector structure
  263. * @display: Pointer to private display handle
  264. * @c_state: Pointer to connector state
  265. * Returns: valid drm_encoder for success
  266. */
  267. struct drm_encoder *(*atomic_best_encoder)(
  268. struct drm_connector *connector,
  269. void *display,
  270. struct drm_connector_state *c_state);
  271. /**
  272. * atomic_check - atomic check handling for connector
  273. * @connector: Pointer to drm connector structure
  274. * @display: Pointer to private display handle
  275. * @c_state: Pointer to connector state
  276. * Returns: valid drm_encoder for success
  277. */
  278. int (*atomic_check)(struct drm_connector *connector,
  279. void *display,
  280. struct drm_atomic_state *state);
  281. /**
  282. * pre_destroy - handle pre destroy operations for the connector
  283. * @connector: Pointer to drm connector structure
  284. * @display: Pointer to private display handle
  285. * Returns: Zero on success, negative error code for failures
  286. */
  287. void (*pre_destroy)(struct drm_connector *connector, void *display);
  288. /**
  289. * cont_splash_config - initialize splash resources
  290. * @display: Pointer to private display handle
  291. * Returns: zero for success, negetive for failure
  292. */
  293. int (*cont_splash_config)(void *display);
  294. /**
  295. * get_panel_vfp - returns original panel vfp
  296. * @display: Pointer to private display handle
  297. * @h_active: width
  298. * @v_active: height
  299. * Returns: v_front_porch on success error-code on failure
  300. */
  301. int (*get_panel_vfp)(void *display, int h_active, int v_active);
  302. /**
  303. * get_default_lm - returns default number of lm
  304. * @display: Pointer to private display handle
  305. * @num_lm: Pointer to number of lms to be populated
  306. * Returns: zero for success, negetive for failure
  307. */
  308. int (*get_default_lms)(void *display, u32 *num_lm);
  309. /**
  310. * prepare_commit - trigger display to program pre-commit time features
  311. * @display: Pointer to private display structure
  312. * @params: Parameter bundle of connector-stored information for
  313. * pre commit time programming into the display
  314. * Returns: Zero on success
  315. */
  316. int (*prepare_commit)(void *display,
  317. struct msm_display_conn_params *params);
  318. };
  319. /**
  320. * enum sde_connector_display_type - list of display types
  321. */
  322. enum sde_connector_display {
  323. SDE_CONNECTOR_UNDEFINED,
  324. SDE_CONNECTOR_PRIMARY,
  325. SDE_CONNECTOR_SECONDARY,
  326. SDE_CONNECTOR_MAX
  327. };
  328. /**
  329. * enum sde_connector_events - list of recognized connector events
  330. */
  331. enum sde_connector_events {
  332. SDE_CONN_EVENT_VID_DONE, /* video mode frame done */
  333. SDE_CONN_EVENT_CMD_DONE, /* command mode frame done */
  334. SDE_CONN_EVENT_VID_FIFO_OVERFLOW, /* dsi fifo overflow error */
  335. SDE_CONN_EVENT_CMD_FIFO_UNDERFLOW, /* dsi fifo underflow error */
  336. SDE_CONN_EVENT_PANEL_ID, /* returns read panel id from ddic */
  337. SDE_CONN_EVENT_COUNT,
  338. };
  339. /**
  340. * struct sde_connector_evt - local event registration entry structure
  341. * @cb_func: Pointer to desired callback function
  342. * @usr: User pointer to pass to callback on event trigger
  343. * Returns: Zero success, negetive for failure
  344. */
  345. struct sde_connector_evt {
  346. int (*cb_func)(uint32_t event_idx,
  347. uint32_t instance_idx, void *usr,
  348. uint32_t data0, uint32_t data1,
  349. uint32_t data2, uint32_t data3);
  350. void *usr;
  351. };
  352. struct sde_connector_dyn_hdr_metadata {
  353. u8 dynamic_hdr_payload[SDE_CONNECTOR_DHDR_MEMPOOL_MAX_SIZE];
  354. int dynamic_hdr_payload_size;
  355. bool dynamic_hdr_update;
  356. };
  357. /**
  358. * struct sde_connector - local sde connector structure
  359. * @base: Base drm connector structure
  360. * @connector_type: Set to one of DRM_MODE_CONNECTOR_ types
  361. * @encoder: Pointer to preferred drm encoder
  362. * @panel: Pointer to drm panel, if present
  363. * @display: Pointer to private display data structure
  364. * @drv_panel: Pointer to interface driver's panel module, if present
  365. * @mst_port: Pointer to mst port, if present
  366. * @mmu_secure: MMU id for secure buffers
  367. * @mmu_unsecure: MMU id for unsecure buffers
  368. * @name: ASCII name of connector
  369. * @lock: Mutex lock object for this structure
  370. * @retire_fence: Retire fence context reference
  371. * @ops: Local callback function pointer table
  372. * @dpms_mode: DPMS property setting from user space
  373. * @lp_mode: LP property setting from user space
  374. * @last_panel_power_mode: Last consolidated dpms/lp mode setting
  375. * @property_info: Private structure for generic property handling
  376. * @property_data: Array of private data for generic property handling
  377. * @blob_caps: Pointer to blob structure for 'capabilities' property
  378. * @blob_hdr: Pointer to blob structure for 'hdr_properties' property
  379. * @blob_ext_hdr: Pointer to blob structure for 'ext_hdr_properties' property
  380. * @blob_dither: Pointer to blob structure for default dither config
  381. * @blob_mode_info: Pointer to blob structure for mode info
  382. * @blob_panel_id: Pointer to blob structure for blob_panel_id
  383. * @fb_kmap: true if kernel mapping of framebuffer is requested
  384. * @event_table: Array of registered events
  385. * @event_lock: Lock object for event_table
  386. * @bl_device: backlight device node
  387. * @cdev: backlight cooling device interface
  388. * @n: backlight cooling device notifier
  389. * @thermal_max_brightness: thermal max brightness cap
  390. * @status_work: work object to perform status checks
  391. * @esd_status_interval: variable to change ESD check interval in millisec
  392. * @panel_dead: Flag to indicate if panel has gone bad
  393. * @esd_status_check: Flag to indicate if ESD thread is scheduled or not
  394. * @bl_scale_dirty: Flag to indicate PP BL scale value(s) is changed
  395. * @bl_scale: BL scale value for ABA feature
  396. * @bl_scale_sv: BL scale value for sunlight visibility feature
  397. * @unset_bl_level: BL level that needs to be set later
  398. * @hdr_eotf: Electro optical transfer function obtained from HDR block
  399. * @hdr_metadata_type_one: Metadata type one obtained from HDR block
  400. * @hdr_max_luminance: desired max luminance obtained from HDR block
  401. * @hdr_avg_luminance: desired avg luminance obtained from HDR block
  402. * @hdr_min_luminance: desired min luminance obtained from HDR block
  403. * @hdr_supported: does the sink support HDR content
  404. * @color_enc_fmt: Colorimetry encoding formats of sink
  405. * @allow_bl_update: Flag to indicate if BL update is allowed currently or not
  406. * @qsync_mode: Cached Qsync mode, 0=disabled, 1=continuous mode
  407. * @qsync_updated: Qsync settings were updated
  408. * @colorspace_updated: Colorspace property was updated
  409. * @last_cmd_tx_sts: status of the last command transfer
  410. * @hdr_capable: external hdr support present
  411. * @cmd_rx_buf: the return buffer of response of command transfer
  412. * @rx_len: the length of dcs command received buffer
  413. */
  414. struct sde_connector {
  415. struct drm_connector base;
  416. int connector_type;
  417. struct drm_encoder *encoder;
  418. void *display;
  419. void *drv_panel;
  420. void *mst_port;
  421. struct msm_gem_address_space *aspace[SDE_IOMMU_DOMAIN_MAX];
  422. char name[SDE_CONNECTOR_NAME_SIZE];
  423. struct mutex lock;
  424. struct sde_fence_context *retire_fence;
  425. struct sde_connector_ops ops;
  426. int dpms_mode;
  427. int lp_mode;
  428. int last_panel_power_mode;
  429. struct msm_property_info property_info;
  430. struct msm_property_data property_data[CONNECTOR_PROP_COUNT];
  431. struct drm_property_blob *blob_caps;
  432. struct drm_property_blob *blob_hdr;
  433. struct drm_property_blob *blob_ext_hdr;
  434. struct drm_property_blob *blob_dither;
  435. struct drm_property_blob *blob_mode_info;
  436. struct drm_property_blob *blob_panel_id;
  437. bool fb_kmap;
  438. struct sde_connector_evt event_table[SDE_CONN_EVENT_COUNT];
  439. spinlock_t event_lock;
  440. struct backlight_device *bl_device;
  441. struct sde_cdev *cdev;
  442. struct notifier_block n;
  443. unsigned long thermal_max_brightness;
  444. struct delayed_work status_work;
  445. u32 esd_status_interval;
  446. bool panel_dead;
  447. bool esd_status_check;
  448. bool bl_scale_dirty;
  449. u32 bl_scale;
  450. u32 bl_scale_sv;
  451. u32 unset_bl_level;
  452. bool allow_bl_update;
  453. u32 hdr_eotf;
  454. bool hdr_metadata_type_one;
  455. u32 hdr_max_luminance;
  456. u32 hdr_avg_luminance;
  457. u32 hdr_min_luminance;
  458. bool hdr_supported;
  459. u32 color_enc_fmt;
  460. u8 hdr_plus_app_ver;
  461. u32 qsync_mode;
  462. bool qsync_updated;
  463. bool colorspace_updated;
  464. bool last_cmd_tx_sts;
  465. bool hdr_capable;
  466. u8 cmd_rx_buf[MAX_CMD_RECEIVE_SIZE];
  467. int rx_len;
  468. };
  469. /**
  470. * to_sde_connector - convert drm_connector pointer to sde connector pointer
  471. * @X: Pointer to drm_connector structure
  472. * Returns: Pointer to sde_connector structure
  473. */
  474. #define to_sde_connector(x) container_of((x), struct sde_connector, base)
  475. /**
  476. * sde_connector_get_display - get sde connector's private display pointer
  477. * @C: Pointer to drm connector structure
  478. * Returns: Pointer to associated private display structure
  479. */
  480. #define sde_connector_get_display(C) \
  481. ((C) ? to_sde_connector((C))->display : NULL)
  482. /**
  483. * sde_connector_get_encoder - get sde connector's private encoder pointer
  484. * @C: Pointer to drm connector structure
  485. * Returns: Pointer to associated private encoder structure
  486. */
  487. #define sde_connector_get_encoder(C) \
  488. ((C) ? to_sde_connector((C))->encoder : NULL)
  489. /**
  490. * sde_connector_qsync_updated - indicates if connector updated qsync
  491. * @C: Pointer to drm connector structure
  492. * Returns: True if qsync is updated; false otherwise
  493. */
  494. #define sde_connector_is_qsync_updated(C) \
  495. ((C) ? to_sde_connector((C))->qsync_updated : 0)
  496. /**
  497. * sde_connector_get_qsync_mode - get sde connector's qsync_mode
  498. * @C: Pointer to drm connector structure
  499. * Returns: Current cached qsync_mode for given connector
  500. */
  501. #define sde_connector_get_qsync_mode(C) \
  502. ((C) ? to_sde_connector((C))->qsync_mode : 0)
  503. /**
  504. * sde_connector_get_propinfo - get sde connector's property info pointer
  505. * @C: Pointer to drm connector structure
  506. * Returns: Pointer to associated private property info structure
  507. */
  508. #define sde_connector_get_propinfo(C) \
  509. ((C) ? &to_sde_connector((C))->property_info : NULL)
  510. /**
  511. * struct sde_connector_state - private connector status structure
  512. * @base: Base drm connector structure
  513. * @out_fb: Pointer to output frame buffer, if applicable
  514. * @property_state: Local storage for msm_prop properties
  515. * @property_values: Local cache of current connector property values
  516. * @rois: Regions of interest structure for mapping CRTC to Connector output
  517. * @property_blobs: blob properties
  518. * @mode_info: local copy of msm_mode_info struct
  519. * @hdr_meta: HDR metadata info passed from userspace
  520. * @dyn_hdr_meta: Dynamic HDR metadata payload and state tracking
  521. * @old_topology_name: topology of previous atomic state. remove this in later
  522. * kernel versions which provide drm_atomic_state old_state pointers
  523. */
  524. struct sde_connector_state {
  525. struct drm_connector_state base;
  526. struct drm_framebuffer *out_fb;
  527. struct msm_property_state property_state;
  528. struct msm_property_value property_values[CONNECTOR_PROP_COUNT];
  529. struct msm_roi_list rois;
  530. struct drm_property_blob *property_blobs[CONNECTOR_PROP_BLOBCOUNT];
  531. struct msm_mode_info mode_info;
  532. struct drm_msm_ext_hdr_metadata hdr_meta;
  533. struct sde_connector_dyn_hdr_metadata dyn_hdr_meta;
  534. enum sde_rm_topology_name old_topology_name;
  535. };
  536. /**
  537. * to_sde_connector_state - convert drm_connector_state pointer to
  538. * sde connector state pointer
  539. * @X: Pointer to drm_connector_state structure
  540. * Returns: Pointer to sde_connector_state structure
  541. */
  542. #define to_sde_connector_state(x) \
  543. container_of((x), struct sde_connector_state, base)
  544. /**
  545. * sde_connector_get_property - query integer value of connector property
  546. * @S: Pointer to drm connector state
  547. * @X: Property index, from enum msm_mdp_connector_property
  548. * Returns: Integer value of requested property
  549. */
  550. #define sde_connector_get_property(S, X) \
  551. ((S) && ((X) < CONNECTOR_PROP_COUNT) ? \
  552. (to_sde_connector_state((S))->property_values[(X)].value) : 0)
  553. /**
  554. * sde_connector_get_property_state - retrieve property state cache
  555. * @S: Pointer to drm connector state
  556. * Returns: Pointer to local property state structure
  557. */
  558. #define sde_connector_get_property_state(S) \
  559. ((S) ? (&to_sde_connector_state((S))->property_state) : NULL)
  560. /**
  561. * sde_connector_get_out_fb - query out_fb value from sde connector state
  562. * @S: Pointer to drm connector state
  563. * Returns: Output fb associated with specified connector state
  564. */
  565. #define sde_connector_get_out_fb(S) \
  566. ((S) ? to_sde_connector_state((S))->out_fb : 0)
  567. /**
  568. * sde_connector_get_topology_name - helper accessor to retrieve topology_name
  569. * @connector: pointer to drm connector
  570. * Returns: value of the CONNECTOR_PROP_TOPOLOGY_NAME property or 0
  571. */
  572. static inline uint64_t sde_connector_get_topology_name(
  573. struct drm_connector *connector)
  574. {
  575. if (!connector || !connector->state)
  576. return 0;
  577. return sde_connector_get_property(connector->state,
  578. CONNECTOR_PROP_TOPOLOGY_NAME);
  579. }
  580. /**
  581. * sde_connector_get_old_topology_name - helper accessor to retrieve
  582. * topology_name for the previous mode
  583. * @connector: pointer to drm connector state
  584. * Returns: cached value of the previous topology, or SDE_RM_TOPOLOGY_NONE
  585. */
  586. static inline enum sde_rm_topology_name sde_connector_get_old_topology_name(
  587. struct drm_connector_state *state)
  588. {
  589. struct sde_connector_state *c_state = to_sde_connector_state(state);
  590. if (!state)
  591. return SDE_RM_TOPOLOGY_NONE;
  592. return c_state->old_topology_name;
  593. }
  594. /**
  595. * sde_connector_set_old_topology_name - helper to cache value of previous
  596. * mode's topology
  597. * @connector: pointer to drm connector state
  598. * Returns: 0 on success, negative errno on failure
  599. */
  600. static inline int sde_connector_set_old_topology_name(
  601. struct drm_connector_state *state,
  602. enum sde_rm_topology_name top)
  603. {
  604. struct sde_connector_state *c_state = to_sde_connector_state(state);
  605. if (!state)
  606. return -EINVAL;
  607. c_state->old_topology_name = top;
  608. return 0;
  609. }
  610. /**
  611. * sde_connector_get_lp - helper accessor to retrieve LP state
  612. * @connector: pointer to drm connector
  613. * Returns: value of the CONNECTOR_PROP_LP property or 0
  614. */
  615. static inline uint64_t sde_connector_get_lp(
  616. struct drm_connector *connector)
  617. {
  618. if (!connector || !connector->state)
  619. return 0;
  620. return sde_connector_get_property(connector->state,
  621. CONNECTOR_PROP_LP);
  622. }
  623. /**
  624. * sde_connector_set_property_for_commit - add property set to atomic state
  625. * Add a connector state property update for the specified property index
  626. * to the atomic state in preparation for a drm_atomic_commit.
  627. * @connector: Pointer to drm connector
  628. * @atomic_state: Pointer to DRM atomic state structure for commit
  629. * @property_idx: Connector property index
  630. * @value: Updated property value
  631. * Returns: Zero on success
  632. */
  633. int sde_connector_set_property_for_commit(struct drm_connector *connector,
  634. struct drm_atomic_state *atomic_state,
  635. uint32_t property_idx, uint64_t value);
  636. /**
  637. * sde_connector_init - create drm connector object for a given display
  638. * @dev: Pointer to drm device struct
  639. * @encoder: Pointer to associated encoder
  640. * @panel: Pointer to associated panel, can be NULL
  641. * @display: Pointer to associated display object
  642. * @ops: Pointer to callback operations function table
  643. * @connector_poll: Set to appropriate DRM_CONNECTOR_POLL_ setting
  644. * @connector_type: Set to appropriate DRM_MODE_CONNECTOR_ type
  645. * Returns: Pointer to newly created drm connector struct
  646. */
  647. struct drm_connector *sde_connector_init(struct drm_device *dev,
  648. struct drm_encoder *encoder,
  649. struct drm_panel *panel,
  650. void *display,
  651. const struct sde_connector_ops *ops,
  652. int connector_poll,
  653. int connector_type);
  654. /**
  655. * sde_connector_prepare_fence - prepare fence support for current commit
  656. * @connector: Pointer to drm connector object
  657. */
  658. void sde_connector_prepare_fence(struct drm_connector *connector);
  659. /**
  660. * sde_connector_complete_commit - signal completion of current commit
  661. * @connector: Pointer to drm connector object
  662. * @ts: timestamp to be updated in the fence signalling
  663. * @fence_event: enum value to indicate nature of fence event
  664. */
  665. void sde_connector_complete_commit(struct drm_connector *connector,
  666. ktime_t ts, enum sde_fence_event fence_event);
  667. /**
  668. * sde_connector_commit_reset - reset the completion signal
  669. * @connector: Pointer to drm connector object
  670. * @ts: timestamp to be updated in the fence signalling
  671. */
  672. void sde_connector_commit_reset(struct drm_connector *connector, ktime_t ts);
  673. /**
  674. * sde_connector_get_info - query display specific information
  675. * @connector: Pointer to drm connector object
  676. * @info: Pointer to msm display information structure
  677. * Returns: Zero on success
  678. */
  679. int sde_connector_get_info(struct drm_connector *connector,
  680. struct msm_display_info *info);
  681. /**
  682. * sde_connector_clk_ctrl - enables/disables the connector clks
  683. * @connector: Pointer to drm connector object
  684. * @enable: true/false to enable/disable
  685. * Returns: Zero on success
  686. */
  687. int sde_connector_clk_ctrl(struct drm_connector *connector, bool enable);
  688. /**
  689. * sde_connector_get_dpms - query dpms setting
  690. * @connector: Pointer to drm connector structure
  691. * Returns: Current DPMS setting for connector
  692. */
  693. int sde_connector_get_dpms(struct drm_connector *connector);
  694. /**
  695. * sde_connector_set_qsync_params - set status of qsync_updated for current
  696. * frame and update the cached qsync_mode
  697. * @connector: pointer to drm connector
  698. *
  699. * This must be called after the connector set_property values are applied,
  700. * and before sde_connector's qsync_updated or qsync_mode fields are accessed.
  701. * It must only be called once per frame update for the given connector.
  702. */
  703. void sde_connector_set_qsync_params(struct drm_connector *connector);
  704. /**
  705. * sde_connector_complete_qsync_commit - callback signalling completion
  706. * of qsync, if modified for the current commit
  707. * @conn - Pointer to drm connector object
  708. * @params - Parameter bundle of connector-stored information for
  709. * post kickoff programming into the display
  710. */
  711. void sde_connector_complete_qsync_commit(struct drm_connector *conn,
  712. struct msm_display_conn_params *params);
  713. /**
  714. * sde_connector_get_dyn_hdr_meta - returns pointer to connector state's dynamic
  715. * HDR metadata info
  716. * @connector: pointer to drm connector
  717. */
  718. struct sde_connector_dyn_hdr_metadata *sde_connector_get_dyn_hdr_meta(
  719. struct drm_connector *connector);
  720. /**
  721. * sde_connector_trigger_event - indicate that an event has occurred
  722. * Any callbacks that have been registered against this event will
  723. * be called from the same thread context.
  724. * @connector: Pointer to drm connector structure
  725. * @event_idx: Index of event to trigger
  726. * @instance_idx: Event-specific "instance index" to pass to callback
  727. * @data0: Event-specific "data" to pass to callback
  728. * @data1: Event-specific "data" to pass to callback
  729. * @data2: Event-specific "data" to pass to callback
  730. * @data3: Event-specific "data" to pass to callback
  731. * Returns: Zero on success
  732. */
  733. int sde_connector_trigger_event(void *drm_connector,
  734. uint32_t event_idx, uint32_t instance_idx,
  735. uint32_t data0, uint32_t data1,
  736. uint32_t data2, uint32_t data3);
  737. /**
  738. * sde_connector_register_event - register a callback function for an event
  739. * @connector: Pointer to drm connector structure
  740. * @event_idx: Index of event to register
  741. * @cb_func: Pointer to desired callback function
  742. * @usr: User pointer to pass to callback on event trigger
  743. * Returns: Zero on success
  744. */
  745. int sde_connector_register_event(struct drm_connector *connector,
  746. uint32_t event_idx,
  747. int (*cb_func)(uint32_t event_idx,
  748. uint32_t instance_idx, void *usr,
  749. uint32_t data0, uint32_t data1,
  750. uint32_t data2, uint32_t data3),
  751. void *usr);
  752. /**
  753. * sde_connector_unregister_event - unregister all callbacks for an event
  754. * @connector: Pointer to drm connector structure
  755. * @event_idx: Index of event to register
  756. */
  757. void sde_connector_unregister_event(struct drm_connector *connector,
  758. uint32_t event_idx);
  759. /**
  760. * sde_connector_register_custom_event - register for async events
  761. * @kms: Pointer to sde_kms
  762. * @conn_drm: Pointer to drm connector object
  763. * @event: Event for which request is being sent
  764. * @en: Flag to enable/disable the event
  765. * Returns: Zero on success
  766. */
  767. int sde_connector_register_custom_event(struct sde_kms *kms,
  768. struct drm_connector *conn_drm, u32 event, bool en);
  769. /**
  770. * sde_connector_pre_kickoff - trigger kickoff time feature programming
  771. * @connector: Pointer to drm connector object
  772. * Returns: Zero on success
  773. */
  774. int sde_connector_pre_kickoff(struct drm_connector *connector);
  775. /**
  776. * sde_connector_prepare_commit - trigger commit time feature programming
  777. * @connector: Pointer to drm connector object
  778. * Returns: Zero on success
  779. */
  780. int sde_connector_prepare_commit(struct drm_connector *connector);
  781. /**
  782. * sde_connector_needs_offset - adjust the output fence offset based on
  783. * display type
  784. * @connector: Pointer to drm connector object
  785. * Returns: true if offset is required, false for all other cases.
  786. */
  787. static inline bool sde_connector_needs_offset(struct drm_connector *connector)
  788. {
  789. struct sde_connector *c_conn;
  790. if (!connector)
  791. return false;
  792. c_conn = to_sde_connector(connector);
  793. return (c_conn->connector_type != DRM_MODE_CONNECTOR_VIRTUAL);
  794. }
  795. /**
  796. * sde_connector_get_dither_cfg - get dither property data
  797. * @conn: Pointer to drm_connector struct
  798. * @state: Pointer to drm_connector_state struct
  799. * @cfg: Pointer to pointer to dither cfg
  800. * @len: length of the dither data
  801. * @idle_pc: flag to indicate idle_pc_restore happened
  802. * Returns: Zero on success
  803. */
  804. int sde_connector_get_dither_cfg(struct drm_connector *conn,
  805. struct drm_connector_state *state, void **cfg,
  806. size_t *len, bool idle_pc);
  807. /**
  808. * sde_connector_set_blob_data - set connector blob property data
  809. * @conn: Pointer to drm_connector struct
  810. * @state: Pointer to the drm_connector_state struct
  811. * @prop_id: property id to be populated
  812. * Returns: Zero on success
  813. */
  814. int sde_connector_set_blob_data(struct drm_connector *conn,
  815. struct drm_connector_state *state,
  816. enum msm_mdp_conn_property prop_id);
  817. /**
  818. * sde_connector_roi_v1_check_roi - validate connector ROI
  819. * @conn_state: Pointer to drm_connector_state struct
  820. * Returns: Zero on success
  821. */
  822. int sde_connector_roi_v1_check_roi(struct drm_connector_state *conn_state);
  823. /**
  824. * sde_connector_schedule_status_work - manage ESD thread
  825. * conn: Pointer to drm_connector struct
  826. * @en: flag to start/stop ESD thread
  827. */
  828. void sde_connector_schedule_status_work(struct drm_connector *conn, bool en);
  829. /**
  830. * sde_connector_helper_reset_properties - reset properties to default values in
  831. * the given DRM connector state object
  832. * @connector: Pointer to DRM connector object
  833. * @connector_state: Pointer to DRM connector state object
  834. * Returns: 0 on success, negative errno on failure
  835. */
  836. int sde_connector_helper_reset_custom_properties(
  837. struct drm_connector *connector,
  838. struct drm_connector_state *connector_state);
  839. /**
  840. * sde_connector_state_get_mode_info - get information of the current mode
  841. * in the given connector state.
  842. * conn_state: Pointer to the DRM connector state object
  843. * mode_info: Pointer to the mode info structure
  844. */
  845. int sde_connector_state_get_mode_info(struct drm_connector_state *conn_state,
  846. struct msm_mode_info *mode_info);
  847. /**
  848. * sde_connector_state_get_topology - get topology from given connector state
  849. * conn_state: Pointer to the DRM connector state object
  850. * topology: Pointer to store topology info of the display
  851. */
  852. static inline int sde_connector_state_get_topology(
  853. struct drm_connector_state *conn_state,
  854. struct msm_display_topology *topology)
  855. {
  856. struct sde_connector_state *sde_conn_state = NULL;
  857. if (!conn_state || !topology) {
  858. SDE_ERROR("invalid arguments conn_state %d, topology %d\n",
  859. !conn_state, !topology);
  860. return -EINVAL;
  861. }
  862. sde_conn_state = to_sde_connector_state(conn_state);
  863. memcpy(topology, &sde_conn_state->mode_info.topology,
  864. sizeof(struct msm_display_topology));
  865. return 0;
  866. }
  867. /**
  868. * sde_connector_state_get_compression_info- get compression info of display
  869. * from given connector state
  870. * conn_state: Pointer to the DRM connector state object
  871. * comp_info: Pointer to the compression info structure
  872. */
  873. static inline int sde_connector_state_get_compression_info(
  874. struct drm_connector_state *conn_state,
  875. struct msm_compression_info *comp_info)
  876. {
  877. struct sde_connector_state *sde_conn_state = NULL;
  878. if (!conn_state || !comp_info) {
  879. SDE_ERROR("invalid arguments\n");
  880. return -EINVAL;
  881. }
  882. sde_conn_state = to_sde_connector_state(conn_state);
  883. memcpy(comp_info, &sde_conn_state->mode_info.comp_info,
  884. sizeof(struct msm_compression_info));
  885. return 0;
  886. }
  887. /**
  888. * sde_connector_get_mode_info - retrieve mode info for given mode
  889. * @connector: Pointer to drm connector structure
  890. * @drm_mode: Display mode set for the display
  891. * @mode_info: Out parameter. information of the display mode
  892. * Returns: Zero on success
  893. */
  894. int sde_connector_get_mode_info(struct drm_connector *conn,
  895. const struct drm_display_mode *drm_mode,
  896. struct msm_mode_info *mode_info);
  897. /**
  898. * sde_conn_timeline_status - current buffer timeline status
  899. * conn: Pointer to drm_connector struct
  900. */
  901. void sde_conn_timeline_status(struct drm_connector *conn);
  902. /**
  903. * sde_connector_helper_bridge_disable - helper function for drm bridge disable
  904. * @connector: Pointer to DRM connector object
  905. */
  906. void sde_connector_helper_bridge_disable(struct drm_connector *connector);
  907. /**
  908. * sde_connector_destroy - destroy drm connector object
  909. * @connector: Pointer to DRM connector object
  910. */
  911. void sde_connector_destroy(struct drm_connector *connector);
  912. /**
  913. * sde_connector_event_notify - signal hw recovery event to client
  914. * @connector: pointer to connector
  915. * @type: event type
  916. * @len: length of the value of the event
  917. * @val: value
  918. */
  919. int sde_connector_event_notify(struct drm_connector *connector, uint32_t type,
  920. uint32_t len, uint32_t val);
  921. /**
  922. * sde_connector_helper_bridge_enable - helper function for drm bridge enable
  923. * @connector: Pointer to DRM connector object
  924. */
  925. void sde_connector_helper_bridge_enable(struct drm_connector *connector);
  926. /**
  927. * sde_connector_get_panel_vfp - helper to get panel vfp
  928. * @connector: pointer to drm connector
  929. * @h_active: panel width
  930. * @v_active: panel heigth
  931. * Returns: v_front_porch on success error-code on failure
  932. */
  933. int sde_connector_get_panel_vfp(struct drm_connector *connector,
  934. struct drm_display_mode *mode);
  935. /**
  936. * sde_connector_esd_status - helper function to check te status
  937. * @connector: Pointer to DRM connector object
  938. */
  939. int sde_connector_esd_status(struct drm_connector *connector);
  940. #endif /* _SDE_CONNECTOR_H_ */