Semaphore (SEMA)

Modules
	SEMA_Registers

Typedefs
typedef void(*	mxc_sema_complete_cb_t) (int result)

Functions
int	MXC_SEMA_Init (void)
int	MXC_SEMA_GetSema (unsigned sema)
int	MXC_SEMA_CheckSema (unsigned sema)
uint32_t	MXC_SEMA_Status (void)
void	MXC_SEMA_FreeSema (unsigned sema)
int	MXC_SEMA_Shutdown (void)
int	MXC_SEMA_InitBoxes (void)
int	MXC_SEMA_ReadBox (uint8_t *data, unsigned len)
int	MXC_SEMA_WriteBox (const uint8_t *data, unsigned len)
int	MXC_SEMA_Handler (void)
int	MXC_SEMA_ReadBoxAsync (mxc_sema_complete_cb_t cb, uint8_t *data, unsigned len)
int	MXC_SEMA_WriteBoxAsync (mxc_sema_complete_cb_t cb, const uint8_t *data, unsigned len)

Detailed Description

Typedef Documentation

mxc_sema_complete_cb_t

typedef void(* mxc_sema_complete_cb_t) (int result)

The callback routine used by the MXC_SEMA_ReadBoxAsync() and MXC_SEMA_WriteBoxAsync functions to indicate the operation has completed.

Parameters

result

The error code (if any) of the read/write operation. See Error Codes for the list of error codes.

Function Documentation

MXC_SEMA_CheckSema()

int MXC_SEMA_CheckSema

(

unsigned

sema

)

Check a semaphore.

Parameters

sema	Number of semaphore you want to check.

Returns

E_NO_ERROR if semaphore is free. E_BUSY if semaphore is already locked.

Note

Will not be atomic if you call this function and then attempt to MXC_SEMA_GetSema().

MXC_SEMA_FreeSema()

void MXC_SEMA_FreeSema

(

unsigned

sema

)

Frees the semaphore.

Parameters

sema	Number of semaphore want to free.

MXC_SEMA_GetSema()

int MXC_SEMA_GetSema

(

unsigned

sema

)

Attempt to get a semaphore.

Parameters

sema	Number of semaphore you are trying to get.

Returns

E_NO_ERROR if semaphore acquired. E_BUSY if semaphore is already locked.

MXC_SEMA_Handler()

int MXC_SEMA_Handler

(

void

)

Semaphore interrupt handler.

Returns

E_NO_ERROR if interrupt handled properly.

MXC_SEMA_Init()

int MXC_SEMA_Init

(

void

)

Initialize the semaphore peripheral.

Returns

E_NO_ERROR if semaphore initialized.

MXC_SEMA_InitBoxes()

int MXC_SEMA_InitBoxes

(

void

)

Initialize the mailboxes.

Returns

E_NO_ERROR if mailboxes initialized.

MXC_SEMA_ReadBox()

int MXC_SEMA_ReadBox	(	uint8_t *	data,
		unsigned	len
	)

Read from the mailbox.

Will only read data currently available.

Parameters

data	Buffer to store the data from the mailbox.
len	Number of bytes to read from the mailbox.

Returns

E_NO_ERROR if data read properly.

MXC_SEMA_ReadBoxAsync()

int MXC_SEMA_ReadBoxAsync	(	mxc_sema_complete_cb_t	cb,
		uint8_t *	data,
		unsigned	len
	)

Read asynchronously from the mailbox.

Non-blocking read. Will only read data currently available.

Parameters

cb	Callback function, called once the read is complete.
data	Buffer to store the data from the mailbox.
len	Number of bytes to read from the mailbox.

Returns

E_NO_ERROR if data read properly.

MXC_SEMA_Shutdown()

int MXC_SEMA_Shutdown

(

void

)

Shutdown the semaphore peripheral.

Returns

E_NO_ERROR if semaphore released.

MXC_SEMA_Status()

uint32_t MXC_SEMA_Status

(

void

)

Check all semaphores.

Returns

Status of all semaphores. Each semaphore will be represented by 1 bit.

Note

Will not be atomic if you call this function and then attempt to MXC_SEMA_GetSema().

MXC_SEMA_WriteBox()

int MXC_SEMA_WriteBox	(	const uint8_t *	data,
		unsigned	len
	)

Write to the mailbox.

Will only write in the space currently available.

Parameters

data	Data to write to the mailbox.
len	Number of bytes to write to the mailbox.

Returns

E_NO_ERROR if data written properly.

MXC_SEMA_WriteBoxAsync()

int MXC_SEMA_WriteBoxAsync	(	mxc_sema_complete_cb_t	cb,
		const uint8_t *	data,
		unsigned	len
	)

Write asynchronously to the mailbox.

Parameters

cb	Callback function, called once the write is complete.
data	Data to write to the mailbox.
len	Number of bytes to write to the mailbox.

Returns

E_NO_ERROR if data written properly.