Macros | Functions

le_fwupdate_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros

#define LE_FWUPDATE_MAX_VERS_LEN   256
 

Functions

void le_fwupdate_ConnectService (void)
 
le_result_t le_fwupdate_TryConnectService (void)
 
void le_fwupdate_DisconnectService (void)
 
le_result_t le_fwupdate_Download (int fd)
 
le_result_t le_fwupdate_GetFirmwareVersion (char *version, size_t versionNumElements)
 
le_result_t le_fwupdate_GetBootloaderVersion (char *version, size_t versionNumElements)
 

Detailed Description

Legato Modem Firmware Update include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Macro Definition Documentation

#define LE_FWUPDATE_MAX_VERS_LEN   256

Maximum length of a version string, excluding any termination character.

Function Documentation

void le_fwupdate_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_fwupdate_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.

le_result_t le_fwupdate_Download ( int  fd)

Download the firmware image file.

Returns
  • LE_OK on success
  • LE_BAD_PARAMETER if an input parameter is not valid
  • LE_FAULT on failure
Note
The process exits, if an invalid file descriptor (e.g. negative) is given.
Parameters
[in]fdFile descriptor of the image, opened to the start of the image.
le_result_t le_fwupdate_GetBootloaderVersion ( char *  version,
size_t  versionNumElements 
)

Get the bootloader version string

Returns
  • LE_OK on success
  • LE_NOT_FOUND if the version string is not available
  • LE_OVERFLOW if version string to big to fit in provided buffer
  • LE_FAULT for any other errors
Parameters
[out]versionBootloader version string
[in]versionNumElements
le_result_t le_fwupdate_GetFirmwareVersion ( char *  version,
size_t  versionNumElements 
)

Get the firmware version string

Returns
  • LE_OK on success
  • LE_NOT_FOUND if the version string is not available
  • LE_OVERFLOW if version string to big to fit in provided buffer
  • LE_FAULT for any other errors
Parameters
[out]versionFirmware version string
[in]versionNumElements
le_result_t le_fwupdate_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.