Bootloader Generator User's Guide

Total Page:16

File Type:pdf, Size:1020Kb

Bootloader Generator User's Guide Bootloader Generator User’s Guide 2015-2016 Microchip Technology Inc. DS40001779B Note the following details of the code protection feature on Microchip devices: • Microchip products meet the specification contained in their particular Microchip Data Sheet. • Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions. • There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data Sheets. Most likely, the person doing so is engaged in theft of intellectual property. • Microchip is willing to work with the customer who is concerned about the integrity of their code. • Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not mean that we are guaranteeing the product as “unbreakable.” Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip’s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act. Information contained in this publication regarding device Trademarks applications and the like is provided only for your convenience The Microchip name and logo, the Microchip logo, AnyRate, AVR, and may be superseded by updates. It is your responsibility to AVR logo, AVR Freaks, BeaconThings, BitCloud, CryptoMemory, ensure that your application meets with your specifications. CryptoRF, dsPIC, FlashFlex, flexPWR, Heldo, JukeBlox, KEELOQ, MICROCHIP MAKES NO REPRESENTATIONS OR KEELOQ logo, Kleer, LANCheck, LINK MD, maXStylus, WARRANTIES OF ANY KIND WHETHER EXPRESS OR maXTouch, MediaLB, megaAVR, MOST, MOST logo, MPLAB, IMPLIED, WRITTEN OR ORAL, STATUTORY OR OptoLyzer, PIC, picoPower, PICSTART, PIC32 logo, Prochip OTHERWISE, RELATED TO THE INFORMATION, Designer, QTouch, RightTouch, SAM-BA, SpyNIC, SST, SST INCLUDING BUT NOT LIMITED TO ITS CONDITION, Logo, SuperFlash, tinyAVR, UNI/O, and XMEGA are registered QUALITY, PERFORMANCE, MERCHANTABILITY OR trademarks of Microchip Technology Incorporated in the U.S.A. FITNESS FOR PURPOSE. Microchip disclaims all liability and other countries. arising from this information and its use. Use of Microchip ClockWorks, The Embedded Control Solutions Company, devices in life support and/or safety applications is entirely at EtherSynch, Hyper Speed Control, HyperLight Load, IntelliMOS, the buyer’s risk, and the buyer agrees to defend, indemnify and mTouch, Precision Edge, and Quiet-Wire are registered hold harmless Microchip from any and all damages, claims, trademarks of Microchip Technology Incorporated in the U.S.A. suits, or expenses resulting from such use. No licenses are Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any conveyed, implicitly or otherwise, under any Microchip Capacitor, AnyIn, AnyOut, BodyCom, chipKIT, chipKIT logo, intellectual property rights unless otherwise stated. CodeGuard, CryptoAuthentication, CryptoCompanion, CryptoController, dsPICDEM, dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, EtherGREEN, In-Circuit Serial Programming, ICSP, Inter-Chip Connectivity, JitterBlocker, KleerNet, KleerNet logo, Mindi, MiWi, motorBench, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, Omniscient Code Generation, PICDEM, PICDEM.net, PICkit, PICtail, PureSilicon, QMatrix, RightTouch logo, REAL ICE, Ripple Blocker, SAM-ICE, Serial Quad I/O, SMART-I.S., SQI, SuperSwitcher, SuperSwitcher II, Total Endurance, TSHARC, USBCheck, VariSense, ViewSpan, WiperLock, Wireless DNA, and ZENA are trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. SQTP is a service mark of Microchip Technology Incorporated in Microchip received ISO/TS-16949:2009 certification for its worldwide the U.S.A. headquarters, design and wafer fabrication facilities in Chandler and Tempe, Arizona; Gresham, Oregon and design centers in California Silicon Storage Technology is a registered trademark of Microchip and India. The Company’s quality system processes and procedures Technology Inc. in other countries. are for its PIC® MCUs and dsPIC® DSCs, KEELOQ® code hopping devices, Serial EEPROMs, microperipherals, nonvolatile memory and GestIC is a registered trademark of Microchip Technology analog products. In addition, Microchip’s quality system for the design Germany II GmbH & Co. KG, a subsidiary of Microchip Technology and manufacture of development systems is ISO 9001:2000 certified. Inc., in other countries. All other trademarks mentioned herein are property of their QUALITY MANAGEMENT SYSTEM respective companies. © 2015-2016, Microchip Technology Incorporated, All Rights CERTIFIED BY DNV Reserved. ISBN: 978-1-5224-1205-2 == ISO/TS 16949 == DS40001779B-page 2 2015-2016 Microchip Technology Inc. BOOTLOADER GENERATOR USER’S GUIDE Table of Contents Preface ........................................................................................................................... 5 Chapter 1. Overview 1.1 Bootloader Overview ...................................................................................... 9 1.2 Bootloader Requirements ............................................................................... 9 Chapter 2. Options, Parts and Pieces 2.1 Communication Method ............................................................................... 15 2.2 Verification of Bootload Integrity ................................................................... 16 2.3 Self Protection .............................................................................................. 16 2.4 IO Pin Indicator ............................................................................................. 16 2.5 Enable Read Flash ....................................................................................... 16 2.6 Enable Read/Write EEData .......................................................................... 16 2.7 Encryption .................................................................................................... 16 Chapter 3. Hex File 3.1 Intel® Hex File Format .................................................................................. 19 3.2 PIC16F1XXX Interpretations ........................................................................ 19 3.3 PIC18 Interpretations ................................................................................... 20 Chapter 4. MCC Bootloader Generator 4.1 Generate Bootloader .................................................................................... 21 Chapter 5. Merge Bootloader with the Application 5.1 MPLAB X Project configurations .................................................................. 25 5.1.1 End – Application Project Configurations .................................................. 27 Chapter 6. Bootloader Host Application 6.1 Overall Working Strategy ............................................................................. 31 6.2 Prerequisites ................................................................................................ 32 6.3 Detailed Steps .............................................................................................. 32 6.4 Menu Bar Options ........................................................................................ 35 6.5 Troubleshooting ............................................................................................ 36 6.6 External Dependencies ................................................................................ 36 6.7 The Host Application .................................................................................... 36 Chapter 7. Bootloader Protocol 7.1 Command set ............................................................................................... 37 7.2 The Host Application .................................................................................... 38 7.3 Additional commands ................................................................................... 41 Worldwide Sales and Service .................................................................................... 45 2015-2016 Microchip Technology Inc. DS40001779B-page 3 Bootloader Generator User’s Guide NOTES: DS40001779B-page 4 2015-2016 Microchip Technology Inc. BOOTLOADER GENERATOR USER’S GUIDE Preface NOTICE TO CUSTOMERS All documentation becomes dated, and this manual is no exception. Microchip tools and documentation are constantly evolving to meet customer needs, so some actual dialogs and/or tool descriptions may differ from those in this document. Please refer to our website (www.microchip.com) to obtain the latest documentation available. Documents are identified with a “DS” number. This number is located on the bottom of each page, in front of the page number. The numbering convention for the DS number is “DSXXXXXA”, where “XXXXX” is the document number and “A” is the revision level of the document. For the most up-to-date information on development tools, see the MPLAB® IDE online help. Select the Help menu, and then Topics to open a list of available online help files. INTRODUCTION This chapter contains general information that will be useful to know
Recommended publications
  • Project Log 2 2 LPC2148 USB Bootloader
    Project Log 2 Project Title: USB MicroSD Card Reader EEE G512 Embedded System Design October 2018 Submitted by: Submitted to: Joy Parikh j 2016A3PS0136P Dr. Devesh Samaiya Rutwik Narendra Jain j 2015A3PS0726P 2 LPC2148 USB Bootloader The LPC2148 USB bootloader performs three steps: 1. The bootloader checks to see if a USB cable has been plugged in. If the LPC2148 detects the presence of a USB cable then it initiates a USB Mass Storage system. This will cause the target board to appear on any computer platform as a removable flash drive. The user can then seamlessly transfer files to the flash drive. In the background, the LPC2148 moves the user's files onto the SD card using the FAT16 file system. 2. The next thing the bootloader does is look for a firmware file (a file named FW.SFE). This file contains the desired operating firmware (in a binary file format) for the LPC2148 mi- croprocessor. If the bootloader finds this file on the FAT16 system then it programs the contents of this file to the flash memory of the LPC2148. In this way, the bootloader acts as a \programmer" for the LPC2148; and we can upgrade the firmware on the LPC2148 simply by loading a new file onto the micro SD card. 3. After performing the first two checks, the bootloader calls the main firmware. The main code should not even know that the bootloader was used and will run normally. 2.1 Details The USB device class used is MSCD (Mass Storage Class Device). The MSCD presents easy integration with PC's operating systems.
    [Show full text]
  • UG103.6: Bootloader Fundamentals
    UG103.6: Bootloader Fundamentals This document introduces bootloading for Silicon Labs network- ing devices. It describes the concepts of standalone and applica- KEY POINTS tion bootloaders and discusses their relative strengths and weak- • Introduces the Gecko Bootloader. nesses. In addition, it looks at design and implementation details • Summarizes the key features the for each method. Finally, it describes the bootloader file format. bootloaders support and the design decisions associated with selecting a Silicon Labs’ Fundamentals series covers topics that project managers, application de- bootloader. signers, and developers should understand before beginning to work on an embedded • Describes bootloader file formats. networking solution using Silicon Labs chips, networking stacks such as EmberZNet PRO or Silicon Labs Bluetooth®, and associated development tools. The documents can be used as a starting place for anyone needing an introduction to developing wire- less networking applications, or who is new to the Silicon Labs development environ- ment. silabs.com | Building a more connected world. Rev. 1.7 UG103.6: Bootloader Fundamentals Introduction 1. Introduction The bootloader is a program stored in reserved flash memory that can initialize a device, update firmware images, and possibly perform some integrity checks. Firmware image update occurs on demand, either by serial communication or over the air. Production-level pro- gramming is typically done during the product manufacturing process yet it is desirable to be able to reprogram the system after produc- tion is complete. More importantly, it is valuable to be able to update the device's firmware with new features and bug fixes after deploy- ment. The firmware image update capability makes that possible.
    [Show full text]
  • USART Protocol Used in the STM32 Bootloader
    AN3155 Application note USART protocol used in the STM32 bootloader Introduction This application note describes the USART protocol used in the STM32 microcontroller bootloader, providing details on each supported command. This document applies to STM32 products embedding any bootloader version, as specified in application note AN2606 STM32 system memory boot mode, available on www.st.com. These products are listed in Table 1, and are referred to as STM32 throughout the document. For more information about the USART hardware resources and requirements for your device bootloader, refer to the already mentioned AN2606. Table 1. Applicable products Type Product series STM32F0 Series STM32F1 Series STM32F2 Series STM32F3 Series STM32F4 Series STM32F7 Series STM32G0 Series Microcontrollers STM32G4 Series STM32H7 Series STM32L0 Series STM32L1 Series STM32L4 Series STM32L5 Series STM32WB Series STM32WL Series June 2021 AN3155 Rev 14 1/48 www.st.com 1 Contents AN3155 Contents 1 USART bootloader code sequence . 5 2 Choosing the USARTx baud rate . 6 2.1 Minimum baud rate . 6 2.2 Maximum baud rate . 6 3 Bootloader command set . 7 3.1 Get command . 8 3.2 Get Version & Read Protection Status command . 10 3.3 Get ID command . 12 3.4 Read Memory command . 13 3.5 Go command . 16 3.6 Write Memory command . 18 3.7 Erase Memory command . 21 3.8 Extended Erase Memory command . 24 3.9 Write Protect command . 27 3.10 Write Unprotect command . 30 3.11 Readout Protect command . 31 3.12 Readout Unprotect command . 33 3.13 Get Checksum command . 35 3.14 Special command . 39 3.15 Extended Special command .
    [Show full text]
  • USB Mass Storage Device (MSD) Bootloader
    Freescale Semiconductor Document Number: AN4379 Application Note Rev. 0, October 2011 Freescale USB Mass Storage Device Bootloader by: Derek Snell Freescale Contents 1 Introduction 1 Introduction................................................................1 Freescale offers a broad selection of microcontrollers that 2 Functional description...............................................2 feature universal serial bus (USB) access. A product with a 3 Using the bootloader.................................................9 USB port allows very easy field updates of the firmware. This application note describes a mass storage device (MSD) USB 4 Porting USB MSD device bootloader to bootloader that has been written to work with several other platforms.........................................................13 Freescale USB families. A device with this bootloader is 5 Developing new applications..................................15 connected to a host computer, and the bootloader enumerates as a new drive. The new firmware is copied onto this drive, 6 Conclusion...............................................................20 and the device reprograms itself. Freescale does offer other bootloaders. For example, application note AN3561, "USB Bootloader for the MC9S08JM60," describes a USB bootloader that was written for the Flexis JM family. The MSD bootloader described in this application note is offered as another option, and has these advantages: • It does not require a driver to be installed on the host. • It does not require an application to run on the host. • Any user can use it with a little training. The only action required is to copy a file onto a drive. • It can be used with many different host operating systems since it requires no host software or driver This bootloader was specifically written for several families of Freescale microcontrollers that share similar USB peripherals. These families include, but are not limited to, the following: • Flexis JM family MCF51JM © 2011 Freescale Semiconductor, Inc.
    [Show full text]
  • Bootloader and Startup Feature Overview and Configuratoin Guide
    TechnicalTTechnicalechnical GuideGuidGuidee Bootloader and Startup Feature Overview and Configuration Guide The AlliedWare Plus™ Bootloader Every switch has a startup process. The end result of the startup is that the unit is running a specific version of the operating system software, with the features configured according to a specific startup configuration file. The startup process goes through two main phases: First, the switch boots up off a dedicated bootloader software image, which initializes core functionality of the unit. Then, the bootloader launches the main operating software image, and passes control over to this operating system. The bootloader is the executable code responsible for setting up the system and loading the operating system software. The bootloader is the software that runs the unit when it first powers up, performing basic initialization and executing the product software release. As part of the startup process of the switch, the bootloader allows you various options before running the product operating system software. C613-22004-00 x REV A alliedtelesis.com Products and software version that apply to this guide This guide applies to all AlliedWare Plus products, running version 5.4.4 or later. However, not all features in this guide are supported on all products. To see whether a product supports a particular feature or command, see the following documents: The product’s Datasheet The AlliedWare Plus Datasheet The product’s Command Reference These documents are available from the above links on our website at alliedtelesis.com. Feature support may change in later versions. For the latest information, see the above documents. Content The AlliedWare Plus™ Bootloader ....................................................................................
    [Show full text]
  • Flash Bootloader
    Flash Bootloader Product Information Flash Bootloader Table of Contents 1 Flash Bootloader Overview ...................................................................................................................................................... 4 1.1 Overview of Advantages .......................................................................................................................................................... 5 1.2 Application Areas ...................................................................................................................................................................... 5 1.3 Flash Bootloader System Architecture ................................................................................................................................... 5 1.4 Functions.................................................................................................................................................................................... 6 1.5 Configuration ............................................................................................................................................................................ 6 1.6 Scope of Delivery....................................................................................................................................................................... 7 1.7 Availability ................................................................................................................................................................................
    [Show full text]
  • MCU Bootloader V2.5.0 Reference Manual
    MCU Bootloader v2.5.0 Reference Manual Document Number: MCUBOOTRM Rev. 1, 05/2018 MCU Bootloader v2.5.0 Reference Manual, Rev. 1, 05/2018 2 NXP Semiconductors Contents Section number Title Page Chapter 1 Introduction 1.1 Introduction.....................................................................................................................................................................9 1.2 Terminology....................................................................................................................................................................9 1.3 Block diagram.................................................................................................................................................................10 1.4 Features supported.......................................................................................................................................................... 10 1.5 Components supported....................................................................................................................................................11 Chapter 2 Functional description 2.1 Introduction.....................................................................................................................................................................13 2.2 Memory map...................................................................................................................................................................13 2.3 The MCU Bootloader Configuration Area (BCA)........................................................................................................
    [Show full text]
  • Using the OMAP-L1x7 Bootloader Urmil Parikh and Joseph Coombs
    Application Report SPRAB04G– June 2012 Using the OMAP-L1x7 Bootloader Urmil Parikh and Joseph Coombs ABSTRACT This application report describes various boot mechanisms supported by the OMAP-L1x7 bootloader read- only memory (ROM) image. Topics covered include the Application Image Script (AIS) boot process, an AISgen tool used to generate boot scripts, protocol for booting the device from an external master device, a UART Boot Host GUI for booting the device from a host PC, and any limitations, default settings, and assumptions made by the bootloader. Project collateral discussed in this application report can be downloaded from the following URL: http://www.ti.com/lit/zip/SPRAB04. Contents 1 Introduction .......................................................................................................................................................... 2 2 Boot Modes .......................................................................................................................................................... 3 3 Non-AIS Boot Modes ........................................................................................................................................... 3 4 Application Image Script (AIS) Boot ..................................................................................................................... 5 5 AISgen: Tool to Generate Boot Script (AIS image) ........................................................................................... 11 6 Master Boot – Booting From a Slave Memory Device
    [Show full text]
  • Acronis Os Selector Als Bootmanager
    Benutzerhandbuch OS Selector 8.0 Compute with confidence www.acronis.de Copyright © SWsoft, 2000-2002. Alle Rechte vorbehalten. Linux ist ein eingetragenes Warenzeichen von Linus Torvalds. OS/2 ist ein eingetragenes Warenzeichen der IBM Corporation. UNIX ist ein eingetragenes Warenzeichen von The Open Group. Windows und MS-DOS eingetragene Warenzeichen der Microsoft Corporati- on. Andere in diesem Buch erwähnte Namen können Warenzeichen oder einge- tragene Warenzeichen der jeweiligen Eigentümer sein und sollten als solche betrachtet werden. Die Veränderung und Verbreitung dieser Dokumentation ohne schriftlicher Genehmigung des Copyright-Inhabers ist untersagt. Die Verbreitung des Werkes oder einzelner Bestandteile des Werkes in belie- biger auf Papier abgedruckter Form (z.B. als Buch) zu kommerziellen Zwecken ist ohne vorheriger schriftlicher Genehmigung des Copyright- Inhabers verboten. Diese Dokumentation wird ohne Anspruch auf Vollständigkeit zur Verfügung gestellt. Der Autor gewährleistet nicht, daß der Inhalt fehlerfrei ist, Ihren An- forderungen sowie dem von Ihnen gewünschten Einsatzweck entsprechen. Weiterhin übernimmt der Autor keine Gewähr für die Richtigkeit des Inhaltes, soweit nicht grob fahrlässiges oder vorsätzliches Verhalten vorliegt. Teile oder die gesamte Dokumentation kann jederzeit ohne Ankündigung geändert werden. ENDBENUTZER-LIZENZVERTRAG OS Selector (Das SOFTWAREPRODUKT) unterliegt dem Copyright (C) 2001 der SWsoft. Alle Rechte sind vorbehalten. Durch die Installation des SOFTWAREPRODUKTES nehmen Sie diesen Li-
    [Show full text]
  • Using U-Boot to Boot from a NAND Flash Memory Device for MPC8313E by Nick Spence Network Computing Systems Group, Freescale Semiconductor, Inc
    Freescale Semiconductor Document Number: AN3201 Application Note Rev. 0, 06/2007 Using U-boot to Boot From a NAND Flash Memory Device for MPC8313E by Nick Spence Network Computing Systems Group, Freescale Semiconductor, Inc. NOR-based Flash memory devices have traditionally been Contents used for non-volatile storage for a bootloader. The advantages 1 MPC8313 Flash Control Machine . 2 1.1Registers . 2 of this type of memory include support for execute-in-place 1.2Buffers . 3 code, random access to memory, and zero error rate. 1.3Error Checking and Correction. 4 1.4NAND Boot Sequencer . 5 Because of their higher density and lower cost per byte, NAND 2 U-boot . 5 Flash technologies are becoming more common. 2.1Stage 0 Bootloader . .5 Unfortunately, the technology comes with a major 2.2Board Configuration Settings for NAND boot . 6 2.3u-boot files for NAND Boot . 8 disadvantage, which is the early failure of bits during memory 2.4NAND u-boot Execution Sequence . 8 writes. After some number of erase cycles, some bits lose the 3 Building and Loading NAND u-boot . .9 ability to be programmed to a zero state. Block-based error 4 NAND Auto Boot Settings on RDB Board . .10 correction solves this problem, but it prevents random memory 5 Conclusion . 10 6 References . 10 accesses for execute-in-place code without a specialized Appendix ANAND u-boot Macros. 11 NAND Flash memory controller. Appendix BNAND u-boot Code. 12 The local bus controller in the PowerQUICC™ MPC8313E processor is enhanced with a specialized NAND Flash control machine (FCM) to provide hardware support for small- and large-page NAND Flash-based memories, including the ability to boot from NAND Flash memory.
    [Show full text]
  • MSP430™ Flash Devices Bootloader (BSL) User's Guide (Rev
    www.ti.com Table of Contents User’s Guide MSP430™ Flash Devices Bootloader (BSL) ABSTRACT The MSP430™ bootloader (BSL) (formerly known as the bootstrap loader) allows users to communicate with embedded memory in the MSP430 microcontroller (MCU) during the prototyping phase, final production, and in service. Both the programmable memory (flash memory) and the data memory (RAM) can be modified as required. Do not confuse the bootloader with the bootstrap loader programs found in some digital signal processors (DSPs) that automatically load program code (and data) from external memory to the internal memory of the DSP. To use the bootloader, a specific BSL entry sequence must be applied. An added sequence of commands initiates the desired function. A bootloading session can be exited by continuing operation at a defined user program address or by the reset condition. If the device is secured by disabling JTAG, it is still possible to use the BSL. Access to the MSP430 MCU memory through the BSL is protected against misuse by the BSL password. The BSL password is equal to the content of the interrupt vector table on the device. Table of Contents 1 Introduction.............................................................................................................................................................................3 1.1 Supplementary Online Information.....................................................................................................................................3 1.2 Overview of BSL Features................................................................................................................................................
    [Show full text]
  • UEFI, Booting & Partition Management
    UEFI, Booting & Partition Management Kelvin Cording July 2018 Unified Extendible Interface (UEFI) • Modern computer and Windows are moving away from the traditional MBR based boot- up processes to hardware and software using UEFI • Win 8 introduced UEFI • If Windows 8 is already installed using Legacy BIOS, it can't be converted to UEFI. A new OS installation is required. Understanding a computer boot up process When you hit the power button of your PC, an execution begins that will eventually load the Operating System into memory. This first execution depends on the partition structure of your hard disk. We have two types of partition structures (or formats): MBR and GPT. The partition structure on a drive defines three things: • The structure of data on the drive. • The code used during startup if a partition is bootable. • Where a partition begins and ends. MBR -Master Boot Record GPT Globally Unique Identifier Partition Table = GUID Partition A comparison of GPT and MBR partition structures A comparison of GPT and MBR partition structures (2) Max partition size in MBR is ~2TB whereas in UEFI it is ~9 ZetaBytes One zettabyte (1021) is approximately equal to a thousand exabytes or a billion terabytes. MBR can have at max 4 primary partition whereas GPT can have 128. MBR can store only one bootloader whereas GPT has a separate dedicated EFI System Partition(ESP) for storing multiple bootloaders. The MBR Boot Process Before the BIOS can detect the boot device, it goes through a sequence of system configuration functions starting with: • Power-on-self-test. • Detecting and initializing the video card.
    [Show full text]