Instruction/ maintenance manual of the product 802.15.4 Freescale Semiconductor
Go to page of 66
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.
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.
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.
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.
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.
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 i.
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.
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.
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-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.
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.
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.
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.
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.
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.
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.
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 .
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.
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.
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-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.
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.
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 .
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.
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.
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.
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”.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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.
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 .
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_.
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.
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-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.
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.
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.
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.
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.
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.
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 51F.
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 51.
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 BDF.
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.
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.
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.
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.
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 .
A-4 Embedded Bootloader Reference Manual, Rev. 0.0 Fr eescale Semic onductor.
An important point after buying a device Freescale Semiconductor 802.15.4 (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought Freescale Semiconductor 802.15.4 yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data Freescale Semiconductor 802.15.4 - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, Freescale Semiconductor 802.15.4 you will learn all the available features of the product, as well as information on its operation. The information that you get Freescale Semiconductor 802.15.4 will certainly help you make a decision on the purchase.
If you already are a holder of Freescale Semiconductor 802.15.4, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime Freescale Semiconductor 802.15.4.
However, one of the most important roles played by the user manual is to help in solving problems with Freescale Semiconductor 802.15.4. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device Freescale Semiconductor 802.15.4 along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
