blob: dd972d2b4e4f0a3b707c2cf4b24f7aac7895dfdd [file] [log] [blame]
Angel Pons182dbde2020-04-02 23:49:05 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Stefan Reinauer8e073822012-04-04 00:07:22 +02002
3/*
4 * This is a ramstage driver for the Intel Management Engine found in the
5 * 6-series chipset. It handles the required boot-time messages over the
6 * MMIO-based Management Engine Interface to tell the ME that the BIOS is
7 * finished with POST. Additional messages are defined for debug but are
8 * not used unless the console loglevel is high enough.
9 */
10
Furquan Shaikh76cedd22020-05-02 10:24:23 -070011#include <acpi/acpi.h>
Kyösti Mälkki13f66502019-03-03 08:01:05 +020012#include <device/mmio.h>
Kyösti Mälkki21d6a272019-11-05 18:50:38 +020013#include <device/device.h>
14#include <device/pci.h>
Kyösti Mälkkif1b58b72019-03-01 13:43:02 +020015#include <device/pci_ops.h>
Stefan Reinauer8e073822012-04-04 00:07:22 +020016#include <console/console.h>
17#include <device/pci_ids.h>
18#include <device/pci_def.h>
19#include <string.h>
20#include <delay.h>
Duncan Lauriec1c94352012-07-13 10:11:54 -070021#include <elog.h>
Patrick Georgi546953c2014-11-29 10:38:17 +010022#include <halt.h>
Stefan Reinauer8e073822012-04-04 00:07:22 +020023
Stefan Reinauer8e073822012-04-04 00:07:22 +020024#include "me.h"
25#include "pch.h"
26
Julius Wernercd49cce2019-03-05 16:53:33 -080027#if CONFIG(CHROMEOS)
Stefan Reinauer49058c02012-06-11 14:13:09 -070028#include <vendorcode/google/chromeos/gnvs.h>
Stefan Reinauer8e073822012-04-04 00:07:22 +020029#endif
30
Stefan Reinauer8e073822012-04-04 00:07:22 +020031/* Path that the BIOS should take based on ME state */
Angel Pons7f32df32020-06-02 13:36:57 +020032static const char *me_bios_path_values[] __unused = {
Stefan Reinauer8e073822012-04-04 00:07:22 +020033 [ME_NORMAL_BIOS_PATH] = "Normal",
34 [ME_S3WAKE_BIOS_PATH] = "S3 Wake",
35 [ME_ERROR_BIOS_PATH] = "Error",
36 [ME_RECOVERY_BIOS_PATH] = "Recovery",
37 [ME_DISABLE_BIOS_PATH] = "Disable",
38 [ME_FIRMWARE_UPDATE_BIOS_PATH] = "Firmware Update",
39};
Stefan Reinauer8e073822012-04-04 00:07:22 +020040
41/* MMIO base address for MEI interface */
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -080042static u32 *mei_base_address;
Stefan Reinauer8e073822012-04-04 00:07:22 +020043
Stefan Reinauer8e073822012-04-04 00:07:22 +020044static void mei_dump(void *ptr, int dword, int offset, const char *type)
45{
46 struct mei_csr *csr;
47
Kyösti Mälkkic86fc8e2019-11-06 06:32:27 +020048 if (!CONFIG(DEBUG_INTEL_ME))
49 return;
50
Stefan Reinauer8e073822012-04-04 00:07:22 +020051 printk(BIOS_SPEW, "%-9s[%02x] : ", type, offset);
52
53 switch (offset) {
54 case MEI_H_CSR:
55 case MEI_ME_CSR_HA:
56 csr = ptr;
57 if (!csr) {
58 printk(BIOS_SPEW, "ERROR: 0x%08x\n", dword);
59 break;
60 }
61 printk(BIOS_SPEW, "cbd=%u cbrp=%02u cbwp=%02u ready=%u "
62 "reset=%u ig=%u is=%u ie=%u\n", csr->buffer_depth,
63 csr->buffer_read_ptr, csr->buffer_write_ptr,
64 csr->ready, csr->reset, csr->interrupt_generate,
65 csr->interrupt_status, csr->interrupt_enable);
66 break;
67 case MEI_ME_CB_RW:
68 case MEI_H_CB_WW:
69 printk(BIOS_SPEW, "CB: 0x%08x\n", dword);
70 break;
71 default:
72 printk(BIOS_SPEW, "0x%08x\n", offset);
73 break;
74 }
75}
Stefan Reinauer8e073822012-04-04 00:07:22 +020076
77/*
78 * ME/MEI access helpers using memcpy to avoid aliasing.
79 */
80
81static inline void mei_read_dword_ptr(void *ptr, int offset)
82{
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -080083 u32 dword = read32(mei_base_address + (offset/sizeof(u32)));
Stefan Reinauer8e073822012-04-04 00:07:22 +020084 memcpy(ptr, &dword, sizeof(dword));
85 mei_dump(ptr, dword, offset, "READ");
86}
87
88static inline void mei_write_dword_ptr(void *ptr, int offset)
89{
90 u32 dword = 0;
91 memcpy(&dword, ptr, sizeof(dword));
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -080092 write32(mei_base_address + (offset/sizeof(u32)), dword);
Stefan Reinauer8e073822012-04-04 00:07:22 +020093 mei_dump(ptr, dword, offset, "WRITE");
94}
95
Kyösti Mälkki21d6a272019-11-05 18:50:38 +020096#ifndef __SIMPLE_DEVICE__
Elyes HAOUASdc035282018-09-18 13:28:49 +020097static inline void pci_read_dword_ptr(struct device *dev, void *ptr, int offset)
Stefan Reinauer8e073822012-04-04 00:07:22 +020098{
99 u32 dword = pci_read_config32(dev, offset);
100 memcpy(ptr, &dword, sizeof(dword));
101 mei_dump(ptr, dword, offset, "PCI READ");
102}
103#endif
104
105static inline void read_host_csr(struct mei_csr *csr)
106{
107 mei_read_dword_ptr(csr, MEI_H_CSR);
108}
109
110static inline void write_host_csr(struct mei_csr *csr)
111{
112 mei_write_dword_ptr(csr, MEI_H_CSR);
113}
114
115static inline void read_me_csr(struct mei_csr *csr)
116{
117 mei_read_dword_ptr(csr, MEI_ME_CSR_HA);
118}
119
120static inline void write_cb(u32 dword)
121{
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -0800122 write32(mei_base_address + (MEI_H_CB_WW/sizeof(u32)), dword);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200123 mei_dump(NULL, dword, MEI_H_CB_WW, "WRITE");
124}
125
126static inline u32 read_cb(void)
127{
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -0800128 u32 dword = read32(mei_base_address + (MEI_ME_CB_RW/sizeof(u32)));
Stefan Reinauer8e073822012-04-04 00:07:22 +0200129 mei_dump(NULL, dword, MEI_ME_CB_RW, "READ");
130 return dword;
131}
132
133/* Wait for ME ready bit to be asserted */
134static int mei_wait_for_me_ready(void)
135{
136 struct mei_csr me;
Martin Rothff744bf2019-10-23 21:46:03 -0600137 unsigned int try = ME_RETRY;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200138
139 while (try--) {
140 read_me_csr(&me);
141 if (me.ready)
142 return 0;
143 udelay(ME_DELAY);
144 }
145
146 printk(BIOS_ERR, "ME: failed to become ready\n");
147 return -1;
148}
149
150static void mei_reset(void)
151{
152 struct mei_csr host;
153
154 if (mei_wait_for_me_ready() < 0)
155 return;
156
157 /* Reset host and ME circular buffers for next message */
158 read_host_csr(&host);
159 host.reset = 1;
160 host.interrupt_generate = 1;
161 write_host_csr(&host);
162
163 if (mei_wait_for_me_ready() < 0)
164 return;
165
166 /* Re-init and indicate host is ready */
167 read_host_csr(&host);
168 host.interrupt_generate = 1;
169 host.ready = 1;
170 host.reset = 0;
171 write_host_csr(&host);
172}
173
174static int mei_send_msg(struct mei_header *mei, struct mkhi_header *mkhi,
175 void *req_data)
176{
177 struct mei_csr host;
Martin Rothff744bf2019-10-23 21:46:03 -0600178 unsigned int ndata, n;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200179 u32 *data;
180
181 /* Number of dwords to write, ignoring MKHI */
182 ndata = mei->length >> 2;
183
184 /* Pad non-dword aligned request message length */
185 if (mei->length & 3)
186 ndata++;
187 if (!ndata) {
188 printk(BIOS_DEBUG, "ME: request does not include MKHI\n");
189 return -1;
190 }
191 ndata++; /* Add MEI header */
192
193 /*
194 * Make sure there is still room left in the circular buffer.
195 * Reset the buffer pointers if the requested message will not fit.
196 */
197 read_host_csr(&host);
198 if ((host.buffer_depth - host.buffer_write_ptr) < ndata) {
199 printk(BIOS_ERR, "ME: circular buffer full, resetting...\n");
200 mei_reset();
201 read_host_csr(&host);
202 }
203
204 /*
205 * This implementation does not handle splitting large messages
206 * across multiple transactions. Ensure the requested length
207 * will fit in the available circular buffer depth.
208 */
209 if ((host.buffer_depth - host.buffer_write_ptr) < ndata) {
210 printk(BIOS_ERR, "ME: message (%u) too large for buffer (%u)\n",
211 ndata + 2, host.buffer_depth);
212 return -1;
213 }
214
215 /* Write MEI header */
216 mei_write_dword_ptr(mei, MEI_H_CB_WW);
217 ndata--;
218
219 /* Write MKHI header */
220 mei_write_dword_ptr(mkhi, MEI_H_CB_WW);
221 ndata--;
222
223 /* Write message data */
224 data = req_data;
225 for (n = 0; n < ndata; ++n)
226 write_cb(*data++);
227
228 /* Generate interrupt to the ME */
229 read_host_csr(&host);
230 host.interrupt_generate = 1;
231 write_host_csr(&host);
232
233 /* Make sure ME is ready after sending request data */
234 return mei_wait_for_me_ready();
235}
236
237static int mei_recv_msg(struct mkhi_header *mkhi,
238 void *rsp_data, int rsp_bytes)
239{
240 struct mei_header mei_rsp;
241 struct mkhi_header mkhi_rsp;
242 struct mei_csr me, host;
Martin Rothff744bf2019-10-23 21:46:03 -0600243 unsigned int ndata, n/*, me_data_len*/;
244 unsigned int expected;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200245 u32 *data;
246
247 /* Total number of dwords to read from circular buffer */
248 expected = (rsp_bytes + sizeof(mei_rsp) + sizeof(mkhi_rsp)) >> 2;
249 if (rsp_bytes & 3)
250 expected++;
251
252 /*
253 * The interrupt status bit does not appear to indicate that the
254 * message has actually been received. Instead we wait until the
255 * expected number of dwords are present in the circular buffer.
256 */
257 for (n = ME_RETRY; n; --n) {
258 read_me_csr(&me);
259 if ((me.buffer_write_ptr - me.buffer_read_ptr) >= expected)
260 break;
261 udelay(ME_DELAY);
262 }
263 if (!n) {
264 printk(BIOS_ERR, "ME: timeout waiting for data: expected "
265 "%u, available %u\n", expected,
266 me.buffer_write_ptr - me.buffer_read_ptr);
267 return -1;
268 }
269
270 /* Read and verify MEI response header from the ME */
271 mei_read_dword_ptr(&mei_rsp, MEI_ME_CB_RW);
272 if (!mei_rsp.is_complete) {
273 printk(BIOS_ERR, "ME: response is not complete\n");
274 return -1;
275 }
276
277 /* Handle non-dword responses and expect at least MKHI header */
278 ndata = mei_rsp.length >> 2;
279 if (mei_rsp.length & 3)
280 ndata++;
281 if (ndata != (expected - 1)) {
282 printk(BIOS_ERR, "ME: response is missing data %d != %d\n",
283 ndata, (expected - 1));
284 return -1;
285 }
286
287 /* Read and verify MKHI response header from the ME */
288 mei_read_dword_ptr(&mkhi_rsp, MEI_ME_CB_RW);
289 if (!mkhi_rsp.is_response ||
290 mkhi->group_id != mkhi_rsp.group_id ||
291 mkhi->command != mkhi_rsp.command) {
Angel Pons7f32df32020-06-02 13:36:57 +0200292 printk(BIOS_ERR, "ME: invalid response, group %u ?= %u, "
Stefan Reinauer8e073822012-04-04 00:07:22 +0200293 "command %u ?= %u, is_response %u\n", mkhi->group_id,
294 mkhi_rsp.group_id, mkhi->command, mkhi_rsp.command,
295 mkhi_rsp.is_response);
296 return -1;
297 }
298 ndata--; /* MKHI header has been read */
299
300 /* Make sure caller passed a buffer with enough space */
301 if (ndata != (rsp_bytes >> 2)) {
302 printk(BIOS_ERR, "ME: not enough room in response buffer: "
303 "%u != %u\n", ndata, rsp_bytes >> 2);
304 return -1;
305 }
306
307 /* Read response data from the circular buffer */
308 data = rsp_data;
309 for (n = 0; n < ndata; ++n)
310 *data++ = read_cb();
311
312 /* Tell the ME that we have consumed the response */
313 read_host_csr(&host);
314 host.interrupt_status = 1;
315 host.interrupt_generate = 1;
316 write_host_csr(&host);
317
318 return mei_wait_for_me_ready();
319}
320
321static inline int mei_sendrecv(struct mei_header *mei, struct mkhi_header *mkhi,
322 void *req_data, void *rsp_data, int rsp_bytes)
323{
324 if (mei_send_msg(mei, mkhi, req_data) < 0)
325 return -1;
326 if (mei_recv_msg(mkhi, rsp_data, rsp_bytes) < 0)
327 return -1;
328 return 0;
329}
330
Stefan Reinauer8e073822012-04-04 00:07:22 +0200331static inline void print_cap(const char *name, int state)
332{
333 printk(BIOS_DEBUG, "ME Capability: %-41s : %sabled\n",
334 name, state ? " en" : "dis");
335}
336
Kyösti Mälkkic86fc8e2019-11-06 06:32:27 +0200337static void __unused me_print_fw_version(mbp_fw_version_name *vers_name)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200338{
339 if (!vers_name->major_version) {
340 printk(BIOS_ERR, "ME: mbp missing version report\n");
341 return;
342 }
343
344 printk(BIOS_DEBUG, "ME: found version %d.%d.%d.%d\n",
345 vers_name->major_version, vers_name->minor_version,
346 vers_name->hotfix_version, vers_name->build_version);
347}
348
349/* Get ME Firmware Capabilities */
350static int mkhi_get_fwcaps(mefwcaps_sku *cap)
351{
352 u32 rule_id = 0;
353 struct me_fwcaps cap_msg;
354 struct mkhi_header mkhi = {
355 .group_id = MKHI_GROUP_ID_FWCAPS,
356 .command = MKHI_FWCAPS_GET_RULE,
357 };
358 struct mei_header mei = {
359 .is_complete = 1,
360 .host_address = MEI_HOST_ADDRESS,
361 .client_address = MEI_ADDRESS_MKHI,
362 .length = sizeof(mkhi) + sizeof(rule_id),
363 };
364
365 /* Send request and wait for response */
Edward O'Callaghan152e5172014-07-13 00:28:05 +1000366 if (mei_sendrecv(&mei, &mkhi, &rule_id, &cap_msg, sizeof(cap_msg)) < 0) {
Stefan Reinauer8e073822012-04-04 00:07:22 +0200367 printk(BIOS_ERR, "ME: GET FWCAPS message failed\n");
368 return -1;
Edward O'Callaghan152e5172014-07-13 00:28:05 +1000369 }
Stefan Reinauer8e073822012-04-04 00:07:22 +0200370 *cap = cap_msg.caps_sku;
371 return 0;
372}
373
374/* Get ME Firmware Capabilities */
Kyösti Mälkkic86fc8e2019-11-06 06:32:27 +0200375static void __unused me_print_fwcaps(mbp_fw_caps *caps_section)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200376{
377 mefwcaps_sku *cap = &caps_section->fw_capabilities;
378 if (!caps_section->available) {
379 printk(BIOS_ERR, "ME: mbp missing fwcaps report\n");
380 if (mkhi_get_fwcaps(cap))
381 return;
382 }
383
384 print_cap("Full Network manageability", cap->full_net);
385 print_cap("Regular Network manageability", cap->std_net);
386 print_cap("Manageability", cap->manageability);
387 print_cap("Small business technology", cap->small_business);
388 print_cap("Level III manageability", cap->l3manageability);
389 print_cap("IntelR Anti-Theft (AT)", cap->intel_at);
390 print_cap("IntelR Capability Licensing Service (CLS)", cap->intel_cls);
391 print_cap("IntelR Power Sharing Technology (MPC)", cap->intel_mpc);
392 print_cap("ICC Over Clocking", cap->icc_over_clocking);
Edward O'Callaghan152e5172014-07-13 00:28:05 +1000393 print_cap("Protected Audio Video Path (PAVP)", cap->pavp);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200394 print_cap("IPV6", cap->ipv6);
395 print_cap("KVM Remote Control (KVM)", cap->kvm);
396 print_cap("Outbreak Containment Heuristic (OCH)", cap->och);
397 print_cap("Virtual LAN (VLAN)", cap->vlan);
398 print_cap("TLS", cap->tls);
399 print_cap("Wireless LAN (WLAN)", cap->wlan);
400}
Stefan Reinauer8e073822012-04-04 00:07:22 +0200401
Duncan Laurie708f7312012-07-10 15:15:41 -0700402/* Send END OF POST message to the ME */
Kyösti Mälkki21d6a272019-11-05 18:50:38 +0200403static int __unused mkhi_end_of_post(void)
Duncan Laurie708f7312012-07-10 15:15:41 -0700404{
405 struct mkhi_header mkhi = {
406 .group_id = MKHI_GROUP_ID_GEN,
407 .command = MKHI_END_OF_POST,
408 };
409 struct mei_header mei = {
410 .is_complete = 1,
411 .host_address = MEI_HOST_ADDRESS,
412 .client_address = MEI_ADDRESS_MKHI,
413 .length = sizeof(mkhi),
414 };
415
416 u32 eop_ack;
417
418 /* Send request and wait for response */
419 printk(BIOS_NOTICE, "ME: %s\n", __FUNCTION__);
420 if (mei_sendrecv(&mei, &mkhi, NULL, &eop_ack, sizeof(eop_ack)) < 0) {
421 printk(BIOS_ERR, "ME: END OF POST message failed\n");
422 return -1;
423 }
424
425 printk(BIOS_INFO, "ME: END OF POST message successful (%d)\n", eop_ack);
426 return 0;
427}
428
Kyösti Mälkki21d6a272019-11-05 18:50:38 +0200429#ifdef __SIMPLE_DEVICE__
430
Stefan Reinauer998f3a22012-06-11 15:15:46 -0700431void intel_me8_finalize_smm(void)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200432{
433 struct me_hfs hfs;
434 u32 reg32;
Elyes HAOUAS729c0692020-04-28 19:50:44 +0200435 u16 reg16;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200436
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -0800437 mei_base_address = (void *)
438 (pci_read_config32(PCH_ME_DEV, PCI_BASE_ADDRESS_0) & ~0xf);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200439
440 /* S3 path will have hidden this device already */
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -0800441 if (!mei_base_address || mei_base_address == (u32 *)0xfffffff0)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200442 return;
443
444 /* Make sure ME is in a mode that expects EOP */
Kyösti Mälkkifd98c652013-07-26 08:50:53 +0300445 reg32 = pci_read_config32(PCH_ME_DEV, PCI_ME_HFS);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200446 memcpy(&hfs, &reg32, sizeof(u32));
447
448 /* Abort and leave device alone if not normal mode */
449 if (hfs.fpt_bad ||
450 hfs.working_state != ME_HFS_CWS_NORMAL ||
451 hfs.operation_mode != ME_HFS_MODE_NORMAL)
452 return;
453
454 /* Try to send EOP command so ME stops accepting other commands */
455 mkhi_end_of_post();
456
457 /* Make sure IO is disabled */
Elyes HAOUAS729c0692020-04-28 19:50:44 +0200458 reg16 = pci_read_config16(PCH_ME_DEV, PCI_COMMAND);
459 reg16 &= ~(PCI_COMMAND_MASTER |
Stefan Reinauer8e073822012-04-04 00:07:22 +0200460 PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
Elyes HAOUAS729c0692020-04-28 19:50:44 +0200461 pci_write_config16(PCH_ME_DEV, PCI_COMMAND, reg16);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200462
463 /* Hide the PCI device */
464 RCBA32_OR(FD2, PCH_DISABLE_MEI1);
465}
466
Kyösti Mälkki21d6a272019-11-05 18:50:38 +0200467#else /* !__SIMPLE_DEVICE__ */
Stefan Reinauer8e073822012-04-04 00:07:22 +0200468
469/* Determine the path that we should take based on ME status */
Elyes HAOUASdc035282018-09-18 13:28:49 +0200470static me_bios_path intel_me_path(struct device *dev)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200471{
472 me_bios_path path = ME_DISABLE_BIOS_PATH;
473 struct me_hfs hfs;
474 struct me_gmes gmes;
475
Stefan Reinauer8e073822012-04-04 00:07:22 +0200476 /* S3 wake skips all MKHI messages */
Kyösti Mälkkic3ed8862014-06-19 19:50:51 +0300477 if (acpi_is_wakeup_s3())
Stefan Reinauer8e073822012-04-04 00:07:22 +0200478 return ME_S3WAKE_BIOS_PATH;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200479
480 pci_read_dword_ptr(dev, &hfs, PCI_ME_HFS);
481 pci_read_dword_ptr(dev, &gmes, PCI_ME_GMES);
482
483 /* Check and dump status */
484 intel_me_status(&hfs, &gmes);
485
Stefan Reinauer8e073822012-04-04 00:07:22 +0200486 /* Check Current Working State */
487 switch (hfs.working_state) {
488 case ME_HFS_CWS_NORMAL:
489 path = ME_NORMAL_BIOS_PATH;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200490 break;
491 case ME_HFS_CWS_REC:
492 path = ME_RECOVERY_BIOS_PATH;
493 break;
494 default:
495 path = ME_DISABLE_BIOS_PATH;
496 break;
497 }
498
499 /* Check Current Operation Mode */
500 switch (hfs.operation_mode) {
501 case ME_HFS_MODE_NORMAL:
502 break;
503 case ME_HFS_MODE_DEBUG:
504 case ME_HFS_MODE_DIS:
505 case ME_HFS_MODE_OVER_JMPR:
506 case ME_HFS_MODE_OVER_MEI:
507 default:
508 path = ME_DISABLE_BIOS_PATH;
509 break;
510 }
511
Duncan Laurie5c88c6f2012-09-01 14:00:23 -0700512 /* Check for any error code and valid firmware and MBP */
513 if (hfs.error_code || hfs.fpt_bad)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200514 path = ME_ERROR_BIOS_PATH;
515
Duncan Laurie5c88c6f2012-09-01 14:00:23 -0700516 /* Check if the MBP is ready */
517 if (!gmes.mbp_rdy) {
518 printk(BIOS_CRIT, "%s: mbp is not ready!\n",
519 __FUNCTION__);
520 path = ME_ERROR_BIOS_PATH;
521 }
522
Kyösti Mälkkibe5317f2019-11-06 12:07:21 +0200523 if (CONFIG(ELOG) && path != ME_NORMAL_BIOS_PATH) {
Duncan Laurie5c88c6f2012-09-01 14:00:23 -0700524 struct elog_event_data_me_extended data = {
525 .current_working_state = hfs.working_state,
526 .operation_state = hfs.operation_state,
527 .operation_mode = hfs.operation_mode,
528 .error_code = hfs.error_code,
529 .progress_code = gmes.progress_code,
530 .current_pmevent = gmes.current_pmevent,
531 .current_state = gmes.current_state,
532 };
533 elog_add_event_byte(ELOG_TYPE_MANAGEMENT_ENGINE, path);
534 elog_add_event_raw(ELOG_TYPE_MANAGEMENT_ENGINE_EXT,
535 &data, sizeof(data));
536 }
Duncan Laurie5c88c6f2012-09-01 14:00:23 -0700537
Stefan Reinauer8e073822012-04-04 00:07:22 +0200538 return path;
539}
540
541/* Prepare ME for MEI messages */
Elyes HAOUASdc035282018-09-18 13:28:49 +0200542static int intel_mei_setup(struct device *dev)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200543{
544 struct resource *res;
545 struct mei_csr host;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200546
547 /* Find the MMIO base for the ME interface */
548 res = find_resource(dev, PCI_BASE_ADDRESS_0);
549 if (!res || res->base == 0 || res->size == 0) {
550 printk(BIOS_DEBUG, "ME: MEI resource not present!\n");
551 return -1;
552 }
Kevin Paul Herbertbde6d302014-12-24 18:43:20 -0800553 mei_base_address = (u32 *)(uintptr_t)res->base;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200554
555 /* Ensure Memory and Bus Master bits are set */
Elyes HAOUAS729c0692020-04-28 19:50:44 +0200556 pci_or_config16(dev, PCI_COMMAND, PCI_COMMAND_MASTER | PCI_COMMAND_MEMORY);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200557
558 /* Clean up status for next message */
559 read_host_csr(&host);
560 host.interrupt_generate = 1;
561 host.ready = 1;
562 host.reset = 0;
563 write_host_csr(&host);
564
565 return 0;
566}
567
Angel Pons7f32df32020-06-02 13:36:57 +0200568#if CONFIG(CHROMEOS)
569#include <vendorcode/google/chromeos/chromeos.h>
570#endif
571
Stefan Reinauer8e073822012-04-04 00:07:22 +0200572/* Read the Extend register hash of ME firmware */
Elyes HAOUASdc035282018-09-18 13:28:49 +0200573static int intel_me_extend_valid(struct device *dev)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200574{
575 struct me_heres status;
Stefan Reinauer49058c02012-06-11 14:13:09 -0700576 u32 extend[8] = {0};
Stefan Reinauer8e073822012-04-04 00:07:22 +0200577 int i, count = 0;
578
579 pci_read_dword_ptr(dev, &status, PCI_ME_HERES);
580 if (!status.extend_feature_present) {
581 printk(BIOS_ERR, "ME: Extend Feature not present\n");
582 return -1;
583 }
584
585 if (!status.extend_reg_valid) {
586 printk(BIOS_ERR, "ME: Extend Register not valid\n");
587 return -1;
588 }
589
590 switch (status.extend_reg_algorithm) {
591 case PCI_ME_EXT_SHA1:
592 count = 5;
593 printk(BIOS_DEBUG, "ME: Extend SHA-1: ");
594 break;
595 case PCI_ME_EXT_SHA256:
596 count = 8;
597 printk(BIOS_DEBUG, "ME: Extend SHA-256: ");
598 break;
599 default:
600 printk(BIOS_ERR, "ME: Extend Algorithm %d unknown\n",
601 status.extend_reg_algorithm);
602 return -1;
603 }
604
Stefan Reinauer8e073822012-04-04 00:07:22 +0200605 for (i = 0; i < count; ++i) {
Stefan Reinauer49058c02012-06-11 14:13:09 -0700606 extend[i] = pci_read_config32(dev, PCI_ME_HER(i));
607 printk(BIOS_DEBUG, "%08x", extend[i]);
Stefan Reinauer8e073822012-04-04 00:07:22 +0200608 }
609 printk(BIOS_DEBUG, "\n");
610
Julius Wernercd49cce2019-03-05 16:53:33 -0800611#if CONFIG(CHROMEOS)
Stefan Reinauer49058c02012-06-11 14:13:09 -0700612 /* Save hash in NVS for the OS to verify */
613 chromeos_set_me_hash(extend, count);
614#endif
615
Stefan Reinauer8e073822012-04-04 00:07:22 +0200616 return 0;
617}
618
619/* Hide the ME virtual PCI devices */
Elyes HAOUASdc035282018-09-18 13:28:49 +0200620static void intel_me_hide(struct device *dev)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200621{
622 dev->enabled = 0;
623 pch_enable(dev);
624}
625
Angel Pons7f32df32020-06-02 13:36:57 +0200626static int intel_me_read_mbp(me_bios_payload *mbp_data);
627
Stefan Reinauer8e073822012-04-04 00:07:22 +0200628/* Check whether ME is present and do basic init */
Elyes HAOUASdc035282018-09-18 13:28:49 +0200629static void intel_me_init(struct device *dev)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200630{
631 me_bios_path path = intel_me_path(dev);
632 me_bios_payload mbp_data;
633
634 /* Do initial setup and determine the BIOS path */
635 printk(BIOS_NOTICE, "ME: BIOS path: %s\n", me_bios_path_values[path]);
636
637 switch (path) {
638 case ME_S3WAKE_BIOS_PATH:
639 intel_me_hide(dev);
640 break;
641
642 case ME_NORMAL_BIOS_PATH:
643 /* Validate the extend register */
644 if (intel_me_extend_valid(dev) < 0)
645 break; /* TODO: force recovery mode */
646
647 /* Prepare MEI MMIO interface */
648 if (intel_mei_setup(dev) < 0)
649 break;
650
Elyes HAOUASba28e8d2016-08-31 19:22:16 +0200651 if (intel_me_read_mbp(&mbp_data))
Stefan Reinauer8e073822012-04-04 00:07:22 +0200652 break;
653
Kyösti Mälkkic86fc8e2019-11-06 06:32:27 +0200654 if (CONFIG_DEFAULT_CONSOLE_LOGLEVEL >= BIOS_DEBUG) {
655 me_print_fw_version(&mbp_data.fw_version_name);
656 me_print_fwcaps(&mbp_data.fw_caps_sku);
657 }
Duncan Laurie708f7312012-07-10 15:15:41 -0700658
659 /*
660 * Leave the ME unlocked in this path.
661 * It will be locked via SMI command later.
662 */
Stefan Reinauer8e073822012-04-04 00:07:22 +0200663 break;
664
665 case ME_ERROR_BIOS_PATH:
666 case ME_RECOVERY_BIOS_PATH:
667 case ME_DISABLE_BIOS_PATH:
668 case ME_FIRMWARE_UPDATE_BIOS_PATH:
Stefan Reinauer8e073822012-04-04 00:07:22 +0200669 break;
670 }
671}
672
Stefan Reinauer8e073822012-04-04 00:07:22 +0200673static struct device_operations device_ops = {
674 .read_resources = pci_dev_read_resources,
675 .set_resources = pci_dev_set_resources,
676 .enable_resources = pci_dev_enable_resources,
677 .init = intel_me_init,
Angel Pons1fc0edd2020-05-31 00:03:28 +0200678 .ops_pci = &pci_dev_ops_pci,
Stefan Reinauer8e073822012-04-04 00:07:22 +0200679};
680
681static const struct pci_driver intel_me __pci_driver = {
682 .ops = &device_ops,
683 .vendor = PCI_VENDOR_ID_INTEL,
684 .device = 0x1e3a,
685};
686
Kyösti Mälkki21d6a272019-11-05 18:50:38 +0200687#endif /* !__SIMPLE_DEVICE__ */
688
Stefan Reinauer8e073822012-04-04 00:07:22 +0200689/******************************************************************************
690 * */
691static u32 me_to_host_words_pending(void)
692{
693 struct mei_csr me;
694 read_me_csr(&me);
695 if (!me.ready)
696 return 0;
697 return (me.buffer_write_ptr - me.buffer_read_ptr) &
698 (me.buffer_depth - 1);
699}
700
Stefan Reinauer8e073822012-04-04 00:07:22 +0200701/*
702 * mbp seems to be following its own flow, let's retrieve it in a dedicated
703 * function.
704 */
Kyösti Mälkki21d6a272019-11-05 18:50:38 +0200705static int __unused intel_me_read_mbp(me_bios_payload *mbp_data)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200706{
707 mbp_header mbp_hdr;
708 mbp_item_header mbp_item_hdr;
709 u32 me2host_pending;
710 u32 mbp_item_id;
711 struct mei_csr host;
712
713 me2host_pending = me_to_host_words_pending();
714 if (!me2host_pending) {
715 printk(BIOS_ERR, "ME: no mbp data!\n");
716 return -1;
717 }
718
719 /* we know for sure that at least the header is there */
720 mei_read_dword_ptr(&mbp_hdr, MEI_ME_CB_RW);
721
722 if ((mbp_hdr.num_entries > (mbp_hdr.mbp_size / 2)) ||
723 (me2host_pending < mbp_hdr.mbp_size)) {
724 printk(BIOS_ERR, "ME: mbp of %d entries, total size %d words"
725 " buffer contains %d words\n",
726 mbp_hdr.num_entries, mbp_hdr.mbp_size,
727 me2host_pending);
728 return -1;
729 }
730
731 me2host_pending--;
732 memset(mbp_data, 0, sizeof(*mbp_data));
733
734 while (mbp_hdr.num_entries--) {
Elyes HAOUAS448d9fb2018-05-22 12:51:27 +0200735 u32 *copy_addr;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200736 u32 copy_size, buffer_room;
737 void *p;
738
739 if (!me2host_pending) {
740 printk(BIOS_ERR, "ME: no mbp data %d entries to go!\n",
741 mbp_hdr.num_entries + 1);
742 return -1;
743 }
744
745 mei_read_dword_ptr(&mbp_item_hdr, MEI_ME_CB_RW);
746
747 if (mbp_item_hdr.length > me2host_pending) {
748 printk(BIOS_ERR, "ME: insufficient mbp data %d "
749 "entries to go!\n",
750 mbp_hdr.num_entries + 1);
751 return -1;
752 }
753
754 me2host_pending -= mbp_item_hdr.length;
755
756 mbp_item_id = (((u32)mbp_item_hdr.item_id) << 8) +
757 mbp_item_hdr.app_id;
758
759 copy_size = mbp_item_hdr.length - 1;
760
761#define SET_UP_COPY(field) { copy_addr = (u32 *)&mbp_data->field; \
762 buffer_room = sizeof(mbp_data->field) / sizeof(u32); \
763 break; \
764 }
765
766 p = &mbp_item_hdr;
767 printk(BIOS_INFO, "ME: MBP item header %8.8x\n", *((u32*)p));
768
Elyes HAOUASf9de5a42018-05-03 17:21:02 +0200769 switch (mbp_item_id) {
Stefan Reinauer8e073822012-04-04 00:07:22 +0200770 case 0x101:
771 SET_UP_COPY(fw_version_name);
772
773 case 0x102:
774 SET_UP_COPY(icc_profile);
775
776 case 0x103:
777 SET_UP_COPY(at_state);
778
779 case 0x201:
780 mbp_data->fw_caps_sku.available = 1;
781 SET_UP_COPY(fw_caps_sku.fw_capabilities);
782
783 case 0x301:
784 SET_UP_COPY(rom_bist_data);
785
786 case 0x401:
787 SET_UP_COPY(platform_key);
788
789 case 0x501:
790 mbp_data->fw_plat_type.available = 1;
791 SET_UP_COPY(fw_plat_type.rule_data);
792
793 case 0x601:
794 SET_UP_COPY(mfsintegrity);
795
796 default:
Vladimir Serbinenkoafc8d982014-06-11 18:52:55 +0000797 printk(BIOS_ERR, "ME: unknown mbp item id 0x%x! Skipping\n",
Stefan Reinauer8e073822012-04-04 00:07:22 +0200798 mbp_item_id);
Elyes HAOUASba28e8d2016-08-31 19:22:16 +0200799 while (copy_size--)
Vladimir Serbinenkoafc8d982014-06-11 18:52:55 +0000800 read_cb();
801 continue;
Stefan Reinauer8e073822012-04-04 00:07:22 +0200802 }
803
804 if (buffer_room != copy_size) {
805 printk(BIOS_ERR, "ME: buffer room %d != %d copy size"
806 " for item 0x%x!!!\n",
807 buffer_room, copy_size, mbp_item_id);
808 return -1;
809 }
Elyes HAOUASba28e8d2016-08-31 19:22:16 +0200810 while (copy_size--)
Stefan Reinauer8e073822012-04-04 00:07:22 +0200811 *copy_addr++ = read_cb();
812 }
813
814 read_host_csr(&host);
815 host.interrupt_generate = 1;
816 write_host_csr(&host);
817
818 {
819 int cntr = 0;
Elyes HAOUASba28e8d2016-08-31 19:22:16 +0200820 while (host.interrupt_generate) {
Stefan Reinauer8e073822012-04-04 00:07:22 +0200821 read_host_csr(&host);
822 cntr++;
823 }
824 printk(BIOS_SPEW, "ME: mbp read OK after %d cycles\n", cntr);
825 }
826
827 return 0;
828}