gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort by Dhivyailangovan · Pull Request #165 · rdkcentral/rdk-halif-device_settings

Dhivyailangovan · 2025-08-05T07:28:53Z

Need to update the description of dsHdmiInGetStatus and dsHdmiInSelectPort to explain below points
activePort and isPresented will be updated asynchronously in a separate thread, and will be communicated through the 'hdmiInStatusChangeCB' callback.

kanjoe24

LGTM

srinivasgtl · 2025-08-20T08:36:52Z

include/dsHdmiIn.h

- *              Also, if thT port has an active connection, it should update isPresented to true as well.
- * 
+ *              Also, if the port has an active connection, it should update isPresented to true as well.
+ *      These Changes are applied asynchronously in a separate thread, and will be communicated through the


This statement shows that we are giving the implementation part rather than the specification. Can we make it like what we wanted from this function.

Updated as per the comments.
New lines:

* Also, if the port has an active connection, it should update isPresented to true as well. * Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInStatusChangeCB_t' callback.

srinivasgtl · 2025-08-20T08:41:20Z

include/dsCompositeIn.h

 * 
 * @note When a port is selected that port should be set as activePort in ::dsCompositeInStatus_t.
 *              Also, if there is a signal (ie isPortConnected[that port ID] is true), once active, isPresented should be set to true as well.
+ *      These Changes are applied asynchronously in a separate thread, and will be communicated through the


Provide what we need from this API rather than how the implementation is considered.

Updated as per the comments.
New lines:
* Any change in the variable - 'dsCompositeInStatus_t' will be communicated via the 'dsCompositeInStatusChangeCB_t' callback.

srinivasgtl · 2025-08-20T08:43:10Z

include/dsCompositeIn.h

 * 
- * @pre  dsCompositeInInit() should be called before calling this API.
+ * @pre  dsCompositeInInit() should be called before calling this API. The Composite input port status is updated asynchronously via 
+ * 'dsCompositeInStatusChangeCB_t' callback whenever a change is detected.


Can we provide what change is considered here? may be point to the structure dsCompInSignalStatus_t if we are considering these changes as part of this requirement.

Updated as per the comments.
New lines:

* @pre dsCompositeInInit() should be called before calling this API. * After every operation, that may change 'dsCompositeInStatus_t',should wait until the * 'dsCompositeInStatusChangeCB_t' callback is received.

srinivasgtl · 2025-08-20T08:43:28Z

include/dsHdmiIn.h

 * 
- * @pre dsHdmiInInit() must be called before calling this API.
+ * @pre dsHdmiInInit() must be called before calling this API. The HDMI input port status is updated asynchronously via 
+ * 'dsHdmiInStatusChangeCB_t' callback whenever a change is detected.


Please describe what changes.

The change is still a bit unclear, even on the callback description. Can you discuss with the team and suggest what changes are really considered here?

Updated as per the comments.
New lines:

* After every operation, that may change 'dsHdmiInStatus_t',should wait until the * 'dsHdmiInStatusChangeCB_t' callback is received.

kanjoe24 · 2025-12-08T12:33:15Z

@Dhivyailangovan , always create PR against develop branch. I have now done the change for you, however you will need to resolve the conflicts now.

kanjoe24 · 2025-12-08T12:55:22Z

Also, you have added Composite header files as well. Is this a new issue? If yes, can you raise a new ticket for composite and attach this PR to that as well or update it in the task ticket here(#164)
Ideally, one task ticket must have corresponding PR.

Can you also rename the PR, so that it has github id and not jira id please
Also, please get approval from @bijasbabu.

Copilot

Pull request overview

Updates public header documentation to clarify that input status fields are updated asynchronously and observed via status-change callbacks, so callers should not assume immediate synchronous updates after selection/operations.

Changes:

Add documentation guidance to wait for StatusChange callbacks after operations that may update status structs.
Fix a typo in the HDMI-In dsHdmiInSelectPort note (“thT” → “the”).
Add similar asynchronous-status notes for Composite-In APIs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
include/dsHdmiIn.h	Documents async status updates and callback-based notification for HDMI-In status fields.
include/dsCompositeIn.h	Adds analogous async/callback documentation for Composite-In status behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-27T09:08:10Z

include/dsCompositeIn.h

 * 
 * @note When a port is selected that port should be set as activePort in ::dsCompositeInStatus_t.
 *              Also, if there is a signal (ie isPortConnected[that port ID] is true), once active, isPresented should be set to true as well.
+ *       Any change in the variable - 'dsCompositeInStatus_t' will be communicated via the 'dsCompositeInStatusChangeCB_t' callback.


PR title/description mention only HDMI-In APIs, but this change also updates Composite-In documentation in this file. Please either update the PR metadata to include Composite-In, or split this into a separate PR so the scope matches the description.

Copilot · 2026-02-27T09:08:10Z

include/dsHdmiIn.h

+ *      After every operation, that may change 'dsHdmiInStatus_t',should wait until the 
+ *       'dsHdmiInStatusChangeCB_t' callback is received.


The new guidance about waiting for status updates is placed under @pre, which reads like a hard precondition for calling dsHdmiInGetStatus(). This is more accurately a @note/@attention about freshness of fields updated asynchronously. Also fix the punctuation/spacing (missing space after comma in "...,should").

Suggested change

* After every operation, that may change 'dsHdmiInStatus_t',should wait until the

* 'dsHdmiInStatusChangeCB_t' callback is received.

* @note After every operation that may change ::dsHdmiInStatus_t, callers should wait until the

* ::dsHdmiInStatusChangeCB_t callback is received before relying on the updated status.

Copilot · 2026-02-27T09:08:11Z

include/dsHdmiIn.h

- *              Also, if thT port has an active connection, it should update isPresented to true as well.
- * 
+ *              Also, if the port has an active connection, it should update isPresented to true as well.
+ *       Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInStatusChangeCB_t' callback.


This note appears to reference the wrong type/callback: it says changes to 'dsHdmiInSignalStatus_t' are communicated via 'dsHdmiInStatusChangeCB_t'. In this header, signal status has its own callback type (dsHdmiInSignalChangeCB_t), while dsHdmiInStatusChangeCB_t carries dsHdmiInStatus_t. Please align the wording with the actual callback used for signal status vs overall status updates.

Suggested change

* Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInStatusChangeCB_t' callback.

* Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInSignalChangeCB_t' callback.

Copilot · 2026-02-27T09:08:11Z

include/dsCompositeIn.h

+ * @pre  dsCompositeInInit() should be called before calling this API. 
+ *       After every operation, that may change 'dsCompositeInStatus_t',should wait until the 
+ *       'dsCompositeInStatusChangeCB_t' callback is received.


Similar to dsHdmiInGetStatus(), the new "wait until ...StatusChangeCB" guidance is under @pre and reads like a strict precondition for calling dsCompositeInGetStatus(). Consider moving it to a @note/@attention about asynchronous updates, and fix punctuation/spacing (missing space after comma in "...,should").

Suggested change

* @pre dsCompositeInInit() should be called before calling this API.

* After every operation, that may change 'dsCompositeInStatus_t',should wait until the

* 'dsCompositeInStatusChangeCB_t' callback is received.

* @pre dsCompositeInInit() should be called before calling this API.

*

* @note After every operation that may change ::dsCompositeInStatus_t, applications should wait

* until the ::dsCompositeInStatusChangeCB_t callback is received before relying on the

* updated status.

Dhivyailangovan added 7 commits August 5, 2025 12:57

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

41787a0

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

be18de6

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

cc38197

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

d951145

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

c118ace

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

b5484fd

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

3998174

srinivasgtl requested review from bijasbabu, outdooruseonly and srinivasgtl August 5, 2025 09:41

srinivasgtl assigned Dhivyailangovan Aug 5, 2025

srinivasgtl added the enhancement New feature or request label Aug 5, 2025

srinivasgtl added this to HAL Interface & Test Suit - Upgrades Aug 5, 2025

srinivasgtl moved this to In Progress in HAL Interface & Test Suit - Upgrades Aug 5, 2025

srinivasgtl moved this from In Progress to Review Requested in HAL Interface & Test Suit - Upgrades Aug 5, 2025

srinivasgtl linked an issue Aug 5, 2025 that may be closed by this pull request

Task: Update description of dsHdmiInGetStatus and dsHdmiInSelectPort #164

Open

srinivasgtl added this to the M1.x.x - Bug Fixes and Enhancment in Aug 2025 milestone Aug 5, 2025

kanjoe24 previously approved these changes Aug 20, 2025

View reviewed changes

thanushreevani previously approved these changes Aug 20, 2025

View reviewed changes

srinivasgtl reviewed Aug 20, 2025

View reviewed changes

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

a83fb0e

Dhivyailangovan dismissed stale reviews from thanushreevani and kanjoe24 via a83fb0e August 25, 2025 17:24

Dhivyailangovan added 3 commits August 25, 2025 22:56

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

6909d27

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

68e4f3d

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort

671d8a5

kanjoe24 changed the base branch from main to develop December 8, 2025 12:29

Merge branch 'develop' into feature/RDKEVD-456_Hdmi

cc9a06c

Copilot AI review requested due to automatic review settings February 27, 2026 09:04

Copilot started reviewing on behalf of Dhivyailangovan February 27, 2026 09:05 View session

Copilot AI reviewed Feb 27, 2026

View reviewed changes

		* After every operation, that may change 'dsHdmiInStatus_t',should wait until the
		* 'dsHdmiInStatusChangeCB_t' callback is received.

	* Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInStatusChangeCB_t' callback.
	* Any change in the variable - 'dsHdmiInSignalStatus_t' will be communicated via the 'dsHdmiInSignalChangeCB_t' callback.

Conversation

Dhivyailangovan commented Aug 5, 2025

Uh oh!

kanjoe24 left a comment

Choose a reason for hiding this comment

Uh oh!

srinivasgtl Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Dhivyailangovan Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srinivasgtl Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Dhivyailangovan Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

srinivasgtl Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Dhivyailangovan Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srinivasgtl Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

srinivasgtl Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

Dhivyailangovan Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

kanjoe24 commented Dec 8, 2025

Uh oh!

kanjoe24 commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Dhivyailangovan Sep 4, 2025 •

edited

Loading

Dhivyailangovan Sep 4, 2025 •

edited

Loading

kanjoe24 commented Dec 8, 2025 •

edited

Loading