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)
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.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. 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]

fd

File 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]	version	Bootloader 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]	version	Firmware version string
[in]	versionNumElements