Skip to content

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dhivyailangovan wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort #165

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
41787a0
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
be18de6
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
cc38197
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
d951145
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
c118ace
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
b5484fd
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
3998174
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 5, 2025
a83fb0e
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 25, 2025
6909d27
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 25, 2025
68e4f3d
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 26, 2025
671d8a5
gh #164 Update description of dsHdmiInGetStatus and dsHdmiInSelectPort
Dhivyailangovan Aug 26, 2025
cc9a06c
Merge branch 'develop' into feature/RDKEVD-456_Hdmi
Dhivyailangovan Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion include/dsCompositeIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,9 @@ dsError_t dsCompositeInGetNumberOfInputs (uint8_t *pNumberOfInputs);
*
* @warning This API is Not thread safe.
*
* @pre dsCompositeInInit() should be called before calling this API.
* @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.
Comment on lines +183 to +185
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
*/
dsError_t dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus);

Expand All @@ -202,6 +204,7 @@ dsError_t dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus);
*
* @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.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
*
* @pre dsCompositeInInit() should be called before calling this API.
*/
Expand Down
9 changes: 6 additions & 3 deletions include/dsHdmiIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,9 @@ dsError_t dsHdmiInGetNumberOfInputs (uint8_t *pNumberOfinputs);
* @retval dsERR_OPERATION_FAILED - The attempted operation has failed
*
* @pre dsHdmiInInit() must be called before calling this API.
*
* After every operation, that may change 'dsHdmiInStatus_t',should wait until the
* 'dsHdmiInStatusChangeCB_t' callback is received.
Comment on lines +184 to +185
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
*
* @warning This API is Not thread safe.
*
*/
Expand Down Expand Up @@ -213,8 +215,9 @@ dsError_t dsHdmiInGetStatus (dsHdmiInStatus_t *pStatus);
* @pre dsHdmiInInit() must be called before calling this API.
*
* @note When a port is selected, activePort should be set to true in Please refer ::dsHdmiInStatus_t for that port
* 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.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
*
* @warning This API is Not thread safe.
*
*/
Expand Down