taf_flash_client.c File Reference

#include "taf_flash_interface.h"
#include "taf_flash_messages.h"
#include "taf_flash_service.h"

Data Structures
struct	_ClientThreadData_t

Macros
#define	LOCK_INIT   le_mutex_Lock(le_ifgen_InitMutexRef);
	Locks the mutex. More...
#define	UNLOCK_INIT   le_mutex_Unlock(le_ifgen_InitMutexRef);
	Unlocks the mutex. More...

Functions
	LE_MEM_DEFINE_STATIC_POOL (taf_flash_ClientThreadData, LE_CDATA_COMPONENT_COUNT, sizeof(_ClientThreadData_t))
static le_result_t	InitClientForThread (bool isBlocking)
static _ClientThreadData_t *	GetClientThreadDataPtr (void)
	__attribute__ ((unused))
static void	ClientThreadDestructor (void *objPtr)
static void	InitCommonData (void)
static le_result_t	DoConnectService (bool isBlocking)
void	taf_flash_ConnectService (void)
le_result_t	taf_flash_TryConnectService (void)
static void	SessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	taf_flash_SetServerDisconnectHandler (taf_flash_DisconnectHandler_t disconnectHandler, void *contextPtr)
static void	NonExitSessionCloseHandler (le_msg_SessionRef_t sessionRef, void *contextPtr)
void	taf_flash_SetNonExitServerDisconnectHandler (taf_flash_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_flash_DisconnectService (void)
void	taf_flash_Init (void)
le_result_t	taf_flash_MtdOpen (const char *LE_NONNULL partitionName, taf_flash_OpenMode_t mode, taf_flash_PartitionRef_t *partitionRefPtr)
le_result_t	taf_flash_MtdClose (taf_flash_PartitionRef_t partitionRef)
le_result_t	taf_flash_MtdInformation (taf_flash_PartitionRef_t partitionRef, uint32_t *blocksNumberPtr, uint32_t *badBlocksNumberPtr, uint32_t *blockSizePtr, uint32_t *pageSizePtr)
le_result_t	taf_flash_MtdEraseBlock (taf_flash_PartitionRef_t partitionRef, uint32_t blockIndex)
le_result_t	taf_flash_MtdReadPage (taf_flash_PartitionRef_t partitionRef, uint32_t pageIndex, uint8_t *readDataPtr, size_t *readDataSizePtr)
le_result_t	taf_flash_MtdWritePage (taf_flash_PartitionRef_t partitionRef, uint32_t pageIndex, const uint8_t *writeDataPtr, size_t writeDataSize)
le_result_t	taf_flash_MtdRead (taf_flash_PartitionRef_t partitionRef, uint32_t offset, uint8_t *readDataPtr, size_t *readDataSizePtr)
le_result_t	taf_flash_MtdWrite (taf_flash_PartitionRef_t partitionRef, uint32_t offset, const uint8_t *writeDataPtr, size_t writeDataSize)
le_result_t	taf_flash_MtdErase (taf_flash_PartitionRef_t partitionRef)
bool	taf_flash_MtdIsBlockGood (taf_flash_PartitionRef_t partitionRef, uint32_t blockIndex)
le_result_t	taf_flash_UbiOpen (const char *LE_NONNULL volumeName, taf_flash_OpenMode_t mode, taf_flash_VolumeRef_t *volumeRefPtr)
le_result_t	taf_flash_UbiClose (taf_flash_VolumeRef_t volumeRef)
le_result_t	taf_flash_UbiInformation (taf_flash_VolumeRef_t volumeRef, uint32_t *lebNumberPtr, uint32_t *freeLebNumberPtr, uint32_t *volumeSizePtr)
le_result_t	taf_flash_UbiRead (taf_flash_VolumeRef_t volumeRef, uint32_t offset, uint8_t *readDataPtr, size_t *readDataSizePtr)
le_result_t	taf_flash_UbiInitWrite (taf_flash_VolumeRef_t volumeRef, int64_t writeBytes)
le_result_t	taf_flash_UbiWrite (taf_flash_VolumeRef_t volumeRef, const uint8_t *writeDataPtr, size_t writeDataSize)

Variables
static le_mem_PoolRef_t	_ClientThreadDataPool
static pthread_key_t	_ThreadDataKey
static bool	CommonDataInitialized = false
le_mutex_Ref_t	le_ifgen_InitMutexRef

Macro Definition Documentation

LOCK_INIT

#define LOCK_INIT   le_mutex_Lock(le_ifgen_InitMutexRef);

Locks the mutex.

UNLOCK_INIT

#define UNLOCK_INIT   le_mutex_Unlock(le_ifgen_InitMutexRef);

Unlocks the mutex.

Function Documentation

LE_MEM_DEFINE_STATIC_POOL()

LE_MEM_DEFINE_STATIC_POOL	(	taf_flash_ClientThreadData	,
		LE_CDATA_COMPONENT_COUNT	,
		sizeof(_ClientThreadData_t)
	)

Static pool for client threads.

InitClientForThread()

static le_result_t InitClientForThread ( bool  isBlocking )

static

Initialize thread specific data, and connect to the service for the current thread.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

GetClientThreadDataPtr()

static _ClientThreadData_t* GetClientThreadDataPtr ( void  )

static

Get a pointer to the client thread data for the current thread.

If the current thread does not have client data, then NULL is returned

__attribute__()

__attribute__

(

(unused)

)

Return the sessionRef for the current thread.

If the current thread does not have a session ref, then this is a fatal error.

ClientThreadDestructor()

static void ClientThreadDestructor ( void *  objPtr )

static

Destructor function for client thread objects.

InitCommonData()

static void InitCommonData ( void  )

static

Init data that is common across all threads.

DoConnectService()

static le_result_t DoConnectService ( bool  isBlocking )

static

Connect to the service, using either blocking or non-blocking calls.

This function implements the details of the public ConnectService functions.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

taf_flash_ConnectService()

void taf_flash_ConnectService

(

void

)

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

taf_flash_TryConnectService()

le_result_t taf_flash_TryConnectService

(

void

)

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

SessionCloseHandler()

static void SessionCloseHandler ( le_msg_SessionRef_t  sessionRef, void *  contextPtr  )

static

taf_flash_SetServerDisconnectHandler()

void taf_flash_SetServerDisconnectHandler	(	taf_flash_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

NonExitSessionCloseHandler()

static void NonExitSessionCloseHandler ( le_msg_SessionRef_t  sessionRef, void *  contextPtr  )

static

taf_flash_SetNonExitServerDisconnectHandler()

void taf_flash_SetNonExitServerDisconnectHandler	(	taf_flash_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

taf_flash_DisconnectService()

void taf_flash_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

taf_flash_Init()

void taf_flash_Init

(

void

)

Initiates flash access reference map and memory pool.

Note

This function should be called once before calling other flash access APIs.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

taf_flash_MtdOpen()

le_result_t taf_flash_MtdOpen	(	const char *LE_NONNULL	partitionName,
		taf_flash_OpenMode_t	mode,
		taf_flash_PartitionRef_t *	partitionRefPtr
	)

Opens an MTD partition for read and write.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionName	MTD partition name.
[in]	mode	Opening mode.
[out]	partitionRefPtr	The MTD partition reference.

taf_flash_MtdClose()

le_result_t taf_flash_MtdClose

(

taf_flash_PartitionRef_t

partitionRef

)

Closes an MTD partition.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]

partitionRef

The MTD partition reference.

taf_flash_MtdInformation()

le_result_t taf_flash_MtdInformation	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t *	blocksNumberPtr,
		uint32_t *	badBlocksNumberPtr,
		uint32_t *	blockSizePtr,
		uint32_t *	pageSizePtr
	)

Gets an information about the given MTD partition.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[out]	blocksNumberPtr	Total blocks number.
[out]	badBlocksNumberPtr	Bad blocks number.
[out]	blockSizePtr	Block size.
[out]	pageSizePtr	Page size.

taf_flash_MtdEraseBlock()

le_result_t taf_flash_MtdEraseBlock	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	blockIndex
	)

Erases an MTD block.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	blockIndex	Logical block index.

taf_flash_MtdReadPage()

le_result_t taf_flash_MtdReadPage	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	pageIndex,
		uint8_t *	readDataPtr,
		size_t *	readDataSizePtr
	)

Reads an MTD page.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	pageIndex	Page index.
[out]	readDataPtr	Buffer read from the MTD page.
[in,out]	readDataSizePtr

taf_flash_MtdWritePage()

le_result_t taf_flash_MtdWritePage	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	pageIndex,
		const uint8_t *	writeDataPtr,
		size_t	writeDataSize
	)

Writes MTD page.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	pageIndex	Page index.
[in]	writeDataPtr	Buffer to be written to the MTD block.
[in]	writeDataSize

taf_flash_MtdRead()

le_result_t taf_flash_MtdRead	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	offset,
		uint8_t *	readDataPtr,
		size_t *	readDataSizePtr
	)

Reads an MTD partition.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	offset	The MTD partition offset.
[out]	readDataPtr	Buffer read from the MTD page.
[in,out]	readDataSizePtr

taf_flash_MtdWrite()

le_result_t taf_flash_MtdWrite	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	offset,
		const uint8_t *	writeDataPtr,
		size_t	writeDataSize
	)

Writes MTD partition.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	offset	The MTD partition offset.
[in]	writeDataPtr	Buffer to be written to the MTD block.
[in]	writeDataSize

taf_flash_MtdErase()

le_result_t taf_flash_MtdErase

(

taf_flash_PartitionRef_t

partitionRef

)

Erases MTD partition.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]

partitionRef

The MTD partition reference.

taf_flash_MtdIsBlockGood()

bool taf_flash_MtdIsBlockGood	(	taf_flash_PartitionRef_t	partitionRef,
		uint32_t	blockIndex
	)

Checks if an MTD block is good.

Returns

• true – Good block.
• false – Bad block.

Parameters

[in]	partitionRef	The MTD partition reference.
[in]	blockIndex	Logical block index.

taf_flash_UbiOpen()

le_result_t taf_flash_UbiOpen	(	const char *LE_NONNULL	volumeName,
		taf_flash_OpenMode_t	mode,
		taf_flash_VolumeRef_t *	volumeRefPtr
	)

Opens UBI volume for read and write.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	volumeName	UBI volume name.
[in]	mode	Opening mode.
[out]	volumeRefPtr	The UBI volume reference.

taf_flash_UbiClose()

le_result_t taf_flash_UbiClose

(

taf_flash_VolumeRef_t

volumeRef

)

Closes UBI volume.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]

volumeRef

The UBI volume reference.

taf_flash_UbiInformation()

le_result_t taf_flash_UbiInformation	(	taf_flash_VolumeRef_t	volumeRef,
		uint32_t *	lebNumberPtr,
		uint32_t *	freeLebNumberPtr,
		uint32_t *	volumeSizePtr
	)

Gets UBI volume information.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	volumeRef	The UBI volume reference.
[out]	lebNumberPtr	Total logical erase blocks number.
[out]	freeLebNumberPtr	Free logical erase blocks number.
[out]	volumeSizePtr	Volume size.

taf_flash_UbiRead()

le_result_t taf_flash_UbiRead	(	taf_flash_VolumeRef_t	volumeRef,
		uint32_t	offset,
		uint8_t *	readDataPtr,
		size_t *	readDataSizePtr
	)

Reads UBI volume.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	volumeRef	The UBI volume reference.
[in]	offset	The UBI volume offset.
[out]	readDataPtr	Buffer read from UBI volume.
[in,out]	readDataSizePtr

taf_flash_UbiInitWrite()

le_result_t taf_flash_UbiInitWrite	(	taf_flash_VolumeRef_t	volumeRef,
		int64_t	writeBytes
	)

Initiates write size of UBI volume.

Note

Users should set the number of bytes before subsequent write operations.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	volumeRef	The UBI volume reference.
[in]	writeBytes	The number of bytes set to write to UBI volume.

taf_flash_UbiWrite()

le_result_t taf_flash_UbiWrite	(	taf_flash_VolumeRef_t	volumeRef,
		const uint8_t *	writeDataPtr,
		size_t	writeDataSize
	)

Writes data to UBI volume.

Note

Users should keep the context of writing UBI volume.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]	volumeRef	The UBI volume reference.
[in]	writeDataPtr	Buffer to be written to UBI volume.
[in]	writeDataSize

Variable Documentation

_ClientThreadDataPool

le_mem_PoolRef_t _ClientThreadDataPool

static

The memory pool for client thread objects

_ThreadDataKey

pthread_key_t _ThreadDataKey

static

Key under which the pointer to the Thread Object (_ClientThreadData_t) will be kept in thread-local storage. This allows a thread to quickly get a pointer to its own Thread Object.

CommonDataInitialized

bool CommonDataInitialized = false

static

This global flag is shared by all client threads, and is used to indicate whether the common data has been initialized.

Warning

Use InitMutex, defined below, to protect accesses to this data.

le_ifgen_InitMutexRef

le_mutex_Ref_t le_ifgen_InitMutexRef

Mutex and associated macros for use with the above CommonDataInitialized.