This module contains APIs which are used by the R5F cores to transfer data to and from PRU cores.
|
typedef struct PRU_IPC_Config_s * | PRU_IPC_Handle |
| A handle that is returned from a PRU_IPC_open() call. This handle is required for calling other PRU_IPC APIs. More...
|
|
typedef void(* | PRU_IPC_CallbackFxn) (void *args) |
| A Callback function required to register callback on data receive if receive interrupt is enabled. More...
|
|
◆ PRU_IPC_Handle
A handle that is returned from a PRU_IPC_open() call. This handle is required for calling other PRU_IPC APIs.
◆ PRU_IPC_CallbackFxn
typedef void(* PRU_IPC_CallbackFxn) (void *args) |
A Callback function required to register callback on data receive if receive interrupt is enabled.
◆ PRU_IPC_init()
void PRU_IPC_init |
( |
void |
| ) |
|
This function initializes the PRU_IPC module.
◆ PRU_IPC_deinit()
void PRU_IPC_deinit |
( |
void |
| ) |
|
This function deinitializes the PRU_IPC module.
◆ PRU_IPC_Params_init()
Function to set default values of PRU_IPC_Params in params.
- Parameters
-
[in] | params | pointer to the structure to be initialized |
◆ PRU_IPC_open()
To initialize and configure PRU_IPC instance.
- Parameters
-
[in] | idx | Identifier for instance to use (generated by sysconfig) |
[in] | params | pointer to the PRU_IPC_Params structure |
- Returns
- PRU_IPC_Handle in case of success, NULL otherwise
◆ PRU_IPC_close()
To stop/end PRU_IPC instance.
- Parameters
-
◆ PRU_IPC_getBlockId()
Reads the id of last written block by PRU from the PRU-Config memory.
- Parameters
-
- Returns
- Returns the id of last written block by PRU
◆ PRU_IPC_getData()
Reads the data from the configured shared memory.
- Parameters
-
[in] | handle | PRU_IPC_Handle returned from PRU_IPC_open() |
[in,out] | container | To store the data read from the configured shared memory, type: 2D Array - int32_t container[BUFFERS][BLOCKSIZE] |
- Returns
- SystemP_SUCCESS in case of success, SystemP_FAILURE otherwise
◆ PRU_IPC_sendData()
Send/Write data to the configured shared memory (generates interrupt to PRU if it is enabled)
- Parameters
-
[in] | handle | PRU_IPC_Handle returned from PRU_IPC_open() |
[in] | container | To write the data to the configured shared memory type: 2D Array - int32_t container[BUFFERS][BLOCKSIZE] |
- Returns
- SystemP_SUCCESS in case of success, SystemP_FAILURE otherwise