avrboot/main.c

/*****************************************************************************
*
* AVRPROG compatible boot-loader
* Version  : 0.80beta (May 2006)
* Compiler : avr-gcc 3.4.6 / avr-libc 1.4.4
* size     : depends on features and startup ( minmal features < 512 words)
* by       : Martin Thomas, Kaiserslautern, Germany
*            eversmith@heizung-thomas.de
*            Additional code and improvements contributed by:
*           - Uwe Bonnes
*           - Bjoern Riemer
*           - Olaf Rempel
*
* License  : Copyright (c) 2006 Martin Thomas
*            Free to use. You have to mention the copyright
*            owners in source-code and documentation of derived
*            work. No warranty!
*
* Tested with ATmega8, ATmega16, ATmega32, ATmega128, AT90CAN128
*
* - Initial versions have been based on the Butterfly bootloader-code
*   by Atmel Corporation (Authors: BBrandal, PKastnes, ARodland, LHM)
*
****************************************************************************
*
*  See the makefile for information how to adopt the linker-settings to
*  the selected Boot Size (BOOTSIZE=xxxx), the AVR clock-frequency and the
*  MCU-type in
*
*  With BOOT_SIMPLE this bootloader has
*  0x2EA - atmega8
*  0x368 - atmega16
*  0x382 - atmega169
*  0x368 - atmega32
*  0x360 - atmega128
*  0x372 - at90can128
*  bytes size and should fit into a 512word bootloader-section.
*
****************************************************************************/
/*
	Does not work reliably so far:
	- lock bits set
*/

// programmers-notepad tabsize 4
#define VERSION_HIGH '0'
#define VERSION_LOW  '7'

/* MCU frequency */
#define F_CPU 7372800

/* UART Baudrate */
#define BAUDRATE 115200

/* use "Double Speed Operation" */
//#define UART_DOUBLESPEED

/* use second UART on mega128 / can128 */
//#define UART_USE_SECOND

/*
 * Pin "STARTPIN" on port "STARTPORT" in this port has to grounded
 * (active low) to start the bootloader
 */
#define BLPORT		PORTB
#define BLDDR		DDRB
#define BLPIN		PINB
#define BLPNUM		PINB0

/*
 * Select startup-mode
 * SIMPLE-Mode - Jump to bootloader main BL-loop if key is
 *   pressed (Pin grounded) "during" reset or jump to the
 *   application if the pin is not grounded (=pulled up by
 *   internal pull-up-resistor)
 * POWERSAVE-Mode - Startup is separated in two loops
 *   which makes power-saving a little easier if no firmware
 *   is on the chip. Needs more memory
 * BOOTICE-Mode - to flash the JTAGICE upgrade.ebn file.
 *   No startup-sequence in this mode. Jump directly to the
 *   parser-loop on reset
 *   F_CPU in BOOTICEMODE must be 7372800 Hz to be compatible
 *   with the org. JTAGICE-Firmware
 * WAIT-mode waits 1 sec for the S command if nothing is recived
 *	  then the user prog is started ..
 */
#define START_SIMPLE
//#define START_WAIT
//#define START_POWERSAVE
//#define START_BOOTICE

/*
 * enable/disable readout of fuse and lock-bits
 * (will not work for Mega169 since not supported by AVRPROG 1.37
 */
//#define ENABLEREADFUSELOCK

 /* enable/disable write of lock-bits
 * WARNING: lock-bits can not be reseted by bootloader (as far as I know)
 * Only protection no unprotection, "chip erase" from bootloader only
 * clears the flash but does no real "chip erase" (this is not possible
 * with a bootloader as far as I know)
 * Keep this undefined!
 */
//#define WRITELOCKBITS

#include <stdint.h>
#include <avr/io.h>
#include <avr/wdt.h>
#include <avr/boot.h>
#include <avr/pgmspace.h>

#include "chipdef.h"

uint8_t gBuffer[SPM_PAGESIZE];

static void sendchar(uint8_t data)
{
	while (!(UART_STATUS & (1<<UART_TXREADY)));
	UART_DATA = data;
}

static uint8_t recvchar(void)
{
	while (!(UART_STATUS & (1<<UART_RXREADY)));
	return UART_DATA;
}

static inline void eraseFlash(void)
{
	// erase only main section (bootloader protection)
	uint32_t addr = 0;
	while (APP_END > addr) {
		boot_page_erase(addr);		// Perform page erase
		boot_spm_busy_wait();		// Wait until the memory is erased.
		addr += SPM_PAGESIZE;
	}
	boot_rww_enable();
}

static inline void recvBuffer(pagebuf_t size)
{
	pagebuf_t cnt;
	for (cnt = 0; cnt < sizeof(gBuffer); cnt++) {
		if (cnt < size)
			gBuffer[cnt] = recvchar();
		else
			gBuffer[cnt] = 0xFF;
	}
}

static inline uint16_t writeFlashPage(uint16_t waddr, pagebuf_t size)
{
	uint32_t pagestart = (uint32_t)waddr<<1;
	uint32_t baddr = pagestart;
	uint16_t data;
	pagebuf_t cnt = 0;

	do {
		data = gBuffer[cnt++];
		data |= gBuffer[cnt++] << 8;
		boot_page_fill(baddr, data);	// call asm routine.

		baddr += 2;			// Select next word in memory
		size -= 2;			// Reduce number of bytes to write by two
	} while (size);				// Loop until all bytes written

	boot_page_write(pagestart);
	boot_spm_busy_wait();
	boot_rww_enable();			// Re-enable the RWW section

	return baddr>>1;
}

static inline uint16_t writeEEpromPage(uint16_t address, pagebuf_t size)
{
	pagebuf_t cnt = 0;

	do {
		EEARL = address;		// Setup EEPROM address
		EEARH = (address >> 8);
		EEDR = gBuffer[cnt++];
		address++;			// Select next byte

		EECR |= (1<<EEMWE);		// Write data into EEPROM
		EECR |= (1<<EEWE);
		eeprom_busy_wait();

		size--;				// Decreas number of bytes to write
	} while (size);				// Loop until all bytes written

	return address;
}

static inline uint16_t readFlashPage(uint16_t waddr, pagebuf_t size)
{
	uint32_t baddr = (uint32_t)waddr<<1;
	uint16_t data;

	do {
#if defined(RAMPZ)
		data = pgm_read_word_far(baddr);
#else
		data = pgm_read_word_near(baddr);
#endif
		sendchar(data);			// send LSB
		sendchar((data >> 8));		// send MSB
		baddr += 2;			// Select next word in memory
		size -= 2;			// Subtract two bytes from number of bytes to read
	} while (size);				// Repeat until all block has been read

	return baddr>>1;
}

static inline uint16_t readEEpromPage(uint16_t address, pagebuf_t size)
{
	do {
		EEARL = address;		// Setup EEPROM address
		EEARH = (address >> 8);
		EECR |= (1<<EERE);		// Read EEPROM
		address++;			// Select next EEPROM byte

		sendchar(EEDR);			// Transmit EEPROM data to PC

		size--;				// Decrease number of bytes to read
	} while (size);				// Repeat until all block has been read

	return address;
}

static uint8_t read_fuse_lock(uint16_t addr, uint8_t mode)
{
	uint8_t retval;

	asm volatile
	(
		"movw r30, %3\n\t" /* Z to addr */ \
		"sts %0, %2\n\t" /* set mode in SPM_REG */ \
		"lpm\n\t"  /* load fuse/lock value into r0 */ \
		"mov %1,r0\n\t" /* save return value */ \
		: "=m" (SPM_REG),
		  "=r" (retval)
		: "r" (mode),
		  "r" (addr)
		: "r30", "r31", "r0"
	);
	return retval;
}

static void send_boot(void)
{
	sendchar('A');
	sendchar('V');
	sendchar('R');
	sendchar('B');
	sendchar('O');
	sendchar('O');
	sendchar('T');
}

static void (*jump_to_app)(void) = 0x0000;

int main(void)
{
	uint16_t address = 0;
	uint8_t device = 0, val;

#ifdef START_POWERSAVE
	uint8_t OK = 1;
#endif

	BLDDR  &= ~(1<<BLPNUM);		// set as Input
	BLPORT |= (1<<BLPNUM);		// Enable pullup

	// Set baud rate
	UART_BAUD_HIGH = (UART_CALC_BAUDRATE(BAUDRATE)>>8) & 0xFF;
	UART_BAUD_LOW = (UART_CALC_BAUDRATE(BAUDRATE) & 0xFF);

#ifdef UART_DOUBLESPEED
	UART_STATUS = UART_DOUBLE;
#endif

	UART_CTRL = UART_CTRL_DATA;
	UART_CTRL2 = UART_CTRL2_DATA;

#ifdef START_POWERSAVE
	/*
		This is an adoption of the Butterfly Bootloader startup-sequence.
		It may look a little strange but separating the login-loop from
		the main parser-loop gives a lot a possibilities (timeout, sleep-modes
	    etc.).
	*/
	for(;OK;) {
		if ((BLPIN & (1<<BLPNUM))) {
			// jump to main app if pin is not grounded
			BLPORT &= ~(1<<BLPNUM);	// set to default
			jump_to_app();		// Jump to application sector

		} else {
			val = recvchar();
			/* ESC */
			if (val == 0x1B) {
				// AVRPROG connection
				// Wait for signon
				while (val != 'S')
					val = recvchar();

				send_boot();			// Report signon
				OK = 0;

			} else {
				sendchar('?');
			}
	        }
		// Power-Save code here
	}

#elif defined(START_SIMPLE)

	if ((BLPIN & (1<<BLPNUM))) {
		// jump to main app if pin is not grounded
		BLPORT &= ~(1<<BLPNUM);		// set to default
		jump_to_app();			// Jump to application sector
	}

#elif defined(START_WAIT)

	// Timer-Setup for ATmega8
	// - verify that the configuration is valid for the target AVR

	#define MY_WAIT 900
	// wait ca 1 sec (900ms)
	TCCR1A = 0; // timer setup
	// F_OSC / 8 / 1000 -> 1ms
	#if (((F_CPU / 8 / 1000)*MY_WAIT) < 65535)
		#warning Information: setting prescaler to 8
		#define WAIT_VALUE ((F_CPU / 8 / 1000)*MY_WAIT)
		TCCR1B |= (1<<CS01);
	#elif ((((F_CPU / 64 / 1000)*MY_WAIT) < 65535))
		#warning Information: setting prescaler to 64
		#define WAIT_VALUE ((F_CPU / 64 / 1000)*MY_WAIT)
		TCCR1B |= (1<<CS01) | (1<<CS00);
	#elif ((((F_CPU / 256 / 1000)*MY_WAIT) < 65535))
		#warning Information: setting prescaler to 256
		#define WAIT_VALUE ((F_CPU / 256 / 1000)*MY_WAIT)
		TCCR1B |= (1<<CS02);
	#else //((((F_CPU / 1024 / 1000)*MY_WAIT) < 65535))
		#warning Information: setting prescaler to 1024
		#define WAIT_VALUE ((F_CPU / 1024 / 1000)*MY_WAIT)
		TCCR1B |= (1<<CS00) | (1<<CS02); //1024 prescaler
	#endif

	while (1) {
		if (UART_STATUS & (1<<UART_RXREADY)) {
			if (UART_DATA == 'S')
				break;
		}
		if (TCNT1 >= WAIT_VALUE){
			BLPORT &= ~(1<<BLPNUM);		// set to default
			TCCR1B = 0;			// timer off
			jump_to_app();			// Jump to application sector
		}
	}
	TCCR1B = 0; // timer off
	send_boot();

#elif defined(START_BOOTICE)
#warning "BOOTICE mode - no startup-condition"

#else
#error "Select START_ condition for bootloader in main.c"
#endif

	for(;;) {
		val = recvchar();
		// Autoincrement?
		if (val == 'a') {
			sendchar('Y');			// Autoincrement is quicker

		//write address
        	} else if (val == 'A') {
			address = recvchar();		//read address 8 MSB
			address = (address<<8) | recvchar();
			sendchar('\r');

		// Buffer load support
		} else if (val == 'b') {
			sendchar('Y');					// Report buffer load supported
			sendchar((sizeof(gBuffer) >> 8) & 0xFF);	// Report buffer size in bytes
			sendchar(sizeof(gBuffer) & 0xFF);

		// Start buffer load
		} else if (val == 'B') {
			pagebuf_t size;
			size = recvchar() << 8;				// Load high byte of buffersize
			size |= recvchar();				// Load low byte of buffersize
			val = recvchar();				// Load memory type ('E' or 'F')
			recvBuffer(size);

			if (device == DEVTYPE) {
				if (val == 'F') {
					address = writeFlashPage(address, size);

				} else if (val == 'E') {
					address = writeEEpromPage(address, size);
				}
				sendchar('\r');

			} else {
				sendchar(0);
			}

		// Block read
		} else if (val == 'g') {
			pagebuf_t size;
			size = recvchar() << 8;				// Load high byte of buffersize
			size |= recvchar();				// Load low byte of buffersize
			val = recvchar();				// Get memtype

			if (val == 'F') {
				address = readFlashPage(address, size);

			} else if (val == 'E') {
				address = readEEpromPage(address, size);
			}

		// Chip erase
 		} else if (val == 'e') {
			if (device == DEVTYPE)
				eraseFlash();

			sendchar('\r');

		// Exit upgrade
		} else if (val == 'E') {
			wdt_enable(WDTO_15MS); // Enable Watchdog Timer to give reset
			sendchar('\r');

#ifdef WRITELOCKBITS
#warning "Extension 'WriteLockBits' enabled"
		// TODO: does not work reliably
		// write lockbits
		} else if (val == 'l') {
			if (device == DEVTYPE) {
				// write_lock_bits(recvchar());
				boot_lock_bits_set(recvchar());	// boot.h takes care of mask
				boot_spm_busy_wait();
			}
			sendchar('\r');
#endif
		// Enter programming mode
		} else if (val == 'P') {
			sendchar('\r');

		// Leave programming mode
		} else if (val == 'L') {
			sendchar('\r');

		// return programmer type
		} else if (val == 'p') {
			sendchar('S');		// always serial programmer

#ifdef ENABLEREADFUSELOCK
#warning "Extension 'ReadFuseLock' enabled"
		// read "low" fuse bits
		} else if (val == 'F') {
			sendchar(read_fuse_lock(0x0000, (1<<BLBSET) | (1<<SPMEN)));

		// read lock bits
		} else if (val == 'r') {
			sendchar(read_fuse_lock(0x0001, (1<<BLBSET) | (1<<SPMEN)));

		// read high fuse bits
		} else if (val == 'N') {
			sendchar(read_fuse_lock(0x0003, (1<<BLBSET) | (1<<SPMEN)));

		// read extended fuse bits
		} else if (val == 'Q') {
			sendchar(read_fuse_lock(0x0002, (1<<BLBSET) | (1<<SPMEN)));
#endif

		// Return device type
		} else if (val == 't') {
			sendchar(DEVTYPE);
			sendchar(0);

		// clear and set LED ignored
        	} else if ((val == 'x') || (val == 'y')) {
			recvchar();
			sendchar('\r');

		// set device
		} else if (val == 'T') {
			device = recvchar();
			sendchar('\r');

		// Return software identifier
		} else if (val == 'S') {
			send_boot();

		// Return Software Version
		} else if (val == 'V') {
			sendchar(VERSION_HIGH);
			sendchar(VERSION_LOW);

		// Return Signature Byte
		} else if (val == 's') {
			sendchar(SIG_BYTE1);
			sendchar(SIG_BYTE2);
			sendchar(SIG_BYTE3);

		/* ESC */
		} else if(val != 0x1b) {
			sendchar('?');
		}
	}
	return 0;
}