]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - tos/lib/TOSBoot/TOSBootM.nc
Changes so this checkout exactly matches CVS at -r release_tinyos_2_0_2_2.
[tinyos-2.x.git] / tos / lib / TOSBoot / TOSBootM.nc
diff --git a/tos/lib/TOSBoot/TOSBootM.nc b/tos/lib/TOSBoot/TOSBootM.nc
new file mode 100644 (file)
index 0000000..b5098a1
--- /dev/null
@@ -0,0 +1,259 @@
+/*
+ * "Copyright (c) 2000-2005 The Regents of the University  of California.  
+ * All rights reserved.
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation for any purpose, without fee, and without written agreement is
+ * hereby granted, provided that the above copyright notice, the following
+ * two paragraphs and the author appear in all copies of this software.
+ * 
+ * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
+ * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
+ * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
+ * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
+ * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
+ *
+ * Copyright (c) 2007 Johns Hopkins University.
+ * All rights reserved.
+ *
+ */
+
+/**
+ * @author Jonathan Hui <jwhui@cs.berkeley.edu>
+ * @author Chieh-Jan Mike Liang <cliang4@cs.jhu.edu>
+ * @author Razvan Musaloiu-E. <razvanm@cs.jhu.edu>
+ */
+
+includes crc;
+includes hardware;
+
+module TOSBootM {
+  uses {
+    interface Exec;
+    interface ExtFlash;
+    interface Hardware;
+    interface InternalFlash as IntFlash;
+    interface Leds;
+    interface ProgFlash;
+    interface StdControl as SubControl;
+    interface Init as SubInit;
+    interface Voltage;
+  }
+}
+implementation {
+
+  enum {
+    LEDS_LOWBATT = 1,
+    LEDS_GESTURE = 7,
+  };
+
+  enum {
+    R_SUCCESS,
+    R_INVALID_IMAGE_ERROR,
+    R_PROGRAMMING_ERROR,
+  };
+
+  void startupLeds() {
+
+    uint8_t  output = 0x7;
+    uint8_t  i;
+
+    for (i = 3; i; i--, output >>= 1 )
+      call Leds.glow(output, output >> 1);
+
+  }
+
+  in_flash_addr_t extFlashReadAddr() {
+    in_flash_addr_t result = 0;
+    uint8_t  i;
+    for ( i = 0; i < 4; i++ )
+      result |= ((in_flash_addr_t)call ExtFlash.readByte() & 0xff) << (i*8);    
+    return result;
+  }
+
+  bool verifyImage(ex_flash_addr_t startAddr) {
+
+    uint16_t crcTarget = 0, crcTmp = 0;
+    uint16_t addr, len;
+    pgnum_t  numPgs;
+    uint8_t  i;
+
+    // read size of image
+    call ExtFlash.startRead(startAddr + offsetof(DelugeImgDesc,numPgs));
+    numPgs = call ExtFlash.readByte();
+    call ExtFlash.stopRead();
+
+    if (numPgs == 0 || numPgs == 0xff)
+      return FALSE;
+
+    startAddr += DELUGE_METADATA_SIZE;
+
+    addr = DELUGE_CRC_BLOCK_SIZE;
+    len = DELUGE_BYTES_PER_PAGE-DELUGE_CRC_BLOCK_SIZE;
+
+    for ( i = 0; i < numPgs && crcTarget == crcTmp; i++ ) {
+
+      // read crc
+      call ExtFlash.startRead(startAddr + i*sizeof(uint16_t));
+      crcTarget = (uint16_t)(call ExtFlash.readByte() & 0xff);
+      crcTarget |= (uint16_t)(call ExtFlash.readByte() & 0xff) << 8;
+      call ExtFlash.stopRead();
+
+      // compute crc
+      call ExtFlash.startRead(startAddr + addr);
+      for ( crcTmp = 0; len; len-- )
+       crcTmp = crcByte(crcTmp, call ExtFlash.readByte());
+      call ExtFlash.stopRead();
+
+      addr = (uint16_t)(i+1)*DELUGE_BYTES_PER_PAGE;
+      len = DELUGE_BYTES_PER_PAGE;
+    }
+
+    return (i == numPgs) && (crcTarget == crcTmp);
+  }
+
+  error_t programImage(ex_flash_addr_t startAddr) {
+
+    uint8_t  buf[TOSBOOT_INT_PAGE_SIZE];
+    uint16_t pageAddr, newPageAddr;
+    in_flash_addr_t intAddr;
+    in_flash_addr_t secLength;
+    ex_flash_addr_t curAddr;
+
+    if (!verifyImage(startAddr))
+      return R_INVALID_IMAGE_ERROR;
+
+    curAddr = startAddr + DELUGE_METADATA_SIZE + DELUGE_CRC_BLOCK_SIZE + DELUGE_IDENT_SIZE;
+
+    call ExtFlash.startRead(curAddr);
+
+    intAddr = extFlashReadAddr();
+    secLength = extFlashReadAddr();
+    curAddr = curAddr + 8;
+
+    // check that the image starts on the correct boundary
+    if (intAddr != TOSBOOT_END) {
+      call ExtFlash.stopRead();
+      return R_INVALID_IMAGE_ERROR;
+    }
+
+    while ( secLength ) {
+      
+      pageAddr = newPageAddr = intAddr / TOSBOOT_INT_PAGE_SIZE;
+
+      call ExtFlash.startRead(curAddr);
+      // fill in ram buffer for internal program flash sector
+      do {
+
+       // check if secLength is all ones
+       if ( secLength == 0xffffffff )
+         return FAIL;
+
+       buf[(uint16_t)intAddr % TOSBOOT_INT_PAGE_SIZE] = call ExtFlash.readByte();
+       intAddr++; curAddr++;
+       
+       if ( --secLength == 0 ) {
+         intAddr = extFlashReadAddr();
+         secLength = extFlashReadAddr();
+         curAddr = curAddr + 8;
+       }
+
+       newPageAddr = intAddr / TOSBOOT_INT_PAGE_SIZE;
+
+      } while ( pageAddr == newPageAddr && secLength );
+      call ExtFlash.stopRead();
+
+      call Leds.set(pageAddr);
+
+
+      // write out page
+      if (call ProgFlash.write(pageAddr*TOSBOOT_INT_PAGE_SIZE, buf,
+                              TOSBOOT_INT_PAGE_SIZE) == FAIL)
+       return R_PROGRAMMING_ERROR;
+
+    }
+
+    return R_SUCCESS;
+
+  }
+
+  void runApp() {
+    call SubControl.stop();
+    call Exec.exec();
+  }
+
+  void startupSequence() {
+
+    tosboot_args_t args;
+
+    // check voltage and make sure flash can be programmed
+    //   if not, just run the app, can't check for gestures
+    //   if we can't write to the internal flash anyway
+    if ( !call Voltage.okToProgram() ) {
+      // give user some time and count down LEDs
+      call Leds.flash(LEDS_LOWBATT);
+      startupLeds();
+      runApp();
+    }
+
+    // get current value of counter
+    call IntFlash.read((uint8_t*)TOSBOOT_ARGS_ADDR, &args, sizeof(args));
+
+    // increment gesture counter, see if it exceeds threshold
+    if ( ++args.gestureCount >= TOSBOOT_GESTURE_MAX_COUNT - 1 ) {
+      // gesture has been detected, display receipt of gesture on LEDs
+      call Leds.flash(LEDS_GESTURE);
+
+      // load golden image from flash
+      // if the golden image is invalid, forget about reprogramming
+      // if an error happened during reprogramming, reboot and try again
+      //   not much else we can do :-/
+      if (programImage(TOSBOOT_GOLDEN_IMG_ADDR) == R_PROGRAMMING_ERROR)
+       call Hardware.reboot();
+    }
+    else {
+      // update gesture counter
+      call IntFlash.write((uint8_t*)TOSBOOT_ARGS_ADDR, &args, sizeof(args));
+      if ( !args.noReprogram ) {
+       // if an error happened during reprogramming, reboot and try again
+       //   after two tries, try programming the golden image
+       if (programImage(args.imageAddr) == R_PROGRAMMING_ERROR) {
+         call Hardware.reboot();
+       }
+      }
+    }
+
+    // give user some time and count down LEDs
+    startupLeds();
+
+    // reset counter and reprogramming flag
+    args.gestureCount = 0xff;
+    args.noReprogram = TRUE;
+    call IntFlash.write((uint8_t*)TOSBOOT_ARGS_ADDR, &args, sizeof(args));
+    
+    runApp();
+
+  }
+
+  int main() __attribute__ ((C, spontaneous)) {
+
+    __nesc_disable_interrupt();
+
+    TOSH_SET_PIN_DIRECTIONS();
+    call Hardware.init();
+
+    call SubInit.init();
+    call SubControl.start();
+
+    startupSequence();
+
+    return 0;
+
+  }
+
+}