PDK API Guide for J721E
|
SwiP interface
Files | |
file | SwiP.h |
Software Interrupt module for the RTOS Porting Interface. | |
Data Structures | |
struct | SwiP_Params |
Basic SwiP Parameters. More... | |
Functions | |
SwiP_Handle | SwiP_create (SwiP_Fxn swiFxn, const SwiP_Params *swiPparams) |
Function to create a software interrupt. More... | |
SwiP_Status | SwiP_delete (SwiP_Handle *pHandle) |
Function to delete an interrupt on CortexM devices. More... | |
void | SwiP_Params_init (SwiP_Params *swiPparams) |
Initialize params structure to default values. More... | |
SwiP_Status | SwiP_post (SwiP_Handle swiPhandle) |
Function to post the Swi interrupt. More... | |
Typedefs | |
typedef void * | SwiP_Handle |
SwiP handle of an instance. More... | |
typedef void(* | SwiP_Fxn) (uintptr_t arg0, uintptr_t arg1) |
Prototype for the entry function for a software interrupt. More... | |
Enumerations | |
enum | SwiP_Status { SwiP_OK = 0, SwiP_FAILURE = (-(int32_t)1) } |
Status codes for SwiP APIs. More... | |
typedef void* SwiP_Handle |
SwiP handle of an instance.
A SwiP_Handle returned from the SwiP_create represents that instance.
typedef void(* SwiP_Fxn) (uintptr_t arg0, uintptr_t arg1) |
Prototype for the entry function for a software interrupt.
enum SwiP_Status |
SwiP_Handle SwiP_create | ( | SwiP_Fxn | swiFxn, |
const SwiP_Params * | swiPparams | ||
) |
Function to create a software interrupt.
swiFxn | entry function of the software interrupt |
swiPparams | Pointer to the instance configuration parameters. NULL denotes to use the default parameters. The SwiP default parameters are noted in SwiP_Params_init. |
SwiP_Status SwiP_delete | ( | SwiP_Handle * | pHandle | ) |
Function to delete an interrupt on CortexM devices.
pHandle | pointer of the handle returned from the SwiP_create call |
void SwiP_Params_init | ( | SwiP_Params * | swiPparams | ) |
Initialize params structure to default values.
swiPparams | Pointer to the instance configuration parameters. |
SwiP_Status SwiP_post | ( | SwiP_Handle | swiPhandle | ) |
Function to post the Swi interrupt.
swiPhandle | The swiP handle |