los_hwi.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2013-2020. All rights reserved.
 * Description: Hwi HeadFile
 * 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_HWI_H
#define _LOS_HWI_H
 
#include "los_base.h"
#include "hal_hwi.h"
#include "arch/cpu.h"
#include "arch/interrupt.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
extern size_t IntActive(VOID);
 
#define OS_INT_ACTIVE IntActive()
 
#define OS_INT_INACTIVE (!(OS_INT_ACTIVE))
 
#define OS_HWI_PRIO_HIGHEST 0
 
#define OS_HWI_PRIO_LOWEST (LOSCFG_HWI_PRIO_LIMIT - 1)
 
#if (OS_HWI_PRIO_HIGHEST == 0)
#define HWI_PRI_VALID(pri) ((pri) <= OS_HWI_PRIO_LOWEST)
#else
#define HWI_PRI_VALID(pri) (((pri) >= OS_HWI_PRIO_HIGHEST) && ((pri) <= OS_HWI_PRIO_LOWEST))
#endif
 
#define LOS_ERRNO_HWI_NUM_INVALID               LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x00)
#define OS_ERRNO_HWI_NUM_INVALID                LOS_ERRNO_HWI_NUM_INVALID
 
#define LOS_ERRNO_HWI_PROC_FUNC_NULL            LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x01)
#define OS_ERRNO_HWI_PROC_FUNC_NULL             LOS_ERRNO_HWI_PROC_FUNC_NULL
 
#define OS_ERRNO_HWI_CB_UNAVAILABLE LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x02)
 
#define LOS_ERRNO_HWI_NO_MEMORY                 LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x03)
#define OS_ERRNO_HWI_NO_MEMORY                  LOS_ERRNO_HWI_NO_MEMORY
 
#define LOS_ERRNO_HWI_ALREADY_CREATED           LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x04)
#define OS_ERRNO_HWI_ALREADY_CREATED            LOS_ERRNO_HWI_ALREADY_CREATED
 
#define LOS_ERRNO_HWI_PRIO_INVALID              LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x05)
#define OS_ERRNO_HWI_PRIO_INVALID               LOS_ERRNO_HWI_PRIO_INVALID
 
#define OS_ERRNO_HWI_MODE_INVALID LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x06)
 
#define OS_ERRNO_HWI_FASTMODE_ALREADY_CREATED LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x07)
 
#define LOS_ERRNO_HWI_INTERR                    LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x08)
#define OS_ERRNO_HWI_INTERR                     LOS_ERRNO_HWI_INTERR
 
#define LOS_ERRNO_HWI_SHARED_ERROR              LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x09)
#define OS_ERRNO_HWI_SHARED_ERROR               LOS_ERRNO_HWI_SHARED_ERROR
 
#define OS_ERRNO_HWI_ARG_INVALID LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0a)
 
#define LOS_ERRNO_HWI_HWINUM_UNCREATE           LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0b)
#define OS_ERRNO_HWI_HWINUM_UNCREATE            LOS_ERRNO_HWI_HWINUM_UNCREATE
 
#define LOS_ERRNO_HWI_NO_CPUP_MEMORY            LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0c)
 
#define LOS_ERRNO_HWI_NOT_INTERRUPT_CONTEXT    LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0d)
 
#define LOS_ERRNO_HWI_PTR_NULL                  LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0e)
 
#define LOS_ERRNO_HWI_ARG_NOT_ENABLED           LOS_ERRNO_OS_ERROR(LOS_MOD_HWI, 0x0f)
 
typedef UINT32 HWI_HANDLE_T;
 
typedef UINT16 HWI_PRIOR_T;
 
typedef UINT16 HWI_MODE_T;
 
typedef UINTPTR HWI_ARG_T;
 
typedef VOID (*HWI_PROC_FUNC)(VOID);
 
typedef VOID (*HWI_BOTTOM_HALF_FUNC)(VOID *);
 
#define IRQF_SHARED 0x8000U
 
typedef struct tagIrqParam {
    int swIrq;          
    VOID *pDevId;       
    const CHAR *pName;  
} HWI_IRQ_PARAM_S;
 
STATIC INLINE UINT32 LOS_IntLock(VOID)
{
    return ArchIntLock();
}
 
STATIC INLINE UINT32 LOS_IntUnLock(VOID)
{
    return ArchIntUnlock();
}
 
STATIC INLINE VOID LOS_IntRestore(UINT32 intSave)
{
    ArchIntRestore(intSave);
}
 
extern UINT32 LOS_HwiCreate(HWI_HANDLE_T hwiNum,
                            HWI_PRIOR_T hwiPrio,
                            HWI_MODE_T hwiMode,
                            HWI_PROC_FUNC hwiHandler,
                            HWI_IRQ_PARAM_S *irqParam);
 
extern UINT32 LOS_HwiDelete(HWI_HANDLE_T hwiNum, HWI_IRQ_PARAM_S *irqParam);
 
extern UINT32 LOS_HwiTrigger(HWI_HANDLE_T hwiNum);
 
extern UINT32 LOS_HwiClear(HWI_HANDLE_T hwiNum);
 
extern UINT32 LOS_HwiEnable(HWI_HANDLE_T hwiNum);
 
extern UINT32 LOS_HwiDisable(HWI_HANDLE_T hwiNum);
 
extern UINT32 LOS_HwiBhworkAdd(HWI_BOTTOM_HALF_FUNC bhHandler, VOID *data);
 
extern UINT32 LOS_HwiSendIpi(HWI_HANDLE_T hwiNum, UINT32 cpuMask);
 
extern UINT32 LOS_HwiSetAffinity(HWI_HANDLE_T hwiNum, UINT32 cpuMask);
 
extern UINT32 LOS_HwiSetPriority(HWI_HANDLE_T hwiNum, HWI_PRIOR_T priority);
 
extern LITE_OS_SEC_TEXT UINT32 LOS_HwiRespCntGet(HWI_HANDLE_T hwiNum, UINT32 *respCount);
 
#ifdef LOSCFG_HWI_PRE_POST_PROCESS
typedef VOID (*HWI_PROC_HOOK)(HWI_HANDLE_T hwiNum);
 
extern VOID LOS_HwiPreHookReg(HWI_PROC_HOOK intPreHook);
 
extern VOID LOS_HwiPostHookReg(HWI_PROC_HOOK intPostHook);
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_HWI_H */