Add a version number to the optiboot source and binary.

http://code.google.com/p/arduino/issues/detail?id=554

end of flash memory where they can be read (at least in theory) by
device programmers, hex-file examination, or application programs.
This is done by putting the version number in a separate section
(".version"), and using linker/objcopy magic to locate that section as
appropriate for the target chip.  (See
http://lists.gnu.org/archive/html/avr-gcc-list/2011-02/msg00016.html
for some discussion on the details.)

Start the version at 4.1 (the last "packaged" version of optiboot was
called version 3, so the "top of source" would be 4.0, and adding the
version number makes 4.1)

Refactor LDSECTION in the Makefile to LDSECTIONS so that multiple
section start addresses can be defined.

Change the _isp makefile definitions to make the bootloader section
readable (but not writable) by the application section.  (This would
need to be done elsewhere as well to handle all bootloader programming
techniques.  Notably Arduino's boards.txt

Note that this change does not change the "code" portion of optiboot
at all.  The only diffs in the .hex files are the added version word
at the end of flash memory.

Author: WestfW

bootloaders/optiboot/Makefile

@@ -36,7 +36,7 @@ ISPPORT	   = usb
 ISPSPEED   = -b 115200
 
 MCU_TARGET = atmega168
-LDSECTION  = --section-start=.text=0x3e00
+LDSECTIONS  = -Wl,--section-start=.text=0x3e00 -Wl,--section-start=.version=0x3ffe
 
 # Build environments
 # Start of some ugly makefile-isms to allow optiboot to be built
@@ -88,7 +88,7 @@ endif
 # http://tinker.it/now/2007/02/24/the-tale-of-avrdude-atmega168-and-extended-bits-fuses/
 #
 # similarly, the lock bits should be 0xff instead of 0x3f (to
-# unlock the bootloader section) and 0xcf instead of 0x0f (to
+# unlock the bootloader section) and 0xcf instead of 0x2f (to
 # lock it), but since the high two bits of the lock byte are
 # unused, avrdude would get confused.
 
@@ -98,7 +98,7 @@ ISPFUSES    = $(GCCROOT)avrdude $(AVRDUDE_CONF) -c $(ISPTOOL) \
               -U hfuse:w:0x$(HFUSE):m -U lfuse:w:0x$(LFUSE):m
 ISPFLASH    = $(GCCROOT)avrdude $(AVRDUDE_CONF) -c $(ISPTOOL) \
               -p $(MCU_TARGET) -P $(ISPPORT) $(ISPSPEED) \
-              -U flash:w:$(PROGRAM)_$(TARGET).hex -U lock:w:0x0f:m
+              -U flash:w:$(PROGRAM)_$(TARGET).hex -U lock:w:0x2f:m
 
 STK500 = "C:\Program Files\Atmel\AVR Tools\STK500\Stk500.exe"
 STK500-1 = $(STK500) -e -d$(MCU_TARGET) -pf -vf -if$(PROGRAM)_$(TARGET).hex \
@@ -116,7 +116,7 @@ CC         = $(GCCROOT)avr-gcc
 # Override is only needed by avr-lib build system.
 
 override CFLAGS        = -g -Wall $(OPTIMIZE) -mmcu=$(MCU_TARGET) -DF_CPU=$(AVR_FREQ) $(DEFS)
-override LDFLAGS       = -Wl,$(LDSECTION) -Wl,--relax -Wl,--gc-sections -nostartfiles -nostdlib
+override LDFLAGS       = $(LDSECTIONS) -Wl,--relax -Wl,--gc-sections -nostartfiles -nostdlib
 
 OBJCOPY        = $(GCCROOT)avr-objcopy
 OBJDUMP        = $(call fixpath,$(GCCROOT)avr-objdump)
@@ -129,7 +129,7 @@ virboot328: TARGET = atmega328
 virboot328: MCU_TARGET = atmega328p
 virboot328: CFLAGS += '-DLED_START_FLASHES=3' '-DBAUD_RATE=115200' '-DVIRTUAL_BOOT'
 virboot328: AVR_FREQ = 16000000L
-virboot328: LDSECTION  = --section-start=.text=0x7e00
+virboot328: LDSECTIONS  = --section-start=.text=0x7e00 -Wl,--section-start=.version=0x7ffe
 virboot328: $(PROGRAM)_atmega328.hex
 virboot328: $(PROGRAM)_atmega328.lst
 
@@ -200,7 +200,7 @@ atmega328: TARGET = atmega328
 atmega328: MCU_TARGET = atmega328p
 atmega328: CFLAGS += '-DLED_START_FLASHES=3' '-DBAUD_RATE=115200'
 atmega328: AVR_FREQ = 16000000L
-atmega328: LDSECTION  = --section-start=.text=0x7e00
+atmega328: LDSECTIONS  = -Wl,--section-start=.text=0x7e00 -Wl,--section-start=.version=0x7ffe
 atmega328: $(PROGRAM)_atmega328.hex
 atmega328: $(PROGRAM)_atmega328.lst
 
@@ -262,7 +262,7 @@ atmega8: TARGET = atmega8
 atmega8: MCU_TARGET = atmega8
 atmega8: CFLAGS += '-DLED_START_FLASHES=3' '-DBAUD_RATE=115200'
 atmega8: AVR_FREQ = 16000000L 
-atmega8: LDSECTION  = --section-start=.text=0x1e00
+atmega8: LDSECTIONS  = --section-start=.text=0x1e00 -Wl,--section-start=.version=0x1ffe
 atmega8: $(PROGRAM)_atmega8.hex
 atmega8: $(PROGRAM)_atmega8.lst
 
@@ -281,7 +281,7 @@ atmega88: TARGET = atmega88
 atmega88: MCU_TARGET = atmega88
 atmega88: CFLAGS += '-DLED_START_FLASHES=3' '-DBAUD_RATE=115200'
 atmega88: AVR_FREQ = 16000000L 
-atmega88: LDSECTION  = --section-start=.text=0x1e00
+atmega88: LDSECTIONS  = --section-start=.text=0x1e00 -Wl,--section-start=.version=0x1ffe
 atmega88: $(PROGRAM)_atmega88.hex
 atmega88: $(PROGRAM)_atmega88.lst
 
@@ -357,7 +357,7 @@ atmega328_pro8: TARGET = atmega328_pro_8MHz
 atmega328_pro8: MCU_TARGET = atmega328p
 atmega328_pro8: CFLAGS += '-DLED_START_FLASHES=3' '-DBAUD_RATE=115200'
 atmega328_pro8: AVR_FREQ = 8000000L
-atmega328_pro8: LDSECTION  = --section-start=.text=0x7e00
+atmega328_pro8: LDSECTIONS = --section-start=.text=0x7e00 -Wl,--section-start=.version=0x7ffe
 atmega328_pro8: $(PROGRAM)_atmega328_pro_8MHz.hex
 atmega328_pro8: $(PROGRAM)_atmega328_pro_8MHz.lst
 
@@ -382,7 +382,7 @@ luminet: MCU_TARGET = attiny84
 luminet: CFLAGS += '-DLED_START_FLASHES=3' '-DSOFT_UART' '-DBAUD_RATE=9600'
 luminet: CFLAGS += '-DVIRTUAL_BOOT_PARTITION'
 luminet: AVR_FREQ = 1000000L
-luminet: LDSECTION  = --section-start=.text=0x1d00
+luminet: LDSECTIONS = --section-start=.text=0x1d00 -Wl,--section-start=.version=0x1efe
 luminet: $(PROGRAM)_luminet.hex
 luminet: $(PROGRAM)_luminet.lst
 
@@ -421,10 +421,10 @@ clean:
 	$(OBJDUMP) -h -S $< > $@
 
 %.hex: %.elf
-	$(OBJCOPY) -j .text -j .data -O ihex $< $@
+	$(OBJCOPY) -j .text -j .data -j .version --set-section-flags .version=alloc,load -O ihex $< $@
 
 %.srec: %.elf
-	$(OBJCOPY) -j .text -j .data -O srec $< $@
+	$(OBJCOPY) -j .text -j .data -j .version --set-section-flags .version=alloc,load -O srec $< $@
 
 %.bin: %.elf
-	$(OBJCOPY) -j .text -j .data -O binary $< $@
+	$(OBJCOPY) -j .text -j .data -j .version --set-section-flags .version=alloc,load -O binary $< $@

bootloaders/optiboot/optiboot.c

@@ -114,7 +114,37 @@
 /* 500,1000,2000,4000,8000 supported.                     */
 /*                                                        */
 /**********************************************************/
+
+/**********************************************************/
+/* Version Numbers!                                       */
+/*                                                        */
+/* Arduino Optiboot now includes this Version number in   */
+/* the source and object code.                            */
+/*                                                        */
+/* Version 3 was released as zip from the optiboot        */
+/*  repository and was distributed with Arduino 0022.     */
+/* Version 4 starts with the arduino repository commit    */
+/*  that brought the arduino repository up-to-date with   */
+/* the optiboot source tree changes since v3.             */
+/*                                                        */
+/**********************************************************/
+
+/**********************************************************/
+/* Edit History:					  */
+/*							  */
+/* 4.1 WestfW: put version number in binary.		  */
+/**********************************************************/
+
+#define OPTIBOOT_MAJVER 4
+#define OPTIBOOT_MINVER 1
 
+#define MAKESTR(a) #a
+#define MAKEVER(a, b) MAKESTR(a*256+b)
+
+asm("  .section .version\n"
+    "optiboot_version:  .word " MAKEVER(OPTIBOOT_MAJVER, OPTIBOOT_MINVER) "\n"
+    "  .section .text\n");
+
 #include <inttypes.h>
 #include <avr/io.h>
 #include <avr/pgmspace.h>
@@ -324,7 +354,7 @@ int main(void) {
 
       // If we are in RWW section, immediately start page erase
       if (address < NRWWSTART) __boot_page_erase_short((uint16_t)(void*)address);
-      
+
       // While that is going on, read in page contents
       bufPtr = buff;
       do *bufPtr++ = getch();
@@ -336,7 +366,7 @@ int main(void) {
 
       // Read command terminator, start reply
       verifySpace();
-      
+
       // If only a partial page is to be programmed, the erase might not be complete.
       // So check that here
       boot_spm_busy_wait();
@@ -371,7 +401,7 @@ int main(void) {
         __boot_page_fill_short((uint16_t)(void*)addrPtr,a);
         addrPtr += 2;
       } while (--ch);
-      
+
       // Write from programming buffer
       __boot_page_write_short((uint16_t)(void*)address);
       boot_spm_busy_wait();
@@ -489,7 +519,7 @@ uint8_t getch(void) {
     "   rcall uartDelay\n"              // Wait 1 bit period
     "   clc\n"
     "   sbic  %[uartPin],%[uartBit]\n"
-    "   sec\n"                          
+    "   sec\n"
     "   dec   %[bitCnt]\n"
     "   breq  3f\n"
     "   ror   %[ch]\n"

bootloaders/optiboot/optiboot_atmega328.hex

@@ -30,5 +30,6 @@
 :107FD00090838083089580E0F8DFEE27FF270994DF
 :107FE000E7DF803209F0F7DF84E1DACF1F93182F43
 :0C7FF000DFDF1150E9F7F4DF1F91089566
+:027FFE0001047C
 :0400000300007E007B
 :00000001FF

bootloaders/optiboot/optiboot_atmega328.lst

@@ -5,23 +5,25 @@ Sections:
 Idx Name          Size      VMA       LMA       File off  Algn
   0 .text         000001fc  00007e00  00007e00  00000054  2**1
                   CONTENTS, ALLOC, LOAD, READONLY, CODE
-  1 .debug_aranges 00000028  00000000  00000000  00000250  2**0
+  1 .version      00000002  00007ffe  00007ffe  00000250  2**0
+                  CONTENTS, READONLY
+  2 .debug_aranges 00000028  00000000  00000000  00000252  2**0
                   CONTENTS, READONLY, DEBUGGING
-  2 .debug_pubnames 0000006a  00000000  00000000  00000278  2**0
+  3 .debug_pubnames 0000006a  00000000  00000000  0000027a  2**0
                   CONTENTS, READONLY, DEBUGGING
-  3 .debug_info   00000284  00000000  00000000  000002e2  2**0
+  4 .debug_info   00000285  00000000  00000000  000002e4  2**0
                   CONTENTS, READONLY, DEBUGGING
-  4 .debug_abbrev 000001ae  00000000  00000000  00000566  2**0
+  5 .debug_abbrev 0000019f  00000000  00000000  00000569  2**0
                   CONTENTS, READONLY, DEBUGGING
-  5 .debug_line   00000450  00000000  00000000  00000714  2**0
+  6 .debug_line   00000453  00000000  00000000  00000708  2**0
                   CONTENTS, READONLY, DEBUGGING
-  6 .debug_frame  00000090  00000000  00000000  00000b64  2**2
+  7 .debug_frame  00000090  00000000  00000000  00000b5c  2**2
                   CONTENTS, READONLY, DEBUGGING
-  7 .debug_str    00000141  00000000  00000000  00000bf4  2**0
+  8 .debug_str    00000141  00000000  00000000  00000bec  2**0
                   CONTENTS, READONLY, DEBUGGING
-  8 .debug_loc    000001e1  00000000  00000000  00000d35  2**0
+  9 .debug_loc    000001e1  00000000  00000000  00000d2d  2**0
                   CONTENTS, READONLY, DEBUGGING
-  9 .debug_ranges 00000068  00000000  00000000  00000f16  2**0
+ 10 .debug_ranges 00000068  00000000  00000000  00000f0e  2**0
                   CONTENTS, READONLY, DEBUGGING
 
 Disassembly of section .text:
@@ -135,7 +137,7 @@ void watchdogReset() {
         __boot_page_fill_short((uint16_t)(void*)addrPtr,a);
         addrPtr += 2;
       } while (--ch);
-      
+
       // Write from programming buffer
       __boot_page_write_short((uint16_t)(void*)address);
     7e50:	a5 e0       	ldi	r26, 0x05	; 5
@@ -249,7 +251,7 @@ void watchdogReset() {
     7ec6:	e8 95       	spm
     7ec8:	c0 e0       	ldi	r28, 0x00	; 0
     7eca:	d1 e0       	ldi	r29, 0x01	; 1
-      
+
       // While that is going on, read in page contents
       bufPtr = buff;
       do *bufPtr++ = getch();
@@ -278,7 +280,7 @@ void watchdogReset() {
       // Read command terminator, start reply
       verifySpace();
     7ef4:	75 d0       	rcall	.+234    	; 0x7fe0 <verifySpace>
-      
+
       // If only a partial page is to be programmed, the erase might not be complete.
       // So check that here
       boot_spm_busy_wait();
@@ -336,7 +338,7 @@ int main(void) {
     7f2e:	a0 38       	cpi	r26, 0x80	; 128
     7f30:	bf 07       	cpc	r27, r31
     7f32:	51 f7       	brne	.-44     	; 0x7f08 <main+0x108>
-      
+
       // Write from programming buffer
       __boot_page_write_short((uint16_t)(void*)address);
     7f34:	e0 91 00 02 	lds	r30, 0x0200

bootloaders/optiboot/optiboot_atmega328_pro_8MHz.hex

@@ -1,34 +1,34 @@
-:107E0000112484B714BE81FFE6D085E08093810001
-:107E100082E08093C00088E18093C10086E0809377
-:107E2000C20088E08093C4008EE0CFD0259A86E01F
-:107E300028E13EEF91E0309385002093840096BBCB
-:107E4000B09BFECF1D9AA8958150A9F7DD24D3944D
-:107E5000A5E0EA2EF1E1FF2EABD0813421F481E0E0
-:107E6000C5D083E020C0823411F484E103C085349E
-:107E700019F485E0BBD091C0853581F499D0082FE5
-:107E800010E096D090E0982F8827802B912B880FB8
-:107E9000991F90930102809300027EC0863529F4D9
-:107EA00084E0A4D080E07CD078C0843609F04EC055
-:107EB00087D0E0910002F091010280E7E030F807FE
-:107EC00018F483E087BFE895C0E0D1E071D08993D2
-:107ED000809102028150809302028823B9F7E091D9
-:107EE0000002F091010280E7E030F80718F083E02B
-:107EF00087BFE89575D007B600FCFDCF4091000222
-:107F000050910102A0E0B1E02C9130E011968C91EB
-:107F1000119790E0982F8827822B932B1296FA01C5
-:107F20000C01D7BEE89511244E5F5F4FF1E0A038F9
-:107F3000BF0751F7E0910002F0910102E7BEE8951A
-:107F400007B600FCFDCFF7BEE89527C08437B9F42B
-:107F500037D046D0E0910002F09101023196F093C3
-:107F60000102E09300023197E4918E2F19D08091A5
-:107F70000202815080930202882361F70EC0853788
-:107F800039F42ED08EE10CD085E90AD08FE08BCF6A
-:107F9000813511F488E019D023D080E101D05CCF85
-:107FA000982F8091C00085FFFCCF9093C600089564
-:107FB000A8958091C00087FFFCCF8091C6000895EE
-:107FC000F7DFF6DF80930202F3CFE0E6F0E098E11E
-:107FD00090838083089580E0F8DFEE27FF270994DF
-:107FE000E7DF803209F0F7DF84E1DACF1F93182F43
-:0C7FF000DFDF1150E9F7F4DF1F91089566
-:0400000300007E007B
+:10000000112484B714BE81FFE6D085E0809381007F
+:1000100082E08093C00088E18093C10086E08093F5
+:10002000C20088E08093C4008EE0CFD0259A86E09D
+:1000300028E13EEF91E0309385002093840096BB49
+:10004000B09BFECF1D9AA8958150A9F7DD24D394CB
+:10005000A5E0EA2EF1E1FF2EABD0813421F481E05E
+:10006000C5D083E020C0823411F484E103C085341C
+:1000700019F485E0BBD091C0853581F499D0082F63
+:1000800010E096D090E0982F8827802B912B880F36
+:10009000991F90930102809300027EC0863529F457
+:1000A00084E0A4D080E07CD078C0843609F04EC0D3
+:1000B00087D0E0910002F091010280E7E030F8077C
+:1000C00018F483E087BFE895C0E0D1E071D0899350
+:1000D000809102028150809302028823B9F7E09157
+:1000E0000002F091010280E7E030F80718F083E0A9
+:1000F00087BFE89575D007B600FCFDCF40910002A0
+:1001000050910102A0E0B1E02C9130E011968C9169
+:10011000119790E0982F8827822B932B1296FA0143
+:100120000C01D7BEE89511244E5F5F4FF1E0A03877
+:10013000BF0751F7E0910002F0910102E7BEE89598
+:1001400007B600FCFDCFF7BEE89527C08437B9F4A9
+:1001500037D046D0E0910002F09101023196F09341
+:100160000102E09300023197E4918E2F19D0809123
+:100170000202815080930202882361F70EC0853706
+:1001800039F42ED08EE10CD085E90AD08FE08BCFE8
+:10019000813511F488E019D023D080E101D05CCF03
+:1001A000982F8091C00085FFFCCF9093C6000895E2
+:1001B000A8958091C00087FFFCCF8091C60008956C
+:1001C000F7DFF6DF80930202F3CFE0E6F0E098E19C
+:1001D00090838083089580E0F8DFEE27FF2709945D
+:1001E000E7DF803209F0F7DF84E1DACF1F93182FC1
+:0C01F000DFDF1150E9F7F4DF1F910895E4
+:027FFE0001047C
 :00000001FF