LMS API Documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
Version and update functions

Data Structures

struct  lms_dev_info_t
 

Typedefs

typedef bool(* lms_prog_callback_t )(int bsent, int btotal, const char *progressMsg)
 

Enumerations

enum  lms_prog_md_t { LMS_PROG_MD_RAM = 0, LMS_PROG_MD_FLASH = 1, LMS_PROG_MD_RST = 2 }
 
enum  lms_prog_trg_t { LMS_PROG_TRG_FX3 = 0, LMS_PROG_TRG_FPGA, LMS_PROG_TRG_MCU, LMS_PROG_TRG_HPM7 }
 

Functions

API_EXPORT int CALL_CONV LMS_Program (lms_device_t *device, const char *data, size_t size, lms_prog_trg_t target, lms_prog_md_t mode, lms_prog_callback_t callback)
 
API_EXPORT int CALL_CONV LMS_ProgramUpdate (lms_device_t *dev, bool download, lms_prog_callback_t callback)
 
API_EXPORT const
lms_dev_info_t *CALL_CONV 
LMS_GetDeviceInfo (lms_device_t *device)
 
API_EXPORT const char * LMS_GetLibraryVersion ()
 Returns API library version.
 
API_EXPORT const char *CALL_CONV LMS_GetLastErrorMessage (void)
 

Detailed Description

The functions in this section provides ability to check device version and perform updates

Typedef Documentation

typedef bool(* lms_prog_callback_t)(int bsent, int btotal, const char *progressMsg)

Callback from programming processes

Parameters
bsentnumber of bytes transferred
btotaltotal number of bytes to send
progressMsgstring describing current progress state
Returns
0-continue programming, 1-abort operation

Definition at line 1213 of file LimeSuite.h.

Enumeration Type Documentation

Enumeration of programming mode

Enumerator
LMS_PROG_MD_RAM 

load firmware/bitstream to volatile storage

LMS_PROG_MD_FLASH 

load firmware/bitstream to non-volatile storage

LMS_PROG_MD_RST 

reset and boot from flash

Definition at line 1190 of file LimeSuite.h.

Enumeration of programmable board modules

Enumerator
LMS_PROG_TRG_FX3 

program FX3 firmware

LMS_PROG_TRG_FPGA 

program FPGA gateware

LMS_PROG_TRG_MCU 

program LMS7 MCU firmware

Definition at line 1198 of file LimeSuite.h.

Function Documentation

API_EXPORT const lms_dev_info_t* CALL_CONV LMS_GetDeviceInfo ( lms_device_t device)

Get device serial number and version information

Note
This function returns pointer to internal data structure that gets deallocated when device is closed. Do not attempt to read from it after closing the device. If you need to keep using device info returned by this function after closing the device, make a copy before closing the device.
Parameters
deviceDevice handle previously obtained by LMS_Open().
Returns
pointer to device info structure lms_dev_info_t
API_EXPORT const char* CALL_CONV LMS_GetLastErrorMessage ( void  )

Get the error message detailing why the last error occurred.

Returns
last error message.
API_EXPORT int CALL_CONV LMS_Program ( lms_device_t device,
const char *  data,
size_t  size,
lms_prog_trg_t  target,
lms_prog_md_t  mode,
lms_prog_callback_t  callback 
)

Write binary firmware/bitsteam image to specified device component.

Parameters
deviceDevice handle previously obtained by LMS_Open().
dataPointer to memory containing firmware/bitsteam image
sizeSize of firmware/bitsteam image in bytes.
targetdevice component to program lms_prog_trg_t
modeprogramming mode lms_prog_md_t
callbackcallback function for monitoring progress
Returns
0 on success, (-1) on failure
API_EXPORT int CALL_CONV LMS_ProgramUpdate ( lms_device_t dev,
bool  download,
lms_prog_callback_t  callback 
)

Automatically update device firmware

Parameters
devDevice handle previously obtained by LMS_Open().
downloadTrue to download missing images from the web.
callbackcallback function for monitoring progress
Returns
0 on success, (-1) on failure