pru_ipc.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022 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 PRU_IPC_H_
#define PRU_IPC_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/pruicss.h>
#include <kernel/dpl/SystemP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef struct PRU_IPC_Config_s         *PRU_IPC_Handle;
 
typedef void (*PRU_IPC_CallbackFxn)(void *args);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct {
    uint16_t blockId;
    uint8_t  dataSize;
    uint8_t  noOfBuffers;
    uint16_t blockSize;
    uint16_t noOfBlocks;
    uint32_t bufferAddrs;
} Config_Mem_Struct;
typedef struct PRU_IPC_Attrs_s {
    uint16_t  dataSize;          
    uint16_t  blockSize;         
    uint16_t  noOfBlocks;        
    uint16_t  noOfBuffers;       
    uint32_t  *bufferAddrs;      
    Config_Mem_Struct *config;   
    uint32_t  enableRxInt;       
    uint32_t  pruEvtoutNum;      
    uint32_t  sysEventNum;       
    uint32_t  r5fIntrNum;        
    uint32_t  enableTxInt;       
    uint32_t  txEventNum;        
    uint32_t  blockSizeBytes;    
} PRU_IPC_Attrs;
 
typedef struct PRU_IPC_Params_s {
    PRUICSS_Handle          pruicssHandle;
    PRU_IPC_CallbackFxn     transferCallbackFxn;
} PRU_IPC_Params;
 
typedef struct PRU_IPC_Object_s {
    PRU_IPC_Params  pruIpcParams;
} PRU_IPC_Object;
 
typedef struct PRU_IPC_Config_s {
    PRU_IPC_Object       *object;
    PRU_IPC_Attrs  const *attrs;
} PRU_IPC_Config;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
void PRU_IPC_init(void);
 
void PRU_IPC_deinit(void);
 
void PRU_IPC_Params_init(PRU_IPC_Params *params);
 
PRU_IPC_Handle PRU_IPC_open(uint32_t idx , PRU_IPC_Params *params);
 
void PRU_IPC_close(PRU_IPC_Handle handle);
 
uint16_t PRU_IPC_getBlockId(PRU_IPC_Handle handle);
 
int32_t PRU_IPC_getData(PRU_IPC_Handle handle, void *container);
 
int32_t PRU_IPC_sendData(PRU_IPC_Handle handle, void *container);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef PRU_IPC_H_ */