Summary of the content on the page No. 1
802.15.4/Zigbee
Embedded Bootloader
Reference Manual
802154EBRM/D
Rev. 0.0, 09/2004
Summary of the content on the page No. 2
How to Reach Us: Information in this document is provided solely to enable system and software implementers to use Freescale Semiconductor products. There are no express or implied copyright licenses granted hereunder to design or fabricate any integrated USA/Europe/Locations Not Listed: circuits or integrated circuits based on the information in this document. Freescale Semiconductor Literature Distribution Center P.O. Box 5405 Freescale Semiconduc
Summary of the content on the page No. 3
Contents About This Book ..................................................................................................................... vi Audience ......................................................................................................................................................vi Organization.................................................................................................................................................vi Conventions ..............
Summary of the content on the page No. 4
3.2.1 Normal Use Example (Default) ....................................................................................................3-9 3.2.2 Flash Erase Disabled Example......................................................................................................3-9 Chapter 4 Embedded Bootloader Programming................................................................. 4-1 4.1 Programming To An Empty (Erased) Board ..............................................................
Summary of the content on the page No. 5
6.3 Porting to a Specific Target ..........................................................................................................6-3 6.3.1 Code and Data Segments ..............................................................................................................6-3 6.3.2 Standard Libraries.........................................................................................................................6-3 6.3.3 Compiler #defines.....................................
Summary of the content on the page No. 6
About This Book This guide provides a detailed description of Freescales Embedded Bootloader and describes how to port Freescales Embedded Bootloader to a specific PCB/target.. The Embedded Bootloader is intended for use with the IEEE® 802.15.4 evaluation kits (EVK). However, it is possible to upload applications with the Embedded Bootloader in the development phase, but the Embedded Bootloader will not provide any debug functions. The Embedded Bootloader provides an easy and inexpensi
Summary of the content on the page No. 7
Conventions This document uses the following notational conventions: • Courier monospaced type indicates commands, command parameters, code examples, expressions, data types, and directives. • Italic type indicates replaceable command parameters. • All source code examples are in C. Definitions, Acronyms, and Abbreviations BDM debugger A debugger using the BDM interface for communication with the MCU. An example is the P&E BDM Multilink debugger for HCS08. BDM Background Debug Module
Summary of the content on the page No. 8
References [1] Freescale 802.15.4 MAC/PHY Software Reference Manual, 802154MPSRM/D [2] Zigbee.hlp (see Test Tool installation directory .\help) [3] Freescale MC908HCS08GB60/GT60 MCU Data Sheet, MC9S08GB60/D [4] Freescale Application Note, Handling MAC Address Erasure, AN2825/D [5] Freescale Application Note, Zigbee/802.15.4 Evaluation Kit, Quick Start Guide, AN2772/D [6] Freescale Embedded Bootloader Users Guide, MC13192FLUG/D [7] Freescale Switch Demo Application, AN2773/D Revisio
Summary of the content on the page No. 9
Chapter 1 Embedded Bootloader Description The Embedded Bootloader is intended for use with the IEEE® 802.15.4 evaluation kits (EVK). However, it is possible to upload applications with the Embedded Bootloader in the development phase, but the Embedded Bootloader will not provide any debug functions. The Embedded Bootloader provides an easy and inexpensive way to upload new firmware and eliminate the requirements for expensive debug/development tools. The only requirement is a standard PC
Summary of the content on the page No. 10
1.1.1 Ported Targets The Embedded Bootloader must be ported (I/O mapped) to a specific PCB for proper functionality and is currently ported to the following Freescale PCBs: Axiom AXM-0308: • PC Communication Interface: RS232/UART on COM1 (SCI1)/ RS232/UART on COM2 (SCI2) • Safe Mode Boot Short pins 2-3 on COM1 (SCI1)/ COM2 (SCI2) • Version Number AX-0308 Ver 5.01 DIG528-2 EVK • PC Communication Interface: RS232/UART on COM1 (SCI1)/ USB (SCI2) • Safe Mode Boot Short pins 2-
Summary of the content on the page No. 11
1.2 Features The following features are supported: • Upload firmware (802.15.4/Zigbee application) in Motorola S19 record format through UART/USB. The S1 data record length must be set to 32 bytes • Auto-Detection of the PC communication interface (see Section 1.1.1, Ported Targets). • Initialize memory including stack of uploaded firmware • Initialize the system clock. Self clocked mode and MC13192 clock setup. Power save mode supported • Run time update/change of the NVM NOTE See
Summary of the content on the page No. 12
1.4.1 Optional Firmware Upload Settings • Skip flash erase o Disabled The 802.15.4/Application/NVM (except production data section) is erased (default) o Enabled The 802.15.4/Application/NVM is NOT erased • Erase production data (get production data from firmware file) o Disabled The production data section (with MAC address) in NVM are preserved. All other NVM values are updated with the values from the S19 record file (default) o Enabled The production data (with MAC address)
Summary of the content on the page No. 13
Chapter 2 Using the Embedded Bootloader This chapter describes the Embedded Bootloader functionality. A detailed description of the functions briefly mentioned in this chapter can be found in Chapter 7. 2.1 Upload Firmware The Embedded Bootloader can be used in different system configurations depending on the PCB and the application. The application should have a user interface feature that makes it possible for the application to call the Enable_Download_Firmware() function: The appli
Summary of the content on the page No. 14
2.1.2 Use Case Two In this use case, users push a button on the board to enable firmware upload. (1) MC908HCS08GB60 /MC13192 B Application o o NVM t l 802.15.4 MAC o a User Interface
Summary of the content on the page No. 15
7. Remove short from UART TX and RX and connect UART cable again (if the RS232 UART interface is used) 8. Power up again 9. Embedded Bootloader is ready to receive new firmware (all LEDs on) 10. Start the PC-Tool. See Chapter 3, for more information. NOTE The Safe Mode Boot description is only valid for the Freescale ported versions of the Embedded Bootloader. Refer to the 802.15.4 Embedded Bootloader Reference Manual, 802154EBRM/D, for more details about a specific port of the Emb
Summary of the content on the page No. 16
2.3 System Bus Frequency The MC908HCS08GB60/GT60 starts in 4 MHz self clocked mode. The init code changes this to 8 MHz after a few instructions from reset. If NVM data is found, the system clock (MC908HCS08GB60/GT60 ICG module and MC13192 CLKO) and other options are setup as specified by the uploaded application. See the Freescale 802.15.4 MAC/PHY Software Reference Manual, 802154MPSRM/D, for more details. If no NVM data can be found, the following (safe mode boot) values are used: •
Summary of the content on the page No. 17
Chapter 3 Test Tool – Zigbee Flash Tool The Zigbee flash tool is a part of the general Zigbee Test Tool. This chapter provides a brief description of how to use the Zigbee Test Tool to upload new firmware. For more details about installation and other features, see the documentation for the Zigbee Test Tool and the Zigbee.hlp file in Test Tool installation directory .\help. The flash programming part of the Test Tool can be used with two different user interfaces. 1. The GUI-version in
Summary of the content on the page No. 18
3.1 Graphical User Interface (GUI) Version To use the GUI version of the Test Tool, execute the following file: [installation directory]\Freescale\Test Tool\Test Tool.exe 3.1.1 Using the Tools Menu Option After clicking on the Tools menu option, click the Communication Settings option to choose the baud rate specified for the current embedded application. Notice that applications require that you push one or more buttons or some other functions to enable upload of new firmware. See the
Summary of the content on the page No. 19
3.1.2 Using the View Menu Option After clicking the View menu option, select port COMx and click OK. Choose the baud rate specified for the current embedded application. See the Zigbee/802.15.4 Evaluation Kit Quick Start Guide, AN2772/D, for a description of what to do for a specific application. If no application is uploaded, you must use the default settings specified for the Embedded Bootloader. See Chapter 2 for more information. NOTE If the USB interface is used, the USB optio
Summary of the content on the page No. 20
3.1.3 Selecting the Firmware File to Upload In the Flash Section window, click on the application file to upload and then click on the Upload button. The upload progress bar begins to indicate upload progress. Upload Application Upload Button Progress Field Files Status/Error Information Field Figure 5 Firmware Upload The Status/Error Information Field shows the Status/Error Information received from the Embedded Bootloader. 3-4 Embedded Bootloader Ref
