blob: d2fb5e28d230ff01c5a3fca90511411409426528 [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.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
Peter Lemenkov4adf8a62010-06-01 10:13:17 +000022#include <stdio.h>
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000023#include <string.h>
24#include <stdlib.h>
25#include <time.h>
26#include "flash.h"
27#include "flashchips.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000028#include "programmer.h"
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000029
Mathias Krausea60faab2011-01-17 07:50:42 +000030static const char wiki_header[] = "= Supported devices =\n\n\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000031<div style=\"margin-top:0.5em; padding:0.5em 0.5em 0.5em 0.5em; \
Stefan Tauner05aa0f42014-06-02 00:45:57 +000032background-color:#eeeeee; text-align:left; border:1px solid #aabbcc;\">\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000033<small>\n\
Stefan Tauner2a10e702014-06-02 00:46:02 +000034'''Last update:''' %s (generated by flashrom %s)<br />\n\
Stefan Tauner05aa0f42014-06-02 00:45:57 +000035The tables below are generated from flashrom's source by copying the output of '''flashrom -z'''.<br /><br />\n\
36A short explanation of the cells representing the support state follows:<br />\n\
37{| border=\"0\" valign=\"top\"\n\
38! style=\"text-align:left;\" |\n\
39! style=\"text-align:left;\" |\n\
40|-\n\
41|{{OK}}\n\
42| The feature was '''tested and should work''' in general unless there is a bug in flashrom or another component in \
43the system prohibits some functionality.\n\
44|-\n\
45|{{Dep}}\n\
46| '''Configuration-dependent'''. The feature was tested and should work in general but there are common \
47configurations that drastically limit flashrom's capabilities or make it completely stop working.\n\
48|-\n\
49|{{?3}}\n\
50| The feature is '''untested''' but believed to be working.\n\
51|-\n\
52|{{NA}}\n\
53| The feature is '''not applicable''' in this configuration (e.g. write operations on ROM chips).\n\
54|-\n\
55|{{No}}\n\
56| The feature is '''known to not work'''. Don't bother testing (nor reporting. Patches welcome! ;).\n\
57|}\n\
58</small></div>\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000059
Stefan Tauner00ec0272012-07-29 02:04:21 +000060static const char th_start[] = "| valign=\"top\"|\n\n\
61{| border=\"0\" style=\"font-size: smaller\" valign=\"top\"\n\
62|- bgcolor=\"#6699dd\"\n";
63
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000064#if CONFIG_INTERNAL == 1
Stefan Tauner00ec0272012-07-29 02:04:21 +000065static const char chipset_th[] = "\
66! align=\"left\" | Vendor\n\
67! align=\"left\" | Southbridge\n\
68! align=\"center\" | PCI IDs\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000069! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000070
Stefan Tauner00ec0272012-07-29 02:04:21 +000071static const char board_th[] = "\
72! align=\"left\" | Vendor\n\
73! align=\"left\" | Mainboard\n\
74! align=\"left\" | Required option\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000075! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000076
Mathias Krausea60faab2011-01-17 07:50:42 +000077static const char board_intro[] = "\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000078\n== Supported mainboards ==\n\n\
79In general, it is very likely that flashrom works out of the box even if your \
80mainboard is not listed below.\n\nThis is a list of mainboards where we have \
81verified that they either do or do not need any special initialization to \
82make flashrom work (given flashrom supports the respective chipset and flash \
83chip), or that they do not yet work at all. If they do not work, support may \
84or may not be added later.\n\n\
Stefan Taunerd06d9412011-06-12 19:47:55 +000085Mainboards (or individual revisions) which don't appear in the list may or may \
86not work (we don't know, someone has to give it a try). Please report any \
87further verified mainboards on the [[Mailinglist|mailing list]].\n";
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000088#endif
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000089
Stefan Tauner00ec0272012-07-29 02:04:21 +000090static const char chip_th[] = "\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000091! align=\"left\" | Vendor\n\
92! align=\"left\" | Device\n\
93! align=\"center\" | Size [kB]\n\
94! align=\"center\" | Type\n\
95! align=\"center\" colspan=\"4\" | Status\n\
96! align=\"center\" colspan=\"2\" | Voltage [V]\n\n\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +000097|- bgcolor=\"#6699ff\"\n| colspan=\"4\" | &nbsp;\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +000098| Probe\n| Read\n| Erase\n| Write\n\
Paul Menzel018d4822011-10-21 12:33:07 +000099| align=\"center\" | Min \n| align=\"center\" | Max\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000100
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000101static const char chip_intro[] = "\
102\n== Supported flash chips ==\n\n\
103The list below contains all chips that have some kind of explicit support added to flashrom and their last \
104known test status. Newer SPI flash chips might work even without explicit support if they implement SFDP ([\
105http://www.jedec.org/standards-documents/docs/jesd216 Serial Flash Discoverable Parameters - JESD216]). \
106Flashrom will detect this automatically and inform you about it.\n\n\
107The names used below are designed to be as concise as possible and hence contain only the characters \
108describing properties that are relevant to flashrom. Irrelevant characters specify attributes flashrom can not \
109use or even detect by itself (e.g. the physical package) and have no effect on flashrom's operation. They are \
110replaced by dots ('.') functioning as wildcards (like in Regular Expressions) or are completely omitted at the \
111end of a name.\n";
112
Stefan Tauner00ec0272012-07-29 02:04:21 +0000113static const char programmer_th[] = "\
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000114! align=\"left\" | Programmer\n\
Stefan Tauner00ec0272012-07-29 02:04:21 +0000115! align=\"left\" | Vendor\n\
116! align=\"left\" | Device\n\
Stefan Tauneraf358d62012-12-27 18:40:26 +0000117! align=\"center\" | IDs\n\
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000118! align=\"center\" | Status\n\n";
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000119
Stefan Tauner618d8972014-05-28 13:02:13 +0000120/* The output of this module relies on MediaWiki templates to select special formatting styles for table cells
121 * reflecting the test status of the respective hardware. This functions returns the correct template name for
122 * the supplied enum test_state. */
123static const char *test_state_to_template(enum test_state test_state)
124{
125 switch (test_state) {
126 case OK: return "OK";
127 case BAD: return "No";
128 case NA: return "NA";
129 case DEP: return "Dep";
130 case NT:
131 default: return "?3";
132 }
133}
134
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000135#if CONFIG_INTERNAL == 1
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000136static const char laptop_intro[] = "\n== Supported mobile devices (laptops, tablets etc.) ==\n\n\
137In general, flashing mobile devices is more difficult because they\n\n\
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000138* often use the flash chip for stuff besides the BIOS,\n\
139* often have special protection stuff which has to be handled by flashrom,\n\
140* often use flash translation circuits which need drivers in flashrom.\n\n\
141<div style=\"margin-top:0.5em; padding:0.5em 0.5em 0.5em 0.5em; \
142background-color:#ff6666; align:right; border:1px solid #000000;\">\n\
143'''IMPORTANT:''' At this point we recommend to '''not''' use flashrom on \
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000144untested mobile devices unless you have a means to recover from a flashing that goes \
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000145wrong (a working backup flash chip and/or good soldering skills).\n</div>\n";
146
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000147static void print_supported_chipsets_wiki(int cols)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000148{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000149 int i;
150 unsigned int lines_per_col;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000151 const struct penable *e;
Stefan Tauner00ec0272012-07-29 02:04:21 +0000152 int enablescount = 0, color = 1;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000153
154 for (e = chipset_enables; e->vendor_name != NULL; e++)
155 enablescount++;
156
Stefan Tauner00ec0272012-07-29 02:04:21 +0000157 /* +1 to force the resulting number of columns to be < cols */
158 lines_per_col = enablescount / cols + ((enablescount%cols) > 0 ? 1 : 0);
159
160 printf("\n== Supported chipsets ==\n\nTotal amount of supported chipsets: '''%d'''\n\n"
161 "{| border=\"0\" valign=\"top\"\n", enablescount);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000162
163 e = chipset_enables;
Stefan Tauner00ec0272012-07-29 02:04:21 +0000164 for (i = 0; e[i].vendor_name != NULL; i++) {
165 if ((i % lines_per_col) == 0)
166 printf("%s%s", th_start, chipset_th);
167
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000168 /* Alternate colors if the vendor changes. */
169 if (i > 0 && strcmp(e[i].vendor_name, e[i - 1].vendor_name))
170 color = !color;
171
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000172 printf("|- bgcolor=\"#%s\"\n| %s || %s "
Stefan Tauner618d8972014-05-28 13:02:13 +0000173 "|| %04x:%04x || {{%s}}\n", (color) ? "eeeeee" : "dddddd",
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000174 e[i].vendor_name, e[i].device_name,
175 e[i].vendor_id, e[i].device_id,
Stefan Tauner618d8972014-05-28 13:02:13 +0000176 test_state_to_template(e[i].status));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000177
Stefan Tauner00ec0272012-07-29 02:04:21 +0000178 if (((i % lines_per_col) + 1) == lines_per_col)
179 printf("\n|}\n\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000180 }
181
Stefan Tauner00ec0272012-07-29 02:04:21 +0000182 /* end inner table if it did not fill the last column fully */
183 if (((i % lines_per_col)) > 0)
184 printf("\n|}\n\n");
185 printf("\n\n|}\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000186}
187
Stefan Tauneraf358d62012-12-27 18:40:26 +0000188static void print_supported_boards_wiki_helper(const char *devicetype, int cols, const struct board_info boards[])
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000189{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000190 int i, k;
191 unsigned int boardcount, lines_per_col;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000192 unsigned int boardcount_good = 0, boardcount_bad = 0, boardcount_nt = 0;
193 int num_notes = 0, color = 1;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000194 char *notes = calloc(1, 1);
195 char tmp[900 + 1];
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +0000196 const struct board_match *b = board_matches;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000197
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000198 for (i = 0; boards[i].vendor != NULL; i++) {
Stefan Tauner2c20b282012-07-28 19:35:26 +0000199 if (boards[i].working == OK)
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000200 boardcount_good++;
Stefan Tauner2c20b282012-07-28 19:35:26 +0000201 else if (boards[i].working == NT)
202 boardcount_nt++;
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000203 else
204 boardcount_bad++;
205 }
Stefan Tauner00ec0272012-07-29 02:04:21 +0000206 boardcount = boardcount_good + boardcount_nt + boardcount_bad;
207
208 /* +1 to force the resulting number of columns to be < cols */
209 lines_per_col = boardcount / cols + ((boardcount%cols) > 0 ? 1 : 0);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000210
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000211 printf("\n\nTotal amount of known good %s: '''%d'''; "
Stefan Tauner2c20b282012-07-28 19:35:26 +0000212 "Untested (e.g. user vanished before testing new code): '''%d'''; "
213 "Not yet supported (i.e. known-bad): '''%d'''.\n\n"
Stefan Tauner00ec0272012-07-29 02:04:21 +0000214 "{| border=\"0\" valign=\"top\"\n", devicetype, boardcount_good, boardcount_nt, boardcount_bad);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000215
Stefan Tauner00ec0272012-07-29 02:04:21 +0000216 for (i = 0; boards[i].vendor != NULL; i++) {
217 if ((i % lines_per_col) == 0)
218 printf("%s%s", th_start, board_th);
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000219
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000220 /* Alternate colors if the vendor changes. */
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000221 if (i > 0 && strcmp(boards[i].vendor, boards[i - 1].vendor))
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000222 color = !color;
223
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000224 k = 0;
Carl-Daniel Hailfinger4146ced2010-06-07 11:10:43 +0000225 while ((b[k].vendor_name != NULL) &&
226 (strcmp(b[k].vendor_name, boards[i].vendor) ||
227 strcmp(b[k].board_name, boards[i].name))) {
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000228 k++;
229 }
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000230
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000231 printf("|- bgcolor=\"#%s\"\n| %s || %s%s %s%s || %s%s%s%s "
232 "|| {{%s}}", (color) ? "eeeeee" : "dddddd",
233 boards[i].vendor,
234 boards[i].url ? "[" : "",
235 boards[i].url ? boards[i].url : "",
236 boards[i].name,
237 boards[i].url ? "]" : "",
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000238 b[k].lb_vendor ? "-p internal:mainboard=" : "&mdash;",
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000239 b[k].lb_vendor ? b[k].lb_vendor : "",
240 b[k].lb_vendor ? ":" : "",
241 b[k].lb_vendor ? b[k].lb_part : "",
Stefan Tauner618d8972014-05-28 13:02:13 +0000242 test_state_to_template(boards[i].working));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000243
Peter Lemenkov4adf8a62010-06-01 10:13:17 +0000244 if (boards[i].note) {
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000245 num_notes++;
246 printf(" <span id=\"%s_ref%d\"><sup>[[#%s_note%d|%d]]</sup></span>\n",
247 devicetype, num_notes, devicetype, num_notes, num_notes);
248 int ret = snprintf(tmp, sizeof(tmp),
249 "<span id=\"%s_note%d\">%d. [[#%s_ref%d|&#x2191;]]</span>"
250 " <nowiki>%s</nowiki><br />\n", devicetype, num_notes, num_notes,
251 devicetype, num_notes, boards[i].note);
252 if (ret < 0 || ret >= sizeof(tmp)) {
253 fprintf(stderr, "Footnote text #%d of %s truncated (ret=%d, sizeof(tmp)=%zu)\n",
254 num_notes, devicetype, ret, sizeof(tmp));
255 }
Mathias Krausea60faab2011-01-17 07:50:42 +0000256 notes = strcat_realloc(notes, tmp);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000257 } else {
258 printf("\n");
259 }
260
Stefan Tauner00ec0272012-07-29 02:04:21 +0000261 if (((i % lines_per_col) + 1) == lines_per_col)
262 printf("\n|}\n\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000263 }
264
Stefan Tauner00ec0272012-07-29 02:04:21 +0000265 /* end inner table if it did not fill the last column fully */
266 if (((i % lines_per_col)) > 0)
267 printf("\n|}\n\n");
Stefan Tauner352e50b2013-02-22 15:58:45 +0000268 printf("|}\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000269
270 if (num_notes > 0)
271 printf("\n<small>\n%s</small>\n", notes);
272 free(notes);
273}
274
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000275static void print_supported_boards_wiki(void)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000276{
277 printf("%s", board_intro);
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000278 print_supported_boards_wiki_helper("mainboards", 2, boards_known);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000279
280 printf("%s", laptop_intro);
Stefan Tauner74dc73f2015-03-01 22:04:38 +0000281 print_supported_boards_wiki_helper("mobile devices", 1, laptops_known);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000282}
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000283#endif
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000284
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000285static void print_supported_chips_wiki(int cols)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000286{
Stefan Tauner00ec0272012-07-29 02:04:21 +0000287 unsigned int lines_per_col;
Stefan Tauner00155492011-06-26 20:45:35 +0000288 char *s;
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000289 char vmax[6];
290 char vmin[6];
Stefan Tauner00ec0272012-07-29 02:04:21 +0000291 const struct flashchip *f, *old = NULL;
292 int i = 0, c = 1, chipcount = 0;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000293
Stefan Tauner93f70232011-07-26 14:33:46 +0000294 for (f = flashchips; f->name != NULL; f++) {
Stefan Tauner035492a2012-02-03 22:32:09 +0000295 /* Don't count generic entries. */
296 if (!strncmp(f->vendor, "Unknown", 7) ||
297 !strncmp(f->vendor, "Programmer", 10) ||
298 !strncmp(f->name, "unknown", 7))
Stefan Tauner4c5665f2012-02-17 20:03:37 +0000299 continue;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000300 chipcount++;
Stefan Tauner93f70232011-07-26 14:33:46 +0000301 }
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000302
Stefan Tauner00ec0272012-07-29 02:04:21 +0000303 /* +1 to force the resulting number of columns to be < cols */
304 lines_per_col = chipcount / cols + ((chipcount%cols) > 0 ? 1 : 0);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000305
Stefan Tauner1c356bb2013-07-11 13:48:52 +0000306 printf("%s", chip_intro);
307 printf("\nTotal amount of supported chips: '''%d'''\n\n"
Stefan Tauner00ec0272012-07-29 02:04:21 +0000308 "{| border=\"0\" valign=\"top\"\n", chipcount);
309
310 for (f = flashchips; f->name != NULL; f++) {
Stefan Tauner035492a2012-02-03 22:32:09 +0000311 /* Don't print generic entries. */
312 if (!strncmp(f->vendor, "Unknown", 7) ||
313 !strncmp(f->vendor, "Programmer", 10) ||
314 !strncmp(f->name, "unknown", 7))
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000315 continue;
316
Stefan Tauner00ec0272012-07-29 02:04:21 +0000317 if ((i % lines_per_col) == 0)
318 printf("%s%s", th_start, chip_th);
319
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000320 /* Alternate colors if the vendor changes. */
321 if (old != NULL && strcmp(old->vendor, f->vendor))
322 c = !c;
323
Stefan Tauner00ec0272012-07-29 02:04:21 +0000324 old = f;
Stefan Tauner00155492011-06-26 20:45:35 +0000325 s = flashbuses_to_text(f->bustype);
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000326 sprintf(vmin, "%0.03f", f->voltage.min / (double)1000);
327 sprintf(vmax, "%0.03f", f->voltage.max / (double)1000);
Stefan Taunerf74a7b92011-09-14 22:09:48 +0000328 printf("|- bgcolor=\"#%s\"\n| %s || %s || align=\"right\" | %d "
329 "|| %s || {{%s}} || {{%s}} || {{%s}} || {{%s}}"
330 "|| %s || %s \n",
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000331 (c == 1) ? "eeeeee" : "dddddd", f->vendor, f->name,
Stefan Tauner00155492011-06-26 20:45:35 +0000332 f->total_size, s,
Stefan Tauner618d8972014-05-28 13:02:13 +0000333 test_state_to_template(f->tested.probe),
334 test_state_to_template(f->tested.read),
335 test_state_to_template(f->tested.erase),
336 test_state_to_template(f->tested.write),
Stefan Tauner6455dff2014-05-26 00:36:24 +0000337 f->voltage.min ? vmin : "?",
338 f->voltage.max ? vmax : "?");
Stefan Tauner00155492011-06-26 20:45:35 +0000339 free(s);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000340
Stefan Tauner00ec0272012-07-29 02:04:21 +0000341 if (((i % lines_per_col) + 1) == lines_per_col)
342 printf("\n|}\n\n");
343 i++;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000344 }
Stefan Tauner00ec0272012-07-29 02:04:21 +0000345 /* end inner table if it did not fill the last column fully */
346 if (((i % lines_per_col)) > 0)
347 printf("\n|}\n\n");
348 printf("|}\n\n");
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000349}
350
Stefan Tauneraf358d62012-12-27 18:40:26 +0000351/* Following functions are not needed when no PCI/USB programmers are compiled in,
352 * but since print_wiki code has no size constraints we include it unconditionally. */
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000353static int count_supported_devs_wiki(const struct dev_entry *devs)
Stefan Tauneraf358d62012-12-27 18:40:26 +0000354{
355 unsigned int count = 0;
356 unsigned int i = 0;
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000357 for (i = 0; devs[i].vendor_id != 0; i++)
Stefan Tauneraf358d62012-12-27 18:40:26 +0000358 count++;
359 return count;
360}
361
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000362static void print_supported_devs_wiki_helper(const struct programmer_entry prog)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000363{
364 int i = 0;
365 static int c = 0;
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000366 const struct dev_entry *devs = prog.devs.dev;
367 const unsigned int count = count_supported_devs_wiki(devs);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000368
369 /* Alternate colors if the vendor changes. */
370 c = !c;
371
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000372 for (i = 0; devs[i].vendor_id != 0; i++) {
373 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
374 if (i == 0)
375 printf("| rowspan=\"%u\" | %s |", count, prog.name);
376 printf("| %s || %s || %04x:%04x || {{%s}}\n", devs[i].vendor_name, devs[i].device_name,
Stefan Tauner618d8972014-05-28 13:02:13 +0000377 devs[i].vendor_id, devs[i].device_id, test_state_to_template(devs[i].status));
Stefan Tauneraf358d62012-12-27 18:40:26 +0000378 }
379}
380
381static void print_supported_devs_wiki()
382{
383 unsigned int pci_count = 0;
384 unsigned int usb_count = 0;
385 unsigned int i;
386
387 for (i = 0; i < PROGRAMMER_INVALID; i++) {
388 const struct programmer_entry prog = programmer_table[i];
389 switch (prog.type) {
390 case USB:
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000391 usb_count += count_supported_devs_wiki(prog.devs.dev);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000392 break;
393 case PCI:
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000394 pci_count += count_supported_devs_wiki(prog.devs.dev);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000395 break;
396 case OTHER:
397 default:
398 break;
399 }
400 }
401
402 printf("\n== PCI Devices ==\n\n"
403 "Total amount of supported PCI devices flashrom can use as a programmer: '''%d'''\n\n"
404 "{%s%s", pci_count, th_start, programmer_th);
405
406 for (i = 0; i < PROGRAMMER_INVALID; i++) {
407 const struct programmer_entry prog = programmer_table[i];
408 if (prog.type == PCI) {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000409 print_supported_devs_wiki_helper(prog);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000410 }
411 }
412 printf("\n|}\n\n|}\n");
413
414 printf("\n== USB Devices ==\n\n"
415 "Total amount of supported USB devices flashrom can use as a programmer: '''%d'''\n\n"
416 "{%s%s", usb_count, th_start, programmer_th);
417
418 for (i = 0; i < PROGRAMMER_INVALID; i++) {
419 const struct programmer_entry prog = programmer_table[i];
420 if (prog.type == USB) {
Stefan Tauner4b24a2d2012-12-27 18:40:36 +0000421 print_supported_devs_wiki_helper(prog);
Stefan Tauneraf358d62012-12-27 18:40:26 +0000422 }
423 }
424 printf("\n|}\n\n|}\n");
Stefan Tauner2c421192012-12-27 18:40:40 +0000425
426 printf("\n== Other programmers ==\n\n"
427 "{%s", th_start);
428 printf("! align=\"left\" | Programmer\n"
429 "! align=\"left\" | Note\n\n");
430
431 for (i = 0; i < PROGRAMMER_INVALID; i++) {
432 static int c = 0;
433 const struct programmer_entry prog = programmer_table[i];
434 if (prog.type == OTHER && prog.devs.note != NULL) {
435 c = !c;
436 printf("|- bgcolor=\"#%s\"\n", (c) ? "eeeeee" : "dddddd");
437 printf("| %s || %s", prog.name, prog.devs.note);
438 }
439 }
440 printf("\n|}\n\n|}\n");
Stefan Tauneraf358d62012-12-27 18:40:26 +0000441}
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000442
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +0000443void print_supported_wiki(void)
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000444{
445 time_t t = time(NULL);
Stefan Tauner2a10e702014-06-02 00:46:02 +0000446 char buf[sizeof("1986-02-28T12:37:42Z")];
447 strftime(buf, sizeof(buf), "%Y-%m-%dT%H:%M:%SZ", gmtime(&t));
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000448
Stefan Tauner2a10e702014-06-02 00:46:02 +0000449 printf(wiki_header, buf, flashrom_version);
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000450 print_supported_chips_wiki(2);
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000451#if CONFIG_INTERNAL == 1
Uwe Hermanna6d9c4b2010-05-24 15:28:12 +0000452 print_supported_chipsets_wiki(3);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000453 print_supported_boards_wiki();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000454#endif
Stefan Tauneraf358d62012-12-27 18:40:26 +0000455 print_supported_devs_wiki();
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000456}
457