summaryrefslogtreecommitdiffstats
path: root/heimdall/source/Interface.cpp
blob: ec66480bdc9194a28aad30ae0cff8ba5b1a2776d (plain) (blame)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/* Copyright (c) 2010-2012 Benjamin Dobell, Glass Echidna
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.*/

// C/C++ Standard Library
#include <cstdarg>
#include <cstdlib>
#include <stdio.h>

// Heimdall
#include "ClosePcScreenAction.h"
#include "DetectAction.h"
#include "DownloadPitAction.h"
#include "DumpAction.h"
#include "FlashAction.h"
#include "HelpAction.h"
#include "InfoAction.h"
#include "Heimdall.h"
#include "Interface.h"
#include "PrintPitAction.h"
#include "VersionAction.h"

using namespace std;
using namespace libpit;
using namespace Heimdall;

map<string, Interface::ActionInfo> actionMap;
bool stdoutErrors = false;
		
const char *version = "v1.4 RC2";
const char *actionUsage = "Usage: heimdall <action> <action arguments>\n";

const char *releaseInfo = "Heimdall %s\n\n\
Copyright (c) 2010-2012, Benjamin Dobell, Glass Echidna\n\
http://www.glassechidna.com.au/\n\n\
This software is provided free of charge. Copying and redistribution is\nencouraged.\n\n\
If you appreciate this software and you would like to support future\ndevelopment please consider donating:\n\
http://www.glassechidna.com.au/donate/\n\n";

static const char *extraInfo = "Heimdall utilises libusb-1.0 for all USB communication:\n\
    http://www.libusb.org/\n\
\n\
libusb-1.0 is licensed under the LGPL-2.1:\n\
    http://www.gnu.org/licenses/licenses.html#LGPL\n\n";

void populateActionMap(void)
{
	actionMap["close-pc-screen"] = Interface::ActionInfo(&ClosePcScreenAction::Execute, ClosePcScreenAction::usage);
	actionMap["detect"] = Interface::ActionInfo(&DetectAction::Execute, DetectAction::usage);
	actionMap["download-pit"] = Interface::ActionInfo(&DownloadPitAction::Execute, DownloadPitAction::usage);
	actionMap["dump"] = Interface::ActionInfo(&DumpAction::Execute, DumpAction::usage);
	actionMap["flash"] = Interface::ActionInfo(&FlashAction::Execute, FlashAction::usage);
	actionMap["help"] = Interface::ActionInfo(&HelpAction::Execute, HelpAction::usage);
	actionMap["info"] = Interface::ActionInfo(&InfoAction::Execute, InfoAction::usage);
	actionMap["print-pit"] = Interface::ActionInfo(&PrintPitAction::Execute, PrintPitAction::usage);
	actionMap["version"] = Interface::ActionInfo(&VersionAction::Execute, VersionAction::usage);
}

const map<string, Interface::ActionInfo>& Interface::GetActionMap(void)
{
	if (actionMap.size() == 0)
		populateActionMap();

	return actionMap;
}

void Interface::Print(const char *format, ...)
{
	va_list args;
	va_start(args, format);

	vfprintf(stdout, format, args);
	fflush(stdout);

	va_end(args);
	
}

void Interface::PrintWarning(const char *format, ...)
{
	va_list args;
	va_start(args, format);

	fprintf(stderr, "WARNING: ");
	vfprintf(stderr, format, args);
	fflush(stderr);

	if (stdoutErrors)
	{
		fprintf(stdout, "WARNING: ");
		vfprintf(stdout, format, args);
		fflush(stdout);
	}

	va_end(args);
}

void Interface::PrintWarningSameLine(const char *format, ...)
{
	va_list args;
	va_start(args, format);

	vfprintf(stderr, format, args);
	fflush(stderr);

	if (stdoutErrors)
	{
		vfprintf(stdout, format, args);
		fflush(stdout);
	}

	va_end(args);
}

void Interface::PrintError(const char *format, ...)
{
	va_list args;
	va_start(args, format);

	fprintf(stderr, "ERROR: ");
	vfprintf(stderr, format, args);
	fflush(stderr);

	if (stdoutErrors)
	{
		fprintf(stdout, "ERROR: ");
		vfprintf(stdout, format, args);
		fflush(stdout);
	}

	va_end(args);
}

void Interface::PrintErrorSameLine(const char *format, ...)
{
	va_list args;
	va_start(args, format);

	vfprintf(stderr, format, args);
	fflush(stderr);

	if (stdoutErrors)
	{
		vfprintf(stdout, format, args);
		fflush(stdout);
	}

	va_end(args);
}

void Interface::PrintVersion(void)
{
	Interface::Print("%s\n", version);
}

void Interface::PrintUsage(void)
{
	const map<string, ActionInfo>& actionMap = Interface::GetActionMap();

	Interface::Print(actionUsage);

	for (map<string, ActionInfo>::const_iterator it = actionMap.begin(); it != actionMap.end(); it++)
		Interface::Print("\n%s", it->second.usage);
}

void Interface::PrintReleaseInfo(void)
{
	Interface::Print(releaseInfo, version);
}

void Interface::PrintFullInfo(void)
{
	Interface::Print(releaseInfo, version);
	Interface::Print(extraInfo);
}

void Interface::PrintDeviceDetectionFailed(void)
{
	Interface::PrintError("Failed to detect compatible download-mode device.\n");
}

void Interface::PrintPit(const PitData *pitData)
{
	Interface::Print("Entry Count: %d\n", pitData->GetEntryCount());

	Interface::Print("Unknown 1: %d\n", pitData->GetUnknown1());
	Interface::Print("Unknown 2: %d\n", pitData->GetUnknown2());
	Interface::Print("Unknown 3: %d\n", pitData->GetUnknown3());
	Interface::Print("Unknown 4: %d\n", pitData->GetUnknown4());
	Interface::Print("Unknown 5: %d\n", pitData->GetUnknown5());
	Interface::Print("Unknown 6: %d\n", pitData->GetUnknown6());
	Interface::Print("Unknown 7: %d\n", pitData->GetUnknown7());
	Interface::Print("Unknown 8: %d\n", pitData->GetUnknown8());

	for (unsigned int i = 0; i < pitData->GetEntryCount(); i++)
	{
		const PitEntry *entry = pitData->GetEntry(i);

		Interface::Print("\n\n--- Entry #%d ---\n", i);
		Interface::Print("Binary Type: %d (", entry->GetBinaryType());

		switch (entry->GetBinaryType())
		{
			case PitEntry::kBinaryTypeApplicationProcessor:
				Interface::Print("AP");
				break;

			case PitEntry::kBinaryTypeCommunicationProcessor:
				Interface::Print("CP");
				break;

			default:
				Interface::Print("Unknown");
				break;
		}

		Interface::Print(")\n");

		Interface::Print("Device Type: %d (", entry->GetDeviceType());

		switch (entry->GetDeviceType())
		{
			case PitEntry::kDeviceTypeOneNand:
				Interface::Print("OneNAND");
				break;

			case PitEntry::kDeviceTypeFile:
				Interface::Print("File/FAT");
				break;

			case PitEntry::kDeviceTypeMMC:
				Interface::Print("MMC");
				break;

			case PitEntry::kDeviceTypeAll:
				Interface::Print("All (?)");
				break;

			default:
				Interface::Print("Unknown");
				break;
		}

		Interface::Print(")\n");

		Interface::Print("Identifier: %d\n", entry->GetIdentifier());

		Interface::Print("Attributes: %d (", entry->GetAttributes());

		if (entry->GetAttributes() & PitEntry::kAttributeSTL)
			Interface::Print("STL ");

		if (entry->GetAttributes() & PitEntry::kAttributeWrite)
			Interface::Print("Read/Write");
		else
			Interface::Print("Read-Only");

		Interface::Print(")\n");

		Interface::Print("Update Attributes: %d", entry->GetUpdateAttributes());

		if (entry->GetUpdateAttributes())
		{
			Interface::Print(" (");

			if (entry->GetUpdateAttributes() & PitEntry::kUpdateAttributeFota)
			{
				if (entry->GetUpdateAttributes() & PitEntry::kUpdateAttributeSecure)
					Interface::Print("FOTA, Secure");
				else
					Interface::Print("FOTA");
			}
			else
			{
				if (entry->GetUpdateAttributes() & PitEntry::kUpdateAttributeSecure)
					Interface::Print("Secure");
			}

			Interface::Print(")\n");
		}
		else
		{
			Interface::Print("\n");
		}

		Interface::Print("Partition Block Size/Offset: %d\n", entry->GetBlockSizeOrOffset());
		Interface::Print("Partition Block Count: %d\n", entry->GetBlockCount());

		Interface::Print("File Offset (Obsolete): %d\n", entry->GetFileOffset());
		Interface::Print("File Size (Obsolete): %d\n", entry->GetFileSize());

		Interface::Print("Partition Name: %s\n", entry->GetPartitionName());
		Interface::Print("Flash Filename: %s\n", entry->GetFlashFilename());
		Interface::Print("FOTA Filename: %s\n", entry->GetFotaFilename());
	}

	Interface::Print("\n");
}

void Interface::SetStdoutErrors(bool enabled)
{
	stdoutErrors = enabled;
}