HwiP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2025, 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_dpl_HwiP__include
#define ti_dpl_HwiP__include

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

#ifdef __cplusplus
extern "C" {
#endif

#define HwiP_STRUCT_SIZE (28)

typedef union HwiP_Struct
{
    uint32_t dummy; 
    uint8_t data[HwiP_STRUCT_SIZE];
} HwiP_Struct;

typedef void *HwiP_Handle;

typedef enum
{
    HwiP_OK      = 0,
    HwiP_FAILURE = -1
} HwiP_Status;

typedef void (*HwiP_Fxn)(uintptr_t arg);

typedef struct
{
    uintptr_t arg;     
    uint32_t priority; 
    bool enableInt;    
} HwiP_Params;

extern int HwiP_swiPIntNum;

extern HwiP_Handle HwiP_construct(HwiP_Struct *handle, int interruptNum, HwiP_Fxn hwiFxn, HwiP_Params *params);

extern void HwiP_destruct(HwiP_Struct *handle);

extern void HwiP_clearInterrupt(int interruptNum);

extern HwiP_Handle HwiP_create(int interruptNum, HwiP_Fxn hwiFxn, HwiP_Params *params);

extern void HwiP_delete(HwiP_Handle handle);

extern uintptr_t HwiP_disable(void);

extern void HwiP_enable(void);

extern void HwiP_disableInterrupt(int interruptNum);

extern void HwiP_enableInterrupt(int interruptNum);

extern bool HwiP_inISR(void);

extern bool HwiP_interruptsEnabled(void);

extern void HwiP_Params_init(HwiP_Params *params);

extern void HwiP_plug(int interruptNum, void *fxn);

extern void HwiP_post(int interruptNum);

extern void HwiP_restore(uintptr_t key);

extern void HwiP_setFunc(HwiP_Handle handle, HwiP_Fxn fxn, uintptr_t arg);

extern void HwiP_setPriority(int interruptNum, uint32_t priority);

void HwiP_dispatchInterrupt(int interruptNum);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_HwiP__include */