mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-11-13 19:18:56 +00:00
bootloader: parse incoming protobuf messages
This commit is contained in:
Pavol Rusnak
parent
fe672fbd09
commit
46c26b8c09
3
.gitignore
vendored
3
.gitignore
vendored
@ -2,4 +2,5 @@
|
||||
_attic/
|
||||
vendor/src/
|
||||
emu.config
|
||||
__pycache__
|
||||
__pycache__/
|
||||
.mypy_cache/
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
#include <pb_decode.h>
|
||||
#include <pb_encode.h>
|
||||
#include "messages.pb.h"
|
||||
|
||||
@ -6,8 +7,6 @@
|
||||
|
||||
#include "messages.h"
|
||||
|
||||
// DECODE
|
||||
|
||||
bool msg_parse_header(const uint8_t *buf, uint16_t *msg_id, uint32_t *msg_size)
|
||||
{
|
||||
if (buf[0] != '?' || buf[1] != '#' || buf[2] != '#') {
|
||||
@ -18,8 +17,6 @@ bool msg_parse_header(const uint8_t *buf, uint16_t *msg_id, uint32_t *msg_size)
|
||||
return true;
|
||||
}
|
||||
|
||||
// ENCODE
|
||||
|
||||
typedef struct {
|
||||
uint8_t iface_num;
|
||||
uint8_t packet_index;
|
||||
@ -60,7 +57,7 @@ static bool _usb_write(pb_ostream_t *stream, const pb_byte_t *buf, size_t count)
|
||||
return true;
|
||||
}
|
||||
|
||||
static void _usb_flush(usb_write_state *state)
|
||||
static void _usb_write_flush(usb_write_state *state)
|
||||
{
|
||||
// if packet is not filled up completely
|
||||
if (state->packet_pos < USB_PACKET_SIZE) {
|
||||
@ -108,7 +105,7 @@ static bool _send_msg(uint8_t iface_num, uint16_t msg_id, const pb_field_t field
|
||||
return false;
|
||||
}
|
||||
|
||||
_usb_flush(&state);
|
||||
_usb_write_flush(&state);
|
||||
|
||||
return true;
|
||||
}
|
||||
@ -121,81 +118,147 @@ static bool _encode_string(pb_ostream_t *stream, const pb_field_t *field, void *
|
||||
return pb_encode_string(stream, *arg, strlen(*arg));
|
||||
}
|
||||
|
||||
#define MSG_INIT(TYPE) TYPE msg = TYPE##_init_default
|
||||
#define MSG_ASSIGN_VALUE(FIELD, VALUE) do { msg.has_##FIELD = true; msg.FIELD = VALUE; } while (0)
|
||||
#define MSG_ASSIGN_STRING(FIELD, VALUE) do { msg.FIELD.funcs.encode = &_encode_string; msg.FIELD.arg = VALUE; } while (0)
|
||||
#define MSG_SEND(TYPE) do { _send_msg(iface_num, MessageType_MessageType_##TYPE, TYPE##_fields, &msg); } while (0)
|
||||
#define MSG_SEND_INIT(TYPE) TYPE msg_send = TYPE##_init_default
|
||||
#define MSG_SEND_ASSIGN_VALUE(FIELD, VALUE) do { msg_send.has_##FIELD = true; msg_send.FIELD = VALUE; } while (0)
|
||||
#define MSG_SEND_ASSIGN_STRING(FIELD, VALUE) do { msg_send.FIELD.funcs.encode = &_encode_string; msg_send.FIELD.arg = VALUE; } while (0)
|
||||
#define MSG_SEND(TYPE) do { _send_msg(iface_num, MessageType_MessageType_##TYPE, TYPE##_fields, &msg_send); } while (0)
|
||||
|
||||
static void consume_message(uint8_t iface_num, uint32_t msg_size, uint8_t *buf, void (* consumer)(const uint8_t *buf, uint8_t len))
|
||||
typedef struct {
|
||||
uint8_t iface_num;
|
||||
uint8_t packet_index;
|
||||
uint8_t packet_pos;
|
||||
uint8_t *buf;
|
||||
} usb_read_state;
|
||||
|
||||
static bool _usb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
|
||||
{
|
||||
if (consumer) {
|
||||
consumer(buf + MSG_HEADER1_LEN, USB_PACKET_SIZE - MSG_HEADER1_LEN);
|
||||
usb_read_state *state = (usb_read_state *)(stream->state);
|
||||
|
||||
size_t read = 0;
|
||||
// while we have data left
|
||||
while (read < count) {
|
||||
size_t remaining = count - read;
|
||||
// if all remaining data fit into our packet
|
||||
if (state->packet_pos + remaining <= USB_PACKET_SIZE) {
|
||||
// append data from buf to state->buf
|
||||
memcpy(buf + read, state->buf + state->packet_pos, remaining);
|
||||
// advance position
|
||||
state->packet_pos += remaining;
|
||||
// and return
|
||||
return true;
|
||||
} else {
|
||||
// append data that fits
|
||||
memcpy(buf + read, state->buf + state->packet_pos, USB_PACKET_SIZE - state->packet_pos);
|
||||
read += USB_PACKET_SIZE - state->packet_pos;
|
||||
// read next packet
|
||||
usb_hid_write_blocking(state->iface_num, state->buf, USB_PACKET_SIZE, 1);
|
||||
// prepare next packet
|
||||
state->packet_index++;
|
||||
state->packet_pos = MSG_HEADER2_LEN;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
static void _usb_read_flush(usb_read_state *state)
|
||||
{
|
||||
(void)state;
|
||||
}
|
||||
|
||||
static bool _recv_msg(uint8_t iface_num, uint32_t msg_size, uint8_t *buf, const pb_field_t fields[], void *msg)
|
||||
{
|
||||
usb_read_state state = {
|
||||
.iface_num = iface_num,
|
||||
.packet_index = 0,
|
||||
.packet_pos = MSG_HEADER1_LEN,
|
||||
.buf = buf
|
||||
};
|
||||
|
||||
pb_istream_t stream = {
|
||||
.callback = &_usb_read,
|
||||
.state = &state,
|
||||
.bytes_left = msg_size,
|
||||
.errmsg = NULL
|
||||
};
|
||||
|
||||
if (!pb_decode(&stream, fields, msg)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
_usb_read_flush(&state);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
#define MSG_RECV_INIT(TYPE) TYPE msg_recv = TYPE##_init_zero
|
||||
#define MSG_RECV(TYPE) do { _recv_msg(iface_num, msg_size, buf, TYPE##_fields, &msg_recv); } while(0)
|
||||
|
||||
void process_msg_Initialize(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
MSG_RECV_INIT(Initialize);
|
||||
MSG_RECV(Initialize);
|
||||
|
||||
MSG_SEND_INIT(Features);
|
||||
MSG_SEND_ASSIGN_STRING(vendor, "trezor.io");
|
||||
MSG_SEND_ASSIGN_VALUE(major_version, VERSION_MAJOR);
|
||||
MSG_SEND_ASSIGN_VALUE(minor_version, VERSION_MINOR);
|
||||
MSG_SEND_ASSIGN_VALUE(patch_version, VERSION_PATCH);
|
||||
MSG_SEND_ASSIGN_VALUE(bootloader_mode, true);
|
||||
// TODO: properly detect firmware
|
||||
MSG_SEND_ASSIGN_VALUE(firmware_present, false);
|
||||
MSG_SEND(Features);
|
||||
}
|
||||
|
||||
|
||||
void process_msg_Ping(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
MSG_RECV_INIT(Ping);
|
||||
MSG_RECV(Ping);
|
||||
|
||||
MSG_SEND_INIT(Success);
|
||||
// TODO: read message from Ping
|
||||
MSG_SEND_ASSIGN_STRING(message, "PONG!");
|
||||
MSG_SEND(Success);
|
||||
}
|
||||
|
||||
void process_msg_FirmwareErase(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
MSG_RECV_INIT(FirmwareErase);
|
||||
MSG_RECV(FirmwareErase);
|
||||
|
||||
// TODO: implement
|
||||
MSG_SEND_INIT(Failure);
|
||||
MSG_SEND_ASSIGN_VALUE(code, FailureType_Failure_FirmwareError);
|
||||
MSG_SEND_ASSIGN_STRING(message, "Unsupported message");
|
||||
MSG_SEND(Failure);
|
||||
}
|
||||
|
||||
void process_msg_FirmwareUpload(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
MSG_RECV_INIT(FirmwareUpload);
|
||||
MSG_RECV(FirmwareUpload);
|
||||
|
||||
// TODO: implement
|
||||
MSG_SEND_INIT(Failure);
|
||||
MSG_SEND_ASSIGN_VALUE(code, FailureType_Failure_FirmwareError);
|
||||
MSG_SEND_ASSIGN_STRING(message, "Unsupported message");
|
||||
MSG_SEND(Failure);
|
||||
}
|
||||
|
||||
void process_msg_unknown(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
// consume remaining message
|
||||
int remaining_chunks = (msg_size - (USB_PACKET_SIZE - MSG_HEADER1_LEN)) / (USB_PACKET_SIZE - MSG_HEADER2_LEN);
|
||||
for (int i = 0; i < remaining_chunks; i++) {
|
||||
int r = usb_hid_read_blocking(USB_IFACE_NUM, buf, USB_PACKET_SIZE, 100);
|
||||
if (r != USB_PACKET_SIZE) {
|
||||
break;
|
||||
}
|
||||
if (consumer) {
|
||||
consumer(buf + MSG_HEADER2_LEN, USB_PACKET_SIZE - MSG_HEADER2_LEN);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void process_msg_Initialize(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
consume_message(iface_num, msg_size, buf, NULL);
|
||||
|
||||
MSG_INIT(Features);
|
||||
MSG_ASSIGN_STRING(vendor, "trezor.io");
|
||||
MSG_ASSIGN_VALUE(major_version, VERSION_MAJOR);
|
||||
MSG_ASSIGN_VALUE(minor_version, VERSION_MINOR);
|
||||
MSG_ASSIGN_VALUE(patch_version, VERSION_PATCH);
|
||||
MSG_ASSIGN_VALUE(bootloader_mode, true);
|
||||
// TODO: properly detect firmware
|
||||
MSG_ASSIGN_VALUE(firmware_present, false);
|
||||
MSG_SEND(Features);
|
||||
}
|
||||
|
||||
void process_msg_Ping(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
consume_message(iface_num, msg_size, buf, NULL);
|
||||
|
||||
MSG_INIT(Success);
|
||||
// TODO: read message from Ping
|
||||
MSG_ASSIGN_STRING(message, "PONG!");
|
||||
MSG_SEND(Success);
|
||||
}
|
||||
|
||||
void process_msg_FirmwareErase(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
consume_message(iface_num, msg_size, buf, NULL);
|
||||
|
||||
// TODO: implement
|
||||
MSG_INIT(Failure);
|
||||
MSG_ASSIGN_VALUE(code, FailureType_Failure_FirmwareError);
|
||||
MSG_ASSIGN_STRING(message, "Unsupported message");
|
||||
MSG_SEND(Failure);
|
||||
}
|
||||
|
||||
void process_msg_FirmwareUpload(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
consume_message(iface_num, msg_size, buf, NULL);
|
||||
|
||||
// TODO: implement
|
||||
MSG_INIT(Failure);
|
||||
MSG_ASSIGN_VALUE(code, FailureType_Failure_FirmwareError);
|
||||
MSG_ASSIGN_STRING(message, "Unsupported message");
|
||||
MSG_SEND(Failure);
|
||||
}
|
||||
|
||||
void process_msg_unknown(uint8_t iface_num, uint32_t msg_size, uint8_t *buf)
|
||||
{
|
||||
consume_message(iface_num, msg_size, buf, NULL);
|
||||
|
||||
MSG_INIT(Failure);
|
||||
MSG_ASSIGN_VALUE(code, FailureType_Failure_UnexpectedMessage);
|
||||
MSG_ASSIGN_STRING(message, "Unexpected message");
|
||||
MSG_SEND_INIT(Failure);
|
||||
MSG_SEND_ASSIGN_VALUE(code, FailureType_Failure_UnexpectedMessage);
|
||||
MSG_SEND_ASSIGN_STRING(message, "Unexpected message");
|
||||
MSG_SEND(Failure);
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user