* Author: Christian Starkjohann
* Author: Stephan Baerwolf
* Creation Date: 2007-12-08
- * Modification Date: 2012-11-10
+ * Modification Date: 2013-03-31
* Tabsize: 4
* Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH
* License: GNU GPL v2 (see License.txt)
- * This Revision: $Id: bootloaderconfig.h 729 2009-03-20 09:03:58Z cs $
*/
#ifndef __bootloaderconfig_h_included__
#define __bootloaderconfig_h_included__
-#include <avr/io.h>
+#include "../misc/iofixes.h"
/*
General Description:
/* 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.
*/
+#ifndef USB_CFG_INTPORT_BIT
+ #if (defined(__AVR_ATmega640__) || defined (__AVR_ATmega128__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega2561__))
+ #define USB_CFG_INTPORT_BIT 0
+ #else
+ #define USB_CFG_INTPORT_BIT 2
+ #endif
+#endif
+/* Not all devices have their INT0 on PD2.
+ * Since "INT0" and "USB_CFG_DPLUS_BIT" should get the same signals,
+ * map them to be ideally the same:
+ * So abstract "USB_CFG_DPLUS_BIT" to this one here.
+ */
+
#ifndef USB_CFG_DMINUS_BIT
- #define USB_CFG_DMINUS_BIT 6 /* old value was 4 */
+ /* This is Revision 3 and later (where PD6 and PD7 were swapped */
+ #define USB_CFG_DMINUS_BIT 7 /* Rev.2 and previous was 6 */
#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.
*/
#ifndef USB_CFG_DPLUS_BIT
- #define USB_CFG_DPLUS_BIT 2
+ #define USB_CFG_DPLUS_BIT USB_CFG_INTPORT_BIT
#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
* jumper is connected to this port
*/
#ifndef JUMPER_BIT
- #define JUMPER_BIT 7 /* old value was 0 */
+ /* This is Revision 3 and later (where PD6 and PD7 were swapped */
+ #define JUMPER_BIT 6 /* Rev.2 and previous was 7 */
#endif
/*
* jumper is connected to this bit in port "JUMPER_PORT", active low
* 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
+ *
+ *
+ * ***************************************************************************
+ * ***************************************************************************
+ *
+ * Because of pressing interest there will be following free-for-use scheme.
+ * It will always start with 0xf as the 4 most significant bits, and then
+ * can be encoded based of the signature of the AVR, the IO-Port used for USB,
+ * the USB dataline PINs, the external interrupt used for USB, the clock frequency
+ * the BOD voltage and if the watchdog is enabled by fuses.
+ *
+ * The magic will be: 0xf??????? in binary 0b1111ZZZZ YYYYYYYY WXXXVUUU TTSSSRRR
+ *
+ * --> where the 4 bit of Z correspond to the middle of the 3 byte AVR signature:
+ * SIGNATURE_1 == 0x90 <--> ZZZZ == 0b0000
+ * SIGNATURE_1 == 0x91 <--> ZZZZ == 0b0001
+ * SIGNATURE_1 == 0x92 <--> ZZZZ == 0b0010
+ * SIGNATURE_1 == 0x93 <--> ZZZZ == 0b0011
+ * SIGNATURE_1 == 0x94 <--> ZZZZ == 0b0100
+ * SIGNATURE_1 == 0x95 <--> ZZZZ == 0b0101
+ * SIGNATURE_1 == 0x96 <--> ZZZZ == 0b0110
+ * SIGNATURE_1 == 0x97 <--> ZZZZ == 0b0111
+ * SIGNATURE_1 == 0x98 <--> ZZZZ == 0b1000
+ * SIGNATURE_1 == 0xA6 <--> ZZZZ == 0b1001
+ * SIGNATURE_1 == 0xA7 <--> ZZZZ == 0b1010 *
+ * SIGNATURE_1 == 0xA8 <--> ZZZZ == 0b1011
+ * reserved ZZZZ == 0b1100 *
+ * not free (database magics) ZZZZ == 0b1101 *
+ * not free (database magics) ZZZZ == 0b1110 *
+ * not free (database magics) ZZZZ == 0b1111 *
+ * If the AVRs SIGNATURE_1 is different from the presented 12, this coding scheme is
+ * not applicable for you - please ask for a personal magic in this case.
+ *
+ *
+ * --> where the 8 bit of Y are the SIGNATURE_2 byte (for example 0b00000111 on ATmega8)
+ *
+ *
+ * --> where the 1 bit of W is watchdog enabled by fuse: 0=no, 1=yes (WD enabled)
+ *
+ *
+ * --> where the 3 bit of X are the (external) crystal clockspeed
+ * 12MHz external crystal <--> XXX == 0b000
+ * 12.8MHz external crystal <--> XXX == 0b001
+ * reserved <--> XXX == 0b010
+ * 15MHz external crystal <--> XXX == 0b011
+ * 16MHz external crystal <--> XXX == 0b100
+ * 16.5MHz external crystal <--> XXX == 0b101
+ * 18MHz external crystal <--> XXX == 0b110
+ * 20MHz external crystal <--> XXX == 0b111
+ * If your clockspeed is different from the presented 8, this coding scheme is
+ * not applicable for you - please ask for a personal magic in this case.
+ *
+ *
+ * --> where the 1 bit of V depends on the controllers Vcc:
+ * 4.5V (ususally 5V) <--> V == 0
+ * 3.3V <--> V == 1
+ *
+ *
+ * --> where the 3 bit of U define the PORT (USB_CFG_IOPORTNAME) for USB
+ * PORTA <--> UUU == 0b000
+ * PORTB <--> UUU == 0b001
+ * PORTC <--> UUU == 0b010
+ * PORTD <--> UUU == 0b011
+ * PORTE <--> UUU == 0b100
+ * PORTF <--> UUU == 0b101
+ * PORTG <--> UUU == 0b110
+ * PORTH <--> UUU == 0b111
+ * If your PORT is different from the presented 8:
+ * This coding scheme is more an example. UUU=0b000 really means, the first GPIO port
+ * on the specified MCU. (0b001 is the second, 0b010 the third...)
+ * Normally there aren't more then 8 GPIO ports on an AVR - so this coding works.
+ * If there are more then 8, only the first 8 ports can be encoded and otherwise
+ * this coding scheme is not applicable for you - please ask for a personal magic in this case.
+ *
+ *
+ * --> where the 2 bit of T define the external interrupt used for USBD
+ * INT0 <--> TT == 0b00
+ * INT1 <--> TT == 0b01
+ * INT2 <--> TT == 0b10
+ * INT3 <--> TT == 0b11
+ * If you use a different interrupt, this coding scheme is not applicable
+ * for you - please ask for a personal magic in this case.
+ *
+ *
+ * --> where the 3 bit of S define the PIN (on the previous encoded port) for USB+
+ * (basically the value of USB_CFG_DPLUS_BIT)
+ * 0 <--> SSS == 0b000
+ * 1 <--> SSS == 0b001
+ * ...
+ * 7 <--> SSS == 0b111
+ *
+ *
+ * --> where the 3 bit of R define the PIN (on the previous encoded port) for USB-
+ * (basically the value of USB_CFG_DMINUS_BIT)
+ * 0 <--> RRR == 0b000
+ * 1 <--> RRR == 0b001
+ * ...
+ * 7 <--> RRR == 0b111
+ *
+ *
+ * WARNING:
+ * Please note, that this 0xf------- magic does not include
+ * any information about the bootloader condition pin (and port)!
+ * This magic just ensures basic protection against different
+ * layouts. (Which only covers essential data)
+ *
+ * ?Maybe as a heuristic?:
+ * The bootloader condition pin should be the same port as USB,
+ * at the pin before USB_CFG_DMINUS_BIT.
+ *
+ * If you want to be very safe, request your own magic...
+ *
+ *
+ *
+ * Examples (USB pinning are defaults from this file):
+ *
+ * "ATmega8@16MHz powered with 5V and no watchdog fused": 0xf3078317
+ * The same just for ATmega328p: 0xf50f8317
+ *
+ * "ATmega1024p @ 20MHz powered with 3V and watchdog fused active": 0xf705fb17
+ * "ATmega2560 @ 12MHz powered with 5V and watchdog fused active": 0xf8010307
+ *
+ * ***************************************************************************
+ * ***************************************************************************
+ *
*/
#ifndef CONFIG_NO__EEPROM_PAGED_ACCESS
* (except registers and IO), since RESET will NOT clear old RAM content.
*/
+#ifdef CONFIG_NO__BOOTLOADERENTRY_FROMSOFTWARE
+# define HAVE_BOOTLOADERENTRY_FROMSOFTWARE 0
+#else
+# define HAVE_BOOTLOADERENTRY_FROMSOFTWARE 1
+#endif
+/*
+ * Enable firmware to boot the bootloader without
+ * user intervention
+ */
+
+#ifdef CONFIG_NO__BOOTLOADER_HIDDENEXITCOMMAND
+# define HAVE_BOOTLOADER_HIDDENEXITCOMMAND 0
+#else
+# define HAVE_BOOTLOADER_HIDDENEXITCOMMAND 0xff
+#endif
+/*
+ * When enabling "BOOTLOADER_HIDDENEXITCOMMAND", then
+ * sending the RAW-ISP command "0xff 0xXX 0xXX 0xXX"
+ * will cause the bootloader to start the firmware
+ * as soon as the programming software disconnects.
+ */
+
+#ifdef CONFIG_BOOTLOADER_LOOPCYCLES_TIMEOUT
+# define BOOTLOADER_LOOPCYCLES_TIMEOUT (CONFIG_BOOTLOADER_LOOPCYCLES_TIMEOUT)
+#else
+# define BOOTLOADER_LOOPCYCLES_TIMEOUT (0)
+#endif
+/*
+ * When greater than "0", "BOOTLOADER_LOOPCYCLES_TIMEOUT"
+ * defines how many 16bit loopcycles can be cycled,
+ * before bootloader times out and starts user
+ * firmware.
+ * Of course "BOOTLOADER_CAN_EXIT" must be enabled.
+ * If value is even too small, bootloader will not
+ * exit as long as bootLoaderConditionSimple stays on.
+ */
+
+#ifdef CONFIG_HAVE__BOOTLOADER_ABORTTIMEOUTONACT
+#endif
+/*
+ * When defined, the bootloader will abort the timeout when
+ * it sees some activity (bootLoaderConditionSimple() or
+ * programming).
+ * After aborting timeout, the bootloader falls back to
+ * conventional exitting.
+ */
+
+#ifdef CONFIG_HAVE__BOOTLOADER_ALWAYSENTERPROGRAMMODE
+# if (BOOTLOADER_CAN_EXIT)
+# define BOOTLOADER_ALWAYSENTERPROGRAMMODE 1
+# else
+# define BOOTLOADER_ALWAYSENTERPROGRAMMODE 0
+# endif
+#else
+# define BOOTLOADER_ALWAYSENTERPROGRAMMODE 0
+#endif
+/*
+ * Ignore bootLoaderCondition() (BUT NOT bootLoaderConditionSimple())
+ * and always enter the program-mode.
+ * This is helpful to emulate behaviour of Arduino bootloaders
+ *
+ * However, this feature may be dangerous, since bootloader may never exit.
+ * So it is enabled, only if "CONFIG_NO__BOOTLOADER_CAN_EXIT" is disabled.
+ *
+ */
+
+#ifdef CONFIG_HAVE__BOOTLOADER_IGNOREPROGBUTTON
+# if ( (BOOTLOADER_ALWAYSENTERPROGRAMMODE) && (defined(BOOTLOADER_CAN_EXIT)) && (BOOTLOADER_LOOPCYCLES_TIMEOUT >= 8) )
+# define BOOTLOADER_IGNOREPROGBUTTON 1
+# else
+# define BOOTLOADER_IGNOREPROGBUTTON 0
+# endif
+#endif
+/*
+ * Generates an USBaspLoader without using the PROGBUTTON.
+ * It can be used to reduce the required PINcount for USBaspLoader
+ * on the MCU.
+ * However this feature is very dangerous, so it becomes only
+ * enabled, if "CONFIG_HAVE__BOOTLOADER_ALWAYSENTERPROGRAMMODE" is
+ * enabled and "CONFIG_NO__BOOTLOADER_CAN_EXIT" is disabled, too.
+ * Additionally "BOOTLOADER_LOOPCYCLES_TIMEOUT" must be greater
+ * or equal than 8 (In order to give user enough time to program).
+ *
+ * When active, "JUMPER_PORT" and "JUMPER_BIT" are ignored and
+ * can be soldered otherwise.
+ */
+
+#ifdef CONFIG_NO__BOOTLOADER_ADDITIONALDEVICEWAIT
+# define HAVE_BOOTLOADER_ADDITIONALMSDEVICEWAIT 0
+#else
+# define HAVE_BOOTLOADER_ADDITIONALMSDEVICEWAIT 50
+#endif
+/*
+ * When enabling "HAVE_BOOTLOADER_ADDITIONALMSDEVICEWAIT", then
+ * the bootloader will alway delay its bootup by the configured
+ * number of milliseconds.
+ * This gives the pullups additional time to charge up.
+ */
+
//#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
static inline void bootLoaderInit(void)
{
+#if (BOOTLOADER_IGNOREPROGBUTTON)
+#else
PIN_DDR(JUMPER_PORT) = 0;
PIN_PORT(JUMPER_PORT) = (1<< PIN(JUMPER_PORT, JUMPER_BIT)); /* activate pull-up */
+#endif
// 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)
{
+#if (BOOTLOADER_IGNOREPROGBUTTON)
+#else
PIN_PORT(JUMPER_PORT) = 0; /* undo bootLoaderInit() changes */
+#endif
}
-#define bootLoaderCondition() ((PIN_PIN(JUMPER_PORT) & (1 << PIN(JUMPER_PORT, JUMPER_BIT))) == 0)
+
+#if (BOOTLOADER_IGNOREPROGBUTTON)
+# define bootLoaderConditionSimple() (false)
+#else
+# define bootLoaderConditionSimple() ((PIN_PIN(JUMPER_PORT) & (1 << PIN(JUMPER_PORT, JUMPER_BIT))) == 0)
+#endif
+
+#if (HAVE_BOOTLOADERENTRY_FROMSOFTWARE)
+/*
+ * How it works: The idea
+ *
+ * During normal C initialization, the stackpointer (SP) always is pointed to
+ * SRAMs end, where it grows towards RAMSTART.
+ *
+ * Check if last possible pushed address in stack is bootloaders address.
+ * Store investigation result into "__BOOTLOADERENTRY_FROMSOFTWARE__bootup_RAMEND_doesmatch"
+ * Result will be "0xff" in case of mismatch.
+ */
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#define __BOOTLOADERENTRY_FROMSOFTWARE__EXPECTEDADDRESS (BOOTLOADER_ADDRESS>>1)
+static volatile uint8_t __BOOTLOADERENTRY_FROMSOFTWARE__bootup_RAMEND_doesmatch __attribute__ ((section(".noinit")));
+static volatile uint8_t __BOOTLOADERENTRY_FROMSOFTWARE__bootup_MCUCSR __attribute__ ((section(".noinit")));
+
+# if (BOOTLOADER_ALWAYSENTERPROGRAMMODE)
+# define bootLoaderCondition() (true)
+# else
+static inline bool bootLoaderCondition(void)
+{
+ if (__BOOTLOADERENTRY_FROMSOFTWARE__bootup_MCUCSR & (~(_BV(WDRF)))) {
+ } else {
+ if (__BOOTLOADERENTRY_FROMSOFTWARE__bootup_RAMEND_doesmatch == (__BOOTLOADERENTRY_FROMSOFTWARE__EXPECTEDADDRESS & 0xff)) {
+ // anything else: match - the firmware is calling the bootloader
+ return true;
+ }
+ }
+ return bootLoaderConditionSimple();
+}
+# endif
+#else
+# if (BOOTLOADER_ALWAYSENTERPROGRAMMODE)
+# define bootLoaderCondition() (true)
+# else
+# define bootLoaderCondition bootLoaderConditionSimple
+# endif
+#endif
#endif /* __ASSEMBLER__ */
projects / pub / USBaspLoader.git / blobdiff