avrdude/src/flip2.c

/*
 * avrdude - A Downloader/Uploader for AVR device programmers
 * Copyright (C) 2012 Kirill Levchenko
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#include <ac_cfg.h>

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <limits.h>
#include <unistd.h>

#include "avrdude.h"
#include "libavrdude.h"

#include "flip2.h"
#include "dfu.h"
#include "usbdevs.h"            // For USB_VENDOR_ATMEL

/*
 * There are three versions of the FLIP protocol:
 *
 * Version 0: C51 parts
 * Version 1: megaAVR parts ("USB DFU Bootloader Datasheet" [doc7618])
 * Version 2: XMEGA parts (AVR4023 [doc8457])
 *
 * We currently only support Version 2, as documented in AVR4023.
 *
 * Additional references:
 *   flip_protocol.h from the Atmel Software Framework.
 *   udi_dfu_atmel.c from XMEGA bootloaders archive.
 */

const char flip2_desc[] = "FLIP USB DFU protocol version 2 (AVR4023)";

struct flip2 {
  struct dfu_dev *dfu;
  unsigned char part_sig[3];
  unsigned char part_rev;
  unsigned char boot_ver;
};

#define FLIP2(pgm) ((struct flip2 *)(pgm->cookie))

/* The FLIP2 protocol assigns specific meaning to certain combinations of
 * status and state bytes in the DFU_GETSTATUS response. These constants en-
 * code these combinations as a 16-bit value: the high order byte is the
 * status and the low order byte is the state of the status-state pairing.
 */

#define FLIP2_STATUS_OK 0x0000
#define FLIP2_STATUS_STALL 0x0F0A
#define FLIP2_STATUS_MEM_UKNOWN 0x030A
#define FLIP2_STATUS_MEM_PROTECTED 0x0300
#define FLIP2_STATUS_OUTOFRANGE 0x080A
#define FLIP2_STATUS_BLANK_FAIL 0x0500
#define FLIP2_STATUS_ERASE_ONGOING 0x0904

// FLIP2 data structures and constants

struct flip2_cmd {
  unsigned char group_id;
  unsigned char cmd_id;
  unsigned char args[4];
};

#define FLIP2_CMD_GROUP_DOWNLOAD 0x01
#define FLIP2_CMD_GROUP_UPLOAD 0x03
#define FLIP2_CMD_GROUP_EXEC 0x04
#define FLIP2_CMD_GROUP_SELECT 0x06

#define FLIP2_CMD_PROG_START 0x00
#define FLIP2_CMD_READ_MEMORY 0x00
#define FLIP2_CMD_SELECT_MEMORY 0x03
#define FLIP2_CMD_CHIP_ERASE 0x00
#define FLIP2_CMD_START_APP 0x03

#define FLIP2_SELECT_MEMORY_UNIT 0x00
#define FLIP2_SELECT_MEMORY_PAGE 0x01

enum flip2_mem_unit {
  FLIP2_MEM_UNIT_UNKNOWN = -1,
  FLIP2_MEM_UNIT_FLASH = 0x00,
  FLIP2_MEM_UNIT_EEPROM = 0x01,
  FLIP2_MEM_UNIT_SECURITY = 0x02,
  FLIP2_MEM_UNIT_CONFIGURATION = 0x03,
  FLIP2_MEM_UNIT_BOOTLOADER = 0x04,
  FLIP2_MEM_UNIT_SIGNATURE = 0x05,
  FLIP2_MEM_UNIT_USER = 0x06,
  FLIP2_MEM_UNIT_INT_RAM = 0x07,
  FLIP2_MEM_UNIT_EXT_MEM_CS0 = 0x08,
  FLIP2_MEM_UNIT_EXT_MEM_CS1 = 0x09,
  FLIP2_MEM_UNIT_EXT_MEM_CS2 = 0x0A,
  FLIP2_MEM_UNIT_EXT_MEM_CS3 = 0x0B,
  FLIP2_MEM_UNIT_EXT_MEM_CS4 = 0x0C,
  FLIP2_MEM_UNIT_EXT_MEM_CS5 = 0x0D,
  FLIP2_MEM_UNIT_EXT_MEM_CS6 = 0x0E,
  FLIP2_MEM_UNIT_EXT_MEM_CS7 = 0x0F,
  FLIP2_MEM_UNIT_EXT_MEM_DF = 0x10
};

#ifdef HAVE_LIBUSB

static int flip2_open(PROGRAMMER *pgm, const char *port_spec);
static int flip2_initialize(const PROGRAMMER *pgm, const AVRPART *part);
static void flip2_close(PROGRAMMER *pgm);
static void flip2_enable(PROGRAMMER *pgm, const AVRPART *p);
static void flip2_disable(const PROGRAMMER *pgm);
static void flip2_display(const PROGRAMMER *pgm, const char *prefix);
static int flip2_program_enable(const PROGRAMMER *pgm, const AVRPART *part);
static int flip2_chip_erase(const PROGRAMMER *pgm, const AVRPART *part);
static int flip2_start_app(const PROGRAMMER *pgm);
static int flip2_read_byte(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned long addr, unsigned char *value);
static int flip2_write_byte(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned long addr, unsigned char value);
static int flip2_paged_load(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned int page_size, unsigned int addr, unsigned int n_bytes);
static int flip2_paged_write(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned int page_size, unsigned int addr, unsigned int n_bytes);
static int flip2_read_sig_bytes(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem);
static int flip2_parseexitspecs(PROGRAMMER *pgm, const char *s);
static void flip2_setup(PROGRAMMER *pgm);
static void flip2_teardown(PROGRAMMER *pgm);

static void flip2_show_info(struct flip2 *flip2);
static int flip2_read_memory(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit,
  uint32_t addr, void *ptr, int size);
static int flip2_write_memory(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit,
  uint32_t addr, const void *ptr, int size);
static int flip2_set_mem_unit(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit);
static int flip2_set_mem_page(struct dfu_dev *dfu, unsigned short page_addr);
static int flip2_read_max1k(struct dfu_dev *dfu, unsigned short offset,
  void *ptr, unsigned short size);
static int flip2_write_max1k(struct dfu_dev *dfu, unsigned short offset,
  const void *ptr, unsigned short size);

static const char *flip2_status_str(const struct dfu_status *status);
static const char *flip2_mem_unit_str(enum flip2_mem_unit mem_unit);
static enum flip2_mem_unit flip2_mem_unit(const char *name);

void flip2_initpgm(PROGRAMMER *pgm) {
  strcpy(pgm->type, "flip2");

  // Mandatory functions
  pgm->initialize = flip2_initialize;
  pgm->enable = flip2_enable;
  pgm->disable = flip2_disable;
  pgm->display = flip2_display;
  pgm->program_enable = flip2_program_enable;
  pgm->chip_erase = flip2_chip_erase;
  pgm->open = flip2_open;
  pgm->close = flip2_close;
  pgm->paged_load = flip2_paged_load;
  pgm->paged_write = flip2_paged_write;
  pgm->read_byte = flip2_read_byte;
  pgm->write_byte = flip2_write_byte;
  pgm->read_sig_bytes = flip2_read_sig_bytes;
  pgm->parseexitspecs = flip2_parseexitspecs;
  pgm->setup = flip2_setup;
  pgm->teardown = flip2_teardown;
}

static int flip2_open(PROGRAMMER *pgm, const char *port_spec) {
  if(pgm->bitclock)
    pmsg_warning("-c %s does not support adjustable bitclock speed; ignoring -B\n", pgmid);

  FLIP2(pgm)->dfu = dfu_open(port_spec);
  return (FLIP2(pgm)->dfu != NULL)? 0: -1;
}

static int flip2_initialize(const PROGRAMMER *pgm, const AVRPART *part) {
  unsigned short vid, pid;
  int result;
  struct dfu_dev *dfu = FLIP2(pgm)->dfu;

  /* A note about return values. Negative return values from this function are
   * interpreted as failure by main(), from where this function is called.
   * However such failures are interpreted as a device signature check failure
   * and the user is advised to use the -F option to override this check. In
   * our case, this is misleading, so we defer reporting an error until another
   * function is called. Thus, we always return 0 (success) from initialize().
   * I don't like this, but I don't want to mess with main().
   */

  /* The dfu_init() function will try to find the target part either based on
   * a USB address provided by the user with the -P option or by matching the
   * VID and PID of the device. The VID may be specified in the programmer
   * definition; if not specified, it defaults to USB_VENDOR_ATMEL (defined
   * in usbdevs.h). The PID may be specified either in the programmer
   * definition or the part definition; the programmer definition takes
   * priority. The default PID value is 0, which causes dfu_init() to ignore
   * the PID when matching a target device.
   */

  vid = (pgm->usbvid != 0)? pgm->usbvid: USB_VENDOR_ATMEL;
  LNODEID usbpid = lfirst(pgm->usbpid);

  if(usbpid) {
    pid = *(int *) (ldata(usbpid));
    if(lnext(usbpid))
      pmsg_warning("using PID 0x%04x, ignoring remaining PIDs in list\n", pid);
  } else {
    pid = part->usbpid;
  }

  if(!ovsigck && !is_pdi(part)) {
    pmsg_error("flip2 (FLIP protocol version 2) is for Xmega devices;\n");
    imsg_error("for AT90USB* or ATmega*U* devices use flip1 or use -F to bypass this check\n");
    return -1;
  }

  result = dfu_init(dfu, vid, pid);

  if(result != 0)
    goto flip2_initialize_fail;

  // Check if descriptor values are what we expect

  if(dfu->dev_desc.idVendor != vid)
    pmsg_warning("USB idVendor = 0x%04X (expected 0x%04X)\n", dfu->dev_desc.idVendor, vid);

  if(pid != 0 && dfu->dev_desc.idProduct != pid)
    pmsg_warning("USB idProduct = 0x%04X (expected 0x%04X)\n", dfu->dev_desc.idProduct, pid);

  if(dfu->dev_desc.bNumConfigurations != 1)
    pmsg_error("USB bNumConfigurations = %d (expected 1)\n", (int) dfu->dev_desc.bNumConfigurations);

  if(dfu->conf_desc.bNumInterfaces != 1)
    pmsg_error("USB bNumInterfaces = %d (expected 1)\n", (int) dfu->conf_desc.bNumInterfaces);

  if(dfu->dev_desc.bDeviceClass != 0)
    pmsg_error("USB bDeviceClass = %d (expected 0)\n", (int) dfu->dev_desc.bDeviceClass);

  if(dfu->dev_desc.bDeviceSubClass != 0)
    pmsg_error("USB bDeviceSubClass = %d (expected 0)\n", (int) dfu->dev_desc.bDeviceSubClass);

  if(dfu->dev_desc.bDeviceProtocol != 0)
    pmsg_error("USB bDeviceProtocol = %d (expected 0)\n", (int) dfu->dev_desc.bDeviceProtocol);

  if(dfu->intf_desc.bInterfaceClass != 0xFF)
    pmsg_error("USB bInterfaceClass = %d (expected 255)\n", (int) dfu->intf_desc.bInterfaceClass);

  if(dfu->intf_desc.bInterfaceSubClass != 0)
    pmsg_error("USB bInterfaceSubClass = %d (expected 0)\n", (int) dfu->intf_desc.bInterfaceSubClass);

  if(dfu->intf_desc.bInterfaceProtocol != 0)
    pmsg_error("USB bInterfaceSubClass = %d (expected 0)\n", (int) dfu->intf_desc.bInterfaceProtocol);

  result = flip2_read_memory(FLIP2(pgm)->dfu, FLIP2_MEM_UNIT_SIGNATURE, 0, FLIP2(pgm)->part_sig, 4);

  if(result != 0)
    goto flip2_initialize_fail;

  result = flip2_read_memory(FLIP2(pgm)->dfu, FLIP2_MEM_UNIT_BOOTLOADER, 0, &FLIP2(pgm)->boot_ver, 1);

  if(result != 0)
    goto flip2_initialize_fail;

  if(verbose > 0)
    flip2_show_info(FLIP2(pgm));

  return 0;

flip2_initialize_fail:
  dfu_close(FLIP2(pgm)->dfu);
  FLIP2(pgm)->dfu = NULL;
  return 0;
}

static void flip2_close(PROGRAMMER *pgm) {
  if(FLIP2(pgm)->dfu != NULL) {
    if(pgm->exit_reset == EXIT_RESET_ENABLED)
      flip2_start_app(pgm);

    dfu_close(FLIP2(pgm)->dfu);
    FLIP2(pgm)->dfu = NULL;
  }
}

static void flip2_enable(PROGRAMMER *pgm, const AVRPART *p) {
}

static void flip2_disable(const PROGRAMMER *pgm) {
}

static void flip2_display(const PROGRAMMER *pgm, const char *prefix) {
}

static int flip2_program_enable(const PROGRAMMER *pgm, const AVRPART *part) {
  return 0;
}

static int flip2_chip_erase(const PROGRAMMER *pgm, const AVRPART *part) {
  struct dfu_status status;
  int cmd_result = 0;
  int aux_result;

  pmsg_debug("flip_chip_erase()\n");

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_EXEC, FLIP2_CMD_CHIP_ERASE, {0xFF, 0, 0, 0}
  };

  for(;;) {
    cmd_result = dfu_dnload(FLIP2(pgm)->dfu, &cmd, sizeof(cmd));
    aux_result = dfu_getstatus(FLIP2(pgm)->dfu, &status);

    if(aux_result != 0)
      return aux_result;

    if(status.bStatus != DFU_STATUS_OK) {
      if(status.bStatus == ((FLIP2_STATUS_ERASE_ONGOING >> 8) & 0xFF) &&
        status.bState == ((FLIP2_STATUS_ERASE_ONGOING >> 0) & 0xFF)) {
        continue;
      }
      pmsg_error("DFU status %s\n", flip2_status_str(&status));
      dfu_clrstatus(FLIP2(pgm)->dfu);
    } else
      break;
  }

  return cmd_result;
}

static int flip2_start_app(const PROGRAMMER *pgm) {
  pmsg_info("starting application\n");

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_EXEC, FLIP2_CMD_START_APP, {0x00, 0, 0, 0}
  };

  // Queue command
  int cmd_result = dfu_dnload(FLIP2(pgm)->dfu, &cmd, sizeof(cmd));

  // Repeat dnload to actually execute
  dfu_dnload(FLIP2(pgm)->dfu, &cmd, sizeof(cmd));

  return cmd_result;
}

static int flip2_read_byte(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned long addr, unsigned char *value) {
  enum flip2_mem_unit mem_unit;

  if(FLIP2(pgm)->dfu == NULL)
    return -1;

  mem_unit = flip2_mem_unit(mem->desc);

  if(mem_unit == FLIP2_MEM_UNIT_UNKNOWN) {
    pmsg_error("%s memory not accessible using FLIP", mem->desc);
    if(mem_is_flash(mem))
      msg_error(" (did you mean \"application\"?)");
    msg_error("\n");
    return -1;
  }

  return flip2_read_memory(FLIP2(pgm)->dfu, mem_unit, addr, value, 1);
}

static int flip2_write_byte(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned long addr, unsigned char value) {
  enum flip2_mem_unit mem_unit;

  if(mem_is_readonly(mem)) {
    unsigned char is;

    if(pgm->read_byte(pgm, part, mem, addr, &is) >= 0 && is == value)
      return 0;

    pmsg_error("cannot write to read-only memory %s of %s\n", mem->desc, part->desc);
    return -1;
  }

  if(FLIP2(pgm)->dfu == NULL)
    return -1;

  mem_unit = flip2_mem_unit(mem->desc);

  if(mem_unit == FLIP2_MEM_UNIT_UNKNOWN) {
    pmsg_error("%s memory not accessible using FLIP", mem->desc);
    if(mem_is_flash(mem))
      msg_error(" (did you mean \"application\"?)");
    msg_error("\n");
    return -1;
  }

  return flip2_write_memory(FLIP2(pgm)->dfu, mem_unit, addr, &value, 1);
}

static int flip2_paged_load(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned int page_size, unsigned int addr, unsigned int n_bytes) {

  enum flip2_mem_unit mem_unit;
  int result;

  if(FLIP2(pgm)->dfu == NULL)
    return -1;

  mem_unit = flip2_mem_unit(mem->desc);

  if(mem_unit == FLIP2_MEM_UNIT_UNKNOWN) {
    pmsg_error("%s memory not accessible using FLIP", mem->desc);
    if(mem_is_flash(mem))
      msg_error(" (did you mean \"application\"?)");
    msg_error("\n");
    return -1;
  }

  if(n_bytes > INT_MAX) {
    // This should never happen, unless the int type is only 16 bits
    pmsg_error("attempting to read more than %d bytes\n", INT_MAX);
    return -1;
  }

  result = flip2_read_memory(FLIP2(pgm)->dfu, mem_unit, addr, mem->buf + addr, n_bytes);

  return result == 0? (int) n_bytes: -1;
}

static int flip2_paged_write(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem,
  unsigned int page_size, unsigned int addr, unsigned int n_bytes) {

  enum flip2_mem_unit mem_unit;
  int result;

  if(FLIP2(pgm)->dfu == NULL)
    return -1;

  mem_unit = flip2_mem_unit(mem->desc);

  if(mem_unit == FLIP2_MEM_UNIT_UNKNOWN) {
    pmsg_error("%s memory not accessible using FLIP", mem->desc);
    if(mem_is_flash(mem))
      msg_error(" (did you mean \"application\"?)");
    msg_error("\n");
    return -1;
  }

  if(n_bytes > INT_MAX) {
    // This should never happen, unless the int type is only 16 bits
    pmsg_error("attempting to read more than %d bytes\n", INT_MAX);
    return -1;
  }

  result = flip2_write_memory(FLIP2(pgm)->dfu, mem_unit, addr, mem->buf + addr, n_bytes);

  return result == 0? (int) n_bytes: -1;
}

// Parse the -E option flag
static int flip2_parseexitspecs(PROGRAMMER *pgm, const char *sp) {
  char *cp, *s, *str = mmt_strdup(sp);
  int rv = 0;
  bool help = false;

  s = str;
  while((cp = strtok(s, ","))) {
    s = NULL;
    if(str_eq(cp, "reset")) {
      pgm->exit_reset = EXIT_RESET_ENABLED;
      continue;
    }
    if(str_eq(cp, "noreset")) {
      pgm->exit_reset = EXIT_RESET_DISABLED;
      continue;
    }
    if(str_eq(cp, "help")) {
      help = true;
      rv = LIBAVRDUDE_EXIT;
    }

    if(!help) {
      pmsg_error("invalid exitspec parameter -E %s\n", cp);
      rv = -1;
    }
    msg_error("%s -c %s exitspec parameter options:\n", progname, pgmid);
    msg_error("  -E reset   Application will not start automatically after programming session\n");
    msg_error("  -E noreset Application will start automatically after programming session\n");
    msg_error("  -E help    Show this help menu and exit\n");
    mmt_free(str);
    return rv;
  }

  mmt_free(str);
  return rv;
}

static int flip2_read_sig_bytes(const PROGRAMMER *pgm, const AVRPART *part, const AVRMEM *mem) {
  if(FLIP2(pgm)->dfu == NULL)
    return -1;

  if(mem->size < (int) sizeof(FLIP2(pgm)->part_sig)) {
    pmsg_error("signature read must be at least %u bytes\n", (unsigned int) sizeof(FLIP2(pgm)->part_sig));
    return -1;
  }

  memcpy(mem->buf, FLIP2(pgm)->part_sig, sizeof(FLIP2(pgm)->part_sig));
  return 0;
}

static void flip2_setup(PROGRAMMER *pgm) {
  pgm->cookie = mmt_malloc(sizeof(struct flip2));
}

static void flip2_teardown(PROGRAMMER *pgm) {
  mmt_free(pgm->cookie);
  pgm->cookie = NULL;
}

/* INTERNAL FUNCTION DEFINITIONS
 */

static void flip2_show_info(struct flip2 *flip2) {
  dfu_show_info(flip2->dfu);

  msg_info("    Part signature      : 0x%02X%02X%02X\n",
    (int) flip2->part_sig[0], (int) flip2->part_sig[1], (int) flip2->part_sig[2]);

  if(flip2->part_rev < 26)
    msg_info("    Part revision       : %c\n", (char) (flip2->part_rev + 'A'));
  else
    msg_info("    Part revision       : %c%c\n",
      (char) (flip2->part_rev/26 - 1 + 'A'), (char) (flip2->part_rev%26 + 'A'));

  msg_info("    Bootloader version  : 2.%u.%u\n",
   (flip2->boot_ver >> 4) & 0xF, (flip2->boot_ver >> 0) & 0xF);

  msg_info("    USB max packet size : %hu\n",
    (unsigned short) flip2->dfu->dev_desc.bMaxPacketSize0);
}

static int flip2_read_memory(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit,
  uint32_t addr, void *ptr, int size) {

  unsigned short prev_page_addr;
  unsigned short page_addr;
  const char *mem_name;
  int read_size;
  int result;

  pmsg_debug("flip_read_memory(%s, 0x%04x, %d)\n", flip2_mem_unit_str(mem_unit), addr, size);

  result = flip2_set_mem_unit(dfu, mem_unit);

  if(result != 0) {
    if((mem_name = flip2_mem_unit_str(mem_unit)) != NULL)
      pmsg_error("unable to set memory unit 0x%02X (%s)\n", (int) mem_unit, mem_name);
    else
      pmsg_error("unable to set memory unit 0x%02X\n", (int) mem_unit);
    return -1;
  }

  page_addr = addr >> 16;
  result = flip2_set_mem_page(dfu, page_addr);

  if(result != 0) {
    pmsg_error("unable to set memory page 0x%04hX\n", page_addr);
    return -1;
  }

  while(size > 0) {
    prev_page_addr = page_addr;
    page_addr = addr >> 16;

    if(page_addr != prev_page_addr) {
      result = flip2_set_mem_page(dfu, page_addr);
      if(result != 0) {
        pmsg_error("unable to set memory page 0x%04hX\n", page_addr);
        return -1;
      }
    }

    read_size = (size > 0x400)? 0x400: size;
    result = flip2_read_max1k(dfu, addr & 0xFFFF, ptr, read_size);

    if(result != 0) {
      pmsg_error("unable to read 0x%04X bytes at 0x%04lX\n", read_size, (unsigned long) addr);
      return -1;
    }

    ptr = (char *) ptr + read_size;
    addr += read_size;
    size -= read_size;
  }

  return 0;
}

static int flip2_write_memory(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit,
  uint32_t addr, const void *ptr, int size) {

  unsigned short prev_page_addr;
  unsigned short page_addr;
  const char *mem_name;
  int write_size;
  int result;

  pmsg_debug("flip_write_memory(%s, 0x%04x, %d)\n", flip2_mem_unit_str(mem_unit), addr, size);

  result = flip2_set_mem_unit(dfu, mem_unit);

  if(result != 0) {
    if((mem_name = flip2_mem_unit_str(mem_unit)) != NULL)
      pmsg_error("unable to set memory unit 0x%02X (%s)\n", (int) mem_unit, mem_name);
    else
      pmsg_error("unable to set memory unit 0x%02X\n", (int) mem_unit);
    return -1;
  }

  page_addr = addr >> 16;
  result = flip2_set_mem_page(dfu, page_addr);

  if(result != 0) {
    pmsg_error("unable to set memory page 0x%04hX\n", page_addr);
    return -1;
  }

  while(size > 0) {
    prev_page_addr = page_addr;
    page_addr = addr >> 16;

    if(page_addr != prev_page_addr) {
      result = flip2_set_mem_page(dfu, page_addr);
      if(result != 0) {
        pmsg_error("unable to set memory page 0x%04hX\n", page_addr);
        return -1;
      }
    }

    write_size = (size > 0x800)? 0x800: size;
    result = flip2_write_max1k(dfu, addr & 0xFFFF, ptr, write_size);

    if(result != 0) {
      pmsg_error("unable to write 0x%04X bytes at 0x%04lX\n", write_size, (unsigned long) addr);
      return -1;
    }

    ptr = (const char *) ptr + write_size;
    addr += write_size;
    size -= write_size;
  }

  return 0;
}

static int flip2_set_mem_unit(struct dfu_dev *dfu, enum flip2_mem_unit mem_unit) {
  struct dfu_status status;
  int cmd_result = 0;
  int aux_result;

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_SELECT, FLIP2_CMD_SELECT_MEMORY, {0, 0, 0, 0}
  };

  cmd.args[0] = FLIP2_SELECT_MEMORY_UNIT;
  cmd.args[1] = mem_unit;

  cmd_result = dfu_dnload(dfu, &cmd, sizeof(cmd));

  aux_result = dfu_getstatus(dfu, &status);

  if(aux_result != 0)
    return aux_result;

  if(status.bStatus != DFU_STATUS_OK) {
    if(status.bStatus == ((FLIP2_STATUS_OUTOFRANGE >> 8) & 0xFF) &&
      status.bState == ((FLIP2_STATUS_OUTOFRANGE >> 0) & 0xFF)) {

      pmsg_error("unknown memory unit (0x%02x)\n", (unsigned int) mem_unit);
    } else
      pmsg_error("DFU status %s\n", flip2_status_str(&status));
    dfu_clrstatus(dfu);
  }

  return cmd_result;
}

static int flip2_set_mem_page(struct dfu_dev *dfu, unsigned short page_addr) {

  struct dfu_status status;
  int cmd_result = 0;
  int aux_result;

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_SELECT, FLIP2_CMD_SELECT_MEMORY, {0, 0, 0, 0}
  };

  cmd.args[0] = FLIP2_SELECT_MEMORY_PAGE;
  cmd.args[1] = (page_addr >> 8) & 0xFF;
  cmd.args[2] = (page_addr >> 0) & 0xFF;

  cmd_result = dfu_dnload(dfu, &cmd, sizeof(cmd));

  aux_result = dfu_getstatus(dfu, &status);

  if(aux_result != 0)
    return aux_result;

  if(status.bStatus != DFU_STATUS_OK) {
    if(status.bStatus == ((FLIP2_STATUS_OUTOFRANGE >> 8) & 0xFF) &&
      status.bState == ((FLIP2_STATUS_OUTOFRANGE >> 0) & 0xFF)) {

      pmsg_error("page address out of range (0x%04hx)\n", page_addr);
    } else
      pmsg_error("DFU status %s\n", flip2_status_str(&status));
    dfu_clrstatus(dfu);
  }

  return cmd_result;
}

static int flip2_read_max1k(struct dfu_dev *dfu, unsigned short offset, void *ptr, unsigned short size) {

  struct dfu_status status;
  int cmd_result = 0;
  int aux_result;

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_UPLOAD, FLIP2_CMD_READ_MEMORY, {0, 0, 0, 0}
  };

  cmd.args[0] = (offset >> 8) & 0xFF;
  cmd.args[1] = (offset >> 0) & 0xFF;
  cmd.args[2] = ((offset + size - 1) >> 8) & 0xFF;
  cmd.args[3] = ((offset + size - 1) >> 0) & 0xFF;

  cmd_result = dfu_dnload(dfu, &cmd, sizeof(cmd));

  if(cmd_result != 0)
    goto flip2_read_max1k_status;

  cmd_result = dfu_upload(dfu, (char *) ptr, size);

flip2_read_max1k_status:

  aux_result = dfu_getstatus(dfu, &status);

  if(aux_result != 0)
    return aux_result;

  if(status.bStatus != DFU_STATUS_OK) {
    if(status.bStatus == ((FLIP2_STATUS_OUTOFRANGE >> 8) & 0xFF) &&
      status.bState == ((FLIP2_STATUS_OUTOFRANGE >> 0) & 0xFF)) {

      pmsg_error("address out of range [0x%04X,0x%04X]\n", offset, (offset + size - 1) & 0xffff);
    } else
      pmsg_error("DFU status %s\n", flip2_status_str(&status));
    dfu_clrstatus(dfu);
  }

  return cmd_result;
}

static int flip2_write_max1k(struct dfu_dev *dfu, unsigned short offset, const void *ptr, unsigned short size) {

  char buffer[64 + 64 + 0x400];
  unsigned short data_offset;
  struct dfu_status status;
  int cmd_result = 0;
  int aux_result;

  struct flip2_cmd cmd = {
    FLIP2_CMD_GROUP_DOWNLOAD, FLIP2_CMD_PROG_START, {0, 0, 0, 0}
  };

  cmd.args[0] = (offset >> 8) & 0xFF;
  cmd.args[1] = (offset >> 0) & 0xFF;
  cmd.args[2] = ((offset + size - 1) >> 8) & 0xFF;
  cmd.args[3] = ((offset + size - 1) >> 0) & 0xFF;

  if(size > 0x400) {
    pmsg_error("erite block too large (%hu > 1024)\n", size);
    return -1;
  }

  /* There are some special padding requirements for writes. The first packet
   * must consist only of the FLIP2 command data, which must be padded to
   * fill out the USB packet (the packet size is given by bMaxPacketSize0 in
   * the device descriptor). In addition, the data must be padded so that the
   * first byte of data to be written is at located at position (offset mod
   * bMaxPacketSize0) within the packet.
   */

  data_offset = dfu->dev_desc.bMaxPacketSize0;
  data_offset += offset%dfu->dev_desc.bMaxPacketSize0;

  memcpy(buffer, &cmd, sizeof(cmd));
  memset(buffer + sizeof(cmd), 0, data_offset - sizeof(cmd));
  memcpy(buffer + data_offset, ptr, size);

  cmd_result = dfu_dnload(dfu, buffer, data_offset + size);

  aux_result = dfu_getstatus(dfu, &status);

  if(aux_result != 0)
    return aux_result;

  if(status.bStatus != DFU_STATUS_OK) {
    if(status.bStatus == ((FLIP2_STATUS_OUTOFRANGE >> 8) & 0xFF) &&
      status.bState == ((FLIP2_STATUS_OUTOFRANGE >> 0) & 0xFF)) {

      pmsg_error("address out of range [0x%04X,0x%04X]\n", offset, (offset + size - 1) & 0xffff);
    } else
      pmsg_error("DFU status %s\n", flip2_status_str(&status));
    dfu_clrstatus(dfu);
  }

  return cmd_result;
}

static const char *flip2_status_str(const struct dfu_status *status) {
  unsigned short selector;

  selector = (unsigned short) status->bStatus << 8;
  selector |= status->bState;

  switch(selector) {
  case FLIP2_STATUS_OK:
    return "OK";
  case FLIP2_STATUS_STALL:
    return "STALL";
  case FLIP2_STATUS_MEM_UKNOWN:
    return "MEM_UKNOWN";
  case FLIP2_STATUS_MEM_PROTECTED:
    return "MEM_PROTECTED";
  case FLIP2_STATUS_OUTOFRANGE:
    return "OUTOFRANGE";
  case FLIP2_STATUS_BLANK_FAIL:
    return "BLANK_FAIL";
  case FLIP2_STATUS_ERASE_ONGOING:
    return "ERASE_ONGOING";
  default:
    return dfu_status_str(status->bStatus);
  }
}

static const char *flip2_mem_unit_str(enum flip2_mem_unit mem_unit) {
  switch(mem_unit) {
  case FLIP2_MEM_UNIT_FLASH:
    return "Flash";
  case FLIP2_MEM_UNIT_EEPROM:
    return "EEPROM";
  case FLIP2_MEM_UNIT_SECURITY:
    return "security";
  case FLIP2_MEM_UNIT_CONFIGURATION:
    return "configuration";
  case FLIP2_MEM_UNIT_BOOTLOADER:
    return "bootloader version";
  case FLIP2_MEM_UNIT_SIGNATURE:
    return "signature";
  case FLIP2_MEM_UNIT_USER:
    return "user";
  case FLIP2_MEM_UNIT_INT_RAM:
    return "internal RAM";
  case FLIP2_MEM_UNIT_EXT_MEM_CS0:
    return "EXT_MEM_CS0";
  case FLIP2_MEM_UNIT_EXT_MEM_CS1:
    return "EXT_MEM_CS1";
  case FLIP2_MEM_UNIT_EXT_MEM_CS2:
    return "EXT_MEM_CS2";
  case FLIP2_MEM_UNIT_EXT_MEM_CS3:
    return "EXT_MEM_CS3";
  case FLIP2_MEM_UNIT_EXT_MEM_CS4:
    return "EXT_MEM_CS4";
  case FLIP2_MEM_UNIT_EXT_MEM_CS5:
    return "EXT_MEM_CS5";
  case FLIP2_MEM_UNIT_EXT_MEM_CS6:
    return "EXT_MEM_CS6";
  case FLIP2_MEM_UNIT_EXT_MEM_CS7:
    return "EXT_MEM_CS7";
  case FLIP2_MEM_UNIT_EXT_MEM_DF:
    return "EXT_MEM_DF";
  default:
    return "unknown";
  }
}

static enum flip2_mem_unit flip2_mem_unit(const char *name) {
  if(str_eq(name, "application"))
    return FLIP2_MEM_UNIT_FLASH;
  if(str_eq(name, "eeprom"))
    return FLIP2_MEM_UNIT_EEPROM;
  if(str_eq(name, "signature"))
    return FLIP2_MEM_UNIT_SIGNATURE;
  return FLIP2_MEM_UNIT_UNKNOWN;
}

#else                           // !HAVE_LIBUSB

 // Give a proper error if we were not compiled with libusb
static int flip2_nousb_open(PROGRAMMER *pgm, const char *name) {
  pmsg_error("no USB support; please compile with libusb installed\n");
  return -1;
}

void flip2_initpgm(PROGRAMMER *pgm) {
  strcpy(pgm->type, "flip2");
  pgm->open = flip2_nousb_open;
}
#endif                          // HAVE_LIBUSB