PR: Interface changes to support AIDL changes #33
Conversation
|
|
Ulrond
changed the title
Ulrond
changed the title
Ulrond
changed the title
| * | ||
| * @pre dsDisplayInit() and dsGetDisplay() must be called before calling this API | ||
| * | ||
| * @warning This API is Not thread safe |
There was a problem hiding this comment.
remove this everywhere, it's not required. You’ve stated it in your markdown overview.
Threading Model
This interface is not required to be thread safe
| * @param[out] length - length of the EDID buffer data. Min value is 0 | ||
| * @param[in] handle - Handle of the display device | ||
| * @param[out] edid - Pointer to raw EDID buffer | ||
| * @param[in] maxEDIDSize - length of the EDID buffer data. Min value is 0 |
There was a problem hiding this comment.
invalid value surely would be zero? You should be stating a reasonable value here, that's defined by a #define, otherwise the client doesn't know how much of a default buffer would cover a valid EDID.
| * | ||
| * @pre dsHdmiInInit() must be called before calling this API | ||
| * | ||
| * @warning This API is Not thread safe. |
| /** | ||
| * @brief Gets the maximum size of EDID data corresponds to the given input port | ||
| * | ||
| * For Sink devices this function gets the maximum size of EDID data corresponds to the given input port. |
There was a problem hiding this comment.
then the function should be stated as
dsGetSinkEDIDBytesMaxSize surely?
| * | ||
| * @pre dsHostInit() must be called before this function | ||
| * | ||
| * @warning This API is Not thread safe. |
| * @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 |
There was a problem hiding this comment.
under what condition would it be not supported? can't see this as a valid return code?
| * | ||
| * @pre dsHostInit() must be called before this function | ||
| * | ||
| * @warning This API is Not thread safe. |
| * @param[out] edid - host EDID. | ||
| * @param[out] length - length of host EDID. Min value of 0. Max value of 2048 | ||
| * @param[out] edid - host EDID. | ||
| * @param[in] maxEDIDLength - length of host EDID. Min value of 0. Max value of 2048 |
There was a problem hiding this comment.
can't be zero... You need to set a #define with a reasonable buffer size so that it's used here and the documention should state that.
| * @retval dsERR_NONE - Success | ||
| * @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid | ||
| * @retval dsERR_NOT_INITIALIZED - Module is not initialised | ||
| * @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported |
There was a problem hiding this comment.
why would this occur? dsERR_OPERATION_NOT_SUPPORTED ? Was this added to all functions due to AIDL?
No description provided.