1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2019-2020 Linaro Limited */
4 #include <linux/acpi.h>
5 #include <linux/firmware.h>
6 #include <linux/module.h>
8 #include <linux/slab.h>
9 #include <asm/unaligned.h>
12 #include "xhci-trace.h"
15 #define RENESAS_FW_VERSION 0x6C
16 #define RENESAS_ROM_CONFIG 0xF0
17 #define RENESAS_FW_STATUS 0xF4
18 #define RENESAS_FW_STATUS_MSB 0xF5
19 #define RENESAS_ROM_STATUS 0xF6
20 #define RENESAS_ROM_STATUS_MSB 0xF7
21 #define RENESAS_DATA0 0xF8
22 #define RENESAS_DATA1 0xFC
24 #define RENESAS_FW_VERSION_FIELD GENMASK(23, 7)
25 #define RENESAS_FW_VERSION_OFFSET 8
27 #define RENESAS_FW_STATUS_DOWNLOAD_ENABLE BIT(0)
28 #define RENESAS_FW_STATUS_LOCK BIT(1)
29 #define RENESAS_FW_STATUS_RESULT GENMASK(6, 4)
30 #define RENESAS_FW_STATUS_INVALID 0
31 #define RENESAS_FW_STATUS_SUCCESS BIT(4)
32 #define RENESAS_FW_STATUS_ERROR BIT(5)
33 #define RENESAS_FW_STATUS_SET_DATA0 BIT(8)
34 #define RENESAS_FW_STATUS_SET_DATA1 BIT(9)
36 #define RENESAS_ROM_STATUS_ACCESS BIT(0)
37 #define RENESAS_ROM_STATUS_ERASE BIT(1)
38 #define RENESAS_ROM_STATUS_RELOAD BIT(2)
39 #define RENESAS_ROM_STATUS_RESULT GENMASK(6, 4)
40 #define RENESAS_ROM_STATUS_NO_RESULT 0
41 #define RENESAS_ROM_STATUS_SUCCESS BIT(4)
42 #define RENESAS_ROM_STATUS_ERROR BIT(5)
43 #define RENESAS_ROM_STATUS_SET_DATA0 BIT(8)
44 #define RENESAS_ROM_STATUS_SET_DATA1 BIT(9)
45 #define RENESAS_ROM_STATUS_ROM_EXISTS BIT(15)
47 #define RENESAS_ROM_ERASE_MAGIC 0x5A65726F
48 #define RENESAS_ROM_WRITE_MAGIC 0x53524F4D
50 #define RENESAS_RETRY 10000
51 #define RENESAS_DELAY 10
53 #define ROM_VALID_01 0x2013
54 #define ROM_VALID_02 0x2026
56 static int renesas_verify_fw_version(struct pci_dev *pdev, u32 version)
63 dev_err(&pdev->dev, "FW has invalid version :%d\n", version);
67 static int renesas_fw_download_image(struct pci_dev *dev,
68 const u32 *fw, size_t step, bool rom)
77 status_reg = RENESAS_ROM_STATUS_MSB;
79 status_reg = RENESAS_FW_STATUS_MSB;
82 * The hardware does alternate between two 32-bit pages.
83 * (This is because each row of the firmware is 8 bytes).
85 * for even steps we use DATA0, for odd steps DATA1.
87 data0_or_data1 = (step & 1) == 1;
89 /* step+1. Read "Set DATAX" and confirm it is cleared. */
90 for (i = 0; i < RENESAS_RETRY; i++) {
91 err = pci_read_config_byte(dev, status_reg, &fw_status);
93 dev_err(&dev->dev, "Read Status failed: %d\n",
94 pcibios_err_to_errno(err));
95 return pcibios_err_to_errno(err);
97 if (!(fw_status & BIT(data0_or_data1)))
100 udelay(RENESAS_DELAY);
102 if (i == RENESAS_RETRY) {
103 dev_err(&dev->dev, "Timeout for Set DATAX step: %zd\n", step);
108 * step+2. Write FW data to "DATAX".
109 * "LSB is left" => force little endian
111 err = pci_write_config_dword(dev, data0_or_data1 ?
112 RENESAS_DATA1 : RENESAS_DATA0,
113 (__force u32)cpu_to_le32(fw[step]));
115 dev_err(&dev->dev, "Write to DATAX failed: %d\n",
116 pcibios_err_to_errno(err));
117 return pcibios_err_to_errno(err);
122 /* step+3. Set "Set DATAX". */
123 err = pci_write_config_byte(dev, status_reg, BIT(data0_or_data1));
125 dev_err(&dev->dev, "Write config for DATAX failed: %d\n",
126 pcibios_err_to_errno(err));
127 return pcibios_err_to_errno(err);
133 static int renesas_fw_verify(const void *fw_data,
136 u16 fw_version_pointer;
140 * The Firmware's Data Format is describe in
141 * "6.3 Data Format" R19UH0078EJ0500 Rev.5.00 page 124
145 * The bootrom chips of the big brother have sizes up to 64k, let's
146 * assume that's the biggest the firmware can get.
148 if (length < 0x1000 || length >= 0x10000) {
149 pr_err("firmware is size %zd is not (4k - 64k).",
154 /* The First 2 bytes are fixed value (55aa). "LSB on Left" */
155 if (get_unaligned_le16(fw_data) != 0x55aa) {
156 pr_err("no valid firmware header found.");
160 /* verify the firmware version position and print it. */
161 fw_version_pointer = get_unaligned_le16(fw_data + 4);
162 if (fw_version_pointer + 2 >= length) {
163 pr_err("fw ver pointer is outside of the firmware image");
167 fw_version = get_unaligned_le16(fw_data + fw_version_pointer);
168 pr_err("got firmware version: %02x.", fw_version);
173 static bool renesas_check_rom(struct pci_dev *pdev)
178 /* Check if external ROM exists */
179 retval = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_status);
183 rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
185 dev_dbg(&pdev->dev, "External ROM exists\n");
186 return true; /* External ROM exists */
192 static int renesas_check_rom_state(struct pci_dev *pdev)
198 /* check FW version */
199 err = pci_read_config_dword(pdev, RENESAS_FW_VERSION, &version);
201 return pcibios_err_to_errno(err);
203 version &= RENESAS_FW_VERSION_FIELD;
204 version = version >> RENESAS_FW_VERSION_OFFSET;
206 err = renesas_verify_fw_version(pdev, version);
211 * Test if ROM is present and loaded, if so we can skip everything
213 err = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_state);
215 return pcibios_err_to_errno(err);
217 if (rom_state & BIT(15)) {
219 dev_dbg(&pdev->dev, "ROM exists\n");
221 /* Check the "Result Code" Bits (6:4) and act accordingly */
222 switch (rom_state & RENESAS_ROM_STATUS_RESULT) {
223 case RENESAS_ROM_STATUS_SUCCESS:
226 case RENESAS_ROM_STATUS_NO_RESULT: /* No result yet */
229 case RENESAS_ROM_STATUS_ERROR: /* Error State */
230 default: /* All other states are marked as "Reserved states" */
231 dev_err(&pdev->dev, "Invalid ROM..");
239 static int renesas_fw_check_running(struct pci_dev *pdev)
244 /* Check if device has ROM and loaded, if so skip everything */
245 err = renesas_check_rom(pdev);
246 if (err) { /* we have rom */
247 err = renesas_check_rom_state(pdev);
253 * Test if the device is actually needing the firmware. As most
254 * BIOSes will initialize the device for us. If the device is
257 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_state);
259 return pcibios_err_to_errno(err);
262 * Check if "FW Download Lock" is locked. If it is and the FW is
263 * ready we can simply continue. If the FW is not ready, we have
266 if (fw_state & RENESAS_FW_STATUS_LOCK) {
267 dev_dbg(&pdev->dev, "FW Download Lock is engaged.");
269 if (fw_state & RENESAS_FW_STATUS_SUCCESS)
273 "FW Download Lock is set and FW is not ready. Giving Up.");
278 * Check if "FW Download Enable" is set. If someone (us?) tampered
279 * with it and it can't be reset, we have to give up too... and
280 * ask for a forgiveness and a reboot.
282 if (fw_state & RENESAS_FW_STATUS_DOWNLOAD_ENABLE) {
284 "FW Download Enable is stale. Giving Up (poweroff/reboot needed).");
288 /* Otherwise, Check the "Result Code" Bits (6:4) and act accordingly */
289 switch (fw_state & RENESAS_FW_STATUS_RESULT) {
290 case 0: /* No result yet */
291 dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");
293 /* tell the caller, that this device needs the firmware. */
296 case RENESAS_FW_STATUS_SUCCESS: /* Success, device should be working. */
297 dev_dbg(&pdev->dev, "FW is ready.");
300 case RENESAS_FW_STATUS_ERROR: /* Error State */
302 "hardware is in an error state. Giving up (poweroff/reboot needed).");
305 default: /* All other states are marked as "Reserved states" */
307 "hardware is in an invalid state %lx. Giving up (poweroff/reboot needed).",
308 (fw_state & RENESAS_FW_STATUS_RESULT) >> 4);
313 static int renesas_fw_download(struct pci_dev *pdev,
314 const struct firmware *fw)
316 const u32 *fw_data = (const u32 *)fw->data;
322 * For more information and the big picture: please look at the
323 * "Firmware Download Sequence" in "7.1 FW Download Interface"
324 * of R19UH0078EJ0500 Rev.5.00 page 131
328 * 0. Set "FW Download Enable" bit in the
329 * "FW Download Control & Status Register" at 0xF4
331 err = pci_write_config_byte(pdev, RENESAS_FW_STATUS,
332 RENESAS_FW_STATUS_DOWNLOAD_ENABLE);
334 return pcibios_err_to_errno(err);
336 /* 1 - 10 follow one step after the other. */
337 for (i = 0; i < fw->size / 4; i++) {
338 err = renesas_fw_download_image(pdev, fw_data, i, false);
341 "Firmware Download Step %zd failed at position %zd bytes with (%d).",
348 * This sequence continues until the last data is written to
349 * "DATA0" or "DATA1". Naturally, we wait until "SET DATA0/1"
350 * is cleared by the hardware beforehand.
352 for (i = 0; i < RENESAS_RETRY; i++) {
353 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS_MSB,
356 return pcibios_err_to_errno(err);
357 if (!(fw_status & (BIT(0) | BIT(1))))
360 udelay(RENESAS_DELAY);
362 if (i == RENESAS_RETRY)
363 dev_warn(&pdev->dev, "Final Firmware Download step timed out.");
366 * 11. After finishing writing the last data of FW, the
367 * System Software must clear "FW Download Enable"
369 err = pci_write_config_byte(pdev, RENESAS_FW_STATUS, 0);
371 return pcibios_err_to_errno(err);
373 /* 12. Read "Result Code" and confirm it is good. */
374 for (i = 0; i < RENESAS_RETRY; i++) {
375 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_status);
377 return pcibios_err_to_errno(err);
378 if (fw_status & RENESAS_FW_STATUS_SUCCESS)
381 udelay(RENESAS_DELAY);
383 if (i == RENESAS_RETRY) {
384 /* Timed out / Error - let's see if we can fix this */
385 err = renesas_fw_check_running(pdev);
388 * we shouldn't end up here.
389 * maybe it took a little bit longer.
390 * But all should be well?
394 case 1: /* (No result yet! */
395 dev_err(&pdev->dev, "FW Load timedout");
406 static void renesas_rom_erase(struct pci_dev *pdev)
411 dev_dbg(&pdev->dev, "Performing ROM Erase...\n");
412 retval = pci_write_config_dword(pdev, RENESAS_DATA0,
413 RENESAS_ROM_ERASE_MAGIC);
415 dev_err(&pdev->dev, "ROM erase, magic word write failed: %d\n",
416 pcibios_err_to_errno(retval));
420 retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
422 dev_err(&pdev->dev, "ROM status read failed: %d\n",
423 pcibios_err_to_errno(retval));
426 status |= RENESAS_ROM_STATUS_ERASE;
427 retval = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, status);
429 dev_err(&pdev->dev, "ROM erase set word write failed\n");
433 /* sleep a bit while ROM is erased */
436 for (i = 0; i < RENESAS_RETRY; i++) {
437 retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS,
439 status &= RENESAS_ROM_STATUS_ERASE;
443 mdelay(RENESAS_DELAY);
446 if (i == RENESAS_RETRY)
447 dev_dbg(&pdev->dev, "Chip erase timedout: %x\n", status);
449 dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
452 static bool renesas_setup_rom(struct pci_dev *pdev, const struct firmware *fw)
454 const u32 *fw_data = (const u32 *)fw->data;
458 /* 2. Write magic word to Data0 */
459 err = pci_write_config_dword(pdev, RENESAS_DATA0,
460 RENESAS_ROM_WRITE_MAGIC);
464 /* 3. Set External ROM access */
465 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
466 RENESAS_ROM_STATUS_ACCESS);
470 /* 4. Check the result */
471 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
474 status &= GENMASK(6, 4);
477 "setting external rom failed: %x\n", status);
481 /* 5 to 16 Write FW to DATA0/1 while checking SetData0/1 */
482 for (i = 0; i < fw->size / 4; i++) {
483 err = renesas_fw_download_image(pdev, fw_data, i, true);
486 "ROM Download Step %d failed at position %d bytes with (%d)\n",
493 * wait till DATA0/1 is cleared
495 for (i = 0; i < RENESAS_RETRY; i++) {
496 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS_MSB,
500 if (!(status & (BIT(0) | BIT(1))))
503 udelay(RENESAS_DELAY);
505 if (i == RENESAS_RETRY) {
506 dev_err(&pdev->dev, "Final Firmware ROM Download step timed out\n");
510 /* 17. Remove bypass */
511 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
517 /* 18. check result */
518 for (i = 0; i < RENESAS_RETRY; i++) {
519 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
521 dev_err(&pdev->dev, "Read ROM status failed:%d\n",
522 pcibios_err_to_errno(err));
525 status &= RENESAS_ROM_STATUS_RESULT;
526 if (status == RENESAS_ROM_STATUS_SUCCESS) {
527 dev_dbg(&pdev->dev, "Download ROM success\n");
530 udelay(RENESAS_DELAY);
532 if (i == RENESAS_RETRY) { /* Timed out */
534 "Download to external ROM TO: %x\n", status);
538 dev_dbg(&pdev->dev, "Download to external ROM succeeded\n");
540 /* Last step set Reload */
541 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
542 RENESAS_ROM_STATUS_RELOAD);
544 dev_err(&pdev->dev, "Set ROM execute failed: %d\n",
545 pcibios_err_to_errno(err));
550 * wait till Reload is cleared
552 for (i = 0; i < RENESAS_RETRY; i++) {
553 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
556 if (!(status & RENESAS_ROM_STATUS_RELOAD))
559 udelay(RENESAS_DELAY);
561 if (i == RENESAS_RETRY) {
562 dev_err(&pdev->dev, "ROM Exec timed out: %x\n", status);
569 pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
573 static int renesas_load_fw(struct pci_dev *pdev, const struct firmware *fw)
578 /* Check if the device has external ROM */
579 rom = renesas_check_rom(pdev);
581 /* perform chip erase first */
582 renesas_rom_erase(pdev);
584 /* lets try loading fw on ROM first */
585 rom = renesas_setup_rom(pdev, fw);
588 "ROM load failed, falling back on FW load\n");
591 "ROM load success\n");
596 err = renesas_fw_download(pdev, fw);
600 dev_err(&pdev->dev, "firmware failed to download (%d).", err);
604 int renesas_xhci_check_request_fw(struct pci_dev *pdev,
605 const struct pci_device_id *id)
607 struct xhci_driver_data *driver_data =
608 (struct xhci_driver_data *)id->driver_data;
609 const char *fw_name = driver_data->firmware;
610 const struct firmware *fw;
613 err = renesas_fw_check_running(pdev);
614 /* Continue ahead, if the firmware is already running. */
622 err = request_firmware(&fw, fw_name, &pdev->dev);
625 dev_err(&pdev->dev, "request_firmware failed: %d\n", err);
629 err = renesas_fw_verify(fw->data, fw->size);
633 err = renesas_load_fw(pdev, fw);
635 release_firmware(fw);
638 EXPORT_SYMBOL_GPL(renesas_xhci_check_request_fw);
640 void renesas_xhci_pci_exit(struct pci_dev *dev)
643 EXPORT_SYMBOL_GPL(renesas_xhci_pci_exit);
645 MODULE_LICENSE("GPL v2");