gs2k module programming user guide...1.3 may 2014 updated dos flash programming instructions. see...

GS2K Module Programming User Guide 1VV0301437 Rev. 3.0 – 2019-02-01

GS2K Module Programming User Guide

SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE

NOTICEWhile reasonable efforts have been made to assure the accuracy of this document, Telit assumes noliability resulting from any inaccuracies or omissions in this document, or from use of the informationobtained herein. The information in this document has been carefully checked and is believed to bereliable. However, no responsibility is assumed for inaccuracies or omissions. Telit reserves the rightto make changes to any products described herein and reserves the right to revise this documentand to make changes from time to time in content hereof with no obligation to notify any person ofrevisions or changes. Telit does not assume any liability arising out of the application or use of anyproduct, software, or circuit described herein; neither does it convey license under its patent rights orthe rights of others.It is possible that this publication may contain references to, or information about Telit products(machines and programs), programming, or services that are not announced in your country. Suchreferences or information must not be construed to mean that Telit intends to announce such Telitproducts, programming, or services in your country.

COPYRIGHTSThis instruction manual and the Telit products described in this instruction manual may be, include ordescribe copyrighted Telit material, such as computer programs stored in semiconductor memoriesor other media. Laws in the Italy and other countries preserve for Telit and its licensors certainexclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form,distribute and make derivative works of the copyrighted material. Accordingly, any copyrightedmaterial of Telit and its licensors contained herein or in the Telit products described in this instructionmanual may not be copied, reproduced, distributed, merged or modified in any manner without theexpress written permission of Telit. Furthermore, the purchase of Telit products shall not be deemedto grant either directly or by implication, estoppel, or otherwise, any license under the copyrights,patents or patent applications of Telit, as arises by operation of law in the sale of a product.

COMPUTER SOFTWARE COPYRIGHTSThe Telit and 3rd Party supplied Software (SW) products described in this instruction manual mayinclude copyrighted Telit and other 3rd Party supplied computer programs stored in semiconductormemories or other media. Laws in the Italy and other countries preserve for Telit and other 3rd Partysupplied SW certain exclusive rights for copyrighted computer programs, including the exclusive rightto copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrightedTelit or other 3rd Party supplied SW computer programs contained in the Telit products described inthis instruction manual may not be copied (reverse engineered) or reproduced in any manner withoutthe express written permission of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telitproducts shall not be deemed to grant either directly or by implication, estoppel, or otherwise, anylicense under the copyrights, patents or patent applications of Telit or other 3rd Party supplied SW,except for the normal non-exclusive, royalty free license to use that arises by operation of law in thesale of a product.

1VV0301437 Rev. 3.0 2 2019-02-01


USAGE AND DISCLOSURE RESTRICTIONS

I. License Agreements

The software described in this document is the property of Telit and its licensors. It is furnished byexpress license agreement only and may be used only in accordance with the terms of such anagreement.

II. Copyrighted Materials

Software and documentation are copyrighted materials. Making unauthorized copies is prohibited bylaw. No part of the software or documentation may be reproduced, transmitted, transcribed, stored ina retrieval system, or translated into any language or computer language, in any form or by anymeans, without prior written permission of Telit

III. High Risk Materials

Components, units, or third-party products used in the product described herein are NOTfault-tolerant and are NOT designed, manufactured, or intended for use as on-line control equipmentin the following hazardous environments requiring fail-safe controls: the operation of NuclearFacilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic Control, Life Support, orWeapons Systems (High Risk Activities”). Telit and its supplier(s) specifically disclaim any expressedor implied warranty of fitness for such High Risk Activities.

IV. Trademarks

TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service namesare the property of their respective owners.

V. Third Party Rights

The software may include Third Party Right software. In this case you agree to comply with all termsand conditions imposed on you in respect of such separate software. In addition to Third PartyTerms, the disclaimer of warranty and limitation of liability provisions in this License shall apply to theThird Party Right software.

TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM ANYTHIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY MATERIALSINCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM WHICH THESOFTWARE IS DERIVED (COLLECTIVELY “OTHER CODE”), AND THE USE OF ANY OR ALLTHE OTHER CODE IN CONNECTION WITH THE SOFTWARE, INCLUDING (WITHOUTLIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY OR FITNESS FOR APARTICULAR PURPOSE.

NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANYDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND WHETHERMADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY, ARISING IN ANY WAY OUT OFTHE USE OR DISTRIBUTION OF THE OTHER CODE OR THE EXERCISE OF ANY RIGHTSGRANTED UNDER EITHER OR BOTH THIS LICENSE AND THE LEGAL TERMS APPLICABLE TOANY SEPARATE FILES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

1VV0301437 Rev. 3.0 3 2019-02-01


Note: The features described in the present document are provided by the products equipped with the software versions equal or higher than the versions shown in the table. See also the Revision History chapter.

PRODUCT

GS2K based Modules

APPLICABILITY TABLE

1VV0301437 Rev. 3.0 4 2019-02-01


1VV0301437 Rev 3.0 5 2019-02-01

Table of Contents

Chapter 1 GS2K Evaluation Board Overview .................................................................................. 191.1 Introduction ............................................................................................................................191.2 Requirements ........................................................................................................................20

Chapter 2 Programming Modules on the Evaluation Board ............................................................ 212.1 Building Binaries Using the SDK Builder Application ............................................................222.2 Preparing the Evaluation Boards for UART Interface ............................................................28

2.2.1 GS2011M Evaluation Board .........................................................................................282.2.2 GS2100M Evaluation Board .........................................................................................292.2.3 GS2101M Evaluation Board .........................................................................................302.2.4 GS2200M Evaluation Board .........................................................................................31

2.3 Programming the Evaluation Boards Using the GUI Application ...........................................322.4 Programming the Module Using the UART Interface ............................................................34

2.4.1 Programming the Module With Multiple Images - UART .............................................392.4.2 Programming the Module Using 921600 Baud Rate - UART .......................................44

2.5 Programming the Module Using DOS for UART Interface ....................................................482.5.1 Programming the Module Using DOS 115200 Baud Rate - UART ..............................492.5.2 Programming the Module Using DOS 921600 Baud Rate - UART ..............................54

2.6 Preparing the Evaluation Boards for SPI Interface ................................................................592.6.1 GS2011M Evaluation Board .........................................................................................592.6.2 GS2100M Evaluation Board .........................................................................................602.6.3 GS2101M Evaluation Board .........................................................................................612.6.4 GS2200M Evaluation Board .........................................................................................62

2.7 Programming the Module Using the SPI Interface ................................................................632.7.1 Programming the Module With Multiple Images - SPI .................................................68

2.8 Programming the Module Using DOS for SPI Interface ........................................................73

Chapter 3 Associating and Verifying ................................................................................................ 793.1 Connecting the Evaluation Board to a Serial COM Port ........................................................79

Chapter 4 Starting the Serial-to-Wi-Fi Application .......................................................................... 834.1 Communicating with the Evaluation Board ............................................................................83

Appendix A Dumping Flash Memory Commands .............................................................. 85A.1 Prerequisites .........................................................................................................................85A.2 Configuring Flash Commands ...............................................................................................85

A.2.1 Reading 2MB flash memory to a file ............................................................................85A.2.2 Writing 2MB file to flash memory .................................................................................86A.2.3 Reading 4MB flash memory to a file ............................................................................86A.2.4 Writing 4MB file to a flash memory ..............................................................................87


About This Manual

This manual provides guidelines for programming the Flash memory on the GainSpan® modules through either the UART or SPI interface on the GS2000 evaluation board.

Refer to the following sections:

• Revision History, page 7

• Audience, page 9

• Standards, page 9

• Documentation Conventions, page 10

• Documentation, page 13

• References, page 15

• Contact Information, Support, page 16

• Returning Products to Telit, page 17

• Accessing the Telit Wi-Fi Portal, page 18

1VV0301437 Rev 3.0 6 2019-02-01


Revision HistoryThis version of the GainSpan GS2000 Based Module Programming User Guide contains the following new information listed in Table 1, page 7.

Table 1 Revision History

Version Date Remarks1.0 November 2013 Initial Release

1.1 February 2014Updated flash programming instructions. See 2.3 Programming the Evaluation Boards, page 28.

1.2 April 2014Updated instructions for building binaries using the SDK Builder. See 2.1 Building Binaries Using the SDK Builder Application, page 20.

1.3 May 2014Updated DOS flash programming instructions. See 2.3.4 Programming the Module Flash Using DOS, page 39.

1.4 June 2014

Updated GUI application to support 921600 Baud Rate, Program same firmware image at multiple locations. See 2.3.2 Programming Firmware Image to Multiple Locations, page 34 and 2.3.3 Programming the Module on the Evaluation Board Using 921600 Baud Rate, page 36.

1.4.1 September 2014

Updated Serial Flash Programmer for GS2000 screen capture and instructions to support version 1.2.2. See 2.3.1 Programming the Module Using GUI Application, page 28.

1.4.2 October 2014

Updated instructions to include additional screen captures representing programming the GS2000 module. See 2.3.1 Programming the Module Using GUI Application, page 28 .

1.5 December 2014

Added DOS instructions for programming the evaluation boards using 115200 and 921600 Baud Rate settings. See 2.5 Programming the Module Using DOS for UART Interface, page 48 and 2.8 Programming the Module Using DOS for SPI Interface, page 73.

1.6 October 2015

Updated details in 1.2 Requirements, page 20.Updated screen captures in section 2.4 Programming the Module Using the UART Interface, page 34; 2.6 Preparing the Evaluation Boards for SPI Interface, page 59 and 2.7 Programming the Module Using the SPI Interface, page 63.

1VV0301437 Rev 3.0 7 2019-02-01


1.7 January 2016

Updated the note in 2.4 Programming the Module Using the UART Interface, page 34Updated screen shots, see 2.3 Programming the Evaluation Boards Using the GUI Application, page 32,2.4 Programming the Module Using the UART Interface, page 34, 2.5 Programming the Module Using DOS for UART Interface, page 48, 2.6 Preparing the Evaluation Boards for SPI Interface, page 59, 2.7 Programming the Module Using the SPI Interface, page 63, 2.7 Programming the Module Using the SPI Interface, page 63, 2.8 Programming the Module Using DOS for SPI Interface, page 73 and 4.1 Communicating with the Evaluation Board, page 83

1.8 July 2017

Added a note on Serial Flash Utility see 2.3 Programming the Evaluation Boards Using the GUI Application, page 32Updated the note in 2.4 Programming the Module Using the UART Interface, page 34 and 2.7 Programming the Module Using the SPI Interface, page 63

1.9 Sept 2017 Added details of GS2200M to all the chapters

2.0 Nov 2017 Added Appendix ADumping Flash Memory Commands, page 85.

3.0 Feb 2019 Updated the Telit Contact Information.

Table 1 Revision History

Version Date Remarks

1VV0301437 Rev 3.0 8 2019-02-01


AudienceThis manual is designed for software engineers who want to program the on-board Flash to evaluate and run Serial-to-Wi-Fi or Temperature and Light Sensor applications for their environment using DOS or Graphical User Interface procedures. These modules can be programmed using UART or SPI interface procedures.

StandardsThe GainSpan GS module series supports the IEEE 802.11 b/g/n standards.

1VV0301437 Rev 3.0 9 2019-02-01


Documentation ConventionsThis manual uses the following text and syntax conventions:

– Special text fonts represent particular commands, keywords, variables, or window sessions

– Color text indicates cross-reference hyper links to supplemental information

– Command notation indicates commands, subcommands, or command elements

Table 2, page 10, describes the text conventions used in this manual for software procedures that are explained using the AT command line interface.

Table 2 Document Text Conventions

Convention Type Description

command syntaxmonospaced font

This monospaced font represents command strings entered on a command line and sample source code.

AT XXXX

Proportional fontdescription

Gives specific details about a parameter.

<Data> DATA

UPPERCASEVariable parameter

Indicates user input. Enter a value according to the descriptions that follow. Each uppercased token expands into one or more other token.

lowercaseKeyword parameter

Indicates keywords. Enter values exactly as shown in the command description.

[ ]Square brackets

Enclose optional parameters. Choose none; or select one or more an unlimited number of times each. Do not enter brackets as part of any command.

[parm1|parm2|parm3]

?Question mark

Used with the square brackets to limit the immediately following token to one occurrence.

<ESC>Escape sequence

Each escape sequence <ESC> starts with the ASCII character 27 (0x1B). This is equivalent to the Escape key.

<ESC>C

<CR>Carriage return

Each command is terminated by a carriage return.

<LF>Line feed

Each command is terminated by a line feed.

1VV0301437 Rev 3.0 10 2019-02-01


<CR> <LF>Carriage returnLine feed

Each response is started with a carriage return and line feed with some exceptions.

< >Angle brackets

Enclose a numeric range, endpoints inclusive. Do not enter angle brackets as part of any command.

<SSID>

=Equal sign

Separates the variable from explanatory text. Is entered as part of the command.

PROCESSID = <CID>

.dot (period)

Allows the repetition of the element that immediately follows it multiple times. Do not enter as part of the command.

.AA:NN can be expanded to 1:01 1:02 1:03.

A.B.C.DIP address

IPv4-style address.

10.0.11.123

X:X::X:XIPv6 IP address

IPv6-style address.

3ffe:506::1Where the : : represents all 0x for those address components not explicitly given.

LINEEnd-to-line input token

Indicates user input of any string, including spaces. No other parameters may be entered after input for this token.

string of words

WORDSingle token

Indicates user input of any contiguous string (excluding spaces).

singlewordnospaces

Table 2 Document Text Conventions (Continued)

Convention Type Description

1VV0301437 Rev 3.0 11 2019-02-01


Table 3, page 12, describes the symbol conventions used in this manual for notification and important instructions.

Table 3 Symbol Conventions

Icon Type Description

NoteProvides helpful suggestions needed in understanding a feature or references to material not available in the manual.

Alert Alerts you of potential damage to a program, device, or system or the loss of data or service.

Caution Cautions you about a situation that could result in minor or moderate bodily injury if not avoided.

Warning Warns you of a potential situation that could result in death or serious bodily injury if not avoided.

Electro-Static Discharge (ESD)

Notifies you to take proper grounding precautions before handling a product.

1VV0301437 Rev 3.0 12 2019-02-01


DocumentationThe GainSpan documentation suite listed in Table 4, page 13 includes the part number, documentation name, and a description of the document. The documents are available on the Telit Wi-Fi Portal. Refer to Accessing the Telit Wi-Fi Portal, page 18 for details.

Table 4 Documentation List

Part Number Document Title Description1VV0301415

1VV0301454

1VV0301416

1VV0301417

1VV0301422

• GS2011M Evaluation Board Quick Start Guide




• GS2200M SKB Quick Start Guide

Provides an easy to follow guide on how to unpack and setup GainSpan GS2000 based module kit for the GS2K modules.

1VV0301409 GS2K Software Development Kit Quick Start Guide

Provides easy steps to setup, evaluate, develop, and debug the full capabilities and features of the GS2K modules on the embedded platform software.

• 1VV0301463

• 1VV0301496

• 1VV0301498

• 1VV0301500

• GS2011M S2W Adapter Command Reference Guide




Provides a complete listing of AT serial commands, including configuration examples for initiating, maintaining, and evaluating GainSpan Wi-Fi GS2K series modules.

1VV0301444 GS2K S2W Use Case Reference Guide

Provides references for using GainSpan AT commands and its usage in different scenarios using different features and protocols.

1VV0301435GS2K Module Evaluation BoardHardware User Guide

Provides instructions on how to setup and use the GS2000 based module evaluation board along with component description, jumper settings, board specifications, and pinouts.

1VV0301482 GS2011M Low Power Wi-Fi Module Hardware User Guide

Provides information to help Wi-Fi system designers to build systems using GainSpan GS2011M module and develop wireless applications.

1VV0301437 Rev 3.0 13 2019-02-01


1VV0301486 GS2011MxxS Low Power Wi-Fi Module Hardware User Guide

Provides information to help Wi-Fi system designers to build systems using GainSpan GS2011MxxS module and develop wireless applications.

1VV0301514 GS2100M Low Power Wi-Fi Module






• 1VV0301464

• 1VV0301497

• 1VV0301499

• 1VV0301501

• GS2011M IP2WiFi Adapter Command Reference Guide




Provides a complete listing of AT serial commands, including configuration examples for initiating, maintaining, and evaluation GainSpan IP-to-Wi-Fi GS2000 based modules.

1VV0301438 GS2K SDK Builder User Guide

Allows OEMs and system developers to configure and generate customfirmware binary images for GainSpanlow power embedded GS2000 basedWi-Fi modules. The SDK Buildersupports the GainSpan GEPS softwarereleased, including the correspondingWLAN firmware.

Table 4 Documentation List (Continued)

Part Number Document Title Description

1VV0301437 Rev 3.0 14 2019-02-01


ReferencesThe GainSpan references listed in Table 5, page 15 are available on the Telit Wi-Fi Portal.

Table 5 Other Documents and References

Title Description

Schematics

GS2000 Based Module Evaluation Board schematics supporting:• GS2011M• GS2100M• GS2101M• GS2200M• GS2200M SKB

Smart Phone Applications

• Smart Phone applications for iOS and Android to evaluate and demonstrate the Temperature and Light Sensor (TLS) firmware.

– For use with GS2011M EVK and GS2200 EVB and SKB only

• Android:

– GainSpan Provisioning

– GainSpan Firmware Update

– GainSpan Smartplug

– GainSpan TLS

– Concurrent Provisioning

• iOS:

– GainSpan TLS

– GainSpan Provisioning

– GainSpan-Renesas Wi-Fi Sensor

– GainSpan ConcurrentProvisioning

– GainSpan Freescale Wi- Fi Sensor

– GainSpan Audio

– GainSpan Smartplug

– GainSpan Firmware Update

Tools and UtilitiesSerial terminal program to evaluate and demonstrate Serial-to-Wi-Fi (S2W) applications such as

– gs2k_flashprogram.exe

1VV0301437 Rev 3.0 15 2019-02-01


Contact Information, SupportFor general contact, technical support services, technical questions and to report documentation errors contact Telit Technical Support at:

[email protected]

We recommend adding “Wi-Fi” in subject of the email. For example, the subject of email can be “Wi-Fi: Your actual issue or question in brief” like “Wi-Fi: SPI Driver Issue”.

Also, in description of your email, please provide details about the issue, product and module including software firmware version, module version and type, application being used, customizations done to application, use case, issue frequency, and ability to recreate it among other things wherever applicable.

Alternatively, for more Technical Support information or assistance, perform the following steps:

1. Visit http://www.telit.com, go to IoT Products & Solutions> Wi-Fi and Bluetooth, then scroll down to the Telit Wi- Fi Portal.

2. Click Access the Portal Here icon which will direct you to the Telit Wi-Fi portal https://wifi.telit.com/secure/login

1. Log in with your registered Email and Password.

2. Select the Location.

3. Select Q&A tab.

4. Select Ask a New Question.

5. Enter your technical support question, product information, and a brief description.

For detailed information about where you can buy the Telit modules or for recommendations on accessories and components visit:

http://www.telit.com

Our aim is to make this guide as helpful as possible. Keep us informed of your comments and suggestions for improvements. Telit appreciates feedback from the users of our information.

1VV0301437 Rev 3.0 16 2019-02-01

https://wifi.telit.com/secure/login

[email protected]


Returning Products to TelitIf a problem cannot be resolved by Telit technical support, a Return Material Authorization (RMA) is issued. This number is used to track the returned material at the factory and to return repaired or new components to the customer as needed.

To return a hardware component:

1. Determine the part number and serial number of the component.

2. Obtain an RMA number from Sales/Distributor Representative.

3. Provide the following information in an email or during the telephone call:

– Part number and serial number of component

– Your name, organization name, telephone number, and fax number

– Description of the failure

4. The support representative validates your request and issues an RMA number for return of the components.

5. Pack the component for shipment.

Guidelines for Packing Components for ShipmentTo pack and ship individual components:

– When you return components, make sure they are adequately protected with packing materials and packed so that the pieces are prevented from moving around inside the carton.

– Use the original shipping materials if they are available.

– Place individual components in electrostatic bags.

– Write the RMA number on the exterior of the box to ensure proper tracking.

NOTE: Do not return any components to Telit unless you have first obtained an RMA number. Telit reserves the right to refuse shipments that do not have an RMA. Refused shipments will be returned to the customer by collect freight.

CAUTION! Do not stack any of the components.

1VV0301437 Rev 3.0 17 2019-02-01


Accessing the Telit Wi-Fi PortalTo find the latest version of Telit documentation supporting the GainSpan product release you are interested in, you can search the Telit Wi-Fi Portal website by performing the following steps:

1. Visit http://www.telit.com, go to IoT Products & Solutions> Wi-Fi and Bluetooth, then scroll down the Telit Wi- Fi Portal.

2. Click Access the Portal Here icon which will direct you to the Telit Wi-Fi portal https://wifi.telit.com/secure/login

3. Log in using your customer Email and Password.

4. Click the Getting Started tab to view a Quick Start tutorial on how to use various features within the Telit Wi-Fi Portal.

5. Click the Agreements tab to download and upload the SLA for ADK and SDK respectively.

6. Click on the Documents tab to search, download, and print GainSpan product documentation.

7. Click the Software tab to search and download the latest software versions.

8. Click the Kits Purchased tab to view customer account history.

9. Click the Legal Documents tab to view GainSpan Non-Disclosure Agreement (NDA).

10. Click the Certifications tab to view GainSpan certifications.

NOTE: You must first contact Telit to set up an account, and obtain a customer user name and password before you can access the Telit Wi-Fi Portal.

1VV0301437 Rev 3.0 18 2019-02-01




Chapter 1 GS2K Evaluation Board Overview

This chapter provides an overview of the GainSpan® Evaluation Board (EVB) based on the GS2000 based ultra-low power wireless module solution for Wi-Fi networks.

• Introduction, page 19

• Requirements, page 20

1.1 IntroductionThe EVB provides customers the means to evaluate the capabilities of GainSpan ultra-low power wireless module solutions for Wi-Fi® networks. The Serial-to-Wi-Fi embedded software on the modules allows devices to easily add Wi-Fi capabilities to their products.

The evaluation board comes with preloaded Serial-to-Wi-Fi firmware that supports limited station AP mode, with built-in web server for provisioning the device.

The following steps are outlined in this user guide to program the firmware and related files onto the evaluation board using the programming utility provided:

• Chapter 2 Programming Modules on the Evaluation Board, page 21

• Chapter 3 Associating and Verifying, page 79

• Chapter 4 Starting the Serial-to-Wi-Fi Application, page 83

1VV0301437 Rev 3.0 19 2019-02-01

https://www.gainspan.com/secure.login

https://www.gainspan.com/secure.login


1.2 RequirementsThe following hardware and software are needed to program the GS2000 evaluation boards.

• For UART Interface Programming:

– GS2200M, GS2011M or GS2100M Evaluation Board

– mini-USB Cable

– gs2k_flashprogram GUI and DOS application

– SDK Builder - to build firmware binaries

– Tera Term VT or similar terminal emulation software

• For SPI Interface Programming:

– GS2200M, GS2011M or GS2100M Evaluation Board

– Cheetah and Aardvark SPI Host Adapter (High-Speed USB to SPI Interface)

– Maximum Clock speed for Cheetah is 1200KHz and Aardvark is 4000KHz

– mini-USB Cable

– gs2k_flashprogram GUI and DOS application

– SDK Builder - to build firmware binaries

– Tera Term VT or similar terminal emulation software

– TotalPhaseUSB Drivers for Cheetah SPI Host Adapter - download the latest at: http://www.totalphase.com/products/usb-drivers-windows

1VV0301437 Rev 3.0 20 2019-02-01

http://www.totalphase.com/products/usb-drivers-windows

http://www.totalphase.com/products/usb-drivers-windows


Chapter 2 Programming Modules on the Evaluation Board

This chapter provides step-by-step instructions on how to program the modules and evaluation board using the gs2k_flashprogram GUI application or DOS procedures with a new/different firmware image via UART or SPI interface connections.

• Building Binaries Using the SDK Builder Application, page 22

• Preparing the Evaluation Boards for UART Interface, page 28

• Programming the Evaluation Boards Using the GUI Application, page 32

• Programming the Module Using the UART Interface, page 34

• Programming the Module Using DOS for UART Interface, page 48

• Preparing the Evaluation Boards for SPI Interface, page 59

• Programming the Module Using the SPI Interface, page 63

• Programming the Module Using DOS for SPI Interface, page 73

ESD ALERT! Charged devices and circuit boards can discharge without detection. Although this product features patented or proprietary protection circuitry, damage may occur on devices subjected to high energy ESD. Therefore, proper ESD precautions should be taken to avoid performance degradation or loss of functionality.

NOTE: It is recommended to copy the contents of the flash program utilities to a created folder on your C:\drive.

1VV0301437 Rev 3.0 21 2019-02-01


2.1 Building Binaries Using the SDK Builder ApplicationThe SDK Builder application allows you to build binaries to program the flash for the GS2011M, GS2100M, GS2101M and GS2200M. To use the SDK Builder application, perform the following:

1. Open a web browser, in the address bar type https://wifi.telit.com/secure/login, and press enter. The following page displays (see Figure 1, page 22)

Figure 1 Logging Into Your GainSpan Account

1VV0301437 Rev 3.0 22 2019-02-01


2. Log in to your account using you registered Email and Password, and click SIGN IN.

Figure 2 Sign In To Your GainSpan Account

1VV0301437 Rev 3.0 23 2019-02-01


3. The Getting Started tab guides you through helpful tips on how to program GainSpan products, search for support documentation, and navigate through the website. It also give you a direct link to access the SDK Builder (see Figure 3, page 24).

Figure 3 Getting Started

1VV0301437 Rev 3.0 24 2019-02-01


4. You can also click on the SDK Builder tab, and select a GainSpan module of your choice to create the firmware. In this example, we are selecting GS2000 (see Figure 4, page 25).

Figure 4 Select GainSpan Module to Create Firmware

5. The GainSpan SDK Builder Welcome screen displays links that give a brief explanation of the SDK Builder and Documentation (see Figure 5, page 25).

Figure 5 GainSpan SDK Builder Welcome

6. Click the Next button to proceed to select your SDK Builder configuration.

1VV0301437 Rev 3.0 25 2019-02-01


7. The GainSpan SDK Builder Configuration screen allows you to select your firmware configuration options and submit your build. Once the build request is submitted you will receive an automated receipt acknowledging your build request. For details and description of each field, refer to the GainSpan GS2K Software Developer Kit (SDK) Builder User Guide.

Figure 6 Select SDK Builder Configuration

8. When the SDK Builder completes the process, it will compile and build your custom software.

9. The build package is available for download under the Build History tab, you will receive an automated receipt acknowledging your build success.

10. Next, login to your GainSpan SDK Builder account and download the package files.

Figure 7 Build History Tab

1VV0301437 Rev 3.0 26 2019-02-01


11. Open or Save the Zip binary files to a directory on your C:\drive, and unzip (Figure 8, page 27).

Figure 8 Firmware Binary Files

12. The firmware binary files for the module are displayed (see Figure 9, page 27). The created binary files are used to program the module using the GUI program.

Figure 9 Binary Files Created Using the SDK Builder

For instructions how to program the flash using DOS, refer to 2.5 Programming the Module Using DOS for UART Interface, page 48 and 2.8 Programming the Module Using DOS for SPI Interface, page 73.

1VV0301437 Rev 3.0 27 2019-02-01

https://www.gainspan.com/secure/login


2.2 Preparing the Evaluation Boards for UART Interface

2.2.1 GS2011M Evaluation Board

The following steps will guide you through programming the GS2011M evaluation board with the Serial-to-Wi-Fi binaries using UART interface (see 1.2 Requirements, page 20):

1. Plug the mini-USB cable into the USB0 port as shown in Figure 10, page 28.

2. Plug the other end of the mini-USB cable into a USB port on your computer.

3. Turn the PROGRAM/RUN switch on the GS2011M to the PROGRAM position.

4. Turn the ON/OFF power switch on the GS2011M to the ON position. The Program Flash LED will be lit RED, indicating that the module is ready to be programmed.

Figure 10 Setting Up the GS2011M Evaluation Board to Program Flash Using UART

ALERT! Make sure you unplug/plug the mini-USB cable with the ON/OFF switch in the OFF position.

NOTE: Refer to the GS2K Module Evaluation Board Hardware User Guide for a list of components, jumpers, switches, and LEDs.

NOTE: GS2000 Evaluation Board versions may differ from the picture below.

1VV0301437 Rev 3.0 28 2019-02-01












1VV0301437 Rev 3.0 29 2019-02-01












1VV0301437 Rev 3.0 30 2019-02-01












1VV0301437 Rev 3.0 31 2019-02-01


2.3 Programming the Evaluation Boards Using the GUI ApplicationThe GainSpan GS2011M, GS2100M, GS2101M, and GS2200M, evaluation boards are programmed using the GS2000 Graphical User Interface (GUI) application.

To program the Flash using the GUI application, perform the following:

1. Open the location where your SDK package resides on your C:\drive. Refer to the GainSpan GS2K Module Software Developer Kit (SDK) Builder User Guide for instructions on how to build SDK packages.

2. Go to Tools> GS_programming_tool folder, select and click on the gs2k_flashprogram application (see Figure 14, page 32).

Figure 14 gs2k_flashprogram Application

3. The Serial Flash Programmer window displays (see Figure 15, page 33).

NOTE: a.)The following instructions are the same for programming the flash with different firmware types after the appropriate file name is chosen. b.) The GainSpan Flash Programmer GUI Application version/edition will have no difference in Functionality. Hence, any version with the package can be used.

1VV0301437 Rev 3.0 32 2019-02-01


Figure 15 Serial Flash Programmer

4. Turn the PROGRAM/RUN switch to the PROGRAM mode and turn the ON/OFF power switch ON. The Program Flash LED will be lit RED, indicating the board is ready for programming the module flash.

1VV0301437 Rev 3.0 33 2019-02-01


2.4 Programming the Module Using the UART InterfaceFor programming the GS2011M, GS2011MxxS, GS2100M, GS2101M and GS2200M modules using UART interface, perform the following:

1. Select the Single UART Interface from the pull-down tab.

2. Select the UART port.

3. Select Baud Rate. The Baud Rate 115200 will automatically be selected. When selecting 921600 Baud Rate there are additional hardware instructions that need to be followed. Refer to 2.4.2 Programming the Module Using 921600 Baud Rate - UART, page 44.

4. Click the Check Connection button. The software will communicate with the GS2011M, GS2100M, GS2101M or GS2200M evaluation board to check the connection and display the Module Specifications (Module Type and Mac Address of the module). A Green check will display at the bottom of the screen indicating the Connection and Communication with the board is successful along with the selections specified (see Figure 16, page 34).

Figure 16 Communicating with the GainSpan Module - (UART)

NOTE: Customers should not check the “Retain Dynamic File System” when first programming the modules from GainSpan's factory. The first programming should always erase all of flash memory. For subsequent programming “Retain Dynamic File System” can be selected to retain Live Calibration Data.

1VV0301437 Rev 3.0 34 2019-02-01


5. Select the Firmware and Binaries to program the board with a Single Image. Click the Browse (...) buttons next to the Super Block and Current FW Version to download (see Figure 17, page 35).

Figure 17 Select Super Block and Firmware Single Image Binaries - (UART)

®

1VV0301437 Rev 3.0 35 2019-02-01


6. Select Single Image to program. This will program the module with a single firmware binary image. This is the default and recommended method (see Figure 18, page 36). For instructions on how to program the board with multiple images, refer to 2.4.1 Programming the Module With Multiple Images - UART, page 39.

Figure 18 Selecting Single Image Firmware - (UART)

7. Once selected, a message will display indicating that a valid Super Block and Firmware Image have been selected (see Figure 19, page 37).

1VV0301437 Rev 3.0 36 2019-02-01


Figure 19 Valid Super Block and Firmware Single Image Selected - (UART)

1VV0301437 Rev 3.0 37 2019-02-01


8. Click the Erase and Program button. The GUI software will go through a process of programming the module flash with the new firmware and binaries. When complete a Green check will display indicating the flash has been programmed successfully (see Figure 20, page 38).

Figure 20 Programming Single Image Complete - (UART)

9. Click the Close button. Turn the ON/OFF switch to the OFF position. Turn the PROGRAM/RUN switch to the RUN position. Turn the ON/OFF switch back to the ON position.

The GS2011M, GS2100M, GS2101M, or GS2200M is now ready to be verified. Refer to Chapter 3 Associating and Verifying, page 79.

To program the module flash using DOS, follow the instructions in 2.5 Programming the Module Using DOS for UART Interface, page 48.

For instructions on how to program the module using the SPI interface, refer to 2.7 Programming the Module Using the SPI Interface, page 63.

NOTE: The Erase Flash button will erase the entire flash on the module.

1VV0301437 Rev 3.0 38 2019-02-01


2.4.1 Programming the Module With Multiple Images - UARTProgramming the evaluation board with multiple images is used when you want to have previous or factory default versions of firmware binaries programmed onto the same board. For example, if a current build is not working for your environment, you can revert back to a previous build.

To program multiple images using UART interface, perform the following:

1. Follow the instructions for connecting to an Interface, UART port, Baud Rate, and Check Connection to communicate with the board (see 2.3 Programming the Evaluation Boards Using the GUI Application, page 32).

2. Select the Multiple Images button, and select the Firmware and Binaries to program the board. Click the Browse (...) buttons next to the Super Block and Current FW Version to download (see Figure 21, page 39 and Figure 22, page 40).

Figure 21 Select Super Block and Firmware Multiple Image Binaries - (UART)

NOTE: The Super Block and Current FW Version should be the latest version when programming multiple images.

1VV0301437 Rev 3.0 39 2019-02-01


3. Select the Super Block and Current FW Version to program the board (see Figure 22, page 40). For the Multiple Images, version 5.7.1 was selected.

Figure 22 Selecting Super Block and Current Firmware Version - (UART)

4. Once selected a message will display indicating that a valid Super Block and Firmware Image have been selected.

5. Select the Previous FW Version and/or Factory FW Version. Click the Browse (...) button next to the Previous FW Version and/or Factory FW Version. For the previous and factory firmware versions, 5.5.3 was selected (see Figure 23, page 41 and Figure 24, page 42).

1VV0301437 Rev 3.0 40 2019-02-01


Figure 23 Selecting Previous and Factory Firmware Versions - (UART)

1VV0301437 Rev 3.0 41 2019-02-01


Figure 24 Valid Multiple Images Selected - (UART)

6. Click the Erase and Program button. The GUI software will go through a process of programming the module flash with the current firmware and binaries, and previous and factory versions for Multiple Images. When complete a Green check will display indicating the flash has been programmed successfully (see Figure 25, page 43).

1VV0301437 Rev 3.0 42 2019-02-01


Figure 25 Programming Multiple Images Complete - (UART)


The GS2011M, GS2100M, GS2101M, or GS2200M is now ready to be verified. Refer to Chapter 3 Associating and Verifying, page 79.



1VV0301437 Rev 3.0 43 2019-02-01


2.4.2 Programming the Module Using 921600 Baud Rate - UARTTo program the GS2000 module on the evaluation board using Baud Rate 921600, perform the following:

1. Turn the ON/OFF switch on the evaluation board to the OFF position.

2. Install a jumper on,

a. Pin J25 on the GS2011M (see Figure 26, page 44) evaluation board,

b. Pin J13 on the GS2100M (see Figure 27, page 45) evaluation board,

c. Pin J13 on the GS2101M (see Figure 27, page 45) evaluation board, and

d. Pin J13 on the GS2200M (see Figure 28, page 46) evaluation board and then power ON the board.

Figure 26 GS2011M Baud Rate Jumper Settings - (UART)



NOTE: The Jumper does not need to be installed on the evaluation boards when programming the Flash using SPI Interface.

1VV0301437 Rev 3.0 44 2019-02-01




1VV0301437 Rev 3.0 45 2019-02-01




1VV0301437 Rev 3.0 46 2019-02-01


3. Select the Baud Rate 921600 (see Figure 29, page 47).

Figure 29 Selecting 921600 Baud Rate - (UART)

4. Continue with programming the Flash for Single or Multiple Images. Refer to 2.4 Programming the Module Using the UART Interface, page 34 and 2.4.1 Programming the Module With Multiple Images - UART, page 39.

5. When complete, turn the ON/OFF switch on the evaluation board to the OFF position.

6. Remove the jumper on pin J13 on the GS2011M evaluation board (see Figure 26, page 44) or pin J13 on the GS2100M (see Figure 27, page 45) evaluation board or pin J13 on the GS2200M evaluation board (see Figure 28, page 46).

7. Turn the PROGRAM/RUN switch to the RUN position. Turn the ON/OFF switch to the ON position. The evaluation board is now ready to be verified as well as accept AT commands. Refer to Chapter 3 Associating and Verifying, page 79.


NOTE: The board will not run if these jumpers are installed with the PROGRAM switch in RUN mode.

1VV0301437 Rev 3.0 47 2019-02-01


2.5 Programming the Module Using DOS for UART InterfaceThe following instructions are used to program the flash on the GS2011M, GS2100M, GS2101M and GS2200M evaluation boards using the DOS procedure for UART interface using different Baud Rates (115200 or 921600). The gs_flashprogram_DOS_UART_115K and 9121K scripts are located under the DOS folder (see Figure 30, page 48).

Figure 30 GS_Flashprogram DOS Script for 115200 or 921600 Baud Rate - (UART)

1VV0301437 Rev 3.0 48 2019-02-01


2.5.1 Programming the Module Using DOS 115200 Baud Rate - UART1. Select gs_flashprogram_DOS_Script_UART_115K and right-mouse click on the

batch file and select Edit. This will open the DOS script for UART 115K in a text editing tool like Notepad. Scroll down until you reach the SINGLEIMAGE script binary files (see Figure 31, page 49).

Figure 31 Edit gs_flashprogram DOS Script for 115200 Baud Rate - (UART)

1VV0301437 Rev 3.0 49 2019-02-01


2. Edit the binary file names (see Figure 32, page 50) to match the binary file names that where created in the build (see Figure 9, page 27) from the SDK Builder. For this example the names reflect the GS2011M.

Figure 32 Edited GS2011M Binary File Names for 115200 Baud Rate - (UART)

3. Click the Save button. To verify that the DOS script file has been updated, reopen the DOS folder under the gs2k_Flashprogram_Plus folder and reopen in Notepad.

1VV0301437 Rev 3.0 50 2019-02-01


4. Copy the two binary files from the build created with the SDK Builder to the DOS folder (see Figure 33, page 51). Refer to Figure 9, page 27 to for the binary files to be copied.

Figure 33 Copy Super Block and Firmware Binary Files to DOS Folder for 115200 Baud Rate - (UART)

1VV0301437 Rev 3.0 51 2019-02-01


5. To run the GainSpan flash program DOS version, double click on the DOS script UART batch file.

6. The GS Module Program Script screen will display (see Figure 34, page 52). For running UART, enter the COM port number assigned to the module and press the Enter key.

Figure 34 Running GS Module Program DOS Script for 115200 Baud Rate - (UART)

7. Press any key to continue programming the flash for UART (see Figure 35, page 53). This will take several minutes.

NOTE: Remove jumper on pin J25 on the GS2011M evaluation board, pin J13 on the GS2100M and pin J13 on the GS2200M evaluation board when selecting 115200 Baud Rate for DOS programming.

NOTE: If the evaluation board was not in PROGRAM mode, the programming utility will indicate a timeout.

1VV0301437 Rev 3.0 52 2019-02-01


Figure 35 Programming the Flash Using DOS for 115200 Baud Rate - (UART)

8. When complete, a message will display indicating the module is successfullyprogrammed. Press any key to close the DOS programming screen. Turn the ON/OFFswitch on the evaluation board to the OFF position.

Refer to Chapter 3 Associating and Verifying, page 79 to verify that the evaluation board has been programmed.

1VV0301437 Rev 3.0 53 2019-02-01


2.5.2 Programming the Module Using DOS 921600 Baud Rate - UART1. Select gs_flashprogram_DOS_Script_UART_921K and right click on the batch file

and select Edit. This will open the DOS script for UART 921K in a text editing tool like Notepad. Scroll down until you reach the SINGLEIMAGE script binary files (see Figure 36, page 54).

Figure 36 Edit gs_flashprogram DOS Script for 921600 Baud Rate - (UART)

1VV0301437 Rev 3.0 54 2019-02-01


2. Edit the binary file names (see Figure 37, page 55) to match the binary file names that where created in the build (see Figure 9, page 27) from the SDK Builder. For this example the names reflect the GS2011M.

Figure 37 Edited GS2011M Binary File Names for 921600 Baud Rate - (UART)

3. Click the Save button. To verify that the DOS script file has been updated, reopen the DOS folder under the gs2k_Flashprogram_Plus folder and reopen in Notepad.

1VV0301437 Rev 3.0 55 2019-02-01


4. Copy the two binary files from the build created with the SDK Builder to the DOS folder (see Figure 38, page 56). Refer to Figure 9, page 27 to for the binary files to be copied.

Figure 38 Copy Super Block and Firmware Binary Files to DOS Folder for 921600 Baud Rate - (UART)

1VV0301437 Rev 3.0 56 2019-02-01


5. To run the GainSpan flash program DOS version, double-click on the DOS script UART batch file.

6. The GS Module Program Script screen will display (see Figure 39, page 57). For running UART, enter the COM port number assigned to the module and press the Enter key.

Figure 39 Running GS Module Program DOS Script for 921600 Baud Rate - (UART)

7. Press any key to continue programming the flash for UART (see Figure 40, page 58). This will take several minutes.

NOTE: Install a jumper on pin J25 on the GS2011M evaluation board, pin J13 on the GS2100M and pin J13 on the GS2200M evaluation board when selecting 921600 Baud Rate for DOS programming.


1VV0301437 Rev 3.0 57 2019-02-01


Figure 40 Programming the Flash Using DOS for 921600 Baud Rate - (UART)

8. When complete, a message will display indicating the module is successfully programmed. Press any key to close the DOS programming screen. Turn the ON/OFF switch on the evaluation board to the OFF position.


1VV0301437 Rev 3.0 58 2019-02-01


2.6 Preparing the Evaluation Boards for SPI Interface


The following steps will guide you through programming the GS2011M evaluation board with the Serial-to-Wi-Fi binaries using the SPI Host Adapter:



3. Plug the ribbon cable into the SPI0 connector on the GS2011M board (see Figure 41, page 59).

4. Plug the USB 2.0 cable into the Cheetah SPI Host Adapter and plug the other end into a USB port on your computer (see Figure 41, page 59).

5. Download the Cheetah SPI Host Adapter Device Drivers (see 1.2 Requirements, page 20).



Figure 41 Setting Up the GS2011M Evaluation Board to Program Flash Using SPI

ALERT! Make sure you unplug/plug the mini-USB cable from the USB0 port and the Cheetah SPI Host Adapter from the SPI0 connector with the ON/OFF switch in the OFF position.


1VV0301437 Rev 3.0 59 2019-02-01



The following steps will guide you through programming the GS2100M evaluation board with the Serial-to-Wi-Fi binaries using the SPI Host Adapter (see 1.2 Requirements, page 20):











1VV0301437 Rev 3.0 60 2019-02-01














1VV0301437 Rev 3.0 61 2019-02-01






3. Plug the ribbon cable into the SPI0 connector on the GS2200M board (see Figure 42,page 60).

4. Plug the USB 2.0 cable into the Cheetah SPI Host Adapter and plug the other end intoa USB port on your computer (see Figure 42, page 60).

5. Download the Cheetah SPI Host Adapter Device Drivers (see 1.2 Requirements,page 20).


7. Turn the ON/OFF power switch on the GS2200M to the ON position. The ProgramFlash LED will be lit RED, indicating that the module is ready to be programmed.




1VV0301437 Rev 3.0 62 2019-02-01


2.7 Programming the Module Using the SPI InterfaceFor programming the GS2200M, GS2011M, GS2011MxxS, and GS2100M modules using SPI interface, perform the following:

1. Follow the instructions in 2.3 Programming the Evaluation Boards Using the GUI Application, page 32 to start the gs2k_flashprogram GUI application.

2. Select the SPI interface.

3. Click the Check Connection button. The software will communicate with the GS2200M, GS2011M or GS2100M evaluation board to check the connection and display the Module Specifications (Module Type and Mac Address of the module). A Green check will display at the bottom of the screen indicating the Connection and Communication with the board is successful (see Figure 45, page 63).

Figure 45 Communicating with the GainSpan Module - (SPI)

NOTE: When selecting SPI interface, the Port and Baud Rate will automatically be selected via the Cheetah SPI Host Adapter.

NOTE: Customers should not check the “Retain Dynamic File System” when first programming the modules from GainSpan's factory. The first programming should always erase all of flash memory. For subsequent programming “Retain Dynamic File System” can be selected to retain Live Calibration Data.

1VV0301437 Rev 3.0 63 2019-02-01


4. Select the Firmware and Binaries to program the board with a Single Image. Click the Browse (...) buttons next to the Super Block and Current FW Version to download (see Figure 46, page 64).

Figure 46 Select Super Block and Firmware Single Image Binaries - (SPI)

1VV0301437 Rev 3.0 64 2019-02-01


5. Select Single Image to program. This will program the module with a single firmware binary image. This is the default and recommended method (See Figure 47, page 65). For instructions on how to program the board with multiple images, refer to 2.7.1 Programming the Module With Multiple Images - SPI, page 68.

Figure 47 Select Single Image Firmware - (SPI)

1VV0301437 Rev 3.0 65 2019-02-01


6. Once selected, a message will display indicating that a valid Super Block and Firmware Image have been selected (see Figure 48, page 66).

Figure 48 Valid Super Block and Firmware Images Selected - (SPI)

1VV0301437 Rev 3.0 66 2019-02-01


7. Click the Erase and Program button. The GUI software will go through a process of programming the module flash with the new firmware and binaries. When complete a Green check will display indicating the flash has been programmed successfully (see Figure 49, page 67).

Figure 49 Programming Single Image Complete - (SPI)


The GS2200M, GS2011M or GS2100M is now ready to be verified. Refer to Chapter 3 Associating and Verifying, page 79.

To program the module flash using DOS for SPI, follow the instructions in 2.8 Programming the Module Using DOS for SPI Interface, page 73

.


1VV0301437 Rev 3.0 67 2019-02-01


2.7.1 Programming the Module With Multiple Images - SPIProgramming the evaluation board with multiple images is used when you want to have previous or factory default versions of firmware binaries programmed onto the same board. For example, if a current build isn’t working for your environment, you can revert back to a previous build.

To program multiple images, perform the following:

1. Select SPI Interface.

2. Click the Check Connection button. The software will communicate with theGS2200M, GS2011M or GS2100M evaluation board to check the connection anddisplay the Module Specifications (Module Type and Mac Address of the module). AGreen check will display at the bottom of the screen indicating the Connection andCommunication with the board is successful.

3. Select the Multiple Images button, and select the Firmware and Binaries to programthe board. Click the Browse (...) buttons next to the Super Block and Current FWVersion to download (see Figure 50, page 68 and Figure 51, page 69).

Figure 50 Select Super Block and Firmware Multiple Image Binaries - (SPI)

NOTE: The Super Block and Current FW Version should be the latest version when programming multiple images.

1VV0301437 Rev 3.0 68 2019-02-01


4. Select the Super Block and Current FW Version to program the board (see Figure 51, page 69). For the Multiple Images, version 5.7.1was selected.

Figure 51 Selecting Super Block and Current Firmware Version - (SPI)

5. Once selected a message will display indicating that a valid Super Block and Firmware Image have been selected.

6. Select the Previous FW Version and/or Factory FW Version. Click the Browse (...) button next to the Previous FW Version and/or Factory FW Version. For the previous and factory firmware versions, 5.5.3 was selected (see Figure 52, page 70 and Figure 53, page 71).

1VV0301437 Rev 3.0 69 2019-02-01


Figure 52 Selecting Previous and Factory Firmware Versions - (SPI)

1VV0301437 Rev 3.0 70 2019-02-01


Figure 53 Valid Multiple Images Selected - (SPI)

7. Click the Erase and Program button. The GUI software will go through a process ofprogramming the module flash with the current firmware and binaries, and previousand factory versions for Multiple Images. When complete a Green check will displayindicating the flash has been programmed successfully (see Figure 54, page 72).

1VV0301437 Rev 3.0 71 2019-02-01


Figure 54 Programming Multiple Images Complete - (SPI)

8. Click the Close button. Turn the ON/OFF switch to the OFF position. Turn thePROGRAM/RUN switch to the RUN position. Turn the ON/OFF switch back to theON position.

The GS2200M, GS2011M or GS2100M is now ready to be verified. Refer to Chapter 3 Associating and Verifying, page 79.



1VV0301437 Rev 3.0 72 2019-02-01


2.8 Programming the Module Using DOS for SPI InterfaceThe following instructions are used to program the flash on the GS2200M, GS2011M and GS2100M evaluation boards using the DOS procedure for SPI interface.

1. Locate the SPI script under the DOS folder (see Figure 55, page 73). The DOS folderis located under gs2k_flashprogram_plus directory.

Figure 55 GS_Flashprogram DOS Script - (SPI)

1VV0301437 Rev 3.0 73 2019-02-01


2. Select gs_flashprogram_DOS_Script_SPI and right-mouse click on the batch fileand select Edit. This will open the DOS script for SPI in a text editing tool likeNotepad. Scroll down until you reach the SINGLEIMAGE script binary files (seeFigure 56, page 74).

Figure 56 Edit gs_flashprogram DOS Script - (SPI)

NOTE: For Aardvark adapter use the flag “-A” in command line.

1VV0301437 Rev 3.0 74 2019-02-01


3. Edit the binary file names (see Figure 57, page 75) to match the binary file names thatwhere created in the build (see Figure 9, page 27) from the SDK Builder. For thisexample the names reflect the GS2011M.

Figure 57 Edited GS2011M Binary File Names - (SPI)

4. Click the Save button. To verify that the DOS script file has been updated, reopen theDOS folder under the gs2k_Flashprogram_Plus folder and reopen in Notepad.

1VV0301437 Rev 3.0 75 2019-02-01


5. Copy the two binary files from the build created with the SDK Builder to the DOSfolder (see Figure 58, page 76). Refer to Figure 9, page 27 to for the binary files to becopied.

Figure 58 Copy Super Block and Firmware Binary Files to DOS Folder - (SPI)

1VV0301437 Rev 3.0 76 2019-02-01


6. To run the GainSpan flash program DOS version, click on the DOS script SPI batchfile.

7. The GS Module Program Script screen will display (see Figure 59, page 77). Forrunning SPI, you do not need to enter a COM port number.

Figure 59 Running GS Module Program Script for DOS - (SPI)

8. Press any key to continue programming the flash for SPI (see Figure 60, page 78).This will take several minutes.

NOTE: The Cheetah SPI Host Adapter must be connected to the GainSpan board when running the DOS GS Module Program Script for SPI.


1VV0301437 Rev 3.0 77 2019-02-01


Figure 60 Programming the Flash Using DOS - (SPI)

9. When complete, a message will display indicating the module is successfullyprogrammed.

10. Press any key to close the DOS programming screen. Turn the ON/OFF switch on theevaluation board to the OFF position.


NOTE: The Cheetah SPI Host Adapter must be connected to the GainSpan board when programming the Flash using DOS and SPI.

NOTE: The default clock speed using SPI is 1.3MHz. You can change the clock speed in gs_flashprogram tool Help screen by following the instructions.

1VV0301437 Rev 3.0 78 2019-02-01


Chapter 3 Associating and Verifying

This chapter provides instructions on associating a GainSpan® GS2000 based module evaluation board to a communication port using Tera Term VT terminal emulator.

• Connecting the Evaluation Board to a Serial COM Port, page 79

3.1 Connecting the Evaluation Board to a Serial COM PortTo set up the GS2000 based module evaluation board for Serial-to-Wi-Fi or Temperature and Light Sensor application, perform the following:

1. Turn the PROGRAM/RUN switch to the RUN position.

2. Open the Tera Term VT application from your desktop and select the serial port (COMport) that was assigned to the evaluation board (see Figure 61, page 79).

Figure 61 Connect the Evaluation Board to a Serial Port (COM Port)

NOTE: If selecting 921600 Baud Rate when programming the Flash, make sure that jumpers J25 (GS2011M), J13 (GS2100M) and J13 (GS2200M) are removed. The board will not run if these jumpers are installed with the PROGRAM switch in RUN mode.

NOTE: The Tera Term VT software application is included with the EVK and SDK package.

1VV0301437 Rev 3.0 79 2019-02-01


3. Select the Serial Port (COM) settings for Serial-to-Wi-Fi (see Figure 62, page 80).

Figure 62 Select the Serial Port (COM) Settings for S2W

The Serial Port (COM) settings for Serial-to-Wi-Fi are as follows:

– Port: COMx (x is the number of the COM port)

– Baud Rate: 9600

– Data: 8 bit

– Parity: none

– Stop: 1 bit

– Flow Control: none

NOTE: The Serial Port (COM) should match the port identified.

NOTE: If the user builds firmware with a different default baud rate, then choose that baud rate in the above step.

1VV0301437 Rev 3.0 80 2019-02-01


4. Turn the ON/OFF switch on the evaluation board to the ON position. Figure 63, page 81 shows the Tera Term VT window with the “Serial2Wi-Fi APP” ready prompt.

Figure 63 Serial-to-Wi-Fi Application Ready Prompt

5. Start the Serial-to-Wi-Fi Application (see Chapter 4 Starting the Serial-to-Wi-Fi Application, page 83).

1VV0301437 Rev 3.0 81 2019-02-01


- This page intentionally left blank -

1VV0301437 Rev 3.0 82 2019-02-01


Chapter 4 Starting the Serial-to-Wi-Fi Application

This chapter provides instructions on how to start the Serial-to-Wi-Fi (S2W) application and communicate with the evaluation board.

• Communicating with the Evaluation Board, page 83

4.1 Communicating with the Evaluation BoardTo start the Serial-to-Wi-Fi application, perform the following:

1. In the Tera Term VT window enter the following command to verify the firmware version.

AT+VER=??

The evaluation board will respond back with Serial-to-Wi-Fi firmware version information (see Figure 64, page 83).

Figure 64 Serial-to-Wi-Fi Firmware Information

NOTE: When modules are re-programmed on the evaluation board, the MAC ID will be erased. To update the MAC ID to match the number on the module label, issue the command AT+NMAC=<mac address>.

1VV0301437 Rev 3.0 83 2019-02-01


2. The evaluation board is now ready for additional Serial-to-Wi-Fi commands to be issued. Figure 65, page 84 shows a sample output of the evaluation board connected to an access point DHCP server.

Figure 65 Receiving an IP Address from the Access Point DHCP Server

For more information on how to setup the GS2000 based module evaluation board, refer to the GainSpan Evaluation Board Quick Start Guide.

For step-by-step procedures on how to evaluate S2W or TLS firmwares, refer to the following documents:

– GainSpan GS2000 Based Module Sample Examples (for using Serial-to-Wi-Fi AT Commands to Create TCP and UDP Connection)

– GainSpan GS2000 Based Module Configuration Examples (for using Serial-to-Wi-Fi Commands to Create HTTP, HTTPS, and EAP Connections)

– Temperature and Light Sensor (TLS) Demo Application Note

1VV0301437 Rev 3.0 84 2019-02-01


Appendix A Dumping Flash Memory Commands

This appendix details the DOS commands required for dumping flash memory for the GainSpan® GS2K evaluation boards.

The following sections are covered in this appendix:

• Prerequisites, page 85

• Configuring Flash Commands, page 85

A.1 PrerequisitesTo program the flash memory in GS2K modules, perform the following:

1. Put the GS node in PROGRAM mode (Switch SW8:2011/2200 and SW7:2100/2101

2. Short the jumper J13 (programming 921K baud rate)

3. Perform a power cycle in the EVB (SW6:2011/2200 and SW1:2100/2101)

4. Open the flash programmer tool from the downloaded SDK package available at location <SDK Package>\Tools\GS_programming_tool\gs2k_flashprogram.exe and program the module.

For more information on how to program the module flash, refer to the Chapter 2 Programming Modules on the Evaluation Board.

A.2 Configuring Flash Commands

A.2.1 Reading 2MB flash memory to a fileThe following command allows to read serial flash memory to a file, using a 921K Baud rate:

Command Syntax gs_flashprogram.exe -r 0x00 0x200000 -x -l <File Name> -S<ComPort> –v

gs_flashprogram.exe -r 0x00 0x200000 -x -l 2MBFile_921K -S4 –v

Where,

NOTE: Type “-h” or “-?” for help information regarding DOS commands.Example: gs_flashprogram.exe -h

1VV0301437 Rev 3.0 85 2019-02-01


-r - Read flash address range (For example, Read 0x200000 bytes from the Flash starting from address 0x00)

-x - Baud rate (Use 921600 Baud rate)

-l - File name. It is used to specify dumping data to a binary file. (For example, for dumping data into a file 2MBFile_921K, use -l 2MBFile_921K)

-S - Serial (COM) port number (For example, for COM4 enter '4')

-v - Verbose output.

A.2.2 Writing 2MB file to flash memoryThe following command allows to write file to a serial flash memory, using a 921K Baud rate:

Command Syntax gs_flashprogram.exe -x -t 0x0 -f 0x00 -1 <FileName> -S<ComPort> -v

Example gs_flashprogram.exe -x -t 0x0 -f 0x00 -1 2MBFile_921K.bin -S4 -v

Where,


-t - SRAM start address

-f - Flash start address

-l - File name. It is used for programing the dumped firmware image (For example, 2MBFile_921K.bin) into flash.

-S - Serial (COM) port number. (For example, for COM4 enter '4')

-v - Verbose Output

A.2.3 Reading 4MB flash memory to a fileThe following command allows to read serial flash memory to a file, using a 921K Baud rate:

Command Syntax gs_flashprogram.exe -r 0x00 0x400000 -x -l <FileName> -S<ComPort> -v

Example gs_flashprogram.exe -r 0x00 0x400000 -x -l 4MBFile_921K -S4 -v

Where,

-r - Read flash address range (For example, read 0x400000 bytes from the flash starting from address 0x00)


-l - File name. It is used to specify dumping data to a binary file. (For example, for dumping data into a file 4MBFile_921K, use -l 4MBFile_921K)

-S - Serial (COM) port number. (For example, for COM4 enter '4')

1VV0301437 Rev 3.0 86 2019-02-01


-v - Verbose Output

A.2.4 Writing 4MB file to a flash memoryThe following command allows to write file to a serial flash memory, using a 921K Baud rate:

Command Syntax gs_flashprogram.exe -x -t 0x0 -f 0x00 -1 <FileName> -S<ComPort> -v

Example gs_flashprogram.exe -x -t 0x0 -f 0x00 -1 4MBFile_921K.bin -S4 -v

Where,


-t - SRAM start address

-f - Flash start address

-l - File name. It is used for programing dumped firmware image (For example, 4MBFile_921K.bin) into flash

-S - Serial (COM) port number (For example, for COM4 enter '4')

-v - Verbose Output

NOTE: When programming at 115K baud rate, remove jumper J13 from the EVB and “-x” option from the commands:

For example:

Reading 4MB Flash to a File using 115K:gs_flashprogram.exe -r 0x00 0x400000 -l 4MBFile_115K.bin -S4 -v

Writing 4MB File to Flash using 115K:gs_flashprogram.exe -t 0x0 -f 0x00 -1 4MBFile_115K.bin -S4 -v

1VV0301437 Rev 3.0 87 2019-02-01