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>
7 #include <linux/pci.h>
8 #include <linux/slab.h>
9 #include <linux/unaligned.h>
11 #include "xhci.h"
12 #include "xhci-trace.h"
13 #include "xhci-pci.h"
45 #define RENESAS_ROM_STATUS_ROM_EXISTS			BIT(15)
57 				     const u32 *fw, size_t step, bool rom)  in renesas_fw_download_image()  argument
65 	if (rom)  in renesas_fw_download_image()
71 	 * The hardware does alternate between two 32-bit pages.  in renesas_fw_download_image()
82 			dev_err(&dev->dev, "Read Status failed: %d\n",  in renesas_fw_download_image()
92 		dev_err(&dev->dev, "Timeout for Set DATAX step: %zd\n", step);  in renesas_fw_download_image()
93 		return -ETIMEDOUT;  in renesas_fw_download_image()
104 		dev_err(&dev->dev, "Write to DATAX failed: %d\n",  in renesas_fw_download_image()
114 		dev_err(&dev->dev, "Write config for DATAX failed: %d\n",  in renesas_fw_download_image()
137 		pr_err("firmware is size %zd is not (4k - 64k).",  in renesas_fw_verify()
139 		return -EINVAL;  in renesas_fw_verify()
145 		return -EINVAL;  in renesas_fw_verify()
152 		return -EINVAL;  in renesas_fw_verify()
163 	/* Check if external ROM exists */  in renesas_check_rom()
170 		dev_dbg(&pdev->dev, "External ROM exists\n");  in renesas_check_rom()
171 		return true; /* External ROM exists */  in renesas_check_rom()
190 	dev_dbg(&pdev->dev, "Found ROM version: %x\n", version);  in renesas_check_rom_state()
193 	 * Test if ROM is present and loaded, if so we can skip everything  in renesas_check_rom_state()
200 		/* ROM exists */  in renesas_check_rom_state()
201 		dev_dbg(&pdev->dev, "ROM exists\n");  in renesas_check_rom_state()
209 			dev_dbg(&pdev->dev, "Unknown ROM status ...\n");  in renesas_check_rom_state()
210 			return -ENOENT;  in renesas_check_rom_state()
214 			dev_err(&pdev->dev, "Invalid ROM..");  in renesas_check_rom_state()
219 	return -EIO;  in renesas_check_rom_state()
242 		dev_dbg(&pdev->dev, "FW Download Lock is engaged.");  in renesas_fw_check_running()
247 		dev_err(&pdev->dev,  in renesas_fw_check_running()
249 		return -EIO;  in renesas_fw_check_running()
258 		dev_err(&pdev->dev,  in renesas_fw_check_running()
260 		return -EIO;  in renesas_fw_check_running()
266 		dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");  in renesas_fw_check_running()
272 		dev_dbg(&pdev->dev, "FW is ready.");  in renesas_fw_check_running()
276 		dev_err(&pdev->dev,  in renesas_fw_check_running()
278 		return -ENODEV;  in renesas_fw_check_running()
281 		dev_err(&pdev->dev,  in renesas_fw_check_running()
284 		return -EINVAL;  in renesas_fw_check_running()
291 	const u32 *fw_data = (const u32 *)fw->data;  in renesas_fw_download()
311 	/* 1 - 10 follow one step after the other. */  in renesas_fw_download()
312 	for (i = 0; i < fw->size / 4; i++) {  in renesas_fw_download()
315 			dev_err(&pdev->dev,  in renesas_fw_download()
338 		dev_warn(&pdev->dev, "Final Firmware Download step timed out.");  in renesas_fw_download()
359 		/* Timed out / Error - let's see if we can fix this */  in renesas_fw_download()
370 			dev_err(&pdev->dev, "FW Load timedout");  in renesas_fw_download()
371 			return -ETIMEDOUT;  in renesas_fw_download()
386 	dev_dbg(&pdev->dev, "Performing ROM Erase...\n");  in renesas_rom_erase()
390 		dev_err(&pdev->dev, "ROM erase, magic word write failed: %d\n",  in renesas_rom_erase()
397 		dev_err(&pdev->dev, "ROM status read failed: %d\n",  in renesas_rom_erase()
404 		dev_err(&pdev->dev, "ROM erase set word write failed\n");  in renesas_rom_erase()
408 	/* sleep a bit while ROM is erased */  in renesas_rom_erase()
422 		dev_dbg(&pdev->dev, "Chip erase timedout: %x\n", status);  in renesas_rom_erase()
424 	dev_dbg(&pdev->dev, "ROM Erase... Done success\n");  in renesas_rom_erase()
429 	const u32 *fw_data = (const u32 *)fw->data;  in renesas_setup_rom()
439 	/* 3. Set External ROM access */  in renesas_setup_rom()
451 		dev_err(&pdev->dev,  in renesas_setup_rom()
452 			"setting external rom failed: %x\n", status);  in renesas_setup_rom()
457 	for (i = 0; i < fw->size / 4; i++) {  in renesas_setup_rom()
460 			dev_err(&pdev->dev,  in renesas_setup_rom()
461 				"ROM Download Step %d failed at position %d bytes with (%d)\n",  in renesas_setup_rom()
481 		dev_err(&pdev->dev, "Final Firmware ROM Download step timed out\n");  in renesas_setup_rom()
496 			dev_err(&pdev->dev, "Read ROM status failed:%d\n",  in renesas_setup_rom()
502 			dev_dbg(&pdev->dev, "Download ROM success\n");  in renesas_setup_rom()
508 		dev_err(&pdev->dev,  in renesas_setup_rom()
509 			"Download to external ROM TO: %x\n", status);  in renesas_setup_rom()
513 	dev_dbg(&pdev->dev, "Download to external ROM succeeded\n");  in renesas_setup_rom()
519 		dev_err(&pdev->dev, "Set ROM execute failed: %d\n",  in renesas_setup_rom()
537 		dev_err(&pdev->dev, "ROM Exec timed out: %x\n", status);  in renesas_setup_rom()
551 	bool rom;  in renesas_load_fw()  local
553 	/* Check if the device has external ROM */  in renesas_load_fw()
554 	rom = renesas_check_rom(pdev);  in renesas_load_fw()
555 	if (rom) {  in renesas_load_fw()
559 		/* lets try loading fw on ROM first */  in renesas_load_fw()
560 		rom = renesas_setup_rom(pdev, fw);  in renesas_load_fw()
561 		if (!rom) {  in renesas_load_fw()
562 			dev_dbg(&pdev->dev,  in renesas_load_fw()
563 				"ROM load failed, falling back on FW load\n");  in renesas_load_fw()
565 			dev_dbg(&pdev->dev,  in renesas_load_fw()
566 				"ROM load success\n");  in renesas_load_fw()
575 		dev_err(&pdev->dev, "firmware failed to download (%d).", err);  in renesas_load_fw()
587 	/* Check if device has ROM and loaded, if so skip everything */  in renesas_xhci_check_request_fw()
593 		else if (err != -ENOENT)  in renesas_xhci_check_request_fw()
607 	err = firmware_request_nowarn(&fw, fw_name, &pdev->dev);  in renesas_xhci_check_request_fw()
611 			dev_info(&pdev->dev, "failed to load firmware %s, fallback to ROM\n",  in renesas_xhci_check_request_fw()
615 		dev_err(&pdev->dev, "failed to load firmware %s: %d\n",  in renesas_xhci_check_request_fw()
620 	err = renesas_fw_verify(fw->data, fw->size);  in renesas_xhci_check_request_fw()
650 	.name =		"xhci-pci-renesas",