JeeLabs Café

//>>> The latest version of this code can be found at https://github.com/jcw/ !!

// Upload a boot loader and the blink demo sketch to a second board

// jcw, 2010-05-29

// $Id$

// see http://news.jeelabs.org/2010/04/25/preparing-atmegas-with-isp/

//     http://jeelabs.org/2011/05/17/switching-to-optiboot/

//     http://jeelabs.org/2011/05/26/fixing-the-isp_repair-sketch/

//     http://jeelabs.org/2011/05/29/summary-of-isp-options/

// This code is adapted from isp_prepare. It omits the button and run LED,

// and starts right away. To use, open a serial console and wait until done.

//

// The 6 ISP pins of the target board need to be connected to the board running

// this sketch as follows (using Arduino pin naming):

//

//   ISP pin 1  <->  digital 4  (MISO)          ISP CONNECTOR

//   ISP pin 2  <->  VCC                          +---+---+

//   ISP pin 3  <->  analog 0   (SCK)             | 1 | 2 |

//   ISP pin 4  <->  analog 3   (MOSI)            | 3 | 4 |

//   ISP pin 5  <->  digital 7  (RESET)           | 5 | 6 |

//   ISP pin 6  <->  ground                       +---+---+

//

// The same hookup, using JeeNode port/pin names:

//

//   ISP pin 1  <->  DIO1

//   ISP pin 2  <->  +3V

//   ISP pin 3  <->  AIO1

//   ISP pin 4  <->  AIO4

//   ISP pin 5  <->  DIO4

//   ISP pin 6  <->  GND

//

// Boot Cloner

// adapted from http://www.arduino.cc/playground/BootCloner/BootCloner

// original copyright notice: 2007 by Amplificar <mailto:amplificar@gmail.com>

#include <avr/pgmspace.h>

#include <avr/sleep.h>

#define OPTIBOOT    1   // 1 = optiboot, 0 = original bootstrap code

// pin definitions

#define SCK         14  // PC0 - AIO1 - serial clock to target avr

#define MISO        4   // PD4 - DIO1 - input from target avr

#define MOSI        17  // PC3 - AIO4 - output to target avr

#define RESET       7   // PD7 - DIO4 - reset pin of the target avr

#define DONE_LED    9   // B1 - blue LED on JN USB, blinks on start and when ok

// MPU-specific values

#define PAGE_BYTES      128  // ATmega168 and ATmega328

#define LOCK_BITS       0xCF

#define FUSE_LOW        0xFF

#if OPTIBOOT

#define FUSE_HIGH       0xDE // 512b for optiboot

#else

#define FUSE_HIGH       0xDA // 2048b for 2009 boot

#endif

#define FUSE_EXTENDED   0x05

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

// Include data from a file generated in isp_prepare/ dir with this cmd:

//      ./hex2c.tcl Blink.cpp.hex optiboot_atmega328_1s.hex \

//                  ATmegaBOOT_168_atmega328.hex >../isp_repair/data.h

#include "data.h"

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

// ISP Command Words

#define CMD_Program_Enable      0xAC53

#define CMD_Erase_Flash         0xAC80

#define CMD_Poll                0xF000

#define CMD_Read_Flash_Low      0x2000

#define CMD_Read_Flash_High     0x2800

#define CMD_Load_Page_Low       0x4000

#define CMD_Load_Page_High      0x4800

#define CMD_Write_Page          0x4C00

#define CMD_Read_EEPROM         0xA000

#define CMD_Write_EEPROM        0xC000

#define CMD_Read_Lock           0x5800

#define CMD_Write_Lock          0xACE0

#define CMD_Read_Signature      0x3000

#define CMD_Write_Fuse_Low      0xACA0

#define CMD_Write_Fuse_High     0xACA8

#define CMD_Write_Fuse_Extended 0xACA4

#define CMD_Read_Fuse_Low       0x5000

#define CMD_Read_Fuse_High      0x5808

#define CMD_Read_Fuse_Extended  0x5008

#define CMD_Read_Fuse_High      0x5808

#define CMD_Read_Calibration    0x3800

static byte XferByte(byte v) {

    byte result = 0;

    for (byte i = 0; i < 8; ++i) {

        digitalWrite(MOSI, v & 0x80);

        digitalWrite(SCK, 0); // slow pulse, max 60KHz

        digitalWrite(SCK, 1);

        v <<= 1;

        result = (result << 1) | digitalRead(MISO);

    }

    return result;

}

// send 4 bytes to target microcontroller, returns the fourth MISO byte

static byte Send_ISP (word v01, byte v2 =0, byte v3 =0) {

    XferByte(v01 >> 8);

    XferByte(v01);

    XferByte(v2);

    return XferByte(v3);

}

static void Send_ISP_wait (word v01, byte v2 =0, byte v3 =0) {

    Send_ISP(v01, v2, v3);

    while (Send_ISP(CMD_Poll) & 1)

        ;

}

static void Reset_Target() {

    digitalWrite(RESET, 1);

    digitalWrite(SCK, 0); // has to be set LOW at startup, or PE fails

    delay(30);

    digitalWrite(RESET, 0);

    delay(30); // minimum delay here is 20ms for the ATmega8

}

// prints the 16 signature bytes (device codes)

static void Read_Signature() {

    Serial.print("Signatures:");

    for (byte x = 0 ; x < 8 ; ++x) {

        Serial.print(" ");

        Serial.print(Send_ISP(CMD_Read_Signature, x), HEX);

    }

    Serial.println("");

}

// prints the lock and fuse bits (no leading zeros)

static void Read_Fuse() {

    Serial.print("Lock Bits: ");

    Serial.println(Send_ISP(CMD_Read_Lock), HEX);

    Serial.print("Fuses: low ");

    Serial.print(Send_ISP(CMD_Read_Fuse_Low), HEX);

    Serial.print(", high ");

    Serial.print(Send_ISP(CMD_Read_Fuse_High), HEX);

    Serial.print(", extended ");

    Serial.println(Send_ISP(CMD_Read_Fuse_Extended), HEX);

    if (Send_ISP(CMD_Read_Lock) == LOCK_BITS &&

            Send_ISP(CMD_Read_Fuse_Low) == FUSE_LOW &&

                Send_ISP(CMD_Read_Fuse_High) == FUSE_HIGH &&

                    Send_ISP(CMD_Read_Fuse_Extended) == FUSE_EXTENDED)

        Serial.println("Fuse bits OK.");

}

static word addr2page (word addr) {

    return (word)(addr & ~ (PAGE_BYTES-1)) >> 1;

}

static void LoadPage(word addr, const byte* ptr) {

    word cmd = addr & 1 ? CMD_Load_Page_High : CMD_Load_Page_Low;

    Send_ISP(cmd | (addr >> 9), addr >> 1, pgm_read_byte(ptr));

}

static void WritePage (word page) {

    Send_ISP_wait(CMD_Write_Page | (page >> 8), page);

}

static void WriteData (word start, const byte* data, word count) {

    word page = addr2page(start);

    for (word i = 0; i < count; i += 2) {

        if (page != addr2page(start)) {

            WritePage(page);

            Serial.print('.');

            page = addr2page(start);

        }

        LoadPage(start++, data + i);

        LoadPage(start++, data + i + 1);

    }

    WritePage(page);

    Serial.println();

}

static byte EnableProgramming () {

    Reset_Target();

    if (Send_ISP(CMD_Program_Enable, 0x22, 0x22) != 0x22) {

        Serial.println("Program Enable FAILED");

        return 0;

    }

    return 1;

}

static void blink () {

  pinMode(DONE_LED, OUTPUT);

  digitalWrite(DONE_LED, 0); // inverted logic

  delay(100); // blink briefly

  pinMode(DONE_LED, INPUT);

}

static byte programSection (byte index) {

    Serial.println(sections[index].title);

    byte f = EnableProgramming();

    if (f)

        WriteData(sections[index].start, progdata + sections[index].off,

                      sections[index].count);

    return f;

}

void setup () {

    Serial.begin(57600);

    Serial.println("\n[isp_repair]");

    blink();

    digitalWrite(SCK, 1);

    digitalWrite(MOSI, 1);

    digitalWrite(RESET, 1);

    pinMode(SCK, OUTPUT);

    pinMode(MOSI, OUTPUT);

    pinMode(RESET, OUTPUT);

    Serial.println("\nStarting...");

    if (EnableProgramming()) {

        Serial.println("Erasing Flash");

        Send_ISP_wait(CMD_Erase_Flash, 0x22, 0x22);

        if (EnableProgramming()) {

            Serial.println("Setting Fuses");

            Send_ISP_wait(CMD_Write_Fuse_Low, 0, FUSE_LOW);

            Send_ISP_wait(CMD_Write_Fuse_High, 0, FUSE_HIGH);

            Send_ISP_wait(CMD_Write_Fuse_Extended, 0, FUSE_EXTENDED);

            Send_ISP_wait(CMD_Write_Lock, 0, LOCK_BITS);

            byte ok = programSection(0);

            if (ok)

                ok = programSection(OPTIBOOT ? 1 : 2);

            if (ok) {

                Read_Fuse();

                Read_Signature();

                Serial.println("Done.");

                blink();

            }

        }

    }

    pinMode(SCK, INPUT);

    pinMode(MOSI, INPUT);

    pinMode(RESET, INPUT);

    digitalWrite(SCK, 0);

    digitalWrite(MOSI, 0);

    digitalWrite(RESET, 0);

    delay(10); // let the serial port finish

    cli(); // stop responding to interrupts

    ADCSRA &= ~ bit(ADEN); // disable the ADC

    PRR = 0xFF; // disable all subsystems

    set_sleep_mode(SLEEP_MODE_PWR_DOWN);

    sleep_mode();

    // total power down, can only wake up with a hardware reset

}

void loop () {}