SecureCallback.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Texas Instruments Incorporated - https://www.ti.com
 * 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.
 */

/*
 *  ======== SecureCallback.h ========
 */

#ifndef ti_drivers_tfm_SecureCallback__include
#define ti_drivers_tfm_SecureCallback__include

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

#include <ti/drivers/utils/List.h>

#if defined(__cplusplus)
extern "C" {
#endif

typedef void (*SecureCallback_FuncPtr)(uintptr_t arg);

typedef struct SecureCallback_Object
{
    List_Elem elem;
    uintptr_t arg;
    bool pending;
    SecureCallback_FuncPtr fxn;
} SecureCallback_Object;

typedef SecureCallback_Object *SecureCallback_Handle;

typedef struct SecureCallback_Config
{
    uint32_t intNumber;
    uint8_t intPriority;
} SecureCallback_Config;

void SecureCallback_init(void);

SecureCallback_Handle SecureCallback_construct(SecureCallback_Object *object,
                                               SecureCallback_FuncPtr fxn,
                                               uintptr_t arg);

void SecureCallback_destruct(SecureCallback_Object *object);

void SecureCallback_post(SecureCallback_Handle handle);

#if defined(__cplusplus)
}
#endif

#endif /* ti_drivers_tfm_SecureCallback__include */