1 /*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Uwe Hermann <[email protected]>
5 * Copyright (C) 2009 Carl-Daniel Hailfinger
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 */
17
18 #include <stdio.h>
19 #include <string.h>
20 #include <stdlib.h>
21 #include <time.h>
22 #include "flash.h"
23 #include "flashchips.h"
24 #include "programmer.h"
25
26 static const char wiki_header[] = "= Supported devices =\n\n\
27 <div style=\"margin-top:0.5em; padding:0.5em 0.5em 0.5em 0.5em; \
28 background-color:#eeeeee; text-align:left; border:1px solid #aabbcc;\">\
29 <small>\n\
30 '''Last update:''' %s (generated by flashrom %s)<br />\n\
31 The tables below are generated from flashrom's source by copying the output of '''flashrom -z'''.<br /><br />\n\
32 A short explanation of the cells representing the support state follows:<br />\n\
33 {| border=\"0\" valign=\"top\"\n\
34 ! style=\"text-align:left;\" |\n\
35 ! style=\"text-align:left;\" |\n\
36 |-\n\
37 |{{OK}}\n\
38 | The feature was '''tested and should work''' in general unless there is a bug in flashrom or another component in \
39 the system prohibits some functionality.\n\
40 |-\n\
41 |{{Dep}}\n\
42 | '''Configuration-dependent'''. The feature was tested and should work in general but there are common \
43 configurations that drastically limit flashrom's capabilities or make it completely stop working.\n\
44 |-\n\
45 |{{?3}}\n\
46 | The feature is '''untested''' but believed to be working.\n\
47 |-\n\
48 |{{NA}}\n\
49 | The feature is '''not applicable''' in this configuration (e.g. write operations on ROM chips).\n\
50 |-\n\
51 |{{No}}\n\
52 | The feature is '''known to not work'''. Don't bother testing (nor reporting. Patches welcome! ;).\n\
53 |}\n\
54 </small></div>\n";
55
56 static const char th_start[] = "| valign=\"top\"|\n\n\
57 {| border=\"0\" style=\"font-size: smaller\" valign=\"top\"\n\
58 |- bgcolor=\"#6699dd\"\n";
59
60 #if CONFIG_INTERNAL == 1
61 static const char chipset_th[] = "\
62 ! align=\"left\" | Vendor\n\
63 ! align=\"left\" | Southbridge\n\
64 ! align=\"center\" | PCI IDs\n\
65 ! align=\"center\" | Status\n\n";
66
67 static const char board_th[] = "\
68 ! align=\"left\" | Vendor\n\
69 ! align=\"left\" | Mainboard\n\
70 ! align=\"left\" | Required option\n\
71 ! align=\"center\" | Status\n\n";
72
73 static const char board_intro[] = "\
74 \n== Supported mainboards ==\n\n\
75 In general, it is very likely that flashrom works out of the box even if your \
76 mainboard is not listed below.\n\nThis is a list of mainboards where we have \
77 verified that they either do or do not need any special initialization to \
78 make flashrom work (given flashrom supports the respective chipset and flash \
79 chip), or that they do not yet work at all. If they do not work, support may \
80 or may not be added later.\n\n\
81 Mainboards (or individual revisions) which don't appear in the list may or may \
82 not work (we don't know, someone has to give it a try). Please report any \
83 further verified mainboards on the [[Contact#Mailing_List|mailing list]].\n";
84 #endif
85
86 static const char chip_th[] = "\
87 ! align=\"left\" | Vendor\n\
88 ! align=\"left\" | Device\n\
89 ! align=\"center\" | Size [kB]\n\
90 ! align=\"center\" | Type\n\
91 ! align=\"center\" colspan=\"4\" | Status\n\
92 ! align=\"center\" colspan=\"2\" | Voltage [V]\n\n\
93 |- bgcolor=\"#6699ff\"\n| colspan=\"4\" | \n\
94 | Probe\n| Read\n| Erase\n| Write\n\
95 | align=\"center\" | Min\n| align=\"center\" | Max\n\n";
96
97 static const char chip_intro[] = "\
98 \n== Supported flash chips ==\n\n\
99 The list below contains all chips that have some kind of explicit support added to flashrom and their last \
100 known test status. Newer SPI flash chips might work even without explicit support if they implement SFDP ([\
101 http://www.jedec.org/standards-documents/docs/jesd216 Serial Flash Discoverable Parameters - JESD216]). \
102 Flashrom will detect this automatically and inform you about it.\n\n\
103 The names used below are designed to be as concise as possible and hence contain only the characters \
104 describing properties that are relevant to flashrom. Irrelevant characters specify attributes flashrom can not \
105 use or even detect by itself (e.g. the physical package) and have no effect on flashrom's operation. They are \
106 replaced by dots ('.') functioning as wildcards (like in Regular Expressions) or are completely omitted at the \
107 end of a name.\n";
108
109 static const char programmer_th[] = "\
110 ! align=\"left\" | Programmer\n\
111 ! align=\"left\" | Vendor\n\
112 ! align=\"left\" | Device\n\
113 ! align=\"center\" | IDs\n\
114 ! align=\"center\" | Status\n\n";
115
116 /* The output of this module relies on MediaWiki templates to select special formatting styles for table cells
117 * reflecting the test status of the respective hardware. This functions returns the correct template name for
118 * the supplied enum test_state. */
test_state_to_template(enum test_state test_state)119 static const char *test_state_to_template(enum test_state test_state)
120 {
121 switch (test_state) {
122 case OK: return "OK";
123 case BAD: return "No";
124 case NA: return "NA";
125 case DEP: return "Dep";
126 case NT:
127 default: return "?3";
128 }
129 }
130
131 #if CONFIG_INTERNAL == 1
132 static const char laptop_intro[] = "\n== Supported mobile devices (laptops, tablets etc.) ==\n\n\
133 In general, flashing mobile devices is more difficult because they\n\n\
134 * often use the flash chip for stuff besides the BIOS,\n\
135 * often have special protection stuff which has to be handled by flashrom,\n\
136 * often use flash translation circuits which need drivers in flashrom.\n\n\
137 <div style=\"margin-top:0.5em; padding:0.5em 0.5em 0.5em 0.5em; \
138 background-color:#ff6666; align:right; border:1px solid #000000;\">\n\
139 '''IMPORTANT:''' At this point we recommend to '''not''' use flashrom on \
140 untested mobile devices unless you have a means to recover from a flashing that goes \
141 wrong (a working backup flash chip and/or good soldering skills).\n</div>\n";
142
print_supported_chipsets_wiki(int cols)143 static void print_supported_chipsets_wiki(int cols)
144 {
145 int i;
146 unsigned int lines_per_col;
147 const struct penable *e;
148 int enablescount = 0, color = 1;
149
150 for (e = chipset_enables; e->vendor_name != NULL; e++)
151 enablescount++;
152
153 /* +1 to force the resulting number of columns to be < cols */
154 lines_per_col = enablescount / cols + ((enablescount%cols) > 0 ? 1 : 0);
155
156 printf("\n== Supported chipsets ==\n\nTotal amount of supported chipsets: '''%d'''\n\n"
157 "{| border=\"0\" valign=\"top\"\n", enablescount);
158
159 e = chipset_enables;
160 for (i = 0; e[i].vendor_name != NULL; i++) {
161 if ((i % lines_per_col) == 0)
162 printf("%s%s", th_start, chipset_th);
163
164 /* Alternate colors if the vendor changes. */
165 if (i > 0 && strcmp(e[i].vendor_name, e[i - 1].vendor_name))
166 color = !color;
167
168 printf("|- bgcolor=\"#%s\"\n| %s || %s "
169 "|| %04x:%04x || {{%s}}\n", (color) ? "eeeeee" : "dddddd",
170 e[i].vendor_name, e[i].device_name,
171 e[i].vendor_id, e[i].device_id,
172 test_state_to_template(e[i].status));
173
174 if (((i % lines_per_col) + 1) == lines_per_col)
175 printf("\n|}\n\n");
176 }
177
178 /* end inner table if it did not fill the last column fully */
179 if (((i % lines_per_col)) > 0)
180 printf("\n|}\n\n");
181 printf("\n\n|}\n");
182 }
183
print_supported_boards_wiki_helper(const char * devicetype,int cols,const struct board_info boards[])184 static void print_supported_boards_wiki_helper(const char *devicetype, int cols, const struct board_info boards[])
185 {
186 int i, k;
187 unsigned int boardcount, lines_per_col;
188 unsigned int boardcount_good = 0, boardcount_bad = 0, boardcount_nt = 0;
189 int num_notes = 0, color = 1;
190 char *notes = calloc(1, 1);
191 char tmp[900 + 1];
192 const struct board_match *b = board_matches;
193
194 for (i = 0; boards[i].vendor != NULL; i++) {
195 if (boards[i].working == OK)
196 boardcount_good++;
197 else if (boards[i].working == NT)
198 boardcount_nt++;
199 else
200 boardcount_bad++;
201 }
202 boardcount = boardcount_good + boardcount_nt + boardcount_bad;
203
204 /* +1 to force the resulting number of columns to be < cols */
205 lines_per_col = boardcount / cols + ((boardcount%cols) > 0 ? 1 : 0);
206
207 printf("\n\nTotal amount of known good %s: '''%d'''; "
208 "Untested (e.g. user vanished before testing new code): '''%d'''; "
209 "Not yet supported (i.e. known-bad): '''%d'''.\n\n"
210 "{| border=\"0\" valign=\"top\"\n", devicetype, boardcount_good, boardcount_nt, boardcount_bad);
211
212 for (i = 0; boards[i].vendor != NULL; i++) {
213 if ((i % lines_per_col) == 0)
214 printf("%s%s", th_start, board_th);
215
216 /* Alternate colors if the vendor changes. */
217 if (i > 0 && strcmp(boards[i].vendor, boards[i - 1].vendor))
218 color = !color;
219
220 k = 0;
221 while ((b[k].vendor_name != NULL) &&
222 (strcmp(b[k].vendor_name, boards[i].vendor) ||
223 strcmp(b[k].board_name, boards[i].name))) {
224 k++;
225 }
226
227 printf("|- bgcolor=\"#%s\"\n| %s || %s%s %s%s || %s%s%s%s "
228 "|| {{%s}}", (color) ? "eeeeee" : "dddddd",
229 boards[i].vendor,
230 boards[i].url ? "[" : "",
231 boards[i].url ? boards[i].url : "",
232 boards[i].name,
233 boards[i].url ? "]" : "",
234 b[k].lb_vendor ? "-p internal:mainboard=" : "—",
235 b[k].lb_vendor ? b[k].lb_vendor : "",
236 b[k].lb_vendor ? ":" : "",
237 b[k].lb_vendor ? b[k].lb_part : "",
238 test_state_to_template(boards[i].working));
239
240 if (boards[i].note) {
241 num_notes++;
242 printf(" <span id=\"%s_ref%d\"><sup>[[#%s_note%d|%d]]</sup></span>\n",
243 devicetype, num_notes, devicetype, num_notes, num_notes);
244 int ret = snprintf(tmp, sizeof(tmp),
245 "<span id=\"%s_note%d\">%d. [[#%s_ref%d|↑]]</span>"
246 " <nowiki>%s</nowiki><br />\n", devicetype, num_notes, num_notes,
247 devicetype, num_notes, boards[i].note);
248 if (ret < 0 || (unsigned int)ret >= sizeof(tmp)) {
249 fprintf(stderr, "Footnote text #%d of %s truncated (ret=%d, sizeof(tmp)=%zu)\n",
250 num_notes, devicetype, ret, sizeof(tmp));
251 }
252 notes = strcat_realloc(notes, tmp);
253 } else {
254 printf("\n");
255 }
256
257 if (((i % lines_per_col) + 1) == lines_per_col)
258 printf("\n|}\n\n");
259 }
260
261 /* end inner table if it did not fill the last column fully */
262 if (((i % lines_per_col)) > 0)
263 printf("\n|}\n\n");
264 printf("|}\n");
265
266 if (num_notes > 0)
267 printf("\n<small>\n%s</small>\n", notes);
268 free(notes);
269 }
270
print_supported_boards_wiki(void)271 static void print_supported_boards_wiki(void)
272 {
273 printf("%s", board_intro);
274 print_supported_boards_wiki_helper("mainboards", 2, boards_known);
275
276 printf("%s", laptop_intro);
277 print_supported_boards_wiki_helper("mobile devices", 1, laptops_known);
278 }
279 #endif
280
print_supported_chips_wiki(int cols)281 static void print_supported_chips_wiki(int cols)
282 {
283 unsigned int lines_per_col;
284 char *s;
285 char vmax[6];
286 char vmin[6];
287 const struct flashchip *f, *old = NULL;
288 int i = 0, c = 1, chipcount = 0;
289
290 for (f = flashchips; f->name != NULL; f++) {
291 /* Don't count generic entries. */
292 if (!strncmp(f->vendor, "Unknown", 7) ||
293 !strncmp(f->vendor, "Programmer", 10) ||
294 !strncmp(f->name, "unknown", 7))
295 continue;
296 chipcount++;
297 }
298
299 /* +1 to force the resulting number of columns to be < cols */
300 lines_per_col = chipcount / cols + ((chipcount%cols) > 0 ? 1 : 0);
301
302 printf("%s", chip_intro);
303 printf("\nTotal amount of supported chips: '''%d'''\n\n"
304 "{| border=\"0\" valign=\"top\"\n", chipcount);
305
306 for (f = flashchips; f->name != NULL; f++) {
307 /* Don't print generic entries. */
308 if (!strncmp(f->vendor, "Unknown", 7) ||
309 !strncmp(f->vendor, "Programmer", 10) ||
310 !strncmp(f->name, "unknown", 7))
311 continue;
312
313 if ((i % lines_per_col) == 0)
314 printf("%s%s", th_start, chip_th);
315
316 /* Alternate colors if the vendor changes. */
317 if (old != NULL && strcmp(old->vendor, f->vendor))
318 c = !c;
319
320 old = f;
321 s = flashbuses_to_text(f->bustype);
322 sprintf(vmin, "%0.03f", f->voltage.min / (double)1000);
323 sprintf(vmax, "%0.03f", f->voltage.max / (double)1000);
324 printf("|- bgcolor=\"#%s\"\n| %s || %s || align=\"right\" | %d "
325 "|| %s || {{%s}} || {{%s}} || {{%s}} || {{%s}}"
326 "|| %s || %s\n",
327 (c == 1) ? "eeeeee" : "dddddd", f->vendor, f->name,
328 f->total_size, s ? s : "?",
329 test_state_to_template(f->tested.probe),
330 test_state_to_template(f->tested.read),
331 test_state_to_template(f->tested.erase),
332 test_state_to_template(f->tested.write),
333 f->voltage.min ? vmin : "?",
334 f->voltage.max ? vmax : "?");
335 free(s);
336
337 if (((i % lines_per_col) + 1) == lines_per_col)
338 printf("\n|}\n\n");
339 i++;
340 }
341 /* end inner table if it did not fill the last column fully */
342 if (((i % lines_per_col)) > 0)
343 printf("\n|}\n\n");
344 printf("|}\n\n");
345 }
346
347 /* Following functions are not needed when no PCI/USB programmers are compiled in,
348 * but since print_wiki code has no size constraints we include it unconditionally. */
count_supported_devs_wiki(const struct dev_entry * devs)349 static int count_supported_devs_wiki(const struct dev_entry *devs)
350 {
351 unsigned int count = 0;
352 unsigned int i = 0;
353 for (i = 0; devs[i].vendor_id != 0; i++)
354 count++;
355 return count;
356 }
357
print_supported_devs_wiki_helper(const struct programmer_entry * const prog)358 static void print_supported_devs_wiki_helper(const struct programmer_entry *const prog)
359 {
360 int i = 0;
361 static int c = 0;
362 const struct dev_entry *devs = prog->devs.dev;
363 const unsigned int count = count_supported_devs_wiki(devs);
364
365 /* Alternate colors if the vendor changes. */
366 c = !c;
367
368 for (i = 0; devs[i].vendor_id != 0; i++) {
369 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
370 if (i == 0)
371 printf("| rowspan=\"%u\" | %s |", count, prog->name);
372 printf("| %s || %s || %04x:%04x || {{%s}}\n", devs[i].vendor_name, devs[i].device_name,
373 devs[i].vendor_id, devs[i].device_id, test_state_to_template(devs[i].status));
374 }
375 }
376
print_supported_devs_wiki()377 static void print_supported_devs_wiki()
378 {
379 unsigned int pci_count = 0;
380 unsigned int usb_count = 0;
381 unsigned int i;
382
383 for (i = 0; i < programmer_table_size; i++) {
384 const struct programmer_entry *const prog = programmer_table[i];
385 switch (prog->type) {
386 case USB:
387 usb_count += count_supported_devs_wiki(prog->devs.dev);
388 break;
389 case PCI:
390 pci_count += count_supported_devs_wiki(prog->devs.dev);
391 break;
392 case OTHER:
393 default:
394 break;
395 }
396 }
397
398 printf("\n== PCI Devices ==\n\n"
399 "Total amount of supported PCI devices flashrom can use as a programmer: '''%d'''\n\n"
400 "{%s%s", pci_count, th_start, programmer_th);
401
402 for (i = 0; i < programmer_table_size; i++) {
403 const struct programmer_entry *const prog = programmer_table[i];
404 if (prog->type == PCI) {
405 print_supported_devs_wiki_helper(prog);
406 }
407 }
408 printf("\n|}\n\n|}\n");
409
410 printf("\n== USB Devices ==\n\n"
411 "Total amount of supported USB devices flashrom can use as a programmer: '''%d'''\n\n"
412 "{%s%s", usb_count, th_start, programmer_th);
413
414 for (i = 0; i < programmer_table_size; i++) {
415 const struct programmer_entry *const prog = programmer_table[i];
416 if (prog->type == USB) {
417 print_supported_devs_wiki_helper(prog);
418 }
419 }
420 printf("\n|}\n\n|}\n");
421
422 printf("\n== Other programmers ==\n\n"
423 "{%s", th_start);
424 printf("! align=\"left\" | Programmer\n"
425 "! align=\"left\" | Note\n\n");
426
427 for (i = 0; i < programmer_table_size; i++) {
428 static int c = 0;
429 const struct programmer_entry *const prog = programmer_table[i];
430 if (prog->type == OTHER && prog->devs.note != NULL) {
431 c = !c;
432 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
433 printf("| %s || %s", prog->name, prog->devs.note);
434 }
435 }
436 printf("\n|}\n\n|}\n");
437 }
438
print_supported_wiki(void)439 void print_supported_wiki(void)
440 {
441 time_t t = time(NULL);
442 char buf[sizeof("1986-02-28T12:37:42Z")];
443 strftime(buf, sizeof(buf), "%Y-%m-%dT%H:%M:%SZ", gmtime(&t));
444
445 printf(wiki_header, buf, flashrom_version);
446 print_supported_chips_wiki(2);
447 #if CONFIG_INTERNAL == 1
448 print_supported_chipsets_wiki(3);
449 print_supported_boards_wiki();
450 #endif
451 print_supported_devs_wiki();
452 }
453