A fork of Erik Olieman's bootloader for the KL05Z32. The bootloader is placed in the 29th sector allowing for 28kB of program memory. The 32nd sector is left empty after the bootloader to allow for use of the non volatile storage without the risk of overwriting it during serial firmware update.

Dependencies:   mbed-dev

Fork of Bootloader_K64F by Erik -

This is a simple boot loader which resides at the end of the flash banks of your uController. It has be ported to work with the KL05Z. Porting the code to another Free scale uController requires the following changes:

Step 1 Change the address of the following function address

If your uController of choice has a flash size other than 32kB then you will likely want to change the addresses of following functions (current addresses displayed).

bootloader.cpp
0x7000 bootloader
0x7080 setupserial
0x70A0 write

FreescaleIAP.cpp
0x7268 erase_sector
0x7300 program_flash
0x7500 flash_size
0x7600 program_word
0x7700 run_command
0x7800 check_boundary
0x7900 check_align
0x7A00 verify_erased
0x7B00 check_error

Step 2 Follow the serial_api HAL file of your target

You will be unable to access anything that you don't define yourself in the bootloader. For this reason you need to create a function for serial. Look up and follow your target's serial_api.c file.

__attribute__((section(".ARM.__at_0x7080"))) static void setupserial(void) {
        //Setup USBRX/USBTX pins (PTB1/PTB2)
        //Enable Port B Clock
        SIM->SCGC5 |= 1 <<SIM_SCGC5_PORTB_SHIFT;                   
        //Select MCGFLLCLK clock
        SIM->SOPT2 |= 1 <<SIM_SOPT2_UART0SRC_SHIFT;
        //Select Pins PB1 & PB2 to their ALT3 function (RX & TX respectively)
        PORTB->PCR[1] = (PORTB->PCR[1] & ~0x700) | (3 << 8);
        PORTB->PCR[2] = (PORTB->PCR[2] & ~0x700) | (3 << 8);
        //Set UART0 Clock to be enabled
        SIM->SCGC4 |= SIM_SCGC4_UART0_MASK;
        //Set UART Baud Rate Register
        //Value's gathered expirimentally   
        UART0->BDH = 1;
        UART0->BDL = 56;   
        //Enable UART0
        UART0->C2 |= (UARTLP_C2_RE_MASK | UARTLP_C2_TE_MASK);
}

To set the correct baudrate you need to determine the right values for BDH & BDL registers for your clock speed. An easy way to do that is by simply printing them with the clock speed that you want like so:

#include "mbed.h"

Serial pc(USBTX, USBrX);

int main()
{
    while (1) {
        pc.printf("BDH: %d \n", UART0->BDH); // print the value of BDH Register
        pc.printf("BDL: %d \n", UART0->BDL); // print the value of BDL Register
        pc.printf("SOPT2: %d \n", SIM->SOPT2); // print the value of SOPT2 Register
        pc.printf("SCGC5: %d \n", SIM->SCGC5); // print the value of SCGC5 Register
        pc.printf("SCGC4: %d \n", SIM->SCGC4); // print the value of SCGC4 Register
        pc.printf("C2: %d \n", UART0->C2); // print the value of C2 Register
        pc.printf("C4: %d \n", UART0->C4); // print the value of C4 Register
        wait(.5);
    }
}

Step 3 Include bootloader.cpp in your first firmware

Before you can update firmware using serial you first must update the firmware using SWD along with the bootloader included in your binary.

#include "mbed.h"
extern void bootloader(void);
//...
main(){
//...
bootloader();
}

Step 4 Include reference to bootloader in serial updates

Once the bootloader is on the uControler you should not include the bootloader in binaries that you want to update over serial. Instead you can access the bootloader by using the following:

#include "mbed.h"

void *(*bootloader)(void) = (void *(*)(void))0x7001; //Address of bootloader + 1 (For some reason)
//...
main(){
//...
bootloader();
}

IF YOU ARE PROGRAMMING USING A PROGRAMMER (SWD OR JTAG) AND NOT SERIAL MAKE SURE TO INCLUDE THE BOOTLOADER OR OTHERWISE IT WILL MOST LIKELY BE ERASED OR OVERWRITTEN

Committer:
Sissors
Date:
Thu Mar 12 19:04:30 2015 +0000
Revision:
2:8c44f28c122c
Parent:
1:782a3ddc329e
Child:
3:8c39a7751758
v0.9, works on K20 :D

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Sissors 2:8c44f28c122c 1 #include "mbed.h"
Sissors 2:8c44f28c122c 2 #include "FreescaleIAP.h"
Sissors 2:8c44f28c122c 3
Sissors 2:8c44f28c122c 4 //Could be nicer, but for now just erase all preceding sectors
Sissors 2:8c44f28c122c 5 #define NUM_SECTORS 32
Sissors 2:8c44f28c122c 6 #define TIMEOUT 10000000
Sissors 2:8c44f28c122c 7
Sissors 2:8c44f28c122c 8 void setupserial();
Sissors 2:8c44f28c122c 9 void write(char *value);
Sissors 2:8c44f28c122c 10 char getserial(void);
Sissors 1:782a3ddc329e 11
Sissors 2:8c44f28c122c 12 __attribute__((section(".ARM.__at_0x10000"))) void bootloader(void)
Sissors 2:8c44f28c122c 13 {
Sissors 1:782a3ddc329e 14 setupserial();
Sissors 2:8c44f28c122c 15 write("\n\n\rBootloader\r\n");
Sissors 2:8c44f28c122c 16 write("Continue? (y/n)");
Sissors 2:8c44f28c122c 17
Sissors 2:8c44f28c122c 18 while(!(UART0->S1 & UART_S1_RDRF_MASK));
Sissors 2:8c44f28c122c 19 if (UART0->D != 'y')
Sissors 2:8c44f28c122c 20 return;
Sissors 2:8c44f28c122c 21
Sissors 2:8c44f28c122c 22 write("Erasing sectors!\r\n");
Sissors 2:8c44f28c122c 23 for (int i = 0; i<NUM_SECTORS; i++)
Sissors 2:8c44f28c122c 24 erase_sector(SECTOR_SIZE * i);
Sissors 2:8c44f28c122c 25
Sissors 2:8c44f28c122c 26 write("Done erasing, send file!\r\n");
Sissors 1:782a3ddc329e 27
Sissors 2:8c44f28c122c 28 while(!(UART0->S1 & UART_S1_RDRF_MASK));
Sissors 2:8c44f28c122c 29
Sissors 2:8c44f28c122c 30 char buffer[8];
Sissors 2:8c44f28c122c 31 uint32_t count = 0;
Sissors 2:8c44f28c122c 32 uint8_t buffercount = 0;
Sissors 2:8c44f28c122c 33 uint32_t timeout = 0;
Sissors 2:8c44f28c122c 34 char *pointer;
Sissors 2:8c44f28c122c 35
Sissors 1:782a3ddc329e 36 while(1) {
Sissors 2:8c44f28c122c 37 //Check if there is new data
Sissors 2:8c44f28c122c 38 if (UART0->S1 & UART_S1_RDRF_MASK) {
Sissors 2:8c44f28c122c 39 timeout = 0;
Sissors 2:8c44f28c122c 40 buffer[buffercount] = UART0->D;
Sissors 2:8c44f28c122c 41 buffercount++;
Sissors 2:8c44f28c122c 42
Sissors 2:8c44f28c122c 43 //We write per 8 chars
Sissors 2:8c44f28c122c 44 if (buffercount == 8) {
Sissors 2:8c44f28c122c 45 if (program_flash(count, buffer, 8) != 0) {
Sissors 2:8c44f28c122c 46 write("Error!\r\n");
Sissors 2:8c44f28c122c 47 break;
Sissors 2:8c44f28c122c 48 }
Sissors 2:8c44f28c122c 49 write("A");
Sissors 2:8c44f28c122c 50 buffercount = 0;
Sissors 2:8c44f28c122c 51 count += 8;
Sissors 2:8c44f28c122c 52 }
Sissors 2:8c44f28c122c 53 } else {
Sissors 2:8c44f28c122c 54 //No new data, increase timeout
Sissors 2:8c44f28c122c 55 timeout++;
Sissors 2:8c44f28c122c 56 if (timeout > TIMEOUT) {
Sissors 2:8c44f28c122c 57 //Program remaining values
Sissors 2:8c44f28c122c 58 if (buffercount != 0) {
Sissors 2:8c44f28c122c 59 for (int i = buffercount; i<8; i++)
Sissors 2:8c44f28c122c 60 buffer[i] = 0xFF;
Sissors 2:8c44f28c122c 61 program_flash(count, buffer, 8);
Sissors 2:8c44f28c122c 62 }
Sissors 2:8c44f28c122c 63 break; //We should be done programming :D
Sissors 2:8c44f28c122c 64 }
Sissors 2:8c44f28c122c 65 }
Sissors 1:782a3ddc329e 66 }
Sissors 2:8c44f28c122c 67 write("Done programming!\r\n");
Sissors 2:8c44f28c122c 68 while(1);
Sissors 1:782a3ddc329e 69 }
Sissors 1:782a3ddc329e 70
Sissors 2:8c44f28c122c 71 __attribute__((section(".ARM.__at_0x10080"))) static void setupserial(void) {
Sissors 2:8c44f28c122c 72 //Setup USBTX/USBRX pins (PTB16/PTB17)
Sissors 2:8c44f28c122c 73 SIM->SCGC5 |= 1 << SIM_SCGC5_PORTB_SHIFT;
Sissors 2:8c44f28c122c 74 PORTB->PCR[16] = (PORTB->PCR[16] & 0x700) | (3 << 8);
Sissors 2:8c44f28c122c 75 PORTB->PCR[17] = (PORTB->PCR[17] & 0x700) | (3 << 8);
Sissors 2:8c44f28c122c 76
Sissors 2:8c44f28c122c 77 //Setup UART (ugly, copied resulting values from mbed serial setup)
Sissors 2:8c44f28c122c 78 SIM->SCGC4 |= SIM_SCGC4_UART0_MASK;
Sissors 1:782a3ddc329e 79
Sissors 2:8c44f28c122c 80 UART0->BDH = 1; //3;
Sissors 2:8c44f28c122c 81 UART0->BDL = 56; //13;
Sissors 2:8c44f28c122c 82 UART0->C4 = 8;
Sissors 2:8c44f28c122c 83 UART0->C2 = 12; //Enables UART
Sissors 2:8c44f28c122c 84
Sissors 2:8c44f28c122c 85 }
Sissors 1:782a3ddc329e 86
Sissors 2:8c44f28c122c 87 __attribute__((section(".ARM.__at_0x100A0"))) static void write(char *value) {
Sissors 2:8c44f28c122c 88 int i = 0;
Sissors 2:8c44f28c122c 89 while(*(value+i) != '\0') {
Sissors 2:8c44f28c122c 90 while(!(UART0->S1 & UART_S1_TDRE_MASK));
Sissors 2:8c44f28c122c 91 UART0->D = *(value+i);
Sissors 2:8c44f28c122c 92 i++;
Sissors 2:8c44f28c122c 93 }
Sissors 2:8c44f28c122c 94 }