Freescale Semiconductor 802.15.4 manual

802.15.4/Zigbee Embed ded Bootloader Reference Manual 802154EBRM/D Rev. 0.0, 09/ 2004[...]

Freesc ale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 2 How to Reach Us: USA/Europe/Locations Not Listed: Freescale S emiconduc tor Lit erat ure Di stribut ion Center P.O. B ox 5405 Denver, Colorado 80217 1-800-521-6274 or 480-768-2130 Japan: Freescale S em iconduc t or J apan Ltd. Technical I nformati on Cent er 3-20-1, Minami -A[...]

Contents Freesc ale Semiconductor Embedded Bootloader Reference Manual, Rev. 0.0 iii About This Book ................................................................................................................ ..... vi Audience ......................................................................................................................[...]

iv Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 3.2.1 Normal Use Exam ple (Def ault) ................................................................................................... .3 - 9 3.2.2 Flash Erase Di sabled Example................................................................................................[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 v 6.3 Porting to a Sp ecific Target ................................................................................................... ....... 6-3 6.3.1 Code and Data Seg m ents ..............................................................................................[...]

vi Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor About This B ook This guide provides a detailed description of Freescale’s Em bedded Bootloader and describes how to port Freescale’s Embedded B ootloader to a specific PCB/targ et.. The Embedded Bootloader is intended f or use with the IEEE® 802.15.4 evaluation kits (E[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 vii Conventions This document uses the following notational conventions: • Courier monospaced ty pe indicates com mands, com mand parameters, code exam ples, expressions, data types, and directiv es. • Italic ty pe indicates replaceable com mand param eters. • All so[...]

viii Embedded Bootloader Reference Manual, Rev 0.0 Fr eescale Semic onductor References [1] Freescale 802.15.4 MAC/PHY Software Reference Manual, 802154MPSRM/D [2] Zig bee.hlp (see Test Tool installation directory .help) [3] Freescale MC908HCS08GB60/GT60 MCU Data Sheet, MC9S08GB60/D [4] Freescale Application Note, Handling MAC Address Erasure, AN2[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 1-1 Chapter 1 Embedded Bootloader Description The Embedded Bootloader is intended f or use with the IEEE® 802.15.4 evaluation kits (EVK). However, it is possible to upload applications with the Embedded Bootloader in the dev elopm ent phase, but the Embedded B ootloader w[...]

1-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 1.1.1 Ported Targets The Em bedded Bootloader mu st be ported (I/O mapped) to a specific P CB for proper functionality and is currently ported to the following Freescale PCB s: Axiom AXM-0308: • PC Comm unication Interface: RS232/UART on COM1 (SCI 1)/ RS232/UART on COM2 ([...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 1-3 1.2 Featu res The following features are supported: • Upload firmware (802.15.4/Z i gbee application) in Motorola S19 record form at through UART/USB. The S1 data record length must be set to 32 by tes • A u to - D etection of the P C co m m unication interface (se[...]

1-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 1.4.1 Optional Fi rmwar e Upl oad 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 fil[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 2-1 Chapter 2 Using the Embedded Bootloader This chapter describes the Em bedded Bootloader functionality. A detailed description of the functions briefly m entioned in this chapter can be found in Chapter 7 . 2.1 Up load Firmware The Embedded Bootloader can be used in dif[...]

2-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 2.1.2 Use Case Two In this use case, users push a button on the board to enable firm ware upload. MC908HCS08GB60 (1) /MC13192 B Application o o NVM t l 802.15.4 MAC o a User Interface d 802.15.4 PHY Push Buttons e I/O r Device Driver GPI O S101 S102 S103 S104 1) Or MC908HCS[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 2-3 7. Remove short from UAR T T X and RX and connect UART cable again (if the RS232 UART interface is used) 8. Power up again 9. Embedded B ootloader is ready to receiv e new firm ware (all LEDs on) 10. Start the PC-Tool. See Chapter 3 , for more inform ation. NOTE The Sa[...]

2-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 2.3 S ystem Bus F requen cy The MC908HCS08GB60/GT60 starts in 4 MHz self clocked m ode. 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 m odule and MC13192 CLKO) and other options are s[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 3-1 Chapter 3 Test Tool – Zigbee Flash Tool The Zigbee flash tool is a part of the g eneral Zigbee Test Tool. This chapter provides a brief description of how to use the Zig bee Test Tool to upload new firmware. For mo re details about installation and other features, se[...]

3-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 3.1 G raphical U ser Interface (GU I) Version To use the GUI v ersion of the Test Tool, execute the following file: [installation directory]FreescaleTest ToolTest Tool.exe 3.1.1 Using the Tool s Menu Opti on After clicking on the T ools menu option, click the Comm unicat[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 3-3 3.1.2 Using the View Menu Opti on After clicking the View m enu 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 w[...]

3-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 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 prog ress. Figure 5 Firmware Upload The Status/Error Inform at[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 3-5 After a successful upload of the firmware, the window appears as shown in Fig ure 6 . NOTE A system reset is perform ed (default) after upload as shown in Figure 6 . Figure 6 After a Successful Firmware Upl oad NOTE If the uploaded application uses another baud rate, i[...]

3-6 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 3.1.4 Using the Help Menu Click on the Em bedded Bootloader About box to see the Embedded Bootloader sub v ersion number. Figure 7 Embedded Bootloader Tool Version NOTE The last line is reported from the Em bedded Bootloader on the PCB. This version number is only sent to t[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 3-7 Figure 8 System Configuration Window[...]

3-8 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 3.2 Command Line Ve rsion ( CMD) The comm and line version of the Em bedded Bootloader flash programm ing tool m ust be called with parameters: Execute ‘Bootloader.exe’ without parameters to show a param eter list: Figure 9 Command Line Version (Parameter List)[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 3-9 3.2.1 Normal Use Example (Default) Norm al use example (default). ”Bootloader EVK_PTC_Demo.s19 /C:COM2 /B:19200 /-E /- A /-O /-S” Figure 10 Command Line Version (Using Several Opt i ons) NOTE It is not possible to edit NVM data with the CMD version. 3.2.2 Flash Era[...]

3-10 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 4-1 Chapter 4 Embedded Bootloader Programming This chapter describes how to program the Embedded Bootloader with a P &E Multilink for H CS08 BD M debugg er. The Embedded Bootloader is norm ally downloaded to the PCB where production data is also written. Users m ust em[...]

4-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor The “Connection Assistant” window appears where y ou can select the debugg er interface connection. As shown in Figure 13 , a USB connection was chosen and the HCS08 was selected as the CPU type. Click the “O K” button. Figure 13 Connection Assistant Window[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 4-3 4. Click on “Load Application” under the “File” m enu to open the “Load Executable File” window. Specify application file to prog ram in the “Load Executable File” window as shown in Fig ure 14 . Select “Motorola S-Record (*.s19)” using the “Files[...]

4-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor The Embedded Bootloader is now program med to the PCB as shown in the Status Window in Figure 15 . Figure 15 Status Window 5. Remov e power and disconnect the BDM cable from the PCB. Next, power up the PCB. The PCB is now ready to upload an application. See Chapter 2 for de[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 4-5 4.2 Upgrading The Embedded Boot loader This section describes how to upgrade the Em bedded Bootloader to a newer version with the P&E Multilink BD M debugg er. 1. Execute the HIWAVE.EXE file from your chosen installation directory. For exam ple, [installation direc[...]

4-6 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 4. The “Connection Assistant” window appears where y ou can select the debugg er interface connection. As shown in Figure 17 , a USB connection was chosen and the HCS08 was selected as the CPU type. Click the “OK” button. Figure 17 Connection Assistant Window[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 4-7 5. Make a copy of the NVM sector (both NVM0 and NVM1) with the production data. Select the “PEDebug” m enu, select “Program m ing Options”, and then choose “Start Expert Mode Program mer”. The “Prog ramm er Expert” window appears as shown in Figure 18 .[...]

4-8 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 8. As shown in Figure 20 , use the S19 window to specify which S19 file to store active NVM data to and then click the “OK” button. For NVM0 use ‘PD_NVM0.s19’ and for NVM1 use ‘PD_NVM1.s19’. Figure 20 S19 File Window 9. Close “Program mer Expert” window. 10.[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 4-9 The Embedded Bootloader is now program med to the PCB as shown in Figure 22 . Figure 22 Status Window 12. Write NVM production data back by selecting the “PEDebug ” menu. Then select “Prog ramm i ng Options” and “Start Expert Mode Program mer”. Select “SS[...]

4-10 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 5-1 Chapter 5 Application Integration Reference Guide This chapter describes the deliverables required to build an 802.15.4/Zig bee Application with the Embedded Bootloader. NOTE The Freescale Switch Dem onstration application is available w ith complete source code. The S[...]

5-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 5.1.3 Application Linker File The 802.15.4/Zigbee application code m ust be linked with the following link er file in order to work with the Embedded B ootloader interface. The linker file specifies fixed data and code segm ents. See linker file for more details. Mak e sure[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 5-3 { // Do something to aviod that code is removed by linker } 5.2.3 System Clock Setup The Embedded Bootloader contains the I CG_Setup() function which is called if the Em bedded Bootloader m ust start. The Embedded Bootloader sets up the sy stem clock as specified in th[...]

5-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor NOTE This file can also be used with the MC908HCS08GT60 MCU. 5.3.3 Crt0.c and Crt.h These files contain the basic initialization code (basic sy stem clock , m emo ry and stack setup). The normal basic init file(s) (like the start08.c from Metrowerks) is not needed when the [...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 5-5 5.3.4 Embedded_Bootloader. h and Embedded_Bootloader. c These are the interface files for the 802.14.4/Zigbee application. They contain function pointers to functions accessible in the Embedded B ootloader. These files also contain absolute addresses, which should not [...]

5-6 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 5.3.7 DummyIsr.c This file contains a dumm y I SR function which makes a break if a BDM debugg er is attached to the BDM connector. An illeg al instruction reset occurs if no BDM debugger is attached. The function is added to all unused ISR v ectors in the ISR_Vector.c file[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 6-1 Chapter 6 Port Integration Reference Guide This chapter describes the Embedded Bootloader source code release deliv erables and how to integrate them to m ake an executable Embedded Bootloader for a specific PC B. NOTE For user convenience, sev eral readme.txt files co[...]

6-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor Source file: hw_hc08_libmaker.dll, version 5.0.8.0 Setting: None 6.2 Produc t De liver ables The Freescale Embedded Bootloaader consists of four m ajor components. Refer to Appendix A for a complete list of released files. 6.2.1 Embedded_Bootloader .mcp This is the Metrower[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 6-3 HW_Init.c Hardware init functions HW_Init.h Init function prototyp es and defines. Reset_Vector.c System reset vector. main.c Embedded Bootloader m ain function. 6.3 P orting to a Sp ecific Target This section provides guidelines on how to port the Em bedded Bootloader[...]

6-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 6.4 Sourc e Files This section describes the source files. 6.4.1 Target.h The user must define the PCB targ et specific #defines in the Target.h in the .802.15.4_HeadersGhdr . file for a successful port. NOTE Several other #defines are m ade in the target description in t[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 6-5 //PTADD = 0x00; //All Port A input #define mSETUP_PORT_B //PTBD = 0x00; //PTBPE = 0x00; //PTBDD = 0x00; #define mSETUP_PORT_C PTCDD = (ABEL_RESET_PIN | ABEL_ATT_PIN ); Optional for Safe Mode Boot indicator function (LEDs as output): #define mSETUP_PORT_D PTDPE = 0x00[...]

6-6 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor #define SET_OUTPUT LED1ON // Defined in Target.h #endif defined TARGET_DIG528_2 || defined TARGET_DIG536_2 6.4.4 HW_Init.h This file contains prototypes of all the init functions and defines. 6.4.5 HW_Init.c This file contains some hardware init functions which depend on th[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 7-1 Chapter 7 Embedded Bootloader Public Function Description This section describes the public functions which the 802.15.4/Zigbee application can call in the Embedded Bootloader. 7.1 802.15.4/Zigbee Application Accessible Functions The following functions, located in the[...]

7-2 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor NOTE All bits are enabled by default. Bits can only be disabled (erased in flash) – never enabled. The bits are enabled again by the new firmware. Input: interface_state - The user selectable options. The below values should be OR’ed together: Embedded Bootloader contro[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 7-3 7.1.2 Hard_Reset Prototype: void Hard_Reset(void) Description: The application can call this function to mak e a system reset. T he reset is done by executing an illegal instruction. Input: None Output: None 7.1.3 Update_NV_RAM Prototype: bool_t Update_NV_RAM ( NV_RAM_[...]

7-4 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor 7.1.4 NV_Flash_Setup Prototype: void NV_Flash_Setup(void) Description: This function should never be called under norm al conditions. Howev er, it should be called if any of the other Embedded Bootloader functions m alfunctions. T he function sets up the flash functions (ag[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 7-5 7.1.6 UART_Port_Sel ect Prototype: void FL_ICG_Setup ( uint8_t data_reg_address, uint8_t status_reg_address ) Description: This function can be called when the application has detected the active com munication interface if used by the application. The com munication i[...]

7-6 Embedded Bootloader Reference Manual, Rev 0.0 F reescale Semic onductor[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 8-1 Chapter 8 Embedded Bootloader Memory Map Table 1. Zigbee (MC9S08G B60/GT60) 802.15.4 Embed ded Bootlo ader Memory Map 512 By tes in a physical flash sec tor Sector Number A ddress in hex start A ddress in hex end (sector erase address) Size in bytes General HCS0 8 Map [...]

8-2 Embedded Bootloader Reference Manual, Rev. 0.0 F reescale Semic onductor 1 (shar e) 12 1800 182B 44 High Page Registers (COP, Flash et c.) High Page Register s (COP, Flash etc.) 12 182C 19FF 468 FLASH (s ection 2) 13 1A00 1BFF 512 FLASH (sec tion 2) 14 1C00 1DFF 512 FLASH (sec tion 2) 15 1E00 1FFF 512 FLASH ( section 2) 16 2000 21FF 512 F LASH [...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 8-3 37 4A00 4BFF 512 FLASH (sec tion 2) 38 4C00 4DFF 512 FLASH (sec tion 2) 39 4E00 4FFF 512 FLASH ( section 2) 40 5000 51FF 512 F LASH (section 2) 41 5200 53FF 512 F LASH (section 2) 42 5400 55FF 512 F LASH (section 2) 43 5600 57FF 512 F LASH (section 2) 44 5800 59FF 512 [...]

8-4 Embedded Bootloader Reference Manual, Rev. 0.0 F reescale Semic onductor 64 8000 81FF 512 F LASH (section 2) 65 8200 83FF 512 F LASH (section 2) 66 8400 85FF 512 F LASH (section 2) 67 8600 87FF 512 F LASH (section 2) 68 8800 89FF 512 F LASH (section 2) 69 8A00 8BFF 512 FLASH (sec tion 2) 70 8C00 8DFF 512 FLASH (sec tion 2) 71 8E00 8FFF 512 FLAS[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 8-5 91 B600 B7FF 512 FLASH (sec tion 2) 92 B800 B9FF 512 FLASH (sec tion 2) 93 BA00 BBFF 512 FLASH (s ection 2) 94 BC00 BDFF 512 FLASH (sec tion 2) 95 BE00 BFFF 512 FLASH ( section 2) 96 C000 C1FF 512 FLASH (sec tion 2) 97 C200 C3FF 512 FLASH (sec tion 2) 98 C400 C5FF 512 [...]

8-6 Embedded Bootloader Reference Manual, Rev. 0.0 F reescale Semic onductor 118 EC00 EDFF 512 FLASH ( section 2) 119 EE00 EFBF 448 FLASH (section 2) 119 EFC0 EFFD 62 FLA SH (sect ion 2) 802.15.4 app. ISR v ectors 119 EFFE EFFF 2 FLA SH (section 2) Embedded Bootloader system flags (placed b y 802.15.4 application ) 120 F000 F00F 16 FLASH (section 2[...]

Freescal e Semicond ucto r Embedded Boot loader Referen ce Manu al, Rev. 0.0 8-7 = May be used by Embedded Bootloader. 802.15.4/App. can reuse this space ( overwrite). = Used by Embedded Bootloader. Data/code which m ust be located on the specif ied address and ( m ust/will) exists when the application is running = May be used by 802.15.4/App. = Us[...]

8-8 Embedded Bootloader Reference Manual, Rev. 0.0 F reescale Semic onductor[...]

Freescal e Semicond ucto r Embedded Bootloader Ref eren ce Manu al, Rev. 0.0 A-1 Appendix A Release Folder and File Structure This appendix describes the folder and file structure for this release. A.1. Folder Struct ure 802.15.4_Headers Ghdr Global headers from the 802.15.4 MAC/PHY Release Bin Embedded_Bootloader When target is built, the output f[...]

A-2 Embedded Bootloader Reference Manual, Rev. 0.0 Fr eescale Semic onductor A.2. F ile S tructure This section describes all of the files in the Embedded Bootloader release. .Embedded_Bootloader Embedded_Bootloader.m cp Metrowerks Codewarrior project file flash.hwc Hiwave system file flash.hwl Hiwave system file flash.ini Hiwave system file .Emb[...]

Freescal e Semicond ucto r Embedded Bootloader Ref eren ce Manu al, Rev. 0.0 A-3 .Embedded_BootloaderBinEmbedded_BootloaderAX-0308RevC Embedded_Bootloader.elf Elf format file Embedded_Bootloader.m ap Map file Embedded_Bootloader.s19 Freescale S19 file .Embedded_BootloaderBinEmbedded_BootloaderDIG-528-2_DIG-536-2 Embedded_Bootloader.elf Elf [...]

A-4 Embedded Bootloader Reference Manual, Rev. 0.0 Fr eescale Semic onductor[...]