path: root/commandline/library/micronucleus_lib.c

/*
  Created: September 2012
  (c) 2012 by ihsan Kehribar <ihsan@kehribar.me>
  Changes for Micronucleus protocol version V2.x
  (c) 2014 T. Bo"scke

  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.
*/

/***************************************************************/
/* See the micronucleus_lib.h for the function descriptions/comments */
/***************************************************************/
#include "micronucleus_lib.h"
#include "littleWire_util.h"

micronucleus* micronucleus_connect(int fast_mode) {
  micronucleus *nucleus = NULL;
  libusb_device **devs, **dev;

  // intialise usb and find micronucleus device
  if (libusb_init(NULL) < 0 || libusb_get_device_list(NULL, &devs) < 0) return NULL;

  for (dev = devs; *dev; dev++) {
    struct libusb_device_descriptor desc;

    // skip device if we cannot get its descriptor
    if (libusb_get_device_descriptor(*dev, &desc) < 0) continue;

    if (desc.idVendor == MICRONUCLEUS_VENDOR_ID && desc.idProduct == MICRONUCLEUS_PRODUCT_ID) {
      nucleus = malloc(sizeof(micronucleus));
      nucleus->version.major = (desc.bcdDevice >> 8) & 0xFF;
      nucleus->version.minor = desc.bcdDevice & 0xFF;

      if (nucleus->version.major > MICRONUCLEUS_MAX_MAJOR_VERSION) {
        fprintf(stderr,
                "Warning: device with unknown new version of Micronucleus detected.\n"
                "This tool doesn't know how to upload to this new device. Updates may be available.\n"
                "Device reports version as: %d.%d\n",
                nucleus->version.major, nucleus->version.minor);
        return NULL;
      }

      if (libusb_open(*dev, &nucleus->device) < 0) return NULL;

      if (nucleus->version.major>=2) {  // Version 2.x
        // get nucleus info
        unsigned char buffer[6];
        int res = libusb_control_transfer(nucleus->device, LIBUSB_ENDPOINT_IN|LIBUSB_REQUEST_TYPE_VENDOR|LIBUSB_RECIPIENT_DEVICE, 0, 0, 0, buffer, 6, MICRONUCLEUS_USB_TIMEOUT);

        // Device descriptor was found, but talking to it was not succesful. This can happen when the device is being reset.
        if (res<0) return NULL;

        assert(res >= 6);

        nucleus->flash_size = (buffer[0]<<8) + buffer[1];
        nucleus->page_size = buffer[2];
        nucleus->pages = (nucleus->flash_size / nucleus->page_size);
        if (nucleus->pages * nucleus->page_size < nucleus->flash_size) nucleus->pages += 1;

        nucleus->bootloader_start = nucleus->pages*nucleus->page_size;

        if ((nucleus->version.major>=2)&&(!fast_mode)) {
          // firmware v2 reports more aggressive write times. Add 2ms if fast mode is not used.
          nucleus->write_sleep = (buffer[3] & 127) + 2;
        } else {
          nucleus->write_sleep = (buffer[3] & 127);
        }

        // if bit 7 of write sleep time is set, divide the erase time by four to
        // accomodate to the 4*page erase of the ATtiny841/441
        if (buffer[3]&128) {
             nucleus->erase_sleep = nucleus->write_sleep * nucleus->pages / 4;
        } else {
             nucleus->erase_sleep = nucleus->write_sleep * nucleus->pages;
        }

        nucleus->signature1 = buffer[4];
        nucleus->signature2 = buffer[5];

      } else {  // Version 1.x
        // get nucleus info
        unsigned char buffer[4];
        int res = libusb_control_transfer(nucleus->device, LIBUSB_ENDPOINT_IN|LIBUSB_REQUEST_TYPE_VENDOR |LIBUSB_RECIPIENT_DEVICE, 0, 0, 0, buffer, 4, MICRONUCLEUS_USB_TIMEOUT);

        // Device descriptor was found, but talking to it was not succesful. This can happen when the device is being reset.
        if (res<0) return NULL;

        assert(res >= 4);

        nucleus->flash_size = (buffer[0]<<8) + buffer[1];
        nucleus->page_size = buffer[2];
        nucleus->pages = (nucleus->flash_size / nucleus->page_size);
        if (nucleus->pages * nucleus->page_size < nucleus->flash_size) nucleus->pages += 1;

        nucleus->bootloader_start = nucleus->pages*nucleus->page_size;

        nucleus->write_sleep = (buffer[3] & 127);
        nucleus->erase_sleep = nucleus->write_sleep * nucleus->pages;

        nucleus->signature1 = 0;
        nucleus->signature2 = 0;
      }

      // we've found the device; there's no sense in checking everything else
      break;
    }
  }

  libusb_free_device_list(devs, 1);

  return nucleus;
}

int micronucleus_eraseFlash(micronucleus* deviceHandle, micronucleus_callback progress) {
  int res;
  res = libusb_control_transfer(deviceHandle->device, LIBUSB_ENDPOINT_OUT|LIBUSB_REQUEST_TYPE_VENDOR|LIBUSB_RECIPIENT_DEVICE, 2, 0, 0, NULL, 0, MICRONUCLEUS_USB_TIMEOUT);

  // give microcontroller enough time to erase all writable pages and come back online
  float i = 0;
  while (i < 1.0) {
    // update progress callback if one was supplied
    if (progress) progress(i);

    delay(((float) deviceHandle->erase_sleep) / 100.0f);
    i += 0.01;
  }

  /* Under Linux, the erase process is often aborted with errors such as:
   usbfs: USBDEVFS_CONTROL failed cmd micronucleus rqt 192 rq 2 len 0 ret -84
   This seems to be because the erase is taking long enough that the device
   is disconnecting and reconnecting.  Under Windows, micronucleus can see this
   and automatically reconnects prior to uploading the program.  To get the
   the same functionality, we must flag this state (the "-84" error result) by
   converting the return to 1 for the upper layer.

   On Mac OS a common error is -34 = epipe, but adding it to this list causes:
   Assertion failed: (res >= 4), function micronucleus_connect, file library/micronucleus_lib.c, line 63.
  */
  if (res == -5 || res == -34 || res == -84) {
    return 1; // recoverable errors
  } else {
    return res;
  }
}

int micronucleus_writeFlash(micronucleus* deviceHandle, unsigned int program_size, unsigned char* program, micronucleus_callback prog) {
  unsigned char page_length = deviceHandle->page_size;
  unsigned char page_buffer[page_length];
  unsigned int  address; // overall flash memory address
  unsigned int  page_address; // address within this page when copying buffer
  unsigned int  res;
  unsigned int  pagecontainsdata;
  unsigned int  userReset;

  for (address = 0; address < deviceHandle->flash_size; address += deviceHandle->page_size) {
    // work around a bug in older bootloader versions
    if (deviceHandle->version.major == 1 && deviceHandle->version.minor <= 2
        && address / deviceHandle->page_size == deviceHandle->pages - 1) {
      page_length = deviceHandle->flash_size % deviceHandle->page_size;
    }

    pagecontainsdata=0;

    // copy in bytes from user program
    for (page_address = 0; page_address < page_length; page_address += 1) {
      if (address + page_address > program_size) {
        page_buffer[page_address] = 0xFF; // pad out remainder with unprogrammed bytes
      } else {
        pagecontainsdata=1; // page contains data and needs to be written
        page_buffer[page_address] = program[address + page_address]; // load from user program
      }
    }

    // Reset vector patching is done in the host tool in micronucleus >=2
    if (deviceHandle->version.major >=2)
    {
      if ( address == 0 ) {
        // save user reset vector (bootloader will patch with its vector)
        unsigned int word0,word1;
        word0 = page_buffer [1] * 0x100 + page_buffer [0];
        word1 = page_buffer [3] * 0x100 + page_buffer [2];

        if (word0==0x940c) {  // long jump
          userReset = word1;
        } else if ((word0&0xf000)==0xc000) {  // rjmp
          userReset = (word0 & 0x0fff) - 0 + 1;
        } else {
          fprintf(stderr,
                  "The reset vector of the user program does not contain a branch instruction,\n"
                  "therefore the bootloader can not be inserted. Please rearrage your code.\n"
                  );
          return -1;
        }

        // Patch in jmp to bootloader.
        if (deviceHandle->bootloader_start > 0x2000) {
          //  jmp
          unsigned data = 0x940c;
          page_buffer [ 0 ] = data >> 0 & 0xff;
          page_buffer [ 1 ] = data >> 8 & 0xff;
          page_buffer [ 2 ] = deviceHandle->bootloader_start >> 0 & 0xff;
          page_buffer [ 3 ] = deviceHandle->bootloader_start >> 8 & 0xff;
        } else {
          // rjmp
          unsigned data =  0xc000 | ((deviceHandle->bootloader_start/2 - 1) & 0x0fff);
          page_buffer [ 0 ] = data >> 0 & 0xff;
          page_buffer [ 1 ] = data >> 8 & 0xff;
        }

      }

      if ( address >= deviceHandle->bootloader_start - deviceHandle->page_size ) {
        // move user reset vector to end of last page
        // The reset vector is always the last vector in the tinyvectortable
        unsigned int user_reset_addr = (deviceHandle->pages*deviceHandle->page_size) - 4;

        if (user_reset_addr > 0x2000) {
          //  jmp
          unsigned data = 0x940c;
          page_buffer [user_reset_addr - address + 0] = data >> 0 & 0xff;
          page_buffer [user_reset_addr - address + 1] = data >> 8 & 0xff;
          page_buffer [user_reset_addr - address + 2] = userReset >> 0 & 0xff;
          page_buffer [user_reset_addr - address + 3] = userReset >> 8 & 0xff;
        } else {
          // rjmp
          unsigned data =  0xc000 | ((userReset - user_reset_addr/2 - 1) & 0x0fff);
          page_buffer [user_reset_addr - address + 0] = data >> 0 & 0xff;
          page_buffer [user_reset_addr - address + 1] = data >> 8 & 0xff;
        }
      }
    }


    // always write last page so bootloader can insert the tiny vector table
    if ( address >= deviceHandle->bootloader_start - deviceHandle->page_size )
      pagecontainsdata = 1;

    // ask microcontroller to write this page's data
    if (pagecontainsdata) {

      if (deviceHandle->version.major == 1) {
        // Firmware rev.1 transfers a page as a single block
        // ask microcontroller to write this page's data
        res = libusb_control_transfer(deviceHandle->device,
               LIBUSB_ENDPOINT_OUT| LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
               1,
               page_length, address,
               page_buffer, page_length,
               MICRONUCLEUS_USB_TIMEOUT);
      } else if (deviceHandle->version.major >= 2) {
        // Firmware rev.2 uses individual set up packets to transfer data
        res = libusb_control_transfer(deviceHandle->device, LIBUSB_ENDPOINT_OUT|LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE, 1, page_length, address, NULL, 0, MICRONUCLEUS_USB_TIMEOUT);
        if (res) return -1;
        int i;

        for (i=0; i< page_length; i+=4)
        {
          int w1,w2;
          w1=(page_buffer[i+1]<<8)+(page_buffer[i+0]<<0);
          w2=(page_buffer[i+3]<<8)+(page_buffer[i+2]<<0);

          res = libusb_control_transfer(deviceHandle->device, LIBUSB_ENDPOINT_OUT|LIBUSB_REQUEST_TYPE_VENDOR|LIBUSB_RECIPIENT_DEVICE, 3, w1, w2, NULL, 0, MICRONUCLEUS_USB_TIMEOUT);
          if (res) return -1;
        }
      }
    /*
      res = usb_control_msg(deviceHandle->device,
             USB_ENDPOINT_OUT| USB_TYPE_VENDOR | USB_RECIP_DEVICE,
             1,
             page_length, address,
             (char*)page_buffer, page_length,
             MICRONUCLEUS_USB_TIMEOUT);

      if (res != page_length) return -1;
    */
      // give microcontroller enough time to write this page and come back online
      delay(deviceHandle->write_sleep);
    }

  // call progress update callback if that's a thing
  if (prog) prog(((float) address) / ((float) deviceHandle->flash_size));

  }

  // call progress update callback with completion status
  if (prog) prog(1.0);

  return 0;
}

int micronucleus_startApp(micronucleus* deviceHandle) {
  int res;
  res = libusb_control_transfer(deviceHandle->device, LIBUSB_ENDPOINT_OUT|LIBUSB_REQUEST_TYPE_VENDOR|LIBUSB_RECIPIENT_DEVICE, 4, 0, 0, NULL, 0, MICRONUCLEUS_USB_TIMEOUT);

  if(res!=0)
    return -1;
  else
    return 0;
}

void micronucleus_disconnect(micronucleus* deviceHandle) {
  libusb_close(deviceHandle->device);
  libusb_exit(NULL);
  free(deviceHandle);
}