Skip to content

Commit eec8e8c

Browse files
committed
drm/bridge: document HDMI CEC callbacks
Provide documentation for the drm_bridge callbacks related to the DRM_BRIDGE_OP_HDMI_CEC_ADAPTER flag. Fixes: a74288c ("drm/display: bridge-connector: handle CEC adapters") Reported-by: Stephen Rothwell <[email protected]> Closes: https://lore.kernel.org/r/[email protected] Reviewed-by: Neil Armstrong <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Dmitry Baryshkov <[email protected]>
1 parent 5844603 commit eec8e8c

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

include/drm/drm_bridge.h

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -866,13 +866,61 @@ struct drm_bridge_funcs {
866866
struct drm_connector *connector,
867867
bool enable, int direction);
868868

869+
/**
870+
* @hdmi_cec_init:
871+
*
872+
* Initialize CEC part of the bridge.
873+
*
874+
* This callback is optional, it can be implemented by bridges that
875+
* set the @DRM_BRIDGE_OP_HDMI_CEC_ADAPTER flag in their
876+
* &drm_bridge->ops.
877+
*
878+
* Returns:
879+
* 0 on success, a negative error code otherwise
880+
*/
869881
int (*hdmi_cec_init)(struct drm_bridge *bridge,
870882
struct drm_connector *connector);
871883

884+
/**
885+
* @hdmi_cec_enable:
886+
*
887+
* Enable or disable the CEC adapter inside the bridge.
888+
*
889+
* This callback is optional, it can be implemented by bridges that
890+
* set the @DRM_BRIDGE_OP_HDMI_CEC_ADAPTER flag in their
891+
* &drm_bridge->ops.
892+
*
893+
* Returns:
894+
* 0 on success, a negative error code otherwise
895+
*/
872896
int (*hdmi_cec_enable)(struct drm_bridge *bridge, bool enable);
873897

898+
/**
899+
* @hdmi_cec_log_addr:
900+
*
901+
* Set the logical address of the CEC adapter inside the bridge.
902+
*
903+
* This callback is optional, it can be implemented by bridges that
904+
* set the @DRM_BRIDGE_OP_HDMI_CEC_ADAPTER flag in their
905+
* &drm_bridge->ops.
906+
*
907+
* Returns:
908+
* 0 on success, a negative error code otherwise
909+
*/
874910
int (*hdmi_cec_log_addr)(struct drm_bridge *bridge, u8 logical_addr);
875911

912+
/**
913+
* @hdmi_cec_transmit:
914+
*
915+
* Transmit the message using the CEC adapter inside the bridge.
916+
*
917+
* This callback is optional, it can be implemented by bridges that
918+
* set the @DRM_BRIDGE_OP_HDMI_CEC_ADAPTER flag in their
919+
* &drm_bridge->ops.
920+
*
921+
* Returns:
922+
* 0 on success, a negative error code otherwise
923+
*/
876924
int (*hdmi_cec_transmit)(struct drm_bridge *bridge, u8 attempts,
877925
u32 signal_free_time, struct cec_msg *msg);
878926

0 commit comments

Comments
 (0)