SwiP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2023, 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_SwiP__include
#define ti_dpl_SwiP__include

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

#ifdef __cplusplus
extern "C" {
#endif

#define SwiP_STRUCT_SIZE (60)

typedef union SwiP_Struct
{
    uint32_t dummy; 
    uint8_t data[SwiP_STRUCT_SIZE];
} SwiP_Struct;

typedef void *SwiP_Handle;

typedef enum
{
    SwiP_OK      = 0,
    SwiP_FAILURE = -1
} SwiP_Status;

typedef void (*SwiP_Fxn)(uintptr_t arg0, uintptr_t arg1);

typedef struct
{
    uintptr_t arg0;    
    uintptr_t arg1;    
    uint32_t priority; 
    uint32_t trigger;  
} SwiP_Params;

extern SwiP_Handle SwiP_construct(SwiP_Struct *swiP, SwiP_Fxn swiFxn, SwiP_Params *params);

extern void SwiP_destruct(SwiP_Struct *swiP);

extern void SwiP_Params_init(SwiP_Params *params);

extern SwiP_Handle SwiP_create(SwiP_Fxn swiFxn, SwiP_Params *params);

extern void SwiP_delete(SwiP_Handle handle);

extern uintptr_t SwiP_disable(void);

extern uint32_t SwiP_getTrigger(void);

extern void SwiP_andn(SwiP_Handle handle, uint32_t mask);

extern void SwiP_dec(SwiP_Handle handle);

extern void SwiP_inc(SwiP_Handle handle);

extern bool SwiP_inISR(void);

extern void SwiP_or(SwiP_Handle handle, uint32_t mask);

extern void SwiP_post(SwiP_Handle handle);

extern void SwiP_restore(uintptr_t key);

extern void SwiP_setPriority(SwiP_Handle handle, uint32_t priority);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_SwiP__include */