docs: Replace Panel HAL placeholder with complete documentation (#374) by Ulrond · Pull Request #378 · rdkcentral/rdk-halif-aidl

Ulrond · 2026-03-28T07:49:39Z

Summary

Replace the Panel HAL placeholder ("Document Under Construction") with complete documentation
Content extracted from existing feature/58-task-panel---interface-specification branch
Covers functional overview, implementation requirements, interface definitions, system context, product customization, event handling, and resource management

Test plan

Verify mermaid diagrams render correctly in mkdocs
Review documentation accuracy against Panel AIDL interfaces
Confirm all interface files are listed in the Interface Definitions table

Copilot

Pull request overview

This PR replaces the placeholder Panel HAL documentation with a full specification-style document in docs/halif/panel/current/, aligning the Panel HAL with the documentation depth of other HAL modules.

Changes:

Adds an end-to-end Panel HAL overview covering capabilities, requirements, interfaces, lifecycle, and event handling.
Introduces interface and HFP integration sections plus a mermaid system-context diagram.
Replaces the “Document Under Construction” placeholder with complete content.

docs/halif/panel/current/panel.md

Ulrond · 2026-03-31T22:15:36Z

Copilot review disposition:

Fixed (comments Welcome to rdk-halif-aidl Discussions! #1, Task: Add DeviceInfo HAL interface definition #7): Admonition indentation — References table and Related Pages list now indented correctly under their admonitions.
Fixed (comment Feature: Add HAL Feature Profile reference YAML files to each HAL component #3): panelType/pixelWidth/heightCm attribution corrected from IPanelOutput.aidl to Capabilities.aidl (returned via getCapabilities()).
Dismissed (comment Profiles : IAudioDecoderManager.yaml #2): Removing # column from Implementation Requirements table — this matches the format used in AudioMixer and Flash HAL docs.
Not applied (comments Feature/gh3 Add HFP YAML files #4, Task: Add Flash HAL interface definition #5, Initial commit of Flash HAL and new boot ResetType enums. #6): UK English spelling changes — style preference, not a bug.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 6 comments.

Copilot · 2026-04-07T09:59:50Z

docs/halif/panel/current/panel.md

+| #               | Requirement                                                                                                                                    | Comments                                      |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
+| **HAL.PANEL.1** | The service shall expose accurate static capabilities including panel resolution, physical dimensions, and supported PQ parameters.            | Enables adaptive client configurations        |


The requirements table uses a double leading pipe (|| ...), which creates an extra empty column and can render the table incorrectly in Markdown/MkDocs. Use a single leading | consistently (as done in other HAL docs).

Copilot · 2026-04-07T09:59:50Z

docs/halif/panel/current/panel.md

+| AIDL File                           | Description                                                  |
+| ----------------------------------- | ------------------------------------------------------------ |
+| `Capabilities.aidl`                   | Defines panel capabilities and supported picture modes       |
+| `IFactoryPanel.aidl`                  | Factory interface for persistent configuration and tests     |


The Interface Definitions table also starts each row with ||, which adds an empty first column and may break table rendering. Switch to a single leading | for the header and rows.

Copilot · 2026-04-07T09:59:50Z

docs/halif/panel/current/panel.md

+* Dynamic control over panel enable/disable, picture modes, frame rate matching, and display fading.
+* Event callbacks for real-time updates on video source, dynamic range, resolution, and refresh rate changes.
+
+The corresponding [`hfp-panel.yaml`](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) file includes structured declarations for:


The hfp-panel.yaml link uses a GitHub /tree/ URL which typically 404s for files (it should be /blob/). Update the URL so it points to the file content rather than a non-existent tree path.

Suggested change

The corresponding [`hfp-panel.yaml`](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) file includes structured declarations for:

The corresponding [`hfp-panel.yaml`](https://github.com/rdkcentral/rdk-halif-aidl/blob/develop/panel/current/hfp-panel.yaml) file includes structured declarations for:

Copilot · 2026-04-07T09:59:51Z

docs/halif/panel/current/panel.md

+
+## HAL Feature Profile Integration
+
+Each platform must include a [hfp-panel.yaml](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) to define the platform-specific implementation of this HAL. It includes:


This later hfp-panel.yaml link also uses a GitHub /tree/ URL for a file. Use /blob/ (or a relative docs link) to avoid a broken link in the rendered documentation.

Suggested change

Each platform must include a [hfp-panel.yaml](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) to define the platform-specific implementation of this HAL. It includes:

Each platform must include a [hfp-panel.yaml](https://github.com/rdkcentral/rdk-halif-aidl/blob/develop/panel/current/hfp-panel.yaml) to define the platform-specific implementation of this HAL. It includes:

Copilot · 2026-04-07T09:59:51Z

docs/halif/panel/current/panel.md

+
+## Operation and Data Flow
+
+* Client query `Capabilities` for supported picture modes and PQ parameters.


Grammar: "Client query Capabilities" should be "Clients query Capabilities" (or "A client queries...") for correct subject/verb agreement.

Suggested change

* Client query `Capabilities` for supported picture modes and PQ parameters.

* Clients query `Capabilities` for supported picture modes and PQ parameters.

Copilot · 2026-04-07T09:59:51Z

docs/halif/panel/current/panel.md

+| Format        | Use Case                | Support Level |
+| ------------- | ----------------------- | ------------- |
+| Picture Modes | Video display presets   | Mandatory     |


The Data Format / Protocol Support table also uses || at the start of each row, introducing an empty first column and risking broken rendering. Use a single leading | consistently.

Extract complete Panel HAL documentation from feature/58 branch, replacing the under-construction placeholder with functional overview, implementation requirements, interface definitions, system context, and product customization sections.

Fix References and Related Pages content not rendering inside admonitions due to missing indentation. Correct panelType/pixelWidth/heightCm attribution from IPanelOutput.aidl to Capabilities.aidl.

Copilot AI review requested due to automatic review settings March 28, 2026 07:49

github-project-automation bot moved this to Architecture Review Required in halif_aidl Mar 28, 2026

github-project-automation bot added this to halif_aidl Mar 28, 2026

Copilot started reviewing on behalf of Ulrond March 28, 2026 07:50 View session

Copilot AI reviewed Mar 28, 2026

View reviewed changes

Ulrond self-assigned this Mar 30, 2026

Ulrond added documentation Improvements or additions to documentation component:panel OEM component: panel labels Mar 30, 2026

Ulrond moved this from Architecture Review Required to Under Review in halif_aidl Mar 30, 2026

Ulrond added this to the 0.15.0 milestone Mar 30, 2026

Ulrond linked an issue Apr 7, 2026 that may be closed by this pull request

docs: Replace Panel HAL placeholder with complete documentation #374

Closed

Copilot AI review requested due to automatic review settings April 7, 2026 09:55

Copilot started reviewing on behalf of Ulrond April 7, 2026 09:56 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

Ulrond added 3 commits April 7, 2026 11:00

docs: fix admonition indentation and Capabilities attribution (#374)

bcd8a01

Fix References and Related Pages content not rendering inside admonitions due to missing indentation. Correct panelType/pixelWidth/heightCm attribution from IPanelOutput.aidl to Capabilities.aidl.

docs: apply UK English spelling to Panel HAL documentation (#374)

341d95f

Ulrond force-pushed the feature/374-panel-hal-documentation branch from 2867c21 to 341d95f Compare April 7, 2026 10:00

Ulrond added the pre-restructure Must be completed before interface restructuring label Apr 7, 2026

Ulrond merged commit b0f14fd into develop Apr 7, 2026
2 checks passed

github-project-automation bot moved this from Under Review to Resolved in halif_aidl Apr 7, 2026

github-actions bot locked and limited conversation to collaborators Apr 7, 2026

	The corresponding [`hfp-panel.yaml`](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) file includes structured declarations for:
	The corresponding [`hfp-panel.yaml`](https://github.com/rdkcentral/rdk-halif-aidl/blob/develop/panel/current/hfp-panel.yaml) file includes structured declarations for:


		## HAL Feature Profile Integration

		Each platform must include a [hfp-panel.yaml](https://github.com/rdkcentral/rdk-halif-aidl/tree/develop/panel/current/hfp-panel.yaml) to define the platform-specific implementation of this HAL. It includes:


		## Operation and Data Flow

		* Client query `Capabilities` for supported picture modes and PQ parameters.

	* Client query `Capabilities` for supported picture modes and PQ parameters.
	* Clients query `Capabilities` for supported picture modes and PQ parameters.

Conversation

Ulrond commented Mar 28, 2026

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ulrond commented Mar 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants