fix: modify event API description

Change-Id: I62a819f3407fb933e0bb2ff2e97eda6e643acafb
This commit is contained in:
Guangyao Ma 2021-05-08 10:17:11 +08:00 committed by YOUR_NAME
parent 6c1ce1c1cc
commit 9481f1d840
2 changed files with 5 additions and 5 deletions

View File

@ -274,7 +274,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
/** /**
* @ingroup los_event * @ingroup los_event
* @brief Clear the event occurring in a specified task. * @brief Clear the event of the eventCB by a specified eventMask.
* *
* @par Description: * @par Description:
* <ul> * <ul>
@ -287,7 +287,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
* </ul> * </ul>
* *
* @param eventCB [IN/OUT] Pointer to the event control block to be cleared. * @param eventCB [IN/OUT] Pointer to the event control block to be cleared.
* @param events [IN] Mask of the event to be cleared. * @param eventMask [IN] Mask of the event to be cleared.
* *
* @retval #LOS_ERRNO_EVENT_PTR_NULL Null pointer. * @retval #LOS_ERRNO_EVENT_PTR_NULL Null pointer.
* @retval #LOS_OK The event is successfully cleared. * @retval #LOS_OK The event is successfully cleared.
@ -295,7 +295,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
* <ul><li>los_event.h: the header file that contains the API declaration.</li></ul> * <ul><li>los_event.h: the header file that contains the API declaration.</li></ul>
* @see LOS_EventPoll | LOS_EventRead | LOS_EventWrite * @see LOS_EventPoll | LOS_EventRead | LOS_EventWrite
*/ */
extern UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events); extern UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask);
/** /**
* @ingroup los_event * @ingroup los_event

View File

@ -204,14 +204,14 @@ LITE_OS_SEC_TEXT_INIT UINT32 LOS_EventDestroy(PEVENT_CB_S eventCB)
OsHookCall(LOS_HOOK_TYPE_EVENT_DESTROY); OsHookCall(LOS_HOOK_TYPE_EVENT_DESTROY);
return LOS_OK; return LOS_OK;
} }
LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events) LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask)
{ {
UINTPTR intSave; UINTPTR intSave;
if (eventCB == NULL) { if (eventCB == NULL) {
return LOS_ERRNO_EVENT_PTR_NULL; return LOS_ERRNO_EVENT_PTR_NULL;
} }
intSave = LOS_IntLock(); intSave = LOS_IntLock();
eventCB->uwEventID &= events; eventCB->uwEventID &= eventMask;
LOS_IntRestore(intSave); LOS_IntRestore(intSave);
OsHookCall(LOS_HOOK_TYPE_EVENT_CLEAR, eventCB); OsHookCall(LOS_HOOK_TYPE_EVENT_CLEAR, eventCB);
return LOS_OK; return LOS_OK;