/* Name: bootloaderconfig.h
* Project: USBaspLoader
* Author: Christian Starkjohann
+ * Author: Stephan Baerwolf
* Creation Date: 2007-12-08
+ * Modification Date: 2012-11-10
* Tabsize: 4
* Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH
* License: GNU GPL v2 (see License.txt)
#ifndef __bootloaderconfig_h_included__
#define __bootloaderconfig_h_included__
+#include <avr/io.h>
/*
General Description:
these macros are defined, the boot loader usees them.
*/
+/* ---------------------------- Macro Magic ---------------------------- */
+#define PIN_CONCAT(a,b) a ## b
+#define PIN_CONCAT3(a,b,c) a ## b ## c
+
+#define PIN_PORT(a) PIN_CONCAT(PORT, a)
+#define PIN_PIN(a) PIN_CONCAT(PIN, a)
+#define PIN_DDR(a) PIN_CONCAT(DDR, a)
+
+#define PIN(a, b) PIN_CONCAT3(P, a, b)
+
/* ---------------------------- Hardware Config ---------------------------- */
-#define USB_CFG_IOPORTNAME D
+#ifndef USB_CFG_IOPORTNAME
+ #define USB_CFG_IOPORTNAME D
+#endif
/* This is the port where the USB bus is connected. When you configure it to
* "B", the registers PORTB, PINB and DDRB will be used.
*/
-#define JUMPER_BIT 7 /* old value was 0 */
-/*
- * jumper is connected to this bit in port D, active low
- */
-#define USB_CFG_DMINUS_BIT 6 /* old value was 4 */
+#ifndef USB_CFG_DMINUS_BIT
+ #define USB_CFG_DMINUS_BIT 6 /* old value was 4 */
+#endif
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
* This may be any bit in the port.
*/
-#define USB_CFG_DPLUS_BIT 2
+#ifndef USB_CFG_DPLUS_BIT
+ #define USB_CFG_DPLUS_BIT 2
+#endif
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
* This may be any bit in the port. Please note that D+ must also be connected
* to interrupt pin INT0!
*/
+#ifndef JUMPER_PORT
+ #define JUMPER_PORT USB_CFG_IOPORTNAME
+#endif
+/*
+ * jumper is connected to this port
+ */
+#ifndef JUMPER_BIT
+ #define JUMPER_BIT 7 /* old value was 0 */
+#endif
+/*
+ * jumper is connected to this bit in port "JUMPER_PORT", active low
+ */
+
#define USB_CFG_CLOCK_KHZ (F_CPU/1000)
/* Clock rate of the AVR in MHz. Legal values are 12000, 16000 or 16500.
* The 16.5 MHz version of the code requires no crystal, it tolerates +/- 1%
/* ---------------------- feature / code size options ---------------------- */
/* ------------------------------------------------------------------------- */
-#define HAVE_READ_LOCK_FUSE 1
+#ifndef CONFIG_NO__HAVE_READ_LOCK_FUSE
+ #define HAVE_READ_LOCK_FUSE 1
+#else
+ #define HAVE_READ_LOCK_FUSE 0
+#endif
/*
* enable the loaders capability to load its lfuse, hfuse and lockbits
* ...However, programming of these is prohibited...
*/
-#define HAVE_BLB11_SOFTW_LOCKBIT 1
+#ifndef CONFIG_NO__HAVE_BLB11_SOFTW_LOCKBIT
+ #define HAVE_BLB11_SOFTW_LOCKBIT 1
+#else
+ #define HAVE_BLB11_SOFTW_LOCKBIT 0
+#endif
/*
* The IC itself do not need to prgra BLB11, but the bootloader will avaoid
* to erase itself from the bootregion
*/
-#define HAVE_BLB11_SOFTW_BACKDOOR 1
+#ifndef CONFIG_NO__HAVE_SPMINTEREFACE
+ #define HAVE_SPMINTEREFACE 1
+#else
+ #define HAVE_SPMINTEREFACE 0
+#endif
/*
- * When "HAVE_BLB11_SOFTW_LOCKBIT" is enabled, this backdoor will allow writing
- * to the BLS while JUMPER stays low. (keeps be pressed)
- * If JUMPER is released (and after a short debouncing period) repressing it
- * will have NO affect on disabling the writelock.
+ * Since code within normal section of application memory (rww-section) is
+ * not able to call spm for programming flash-pages, this option (when
+ * enabled) will insert a small subroutine into the bootloader-section
+ * to enable applications to circumvent this limitation and make them
+ * able to program the flash in a similar way as the bootloader does, too.
+ * For further details see "spminterface.h", which implements this
+ * feature.
*/
-#define HAVE_DOSPM_TUNNELCMD 1
+#define HAVE_SPMINTEREFACE_NORETMAGIC 1
/*
- * When enabled, "HAVE_DOSPM_TUNNELCMD" will implement an PROGMEM ARRAY
- * with up to 13 opcodes within BLS.
- * This array will be called "bootloader__do_spm", and implements the
- * "do_spm" subroutine from atmels "Instruction Set Manual" Rev.0856I, page 140.
- * If additionally "HAVE_BLB11_SOFTW_BACKDOOR" is enabled, the array will just
- * contain "NOP()" instructions, since other code can be flashed into via
- * backdoor.
+ * If sth. went wrong within "bootloader__do_spm" and this macro is ACTIVATED,
+ * then "bootloader__do_spm" will not return the call and loop infinity instead.
*
-do_spm:
-;input: spmcrval determines SPM action
-;disable interrupts if enabled, store status
-;temp1 will be register: r7
-;temp2 will be register: r8
-;spmcrval will be register: r9
-
-in temp2, SREG ; --> has to be done before calling
-cli ; --> has to be done before calling
- ;check for previous SPM complete
-wait:
-in temp1, SPMCR
-sbrc temp1, SPMEN
-rjmp wait
- ;SPM timed sequence
-out SPMCR, spmcrval
-spm
- ;restore SREG (to enable interrupts if originally enabled)
-out SREG, temp2
-ret
+ * This feature prevents old updaters to do sth. undefined on wrong magic.
+ */
+
+/* all boards should use a magic to make it safe to confuse updatefiles :-) */
+#define HAVE_SPMINTEREFACE_MAGICVALUE 0
+/* If this feature is enabled (value != 0), the configured 32bit value is
+ * used as a magic value within spminterface. "bootloader__do_spm" will check
+ * additional four (4) registers for this value and only proceed, if they contain
+ * the right value. With this feature you can identify your board and avoid
+ * updating the wrong bootloader to the wrong board!
+ *
+ * Not all values are possible - "SPMINTEREFACE_MAGICVALUE" must be very sparse!
+ * To avoid collisions, magic-values will be organized centrally by Stephan
+ * Following values are definitly blocked or reserved and must not be used:
+ * 0x00000000, 0x12345678,
+ * 0x00a500a5, 0x00a5a500, 0xa50000a5, 0xa500a500,
+ * 0x005a005a, 0x005a5a00, 0x5a00005a, 0x5a005a00,
+ * 0x5aa55aa5, 0x5aa5a55a, 0xa55a5aa5, 0xa55aa55a,
+ * 0x5a5a5a5a, 0xa5a5a5a5,
+ * 0xffa5ffa5, 0xffa5a5ff, 0xa5ffffa5, 0xa5ffa5ff,
+ * 0xff5aff5a, 0xff5a5aff, 0x5affff5a, 0x5aff5aff,
+ * 0x00ff00ff, 0x00ffff00, 0xff0000ff, 0xff00ff00,
+ * 0xffffffff
*
+ * To request your own magic, please send at least following information
+ * about yourself and your board together within an informal request to:
+ * stephan@matrixstorm.com / matrixstorm@gmx.de / stephan.baerwolf@tu-ilmenau.de
+ * - your name
+ * - your e-mail
+ * - your project (maybe an url?)
+ * - your type of MCU used
+ * --> your used "BOOTLOADER_ADDRESS" (since same magics can be reused for different "BOOTLOADER_ADDRESS")
+ *
+ * There may be no garanty for it, but Stephan will then send you an
+ * response with a "SPMINTEREFACE_MAGICVALUE" just for your board/project...
+ * WITH REQUESTING A MAGIC YOU AGREE TO PUBLISHED YOUR DATA SEND WITHIN THE REQUEST
*/
#define HAVE_EEPROM_PAGED_ACCESS 1
* signature) does not support page mode for EEPROM. It is required for
* accessing the EEPROM on the ATMega8. Costs ~54 bytes.
*/
-#define BOOTLOADER_CAN_EXIT 0
+
+#ifndef CONFIG_NO__BOOTLOADER_CAN_EXIT
+ #define BOOTLOADER_CAN_EXIT 1
+#else
+ #define BOOTLOADER_CAN_EXIT 0
+#endif
/* If this macro is defined to 1, the boot loader will exit shortly after the
- * programmer closes the connection to the device. Costs ~36 bytes.
+ * programmer closes the connection to the device. Costs extra bytes.
*/
+
#define HAVE_CHIP_ERASE 0
/* If this macro is defined to 1, the boot loader implements the Chip Erase
* ISP command. Otherwise pages are erased on demand before they are written.
*/
+
+#ifndef CONFIG_NO__NEED_WATCHDOG
+ #define NEED_WATCHDOG 1
+#else
+ #define NEED_WATCHDOG 0
+#endif
+/* ATTANTION: This macro MUST BE 1, if the MCU has reset enabled watchdog (WDTON is 0).
+ * If this macro is defined to 1, the bootloader implements an additional "wdt_disable()"
+ * after its contional entry point.
+ * If the used MCU is fused not to enable watchdog after reset (WDTON is 1 - safty level 1)
+ * then "NEED_WATCHDOG" may be deactivated in order to save some memory.
+ */
+
+#ifndef CONFIG_NO__PRECISESLEEP
+ #define HAVE_UNPRECISEWAIT 0
+#else
+ #define HAVE_UNPRECISEWAIT 1
+#endif
+/* This macro enables hand-optimized assembler code
+ * instead to use _sleep_ms for delaying USB enumeration.
+ * Because normally these timings do not need to be exact,
+ * the optimized assembler code does not need to be precise.
+ * Therefore it is very small, which saves some PROGMEM bytes!
+ */
+
//#define SIGNATURE_BYTES 0x1e, 0x93, 0x07, 0 /* ATMega8 */
/* This macro defines the signature bytes returned by the emulated USBasp to
* the programmer software. They should match the actual device at least in
* ATMega88, ATMega168 and ATMega328 are guessed correctly.
*/
-/* The following block guesses feature options so that the resulting code
- * should fit into 2k bytes boot block with the given device and clock rate.
- * Activate by passing "-DUSE_AUTOCONFIG=1" to the compiler.
- * This requires gcc 3.4.6 for small enough code size!
- */
-#if USE_AUTOCONFIG
-# undef HAVE_EEPROM_PAGED_ACCESS
-# define HAVE_EEPROM_PAGED_ACCESS (USB_CFG_CLOCK_KHZ >= 16000)
-# undef HAVE_EEPROM_BYTE_ACCESS
-# define HAVE_EEPROM_BYTE_ACCESS 1
-# undef BOOTLOADER_CAN_EXIT
-# define BOOTLOADER_CAN_EXIT 1
-# undef SIGNATURE_BYTES
-#endif /* USE_AUTOCONFIG */
/* ------------------------------------------------------------------------- */
static inline void bootLoaderInit(void)
{
- PORTD |= (1 << JUMPER_BIT); /* activate pull-up */
+ PIN_DDR(JUMPER_PORT) = 0;
+ PIN_PORT(JUMPER_PORT) = (1<< PIN(JUMPER_PORT, JUMPER_BIT)); /* activate pull-up */
+
// deactivated by Stephan - reset after each avrdude op is annoing!
// if(!(MCUCSR & (1 << EXTRF))) /* If this was not an external reset, ignore */
// leaveBootloader();
+
MCUCSR = 0; /* clear all reset flags for next time */
}
static inline void bootLoaderExit(void)
{
- PORTD = 0; /* undo bootLoaderInit() changes */
+ PIN_PORT(JUMPER_PORT) = 0; /* undo bootLoaderInit() changes */
}
-#define bootLoaderCondition() ((PIND & (1 << JUMPER_BIT)) == 0)
+#define bootLoaderCondition() ((PIN_PIN(JUMPER_PORT) & (1 << PIN(JUMPER_PORT, JUMPER_BIT))) == 0)
#endif /* __ASSEMBLER__ */