summaryrefslogtreecommitdiff
path: root/libthor/thor.h
blob: e45c7a04b83828506111c8c4bf2b3b25cfbdccfb (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
/*
 * libthor - Tizen Thor communication protocol
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef THOR_H__
#define THOR_H__

#include <sys/types.h>
#include <stdio.h>
#include <stddef.h>

struct usb_device_id {
	const char *busid;
	int vid;
	int pid;
	const char *serial;
};

#define THOR_NET_PORT (23456)

struct net_device_id {
	const char *ip_addr;
	int port;
};

struct thor_device_id {
	struct usb_device_id usb_dev;
	struct net_device_id net_dev;
};

struct thor_device_handle;
typedef struct thor_device_handle thor_device_handle;

enum thor_data_type {
	THOR_NORMAL_DATA = 0,
	THOR_PIT_DATA,
};

struct thor_data_src_entry {
	char *name;
	off_t size;
};

struct thor_data_src {
	off_t (*get_file_length)(struct thor_data_src *src);
	off_t (*get_size)(struct thor_data_src *src);
	off_t (*get_block)(struct thor_data_src *src, void *data, off_t len);
	const char* (*get_name)(struct thor_data_src *src);
	int (*next_file)(struct thor_data_src *src);
	struct thor_data_src_entry **(*get_entries)(struct thor_data_src *src);
	void (*release)(struct thor_data_src *src);
};

enum thor_data_src_format {
	THOR_FORMAT_RAW = 0,
	THOR_FORMAT_TAR,
};

typedef void (*thor_progress_cb)(thor_device_handle *th,
				 struct thor_data_src *data,
				 off_t sent, off_t left,
				 int chunk_nmb, void *user_data);

typedef void (*thor_next_entry_cb)(thor_device_handle *th,
				 struct thor_data_src *data,
				 void *user_data);

enum thor_transport_type {
	THOR_TRANSPORT_USB = 0,
	THOR_TRANSPORT_NET,
	THOR_TRANSPORT_MAX,
};

/* Init the Thor library */
thor_device_handle *thor_init(enum thor_transport_type type);

/* Cleanup the thor library */
void thor_cleanup(thor_device_handle *th);

/* Open the device and prepare it for thor communication */
int thor_open(thor_device_handle *th, struct thor_device_id *dev_id, int wait);

/* Close the device */
void thor_close(thor_device_handle *th);

/* Get protocol version of the device */
int thor_get_proto_ver(thor_device_handle *th);

/* Start thor "session" */
int thor_start_session(thor_device_handle *th, off_t total);

/* Send a butch of data to the target */
int thor_send_data(thor_device_handle *th, struct thor_data_src *data,
		   enum thor_data_type type, thor_progress_cb report_progress,
		   void *user_data, thor_next_entry_cb report_next_entry,
		   void *ne_cb_data);

/* End the session */
int thor_end_session(thor_device_handle *th);

/* Open a standard file or archive as data source for thor */
int thor_get_data_src(const char *path, enum thor_data_src_format format,
		      struct thor_data_src **data);

/* Release data source */
void thor_release_data_src(struct thor_data_src *data);

/* Request target reboot */
int thor_reboot(thor_device_handle *th);

#endif /* THOR_H__ */