JY-MCU Minimum AVR System Board - Criando um Bootloader

Uma das limitações desta placa é que ela vem com a Flash protegida contra leitura. Para liberar a leitura é necessário apagar toda a Flash, perdendo o bootloader. Veremos aqui como criar o nosso próprio bootloader.

O bootloader que vem na placa é uma adaptação do BootloadHID. É dele mesmo que vamos partir. Após baixar o arquivo com o projeto e expandi-lo, os fontes do bootloader estarão no subdiretório firmware. A base para a comunicação USB é o V-USB, que já vimos aqui e aqui.

O primeiro arquivo que precisamos alterar é o bootloaderconfig.h. No final deste arquivo temos a rotina bootLoaderInit() onde precisamos fazer a iniciação referente ao botão e LEDs que vamos utilizar e a macro bootLoaderCondition() onde se testa a condição de execução do bootloader:

view plaincopy to clipboardprint?

1. static inline void  bootLoaderInit(void)  
2. {  
3.     DDRB = 0xFF;    /* LEDs */  
4.     PORTB = 0x00;  
5.     PORTD = 1 << 7; /* activate pull-up for key */  
6.     _delay_us(10);  /* wait for levels to stabilize */  
7. }  
8.   
9. #define bootLoaderCondition()   ((PIND & (1 << 7)) == 0)   /* True se S4 apertado */  

static inline void  bootLoaderInit(void)
{
    DDRB = 0xFF;    /* LEDs */
    PORTB = 0x00;
    PORTD = 1 << 7; /* activate pull-up for key */
    _delay_us(10);  /* wait for levels to stabilize */
}

#define bootLoaderCondition()   ((PIND & (1 << 7)) == 0)   /* True se S4 apertado */

Em princípio bastaria isto e acertar o makefile (que veremos em breve) para ter um bootloader funcional. Entretanto, o código pressupõe que é usado um jumper e não um botão; o bootloader é encerrado quando o botão for solto (eu não tinha percebi isto e perdi dois dias tentando descobrir porque não funcionava!). É preciso altera o main.c para ele continuar no bootloader mesmo que o botão esteja solto.

Vamos aproveitar e piscar um LED para indicar que o bootloader está executando. Aproveitei a lógica de temporização do meu teste anterior; o LED1 pisca 2 vezes por segundo. O código do main fica assim:

view plaincopy to clipboardprint?

1. int __attribute__((noreturn)) main(void)  
2. {  
3.     /* initialize hardware */  
4.     bootLoaderInit();  
5.     odDebugInit();  
6.     DBG1(0x00, 0, 0);  
7.     /* jump to application if jumper is set */  
8.     if(bootLoaderCondition()){  
9.         uchar i = 0, j = 0;  
10. #ifndef TEST_MODE  
11.         GICR = (1 << IVCE);  /* enable change of interrupt vectors */  
12.         GICR = (1 << IVSEL); /* move interrupts to boot flash section */  
13. #endif  
14.         initForUsbConnectivity();  
15.           
16.         /* Preparar o timer 1 operar no modo CTC com 16MHz / 256 */  
17.         /* contando até 15625 (1/4 segundo) */  
18.         OCR1A = 15625;  
19.         TCCR1B = _BV(WGM12) | _BV(CS12);  
20.           
21.         do{ /* main event loop */  
22.             wdt_reset();  
23.             usbPoll();  
24.             if (TIFR & _BV(OCF1A ))  
25.             {  
26.                 TIFR = _BV(OCF1A );         /* Limpa indicação do timer */  
27.                 PORTB ^= 0x80;              /* indica que está vivo */  
28.             }  
29. #if BOOTLOADER_CAN_EXIT  
30.             if(exitMainloop){  
31. #if F_CPU == 12800000  
32.                 break;  /* memory is tight at 12.8 MHz, save exit delay below */  
33. #endif  
34.                 if(--i == 0){  
35.                     if(--j == 0)  
36.                         break;  
37.                 }  
38.             }  
39. #endif  
40.         }while(1);  
41.     }  
42.     leaveBootloader();  
43. }  

int __attribute__((noreturn)) main(void)
{
    /* initialize hardware */
    bootLoaderInit();
    odDebugInit();
    DBG1(0x00, 0, 0);
    /* jump to application if jumper is set */
    if(bootLoaderCondition()){
        uchar i = 0, j = 0;
#ifndef TEST_MODE
        GICR = (1 << IVCE);  /* enable change of interrupt vectors */
        GICR = (1 << IVSEL); /* move interrupts to boot flash section */
#endif
        initForUsbConnectivity();
        
        /* Preparar o timer 1 operar no modo CTC com 16MHz / 256 */
        /* contando até 15625 (1/4 segundo) */
        OCR1A = 15625;
        TCCR1B = _BV(WGM12) | _BV(CS12);
        
        do{ /* main event loop */
            wdt_reset();
            usbPoll();
            if (TIFR & _BV(OCF1A ))
            {
                TIFR = _BV(OCF1A );         /* Limpa indicação do timer */
                PORTB ^= 0x80;              /* indica que está vivo */
            }
#if BOOTLOADER_CAN_EXIT
            if(exitMainloop){
#if F_CPU == 12800000
                break;  /* memory is tight at 12.8 MHz, save exit delay below */
#endif
                if(--i == 0){
                    if(--j == 0)
                        break;
                }
            }
#endif
        }while(1);
    }
    leaveBootloader();
}

Vamos aproveitar e fazer mais uma pequena indicação visual: acender um LED para indicar que a conexão USB foi feita. O ponto que eu escolhi é quando o micro atribuiu um endereço para a placa, na rotina usbDriverSetup que fica no arquivo usbdrv.c:

view plaincopy to clipboardprint?

1. SWITCH_CASE(USBRQ_SET_ADDRESS)          /* 5 */  
2.         PORTB |= 0x40;      /* indica que conectou */  
3.         usbNewDeviceAddr = value;  
4.         USB_SET_ADDRESS_HOOK();  

SWITCH_CASE(USBRQ_SET_ADDRESS)          /* 5 */
        PORTB |= 0x40;      /* indica que conectou */
        usbNewDeviceAddr = value;
        USB_SET_ADDRESS_HOOK();

Do ponto de vista de código é só isto. Precisamos agora acertar o makefile. As configurações de interesse estão todas no início: DEVICE, BOOTLOADER_ADDRESS, F_CPU, FUSEH, FUSE e AVRDUDE.

Inicialmente eu mantive os valores originais dos FUSEs. Pela documentação do ATmega32 descobrimos queo endereço do boot corresponde é "$3800". Há uma pegadinha: este endereço se refere a words e o avr-gcc trabalha com endereço de bytes; o valor deve ser multiplado por dois, resultando num BOOTLOADER_ADDRESS de 7000. Gerando o bootloader desta forma tudo funciona, só que há uma indicação curiosa do bootloadHID:

Device size = 32768 (0x8000); 30720 bytes remaining

O tamanho (device size) está correto porém o espaço reservado para o bootloader é de 4K, logo o que restam são 28672 bytes. Hora de se debruçar nos fontes (afinal, é software livre). O programa do PC assume cegamente que o bootloader ocupa 2K. Uma solução seria mexer nas duas pontas para o bootloader informar o seu tamanho. Uma solução mais simples é reduzir o espaço disponível para o bootloader para 2K, alterando FUSEH e BOOTLOADER_ADDRESS. O makefile fica assim:

view plaincopy to clipboardprint?

1. # Name: Makefile  
2. # Project: bootloadHID  
3. # Author: Christian Starkjohann  
4. # Creation Date: 2007-03-19  
5. # Tabsize: 4  
6. # Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH  
7. # License: GNU GPL v2 (see License.txt)  
8. # This Revision: $Id: Makefile 788 2010-05-30 20:54:41Z cs $  
9.   
10. # Adaptado para a placa JY-MEGA16/32 DEMO v1.2  
11. # por Daniel Quadros (http://dqsoft.blogspot.com)  
12. # em 15/dez/2012  
13.   
14. ###############################################################################  
15. # Configure the following variables according to your AVR. The example below  
16. # is for an ATMega8. Program the device with  
17. #     make fuse    # to set the clock generator, boot section size etc.  
18. #     make flash   # to load the boot loader into flash  
19. #     make lock    # to protect the boot loader from overwriting  
20.   
21. DEVICE = atmega32  
22. BOOTLOADER_ADDRESS = 7800  
23. F_CPU = 16000000  
24. FUSEH = 0xc2  
25. FUSEL = 0xaf  
26. # Fuse high byte:  
27. # 0xc0 = 1 1 0 0   0 0 1 0 <-- BOOTRST (boot reset vector at 0x7800)  
28. #        ^ ^ ^ ^   ^ ^ ^------ BOOTSZ0  
29. #        | | | |   | +-------- BOOTSZ1  
30. #        | | | |   + --------- EESAVE (preserve EEPROM over chip erase)  
31. #        | | | +-------------- CKOPT (full output swing)  
32. #        | | +---------------- SPIEN (allow serial programming)  
33. #        | +------------------ JTAGEN (JTAG disabled)  
34. #        +-------------------- OCDEN (OCD disabled)  
35. # Fuse low byte:  
36. # 0xaf = 1 0 1 0   1 1 1 1  
37. #        ^ ^ \ /   \--+--/  
38. #        | |  |       +------- CKSEL 3..0 (external >8M crystal)  
39. #        | |  +--------------- SUT 1..0 (crystal osc, BOD enabled)  
40. #        | +------------------ BODEN (BrownOut Detector enabled)  
41. #        +-------------------- BODLEVEL (2.7V)  
42.   
43. ###############################################################################  
44.   
45. AVRDUDE = avrdude -c usbtiny -p $(DEVICE)  
46.   
47. LDFLAGS += -Wl,--relax,--gc-sections -Wl,--section-start=.text=$(BOOTLOADER_ADDRESS)  
48.   
49. # Omit -fno-* options when using gcc 3, it does not support them.  
50. COMPILE = avr-gcc -Wall -Os -fno-move-loop-invariants -fno-tree-scev-cprop -fno-inline-small-functions -Iusbdrv -I. -mmcu=$(DEVICE) -DF_CPU=$(F_CPU) -DDEBUG_LEVEL=0 # -DTEST_MODE  
51. # NEVER compile the final product with debugging! Any debug output will  
52. # distort timing so that the specs can't be met.  
53.   
54. OBJECTS =  usbdrv/usbdrvasm.o usbdrv/oddebug.o main.o  
55.   
56.   
57. # symbolic targets:  
58. all: main.hex  
59.   
60. .c.o:  
61.  $(COMPILE) -c $< -o $@  
62.   
63. .S.o:  
64.  $(COMPILE) -x assembler-with-cpp -c $< -o $@  
65. # "-x assembler-with-cpp" should not be necessary since this is the default  
66. # file type for the .S (with capital S) extension. However, upper case  
67. # characters are not always preserved on Windows. To ensure WinAVR  
68. # compatibility define the file type manually.  
69.   
70. .c.s:  
71.  $(COMPILE) -S $< -o $@  
72.   
73. flash: all  
74.  $(AVRDUDE) -U flash:w:main.hex:i  
75.   
76. readflash:  
77.  $(AVRDUDE) -U flash:r:read.hex:i  
78.   
79. fuse:  
80.  $(AVRDUDE) -U hfuse:w:$(FUSEH):m -U lfuse:w:$(FUSEL):m  
81.   
82. lock:  
83.  $(AVRDUDE) -U lock:w:0x2f:m  
84.   
85. read_fuses:  
86.  $(UISP) --rd_fuses  
87.   
88. clean:  
89.  rm -f main.hex main.bin *.o usbdrv/*.o main.s usbdrv/oddebug.s usbdrv/usbdrv.s  
90.   
91. # file targets:  
92. main.bin: $(OBJECTS)  
93.  $(COMPILE) -o main.bin $(OBJECTS) $(LDFLAGS)  
94.   
95. main.hex: main.bin  
96.  rm -f main.hex main.eep.hex  
97.  avr-objcopy -j .text -j .data -O ihex main.bin main.hex  
98.  avr-size main.hex  
99.   
100. disasm: main.bin  
101.  avr-objdump -d main.bin  
102.   
103. cpp:  
104.  $(COMPILE) -E main.c  

# Name: Makefile
# Project: bootloadHID
# Author: Christian Starkjohann
# Creation Date: 2007-03-19
# Tabsize: 4
# Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH
# License: GNU GPL v2 (see License.txt)
# This Revision: $Id: Makefile 788 2010-05-30 20:54:41Z cs $

# Adaptado para a placa JY-MEGA16/32 DEMO v1.2
# por Daniel Quadros (http://dqsoft.blogspot.com)
# em 15/dez/2012

###############################################################################
# Configure the following variables according to your AVR. The example below
# is for an ATMega8. Program the device with
#     make fuse    # to set the clock generator, boot section size etc.
#     make flash   # to load the boot loader into flash
#     make lock    # to protect the boot loader from overwriting

DEVICE = atmega32
BOOTLOADER_ADDRESS = 7800
F_CPU = 16000000
FUSEH = 0xc2
FUSEL = 0xaf
# Fuse high byte:
# 0xc0 = 1 1 0 0   0 0 1 0 <-- BOOTRST (boot reset vector at 0x7800)
#        ^ ^ ^ ^   ^ ^ ^------ BOOTSZ0
#        | | | |   | +-------- BOOTSZ1
#        | | | |   + --------- EESAVE (preserve EEPROM over chip erase)
#        | | | +-------------- CKOPT (full output swing)
#        | | +---------------- SPIEN (allow serial programming)
#        | +------------------ JTAGEN (JTAG disabled)
#        +-------------------- OCDEN (OCD disabled)
# Fuse low byte:
# 0xaf = 1 0 1 0   1 1 1 1
#        ^ ^ \ /   \--+--/
#        | |  |       +------- CKSEL 3..0 (external >8M crystal)
#        | |  +--------------- SUT 1..0 (crystal osc, BOD enabled)
#        | +------------------ BODEN (BrownOut Detector enabled)
#        +-------------------- BODLEVEL (2.7V)

###############################################################################

AVRDUDE = avrdude -c usbtiny -p $(DEVICE)

LDFLAGS += -Wl,--relax,--gc-sections -Wl,--section-start=.text=$(BOOTLOADER_ADDRESS)

# Omit -fno-* options when using gcc 3, it does not support them.
COMPILE = avr-gcc -Wall -Os -fno-move-loop-invariants -fno-tree-scev-cprop -fno-inline-small-functions -Iusbdrv -I. -mmcu=$(DEVICE) -DF_CPU=$(F_CPU) -DDEBUG_LEVEL=0 # -DTEST_MODE
# NEVER compile the final product with debugging! Any debug output will
# distort timing so that the specs can't be met.

OBJECTS =  usbdrv/usbdrvasm.o usbdrv/oddebug.o main.o


# symbolic targets:
all: main.hex

.c.o:
 $(COMPILE) -c $< -o $@

.S.o:
 $(COMPILE) -x assembler-with-cpp -c $< -o $@
# "-x assembler-with-cpp" should not be necessary since this is the default
# file type for the .S (with capital S) extension. However, upper case
# characters are not always preserved on Windows. To ensure WinAVR
# compatibility define the file type manually.

.c.s:
 $(COMPILE) -S $< -o $@

flash: all
 $(AVRDUDE) -U flash:w:main.hex:i

readflash:
 $(AVRDUDE) -U flash:r:read.hex:i

fuse:
 $(AVRDUDE) -U hfuse:w:$(FUSEH):m -U lfuse:w:$(FUSEL):m

lock:
 $(AVRDUDE) -U lock:w:0x2f:m

read_fuses:
 $(UISP) --rd_fuses

clean:
 rm -f main.hex main.bin *.o usbdrv/*.o main.s usbdrv/oddebug.s usbdrv/usbdrv.s

# file targets:
main.bin: $(OBJECTS)
 $(COMPILE) -o main.bin $(OBJECTS) $(LDFLAGS)

main.hex: main.bin
 rm -f main.hex main.eep.hex
 avr-objcopy -j .text -j .data -O ihex main.bin main.hex
 avr-size main.hex

disasm: main.bin
 avr-objdump -d main.bin

cpp:
 $(COMPILE) -E main.c

Para gerar o bootloader basta executar o make. Agora é hora de gravar, conecte o USBtinyUSB (ou o seu gravador predileto). Primeiro execute "make flash" para gravar o novo bootloader, automaticamente será feito o apagamento da flash com o lock retornando ao padrão (reparar que após o apagamento o avrdude para de mostrar o valor estranho do contador de apagamentos). Em seguida, execute "make fuse" para atualizar os fuses. Por último, execute "make lock" para proteger o bootloader de apagamento acidental pela aplicação.

Para testar, desconecte o gravador e ligue diretamente a USB da placa ao PC, com o botão S4 apertado. O LED1 deve começar a piscar e pouco depois o LED2 deve acender. Solte o botão S4, os LEDs não devem sofrer alteração. Experimente gravar um programa (como o meu teste2) com o bootloadHID. Se você não usar a opção -r, vai precisar ressetar para o programa executar. Para voltar ao bootloader, aperte S4 e dê reset.

O projeto completo está nos arquivos do blog, em jymega32_bootloader.zip. Atenção que a licença deste software é a GPL v2 (ou v3 a seu critério).