kinect_upload_fw/kinect_upload_fw.c

   1 /*
   2  * Copyright 2011 Drew Fisher <drew.m.fisher@gmail.com>. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  *   1. Redistributions of source code must retain the above copyright
   9  *      notice, this list of conditions and the following disclaimer.
  10  *
  11  *   2. Redistributions in binary form must reproduce the above copyright
  12  *      notice, this list of conditions and the following disclaimer in the
  13  *      documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS  ''AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL DREW FISHER OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * The views and conclusions contained in the software and documentation are
  28  * those of the authors and should not be interpreted as representing official
  29  * policies, either expressed or implied, of Drew Fisher.
  30  */
  31
  32 #include <stdio.h>
  33 #include <unistd.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <errno.h>
  37 #include <libusb.h>
  38
  39 static libusb_device_handle *dev;
  40 unsigned int seq;
  41
  42 typedef struct {
  43         uint32_t magic;
  44         uint32_t seq;
  45         uint32_t bytes;
  46         uint32_t cmd;
  47         uint32_t write_addr;
  48         uint32_t unk;
  49 } bootloader_command;
  50
  51 typedef struct {
  52         uint32_t magic;
  53         uint32_t seq;
  54         uint32_t status;
  55 } status_code;
  56
  57 #define LOG(...) printf(__VA_ARGS__)
  58 #define fn_le32(x) (x)
  59 // TODO: support architectures that aren't little-endian
  60
  61 static void dump_bl_cmd(bootloader_command cmd) {
  62         int i;
  63         for (i = 0; i < 24; i++)
  64                 LOG("%02X ", ((unsigned char*)(&cmd))[i]);
  65         LOG("\n");
  66 }
  67
  68 static int get_first_reply(void) {
  69         unsigned char buffer[512];
  70         int res;
  71         int transferred;
  72         res = libusb_bulk_transfer(dev, 0x81, buffer, 512, &transferred, 0);
  73         if (res != 0 ) {
  74                 LOG("Error reading first reply: %d\ttransferred: %d (expected %d)\n", res, transferred, 0x60);
  75                 return res;
  76         }
  77         LOG("Reading first reply: ");
  78         int i;
  79         for (i = 0; i < transferred; ++i) {
  80                 LOG("%02X ", buffer[i]);
  81         }
  82         LOG("\n");
  83         return res;
  84 }
  85
  86 static int get_reply(void) {
  87         union {
  88                 status_code buffer;
  89                 /* The following is needed because libusb_bulk_transfer might
  90                  * fail when working on a buffer smaller than 512 bytes.
  91                  */
  92                 unsigned char dump[512];
  93         } reply;
  94         int res;
  95         int transferred;
  96
  97         res = libusb_bulk_transfer(dev, 0x81, reply.dump, 512, &transferred, 0);
  98         if (res != 0 || transferred != sizeof(status_code)) {
  99                 LOG("Error reading reply: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(status_code));
 100                 return res;
 101         }
 102         if (fn_le32(reply.buffer.magic) != 0x0a6fe000) {
 103                 LOG("Error reading reply: invalid magic %08X\n", reply.buffer.magic);
 104                 return -1;
 105         }
 106         if (fn_le32(reply.buffer.seq) != seq) {
 107                 LOG("Error reading reply: non-matching sequence number %08X (expected %08X)\n", reply.buffer.seq, seq);
 108                 return -1;
 109         }
 110         if (fn_le32(reply.buffer.status) != 0) {
 111                 LOG("Notice reading reply: last uint32_t was nonzero: %d\n", reply.buffer.status);
 112         }
 113
 114         LOG("Reading reply: ");
 115         int i;
 116         for (i = 0; i < transferred; ++i) {
 117                 LOG("%02X ", reply.dump[i]);
 118         }
 119         LOG("\n");
 120
 121         return res;
 122 }
 123
 124 int main(int argc, char** argv) {
 125         char default_filename[] = "firmware.bin";
 126         char* filename = default_filename;
 127         int res = 0;
 128
 129         if (argc == 2) {
 130                 filename = argv[1];
 131         }
 132
 133         FILE* fw = fopen(filename, "r");
 134         if (fw == NULL) {
 135                 fprintf(stderr, "Failed to open %s: %s\n", filename, strerror(errno));
 136                 return errno;
 137         }
 138
 139         libusb_init(NULL);
 140         libusb_set_debug(0, 3);
 141
 142         dev = libusb_open_device_with_vid_pid(NULL, 0x045e, 0x02ad);
 143         if (dev == NULL) {
 144                 fprintf(stderr, "Couldn't open device.\n");
 145                 res = -ENODEV;
 146                 goto fail_libusb_open;
 147         }
 148
 149         libusb_set_configuration(dev, 1);
 150         libusb_claim_interface(dev, 0);
 151
 152         seq = 1;
 153
 154         bootloader_command cmd;
 155         cmd.magic = fn_le32(0x06022009);
 156         cmd.seq = fn_le32(seq);
 157         cmd.bytes = fn_le32(0x60);
 158         cmd.cmd = fn_le32(0);
 159         cmd.write_addr = fn_le32(0x15);
 160         cmd.unk = fn_le32(0);
 161
 162         LOG("About to send: ");
 163         dump_bl_cmd(cmd);
 164
 165         int transferred;
 166
 167         res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 168         if (res != 0 || transferred != sizeof(cmd)) {
 169                 LOG("Error: res: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(cmd));
 170                 goto cleanup;
 171         }
 172         res = get_first_reply(); // This first one doesn't have the usual magic bytes at the beginning, and is 96 bytes long - much longer than the usual 12-byte replies.
 173         res = get_reply(); // I'm not sure why we do this twice here, but maybe it'll make sense later.
 174         seq++;
 175
 176         uint32_t addr = 0x00080000;
 177         unsigned char page[0x4000];
 178         int read;
 179         do {
 180                 read = fread(page, 1, 0x4000, fw);
 181                 if (read <= 0) {
 182                         break;
 183                 }
 184                 //LOG("");
 185                 cmd.seq = fn_le32(seq);
 186                 cmd.bytes = fn_le32(read);
 187                 cmd.cmd = fn_le32(0x03);
 188                 cmd.write_addr = fn_le32(addr);
 189                 LOG("About to send: ");
 190                 dump_bl_cmd(cmd);
 191                 // Send it off!
 192                 res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 193                 if (res != 0 || transferred != sizeof(cmd)) {
 194                         LOG("Error: res: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(cmd));
 195                         goto cleanup;
 196                 }
 197                 int bytes_sent = 0;
 198                 while (bytes_sent < read) {
 199                         int to_send = (read - bytes_sent > 512 ? 512 : read - bytes_sent);
 200                         res = libusb_bulk_transfer(dev, 1, &page[bytes_sent], to_send, &transferred, 0);
 201                         if (res != 0 || transferred != to_send) {
 202                                 LOG("Error: res: %d\ttransferred: %d (expected %d)\n", res, transferred, to_send);
 203                                 goto cleanup;
 204                         }
 205                         bytes_sent += to_send;
 206                 }
 207                 res = get_reply();
 208
 209                 addr += (uint32_t)read;
 210                 seq++;
 211         } while (read > 0);
 212
 213         cmd.seq = fn_le32(seq);
 214         cmd.bytes = fn_le32(0);
 215         cmd.cmd = fn_le32(0x04);
 216         cmd.write_addr = fn_le32(0x00080030);
 217         dump_bl_cmd(cmd);
 218         res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 219         if (res != 0 || transferred != sizeof(cmd)) {
 220                 LOG("Error: res: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(cmd));
 221                 goto cleanup;
 222         }
 223         res = get_reply();
 224         seq++;
 225         // Now the device reenumerates.
 226
 227 cleanup:
 228         libusb_close(dev);
 229 fail_libusb_open:
 230         libusb_exit(NULL);
 231         fclose(fw);
 232         return res;
 233 }