Macros | Typedefs | Functions

le_flash_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros

#define LE_FLASH_IMAGE_NAME_MAX_LEN   32
 
#define LE_FLASH_IMAGE_NAME_MAX_BYTES   33
 

Typedefs

typedef void(* le_flash_DisconnectHandler_t) (void *)
 
typedef struct le_flash_BadImageDetectionHandler * le_flash_BadImageDetectionHandlerRef_t
 
typedef void(* le_flash_BadImageDetectionHandlerFunc_t) (const char *LE_NONNULL imageName, void *contextPtr)
 

Functions

void le_flash_ConnectService (void)
 
le_result_t le_flash_TryConnectService (void)
 
void le_flash_SetServerDisconnectHandler (le_flash_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_flash_DisconnectService (void)
 
le_flash_BadImageDetectionHandlerRef_t le_flash_AddBadImageDetectionHandler (le_flash_BadImageDetectionHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_flash_RemoveBadImageDetectionHandler (le_flash_BadImageDetectionHandlerRef_t handlerRef)
 

Detailed Description

Legato Flash API include file.

Copyright (C) Sierra Wireless Inc.

Macro Definition Documentation

#define LE_FLASH_IMAGE_NAME_MAX_BYTES   33

Image length maximum length. One extra byte is added for the null character.

#define LE_FLASH_IMAGE_NAME_MAX_LEN   32

Image length maximum length.

Typedef Documentation

typedef void(* le_flash_BadImageDetectionHandlerFunc_t) (const char *LE_NONNULL imageName,void *contextPtr)

Handler for bad image detection.

Note
The image names are platform dependent.
typedef struct le_flash_BadImageDetectionHandler* le_flash_BadImageDetectionHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_flash_BadImageDetection'

typedef void(* le_flash_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

le_flash_BadImageDetectionHandlerRef_t le_flash_AddBadImageDetectionHandler ( le_flash_BadImageDetectionHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_flash_BadImageDetection'

This event provides information on bad image status.

Parameters
[in]handlerPtr
[in]contextPtr
void le_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 Client-specific Functions.

This function is created automatically.

void le_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 Client-specific Functions.

This function is created automatically.

void le_flash_RemoveBadImageDetectionHandler ( le_flash_BadImageDetectionHandlerRef_t  handlerRef)

Remove handler function for EVENT 'le_flash_BadImageDetection'

Parameters
[in]handlerRef
void le_flash_SetServerDisconnectHandler ( le_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.

le_result_t le_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 Client-specific Functions.

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.