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_StartClient (const char *serviceInstanceName)
void	le_fwupdate_StopClient (void)
le_result_t	le_fwupdate_GetFirmwareVersion (char *version, size_t versionNumElements)
le_result_t	le_fwupdate_GetBootloaderVersion (char *version, size_t versionNumElements)
le_result_t	le_fwupdate_Download (int fd)

Detailed Description

Legato Modem Firmware Update include file.

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

Macro Definition Documentation

#define LE_FWUPDATE_MAX_VERS_LEN   256

Maximum length of a version string

Function Documentation

le_result_t le_fwupdate_Download

(

int

fd

)

Download the firmware image file to the modem.

Returns

• LE_OK on success
• LE_NOT_POSSIBLE 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_NOT_POSSIBLE 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_NOT_POSSIBLE for any other errors

Parameters

[out]	version	Firmware version string
[in]	versionNumElements

void le_fwupdate_StartClient

(

const char *

serviceInstanceName

)

Start the service for the client main thread

Parameters

[in]

serviceInstanceName

void le_fwupdate_StopClient

(

void

)

Stop the service for the current client thread