5faf8e1ce91ce29f0a49e8617c24db67a5e3e4bb
[kinect-audio-setup.git] / 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         int transferred = 0;
88         res = libusb_bulk_transfer(dev, KINECT_AUDIO_IN_EP, buffer, 512, &transferred, 0);
89         if (res != 0 ) {
90                 LOG("Error reading first reply: %d\ttransferred: %d (expected %d)\n", res, transferred, 0x60);
91                 return res;
92         }
93         LOG("Reading first reply: ");
94         int i;
95         for (i = 0; i < transferred; ++i) {
96                 LOG("%02X ", buffer[i]);
97         }
98         LOG("\n");
99         return res;
100 }
101
102 static int get_reply(void) {
103         union {
104                 status_code buffer;
105                 /* The following is needed because libusb_bulk_transfer might
106                  * fail when working on a buffer smaller than 512 bytes.
107                  */
108                 unsigned char dump[512];
109         } reply;
110         int res;
111         int transferred = 0;
112
113         res = libusb_bulk_transfer(dev, KINECT_AUDIO_IN_EP, reply.dump, 512, &transferred, 0);
114         if (res != 0 || transferred != sizeof(status_code)) {
115                 LOG("Error reading reply: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(status_code));
116                 return res;
117         }
118         if (fn_le32(reply.buffer.magic) != 0x0a6fe000) {
119                 LOG("Error reading reply: invalid magic %08X\n", reply.buffer.magic);
120                 return -1;
121         }
122         if (fn_le32(reply.buffer.seq) != seq) {
123                 LOG("Error reading reply: non-matching sequence number %08X (expected %08X)\n", reply.buffer.seq, seq);
124                 return -1;
125         }
126         if (fn_le32(reply.buffer.status) != 0) {
127                 LOG("Notice reading reply: last uint32_t was nonzero: %d\n", reply.buffer.status);
128         }
129
130         LOG("Reading reply: ");
131         int i;
132         for (i = 0; i < transferred; ++i) {
133                 LOG("%02X ", reply.dump[i]);
134         }
135         LOG("\n");
136
137         return res;
138 }
139
140 int main(int argc, char** argv) {
141         char default_filename[] = "firmware.bin";
142         char* filename = default_filename;
143         int res = 0;
144
145         if (argc == 2) {
146                 filename = argv[1];
147         }
148
149         FILE* fw = fopen(filename, "rb");
150         if (fw == NULL) {
151                 fprintf(stderr, "Failed to open %s: %s\n", filename, strerror(errno));
152                 return errno;
153         }
154
155         libusb_init(NULL);
156         libusb_set_debug(NULL, 3);
157
158         dev = libusb_open_device_with_vid_pid(NULL, KINECT_AUDIO_VID, KINECT_AUDIO_PID);
159         if (dev == NULL) {
160                 fprintf(stderr, "Couldn't open device.\n");
161                 res = -ENODEV;
162                 goto fail_libusb_open;
163         }
164
165         int current_configuration = -1;
166         libusb_get_configuration(dev, &current_configuration);
167         if (current_configuration != KINECT_AUDIO_CONFIGURATION)
168                 libusb_set_configuration(dev, KINECT_AUDIO_CONFIGURATION);
169
170         libusb_claim_interface(dev, KINECT_AUDIO_INTERFACE);
171
172         current_configuration = -1;
173         libusb_get_configuration(dev, &current_configuration);
174         if (current_configuration != KINECT_AUDIO_CONFIGURATION) {
175                 res = -ENODEV;
176                 goto cleanup;
177         }
178
179         seq = 1;
180
181         bootloader_command cmd;
182         cmd.magic = fn_le32(0x06022009);
183         cmd.seq = fn_le32(seq);
184         cmd.bytes = fn_le32(0x60);
185         cmd.cmd = fn_le32(0);
186         cmd.write_addr = fn_le32(0x15);
187         cmd.unk = fn_le32(0);
188
189         LOG("About to send: ");
190         dump_bl_cmd(cmd);
191
192         int transferred = 0;
193
194         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
195         if (res != 0 || transferred != sizeof(cmd)) {
196                 LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
197                 goto cleanup;
198         }
199         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.
200         res = get_reply(); // I'm not sure why we do this twice here, but maybe it'll make sense later.
201         seq++;
202
203         // Split addr declaration and assignment in order to compile as C++,
204         // otherwise this would give "jump to label '...' crosses initialization"
205         // errors.
206         uint32_t addr;
207         addr = 0x00080000;
208         unsigned char page[0x4000];
209         int read;
210         do {
211                 read = fread(page, 1, 0x4000, fw);
212                 if (read <= 0) {
213                         break;
214                 }
215                 //LOG("");
216                 cmd.seq = fn_le32(seq);
217                 cmd.bytes = fn_le32(read);
218                 cmd.cmd = fn_le32(0x03);
219                 cmd.write_addr = fn_le32(addr);
220                 LOG("About to send: ");
221                 dump_bl_cmd(cmd);
222                 // Send it off!
223                 transferred = 0;
224                 res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
225                 if (res != 0 || transferred != sizeof(cmd)) {
226                         LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
227                         goto cleanup;
228                 }
229                 int bytes_sent = 0;
230                 while (bytes_sent < read) {
231                         int to_send = (read - bytes_sent > 512 ? 512 : read - bytes_sent);
232                         transferred = 0;
233                         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, &page[bytes_sent], to_send, &transferred, 0);
234                         if (res != 0 || transferred != to_send) {
235                                 LOG("Error: res: %d\ttransferred: %d (expected %d)\n", res, transferred, to_send);
236                                 goto cleanup;
237                         }
238                         bytes_sent += to_send;
239                 }
240                 res = get_reply();
241
242                 addr += (uint32_t)read;
243                 seq++;
244         } while (read > 0);
245
246         cmd.seq = fn_le32(seq);
247         cmd.bytes = fn_le32(0);
248         cmd.cmd = fn_le32(0x04);
249         cmd.write_addr = fn_le32(0x00080030);
250         dump_bl_cmd(cmd);
251         transferred = 0;
252         res = libusb_bulk_transfer(dev, KINECT_AUDIO_OUT_EP, (unsigned char*)&cmd, sizeof(cmd), &transferred, 0);
253         if (res != 0 || transferred != sizeof(cmd)) {
254                 LOG("Error: res: %d\ttransferred: %d (expected %zu)\n", res, transferred, sizeof(cmd));
255                 goto cleanup;
256         }
257         res = get_reply();
258         seq++;
259         // Now the device reenumerates.
260
261 cleanup:
262         libusb_release_interface(dev, KINECT_AUDIO_INTERFACE);
263         libusb_close(dev);
264 fail_libusb_open:
265         libusb_exit(NULL);
266         fclose(fw);
267         return res;
268 }