Freescale Semiconductor 802.15.4/Zigbee Manuale utente

802.15.4/Zigbee

Embedded Bootloader

Reference Manual

802154EBRM/D

Rev. 0.0, 09/2004

Freescale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0

How to Reach Us:

USA/Europe/Locations Not Listed:

Freescale Semiconductor Literature Distribution Center

P.O. Box 5405

Denver, Colorado 80217

1-800-521-6274 or 480-768-2130

Japan:

Freescale Semiconductor Japan Ltd.

Technical Information Center

3-20-1, Minami-Azabu, Minato-ku

Tokyo 106-8573, Japan

81-3-3440-3569

Asia/Pacific:

Freescale Semiconductor Hong Kong Ltd.

2 Dai King Street

Tai Po Industrial Estate

Tai Po, N.T., Hong Kong

852-26668334

Home Page:

www.freescale.com

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

circuits or integrated circuits based on the information in this document.

Freescale Semiconductor reserves the right to make changes without further notice

to any products herein. Freescale Semiconductor makes no warranty, representation

or guarantee regarding the suitability of its products for any particular purpose, nor

does Freescale Semiconductor assume any liability arising out of the application or

use of any product or circuit, and specifically disclaims any and all liability, including

without limitation consequential or incidental damages. “Typical” parameters that may

be provided in Freescale Semiconductor data sheets and/or specifications can and

do vary in different applications and actual performance may vary over time. All

operating parameters, including “Typicals”, must be validated for each customer

application by customer’s technical experts. Freescale Semiconductor does not

convey any license under its patent rights nor the rights of others. Freescale

Semiconductor products are not designed, intended, or authorized for use as

components in systems intended for surgical implant into the body, or other

applications intended to support or sustain life, or for any other application in which

the failure of the Freescale Semiconductor product could create a situation where

personal injury or death may occur. Should Buyer purchase or use Freescale

Semiconductor products for any such unintended or unauthorized application, Buyer

shall indemnify and hold Freescale Semiconductor and its officers, employees,

subsidiaries, affiliates, and distributors harmless against all claims, costs, damages,

and expenses, and reasonable attorney fees arising out of, directly or indirectly, any

claim of personal injury or death associated with such unintended or unauthorized

use, even if such claim alleges that Freescale Semiconductor was negligent

regarding the design or manufacture of the part.

Learn More: For more information about Freescale products, please visit

www.freescale.com.

Freescale™ and the Freescale logo are trademarks of Freescale Semiconductor, Inc.

All other product or service names are the property of their respective owners.

Contents

Freescale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 iii

About This Book..................................................................................................................... vi

Audience ......................................................................................................................................................vi

Organization.................................................................................................................................................vi

Conventions ................................................................................................................................................vii

Definitions, Acronyms, and Abbreviations.................................................................................................vii

References..................................................................................................................................................viii

Revision History ........................................................................................................................................viii

Chapter 1 Embedded Bootloader Description.................................................................... 1-1

1.1 Target............................................................................................................................................1-1

1.1.1 Ported Targets ...............................................................................................................................1-2

1.2 Features.........................................................................................................................................1-3

1.3 Benefits .........................................................................................................................................1-3

1.4 Potential Issues .............................................................................................................................1-3

1.4.1 Optional Firmware Upload Settings .............................................................................................1-4

Chapter 2 Using the Embedded Bootloader........................................................................ 2-1

2.1 Upload Firmware ..........................................................................................................................2-1

2.1.1 Use Case One................................................................................................................................2-1

2.1.2 Use Case Two ...............................................................................................................................2-2

2.1.3 Safe Mode Boot ............................................................................................................................2-2

2.2 Updating Non-volatile Memory (NVM).......................................................................................2-3

2.2.1 An Example of How to Change the MAC Address ......................................................................2-3

2.3 System Bus Frequency..................................................................................................................2-4

2.4 UART Baud Rate..........................................................................................................................2-4

Chapter 3 Test Tool – Zigbee Flash Tool............................................................................. 3-1

3.1 Graphical User Interface (GUI) Version.......................................................................................3-2

3.1.1 Using the Tools Menu Option.......................................................................................................3-2

3.1.2 Using the View Menu Option.......................................................................................................3-3

3.1.3 Selecting the Firmware File to Upload .........................................................................................3-4

3.1.4 Using the Help Menu....................................................................................................................3-6

3.1.5 Changing the NVM Data in Flash or File.....................................................................................3-6

3.2 Command Line Version (CMD) ...................................................................................................3-8

iv Embedded Bootloader Reference Manual, Rev 0.0 Freescale Semiconductor

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 ................................................................................4-1

4.2 Upgrading The Embedded Bootloader .........................................................................................4-5

Chapter 5 Application Integration Reference Guide........................................................... 5-1

5.1 Product Deliverables.....................................................................................................................5-1

5.1.1 Embedded Bootloader Image........................................................................................................5-1

5.1.2 Application Support Files .............................................................................................................5-1

5.1.3 Application Linker File.................................................................................................................5-2

5.2 Application....................................................................................................................................5-2

5.2.1 Compiler Defines..........................................................................................................................5-2

5.2.2 Unreferenced Symbols..................................................................................................................5-2

5.2.3 System Clock Setup ......................................................................................................................5-3

5.3 Application Support Files .............................................................................................................5-3

5.3.1 DigiType.h ....................................................................................................................................5-3

5.3.2 Gb60_io.h .....................................................................................................................................5-3

5.3.3 Crt0.c and Crt.h.............................................................................................................................5-4

5.3.4 Embedded_Bootloader.h and Embedded_Bootloader.c ...............................................................5-5

5.3.5 NV_Data.c and NV_Data.h ..........................................................................................................5-5

5.3.6 ISR_Vectors.c ...............................................................................................................................5-5

5.3.7 DummyIsr.c ..................................................................................................................................5-6

Chapter 6 Port Integration Reference Guide....................................................................... 6-1

6.1 Embedded Bootloader Build Environment...................................................................................6-1

6.1.1 HCS08 Compiler...........................................................................................................................6-1

6.1.2 HCS08 Linker ...............................................................................................................................6-1

6.1.3 HCS08 LibMaker..........................................................................................................................6-1

6.2 Product Deliverables.....................................................................................................................6-2

6.2.1 Embedded_Bootloader.mcp..........................................................................................................6-2

6.2.2 HCS08_Flash_Lib.Lib..................................................................................................................6-2

6.2.3 Embedded_Bootloader_Functionality_Lib.Lib ............................................................................6-2

6.2.4 Source Files...................................................................................................................................6-2

Freescale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 v

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.........................................................................................................................6-3

6.4 Source Files...................................................................................................................................6-4

6.4.1 Target.h.........................................................................................................................................6-4

6.4.2 Reset_Vector.c..............................................................................................................................6-5

6.4.3 Embedded_Bootloader_Target.h ..................................................................................................6-5

6.4.4 HW_Init.h .....................................................................................................................................6-6

6.4.5 HW_Init.c .....................................................................................................................................6-6

6.4.6 main.c............................................................................................................................................6-6

Chapter 7 Embedded Bootloader Public Function Description......................................... 7-1

7.1 802.15.4/Zigbee Application Accessible Functions .....................................................................7-1

7.1.1 Enable_Download_Firmware .......................................................................................................7-1

7.1.2 Hard_Reset....................................................................................................................................7-3

7.1.3 Update_NV_RAM ........................................................................................................................7-3

7.1.4 NV_Flash_Setup...........................................................................................................................7-4

7.1.5 FL_ICG_Setup..............................................................................................................................7-4

7.1.6 UART_Port_Select .......................................................................................................................7-5

Chapter 8 Embedded Bootloader Memory Map.................................................................. 8-1

Appendix A Release Folder and File Structure...................................................................A-1

A.1. Folder Structure ...........................................................................................................................A-1

A.2. File Structure................................................................................................................................A-2

vi Embedded Bootloader Reference Manual, Rev 0.0 Freescale Semiconductor

About This Book

This guide provides a detailed description of Freescale’s Embedded Bootloader and describes how to port

Freescale’s 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 inexpensive way to upload new firmware and eliminate

the requirements for expensive debug/development tools. The only requirement is a standard PC with an

RS232 UART/USB interface running Windows 2000 or XP.

The Embedded Bootloader must be used with the Zigbee Flash Tool which can be found in the Test Tool

Suite ‘Test Tool.exe’.

This document describes Embedded Bootloader version 5.01.

Audience

This document is intended for application developers.

Organization

This document is organized into eight chapters and one appendix.

Chapter 1 Embedded Bootloader Description — This chapter gives an overview of the

Embedded Bootloader.

Chapter 2 Using the Embedded Bootloader — This chapter describes the basic

functionality of the Embedded Bootloader.

Chapter 3 Test Tool, Zigbee Flash Tool — This chapter describes the Zigbee Flash Tool.

The GUI and Command Line versions are covered.

Chapter 4 Programming the Embedded Bootloader — This chapter describes how to

program the Embedded Bootloader to flash memory.

Chapter 5 Application Integration Reference Guide — This chapter describes the

deliverables required to build an 802.15.4/Zigbee Application with the

Embedded Bootloader.

Chapter 6 Port Integration Reference Guide — This chapter describes the deliverables

required and how to integrate them to make an executable Embedded

Bootloader for a specific PCB.

Chapter 7 Embedded Bootloader Public Function Description — This chapter provides

a description of the, from an 802.15.4/Zigbee application, accessible functions

in the Embedded Bootloader.

Chapter 8 Memory Map — This chapter describes the Bootloader Memory Map.

Appendix A Release Folder and File Structure — This appendix shows the folder and file

structure for this release.

Freescale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 vii

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

EVB Evaluation Boards - this term covers the DIG-528-2 (EVK) and DIG536-2

(SARD) boards.

EVK Evaluation Kit

GUI Graphical User Interface

MAC Medium Access Control

MCU MicroController Unit

NVM None-Volatile Memory

PC Personal Computer

PCB Printed Circuit Board

S19 ‘S19’ is the file extension used for the Motorola binary image format. The S19

file encapsulates the binary image as a list of ASCII records. Each record

contains a length -, address -, data - and checksum field. The 16 bit address field

allows a memory space for up to 64 KB. The S19 can be generated with

Metroworks Codewarrior IDE and is the product from the linking process. S19

does not contain additional information to a debugger (where to look for source

files).

Safe Mode Boot The Embedded Bootloader boots up using safe default system values.

HIWAVE P&E HCS08 debugger GUI.

CPROG P&E HCS08 flash programming tool called from HIWAVE. The tool is also

available in a command line version where scripts can be made.

viii Embedded Bootloader Reference Manual, Rev 0.0 Freescale Semiconductor

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 User’s Guide, MC13192FLUG/D

[7] Freescale Switch Demo Application, AN2773/D

Revision History

The following table summarizes revisions to this manual since the previous release (Rev. 0.0).

Revision History

Location Revision

Entire Document This document supercedes revision 2.4 of the

Freescale Embedded Bootloader User’s Guide,

MC13192FLUG/D.

Freescale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 1-1

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 with an

RS232 UART/USB1) interface running Windows 2000 or XP.

The Embedded Bootloader must be used with the Zigbee Flash Tool which can be found in the Test Tool

Suite ‘Test Tool.exe’.

This document describes Embedded Bootloader version 5.01.

The Embedded Bootloader is located in a protected 4 KB flash block in the highest memory area

(0xF000-0xFFFF) of the Freescale MC908HCS08GB60/GT60 microcontroller. (It cannot be accidentally

erased.) A BDM debugger is required to erase the Embedded Bootloader. See the Handling MAC Address

Erasure Application Note, AN2825/D

1) At least one of these communication interfaces must be supported by the target PCB.

1.1 Target

The Embedded Bootloader runs on the Freescale MC908HCS08GB60/GT60 MCU.

The MC908HCS08GB60/GT60 is a member of Freescale’s low-cost, high-performance HCS08 family. It

has 60 KB embedded flash (flash sector size of 512 bytes) and 4 KB embedded RAM..

The Embedded Bootloader uses the MC13192 CLKO. See Chapter 2 for more information.

1-2 Embedded Bootloader Reference Manual, Rev 0.0 Freescale Semiconductor

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-3 on COM1-port (SCI1)

• Version Number “528&536 Ver 5.01”

DIG536-2 SARD

• PC Communication Interface: RS232/UART on COM1 (SCI1)

• Safe Mode Boot Short pins 2-3 on COM1-port (SCI1)

• Version Number “528&536 Ver 5.01”

RD01

• PC Communication Interface: RS232/UART/USB on COM1 (SCI1)/

RS232/UART/USB on COM2 (SCI2)

• Safe Mode Boot Short pins 2-3 on COM1 (SCI1)/

COM2 (SCI2)

• Version Number “ RD01 Ver 5.01”

NOTE

The generic RD01 target can be used with any PCB using the Freescale

Reference Design version 01 I/O layout. The PCB must support at least

one communication interface. If a USB is the only interface, use a

jumper to short SCI pins 2 and 3 to make Safe Mode Boot available.

Refer to Section 6.3 for details on how to port the Embedded Bootloader to a specific PCB.

Indice

Altri manuali Freescale Semiconductor Hardware per computer

Freescale Semiconductor

Freescale Semiconductor MPC8349E PowerQUICC II Pro Manuale utente

Freescale Semiconductor

Freescale Semiconductor MPC8260 PowerQUICC II Family Manuale utente

Freescale Semiconductor

Freescale Semiconductor i.MX31 PDK 1.4 Manuale utente

Freescale Semiconductor

Freescale Semiconductor MTRCKTSPS5604P Manuale utente

Freescale Semiconductor

Freescale Semiconductor MPC850 Manuale utente

Freescale Semiconductor

Freescale Semiconductor MMA9559L Manuale utente

Freescale Semiconductor

Freescale Semiconductor MC9S08PT60 Manuale utente

Freescale Semiconductor

Freescale Semiconductor MCF5480 Manuale utente

Freescale Semiconductor

Freescale Semiconductor SC140 DSP Core Manuale utente

Freescale Semiconductor

Freescale Semiconductor MC68HC08KH12 Manuale utente

Freescale Semiconductor

Freescale Semiconductor Target Interface MMDS0508 Manuale utente

Freescale Semiconductor

Freescale Semiconductor i.MX 6SoloLite Linux Manuale utente

Freescale Semiconductor

Freescale Semiconductor metrowerks CodeWarrior Manuale utente

Freescale Semiconductor

Freescale Semiconductor PowerQUICC III Istruzioni per l'installazione e il funzionamento

Freescale Semiconductor

Freescale Semiconductor MED-EKG Manuale utente

Freescale Semiconductor

Freescale Semiconductor TWR-K60D100M Manuale utente

Freescale Semiconductor

Freescale Semiconductor TWR-LS1021A Manuale utente

Freescale Semiconductor

Freescale Semiconductor NXP 56F8014 Manuale utente

Freescale Semiconductor

Freescale Semiconductor MPC8272ADS Manuale utente

Freescale Semiconductor

Freescale Semiconductor TWR-MPC8309 Manuale utente

Freescale Semiconductor

Freescale Semiconductor MPC8349EA MDS Manuale utente

Freescale Semiconductor

Freescale Semiconductor FRDM-STBC-SA9500 Guida di riferimento

Freescale Semiconductor

Freescale Semiconductor MPC8349EA PowerQUICC II Pro Manuale utente

Freescale Semiconductor

Freescale Semiconductor Motorola MMDS0508 Manuale utente

Manuali Hardware per computer popolari di altre marche

EMC2

EMC2 VNX Series Manuale del proprietario

Panasonic

Panasonic DV0PM20105 Manuale utente

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 Manuale utente

Gigabyte

Gigabyte B660M DS3H AX DDR4 Manuale utente

Raidon

Raidon iT2300 Manuale utente

National Instruments

National Instruments PXI-8186 Manuale utente

Hauppauge

Hauppauge WinTV-HVR-2250 Manuale utente

Kontron

Kontron CP6002 Manuale utente

Manhattan

Manhattan 702843 Manuale utente

Aphex

Aphex 230 Manuale utente

AMD

AMD Phenom II Manuale operativo

Intel

Intel NUC 12 Pro Manuale utente

dbx

dbx Zone Pro 1260 Manuale utente

Galaxy

Galaxy GHDX2-2430S-24F4D Manuale utente

Intel

Intel AXXRMFBU4 Manuale utente

Kontron

Kontron DIMM-PC/MD Manuale utente

ST X-NUCLEO-SAFEA1B Istruzioni operative

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 Manuale utente