RDKEVD-4709: Load project id based hostDataDefault#186
RDKEVD-4709: Load project id based hostDataDefault#186yeshwanth-nagaswamy wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a new API function dsGetHostDataDefault() to the Device Settings Host HAL to retrieve the file path of hostDataDefault based on the ProjectID. This enhancement allows clients to dynamically load project-specific host data configuration.
Changes:
- Added new API function
dsGetHostDataDefault()with full Doxygen documentation
Comments suppressed due to low confidence (3)
include/dsHost.h:195
- The documentation uses inconsistent whitespace (tabs instead of spaces) for alignment. The
@returnand@retvallines should use spaces for alignment to be consistent with other functions in this file (e.g., dsGetCPUTemperature, dsGetSocIDFromSDK, dsGetHostEDID at lines 127-132, 146-151, 168-173).
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
include/dsHost.h:186
- The description for sink and source devices is identical and redundant. Consider simplifying to a single statement: "This function will get the File path of hostDataDefault based on ProjectID for both sink and source devices." or removing the device type distinction if it doesn't add value.
* For sink devices, this function will get the File path of hostDataDefault based on ProjectID.
* For source devices, this function will get the File path of hostDataDefault based on ProjectID.
include/dsHost.h:183
- The brief description says "Gets hostDataDefault path file name" but the detailed description and parameter name refer to "File path". For consistency, consider changing the brief to either "Gets hostDataDefault file path" or "Gets path to hostDataDefault file" to match the detailed description and parameter semantics.
* @brief Gets hostDataDefault path file name
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * For sink devices, this function will get the File path of hostDataDefault based on ProjectID. | ||
| * For source devices, this function will get the File path of hostDataDefault based on ProjectID. | ||
| * | ||
| * @param[out] hostDataPath - File path of hostDataDefault. |
There was a problem hiding this comment.
The parameter documentation for hostDataPath lacks buffer size specification. Similar functions in this file specify the expected buffer size (e.g., dsGetSocIDFromSDK at line 144 specifies "20 byte Chip ID", dsGetHostEDID at line 166 specifies "Max value of 2048"). Consider adding the expected buffer size or maximum path length to help API consumers properly allocate memory.
| * @param[out] hostDataPath - File path of hostDataDefault. | |
| * @param[out] hostDataPath - Caller-allocated buffer that receives the file path of | |
| * hostDataDefault. The buffer must be large enough to hold | |
| * a fully qualified path for the target platform, including | |
| * the terminating null character (for example, at least | |
| * PATH_MAX bytes when using POSIX-style limits). The | |
| * implementation must not write more than the maximum path | |
| * length supported by the platform, including the null | |
| * terminator. |
9fa89cf to
5362a66
Compare
https://ccp.sys.comcast.net/browse/RDKEVD-4709