SwiP

Introduction

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 Documentation

SwiP_Handle

typedef void* SwiP_Handle

SwiP handle of an instance.

A SwiP_Handle returned from the SwiP_create represents that instance.

SwiP_Fxn

typedef void(* SwiP_Fxn) (uintptr_t arg0, uintptr_t arg1)

Prototype for the entry function for a software interrupt.

Enumeration Type Documentation

SwiP_Status

enum SwiP_Status

Status codes for SwiP APIs.

Enumerator
SwiP_OK
SwiP_FAILURE

Function Documentation

SwiP_create()

SwiP_Handle SwiP_create	(	SwiP_Fxn	swiFxn,
		const SwiP_Params *	swiPparams
	)

Function to create a software interrupt.

Parameters

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.

Returns

SwiP_Handle

SwiP_delete()

SwiP_Status SwiP_delete

(

SwiP_Handle *

pHandle

)

Function to delete an interrupt on CortexM devices.

Parameters

pHandle

pointer of the handle returned from the SwiP_create call

Returns

SwiP_OK if successfull, SwiP_FAILURE if fail

SwiP_Params_init()

void SwiP_Params_init

(

SwiP_Params *

swiPparams

)

Initialize params structure to default values.

Parameters

swiPparams

Pointer to the instance configuration parameters.

SwiP_post()

SwiP_Status SwiP_post

(

SwiP_Handle

swiPhandle

)

Function to post the Swi interrupt.

Parameters

swiPhandle

The swiP handle

Returns

SwiP_OK if successfull, SwiP_FAILURE if fail