blob: 9af2e3e27810d60381994b4455a9aee25b3c6fd7 [file] [log] [blame]
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Uwe Hermann <uwe@hermann-uwe.de>
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.
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000016 */
17
Peter Lemenkov4adf8a62010-06-01 10:13:17 +000018#include <stdio.h>
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000019#include <string.h>
20#include <stdlib.h>
21#include <time.h>
22#include "flash.h"
23#include "flashchips.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000024#include "programmer.h"
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000025
Mathias Krausea60faab2011-01-17 07:50:42 +000026static const char wiki_header[] = "= Supported devices =\n\n\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000027<div style=\"margin-top:0.5em; padding:0.5em 0.5em 0.5em 0.5em; \
Stefan Tauner05aa0f42014-06-02 00:45:57 +000028background-color:#eeeeee; text-align:left; border:1px solid #aabbcc;\">\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000029<small>\n\
Stefan Tauner2a10e702014-06-02 00:46:02 +000030'''Last update:''' %s (generated by flashrom %s)<br />\n\
Stefan Tauner05aa0f42014-06-02 00:45:57 +000031The tables below are generated from flashrom's source by copying the output of '''flashrom -z'''.<br /><br />\n\
32A 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 \
39the 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 \
43configurations 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";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000055
Stefan Tauner00ec0272012-07-29 02:04:21 +000056static const char th_start[] = "| valign=\"top\"|\n\n\
57{| border=\"0\" style=\"font-size: smaller\" valign=\"top\"\n\
58|- bgcolor=\"#6699dd\"\n";
59
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000060#if CONFIG_INTERNAL == 1
Stefan Tauner00ec0272012-07-29 02:04:21 +000061static const char chipset_th[] = "\
62! align=\"left\" | Vendor\n\
63! align=\"left\" | Southbridge\n\
64! align=\"center\" | PCI IDs\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000065! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000066
Stefan Tauner00ec0272012-07-29 02:04:21 +000067static const char board_th[] = "\
68! align=\"left\" | Vendor\n\
69! align=\"left\" | Mainboard\n\
70! align=\"left\" | Required option\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000071! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000072
Mathias Krausea60faab2011-01-17 07:50:42 +000073static const char board_intro[] = "\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000074\n== Supported mainboards ==\n\n\
75In general, it is very likely that flashrom works out of the box even if your \
76mainboard is not listed below.\n\nThis is a list of mainboards where we have \
77verified that they either do or do not need any special initialization to \
78make flashrom work (given flashrom supports the respective chipset and flash \
79chip), or that they do not yet work at all. If they do not work, support may \
80or may not be added later.\n\n\
Stefan Taunerd06d9412011-06-12 19:47:55 +000081Mainboards (or individual revisions) which don't appear in the list may or may \
82not work (we don't know, someone has to give it a try). Please report any \
83further verified mainboards on the [[Mailinglist|mailing list]].\n";
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000084#endif
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000085
Stefan Tauner00ec0272012-07-29 02:04:21 +000086static const char chip_th[] = "\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000087! 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\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000093|- bgcolor=\"#6699ff\"\n| colspan=\"4\" | &nbsp;\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000094| Probe\n| Read\n| Erase\n| Write\n\
Elyes HAOUASac01baa2018-05-28 16:52:21 +020095| align=\"center\" | Min\n| align=\"center\" | Max\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000096
Stefan Tauner1c356bb2013-07-11 13:48:52 +000097static const char chip_intro[] = "\
98\n== Supported flash chips ==\n\n\
99The list below contains all chips that have some kind of explicit support added to flashrom and their last \
100known test status. Newer SPI flash chips might work even without explicit support if they implement SFDP ([\
101http://www.jedec.org/standards-documents/docs/jesd216 Serial Flash Discoverable Parameters - JESD216]). \
102Flashrom will detect this automatically and inform you about it.\n\n\
103The names used below are designed to be as concise as possible and hence contain only the characters \
104describing properties that are relevant to flashrom. Irrelevant characters specify attributes flashrom can not \
105use or even detect by itself (e.g. the physical package) and have no effect on flashrom's operation. They are \
106replaced by dots ('.') functioning as wildcards (like in Regular Expressions) or are completely omitted at the \
107end of a name.\n";
108
Stefan Tauner00ec0272012-07-29 02:04:21 +0000109static const char programmer_th[] = "\
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000110! align=\"left\" | Programmer\n\
Stefan Tauner00ec0272012-07-29 02:04:21 +0000111! align=\"left\" | Vendor\n\
112! align=\"left\" | Device\n\
Stefan Tauneraf358d62012-12-27 18:40:26 +0000113! align=\"center\" | IDs\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000114! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000115
Stefan Tauner618d8972014-05-28 13:02:13 +0000116/* 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. */
119static 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
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000131#if CONFIG_INTERNAL == 1
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000132static const char laptop_intro[] = "\n== Supported mobile devices (laptops, tablets etc.) ==\n\n\
133In general, flashing mobile devices is more difficult because they\n\n\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000134* 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; \
138background-color:#ff6666; align:right; border:1px solid #000000;\">\n\
139'''IMPORTANT:''' At this point we recommend to '''not''' use flashrom on \
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000140untested mobile devices unless you have a means to recover from a flashing that goes \
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000141wrong (a working backup flash chip and/or good soldering skills).\n</div>\n";
142
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000143static void print_supported_chipsets_wiki(int cols)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000144{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000145 int i;
146 unsigned int lines_per_col;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000147 const struct penable *e;
Stefan Tauner00ec0272012-07-29 02:04:21 +0000148 int enablescount = 0, color = 1;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000149
150 for (e = chipset_enables; e->vendor_name != NULL; e++)
151 enablescount++;
152
Stefan Tauner00ec0272012-07-29 02:04:21 +0000153 /* +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);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000158
159 e = chipset_enables;
Stefan Tauner00ec0272012-07-29 02:04:21 +0000160 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
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000164 /* Alternate colors if the vendor changes. */
165 if (i > 0 && strcmp(e[i].vendor_name, e[i - 1].vendor_name))
166 color = !color;
167
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000168 printf("|- bgcolor=\"#%s\"\n| %s || %s "
Stefan Tauner618d8972014-05-28 13:02:13 +0000169 "|| %04x:%04x || {{%s}}\n", (color) ? "eeeeee" : "dddddd",
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000170 e[i].vendor_name, e[i].device_name,
171 e[i].vendor_id, e[i].device_id,
Stefan Tauner618d8972014-05-28 13:02:13 +0000172 test_state_to_template(e[i].status));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000173
Stefan Tauner00ec0272012-07-29 02:04:21 +0000174 if (((i % lines_per_col) + 1) == lines_per_col)
175 printf("\n|}\n\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000176 }
177
Stefan Tauner00ec0272012-07-29 02:04:21 +0000178 /* 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");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000182}
183
Stefan Tauneraf358d62012-12-27 18:40:26 +0000184static void print_supported_boards_wiki_helper(const char *devicetype, int cols, const struct board_info boards[])
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000185{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000186 int i, k;
187 unsigned int boardcount, lines_per_col;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000188 unsigned int boardcount_good = 0, boardcount_bad = 0, boardcount_nt = 0;
189 int num_notes = 0, color = 1;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000190 char *notes = calloc(1, 1);
191 char tmp[900 + 1];
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000192 const struct board_match *b = board_matches;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000193
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000194 for (i = 0; boards[i].vendor != NULL; i++) {
Stefan Tauner2c20b282012-07-28 19:35:26 +0000195 if (boards[i].working == OK)
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000196 boardcount_good++;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000197 else if (boards[i].working == NT)
198 boardcount_nt++;
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000199 else
200 boardcount_bad++;
201 }
Stefan Tauner00ec0272012-07-29 02:04:21 +0000202 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);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000206
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000207 printf("\n\nTotal amount of known good %s: '''%d'''; "
Stefan Tauner2c20b282012-07-28 19:35:26 +0000208 "Untested (e.g. user vanished before testing new code): '''%d'''; "
209 "Not yet supported (i.e. known-bad): '''%d'''.\n\n"
Stefan Tauner00ec0272012-07-29 02:04:21 +0000210 "{| border=\"0\" valign=\"top\"\n", devicetype, boardcount_good, boardcount_nt, boardcount_bad);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000211
Stefan Tauner00ec0272012-07-29 02:04:21 +0000212 for (i = 0; boards[i].vendor != NULL; i++) {
213 if ((i % lines_per_col) == 0)
214 printf("%s%s", th_start, board_th);
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000215
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000216 /* Alternate colors if the vendor changes. */
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000217 if (i > 0 && strcmp(boards[i].vendor, boards[i - 1].vendor))
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000218 color = !color;
219
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000220 k = 0;
Carl-Daniel Hailfinger4146ced2010-06-07 11:10:43 +0000221 while ((b[k].vendor_name != NULL) &&
222 (strcmp(b[k].vendor_name, boards[i].vendor) ||
223 strcmp(b[k].board_name, boards[i].name))) {
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000224 k++;
225 }
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000226
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000227 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 ? "]" : "",
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000234 b[k].lb_vendor ? "-p internal:mainboard=" : "&mdash;",
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000235 b[k].lb_vendor ? b[k].lb_vendor : "",
236 b[k].lb_vendor ? ":" : "",
237 b[k].lb_vendor ? b[k].lb_part : "",
Stefan Tauner618d8972014-05-28 13:02:13 +0000238 test_state_to_template(boards[i].working));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000239
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000240 if (boards[i].note) {
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000241 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|&#x2191;]]</span>"
246 " <nowiki>%s</nowiki><br />\n", devicetype, num_notes, num_notes,
247 devicetype, num_notes, boards[i].note);
Nico Huber519be662018-12-23 20:03:35 +0100248 if (ret < 0 || (unsigned int)ret >= sizeof(tmp)) {
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000249 fprintf(stderr, "Footnote text #%d of %s truncated (ret=%d, sizeof(tmp)=%zu)\n",
250 num_notes, devicetype, ret, sizeof(tmp));
251 }
Mathias Krausea60faab2011-01-17 07:50:42 +0000252 notes = strcat_realloc(notes, tmp);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000253 } else {
254 printf("\n");
255 }
256
Stefan Tauner00ec0272012-07-29 02:04:21 +0000257 if (((i % lines_per_col) + 1) == lines_per_col)
258 printf("\n|}\n\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000259 }
260
Stefan Tauner00ec0272012-07-29 02:04:21 +0000261 /* end inner table if it did not fill the last column fully */
262 if (((i % lines_per_col)) > 0)
263 printf("\n|}\n\n");
Stefan Tauner352e50b2013-02-22 15:58:45 +0000264 printf("|}\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000265
266 if (num_notes > 0)
267 printf("\n<small>\n%s</small>\n", notes);
268 free(notes);
269}
270
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000271static void print_supported_boards_wiki(void)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000272{
273 printf("%s", board_intro);
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000274 print_supported_boards_wiki_helper("mainboards", 2, boards_known);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000275
276 printf("%s", laptop_intro);
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000277 print_supported_boards_wiki_helper("mobile devices", 1, laptops_known);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000278}
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000279#endif
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000280
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000281static void print_supported_chips_wiki(int cols)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000282{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000283 unsigned int lines_per_col;
Stefan Tauner00155492011-06-26 20:45:35 +0000284 char *s;
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000285 char vmax[6];
286 char vmin[6];
Stefan Tauner00ec0272012-07-29 02:04:21 +0000287 const struct flashchip *f, *old = NULL;
288 int i = 0, c = 1, chipcount = 0;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000289
Stefan Tauner93f70232011-07-26 14:33:46 +0000290 for (f = flashchips; f->name != NULL; f++) {
Stefan Tauner035492a2012-02-03 22:32:09 +0000291 /* Don't count generic entries. */
292 if (!strncmp(f->vendor, "Unknown", 7) ||
293 !strncmp(f->vendor, "Programmer", 10) ||
294 !strncmp(f->name, "unknown", 7))
Stefan Tauner4c5665f2012-02-17 20:03:37 +0000295 continue;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000296 chipcount++;
Stefan Tauner93f70232011-07-26 14:33:46 +0000297 }
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000298
Stefan Tauner00ec0272012-07-29 02:04:21 +0000299 /* +1 to force the resulting number of columns to be < cols */
300 lines_per_col = chipcount / cols + ((chipcount%cols) > 0 ? 1 : 0);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000301
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000302 printf("%s", chip_intro);
303 printf("\nTotal amount of supported chips: '''%d'''\n\n"
Stefan Tauner00ec0272012-07-29 02:04:21 +0000304 "{| border=\"0\" valign=\"top\"\n", chipcount);
305
306 for (f = flashchips; f->name != NULL; f++) {
Stefan Tauner035492a2012-02-03 22:32:09 +0000307 /* Don't print generic entries. */
308 if (!strncmp(f->vendor, "Unknown", 7) ||
309 !strncmp(f->vendor, "Programmer", 10) ||
310 !strncmp(f->name, "unknown", 7))
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000311 continue;
312
Stefan Tauner00ec0272012-07-29 02:04:21 +0000313 if ((i % lines_per_col) == 0)
314 printf("%s%s", th_start, chip_th);
315
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000316 /* Alternate colors if the vendor changes. */
317 if (old != NULL && strcmp(old->vendor, f->vendor))
318 c = !c;
319
Stefan Tauner00ec0272012-07-29 02:04:21 +0000320 old = f;
Stefan Tauner00155492011-06-26 20:45:35 +0000321 s = flashbuses_to_text(f->bustype);
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000322 sprintf(vmin, "%0.03f", f->voltage.min / (double)1000);
323 sprintf(vmax, "%0.03f", f->voltage.max / (double)1000);
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000324 printf("|- bgcolor=\"#%s\"\n| %s || %s || align=\"right\" | %d "
325 "|| %s || {{%s}} || {{%s}} || {{%s}} || {{%s}}"
Elyes HAOUASac01baa2018-05-28 16:52:21 +0200326 "|| %s || %s\n",
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000327 (c == 1) ? "eeeeee" : "dddddd", f->vendor, f->name,
Stefan Tauner00155492011-06-26 20:45:35 +0000328 f->total_size, s,
Stefan Tauner618d8972014-05-28 13:02:13 +0000329 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),
Stefan Tauner6455dff2014-05-26 00:36:24 +0000333 f->voltage.min ? vmin : "?",
334 f->voltage.max ? vmax : "?");
Stefan Tauner00155492011-06-26 20:45:35 +0000335 free(s);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000336
Stefan Tauner00ec0272012-07-29 02:04:21 +0000337 if (((i % lines_per_col) + 1) == lines_per_col)
338 printf("\n|}\n\n");
339 i++;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000340 }
Stefan Tauner00ec0272012-07-29 02:04:21 +0000341 /* 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");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000345}
346
Stefan Tauneraf358d62012-12-27 18:40:26 +0000347/* 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. */
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000349static int count_supported_devs_wiki(const struct dev_entry *devs)
Stefan Tauneraf358d62012-12-27 18:40:26 +0000350{
351 unsigned int count = 0;
352 unsigned int i = 0;
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000353 for (i = 0; devs[i].vendor_id != 0; i++)
Stefan Tauneraf358d62012-12-27 18:40:26 +0000354 count++;
355 return count;
356}
357
Thomas Heijligendee884e2021-03-31 19:09:44 +0200358static void print_supported_devs_wiki_helper(const struct programmer_entry *const prog)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000359{
360 int i = 0;
361 static int c = 0;
Thomas Heijligendee884e2021-03-31 19:09:44 +0200362 const struct dev_entry *devs = prog->devs.dev;
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000363 const unsigned int count = count_supported_devs_wiki(devs);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000364
365 /* Alternate colors if the vendor changes. */
366 c = !c;
367
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000368 for (i = 0; devs[i].vendor_id != 0; i++) {
369 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
370 if (i == 0)
Thomas Heijligendee884e2021-03-31 19:09:44 +0200371 printf("| rowspan=\"%u\" | %s |", count, prog->name);
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000372 printf("| %s || %s || %04x:%04x || {{%s}}\n", devs[i].vendor_name, devs[i].device_name,
Stefan Tauner618d8972014-05-28 13:02:13 +0000373 devs[i].vendor_id, devs[i].device_id, test_state_to_template(devs[i].status));
Stefan Tauneraf358d62012-12-27 18:40:26 +0000374 }
375}
376
377static void print_supported_devs_wiki()
378{
379 unsigned int pci_count = 0;
380 unsigned int usb_count = 0;
381 unsigned int i;
382
Thomas Heijligene14b2ec2021-05-19 14:12:18 +0200383 for (i = 0; i < programmer_table_size; i++) {
Thomas Heijligendee884e2021-03-31 19:09:44 +0200384 const struct programmer_entry *const prog = programmer_table[i];
385 switch (prog->type) {
Stefan Tauneraf358d62012-12-27 18:40:26 +0000386 case USB:
Thomas Heijligendee884e2021-03-31 19:09:44 +0200387 usb_count += count_supported_devs_wiki(prog->devs.dev);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000388 break;
389 case PCI:
Thomas Heijligendee884e2021-03-31 19:09:44 +0200390 pci_count += count_supported_devs_wiki(prog->devs.dev);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000391 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
Thomas Heijligene14b2ec2021-05-19 14:12:18 +0200402 for (i = 0; i < programmer_table_size; i++) {
Thomas Heijligendee884e2021-03-31 19:09:44 +0200403 const struct programmer_entry *const prog = programmer_table[i];
404 if (prog->type == PCI) {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000405 print_supported_devs_wiki_helper(prog);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000406 }
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
Thomas Heijligene14b2ec2021-05-19 14:12:18 +0200414 for (i = 0; i < programmer_table_size; i++) {
Thomas Heijligendee884e2021-03-31 19:09:44 +0200415 const struct programmer_entry *const prog = programmer_table[i];
416 if (prog->type == USB) {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000417 print_supported_devs_wiki_helper(prog);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000418 }
419 }
420 printf("\n|}\n\n|}\n");
Stefan Tauner2c421192012-12-27 18:40:40 +0000421
422 printf("\n== Other programmers ==\n\n"
423 "{%s", th_start);
424 printf("! align=\"left\" | Programmer\n"
425 "! align=\"left\" | Note\n\n");
426
Thomas Heijligene14b2ec2021-05-19 14:12:18 +0200427 for (i = 0; i < programmer_table_size; i++) {
Stefan Tauner2c421192012-12-27 18:40:40 +0000428 static int c = 0;
Thomas Heijligendee884e2021-03-31 19:09:44 +0200429 const struct programmer_entry *const prog = programmer_table[i];
430 if (prog->type == OTHER && prog->devs.note != NULL) {
Stefan Tauner2c421192012-12-27 18:40:40 +0000431 c = !c;
432 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
Thomas Heijligendee884e2021-03-31 19:09:44 +0200433 printf("| %s || %s", prog->name, prog->devs.note);
Stefan Tauner2c421192012-12-27 18:40:40 +0000434 }
435 }
436 printf("\n|}\n\n|}\n");
Stefan Tauneraf358d62012-12-27 18:40:26 +0000437}
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000438
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000439void print_supported_wiki(void)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000440{
441 time_t t = time(NULL);
Stefan Tauner2a10e702014-06-02 00:46:02 +0000442 char buf[sizeof("1986-02-28T12:37:42Z")];
443 strftime(buf, sizeof(buf), "%Y-%m-%dT%H:%M:%SZ", gmtime(&t));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000444
Stefan Tauner2a10e702014-06-02 00:46:02 +0000445 printf(wiki_header, buf, flashrom_version);
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000446 print_supported_chips_wiki(2);
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000447#if CONFIG_INTERNAL == 1
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000448 print_supported_chipsets_wiki(3);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000449 print_supported_boards_wiki();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000450#endif
Stefan Tauneraf358d62012-12-27 18:40:26 +0000451 print_supported_devs_wiki();
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000452}