michaelh/zephyr
1
0
Fork 0
Code Releases Activity

ipm: Correct IPM API error codes

Browse source 
Indicates that error codes are negative.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2019-11-29 10:19:44 +02:00 • committed by Anas Nashif
commit 07bee26f8f
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/drivers/ipm.h
View file

@ -122,11 +122,11 @@ struct ipm_driver_api {
* @param data Pointer to the data sent in the message.
* @param size Size of the data.
*
* @retval EBUSY If the remote hasn't yet read the last data sent.
* @retval EMSGSIZE If the supplied data size is unsupported by the driver.
* @retval EINVAL If there was a bad parameter, such as: too-large id value.
* or the device isn't an outbound IPM channel.
* @retval 0 On success.
* @retval -EBUSY If the remote hasn't yet read the last data sent.
* @retval -EMSGSIZE If the supplied data size is unsupported by the driver.
* @retval -EINVAL If there was a bad parameter, such as: too-large id value.
* or the device isn't an outbound IPM channel.
* @retval 0 On success.
*/
__syscall int ipm_send(struct device *ipmdev, int wait, u32_t id,
const void *data, int size);
@ -200,8 +200,8 @@ static inline u32_t z_impl_ipm_max_id_val_get(struct device *ipmdev)
* @param ipmdev Driver instance pointer.
* @param enable Set to 0 to disable and to nonzero to enable.
*
* @retval 0 On success.
* @retval EINVAL If it isn't an inbound channel.
* @retval 0 On success.
* @retval -EINVAL If it isn't an inbound channel.
*/
__syscall int ipm_set_enabled(struct device *ipmdev, int enable);