Technical Reference Manual. E1022 Firmware Download Protocol

Transcription

1 Technical Reference Manual E1022 Firmware Download Protocol

2 Manual change record This page records the modifications made to this manual. This manual was originally released as preliminary version 1.0. version date modifications draft NOV new template version (some format changes) - changed manual name to "E1022 Firmware Download Procedure" - added information in Chapter 2 to make document clearer - added CTS/RTS activation in flow chard (appendix A) revision level (preliminary version 1.1) ii E1022 Firmware Download Technical Reference Manual

3 Contents Contents 1 Preparing 2 Firmware for firmware download...1 Connections...2 download procedure...3 Download mode initialization...4 Hardware initialization...4 Software initialization using ISCP...4 Baud rate auto-detect...4 Dialog between host and scanner...5 Downloading the flash driver...5 Dialog between host and scanner A Typical B C D Using the firmware download commands...6 Firmware download command set...7 Flash driver commands...8 ACK_MODE...9 FLASH_INIT...10 REMOVE_DRIVER...11 FIRMWARE_VERSION...12 ERASE_ALL...13 READ_BLOCK...14 WRITE_BLOCK...15 WRITE_SAME_WORD...16 firmware download procedure...17 Checksum calculation...19 RTS/CTS hardware protocol...21 ACK software protocol...23 E1022 Firmware Download Technical Reference Manual iii

4

5 1 Preparing for firmware download This document explains the firmware download procedure and provides the information needed to create a firmware download application for your E1022 scanner. However before using the firmware download protocol, your scanner must have the correct connections. This chapter provides a diagram of the connections necessary to use the firmware download protocol to upgrade the firmware in your scanner. E1022 Firmware Download Technical Reference Manual 1

6 Chapter 1 Preparing for firmware download Connections To be able to upgrade the firmware in the E1022 you must design the host as shown in the following example and allow control of the level of lines 6 and 10 (RTS and CTS). E VCC RXD TRIGGER POWER ENABLE TXD RTS GND Detect In 1 LED CTS BUZZER Detect In HOST Connections in the host Note: If it is not possible to connect the RTS and CTS lines on the host side, these lines MUST be connected to each other on the scanner side. Certain signals behave differently according to whether you are in decoded operating mode or firmware download mode. The following table shows these differences: Contact Normal Operation Firmware Download 1 VCC VCC 2 RXD RXD 3 trigger input input not used 4 power enable power enable 5 TXD TXD 6 RTS RTS 7 GND GND 8 must be connected to buzzer must be connected to VCC 9 LED not used (high impedance) 10 CTS CTS 11 buzzer + must be connected to detect in 1 not used (high impedance) 12 must be connected to GND must be connected to VCC Note: For more details about connections and installing the E1022 scan engine, see the E1022 Integration Guide available on our website at 2 E1022 Firmware Download Technical Reference Manual

7 2 Firmware download procedure This chapter outlines the firmware download procedure: download mode initialization baud rate auto-detect downloading the flash driver using the firmware download commands E1022 Firmware Download Technical Reference Manual 3

8 Chapter 2 Firmware download procedure Download mode initialization Hardware initialization The first step in the firmware download procedure is to initialize download mode. Download mode is initialized by hardware or software (using the Intermec Scanner Control Protocol). Host hardware conditions required before power-up: Detect In 0 and Detect In 1 active (VCC) TXD line inactive (GND) At power-up (low level on power enable), the scanner detects the high levels on contacts Detect In 0 and Detect In 1 and enters firmware download mode. Note: To exit download mode, turn off the scanner, deactivate Detect In 0 and Detect In 1 and turn the scanner on. Software initialization using ISCP If you are using ISCP you can simply send the ISCP control command "flash memory upgrade" to initialize firmware download mode. See the ISCP Technical Reference Manual for more information (available on our website at (limited access) or contact your Intermec representative). Note: To exit download mode simply turn the scanner off then back on. Baud rate auto-detect Once the scanner is in firmware download mode, it waits for the autodetect character (0x00) from the host. When the scanner receives this character, it automatically detects the host's baud rate and adapts itself accordingly. The UART of the host must be configured with the following parameters: baud rate: 9600, 19200, bits no parity 4 E1022 Firmware Download Technical Reference Manual

9 Chapter 2 Firmware download procedure Dialog between host and scanner Downloading the flash driver /*host initiates baud rate auto-detection*/ host sends AUTO_DETECT (0x00) /*scanner detects host baud rate*/ scanner replies BAUD_RATE_DETECTED (0x54) /*scanner now ready to receive flash driver*/ The flash driver is the tool used to communicate between the scanner and the host. It combines the different firmware download functions necessary to erase, read from and write to the flash memory of the scanner. This driver must be downloaded to the RAM memory of the scanner. The host opens the flash driver file (*.DRX) and determines the number of words contained in the file (size of file / 2). The host calculates the number of blocks to send to the scanner by dividing the number of words in the file by 128. The host is now ready to initiate download. Note: The flash driver file ( *.DRX) is provided by Intermec. Contact your Intermec representative or check our website at Dialog between host and scanner /*host initiates download*/ host sends START_DOWNLOAD (0xAA) /*scanner requests number of blocks*/ scanner sends NB_BLOCKS_RQ (0x88) /*host calculates number of blocks*/ host sends NB_BLOCKS (0xNN) (1 byte) /*scanner requests blocks*/ BLOCK_NUM = 1 While (BLOCK_NUM < NB_BLOCKS + 1) { /*scanner requests block*/ scanner sends BLOCK_RQ (0x80) scanner sends BLOCK_NUM (0xNN) /*host reads 128 works of block in flash driver file*/ host sends 128 words of block to scanner /*scanner requests checksum of block*/ scanner sends CHK_RQ (0x7F) /*host calculates checksum of block*/ host sends HOST_CHK (2 words) E1022 Firmware Download Technical Reference Manual 5

10 Chapter 2 Firmware download procedure } /*increment block number if checksum OK*/ if (HOST_CHK = SE_CHK) {BLOCK_NUM ++} /*scanner indicates driver download OK scanner sends DRV_DOWNLOAD_OK (0xBB) /*flash driver ready to receive firmware download commands*/ When the scanner requests a block, it sends the host two bytes (BLOCK_RQ and BLOCK_NUM). The UART of the host must be able to receive these two bytes without a handshaking protocol (e.g. RTS/CTS hardware protocol). If the host is transmitting data, the inter-character delay must be less than one second. If the delay is too long, the scanner watchdog will automatically reinitialize the scanner. See Appendix A for the checksum calculation. Using the firmware download commands The firmware is downloaded to the scanner using the firmware download protocol. This protocol consists of a set of commands that are sent from the host to the scanner via the flash driver. The scanner uses RTS/CTS hardware protocol (see Appendix C) to send the commands from the flash driver to the host. We recommend using this protocol. However, if your system does not support RTS/CTS protocol, you must activate the ACK software protocol (see Appendix D). You can activate the ACK software protocol by sending the corresponding firmware download command (see chapter 3, Firmware download command set). Here are a few important points when sending commands: if the host is transmitting data, the inter-character delay must be less than one second because of the scanner watchdog timeout when a "word" (2 bytes) or a "long" (4 bytes) is transmitted, the most significant byte must be sent first the firmware file (*.RAW) is provided by Intermec (contact your Intermec representative) Note: There is no error management in the Firmware Download Protocol. 6 E1022 Firmware Download Technical Reference Manual

11 3 Firmware download command set This chapter provides the firmware download commands that are used by the flash driver to download the new firmware. E1022 Firmware Download Technical Reference Manual 7

12 Chapter 3 Firmware download command set Flash driver commands The different functions implemented in the flash driver and their associated commands are listed below. Command Op code Description ACK_MODE 0x10 activates the ACK software protocol FLASH_INIT 0x11 checks that the flash driver is able to read from, erase or write to the flash memory of the scanner REMOVE_DRIVER 0x12 removes the driver from the scanner FIRMWARE_VERSION 0x13 requests the version of the firmware present in the flash memory ERASE_ALL 0x14 erases the flash memory of the scanner READ_BLOCK 0x15 reads a block in the flash memory of the scanner WRITE_BLOCK 0x16 writes a block in the flash memory of the scanner WRITE_SAME_WORD 0x17 writes the same word in a block of the flash memory of the scanner Frame format: 16 bits 16 bits 16 bits 16 bits 16 bits 32 bits command parameter 1 parameter 2 parmeter 3 parameter 4 checksum 8 E1022 Firmware Download Technical Reference Manual

13 Chapter 3 Firmware download command set ACK_MODE Description Activates the ACK software protocol (see Appendix C) and deactivates the scanner's default RTS/CTS hardware protocol. ACK_MODE is mandatory for hosts that are not designed to support the RTS/CTS hardware protocol. This command must be sent before any other. If another command is sent, the flash driver will automatically activate the RTS/CTS protocol. Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0010 ACK_MODE <PARM 1> 16 bits 0x0000 must be zero <PARM 2> 16 bits 0x0000 must be zero <PARM 3> 16 bits 0x0000 must be zero <PARM 4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Flash driver response CMD_ACK (0x32) undefined OK then followed by: CMD_DONE (0x31) if command executed correctly OR undefined byte using ACK software protocol if execution of command fails (flash driver then waits for an acknowledge after transmission of this byte) transmission error, bad checksum or incorrect parameter E1022 Firmware Download Technical Reference Manual 9

14 Chapter 3 Firmware download command set FLASH_INIT Description Checks that the flash driver is able to read, erase and write in the flash memory installed in the scanner. FLASH_INIT must be sent before the following commands (mandatory): ERASE_ALL READ_BLOCK WRITE_BLOCK WRITE_SAME_WORD Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0011 FLASH_INIT <PARM 1> 16 bits 0x0000 must be zero <PARM 2> 16 bits 0x0000 must be zero <PARM 3> 16 bits 0x0000 must be zero <PARM 4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Flash driver response CMD_ACK (0x32) undefined OK transmission error, bad checksum or incorrect parameter Flash driver sends When the command has been successfully executed, the flash driver sends two words and a string in ASCII format terminated by the character "\0": <FLASH_SIZE> <DRIVER_VERSION> <FLASH_SIZE> 32 bits 0xN 2 words <DRIVER_VERSION> ASCII string most significant word then least significant word if FLASH_SIZE = 0x then flash memory not recognized by driver(*) 0xn max 30 characters + last character ("\0) Note: (*) When the flash memory is not recognized by the flash driver (0x ) another flash driver must be downloaded to the scanner. See REMOVE_DRIVER on the following page for more information. 10 E1022 Firmware Download Technical Reference Manual

15 Chapter 3 Firmware download command set REMOVE_DRIVER Description Removes the flash driver from the scanner. Use this command: if the driver does not recognize the flash memory installed in the scanner Another flash driver must be downloaded to the scanner. After reception of this command, the scanner will initiate a new flash driver download sequence and wait for the byte AUTO- DETECTION 0x00 (see section 0). The host must wait 100ms before sending the AUTO-DETECTION byte. when firmware download is completed After reception of this command, the scanner waits for the host to switch off its power supply by placing a high level on the pin INPUT/OUTPUT1 (POWER_ENABLE line on scanner). Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0012 REMOVE_DRIVER <PARM 1> 16 bits 0x0000 must be zero <PARM 2> 16 bits 0x0000 must be zero <PARM 3> 16 bits 0x0000 must be zero <PARM 4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Flash driver response CMD_ACK (0x32) undefined OK then followed by: CMD_DONE (0x31) if command executed correctly OR undefined byte using ACK software protocol if execution of command fails (flash driver then waits for an acknowledge after transmission of this byte) transmission error, bad checksum or incorrect parameter E1022 Firmware Download Technical Reference Manual 11

16 Chapter 3 Firmware download command set FIRMWARE_VERSION Description Used to find out what firmware version is currently in the scanner. Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0013 FIRMWARE_VERSION <PARM 1> 16 bits 0x0000 must be zero <PARM 2> 16 bits 0x0000 must be zero <PARM 3> 16 bits 0x0000 must be zero <PARM 4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Flash driver responses CMD_ACK (0x32) undefined OK transmission error, bad checksum or incorrect parameter Flash driver sends: After execution of the command, the flash driver sends four words and a string in ASCII format terminated by the character "\0". <RESERVED> <RESERVED> <FIRMWARE_VERSION> <RESERVED> 32 bits 0xN reserved <RESERVED> 32 bits 0xN reserved <FIRMWARE_ VERSION> ASCII string 0xn max 30 characters + last character ("\0) 12 E1022 Firmware Download Technical Reference Manual

17 Chapter 3 Firmware download command set ERASE_ALL Description Erases the flash memory of the scanner. Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0014 ERASE_ALL <PARM 1> 16 bits 0x0000 must be zero <PARM 2> 16 bits 0x0000 must be zero <PARM 3> 16 bits 0x0000 must be zero <PARM 4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Flash driver responses CMD_ACK (0x32) undefined OK then followed by: CMD_DONE (0x31) if command executed correctly OR undefined byte using ACK software protocol if execution of command fails (flash driver then waits for an acknowledge after transmission of this byte) transmission error, bad checksum or incorrect parameter Note: Depending on the type of flash memory installed in the scanner, erasing the flash memory can take up to 30 seconds E1022 Firmware Download Technical Reference Manual 13

18 Chapter 3 Firmware download command set READ_BLOCK Description Reads a block of the current firmware in the flash memory of the scanner. This command is used to save a copy of the current firmware before sending the erase command and then downloading the new firmware in the scanner. Host request <CMD> <PARM1> <PARM2> <PARM3> <PARM4> <CHK> <CMD> 16 bits 0x0015 READ_BLOCK <PARM1> 16 bits 0xN BLOCK_SIZE (max = 128) number of words to be read to flash memory <PARM2> 16 bits 0xN ADDRESS (*) (most significant word) <PARM3> 16 bits 0xN ADDRESS (*) (least significant word) <PARM4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Note: (*) Points to words (must be compatible with flash memory size. Flash driver responses CMD_ACK (0x32) undefined OK transmission error, bad checksum or incorrect parameter Flash driver sends block <WORD_1>.. <WORD_N> <CHK> <WORD_1> 16 bits 0xN first word of block <WORD_N> 16 bits 0xN last word of block <CHK> 32 bits 0xN calculated 14 E1022 Firmware Download Technical Reference Manual

19 Chapter 3 Firmware download command set WRITE_BLOCK Description Writes a block of the new firmware to the scanner flash memory. Host request <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0016 WRITE_BLOCK <PARM1> 16 bits 0xN BLOCK_SIZE (max = 128) number of words to be written to flash memory <PARM2> 16 bits 0xN ADDRESS (*) (most significant word) <PARM3> 16 bits 0xN ADDRESS (*) (least significant word) <PARM4> 16 bits 0x0000 must be zero <CHK> 32 bits 0xN calculated Note: (*) Points to words (must be compatible with flash memory size). Flash driver responses CMD_ACK (0x32) undefined OK transmission error, bad checksum or incorrect parameter Host sends block After reception of the CMD_ACK byte from the scanner, the host sends the block using the following format. <WORD_1>.. <WORD_N> <CHK> <WORD_1> 16 bits 0xN first word of block <WORD_N> 16 bits 0xN last word of block <CHK> 32 bits 0xN calculated Flash driver replies CMD_DONE (0x31) OK undefined execution of the command failed E1022 Firmware Download Technical Reference Manual 15

20 Chapter 3 Firmware download command set WRITE_SAME_WORD Description Writes the same word in a block of the flash memory in the scanner. This command optimizes the transmission time when you want to fill a block of memory with the same character. Command <CMD> <PARM 1> <PARM 2> <PARM 3> <PARM 4> <CHK> <CMD> 16 bits 0x0017 WRITE_SAME_WORD <PARM1> 16 bits 0xN BLOCK_SIZE (max = 128) number of words to be written to flash memory <PARM2> 16 bits 0xN ADDRESS (*) (most significant word) <PARM3> 16 bits 0xN ADDRESS (*) (least significant word) <PARM4> 16 bits 0xN WORD <CHK> 32 bits 0xN calculated to be written in block of flash memory Note: (*) Points to words (must be compatible with flash memory size). Flash driver responses CMD_ACK (0x32) undefined OK then followed by: CMD_DONE (0x31) if command executed correctly OR undefined byte using ACK software protocol if execution of command fails (flash driver then waits for an acknowledge after transmission of this byte) transmission error, bad checksum or incorrect parameter 16 E1022 Firmware Download Technical Reference Manual

21 A Typical firmware download procedure This appendix provides a flow chart showing a typical firmware download procedure. E1022 Firmware Download Technical Reference Manual 17

22 Appendix A Typical firmware download procedure Preparation Select flash driver Baud rate auto-detection Enable RTS / CTS protocol (or ACK_MODE) Download flash driver Send command FLASH_INIT Receive Flash_Size Flash_Size = 0x Yes Send command FIRMWARE_VERSION Receive name of current software version Create save file Curr_Vers i = 0 No Send command REMOVE_DRIVER Select new flash driver Delay 100ms Send command READ_BLOCK (block_size = 128, address = i * 128 Receive block number i Checksum received = Checksum calculated No Write block in file Curr_Vers i++ Yes i < Flash_Size/128 Yes No Close file Curr_Vers Open file New_Vers Calculate File_Size (in words) File_Size < = Flash_Size No Yes Send command ERASE_ALL i = 0 Read the 128 words of block i in file New_Vers Send command WRITE_BLOCK (block_size = 128, address = i * 128) Send the 128 words of block i i++ i < File_Size/128 No Yes Send command REMOVE_DRIVER Typical firmware download procedure 18 E1022 Firmware Download Technical Reference Manual

23 B Checksum calculation Formula NB_WORDS-1 CHK = Σ WORD i * (NB_WORDS i) i=0 WORD i = 16 bits CHK = 32 bits Algorithm CHK = 0 for i = 0 to (NB_WORDS 1) CHK = CHK + (WORD(i) * (NB_WORDS i)) next i Checksum example frame CMD PARM1 PARM2 PARM3 PARM4 CHK value 0x0015 0x0080 0x0000 0x4C80 0x0000 0x0000 0x9B69 weight value * weight 0x0069 0x0200 0x0000 0x9900 0x0000 checksum = 0x x x x x0000 = 0x9B69 E1022 Firmware Download Technical Reference Manual 19

24

25 C RTS/CTS hardware protocol RTS/CTS hardware protocol is active by default in the scanner. However, the scanner is always ready to receive a character from the host on its RXD line (pull down on scanner CTS line) so the host does not need to use a hardware protocol to send data to the scanner. RTS/CTS hardware protocol uses four lines as indicated below: HOST RXD TXD SCAN ENGINE TXD RXD CTS RTS RTS CTS host signals scanner signals description RXD (input) TXD (output) scanner transmits data to the host TXD (output) RXD (input) host transmits data to the scanner CTS (input) RTS (output) scanner asks the host for permission to transmit a character RTS (output) CTS (input) host authorizes the scanner to transmit a character The scanner: requests permission from the host each time it wants to transmit a byte receives permission from the host transmits a byte removes the request after transmission of the byte E1022 Firmware Download Technical Reference Manual 21

26 Appendix C RTS/CTS hardware protocol waits for the host to remove permission before making another request The host: grants permission when the scanner requests to transmit a byte awaits reception of the byte removes permission after receiving the byte host TXD to scan engine RXD scan engine RTS to host CTS host RTS to scan engine CTS scan engine TXD to host RXD A B-1 B-4 B-2 B-5 B-3 Transmission from the host to the scanner A: The host transmits a byte to the scanner without using the hardware protocol Transmission from the scanner to the host B-1: The scanner requests permission to transmit a byte B-2: The host grants permission to the scanner B-3: The scanner transmits the byte B-4: The scanner removes the request B-5: The host removes the permission after receiving the byte 22 E1022 Firmware Download Technical Reference Manual

27 D ACK software protocol The ACK software protocol must be used by hosts that are not designed to use the RTS/CTS hardware protocol. The host must send the ACK_MODE command to the scanner, before any other command, to activate the ACK software protocol. This deactivates the scanner's default RTS/CTS hardware protocol. When in ACK mode, the scanner sends a byte then waits for an ACK character (0x06) from the host before sending the next byte. This acknowledge tells the scanner that the byte has been correctly received by the host. Using this protocol helps to avoid losing characters when the host is busy. The scanner does not continue sending data unless it has received the ACK character from the host. host TXD to scan engine RXD scan engine TXD to host RXD A byte (no protocol) B-1 byte B-2 ACK (0x06) B-3 B-4 ACK (0x06) byte Transmission from the host to the scanner A: The host transmits a byte to the scanner without using any protocol E1022 Firmware Download Technical Reference Manual 23

28 Appendix D ACK software protocol Transmission from the scanner to the host B-1: The scanner transmits the first byte B-2: The host transmits the acknowledge (ACK = 0x06) B-3: The scanner transmits the next byte B-4: The host transmits the acknowledge (ACK = 0x06) 24 E1022 Firmware Download Technical Reference Manual