espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-06-05 21:14:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

[diag] modify gpio diag functions description (#8538)

Browse Source 
This commit modifies descriptions of diag gpio functions to better
describe returned errors.
This commit is contained in:
Maciej Baczmański
2022-12-20 20:14:20 +01:00
committed by GitHub
parent ddc1c7c8b1
commit 9af0bfa60e
2 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (269)
#define OPENTHREAD_API_VERSION (270)
/**
* @addtogroup api-instance
include/openthread/platform/diag.h
+16 -9
View File
@@ -146,8 +146,10 @@ void otPlatDiagAlarmCallback(otInstance *aInstance);
* @param[in] aValue true to set the gpio to high level, or false otherwise.
*
* @retval OT_ERROR_NONE Successfully set the gpio.
* @retval OT_ERROR_FAILED A platform error occurred while setting the gpio.
* @retval OT_ERROR_INVALID_ARGS @p aGpio is not supported.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on the platform.
* @retval OT_ERROR_INVALID_STATE Diagnostic mode was not enabled or @p aGpio is not configured as output.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented or configured on the platform.
*
*/
otError otPlatDiagGpioSet(uint32_t aGpio, bool aValue);
@@ -159,8 +161,10 @@ otError otPlatDiagGpioSet(uint32_t aGpio, bool aValue);
* @param[out] aValue A pointer where to put gpio value.
*
* @retval OT_ERROR_NONE Successfully got the gpio value.
* @retval OT_ERROR_FAILED A platform error occurred while getting the gpio value.
* @retval OT_ERROR_INVALID_ARGS @p aGpio is not supported or @p aValue is NULL.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on the platform.
* @retval OT_ERROR_INVALID_STATE Diagnostic mode was not enabled or @p aGpio is not configured as input.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented or configured on the platform.
*
*/
otError otPlatDiagGpioGet(uint32_t aGpio, bool *aValue);
@@ -172,8 +176,10 @@ otError otPlatDiagGpioGet(uint32_t aGpio, bool *aValue);
* @param[out] aMode The gpio mode.
*
* @retval OT_ERROR_NONE Successfully set the gpio mode.
* @retval OT_ERROR_INVALID_ARGS @p aGpio is not supported.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on the platform.
* @retval OT_ERROR_FAILED A platform error occurred while setting the gpio mode.
* @retval OT_ERROR_INVALID_ARGS @p aGpio or @p aMode is not supported.
* @retval OT_ERROR_INVALID_STATE Diagnostic mode was not enabled.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented or configured on the platform.
*
*/
otError otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode);
@@ -182,13 +188,14 @@ otError otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode);
* This function gets the gpio mode.
*
* @param[in] aGpio The gpio number.
* @param[out] aValue A pointer where to put gpio value.
* @param[out] aMode A pointer where to put gpio mode.
*
* @retval OT_ERROR_NONE Successfully got the gpio value.
* @retval OT_ERROR_FAILED The gpio is neither in input nor output mode. For example, if the gpio is in
* analog mode.
* @retval OT_ERROR_NONE Successfully got the gpio mode.
* @retval OT_ERROR_FAILED Mode returned by the platform is not implemented in OpenThread or a platform error
* occurred while getting the gpio mode.
* @retval OT_ERROR_INVALID_ARGS @p aGpio is not supported or @p aMode is NULL.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on the platform.
* @retval OT_ERROR_INVALID_STATE Diagnostic mode was not enabled.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented or configured on the platform.
*
*/
otError otPlatDiagGpioGetMode(uint32_t aGpio, otGpioMode *aMode);