SDMMC OSA

Overview

The sdmmc osa adapter provide interface of os adapter.

Data Structures
struct	_sdmmc_osa_event
	sdmmc osa event More...
struct	_sdmmc_osa_mutex
	sdmmc osa mutex More...

Macros
#define	SDMMC_OSA_EVENT_TRANSFER_CMD_SUCCESS   (1UL << 0U)
	transfer event
#define	SDMMC_OSA_EVENT_CARD_INSERTED   (1UL << 8U)
	card detect event, start from index 8
#define	SDMMC_OSA_POLLING_EVENT_BY_SEMPHORE   1
	enable semphore by default

Typedefs
typedef struct _sdmmc_osa_event	sdmmc_osa_event_t
	sdmmc osa event
typedef struct _sdmmc_osa_mutex	sdmmc_osa_mutex_t
	sdmmc osa mutex

sdmmc osa Function
void	SDMMC_OSAInit (void)
	Initialize OSA.
status_t	SDMMC_OSAEventCreate (void *eventHandle)
	OSA Create event. More...
status_t	SDMMC_OSAEventWait (void *eventHandle, uint32_t eventType, uint32_t timeoutMilliseconds, uint32_t *event)
	Wait event. More...
status_t	SDMMC_OSAEventSet (void *eventHandle, uint32_t eventType)
	set event. More...
status_t	SDMMC_OSAEventGet (void *eventHandle, uint32_t eventType, uint32_t *flag)
	Get event flag. More...
status_t	SDMMC_OSAEventClear (void *eventHandle, uint32_t eventType)
	clear event flag. More...
status_t	SDMMC_OSAEventDestroy (void *eventHandle)
	Delete event. More...
status_t	SDMMC_OSAMutexCreate (void *mutexHandle)
	Create a mutex. More...
status_t	SDMMC_OSAMutexLock (void *mutexHandle, uint32_t millisec)
	set event. More...
status_t	SDMMC_OSAMutexUnlock (void *mutexHandle)
	Get event flag. More...
status_t	SDMMC_OSAMutexDestroy (void *mutexHandle)
	Delete mutex. More...
void	SDMMC_OSADelay (uint32_t milliseconds)
	sdmmc delay. More...
uint32_t	SDMMC_OSADelayUs (uint32_t microseconds)
	sdmmc delay us. More...

---

Data Structure Documentation

struct _sdmmc_osa_event

struct _sdmmc_osa_mutex

Function Documentation

status_t SDMMC_OSAEventCreate

(

void *

eventHandle

)

Parameters

eventHandle

event handle.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAEventWait	(	void *	eventHandle,
		uint32_t	eventType,
		uint32_t	timeoutMilliseconds,
		uint32_t *	event
	)

Parameters

eventHandle	The event type
eventType	Timeout time in milliseconds.
timeoutMilliseconds	timeout value in ms.
event	event flags.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAEventSet	(	void *	eventHandle,
		uint32_t	eventType
	)

Parameters

eventHandle	event handle.
eventType	The event type

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAEventGet	(	void *	eventHandle,
		uint32_t	eventType,
		uint32_t *	flag
	)

Parameters

eventHandle	event handle.
eventType	event type.
flag	pointer to store event value.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAEventClear	(	void *	eventHandle,
		uint32_t	eventType
	)

Parameters

eventHandle	event handle.
eventType	The event type

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAEventDestroy

(

void *

eventHandle

)

Parameters

eventHandle

The event handle.

status_t SDMMC_OSAMutexCreate

(

void *

mutexHandle

)

Parameters

mutexHandle

mutex handle.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAMutexLock	(	void *	mutexHandle,
		uint32_t	millisec
	)

Parameters

mutexHandle	mutex handle.
millisec	The maximum number of milliseconds to wait for the mutex. If the mutex is locked, Pass the value osaWaitForever_c will wait indefinitely, pass 0 will return KOSA_StatusTimeout immediately.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAMutexUnlock

(

void *

mutexHandle

)

Parameters

mutexHandle

mutex handle.

Return values

kStatus_Fail

or kStatus_Success.

status_t SDMMC_OSAMutexDestroy

(

void *

mutexHandle

)

Parameters

mutexHandle

The mutex handle.

void SDMMC_OSADelay

(

uint32_t

milliseconds

)

Parameters

milliseconds

time to delay

uint32_t SDMMC_OSADelayUs

(

uint32_t

microseconds

)

Parameters

microseconds

time to delay

Returns

actual delayed microseconds