HwiP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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 ti_osal_HwiP__include
#define ti_osal_HwiP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

/*********************************************************************
 * @def HWIP_USE_DEFAULT_PRIORITY
 * Use the default priority for the interrupts
 *
 *********************************************************************/
#define  HWIP_USE_DEFAULT_PRIORITY   (~((uint32_t)0))

typedef  void *HwiP_Handle;

typedef enum HwiP_Status_e {
    HwiP_OK       = 0,
    HwiP_FAILURE  = (-(int32_t)1)
} HwiP_Status;

typedef uint32_t OSAL_armGicTrigType_t;
#define OSAL_ARM_GIC_TRIG_TYPE_LEVEL          ((uint32_t) 1U)

#define OSAL_ARM_GIC_TRIG_TYPE_EDGE           ((uint32_t) 2U)

#define OSAL_ARM_GIC_TRIG_TYPE_HIGH_LEVEL     ((uint32_t) 3U)

#define OSAL_ARM_GIC_TRIG_TYPE_LOW_LEVEL      ((uint32_t) 4U)

#define OSAL_ARM_GIC_TRIG_TYPE_RISING_EDGE    ((uint32_t) 5U)

#define OSAL_ARM_GIC_TRIG_TYPE_FALLING_EDGE   ((uint32_t) 6U)
/* @} */

typedef void (*HwiP_Fxn)(uintptr_t arg);

typedef void (*HwiP_DirectFxn)(void);

typedef struct HwiP_Params_s {
    char      *name;      
    uintptr_t  arg;       
    uint32_t   priority;  
    uint32_t   enableIntr; 
    uint32_t   evtId;     
#if defined (__ARM_ARCH_7A__) || defined(__aarch64__) || ((__ARM_ARCH == 7) && (__ARM_ARCH_PROFILE == 'R'))
    uint32_t   triggerSensitivity; 
#endif
#ifdef QNX_OS
    uint32_t   autoEnable; 
#endif
} HwiP_Params;

extern void HwiP_clearInterrupt(uint32_t interruptNum);

extern HwiP_Handle HwiP_create(uint32_t interruptNum, HwiP_Fxn hwiFxn,
                               const HwiP_Params *hwipParams);

extern HwiP_Handle HwiP_createDirect(uint32_t interruptNum, HwiP_DirectFxn hwiFxn,
                                     const HwiP_Params *hwipParams);

extern HwiP_Status HwiP_delete(HwiP_Handle hwiPhandle);

extern uintptr_t HwiP_disable(void);

extern void HwiP_disableInterrupt(uint32_t interruptNum);

extern void HwiP_enableInterrupt(uint32_t interruptNum);

extern void HwiP_Params_init(HwiP_Params *hwipParams);

extern void HwiP_restore(uintptr_t key);
HwiP_Handle HwiP_getHandle(uint32_t interruptNum);
uint32_t HwiP_getEventId(uint32_t interruptNum);
extern int32_t HwiP_post(uint32_t interruptNum);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_HwiP__include */
/* @} */