firmware/bootloaderconfig.h

   1 /* Name: bootloaderconfig.h
   2  * Project: USBaspLoader
   3  * Author: Christian Starkjohann
   4  * Creation Date: 2007-12-08
   5  * Tabsize: 4
   6  * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH
   7  * License: GNU GPL v2 (see License.txt)
   8  * This Revision: $Id: bootloaderconfig.h 729 2009-03-20 09:03:58Z cs $
   9  */
  10
  11 #ifndef __bootloaderconfig_h_included__
  12 #define __bootloaderconfig_h_included__
  13
  14 /*
  15 General Description:
  16 This file (together with some settings in Makefile) configures the boot loader
  17 according to the hardware.
  18
  19 This file contains (besides the hardware configuration normally found in
  20 usbconfig.h) two functions or macros: bootLoaderInit() and
  21 bootLoaderCondition(). Whether you implement them as macros or as static
  22 inline functions is up to you, decide based on code size and convenience.
  23
  24 bootLoaderInit() is called as one of the first actions after reset. It should
  25 be a minimum initialization of the hardware so that the boot loader condition
  26 can be read. This will usually consist of activating a pull-up resistor for an
  27 external jumper which selects boot loader mode.
  28
  29 bootLoaderCondition() is called immediately after initialization and in each
  30 main loop iteration. If it returns TRUE, the boot loader will be active. If it
  31 returns FALSE, the boot loader jumps to address 0 (the loaded application)
  32 immediately.
  33
  34 For compatibility with Thomas Fischl's avrusbboot, we also support the macro
  35 names BOOTLOADER_INIT and BOOTLOADER_CONDITION for this functionality. If
  36 these macros are defined, the boot loader usees them.
  37 */
  38
  39 /* ---------------------------- Hardware Config ---------------------------- */
  40
  41 #define USB_CFG_IOPORTNAME      D
  42 /* This is the port where the USB bus is connected. When you configure it to
  43  * "B", the registers PORTB, PINB and DDRB will be used.
  44  */
  45 #define JUMPER_BIT              7       /* old value was 0 */
  46 /*
  47  * jumper is connected to this bit in port D, active low
  48  */
  49 #define USB_CFG_DMINUS_BIT      6       /* old value was 4 */
  50 /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
  51  * This may be any bit in the port.
  52  */
  53 #define USB_CFG_DPLUS_BIT       2
  54 /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
  55  * This may be any bit in the port. Please note that D+ must also be connected
  56  * to interrupt pin INT0!
  57  */
  58 #define USB_CFG_CLOCK_KHZ       (F_CPU/1000)
  59 /* Clock rate of the AVR in MHz. Legal values are 12000, 16000 or 16500.
  60  * The 16.5 MHz version of the code requires no crystal, it tolerates +/- 1%
  61  * deviation from the nominal frequency. All other rates require a precision
  62  * of 2000 ppm and thus a crystal!
  63  * Default if not specified: 12 MHz
  64  */
  65
  66 /* ----------------------- Optional Hardware Config ------------------------ */
  67
  68 /* #define USB_CFG_PULLUP_IOPORTNAME   D */
  69 /* If you connect the 1.5k pullup resistor from D- to a port pin instead of
  70  * V+, you can connect and disconnect the device from firmware by calling
  71  * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
  72  * This constant defines the port on which the pullup resistor is connected.
  73  */
  74 /* #define USB_CFG_PULLUP_BIT          4 */
  75 /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
  76  * above) where the 1.5k pullup resistor is connected. See description
  77  * above for details.
  78  */
  79
  80 /* ------------------------------------------------------------------------- */
  81 /* ---------------------- feature / code size options ---------------------- */
  82 /* ------------------------------------------------------------------------- */
  83
  84 #define HAVE_READ_LOCK_FUSE         1
  85 /*
  86  * enable the loaders capability to load its lfuse, hfuse and lockbits
  87  * ...However, programming of these is prohibited...
  88  */
  89
  90 #define HAVE_BLB11_SOFTW_LOCKBIT    1
  91 /*
  92  * The IC itself do not need to prgra BLB11, but the bootloader will avaoid
  93  * to erase itself from the bootregion
  94  */
  95
  96 #define HAVE_BLB11_SOFTW_BACKDOOR    1
  97 /*
  98  * When "HAVE_BLB11_SOFTW_LOCKBIT" is enabled, this backdoor will allow writing
  99  * to the BLS while JUMPER stays low. (keeps be pressed)
 100  * If JUMPER is released (and after a short debouncing period) repressing it
 101  * will have NO affect on disabling the writelock.
 102  */
 103
 104 #define HAVE_DOSPM_TUNNELCMD        1
 105 /*
 106  * When enabled, "HAVE_DOSPM_TUNNELCMD" will implement an PROGMEM ARRAY
 107  * with up to 15 opcodes within BLS.
 108  * This array will be called "bootloader__do_spm", and implements the
 109  * "do_spm" subroutine from atmels "Instruction Set Manual" Rev.0856I, page 140.
 110  * If additionally "HAVE_BLB11_SOFTW_BACKDOOR" is enabled, the array will just
 111  * contain "NOP()" instructions, since other code can be flashed into via
 112  * backdoor.
 113  *
 114 do_spm:
 115 ;input: spmcrval determines SPM action
 116 ;disable interrupts if enabled, store status
 117 ;temp1 will be register:        r7
 118 ;temp2 will be register:        r8
 119 ;spmcrval will be register:     r9
 120
 121 in      temp2, SREG     ; --> has to be done before calling
 122 cli                     ; --> has to be done before calling
 123                         ;check for previous SPM complete
 124 wait:
 125 in      temp1, SPMCR
 126 sbrc    temp1, SPMEN
 127 rjmp    wait
 128                         ;SPM timed sequence
 129 out     SPMCR, spmcrval
 130 spm
 131                         ;restore SREG (to enable interrupts if originally enabled)
 132 out     SREG, temp2
 133 ret
 134  *
 135  */
 136
 137 #define HAVE_EEPROM_PAGED_ACCESS    1
 138 /* If HAVE_EEPROM_PAGED_ACCESS is defined to 1, page mode access to EEPROM is
 139  * compiled in. Whether page mode or byte mode access is used by AVRDUDE
 140  * depends on the target device. Page mode is only used if the device supports
 141  * it, e.g. for the ATMega88, 168 etc. You can save quite a bit of memory by
 142  * disabling page mode EEPROM access. Costs ~ 138 bytes.
 143  */
 144 #define HAVE_EEPROM_BYTE_ACCESS     1
 145 /* If HAVE_EEPROM_BYTE_ACCESS is defined to 1, byte mode access to EEPROM is
 146  * compiled in. Byte mode is only used if the device (as identified by its
 147  * signature) does not support page mode for EEPROM. It is required for
 148  * accessing the EEPROM on the ATMega8. Costs ~54 bytes.
 149  */
 150 #define BOOTLOADER_CAN_EXIT         0
 151 /* If this macro is defined to 1, the boot loader will exit shortly after the
 152  * programmer closes the connection to the device. Costs ~36 bytes.
 153  */
 154 #define HAVE_CHIP_ERASE             0
 155 /* If this macro is defined to 1, the boot loader implements the Chip Erase
 156  * ISP command. Otherwise pages are erased on demand before they are written.
 157  */
 158 //#define SIGNATURE_BYTES             0x1e, 0x93, 0x07, 0     /* ATMega8 */
 159 /* This macro defines the signature bytes returned by the emulated USBasp to
 160  * the programmer software. They should match the actual device at least in
 161  * memory size and features. If you don't define this, values for ATMega8,
 162  * ATMega88, ATMega168 and ATMega328 are guessed correctly.
 163  */
 164
 165 /* The following block guesses feature options so that the resulting code
 166  * should fit into 2k bytes boot block with the given device and clock rate.
 167  * Activate by passing "-DUSE_AUTOCONFIG=1" to the compiler.
 168  * This requires gcc 3.4.6 for small enough code size!
 169  */
 170 #if USE_AUTOCONFIG
 171 #   undef HAVE_EEPROM_PAGED_ACCESS
 172 #   define HAVE_EEPROM_PAGED_ACCESS     (USB_CFG_CLOCK_KHZ >= 16000)
 173 #   undef HAVE_EEPROM_BYTE_ACCESS
 174 #   define HAVE_EEPROM_BYTE_ACCESS      1
 175 #   undef BOOTLOADER_CAN_EXIT
 176 #   define BOOTLOADER_CAN_EXIT          1
 177 #   undef SIGNATURE_BYTES
 178 #endif /* USE_AUTOCONFIG */
 179
 180 /* ------------------------------------------------------------------------- */
 181
 182 /* Example configuration: Port D bit 3 is connected to a jumper which ties
 183  * this pin to GND if the boot loader is requested. Initialization allows
 184  * several clock cycles for the input voltage to stabilize before
 185  * bootLoaderCondition() samples the value.
 186  * We use a function for bootLoaderInit() for convenience and a macro for
 187  * bootLoaderCondition() for efficiency.
 188  */
 189
 190 #ifndef __ASSEMBLER__   /* assembler cannot parse function definitions */
 191
 192 #ifndef MCUCSR          /* compatibility between ATMega8 and ATMega88 */
 193 #   define MCUCSR   MCUSR
 194 #endif
 195
 196 static inline void  bootLoaderInit(void)
 197 {
 198     PORTD |= (1 << JUMPER_BIT);     /* activate pull-up */
 199 //     deactivated by Stephan - reset after each avrdude op is annoing!
 200 //     if(!(MCUCSR & (1 << EXTRF)))    /* If this was not an external reset, ignore */
 201 //         leaveBootloader();
 202     MCUCSR = 0;                     /* clear all reset flags for next time */
 203 }
 204
 205 static inline void  bootLoaderExit(void)
 206 {
 207     PORTD = 0;                      /* undo bootLoaderInit() changes */
 208 }
 209
 210 #define bootLoaderCondition()           ((PIND & (1 << JUMPER_BIT)) == 0)
 211
 212 #endif /* __ASSEMBLER__ */
 213
 214 /* ------------------------------------------------------------------------- */
 215
 216 #endif /* __bootloader_h_included__ */