Revision 0:3066745764a5, committed 2010-08-31

Comitter:

aberk

Date:

Tue Aug 31 14:09:53 2010 +0000

Child:

1:276f6df4be7a

Commit message:

Version 1.0

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/AVR910.cpp	Tue Aug 31 14:09:53 2010 +0000
@@ -0,0 +1,311 @@
+/**
+ * @author Aaron Berk
+ *
+ * @section LICENSE
+ *
+ * Copyright (c) 2010 Aaron Berk
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * Program AVR chips with the AVR910 ISP (in-system programming) protocol,
+ * using an mbed.
+ *
+ * AVR910 Application Note:
+ *
+ * http://www.atmel.com/dyn/resources/prod_documents/doc0943.pdf
+ */
+
+/**
+ * Includes
+ */
+#include "AVR910.h"
+
+Serial debug(USBTX, USBRX);
+
+AVR910::AVR910(PinName mosi,
+               PinName miso,
+               PinName sclk,
+               PinName nReset) : spi_(mosi, miso, sclk), nReset_(nReset) {
+
+    //Slow frequency as default to ensure no errors from
+    //trying to run it too fast. Increase as appropriate.
+    spi_.frequency(32000);
+    spi_.format(8, 0);
+
+    int response = 0;
+
+    //Enter serial programming mode by pulling reset line low.
+    nReset_ = 0;
+
+    //Wait 20ms before issuing first command.
+    wait_ms(20);
+
+    //Issue a programming enable command.
+    response = enableProgramming();
+    
+    //Simple debugging to see if we get trapped
+    //in an infinite loop.
+    DigitalOut working(LED1);
+    working = 1;
+
+    //TODO: introduce a timeout.
+    while (response < 0) {
+
+        //Give nReset a positive pulse.
+        nReset_ = 1;
+        wait_ms(20);
+        nReset_ = 0;
+        wait_ms(20);
+
+        //Issue another programming enable.
+        response = enableProgramming();
+
+    }
+    
+    working = 0;
+
+}
+
+int AVR910::program(FILE* binary) {
+
+    //Clear memory contents.
+    chipErase();
+
+    char pageOffset = 0;
+    int  pageNumber = 0;
+    int  c          = 0;
+    int  highLow    = 0;
+    
+    while ((c = getc(binary)) != EOF) {
+
+        //Page is fully loaded, time to write it to flash.
+        if (pageOffset == (PAGE_SIZE)) {
+            writeFlashMemoryPage(pageNumber);
+
+            pageNumber++;
+            pageOffset = 0;
+        }
+
+        //Write low byte.
+        if (highLow == 0) {
+            loadMemoryPage(WRITE_LOW_BYTE, pageOffset, c);
+            highLow = 1;
+        }
+        //Write high byte.
+        else {
+            loadMemoryPage(WRITE_HIGH_BYTE, pageOffset, c);
+            highLow = 0;
+            pageOffset++;
+        }
+
+    }
+
+    //We might have partially filled up a page.
+    writeFlashMemoryPage(pageNumber);
+
+    int success = -1;
+    success = checkMemory(pageNumber, binary);
+
+    //Leave serial programming mode by pulling reset line high.
+    nReset_ = 1;
+
+    return success;
+
+}
+
+void AVR910::setFrequency(int frequency) {
+
+    spi_.frequency(frequency);
+
+}
+
+int AVR910::enableProgramming(void) {
+
+    int response = 0;
+    int error    = 0;
+
+    //Programming Enable Command: 0xAC, 0x53, 0x00, 0x00
+    //Byte two echo'd back in byte three.
+    spi_.write(0xAC);
+
+    spi_.write(0x53);
+
+    response = spi_.write(0x00);
+
+    if (response == 0x53) {
+        error =  0;
+    } else {
+        error = -1;
+    }
+
+    spi_.write(0x00);
+
+    return error;
+
+}
+
+void AVR910::poll(void) {
+
+    int response = 0;
+
+    do {
+        spi_.write(0xF0);
+        spi_.write(0x00);
+        spi_.write(0x00);
+        response = spi_.write(0x00);
+    } while ((response & 0x01) != 0);
+
+}
+
+int AVR910::readVendorCode(void) {
+
+    int response = 0;
+
+    //Issue read signature byte command.
+    //Address 0x00 is vendor code.
+    spi_.write(0x30);
+    spi_.write(0x00);
+    spi_.write(0x00);
+    response = spi_.write(0x00);
+
+    return response;
+
+}
+
+int AVR910::readPartFamilyAndFlashSize(void) {
+
+    int response = 0;
+
+    //Issue read signature byte command.
+    //Address 0x01 is part family and flash size code.
+    spi_.write(0x30);
+    spi_.write(0x00);
+    spi_.write(0x01);
+    response = spi_.write(0x00);
+
+    return response;
+
+}
+
+int AVR910::readPartNumber(void) {
+
+    int response = 0;
+
+    //Issue read signature byte command.
+    //Address 0x02 is part number code.
+    spi_.write(0x30);
+    spi_.write(0x00);
+    spi_.write(0x02);
+    response = spi_.write(0x00);
+
+    return response;
+
+}
+
+void AVR910::chipErase(void) {
+
+    //Issue chip erase command.
+    spi_.write(0xAC);
+    spi_.write(0x80);
+    spi_.write(0x00);
+    spi_.write(0x00);
+
+    poll();
+
+    //Temporarily release reset line.
+    nReset_ = 1;
+    nReset_ = 0;
+
+}
+
+void AVR910::loadMemoryPage(int highLow, char address, char data) {
+
+    spi_.write(highLow);
+    spi_.write(0x00);
+    spi_.write(address & 0x3F);
+    spi_.write(data);
+
+    poll();
+
+}
+
+void AVR910::writeFlashMemoryPage(char pageNumber) {
+
+    spi_.write(0x4C);
+    spi_.write((pageNumber >> 2) & 0x3F);
+    spi_.write((pageNumber & 0x03) << 6);
+    spi_.write(0x00);
+
+    poll();
+
+}
+
+char AVR910::readProgramMemory(int highLow, char pageNumber, char pageOffset) {
+
+    int response = 0;
+
+    spi_.write(highLow);
+    spi_.write((pageNumber >> 2) & 0x3F);
+    spi_.write(((pageNumber & 0x03) << 6) | (pageOffset & 0x3F));
+    response = spi_.write(0x00);
+
+    poll();
+
+    return response;
+
+}
+
+int AVR910::checkMemory(int numPages, FILE* binary) {
+
+    int success  = 0;
+    int response = 0;
+    char c       = 0;
+
+    //Go back to the beginning of the binary file.
+    fseek(binary, 0, SEEK_SET);
+
+    for (int i = 0; i < numPages; i++) {
+        for (int j = 0; j < PAGE_SIZE; j++) {
+            c = getc(binary);
+            //Read program memory low byte.
+            response = readProgramMemory(READ_LOW_BYTE, i, j);
+            //debug.printf("Low byte: 0x%02x\n", response);
+            if ( c != response ) {
+                debug.printf("Page %i low byte %i: 0x%02x\n", i, j, response);
+                debug.printf("Correct byte is 0x%02x\n", c);
+                success = -1;
+            }
+
+            c = getc(binary);
+            //Read program memory high byte.
+            response = readProgramMemory(READ_HIGH_BYTE, i, j);
+            //debug.printf("High byte: 0x%02x\n", response);
+            if ( c != response ) {
+                debug.printf("Page %i high byte %i: 0x%02x\n", i, j, response);
+                debug.printf("Correct byte is 0x%02x\n", c);
+                success = -1;
+            }
+        }
+    }
+
+    return success;
+
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/AVR910.h	Tue Aug 31 14:09:53 2010 +0000
@@ -0,0 +1,199 @@
+/**
+ * @author Aaron Berk
+ *
+ * @section LICENSE
+ *
+ * Copyright (c) 2010 Aaron Berk
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * Program AVR chips with the AVR910 ISP (in-system programming) protocol,
+ * using an mbed.
+ *
+ * AVR910 Application Note:
+ *
+ * http://www.atmel.com/dyn/resources/prod_documents/doc0943.pdf
+ */
+
+#ifndef MBED_AVR910_H
+#define MBED_AVR910_H
+
+/**
+ * Includes
+ */
+#include "mbed.h"
+
+/**
+ * Defines
+ */
+
+#define PATH_TO_BINARY "/local/AVRCODE.bin"
+
+//Commands
+#define ATMEL_VENDOR_CODE 0x1E
+#define DEVICE_LOCKED     0x00
+#define WRITE_HIGH_BYTE   0x48
+#define WRITE_LOW_BYTE    0x40
+#define READ_HIGH_BYTE    0x28
+#define READ_LOW_BYTE     0x20
+
+#define PAGE_SIZE         ATMEGA328P_PAGESIZE
+#define NUM_PAGES         ATMEGA328P_NUM_PAGES
+
+//ATMega328P
+#define ATMEGA328P_PAGESIZE  64 //Size in words.
+#define ATMEGA328P_NUM_PAGES 256
+
+/**
+ * AVR910 ISP
+ */
+class AVR910 {
+
+public:
+
+    /**
+     * Constructor.
+     *
+     * @param mosi mbed pin for MOSI SPI line.
+     * @param miso mbed pin for MISO SPI line.
+     * @param sclk mbed pin for SCLK SPI line.
+     * @param nReset mbed pin for not reset line on the ISP interface.
+     *
+     * Sends an enable programming command, allowing device registers to be
+     * read and commands sent.
+     */
+    AVR910(PinName mosi, PinName miso, PinName sclk, PinName nReset);
+
+    /**
+     * Program the AVR microcontroller connected to the mbed.
+     *
+     * Sends a chip erase command followed by writing the binary to the AVR
+     * page buffer and writing the page buffer to flash memory whenever it is
+     * full.
+     *
+     * @param binary File pointer to the binary file to be loaded onto the
+     *               AVR microcontroller.
+     *
+     * @return  0 => AVR microcontroller programmed successfully.
+     *         -1 => Problem during programming.
+     */
+    int program(FILE* binary);
+
+    /**
+     * Set the frequency of the SPI communication.
+     *
+     * (Wrapper for SPI::frequency)
+     *
+     * @param frequency Frequency of the SPI communication in hertz.
+     */
+    void setFrequency(int frequency);
+    
+    /**
+     * Read the vendor code of the device.
+     *
+     * @return The vendor code - should be 0x1E for Atmel.
+     *         0x00 -> Device is locked.
+     */
+    int readVendorCode(void);
+
+    /**
+     * Read the part family and flash size of the device.
+     *
+     * @return Code indicating the family of AVR microcontrollers the device comes
+     *         from and how much flash memory it contains.
+     *         0xFF -> Device code erased or target missing.
+     *         0x01 -> Device is locked.
+     */
+    int readPartFamilyAndFlashSize(void);
+
+    /**
+     * Read the part number.
+     *
+     * @return Code identifying the part number.
+     *         0xFF -> Device code erased or target missing.
+     *         0x02 -> Device is locked.
+     */
+    int readPartNumber(void);
+
+private:
+
+    /**
+     * Issue an enable programming command to the AVR microcontroller.
+     *
+     * @param  0 to indicate programming was enabled successfully.
+     *        -1 to indicate programming was not enabled.
+     */
+    int enableProgramming(void);
+
+    /**
+     * Poll the device until it has finished its current operation.
+     */
+    void poll(void);
+
+    /**
+     * Issue a chip erase command to the AVR microcontroller.
+     */
+    void chipErase(void);
+
+    /**
+     * Load a byte into the memory page buffer.
+     *
+     * @param highLow Indicate whether the byte being loaded is a high or low 
+     *                byte.
+     * @param data The data byte to load.
+     */
+    void loadMemoryPage(int highLow, char address, char data);
+
+    /**
+     * Write the memory page buffer to flash memory.
+     *
+     * @param pageNumber The page number to write to in flash memory.
+     */
+    void writeFlashMemoryPage(char pageNumber);
+
+    /**
+     * Read a byte from program memory.
+     *
+     * @param highLow Indicate whether the byte being read is a low or high byte.
+     * @param pageNumber The page number to read from.
+     * @param pageOffset Address of byte in the page.
+     *
+     * @return The byte at the specified memory location.
+     */
+    char readProgramMemory(int highLow, char pageNumber, char pageOffset);
+
+    /**
+     * Check the binary has been written correctly.
+     *
+     * @param numPages The number of pages written to the AVR microcontroller.
+     * @param binary File pointer to the binary used.
+     * 
+     * @return  0 -> No inconsistencies between binary file and AVR flash memory.
+     *         -1 -> Binary file was not written correctly.
+     */
+    int checkMemory(int numPages, FILE* binary);
+    
+    SPI        spi_;
+    DigitalOut nReset_;
+    
+};
+
+#endif /* AVR910_H */

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Tue Aug 31 14:09:53 2010 +0000
@@ -0,0 +1,75 @@
+/**
+ * Program an AVR with an mbed.
+ */
+
+#include "AVR910.h"
+
+LocalFileSystem local("local");
+Serial pc(USBTX, USBRX);
+AVR910 mAVRISP(p5, p6, p7, p8); //mosi, miso, sclk, nreset.
+
+int main() {
+
+    int success  = -1;
+    int response =  0;
+    
+    //Read the vendor code [0x1E == Atmel].
+    response = mAVRISP.readVendorCode();
+
+    if (response == ATMEL_VENDOR_CODE) {
+        pc.printf("Microcontroller is an Atmel [0x%02x]\n", response);
+    } else if (response == DEVICE_LOCKED) {
+        pc.printf("Device is locked\n");
+        return -1;
+    } else {
+        pc.printf("Microcontroller is not an Atmel\n");
+        return -1;
+    }
+    
+    //Read part family and flash size - see datasheet for code meaning.
+    response = mAVRISP.readPartFamilyAndFlashSize();
+
+    if (response == 0xFF) {
+        pc.printf("Device code erased or target missing\n");
+    } else if (response == 0x01) {
+        pc.printf("Device locked\n");
+        return -1;
+    } else {
+        pc.printf("Part family and flash size code is: 0x%02x\n", response);
+    }
+
+    //Read part number.
+    response = mAVRISP.readPartNumber();
+
+    if (response == 0xFF) {
+        pc.printf("Device code erased or target missing\n");
+        return -1;
+    } else if (response == 0x02) {
+        pc.printf("Device locked\n");
+        return -1;
+    } else {
+        pc.printf("Part number code is: 0x%02x\n", response);
+    }
+    
+    //Open binary file to write to AVR.
+    FILE *fp = fopen(PATH_TO_BINARY, "rb");
+    
+    if(fp == NULL){
+        pc.printf("Failed to open binary. Please check the file path\n");
+        return -1;
+    }
+    else{
+        //Program it!
+        pc.printf("Binary file opened successfully\n");
+        success = mAVRISP.program(fp);
+        fclose(fp);
+    }
+    
+    if(success < 0){
+        printf("Programming failed.\n");
+    }
+    else{
+        printf("Programming was successful!\n");
+    }
+    
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed.bld	Tue Aug 31 14:09:53 2010 +0000
@@ -0,0 +1,1 @@
+http://mbed.org/users/mbed_official/code/mbed/builds/74b8d43b5817