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 <errno.h>
  36 #include <libusb.h>
  37
  38 static libusb_device_handle *dev;
  39 unsigned int seq;
  40
  41 typedef struct {
  42         uint32_t magic;
  43         uint32_t seq;
  44         uint32_t bytes;
  45         uint32_t cmd;
  46         uint32_t write_addr;
  47         uint32_t unk;
  48 } bootloader_command;
  49
  50 typedef struct {
  51         uint32_t magic;
  52         uint32_t seq;
  53         uint32_t status;
  54 } status_code;
  55
  56 #define LOG(...) printf(__VA_ARGS__)
  57 #define fn_le32(x) (x)
  58 // TODO: support architectures that aren't little-endian
  59
  60 static void dump_bl_cmd(bootloader_command cmd) {
  61         int i;
  62         for(i = 0; i < 24; i++)
  63                 LOG("%02X ", ((unsigned char*)(&cmd))[i]);
  64         LOG("\n");
  65 }
  66
  67 static int get_first_reply(void) {
  68         unsigned char buffer[512];
  69         int res;
  70         int transferred;
  71         res = libusb_bulk_transfer(dev, 0x81, buffer, 512, &transferred, 0);
  72         if(res != 0 ) {
  73                 LOG("Error reading first reply: %d\ttransferred: %d (expected %d)\n", res, transferred, 0x60);
  74                 return res;
  75         }
  76         LOG("Reading first reply: ");
  77         int i;
  78         for(i = 0; i < transferred; ++i) {
  79                 LOG("%02X ", buffer[i]);
  80         }
  81         LOG("\n");
  82         return res;
  83 }
  84
  85 static int get_reply(void) {
  86         union {
  87                 status_code buffer;
  88                 /* The following is needed because libusb_bulk_transfer might
  89                  * fail when working on a buffer smaller than 512 bytes.
  90                  */
  91                 unsigned char dump[512];
  92         } reply;
  93         int res;
  94         int transferred;
  95
  96         res = libusb_bulk_transfer(dev, 0x81, reply.dump, 512, &transferred, 0);
  97         if(res != 0 || transferred != sizeof(status_code)) {
  98                 LOG("Error reading reply: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(status_code));
  99                 return res;
 100         }
 101         if(fn_le32(reply.buffer.magic) != 0x0a6fe000) {
 102                 LOG("Error reading reply: invalid magic %08X\n", reply.buffer.magic);
 103                 return -1;
 104         }
 105         if(fn_le32(reply.buffer.seq) != seq) {
 106                 LOG("Error reading reply: non-matching sequence number %08X (expected %08X)\n", reply.buffer.seq, seq);
 107                 return -1;
 108         }
 109         if(fn_le32(reply.buffer.status) != 0) {
 110                 LOG("Notice reading reply: last uint32_t was nonzero: %d\n", reply.buffer.status);
 111         }
 112
 113         LOG("Reading reply: ");
 114         int i;
 115         for(i = 0; i < transferred; ++i) {
 116                 LOG("%02X ", reply.dump[i]);
 117         }
 118         LOG("\n");
 119
 120         return res;
 121 }
 122
 123 int main(int argc, char** argv) {
 124         char default_filename[] = "firmware.bin";
 125         char* filename = default_filename;
 126         if (argc == 2) {
 127                 filename = argv[1];
 128         }
 129         FILE* fw = fopen(filename, "r");
 130         if(fw == NULL) {
 131                 fprintf(stderr, "Failed to open %s: error %d", filename, errno);
 132                 return errno;
 133         }
 134
 135         libusb_init(NULL);
 136         libusb_set_debug(0,3);
 137         dev = libusb_open_device_with_vid_pid(NULL, 0x045e, 0x02ad);
 138
 139         if(dev == NULL) {
 140                 printf("Couldn't open device.\n");
 141                 return 1;
 142         }
 143
 144         libusb_set_configuration(dev, 1);
 145         libusb_claim_interface(dev, 0);
 146
 147         seq = 1;
 148
 149         bootloader_command cmd;
 150         cmd.magic = fn_le32(0x06022009);
 151         cmd.seq = fn_le32(seq);
 152         cmd.bytes = fn_le32(0x60);
 153         cmd.cmd = fn_le32(0);
 154         cmd.write_addr = fn_le32(0x15);
 155         cmd.unk = fn_le32(0);
 156
 157         LOG("About to send: ");
 158         dump_bl_cmd(cmd);
 159         int res;
 160         int transferred;
 161
 162         res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 163         if(res != 0 || transferred != sizeof(cmd)) {
 164                 LOG("Error: res: %d\ttransferred: %d (expected %lu)\n",res, transferred, sizeof(cmd));
 165                 goto cleanup;
 166         }
 167         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.
 168         res = get_reply(); // I'm not sure why we do this twice here, but maybe it'll make sense later.
 169         seq++;
 170
 171         uint32_t addr = 0x00080000;
 172         unsigned char page[0x4000];
 173         int read;
 174         do {
 175                 read = fread(page, 1, 0x4000, fw);
 176                 if(read <= 0) {
 177                         break;
 178                 }
 179                 //LOG("");
 180                 cmd.seq = fn_le32(seq);
 181                 cmd.bytes = fn_le32(read);
 182                 cmd.cmd = fn_le32(0x03);
 183                 cmd.write_addr = fn_le32(addr);
 184                 LOG("About to send: ");
 185                 dump_bl_cmd(cmd);
 186                 // Send it off!
 187                 res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 188                 if(res != 0 || transferred != sizeof(cmd)) {
 189                         LOG("Error: res: %d\ttransferred: %d (expected %lu)\n",res, transferred, sizeof(cmd));
 190                         goto cleanup;
 191                 }
 192                 int bytes_sent = 0;
 193                 while(bytes_sent < read) {
 194                         int to_send = (read - bytes_sent > 512 ? 512 : read - bytes_sent);
 195                         res = libusb_bulk_transfer(dev, 1, &page[bytes_sent], to_send, &transferred, 0);
 196                         if(res != 0 || transferred != to_send) {
 197                                 LOG("Error: res: %d\ttransferred: %d (expected %d)\n",res, transferred, to_send);
 198                                 goto cleanup;
 199                         }
 200                         bytes_sent += to_send;
 201                 }
 202                 res = get_reply();
 203
 204                 addr += (uint32_t)read;
 205                 seq++;
 206         } while (read > 0);
 207
 208         cmd.seq = fn_le32(seq);
 209         cmd.bytes = fn_le32(0);
 210         cmd.cmd = fn_le32(0x04);
 211         cmd.write_addr = fn_le32(0x00080030);
 212         dump_bl_cmd(cmd);
 213         res = libusb_bulk_transfer(dev, 1, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
 214         if(res != 0 || transferred != sizeof(cmd)) {
 215                 LOG("Error: res: %d\ttransferred: %d (expected %lu)\n", res, transferred, sizeof(cmd));
 216                 goto cleanup;
 217         }
 218         res = get_reply();
 219         seq++;
 220         // Now the device reenumerates.
 221
 222 cleanup:
 223         libusb_close(dev);
 224         libusb_exit(NULL);
 225         return 0;
 226 }