ipc_types.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2018
 *  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 IPC_TYPES_H_
#define IPC_TYPES_H_

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define IPC_SOK                        (CSL_PASS)

#define IPC_EFAIL                      (CSL_EFAIL)

#define IPC_EBADARGS                   (CSL_EBADARGS)

#define IPC_EINVALID_PARAMS            (CSL_EINVALID_PARAMS)

#define IPC_ETIMEOUT                   (CSL_ETIMEOUT)

#define IPC_EALLOC                     (CSL_EALLOC)

#define IPC_EUNSUPPORTED               (CSL_EUNSUPPORTED_CMD)

#define IPC_E_UNBLOCKED                (-50)

#define IPC_INTR_INVALID               (0xFFFF0000U)

#define IPC_RPMESSAGE_TIMEOUT_FOREVER   ~(0)

#define RPMESSAGE_ANY                   (0xFFFFFFFFU)

#define RPMESSAGE_ALL                   (0xFFFFFFFFU)

typedef struct Ipc_MbConfig_s
{
    uint32_t   priority;
    uint32_t   eventId;
    uint32_t   inputIntrNum;
    uint32_t   outputIntrNum;
    uint32_t   eventIdBase;
}Ipc_MbConfig;

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

typedef struct Ipc_OsalHIsrHandle_s
{
    uintptr_t       arg0;
    uintptr_t       arg1;
    Ipc_OsalHIsrFxn hIsrFxn;
    void            *hLosHisrHandle;
}Ipc_OsalHIsrHandle;

typedef void (* Ipc_OsalHIsrGateHandle);

typedef uint32_t (*Ipc_VirtToPhyFxn)(const void *virtAddr);

typedef void *(*Ipc_PhyToVirtFxn)(uint32_t phyAddr);

typedef void (*Ipc_PrintFxn)(const char *str);

typedef uintptr_t (*Ipc_OsalDisableAllIntrFxn)(void);

typedef void (*Ipc_OsalRestoreAllIntrFxn)(uintptr_t cookie);

typedef Ipc_OsalHIsrGateHandle (*Ipc_OsalCreateHIsrMutexFxn)(void);

typedef void (*Ipc_OsalDeleteHIsrMutexFxn)(Ipc_OsalHIsrGateHandle *handle);

typedef int32_t (*Ipc_OsalEnterHIsrMutexFxn)(Ipc_OsalHIsrGateHandle handle);

typedef void (*Ipc_OsalExitHIsrMutexFxn)(Ipc_OsalHIsrGateHandle handle,
                                            int32_t key);

typedef void * (*Ipc_OsalMutexCreateFxn)(void);

typedef void (*Ipc_OsalMutexDeleteFxn)(void *mutexHandle);

typedef int32_t (*Ipc_OsalMutexLockFxn)(void *mutexHandle, uint32_t timeout);

typedef void (*Ipc_OsalMutexUnlockFxn)(void *mutexHandle);

typedef int32_t (*Ipc_OsalHIsrCreateFxn)(Ipc_OsalHIsrHandle *handle,
                                         Ipc_OsalHIsrFxn fxn, void *arg);

typedef void (*Ipc_OsalHIsrDeleteFxn)(Ipc_OsalHIsrHandle *handle);

typedef int32_t (*Ipc_OsalHIsrPostFxn)(Ipc_OsalHIsrHandle *handle);

typedef void (*Ipc_OsalIsrFxn)(uintptr_t arg);

typedef void *(*Ipc_OsalRegisterIntrFxn)(Ipc_MbConfig *cfg,
                                         Ipc_OsalIsrFxn isrFxn,
                                         uintptr_t arg);

typedef void (*Ipc_OsalUnRegisterIntrFxn)(void *hwiHandle);

typedef void (*Ipc_NewMsgReceivedFxn)(uint32_t srcEndPt, uint32_t procId);

typedef struct Ipc_OsalPrms_s
{
    Ipc_OsalDisableAllIntrFxn   disableAllIntr;
    Ipc_OsalRestoreAllIntrFxn   restoreAllIntr;
    Ipc_OsalHIsrCreateFxn       createHIsr;
    Ipc_OsalHIsrDeleteFxn       deleteHIsr;
    Ipc_OsalHIsrPostFxn         postHIsr;
    Ipc_OsalCreateHIsrMutexFxn  createHIsrGate;
    Ipc_OsalDeleteHIsrMutexFxn  deleteHIsrGate;
    Ipc_OsalEnterHIsrMutexFxn   lockHIsrGate;
    Ipc_OsalExitHIsrMutexFxn    unLockHIsrGate;
    Ipc_OsalMutexCreateFxn      createMutex;
    Ipc_OsalMutexDeleteFxn      deleteMutex;
    Ipc_OsalMutexLockFxn        lockMutex;
    Ipc_OsalMutexUnlockFxn      unlockMutex;
    Ipc_OsalRegisterIntrFxn     registerIntr;
    Ipc_OsalUnRegisterIntrFxn   unRegisterIntr;
} Ipc_OsalPrms;

#ifdef __cplusplus
}
#endif

#endif /* #ifndef IPC_TYPES_H_ */