[MG245X] OTA(Over The Air) Programmer User s Guide. (No. ADT0106) V1.3

Transcription

1 [MG245X] OTA(Over The Air) Programmer User s Guide (No. ADT0106) V1.3

2 REVISION HISTORY Version Date Description VER First Version VER VER VER Section 3.1 -Device Programmer V3.50=>V3.52 update. Section 3.1 -Device Programmer V3.52=>V3.60 update. Section 4 -CAUTION about size error message is deleted. -Ethernet content is deleted. Section 3, 5 - Add contents about EVK Section 4~6 - Update to Device Programmer MD. Section 9 added. V1.3 Page:2/35

3 CONTENTS 1. INTRODUCTION DEFINITION OTA(OVER-THE-AIR) DEVICE PROGRAMMING OF ZDK OTA FUNCTION PROCEDURE HARDWARE INTERFACE OTA OPERATION PROCEDURE OTA(OVER-THE-AIR) DEVICE PROGRAMMING OF EVK OTA OPERATION PROCEDURE HARDWARE INTERFACE OTA OPERATION PROCEDURE INSTALL DEVICE-PROGRAMMER MD AND USB DRIVER DOWNLOAD THE FIRMWARE USE DEVICE-PROGRAMMER MD CONNECT TO PC MANAGEMENT OF INSTALLER DEVICE MANAGEMENT OF TARGET DEVICE OTA DOWNLOAD OPERATION INFORMATION OTA SERVER DEVELOPMENT V1.3 Page:3/35

4 1. INTRODUCTION This document explains how to use OTA function with MG245X(MG2455/MG2450) by Device Programmer MD, which is win32 application program of RadioPulse DEFINITION INSTALLER: Host System which has the firmware to download. TARGET: The device to be changed by new firmware. MG2455-F48: ZigBee2006, ZigBeePRO and IEEE compliant single chip solution developed by RadioPulse.(22GPIO, QFN Type) LM2455-EM: ZigBee2006, ZigBeePRO and IEEE compliant 2.4GHz ZigBee Module for evaluation with MG2455-F48 chip. MG2450-B72: ZigBee2006, ZigBeePRO and IEEE compliant single chip solution developed by RadioPulse.(24GPIO, BGA Type) LM2450-EM: ZigBee2006, ZigBeePRO and IEEE compliant 2.4GHz ZigBee Module for evaluation with MG2450-B72 chip. MG245X-EVB: A PC interface board of LM2455-EM and LM2450-EM. This board makes it possible to download user programs to LM2455-EM/LM2450-EM or connect to host programs in PC system. V1.3 Page:4/35

5 2. OTA(Over-The-Air) Device Programming of ZDK 2.1. OTA Function Procedure OTA function is operated as follows; 1 INSTALLER device sends the data to TARGET device by 64-bit IEEE address. 2 When TARGET device receives the data, the data is written to External Serial FLASH memory. 3 INSTALLER device checks data integrity(crc), which is written in External Serial FLASH memory. 4 When data integrity(crc) is checked, INSTALLER device sends RESET command. 5 When TARGET device receive RESET command, the data written in External Serial FLASH memory is copied to Internal FLASH memory and then re-boot Hardware Interface HOST SYSTEM (PC) MG245x Wireless Link MG245x Firmware Image File [Installer Device].H00.H01.H03 Internal Flash Flash Memory(96KB) Memory [Target Device] External Serial FLASH AT25FS010N (128KB) V1.3 Page:5/35

6 2.3. OTA Operation Procedure Installer TARGET PING-REQUEST PING-RESPONSE ERASE-REQUEST ERASE-RESPONSE Erase External Flash CROM-WRIT Write to External Flash CRC-REQUEST CRC-RESPONSE Compare CRC RESET-REQUEST RESET-RESPONSE Copy External Flash to Internal Flash and then,reboot 1 INSTALLER configures the RF channel. 2 INSTALLER sends PING with IEEE address to search. 3 TARGET responses when received IEEE address equals to its address. 4 If no response, INSTALLER changes its RF channel and do search operation until success. 5 INSTALLER sends ERASE COMMAND to erase external flash of remote device. 6 INSTALLER sends code-image to TARGET device. 7 INSTALLER sends CRC REQUEST to read CRC value of TARGET device. 8 If CRC equal, INSTALLER sends RESET. 9 TARGET device copies external flash image to internal flash memory. 10 TARGET device restarts. V1.3 Page:6/35

7 3. OTA(Over-The-Air) Device Programming of EVK 3.1. OTA Operation Procedure OTA function is worked as follows; 1 INSTALLER device sends data to TARGET device with 64-bit IEEE address. 2 When TARGET device receives the data, it writes the data to Internal FLASH memory(0x8400~0xffff). 3 INSTALLER device checks the data integrity(crc) for the data, which is written in Internal FLASH memory(0x8400~0xffff). 4 When the data integrity(crc) is checked, INSTALLER device sends RESET command. 5 When TARGET device receives RESET command, copy the data written in defined area(0x8400~0x7bff) of internal flash memory into the other area(0x0000~0x7bff) of internal flash memory and then re-boot Hardware Interface HOST SYSTEM (PC) MG245x Wireless Link MG245x 31KByte Firmware Image File xx.h00.h00.h01.h03 Internal Flash Memory.H00 31KByte [Installer Device] [Target Device] V1.3 Page:7/35

8 3.3. OTA Operation Procedure Installer Target PING-REQUEST PING-RESPONSE ERASE-REQUEST ERASE-RESPONSE Erase Internal Flash Area (0x8400~0xFFFF) CROM-WRIT Write to Internal Flash Area (0x8400~0xFFFF) CRC-REQUEST CRC-RESPONSE Compare CRC RESET-REQUEST RESET-RESPONSE Copy Internal Flash Area to Internal Flash Another Area (0x8400~0xFFFF) (0x0000~0x7BFF) and then, Reboot 1 INSTALLER configures the RF channel. 2 INSTALLER sends PING with IEEE address to search. 3 TARGET responses when received IEEE address equals to its address. 4 If no response, INSTALLER changes its RF channel and do search operation until success. 5 INSTALLER sends ERASE COMMAND to erase internal flash some area of remote device. 6 INSTALLER sends code-image to TARGET device. 7 INSTALLER sends CRC REQUEST to read CRC value of TARGET device. 8 If CRC equal, INSTALLER sends RESET. 9 TARGET device copies internal flash image to another area of internal flash. 10 TARGET device restarts. V1.3 Page:8/35

9 Note - OTA is implemented by 64-bit IEE addressing mode and IEEE MAC DATA PACKET FORMAT(Uses reserved field of frame-control field in IEEE frame) 4. INSTALL DEVICE-PROGRAMMER MD and USB DRIVER Please refer to Sec 3.1 in Device-Programmer MD User s Guide. V1.3 Page:9/35

10 5. DOWNLOAD FIRMWARE In order to use OTA function, first you need to download corresponding firmware to two LM2455-EM or LM2450-EM with MG245X-EVB respectively. 1 Please connect USB1(Uart1) on MG245X-EVB with LM2455-EM or LM2450-EM to PC by a USB cable. 2 Please set the switches on MG245X-EVB as shown below. You can use Power in two ways. One is to set Power switch(sw1) to USB mode as shown in [Figure 1]. The other is to set SW12 switch to BAT_ON after inserting battery to battery holder at the bottom of MG245X-EVB as shown in [Figure 2]. - Power Switch(SW1) Figure 1.Power Switch - 3V Battery Switch(SW12) Figure 2. Battery Power Switch - ISP Switch(SW3) Set ISP Switch(SW3) to ISP mode as shown in [Figure 3]. V1.3 Page:10/35

11 Figure 3. ISP Switch - ISP Select(SW10) Switch As shown in [Figure 4], set ISP Select switch(sw10) to Local ISP mode. Figure 4. ISP Select Switch The following explains ISP Select Switch(SW10). * means that it is set by default when you buy MG245X-EVB. In this case, the default is 1-2 Local ISP and the * of 2-3 Ethernet ISP is printed wrongly. - Dip Switch(J4) As shown in [Figure 5], Set 5 and 7 switch to ON. Figure 5. Dip Switch The following explains Dip Switch(J4). * means that it is set by default when you buy MG245X-EVB. V1.3 Page:11/35

12 Important: When downloading firmware, USB1(UART1) port should be used. Do NOT use DSUB9 or USB0(UART0) port for downloading firmware. 3 Start Device-Programmer MD. 4 Select Direct-Download mode in Device-Programmer MD menu. V1.3 Page:12/35

13 5 Select chip type as MG2450/ Select USB Port type to USB to Serial Port(CP210X) and click replace ( ). The Device List connected to PC is checked as below. V1.3 Page:13/35

14 IMPORTANT: When downloading firmware, the USB port on PCIB shall be used. If serial port is used, downloading does NOT work. 7 Select Bank ON and Bank 0 in Device-Programmer MD. Then, click File open( ) button. For ZDK, select ZigBeePRO_DK_HCI.H00 in 3. ZDK Software Library \ ZigBeePRO_V2X_Library \ HEX folder and click Open button. For EVK, select MG245X-EVK_OTA_INSTALLER_V1X.H00 in MG245X- EVK_V2.X(MG245X-EVK_Source)\OTA_INSTALLER folder and click Open button. 8 For ZDK, when clicking Open button after selecting ZigBeePRO_DK_HCI.H00, ZigBeeXXX_DK_HCI.H01 for Bank 1 and ZigBeeXXX_DK_HCI.H03 for Bank3 are V1.3 Page:14/35

15 automatically selected as shown below. For EVK, click Open button after selecting MG245X- EVK_OTA_INSTALLER_V1X.H00. MG245X-EVK_OTA_INSTALLER_V1X.H01 for Bank1 and MG245X-EVK_OTA_INSTALLER_V1X.H03 for Bank3 are automatically selected. If the MG245X-EVK_OTA_INSTALLER_V1X.H03 to download to Bank3 is over 1000Byte, the Error message below is shown. V1.3 Page:15/35

16 Error Message 9 As shown in the figure below, when selecting Program Hex Code in Operation and Overwrite with hardware information in Modem Configuration Type, Hardware Information window is displayed. Here please set IEEE Address to and set the desired RF Channel. Now, we will select Channel After setting above, click start icon( ) and start downloading firmware. 11 If the downloaded MG245X is set by Code Protection, the warning message below is shown; V1.3 Page:16/35

17 In this case, the FLASH shall be initialized. To proceed downloading, click OK button. When the FLASH is initialized, the message below is shown; To complete FLASH initialization successfully, reset the hardware. Reset the hardware directly by pressing reset button on the MG245X-EVB to release Code Protection function of MG245X. Click OK button after completing hardware reset. 12 When the firmware is downloaded successfully, the success message below is displayed. When the firmware is downloaded to LM2455-EM/LM2450-EM through Step 1~12 above, download firmware of Target Device to another MG245X-EVB with LM2455-EM/LM2450-EM. In this case, follow Step 1~12 above except for Step and. In Step, for ZDK, select ZigBeePRO_DK_HCI.H00, ZigBeePRO_DK_HCI.H01, and ZigBeePRO_DK_HCI.H03. For EVK, select MG245X-EVK_V2X_OTA_TARGET.H00. In Step, set IEEE Address as and set the desired RF channel to Channel 11. V1.3 Page:17/35

18 Now, firmware of Installer Device and Target Device are downloaded to two MG245X-EVBs with LM2455-EM/LM2450-EM. Let s go over how to download the firmware by OTA function in Section 6. V1.3 Page:18/35

19 6. USE DEVICE-PROGRAMMER MD The [Figure 6] below is the initial screen of Device-Programmer MD. Figure 6. Initial Screen of Device-Programmer MD [Table 1] below explains basic menu of Device-Programmer MD. Table 1. Basic Menu of Device-Programmer Tool Bar Menu Description Download Mode Select Download mode Chip Type Select Chip type Port Type Select Serial Port Type connected with PCIB V1.3 Page:19/35

20 Check Check whether the PCIB operates normally. HexEditor Start Hex Editor About Information of Device-Programmer MD Select OTA-Download and MG2450/2455 when OTA downloading to MG245X by Device-Programmer MD as shown below; 6.1 Connect to PC 1 Start Device-Programmer MD. 2 Connect a device downloaded with firmware supporting Installer Device(MG245X-EVB with LM2455-EM/LM2450-EM) of OTA to PC by USB cable after starting Device-Programmer MD. 3 Select OTA-Download and MG2450/2455 on the menu bar. 4 When clicking Connect button( ), communication setting window is shown below. Select RS232(Serial) communication based on connection between PC and Device(MG245X- EVB with LM2455-EM/LM2450-EM) in the window. After selecting RS232(Serial), COM port, Baud Rate, Data Bit, and Parity Bit can be selected. V1.3 Page:20/35

21 Followings are parameter setting values for communication of Device-Programmer MD; RS232 (Serial) MG245X-EVB board and PC program are connected by RS232. Port Type: Select COM port type on current MG245X-EVB board. - All Serial Port : All COM Port connected to PC - USB to Serial Port (CP210X) : COM Port in type of CP210X USB chip Port: Select port of USB cable connected with current MG245B-EVB board and PC. Rate: 115,200 bps Data: 8-bit Parity: None Stop: 1- bit V1.3 Page:21/35

22 IMPORTANT: To connect MG245X-EVB to PC by USB cable, the SW1 on EVB shall be USB location. To connect it by RS-232 cable, the SW1 shall be EXT. NOTE: When using RS-232 cable to connect to PC, the external power of 5V, 2A. If the USB cable is used, the USB power is used so the external power is NOT needed. 6.2 Management of Installer Device Device Programmer MD can read and change IEEE Address, RF Channel, and Transmit Power of Installer Device. ICON FUNCTION DESCRIPTION IEEE Address IEEE Address of Installer Device RF Channel RF Channel on which Installer Device operates. Transmit Power Transmit Power of Installer Device. Transmit Power can be set from STEP 0 to STEP 7 and the STEP 0 means the highest Transmit Check IEEE Address, RF Channel, and Transmit Power Change RF Channel and Transmit Power 6.3 Management of Target Device Power. Check IEEE Address and RF channel on which the Installer Device currently works. Change RF Channel and Transmit Power of Installer Device. ICON FUNCTION DESCRIPTION Destination Address Destination Address of Target Device Search Search Target Device Loop-Back Loop-Back test of Target Device V1.3 Page:22/35

23 Search Input IEEE Address of Device to search in Destination Address. If a user input Destination Address as FF FF FF FF FF FF FF FF, all Device currently operating can be searched. When Search button( ) is clicked after Destination Address is inputted, the Ping window below is opened. Click Ping button and search actual Device. Search Device operating on same channel with Installer Device. After completing Device search, a user can input the searched Device in Destination Address. Select certain Device and double-click on it, the Address of the Device is automatically inputted in Destination Address. V1.3 Page:23/35

24 Loop-Back When loop back button( opened. ) is clicked, the Loop-Back window is Input IEEE Address of Device to loop back test in Destination Address of main window. Input the pattern to execute Loop-back test and click Loop-back button. When the Loop-back test is completed for the device, the result can be checked in Status Text window. If the Loop-back test is succeeded, the equal pattern to transmitted pattern is returned. V1.3 Page:24/35

25 V1.3 Page:25/35

26 7. OTA DOWNLOAD As shown in Section 5, after downloading firmware to two devices(lm2455-em or LM2450- EM with MG245X-EVB), make them operate as Installer Device and Target Device respectively. In other words, connect Installer Device(IEEE Address: 1) to Device Programmer MD. In Device Programmer MD, download firmware to another Target Device(IEEE Address: 2) by OTA function. 1 Set ISP Switch (SW3) on two MG245X-EVBs to Normal mode and then press Reset button on two MG245X-EVBs to operate those devices normally. 2 Please open Device-Programmer MD. Select OTA-Download and MG2450/2455. After that, connect Installer Device(LM2455-EM or LM2450-EM with MG245X-EVB, IEEE Address: 1), which will send the firmware, to Device Programmer MD by clicking Connect button( Sec 6.1 in this document. ). For the setting of port and parameter, refer to 3 Set RF channel of Installer Device and Target Device equally. The Installer Device can ONLY update the device within current RF Channel by OTA function. Please set same channel with Target Device to be downloaded by OTA function with the function( value and the function( transmit power value. ),which reads channel of Installer device and the transmit power ), which changes channel of Installer device and the 4 Input IEEE Address of Target Device in Destination Address. A user can search Destination Address of Target Device with Search( to Sec 6.3 for details. ) function. Please refer 5 Select firmware file to download to Target Device. Select Bank ON and Bank 0 and select ZigBeePRO_DK_HCI.H00 in 3. ZDK Software Library \ ZigBeePRO_V2X_Library \ HEX folder in the CD by clicking. The hex files relating to Bank 1 and Bank 3 are automatically selected. In this way, select the firmware to download. In EVK, select MG245X-EVK_V2X_OTA_TARGET.H00 in Source folder. V1.3 Page:26/35

27 6 Select Download in Operation relating to controlling to Target Device. For detailed setting such as Recovery, refer to Sec 8. 7 Select one in Modem Configuration Type below for Hardware Information setting. Modem Configuration Type Overwrite with hardware information When you want to update the hardware information of Target Device unlike existing setting, you can use this function. Select Overwrite with hardware information on Modem Configuration Type. After that, please select the desired value on the Hardware Information window. In this case, if you change IEEE Address and Channel unlike existing values, you have to set Destination Address and RF Channel to changed values when OTA download. Retain hardware information in FLASH memory This is used when you want to use the hardware information of the Target Device same, which is updated by firmware. Select Retain hardware information in FLASH memory on Modem Configuration Type part of Device Programmer. In this case, IEEE address and channel keeps same as previous one, so set to same Destination Address and Channel value when OTA-Download later. Not including hardware information This is used when you don t want to set the hardware Information of the Target Device, which is updated by firmware. Please select this function when ONLY hardware Information on the firmware to be updated is not supported. V1.3 Page:27/35

28 Hardware Information Setting window For details of Hardware Information, please refer to Sec in Device- Programmer MD User s Guide. 8 When pressing start button( Next button. ), OTA-Wizard window below is displayed. Press V1.3 Page:28/35

29 9 Please press Next button in the window below. 10 Download firmware by OTA function as shown below. 11 When the firmware is downloaded successfully, the following window will be displayed. V1.3 Page:29/35

30 12 Finally, select Remote Re-boot button in Operation and press start button( ). 13 Remote Re-Boot window below is started. For ZDK, re-boot Target Device by clicking OK button after selecting Re-boot External Flash. For EVK, select Re-boot Internal Flash and click OK button. The internal FLASH of Target Device is re-booted. V1.3 Page:30/35

31 14 Success Message window is displayed. Firmware is successfully updated to Target Device by OTA function. V1.3 Page:31/35

32 8. OPERATION INFORMATION Device-Programmer MD provides several commands about OTA download function for target device. All commands perform for DestAddr. All operation is executed based on IEEE Address in Destination Address among Target Device Information. When Start button( ) is pressed after selecting desired function in Operation Section, the selected function is executed to Target Device. 1 Download Download firmware of Target Device. After downloading, if a user wants to apply it, Re-boot External Flash of Remote Re-boot is executed. 2 Recovery When you click this button, it returns to data before performing Re-boot External Flash after erasing or completing update. 3 Erase Initialize entire Target Device. When you adjust it after erasing, perform Re-boot External Flash of Remote Re-boot. V1.3 Page:32/35

33 4 Remote Re-boot Re-boot external or internal flash of target device. 5 Read CRC When you click this button, it can read CRC of current ROM of Target Device. V1.3 Page:33/35

34 9. OTA SERVER DEVELOPMENT Device-Programmer MD operates as OTA server by connecting with OTA Installer in OTA- Download mode. To implement OTA server, please refer to OTA Server Implementation document. OTA Server (Device Programmer MD) UART OTA Installer Device RF Remote Target Device V1.3 Page:34/35

35 RadioPulse Inc 3rd Fl., Hans B/D II, Seongnae-Dong, Gangdong-Gu, Seoul, Korea, , Korea URL: Tel: ~5 Fax: About RadioPulse Inc. RadioPulse is a Being Wireless solution provider offering wireless communication & network technologies and developing next generation wireless networking technologies. The new wireless networking solutions envisioned by RadioPulse will enable user to enjoy wireless technologies with easy interface. Founded in April of 2003, the company maintains it headquarters and R&D center in Seoul, Korea. Copyright (c) 2011 RadioPulse. All rights reserved. V1.3 Page:35/35