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