Patrick Georgi | ea063cb | 2020-05-08 19:28:13 +0200 | [diff] [blame] | 1 | /* ifdtool - dump Intel Firmware Descriptor information */ |
Patrick Georgi | 7333a11 | 2020-05-08 20:48:04 +0200 | [diff] [blame] | 2 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 3 | |
| 4 | #include <stdint.h> |
Bill XIE | b3e15a2 | 2017-09-07 18:34:50 +0800 | [diff] [blame] | 5 | #include <stdbool.h> |
Duncan Laurie | 1f7fd72 | 2015-06-22 11:14:48 -0700 | [diff] [blame] | 6 | #define IFDTOOL_VERSION "1.2" |
| 7 | |
| 8 | enum ifd_version { |
| 9 | IFD_VERSION_1, |
| 10 | IFD_VERSION_2, |
| 11 | }; |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 12 | |
Bill XIE | b3e15a2 | 2017-09-07 18:34:50 +0800 | [diff] [blame] | 13 | /* port from flashrom */ |
| 14 | enum ich_chipset { |
| 15 | CHIPSET_ICH_UNKNOWN, |
| 16 | CHIPSET_ICH, |
| 17 | CHIPSET_ICH2345, |
| 18 | CHIPSET_ICH6, |
| 19 | CHIPSET_POULSBO, /* SCH U* */ |
| 20 | CHIPSET_TUNNEL_CREEK, /* Atom E6xx */ |
| 21 | CHIPSET_CENTERTON, /* Atom S1220 S1240 S1260 */ |
| 22 | CHIPSET_ICH7, |
| 23 | CHIPSET_ICH8, |
| 24 | CHIPSET_ICH9, |
| 25 | CHIPSET_ICH10, |
Subrata Banik | 89db225 | 2020-08-26 14:49:17 +0530 | [diff] [blame] | 26 | CHIPSET_PCH_UNKNOWN, |
Bill XIE | b3e15a2 | 2017-09-07 18:34:50 +0800 | [diff] [blame] | 27 | CHIPSET_5_SERIES_IBEX_PEAK, |
| 28 | CHIPSET_6_SERIES_COUGAR_POINT, |
| 29 | CHIPSET_7_SERIES_PANTHER_POINT, |
| 30 | CHIPSET_8_SERIES_LYNX_POINT, |
| 31 | CHIPSET_BAYTRAIL, /* Actually all with Silvermont architecture: |
| 32 | * Bay Trail, Avoton/Rangeley |
| 33 | */ |
| 34 | CHIPSET_8_SERIES_LYNX_POINT_LP, |
| 35 | CHIPSET_8_SERIES_WELLSBURG, |
| 36 | CHIPSET_9_SERIES_WILDCAT_POINT, |
| 37 | CHIPSET_9_SERIES_WILDCAT_POINT_LP, |
Subrata Banik | 8c082e5 | 2021-06-10 23:02:29 +0530 | [diff] [blame] | 38 | CHIPSET_N_J_SERIES_APOLLO_LAKE, /* Apollo Lake: N3xxx, J3xxx */ |
| 39 | CHIPSET_N_J_SERIES_GEMINI_LAKE, /* Gemini Lake: N5xxx, J5xxx, N4xxx, J4xxx */ |
| 40 | CHIPSET_N_SERIES_JASPER_LAKE, /* Jasper Lake: N6xxx, N51xx, N45xx */ |
| 41 | CHIPSET_x6000_SERIES_ELKHART_LAKE, /* Elkhart Lake: x6000 */ |
Subrata Banik | 89db225 | 2020-08-26 14:49:17 +0530 | [diff] [blame] | 42 | CHIPSET_100_200_SERIES_SUNRISE_POINT, /* 6th-7th gen Core i/o (LP) variants */ |
Subrata Banik | 8c082e5 | 2021-06-10 23:02:29 +0530 | [diff] [blame] | 43 | CHIPSET_300_SERIES_CANNON_POINT, /* 8th-9th gen Core i/o (LP) variants */ |
| 44 | CHIPSET_400_SERIES_ICE_POINT, /* 10th gen Core i/o (LP) variants */ |
Subrata Banik | a5f4781 | 2020-09-29 11:43:01 +0530 | [diff] [blame] | 45 | CHIPSET_500_600_SERIES_TIGER_ALDER_POINT, /* 11th-12th gen Core i/o (LP) |
| 46 | * variants onwards */ |
Bill XIE | b3e15a2 | 2017-09-07 18:34:50 +0800 | [diff] [blame] | 47 | CHIPSET_C620_SERIES_LEWISBURG, |
Jeff Daly | abd4b96 | 2022-01-06 00:52:30 -0500 | [diff] [blame] | 48 | CHIPSET_DENVERTON, |
Bill XIE | b3e15a2 | 2017-09-07 18:34:50 +0800 | [diff] [blame] | 49 | }; |
| 50 | |
Andrey Petrov | 96ecb77 | 2016-10-31 19:31:54 -0700 | [diff] [blame] | 51 | enum platform { |
Furquan Shaikh | c0257dd | 2018-05-02 23:29:04 -0700 | [diff] [blame] | 52 | PLATFORM_APL, |
| 53 | PLATFORM_CNL, |
Johnny Lin | e273a02 | 2021-06-22 11:26:46 +0800 | [diff] [blame] | 54 | PLATFORM_LBG, |
Lean Sheng Tan | 0faba3c | 2021-06-09 07:52:24 -0700 | [diff] [blame] | 55 | PLATFORM_EHL, |
Furquan Shaikh | c0257dd | 2018-05-02 23:29:04 -0700 | [diff] [blame] | 56 | PLATFORM_GLK, |
Aamir Bohra | 1018be2 | 2018-06-29 15:08:50 +0530 | [diff] [blame] | 57 | PLATFORM_ICL, |
rkanabar | d64b046 | 2019-08-30 11:40:08 +0530 | [diff] [blame] | 58 | PLATFORM_JSL, |
Furquan Shaikh | 088b6e8 | 2018-03-21 10:42:37 -0700 | [diff] [blame] | 59 | PLATFORM_SKLKBL, |
Ravi Sarawadi | 7d9d63b | 2019-10-22 13:45:36 -0700 | [diff] [blame] | 60 | PLATFORM_TGL, |
Subrata Banik | 46f8073 | 2020-03-14 15:01:42 +0530 | [diff] [blame] | 61 | PLATFORM_ADL, |
Wonkyu Kim | 3922aa5 | 2022-02-02 15:19:05 -0800 | [diff] [blame] | 62 | PLATFORM_IFD2, |
Jeff Daly | abd4b96 | 2022-01-06 00:52:30 -0500 | [diff] [blame] | 63 | PLATFORM_DNV, |
Subrata Banik | ca82e61 | 2022-01-20 18:51:21 +0530 | [diff] [blame^] | 64 | PLATFORM_MTL, |
Andrey Petrov | 96ecb77 | 2016-10-31 19:31:54 -0700 | [diff] [blame] | 65 | }; |
| 66 | |
Chris Douglass | 03ce014 | 2014-02-26 13:30:13 -0500 | [diff] [blame] | 67 | #define LAYOUT_LINELEN 80 |
| 68 | |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 69 | enum spi_frequency { |
| 70 | SPI_FREQUENCY_20MHZ = 0, |
| 71 | SPI_FREQUENCY_33MHZ = 1, |
Duncan Laurie | 1f7fd72 | 2015-06-22 11:14:48 -0700 | [diff] [blame] | 72 | SPI_FREQUENCY_48MHZ = 2, |
| 73 | SPI_FREQUENCY_50MHZ_30MHZ = 4, |
| 74 | SPI_FREQUENCY_17MHZ = 6, |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 75 | }; |
| 76 | |
Subrata Banik | d16ef4d | 2020-08-26 15:53:00 +0530 | [diff] [blame] | 77 | enum spi_frequency_500_series { |
| 78 | SPI_FREQUENCY_100MHZ = 0, |
| 79 | SPI_FREQUENCY_50MHZ = 1, |
| 80 | SPI_FREQUENCY_500SERIES_33MHZ = 3, |
| 81 | SPI_FREQUENCY_25MHZ = 4, |
| 82 | SPI_FREQUENCY_14MHZ = 6, |
| 83 | }; |
| 84 | |
Subrata Banik | e5d3992 | 2020-08-26 16:01:42 +0530 | [diff] [blame] | 85 | enum espi_frequency { |
| 86 | ESPI_FREQUENCY_20MHZ = 0, |
| 87 | ESPI_FREQUENCY_24MHZ = 1, |
| 88 | ESPI_FREQUENCY_30MHZ = 2, |
| 89 | ESPI_FREQUENCY_48MHZ = 3, |
| 90 | ESPI_FREQUENCY_60MHZ = 4, |
| 91 | ESPI_FREQUENCY_17MHZ = 6, |
| 92 | }; |
| 93 | |
| 94 | enum espi_frequency_500_series { |
| 95 | ESPI_FREQUENCY_500SERIES_20MHZ = 0, |
| 96 | ESPI_FREQUENCY_500SERIES_24MHZ = 1, |
| 97 | ESPI_FREQUENCY_500SERIES_25MHZ = 2, |
| 98 | ESPI_FREQUENCY_500SERIES_48MHZ = 3, |
| 99 | ESPI_FREQUENCY_500SERIES_60MHZ = 4, |
| 100 | }; |
| 101 | |
Stefan Reinauer | 1b1309f | 2012-05-11 15:53:43 -0700 | [diff] [blame] | 102 | enum component_density { |
| 103 | COMPONENT_DENSITY_512KB = 0, |
| 104 | COMPONENT_DENSITY_1MB = 1, |
| 105 | COMPONENT_DENSITY_2MB = 2, |
| 106 | COMPONENT_DENSITY_4MB = 3, |
| 107 | COMPONENT_DENSITY_8MB = 4, |
| 108 | COMPONENT_DENSITY_16MB = 5, |
Duncan Laurie | 1f7fd72 | 2015-06-22 11:14:48 -0700 | [diff] [blame] | 109 | COMPONENT_DENSITY_32MB = 6, |
| 110 | COMPONENT_DENSITY_64MB = 7, |
| 111 | COMPONENT_DENSITY_UNUSED = 0xf |
Stefan Reinauer | 1b1309f | 2012-05-11 15:53:43 -0700 | [diff] [blame] | 112 | }; |
| 113 | |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 114 | // flash descriptor |
| 115 | typedef struct { |
| 116 | uint32_t flvalsig; |
| 117 | uint32_t flmap0; |
| 118 | uint32_t flmap1; |
| 119 | uint32_t flmap2; |
Subrata Banik | bd2da5a | 2020-08-26 15:43:51 +0530 | [diff] [blame] | 120 | uint32_t flmap3; // Exist for 500 series onwards |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 121 | } __attribute__((packed)) fdbar_t; |
| 122 | |
| 123 | // regions |
Jeff Daly | 3623eca | 2022-01-05 23:51:40 -0500 | [diff] [blame] | 124 | #define MAX_REGIONS 16 |
Duncan Laurie | 1f7fd72 | 2015-06-22 11:14:48 -0700 | [diff] [blame] | 125 | #define MAX_REGIONS_OLD 5 |
Bill XIE | 4651d45 | 2017-09-12 11:54:48 +0800 | [diff] [blame] | 126 | |
Duncan Laurie | 7775d67 | 2019-06-06 13:39:26 -0700 | [diff] [blame] | 127 | enum flash_regions { |
| 128 | REGION_DESC, |
| 129 | REGION_BIOS, |
| 130 | REGION_ME, |
| 131 | REGION_GBE, |
| 132 | REGION_PDR, |
Jeff Daly | 3623eca | 2022-01-05 23:51:40 -0500 | [diff] [blame] | 133 | REGION_DEV_EXP1, |
| 134 | REGION_BIOS2, |
Duncan Laurie | 7775d67 | 2019-06-06 13:39:26 -0700 | [diff] [blame] | 135 | REGION_EC = 8, |
Jeff Daly | 3623eca | 2022-01-05 23:51:40 -0500 | [diff] [blame] | 136 | REGION_DEV_EXP2, |
| 137 | REGION_IE, |
| 138 | REGION_10GB_0, |
| 139 | REGION_10GB_1, |
| 140 | REGION_PTT = 15, |
Duncan Laurie | 7775d67 | 2019-06-06 13:39:26 -0700 | [diff] [blame] | 141 | }; |
| 142 | |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 143 | typedef struct { |
Bill XIE | 4651d45 | 2017-09-12 11:54:48 +0800 | [diff] [blame] | 144 | uint32_t flreg[MAX_REGIONS]; |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 145 | } __attribute__((packed)) frba_t; |
| 146 | |
| 147 | // component section |
| 148 | typedef struct { |
| 149 | uint32_t flcomp; |
| 150 | uint32_t flill; |
| 151 | uint32_t flpb; |
| 152 | } __attribute__((packed)) fcba_t; |
| 153 | |
| 154 | // pch strap |
Patrick Rudolph | 802cbee | 2020-05-25 12:18:11 +0200 | [diff] [blame] | 155 | #define MAX_PCHSTRP 1024 |
Bill XIE | 4651d45 | 2017-09-12 11:54:48 +0800 | [diff] [blame] | 156 | |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 157 | typedef struct { |
Bill XIE | 4651d45 | 2017-09-12 11:54:48 +0800 | [diff] [blame] | 158 | uint32_t pchstrp[MAX_PCHSTRP]; |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 159 | } __attribute__((packed)) fpsba_t; |
| 160 | |
Shawn Nematbakhsh | d2cb118 | 2015-09-10 19:07:13 -0700 | [diff] [blame] | 161 | /* |
| 162 | * WR / RD bits start at different locations within the flmstr regs, but |
| 163 | * otherwise have identical meaning. |
| 164 | */ |
| 165 | #define FLMSTR_WR_SHIFT_V1 24 |
| 166 | #define FLMSTR_WR_SHIFT_V2 20 |
| 167 | #define FLMSTR_RD_SHIFT_V1 16 |
| 168 | #define FLMSTR_RD_SHIFT_V2 8 |
| 169 | |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 170 | // master |
| 171 | typedef struct { |
| 172 | uint32_t flmstr1; |
| 173 | uint32_t flmstr2; |
| 174 | uint32_t flmstr3; |
Duncan Laurie | 1f7fd72 | 2015-06-22 11:14:48 -0700 | [diff] [blame] | 175 | uint32_t flmstr4; |
| 176 | uint32_t flmstr5; |
Jeff Daly | abd4b96 | 2022-01-06 00:52:30 -0500 | [diff] [blame] | 177 | uint32_t flmstr6; |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 178 | } __attribute__((packed)) fmba_t; |
| 179 | |
| 180 | // processor strap |
| 181 | typedef struct { |
| 182 | uint32_t data[8]; |
| 183 | } __attribute__((packed)) fmsba_t; |
| 184 | |
Stefan Reinauer | 4a17d29 | 2012-09-27 12:42:15 -0700 | [diff] [blame] | 185 | // ME VSCC |
| 186 | typedef struct { |
| 187 | uint32_t jid; |
| 188 | uint32_t vscc; |
| 189 | } vscc_t; |
Stefan Reinauer | 1c795ad1 | 2011-10-14 12:49:41 -0700 | [diff] [blame] | 190 | |
Stefan Reinauer | 4a17d29 | 2012-09-27 12:42:15 -0700 | [diff] [blame] | 191 | typedef struct { |
| 192 | // Actual number of entries specified in vtl |
Stefan Tauner | 0d22614 | 2018-08-05 18:56:53 +0200 | [diff] [blame] | 193 | /* FIXME: Rationale for the limit of 8. |
| 194 | * AFAICT it's 127, cf. flashrom's ich_descriptors_tool). */ |
Stefan Reinauer | 4a17d29 | 2012-09-27 12:42:15 -0700 | [diff] [blame] | 195 | vscc_t entry[8]; |
| 196 | } vtba_t; |
| 197 | |
| 198 | typedef struct { |
| 199 | int base, limit, size; |
| 200 | } region_t; |
Chris Douglass | 03ce014 | 2014-02-26 13:30:13 -0500 | [diff] [blame] | 201 | |
| 202 | struct region_name { |
Bill XIE | fa5f994 | 2017-09-12 11:22:29 +0800 | [diff] [blame] | 203 | const char *pretty; |
| 204 | const char *terse; |
Bill XIE | 1bf6506 | 2017-09-12 11:31:37 +0800 | [diff] [blame] | 205 | const char *filename; |
Mathew King | c7ddc99 | 2019-08-08 14:59:25 -0600 | [diff] [blame] | 206 | const char *fmapname; |
Chris Douglass | 03ce014 | 2014-02-26 13:30:13 -0500 | [diff] [blame] | 207 | }; |