los_event.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2013-2020. All rights reserved.
 * Description: Event
 * Author: Huawei LiteOS Team
 * Create: 2013-01-01
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_EVENT_H
#define _LOS_EVENT_H
 
#include "los_base.h"
#include "los_list.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define LOS_WAITMODE_AND                    4U
 
#define LOS_WAITMODE_OR                     2U
 
#define LOS_WAITMODE_CLR                    1U
 
#define LOS_ERRNO_EVENT_SETBIT_INVALID      LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x00)
 
#define LOS_ERRNO_EVENT_READ_TIMEOUT        LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x01)
 
#define LOS_ERRNO_EVENT_EVENTMASK_INVALID   LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x02)
 
#define LOS_ERRNO_EVENT_READ_IN_INTERRUPT   LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x03)
 
#define LOS_ERRNO_EVENT_FLAGS_INVALID       LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x04)
 
#define LOS_ERRNO_EVENT_READ_IN_LOCK        LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x05)
 
#define LOS_ERRNO_EVENT_PTR_NULL            LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x06)
 
#define LOS_ERRNO_EVENT_READ_IN_SYSTEM_TASK LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x07)
 
#define LOS_ERRNO_EVENT_SHOULD_NOT_DESTORY  LOS_ERRNO_OS_ERROR(LOS_MOD_EVENT, 0x08)
 
typedef struct tagEvent {
    UINT32 uwEventID;        
    LOS_DL_LIST stEventList; 
} EVENT_CB_S, *PEVENT_CB_S;
 
extern UINT32 LOS_EventInit(PEVENT_CB_S eventCB);
 
extern UINT32 LOS_EventPoll(UINT32 *eventId, UINT32 eventMask, UINT32 mode);
 
extern UINT32 LOS_EventRead(PEVENT_CB_S eventCB, UINT32 eventMask, UINT32 mode, UINT32 timeout);
 
extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
 
extern UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events);
 
extern UINT32 LOS_EventDestroy(PEVENT_CB_S eventCB);
 
extern UINT32 LOS_EventCondWrite(PEVENT_CB_S eventCB);
 
extern UINT32 EventCondRead(PEVENT_CB_S eventCB, UINT32 *timeout);
 
#define LOS_EventCondRead(eventCB, eventCond, timeout) ({           \
    UINT32 ret = LOS_OK;                                            \
    UINT32 readTime = (timeout);                                    \
                                                                    \
    while (!(eventCond)) {                                          \
        ret = EventCondRead(eventCB, &readTime);                    \
        if (ret != LOS_OK) {                                        \
            break;                                                  \
        }                                                           \
    }                                                               \
    ret = (eventCond) ? LOS_OK : ret;                               \
    ret;                                                            \
})
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_EVENT_H */