summaryrefslogtreecommitdiffstats
path: root/sahara.h
blob: b4b0e7b6c51876d92db84facc104e76e36827667 (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
/*
 * Copyright (C) 2017 Wolfgang Wiedmeyer <wolfgit@wiedmeyer.de>
 *
 * 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/>.
 */

#ifndef __SAHARA_PROTOCOL_H__
#define __SAHARA_PROTOCOL_H__

/* 
 * Most of these details of the SAHARA protocol were retrieved from the
 * libopenpst library (https://github.com/openpst/libopenpst).
 */

//modes
#define SAH_MODE_TRANSFER_PENDING  0x00
#define SAH_MODE_TRANSFER_COMPLETE 0x01
#define SAH_MODE_MEMORY_DEBUG      0x02

// commands
#define SAH_COMMAND_HELLO_REQ        0x01
#define SAH_COMMAND_HELLO_RESP       0x02
#define SAH_COMMAND_DATA_REQ         0x03
#define SAH_COMMAND_DATA_END_REQ     0x04
#define SAH_COMMAND_DATA_END_RESP    0x05
#define SAH_COMMAND_DATA_END_ACK     0x06
#define SAH_COMMAND_RESET_REQ        0x07
#define SAH_COMMAND_RESET_RESP       0x08
#define SAH_COMMAND_MEMORY_DEBUG_REQ 0x09
#define SAH_COMMAND_MEMORY_READ_REQ  0x0A

struct sah_header {
	unsigned int command;
	unsigned int packet_size;
} __attribute__((__packed__));

struct sah_hello_req {
	unsigned int version;
	unsigned int min_version;
	unsigned int not_needed;
	unsigned int mode;
	unsigned int appended[6];
} __attribute__((__packed__));

struct sah_hello_resp {
	struct sah_header header;
	unsigned int version;
	unsigned int min_version;
	unsigned int status;
	unsigned int mode;
	unsigned int appended[6];
} __attribute__((__packed__));

struct sah_data_req {
	unsigned int id;
	unsigned int offset;
	unsigned int size;
} __attribute__((__packed__));

struct sah_data_end_req {
	unsigned int id;
	unsigned int status;
} __attribute__((__packed__));

struct sah_data_end_ack {
	struct sah_header header;
	unsigned int status; // 0 more file requests to come, 1 complete
} __attribute__((__packed__));

struct sah_memory_debug_req {
	unsigned int address;
	unsigned int size;
} __attribute__((__packed__));

struct sah_memory_read_req {
	struct sah_header header;
	unsigned int address;
	unsigned int size;
} __attribute__((__packed__));

// response after a memory read request
struct sah_memory_table {
	unsigned int unknown;
	unsigned int address;
	unsigned int size;
	unsigned char empty[20];
	unsigned char file[20];
} __attribute__((__packed__));

int hello_response(int tty_fd, int mode);
int hello_handshake(int tty_fd, int mode);
int send_file(int tty_fd, struct sah_data_end_ack *data_end_ack);
int handle_memory_debug(int tty_fd);

#endif