Diff: AVR910_Serial.h

Revision:

4:ceee1eb7062e

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/AVR910_Serial.h	Sat Jan 31 22:44:09 2015 +0000
@@ -0,0 +1,216 @@
+/**
+ * * @author Aaron Berk, Jeroen Voogd
+ *
+ * @section LICENSE
+ *
+ * Copyright (c) 2010 Aaron Berk
+ * Copyright (c) 2015 Jeroen Voogd
+ *
+ * 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. The version of Aaron Berk used a local file system, this version
+ * useses a python script to feed the data via a serial connection.
+ *
+ * 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
+ */
+
+//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 WRITE_HIGH_FLASH_BYTE 0x68
+#define WRITE_LOW_FLASH_BYTE  0x60
+
+#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 myData The char array with the bytes of the program to be flashed.
+     * @param dataSize The number of bytes to be flashed
+     * @param pageSize The size of one page on the device in words. If the
+     *                 device does not use paged memory, set this as the size
+     *                 of memory of the device in words.
+     * @param numPages The number of pages on the device. If the device does
+     *                 not use paged memory, set this to 1 (default).
+     *
+     * @return  0 => AVR microcontroller programmed successfully.
+     *         -1 => Problem during programming.
+     */
+    int programData(char* myData, int dataSize, int pageSize, int numPages = 1);
+
+    /**
+     * 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 a byte into the flash memory.
+     *
+     * @param highLow Indicate whether the byte being loaded is a high or low
+     *                byte.
+     * @param address The address to load the byte at.
+     * @param data The data byte to load.
+     */
+    void writeFlashMemoryByte(int highLow, int 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 myData The char array with the bytes of the program to be flashed.
+     * @param dataSize The number of bytes to be flashed
+     *
+     * @return  0 -> No inconsistencies between binary file and AVR flash memory.
+     *         -1 -> Binary file was not written correctly.
+     */
+    int checkMemoryData(int numPages, char* myData, int dataSize);
+
+    SPI        spi_;
+    DigitalOut nReset_;
+
+};
+
+#endif /* AVR910_H */