Add ARCHITECTURE.md and PRODUCT.md documentation#43
Conversation
- Add comprehensive architecture documentation describing the layered design - Add product documentation detailing features, use cases, and integration - Include component descriptions, communication flows, and design patterns - Document API usage examples and extension points
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive technical and product documentation for the HDMI-CEC library, providing essential reference materials for developers and integrators working with the CEC protocol implementation.
Summary
The PR introduces two new documentation files that describe the architecture and product capabilities of the HDMI-CEC library. These documents provide both technical implementation details and product-level feature descriptions for RDK-based CEC implementations.
Key Changes
- Added ARCHITECTURE.md covering the layered architecture, core components, communication flows, and design patterns
- Added PRODUCT.md describing product features, API usage patterns, use cases, and integration points
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| ARCHITECTURE.md | Comprehensive technical documentation covering the three-layer architecture (Application, CCEC, OSAL, Driver), core components, communication flows, design patterns, and build system information |
| PRODUCT.md | Product-focused documentation detailing CEC protocol support, dual API layers, asynchronous communication model, use cases across different device types, integration points, and example applications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| └─────────────────────────────────────────────────────┘ | ||
| ↓ | ||
| ┌─────────────────────────────────────────────────────┐ | ||
| │ OSAL Layer │ |
There was a problem hiding this comment.
should remove OSAL as it is giving impression that that layer is making HAL call however it is abstracting mutex and thread related calls
| - State machine for driver lifecycle (CLOSED/OPENING/OPENED/CLOSING) | ||
| - ACK/NACK handling (SENT_AND_ACKD, SENT_FAILED, SENT_BUT_NOT_ACKD) | ||
|
|
||
| #### 2.5 Host Integration |
There was a problem hiding this comment.
this is not used we can remove from code and the docs
|
|
||
| ### 7. Platform Abstraction | ||
|
|
||
| The OSAL layer ensures portability across different RDK platforms: |
There was a problem hiding this comment.
We should mentioned HAL over OSAL
Description
This PR adds comprehensive documentation for the HDMI-CEC library:
Added Files
ARCHITECTURE.md: Describes the overall architecture including:
PRODUCT.md: Describes the product functionality including:
Both documents are limited to approximately 2 pages for easy reference.
Type of Change
Testing