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 #define KINECT_AUDIO_VID           0x045e
  42 #define KINECT_AUDIO_PID           0x02ad
  43 #define KINECT_AUDIO_CONFIGURATION 1
  44 #define KINECT_AUDIO_INTERFACE     0
  45 #define KINECT_AUDIO_IN_EP         0x81
  46 #define KINECT_AUDIO_OUT_EP        0x01
  47
  48 static libusb_device_handle *dev;
  49 static unsigned int seq;
  50
  51 typedef struct {
  52         uint32_t magic;
  53         uint32_t seq;
  54         uint32_t bytes;
  55         uint32_t cmd;
  56         uint32_t write_addr;
  57         uint32_t unk;
  58 } bootloader_command;
  59
  60 typedef struct {
  61         uint32_t magic;
  62         uint32_t seq;
  63         uint32_t status;
  64 } status_code;
  65
  66 #define LOG(...) printf(__VA_ARGS__)
  67
  68 #if __BYTE_ORDER == __BIG_ENDIAN
  69 static inline uint32_t fn_le32(uint32_t d)
  70 {
  71         return (d<<24) | ((d<<8)&0xFF0000) | ((d>>8)&0xFF00) | (d>>24);
  72 }
  73 #else
  74 #define fn_le32(x) (x)
  75 #endif
  76
  77 static void dump_bl_cmd(bootloader_command cmd) {
  78         int i;
  79         for (i = 0; i < 24; i++)
  80                 LOG("%02X ", ((unsigned char*)(&cmd))[i]);
  81         LOG("\n");
  82 }
  83
  84 static int get_first_reply(void) {
  85         unsigned char buffer[512];
  86         int res;
  87
  88         int transferred = 0;
  89         res = libusb_bulk_transfer(dev, KINECT_AUDIO_IN_EP, buffer, 512, &transferred, 0);
  90         if (res != 0 ) {
  91                 LOG("Error reading first reply: %d\ttransferred: %d (expected %d)\n", res, transferred, 0x60);
  92                 return res;
  93         }
  94         LOG("Reading first reply: ");
  95         int i;
  96         for (i = 0; i < transferred; ++i) {
  97                 LOG("%02X ", buffer[i]);
  98         }
  99         LOG("\n");
 100         return res;
 101 }
 102
 103 static int get_reply(void) {
 104         union {
 105                 status_code buffer;
 106                 /* The following is needed because libusb_bulk_transfer might
 107                  * fail when working on a buffer smaller than 512 bytes.
 108                  */
 109                 unsigned char dump[512];
 110         } reply;
 111         int res;
 112         int transferred = 0;
 113
 114         res = libusb_bulk_transfer(dev, KINECT_AUDIO_IN_EP, reply.dump, 512, &transferred, 0);
 115         if (res != 0 || transferred != sizeof(status_code)) {
 116                 LOG("Error reading reply: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(status_code));
 117                 return res;
 118         }
 119         if (fn_le32(reply.buffer.magic) != 0x0a6fe000) {
 120                 LOG("Error reading reply: invalid magic %08X\n", reply.buffer.magic);
 121                 return -1;
 122         }
 123         if (fn_le32(reply.buffer.seq) != seq) {
 124                 LOG("Error reading reply: non-matching sequence number %08X (expected %08X)\n", reply.buffer.seq, seq);
 125                 return -1;
 126         }
 127         if (fn_le32(reply.buffer.status) != 0) {
 128                 LOG("Notice reading reply: last uint32_t was nonzero: %d\n", reply.buffer.status);
 129         }
 130
 131         LOG("Reading reply: ");
 132         int i;
 133         for (i = 0; i < transferred; ++i) {
 134                 LOG("%02X ", reply.dump[i]);
 135         }
 136         LOG("\n");
 137
 138         return res;
 139 }
 140
 141 static int upload_firmware(FILE *fw) {
 142         int res;
 143
 144         seq = 1;
 145
 146         bootloader_command cmd;
 147         cmd.magic = fn_le32(0x06022009);
 148         cmd.seq = fn_le32(seq);
 149         cmd.bytes = fn_le32(0x60);
 150         cmd.cmd = fn_le32(0);
 151         cmd.write_addr = fn_le32(0x15);
 152         cmd.unk = fn_le32(0);
 153
 154         LOG("About to send: ");
 155         dump_bl_cmd(cmd);
 156
 157         int transferred = 0;
 158
 159         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char *)&cmd, sizeof(cmd), &transferred, 0);
 160         if (res != 0 || transferred != sizeof(cmd)) {
 161                 LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
 162                 goto out;
 163         }
 164
 165         // This first one doesn't have the usual magic bytes at the beginning,
 166         // and is 96 bytes long - much longer than the usual 12-byte replies.
 167         res = get_first_reply();
 168         if (res < 0) {
 169                 LOG("get_first_reply() failed");
 170                 goto out;
 171         }
 172
 173         // I'm not sure why we do this twice here, but maybe it'll make sense
 174         // later.
 175         res = get_reply();
 176         if (res < 0) {
 177                 LOG("First get_reply() failed");
 178                 goto out;
 179         }
 180         seq++;
 181
 182         // Split addr declaration and assignment in order to compile as C++,
 183         // otherwise this would give "jump to label '...' crosses initialization"
 184         // errors.
 185         uint32_t addr;
 186         addr = 0x00080000;
 187         unsigned char page[0x4000];
 188         int read;
 189         do {
 190                 read = (int)fread(page, 1, 0x4000, fw);
 191                 if (read <= 0) {
 192                         break;
 193                 }
 194                 //LOG("");
 195                 cmd.seq = fn_le32(seq);
 196                 cmd.bytes = fn_le32((unsigned int)read);
 197                 cmd.cmd = fn_le32(0x03);
 198                 cmd.write_addr = fn_le32(addr);
 199                 LOG("About to send: ");
 200                 dump_bl_cmd(cmd);
 201                 // Send it off!
 202                 transferred = 0;
 203                 res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char *)&cmd, sizeof(cmd), &transferred, 0);
 204                 if (res != 0 || transferred != sizeof(cmd)) {
 205                         LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
 206                         goto out;
 207                 }
 208                 int bytes_sent = 0;
 209                 while (bytes_sent < read) {
 210                         int to_send = (read - bytes_sent > 512 ? 512 : read - bytes_sent);
 211                         transferred = 0;
 212                         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, &page[bytes_sent], to_send, &transferred, 0);
 213                         if (res != 0 || transferred != to_send) {
 214                                 LOG("Error: res: %d\ttransferred: %d (expected %d)\n", res, transferred, to_send);
 215                                 goto out;
 216                         }
 217                         bytes_sent += to_send;
 218                 }
 219                 res = get_reply();
 220                 if (res < 0) {
 221                         LOG("get_reply failed");
 222                         goto out;
 223                 }
 224
 225                 addr += (uint32_t)read;
 226                 seq++;
 227         } while (read > 0);
 228
 229         cmd.seq = fn_le32(seq);
 230         cmd.bytes = fn_le32(0);
 231         cmd.cmd = fn_le32(0x04);
 232         cmd.write_addr = fn_le32(0x00080030);
 233         dump_bl_cmd(cmd);
 234         transferred = 0;
 235         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char *)&cmd, sizeof(cmd), &transferred, 0);
 236         if (res != 0 || transferred != sizeof(cmd)) {
 237                 LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
 238                 goto out;
 239         }
 240         res = get_reply();
 241         seq++;
 242
 243 out:
 244         return res;
 245 }
 246
 247 int main(int argc, char *argv[]) {
 248         char default_filename[] = "firmware.bin";
 249         char *filename = default_filename;
 250         int ret = 0;
 251
 252         if (argc == 2) {
 253                 filename = argv[1];
 254         }
 255
 256         FILE *fw = fopen(filename, "rb");
 257         if (fw == NULL) {
 258                 fprintf(stderr, "Failed to open %s: %s\n", filename, strerror(errno));
 259                 return -errno;
 260         }
 261
 262         ret = libusb_init(NULL);
 263         if (ret < 0) {
 264                 fprintf(stderr, "libusb_init failed: %s\n",
 265                         libusb_error_name(ret));
 266                 goto out;
 267         }
 268
 269         libusb_set_debug(NULL, 3);
 270
 271         dev = libusb_open_device_with_vid_pid(NULL, KINECT_AUDIO_VID, KINECT_AUDIO_PID);
 272         if (dev == NULL) {
 273                 fprintf(stderr, "libusb_open failed: %s\n", strerror(errno));
 274                 ret = -errno;
 275                 goto out_libusb_exit;
 276         }
 277
 278         int current_configuration = -1;
 279         ret = libusb_get_configuration(dev, &current_configuration);
 280         if (ret < 0) {
 281                 fprintf(stderr, "libusb_get_configuration failed: %s\n",
 282                         libusb_error_name(ret));
 283                 goto out_libusb_close;
 284         }
 285
 286         if (current_configuration != KINECT_AUDIO_CONFIGURATION) {
 287                 ret = libusb_set_configuration(dev, KINECT_AUDIO_CONFIGURATION);
 288                 if (ret < 0) {
 289                         fprintf(stderr, "libusb_set_configuration failed: %s\n",
 290                                 libusb_error_name(ret));
 291                         fprintf(stderr, "Cannot set configuration %d\n",
 292                                 KINECT_AUDIO_CONFIGURATION);
 293                         goto out_libusb_close;
 294                 }
 295         }
 296
 297         libusb_set_auto_detach_kernel_driver(dev, 1);
 298
 299         ret = libusb_claim_interface(dev, KINECT_AUDIO_INTERFACE);
 300         if (ret < 0) {
 301                 fprintf(stderr, "libusb_claim_interface failed: %s\n",
 302                         libusb_error_name(ret));
 303                 fprintf(stderr, "Cannot claim interface %d\n",
 304                         KINECT_AUDIO_INTERFACE);
 305                 goto out_libusb_close;
 306         }
 307
 308         /*
 309          * Checking that the configuration has not changed, as suggested in
 310          * http://libusb.sourceforge.net/api-1.0/caveats.html
 311          */
 312         current_configuration = -1;
 313         ret = libusb_get_configuration(dev, &current_configuration);
 314         if (ret < 0) {
 315                 fprintf(stderr, "libusb_get_configuration after claim failed: %s\n",
 316                         libusb_error_name(ret));
 317                 goto out_libusb_release_interface;
 318         }
 319
 320         if (current_configuration != KINECT_AUDIO_CONFIGURATION) {
 321                 fprintf(stderr, "libusb configuration changed (expected: %d, current: %d)\n",
 322                         KINECT_AUDIO_CONFIGURATION, current_configuration);
 323                 ret = -EINVAL;
 324                 goto out_libusb_release_interface;
 325         }
 326
 327         ret = upload_firmware(fw);
 328         // Now the device reenumerates.
 329
 330 out_libusb_release_interface:
 331         libusb_release_interface(dev, KINECT_AUDIO_INTERFACE);
 332 out_libusb_close:
 333         libusb_close(dev);
 334 out_libusb_exit:
 335         libusb_exit(NULL);
 336 out:
 337         fclose(fw);
 338         return ret;
 339 }