Skip to content
Open
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions include/dsHost.h
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,27 @@ dsError_t dsGetSocIDFromSDK(char *socID);
*/
dsError_t dsGetHostEDID(unsigned char *edid, int *length);

/**
* @brief Gets hostDataDefault path file name
*
* This function will get the File path of hostDataDefault configured based on ProjectID.
*
* @param[out] hostDataPath - File path of hostDataDefault.
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
* @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.

Copilot uses AI. Check for mistakes.
*
* @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
*
* @pre dsHostInit() must be called before this function
*
* @warning This API is Not thread safe.
*
*/
dsError_t dsGetHostDataDefault(char *hostDataPath);

/** @} */ // End of DSHAL_HOST_API doxygen group
/** @} */ // End of DS Host HAL
/** @} */ // End of Device Settings HAL
Expand Down