aboutsummaryrefslogtreecommitdiffstats
path: root/halfkay.c
blob: 2b69f9e2dd0bd90246e70f75b362cd6d74e4aca0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 * halfkay.c -- HalfKay protocol implementation
 * Based on Teensy Loader (cli) (http://www.pjrc.com/teensy/loader_cli.html)
 *
 * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#define _DEFAULT_SOURCE
#include <assert.h>
#include <errno.h>
#include <libusb-1.0/libusb.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "halfkay.h"
#include "eprintf.h"

enum {
	HK_USB_VID = 0x16c0,
	HK_USB_PID = 0x0478,
	HK_USB_REQTYP = (LIBUSB_ENDPOINT_OUT \
			 | LIBUSB_REQUEST_TYPE_CLASS \
			 | LIBUSB_RECIPIENT_INTERFACE),
	HK_USB_REQ = LIBUSB_REQUEST_SET_CONFIGURATION,
	HK_USB_VAL = 0x200,
	TIMEOUT = 2000,
	TIMEOUT_FIRST = 3000,
	SEND_DELAY = 4000,
	SEND_ATTEMPTS = 10,
	REBOOTCMD_WIDTH = 3,
	REBOOTCMD_FILL = 0xff,
};

libusb_device_handle *hk_usb_hnd;

static inline void libusb_err(const char *action, int code)
{
	eprintf("libusb %s failed: %s", action, libusb_strerror(code));
}

static void usbopen(void)
{
	int rc;

	if (hk_usb_hnd != NULL)
		return;

	rc = libusb_init(NULL);
	if (libusb_init(NULL) != LIBUSB_SUCCESS)
		libusb_err("init", rc);

	hk_usb_hnd = libusb_open_device_with_vid_pid(NULL, HK_USB_VID, HK_USB_PID);
	if (!hk_usb_hnd)
		eprintf("HalfKay device not found");

	libusb_set_auto_detach_kernel_driver(hk_usb_hnd, 1);
	rc = libusb_claim_interface(hk_usb_hnd, 0);
	if (rc < 0)
		libusb_err("claim", rc);
}

static void usbclose(void)
{
	if (hk_usb_hnd == NULL)
		return;

	libusb_release_interface(hk_usb_hnd, 0);
	libusb_close(hk_usb_hnd);
	libusb_exit(NULL);

	hk_usb_hnd = NULL;
}

/* TODO: move somewhere or consider a cleaner replacement */
/* udelay: usleep replacement */
static void udelay(unsigned long usec)
{
	enum { USECSEC = 1000000, NSECUSEC = 1000, };
	struct timespec ts = {
		.tv_sec = usec / USECSEC,
		.tv_nsec = usec % USECSEC * NSECUSEC,
	};
	/* If we get interrupted, oh well */
	nanosleep(&ts, NULL);
}

static void usbsendcmd(void *data, size_t size, bool firstxfer)
{
	unsigned int timeout = firstxfer ? TIMEOUT_FIRST : TIMEOUT;
	int rc, attempt = 0;
	unsigned long delay = SEND_DELAY;

	_Static_assert(SEND_DELAY << SEND_ATTEMPTS <= (1UL << 32) - 1,
		       "SEND_DELAY << SEND_ATTEMPTS > 2^32 - 1");

	do {
		rc = libusb_control_transfer(hk_usb_hnd, HK_USB_REQTYP, HK_USB_REQ,
					     HK_USB_VAL, 0, data, size, timeout);
		udelay(delay);
		delay *= 2;
	} while (rc == LIBUSB_ERROR_PIPE && ++attempt < SEND_ATTEMPTS);

	if (rc < 0)
		libusb_err("transfer", rc);
}

static void fmtcmd(void *_dest, const struct flashparams *fp, size_t addr)
{
	static const size_t MAX_SHIFT = sizeof addr * CHAR_BIT / 8;
	unsigned char *dest = _dest;

	assert(dest);
	assert(fp);

	addr >>= fp->addrshft;
	for (size_t i = 0; i < fp->cmdsz && i < MAX_SHIFT; i++)
		dest[i] = (addr >> (i * 8)) & 0xFF;
}

int flash(const struct flashparams *fp, const char *file)
{
	FILE *f;
	unsigned char *cmd;
	size_t tsize;

	assert(fp);
	assert(fp->blksz && (fp->blksz & (fp->blksz - 1)) == 0);
	assert(fp->memsz % fp->blksz == 0);
	assert(SIZE_MAX - fp->blksz >= fp->cmdsz);
	assert(file);

	f = fopen(file, "rb");
	if (!f)
		eprintf("Could not open '%s':", file);

	tsize = fp->blksz + fp->cmdsz;
	cmd = emalloc(tsize);

	usbopen();

	for (size_t blkaddr = 0; blkaddr < fp->memsz; blkaddr += fp->blksz) {
		size_t count;

		fmtcmd(cmd, fp, blkaddr);
		count = fread(cmd + fp->cmdsz, 1, fp->blksz, f);
		if (count != fp->blksz && ferror(f))
			eprintf("Error while reading '%s', short read", file);
		if (count == 0)
			break;
		if (count < fp->blksz)
			memset(cmd + fp->cmdsz + count, 0, fp->blksz - count);

		usbsendcmd(cmd, tsize, blkaddr == 0);
	}

	if (!feof(f))
		weprintf("Device ran out of space during writing!");

	usbclose();

	free(cmd);
	fclose(f);

	return 0;
}

int reboot(const struct flashparams *fp)
{
	size_t tsize;
	unsigned char *cmd;

	assert(fp);
	assert(fp->blksz && (fp->blksz & (fp->blksz - 1)) == 0);
	assert(fp->memsz % fp->blksz == 0);
	assert(SIZE_MAX - fp->blksz >= fp->cmdsz);

	tsize = fp->blksz + fp->cmdsz;
	cmd = ecalloc(tsize, 1);

	memset(cmd, REBOOTCMD_FILL, REBOOTCMD_WIDTH);

	usbopen();
	usbsendcmd(cmd, tsize, true);
	usbclose();

	free(cmd);

	return 0;
}