HwiP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  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 HWIP_H
#define HWIP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
typedef void (*HwiP_FxnCallback)(void *args);
 
 
typedef struct HwiP_Config_
{
    uint32_t intcBaseAddr; 
} HwiP_Config;
 
typedef struct HwiP_Params_ {
 
    uint32_t intNum;   
    HwiP_FxnCallback callback; 
    void *args; 
    uint16_t eventId; 
    uint8_t priority; 
    uint8_t isFIQ; 
    uint8_t isPulse; 
} HwiP_Params;
 
#define HwiP_OBJECT_SIZE_MAX    (32u)
 
typedef struct HwiP_Object_ {
 
    uint32_t rsv[HwiP_OBJECT_SIZE_MAX/sizeof(uint32_t)]; 
} HwiP_Object;
 
void HwiP_Params_init(HwiP_Params *params);
 
int32_t HwiP_construct(HwiP_Object *obj, HwiP_Params *params);
 
 
int32_t HwiP_setArgs(HwiP_Object *obj, void *args);
 
void HwiP_destruct(HwiP_Object *obj);
 
void HwiP_enableInt(uint32_t intNum);
 
uint32_t HwiP_disableInt(uint32_t intNum);
 
void HwiP_restoreInt(uint32_t intNum, uint32_t oldIntState);
 
void HwiP_clearInt(uint32_t intNum);
 
 
 
void HwiP_post(uint32_t intNum);
 
uintptr_t HwiP_disable(void);
 
void HwiP_enable(void);
 
void HwiP_restore(uintptr_t oldIntState);
 
 
uint32_t HwiP_inISR(void);
 
void HwiP_init(void);
 
int32_t HwiP_registerNmiHandler(HwiP_FxnCallback nmiHandler, void *args);
 
int32_t HwiP_unregisterNmiHandler(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HWIP_H */