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 <linux/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 RENESAS_FW_NAME "renesas_usb_fw.mem"
55 static int renesas_fw_download_image(struct pci_dev *dev,
56 const u32 *fw, size_t step, bool rom)
65 status_reg = RENESAS_ROM_STATUS_MSB;
67 status_reg = RENESAS_FW_STATUS_MSB;
70 * The hardware does alternate between two 32-bit pages.
71 * (This is because each row of the firmware is 8 bytes).
73 * for even steps we use DATA0, for odd steps DATA1.
75 data0_or_data1 = (step & 1) == 1;
77 /* step+1. Read "Set DATAX" and confirm it is cleared. */
78 for (i = 0; i < RENESAS_RETRY; i++) {
79 err = pci_read_config_byte(dev, status_reg, &fw_status);
81 dev_err(&dev->dev, "Read Status failed: %d\n",
82 pcibios_err_to_errno(err));
83 return pcibios_err_to_errno(err);
85 if (!(fw_status & BIT(data0_or_data1)))
88 udelay(RENESAS_DELAY);
90 if (i == RENESAS_RETRY) {
91 dev_err(&dev->dev, "Timeout for Set DATAX step: %zd\n", step);
96 * step+2. Write FW data to "DATAX".
97 * "LSB is left" => force little endian
99 err = pci_write_config_dword(dev, data0_or_data1 ?
100 RENESAS_DATA1 : RENESAS_DATA0,
101 (__force u32)cpu_to_le32(fw[step]));
103 dev_err(&dev->dev, "Write to DATAX failed: %d\n",
104 pcibios_err_to_errno(err));
105 return pcibios_err_to_errno(err);
110 /* step+3. Set "Set DATAX". */
111 err = pci_write_config_byte(dev, status_reg, BIT(data0_or_data1));
113 dev_err(&dev->dev, "Write config for DATAX failed: %d\n",
114 pcibios_err_to_errno(err));
115 return pcibios_err_to_errno(err);
121 static int renesas_fw_verify(const void *fw_data,
124 u16 fw_version_pointer;
127 * The Firmware's Data Format is describe in
128 * "6.3 Data Format" R19UH0078EJ0500 Rev.5.00 page 124
132 * The bootrom chips of the big brother have sizes up to 64k, let's
133 * assume that's the biggest the firmware can get.
135 if (length < 0x1000 || length >= 0x10000) {
136 pr_err("firmware is size %zd is not (4k - 64k).",
141 /* The First 2 bytes are fixed value (55aa). "LSB on Left" */
142 if (get_unaligned_le16(fw_data) != 0x55aa) {
143 pr_err("no valid firmware header found.");
147 /* verify the firmware version position and print it. */
148 fw_version_pointer = get_unaligned_le16(fw_data + 4);
149 if (fw_version_pointer + 2 >= length) {
150 pr_err("fw ver pointer is outside of the firmware image");
157 static bool renesas_check_rom(struct pci_dev *pdev)
162 /* Check if external ROM exists */
163 retval = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_status);
167 rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
169 dev_dbg(&pdev->dev, "External ROM exists\n");
170 return true; /* External ROM exists */
176 static int renesas_check_rom_state(struct pci_dev *pdev)
182 /* check FW version */
183 err = pci_read_config_dword(pdev, RENESAS_FW_VERSION, &version);
185 return pcibios_err_to_errno(err);
187 version &= RENESAS_FW_VERSION_FIELD;
188 version = version >> RENESAS_FW_VERSION_OFFSET;
189 dev_dbg(&pdev->dev, "Found ROM version: %x\n", version);
192 * Test if ROM is present and loaded, if so we can skip everything
194 err = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_state);
196 return pcibios_err_to_errno(err);
198 if (rom_state & RENESAS_ROM_STATUS_ROM_EXISTS) {
200 dev_dbg(&pdev->dev, "ROM exists\n");
202 /* Check the "Result Code" Bits (6:4) and act accordingly */
203 switch (rom_state & RENESAS_ROM_STATUS_RESULT) {
204 case RENESAS_ROM_STATUS_SUCCESS:
207 case RENESAS_ROM_STATUS_NO_RESULT: /* No result yet */
208 dev_dbg(&pdev->dev, "Unknown ROM status ...\n");
211 case RENESAS_ROM_STATUS_ERROR: /* Error State */
212 default: /* All other states are marked as "Reserved states" */
213 dev_err(&pdev->dev, "Invalid ROM..");
221 static int renesas_fw_check_running(struct pci_dev *pdev)
227 * Test if the device is actually needing the firmware. As most
228 * BIOSes will initialize the device for us. If the device is
231 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_state);
233 return pcibios_err_to_errno(err);
236 * Check if "FW Download Lock" is locked. If it is and the FW is
237 * ready we can simply continue. If the FW is not ready, we have
240 if (fw_state & RENESAS_FW_STATUS_LOCK) {
241 dev_dbg(&pdev->dev, "FW Download Lock is engaged.");
243 if (fw_state & RENESAS_FW_STATUS_SUCCESS)
247 "FW Download Lock is set and FW is not ready. Giving Up.");
252 * Check if "FW Download Enable" is set. If someone (us?) tampered
253 * with it and it can't be reset, we have to give up too... and
254 * ask for a forgiveness and a reboot.
256 if (fw_state & RENESAS_FW_STATUS_DOWNLOAD_ENABLE) {
258 "FW Download Enable is stale. Giving Up (poweroff/reboot needed).");
262 /* Otherwise, Check the "Result Code" Bits (6:4) and act accordingly */
263 switch (fw_state & RENESAS_FW_STATUS_RESULT) {
264 case 0: /* No result yet */
265 dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");
267 /* tell the caller, that this device needs the firmware. */
270 case RENESAS_FW_STATUS_SUCCESS: /* Success, device should be working. */
271 dev_dbg(&pdev->dev, "FW is ready.");
274 case RENESAS_FW_STATUS_ERROR: /* Error State */
276 "hardware is in an error state. Giving up (poweroff/reboot needed).");
279 default: /* All other states are marked as "Reserved states" */
281 "hardware is in an invalid state %lx. Giving up (poweroff/reboot needed).",
282 (fw_state & RENESAS_FW_STATUS_RESULT) >> 4);
287 static int renesas_fw_download(struct pci_dev *pdev,
288 const struct firmware *fw)
290 const u32 *fw_data = (const u32 *)fw->data;
296 * For more information and the big picture: please look at the
297 * "Firmware Download Sequence" in "7.1 FW Download Interface"
298 * of R19UH0078EJ0500 Rev.5.00 page 131
302 * 0. Set "FW Download Enable" bit in the
303 * "FW Download Control & Status Register" at 0xF4
305 err = pci_write_config_byte(pdev, RENESAS_FW_STATUS,
306 RENESAS_FW_STATUS_DOWNLOAD_ENABLE);
308 return pcibios_err_to_errno(err);
310 /* 1 - 10 follow one step after the other. */
311 for (i = 0; i < fw->size / 4; i++) {
312 err = renesas_fw_download_image(pdev, fw_data, i, false);
315 "Firmware Download Step %zd failed at position %zd bytes with (%d).",
322 * This sequence continues until the last data is written to
323 * "DATA0" or "DATA1". Naturally, we wait until "SET DATA0/1"
324 * is cleared by the hardware beforehand.
326 for (i = 0; i < RENESAS_RETRY; i++) {
327 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS_MSB,
330 return pcibios_err_to_errno(err);
331 if (!(fw_status & (BIT(0) | BIT(1))))
334 udelay(RENESAS_DELAY);
336 if (i == RENESAS_RETRY)
337 dev_warn(&pdev->dev, "Final Firmware Download step timed out.");
340 * 11. After finishing writing the last data of FW, the
341 * System Software must clear "FW Download Enable"
343 err = pci_write_config_byte(pdev, RENESAS_FW_STATUS, 0);
345 return pcibios_err_to_errno(err);
347 /* 12. Read "Result Code" and confirm it is good. */
348 for (i = 0; i < RENESAS_RETRY; i++) {
349 err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_status);
351 return pcibios_err_to_errno(err);
352 if (fw_status & RENESAS_FW_STATUS_SUCCESS)
355 udelay(RENESAS_DELAY);
357 if (i == RENESAS_RETRY) {
358 /* Timed out / Error - let's see if we can fix this */
359 err = renesas_fw_check_running(pdev);
362 * we shouldn't end up here.
363 * maybe it took a little bit longer.
364 * But all should be well?
368 case 1: /* (No result yet! */
369 dev_err(&pdev->dev, "FW Load timedout");
380 static void renesas_rom_erase(struct pci_dev *pdev)
385 dev_dbg(&pdev->dev, "Performing ROM Erase...\n");
386 retval = pci_write_config_dword(pdev, RENESAS_DATA0,
387 RENESAS_ROM_ERASE_MAGIC);
389 dev_err(&pdev->dev, "ROM erase, magic word write failed: %d\n",
390 pcibios_err_to_errno(retval));
394 retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
396 dev_err(&pdev->dev, "ROM status read failed: %d\n",
397 pcibios_err_to_errno(retval));
400 status |= RENESAS_ROM_STATUS_ERASE;
401 retval = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, status);
403 dev_err(&pdev->dev, "ROM erase set word write failed\n");
407 /* sleep a bit while ROM is erased */
410 for (i = 0; i < RENESAS_RETRY; i++) {
411 retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS,
413 status &= RENESAS_ROM_STATUS_ERASE;
417 mdelay(RENESAS_DELAY);
420 if (i == RENESAS_RETRY)
421 dev_dbg(&pdev->dev, "Chip erase timedout: %x\n", status);
423 dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
426 static bool renesas_setup_rom(struct pci_dev *pdev, const struct firmware *fw)
428 const u32 *fw_data = (const u32 *)fw->data;
432 /* 2. Write magic word to Data0 */
433 err = pci_write_config_dword(pdev, RENESAS_DATA0,
434 RENESAS_ROM_WRITE_MAGIC);
438 /* 3. Set External ROM access */
439 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
440 RENESAS_ROM_STATUS_ACCESS);
444 /* 4. Check the result */
445 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
448 status &= GENMASK(6, 4);
451 "setting external rom failed: %x\n", status);
455 /* 5 to 16 Write FW to DATA0/1 while checking SetData0/1 */
456 for (i = 0; i < fw->size / 4; i++) {
457 err = renesas_fw_download_image(pdev, fw_data, i, true);
460 "ROM Download Step %d failed at position %d bytes with (%d)\n",
467 * wait till DATA0/1 is cleared
469 for (i = 0; i < RENESAS_RETRY; i++) {
470 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS_MSB,
474 if (!(status & (BIT(0) | BIT(1))))
477 udelay(RENESAS_DELAY);
479 if (i == RENESAS_RETRY) {
480 dev_err(&pdev->dev, "Final Firmware ROM Download step timed out\n");
484 /* 17. Remove bypass */
485 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
491 /* 18. check result */
492 for (i = 0; i < RENESAS_RETRY; i++) {
493 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
495 dev_err(&pdev->dev, "Read ROM status failed:%d\n",
496 pcibios_err_to_errno(err));
499 status &= RENESAS_ROM_STATUS_RESULT;
500 if (status == RENESAS_ROM_STATUS_SUCCESS) {
501 dev_dbg(&pdev->dev, "Download ROM success\n");
504 udelay(RENESAS_DELAY);
506 if (i == RENESAS_RETRY) { /* Timed out */
508 "Download to external ROM TO: %x\n", status);
512 dev_dbg(&pdev->dev, "Download to external ROM succeeded\n");
514 /* Last step set Reload */
515 err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
516 RENESAS_ROM_STATUS_RELOAD);
518 dev_err(&pdev->dev, "Set ROM execute failed: %d\n",
519 pcibios_err_to_errno(err));
524 * wait till Reload is cleared
526 for (i = 0; i < RENESAS_RETRY; i++) {
527 err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
530 if (!(status & RENESAS_ROM_STATUS_RELOAD))
533 udelay(RENESAS_DELAY);
535 if (i == RENESAS_RETRY) {
536 dev_err(&pdev->dev, "ROM Exec timed out: %x\n", status);
543 pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
547 static int renesas_load_fw(struct pci_dev *pdev, const struct firmware *fw)
552 /* Check if the device has external ROM */
553 rom = renesas_check_rom(pdev);
555 /* perform chip erase first */
556 renesas_rom_erase(pdev);
558 /* lets try loading fw on ROM first */
559 rom = renesas_setup_rom(pdev, fw);
562 "ROM load failed, falling back on FW load\n");
565 "ROM load success\n");
570 err = renesas_fw_download(pdev, fw);
574 dev_err(&pdev->dev, "firmware failed to download (%d).", err);
578 static int renesas_xhci_check_request_fw(struct pci_dev *pdev,
579 const struct pci_device_id *id)
581 const char fw_name[] = RENESAS_FW_NAME;
582 const struct firmware *fw;
586 /* Check if device has ROM and loaded, if so skip everything */
587 has_rom = renesas_check_rom(pdev);
589 err = renesas_check_rom_state(pdev);
592 else if (err != -ENOENT)
596 err = renesas_fw_check_running(pdev);
597 /* Continue ahead, if the firmware is already running. */
601 /* no firmware interface available */
603 return has_rom ? 0 : err;
606 err = firmware_request_nowarn(&fw, fw_name, &pdev->dev);
610 dev_info(&pdev->dev, "failed to load firmware %s, fallback to ROM\n",
614 dev_err(&pdev->dev, "failed to load firmware %s: %d\n",
619 err = renesas_fw_verify(fw->data, fw->size);
623 err = renesas_load_fw(pdev, fw);
625 release_firmware(fw);
630 xhci_pci_renesas_probe(struct pci_dev *dev, const struct pci_device_id *id)
634 retval = renesas_xhci_check_request_fw(dev, id);
638 return xhci_pci_common_probe(dev, id);
641 static const struct pci_device_id pci_ids[] = {
642 { PCI_DEVICE(PCI_VENDOR_ID_RENESAS, 0x0014) },
643 { PCI_DEVICE(PCI_VENDOR_ID_RENESAS, 0x0015) },
644 { /* end: all zeroes */ }
646 MODULE_DEVICE_TABLE(pci, pci_ids);
648 static struct pci_driver xhci_renesas_pci_driver = {
649 .name = "xhci-pci-renesas",
652 .probe = xhci_pci_renesas_probe,
653 .remove = xhci_pci_remove,
655 .shutdown = usb_hcd_pci_shutdown,
657 .pm = pm_ptr(&usb_hcd_pci_pm_ops),
660 module_pci_driver(xhci_renesas_pci_driver);
662 MODULE_DESCRIPTION("Renesas xHCI PCI Host Controller Driver");
663 MODULE_FIRMWARE(RENESAS_FW_NAME);
664 MODULE_IMPORT_NS("xhci");
665 MODULE_LICENSE("GPL v2");