Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Date:   Thu, 14 Dec 2023 17:29:12 +0100
Subject: [PATCH v2 4/4] usb: typec: tipd: add patch update support for
 tps6598x
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20231207-tps6598x_update-v2-4-f3cfcde6d890@wolfvision.net>
References: <20231207-tps6598x_update-v2-0-f3cfcde6d890@wolfvision.net>
In-Reply-To: <20231207-tps6598x_update-v2-0-f3cfcde6d890@wolfvision.net>
To:     Heikki Krogerus <heikki.krogerus@linux.intel.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc:     linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org,
        Javier Carrasco <javier.carrasco@wolfvision.net>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TVIySjArNHNpZFZmRnlic01HTVhSY3ZHQS9Eb0dqdHFwZ1l4R1RTa0k5eDdL?=
 =?utf-8?B?ZjRsWG9IVlVXVWI3ZllTTGFDMU5pbS9xdEdOdUh5di9ZK3haTVhwQitReElX?=
 =?utf-8?B?NWR4ckoyTjdUbjRxMXVmV0JSeStEaDgrWlhEdEIxY2grODhsaU9VQ0FaTUxH?=
 =?utf-8?B?OTFjQUFhNm14ZENXbVlmaEw2eitjQW5EU0w4SW5CZ2tzVWtYUERNUmp3emd3?=
 =?utf-8?B?bnprRldqUHdFN3YyTjgzbHA4RFoxcVc2ZldxUHRZZVYzY05XQ2ZjUGJ6Qjkv?=
 =?utf-8?B?dkp5S0h2YU13d2ZNZTgwbFcxYStsYm00cjBjYjJGRkJRVmU0d0NUUXdndDUw?=
 =?utf-8?B?ZVlhWlNibXcxcXNGWlRZazhlcEpIWm5hUm9QTG5SWDY5RUxLalFtTUY5VjBE?=
 =?utf-8?B?QjFJWG42dUxnOUd2SjBXRTBtNURVZU5sL24ySzNnM3oxUHcwaUIzb29tcjhM?=
 =?utf-8?B?Mit4NWRXWjVkaDRzSUlDZnlGVVFWQnF4Q0gxTVdaQkRyUVhkVm9UWDdRcERM?=
 =?utf-8?B?MlJ2cEM2V0E0d1ptaG9VYkhBL3A5N3d3K09GT0VFWnFrL0tjb3Fad2xmVUhE?=
 =?utf-8?B?cytwbEFPZWZlams3a1lvNldDQ016dEFvTGpCckNzRzBLVHBXWTlCRHBxbXJs?=
 =?utf-8?B?bjR1YjlMYTBZT2FMZmIzakFyOTlkRkxyZnFkZHgvR2h0dXFoMGVEM0JkaW0w?=
 =?utf-8?B?Tk1HSENEaUdBUUMxVzd2akNLRXFSRUVjS3ZVZS9XbUkrYjIrd0ZkUnRUZ3Ra?=
 =?utf-8?B?M24zNTVUMVhaZXFzb3NBZ3RVMyttZG84RW8xTVpIT2kxc21RVjdJTjFLQUtu?=
 =?utf-8?B?eCs2WWpLK0tDTVhkaXh6dElyeElnckNrejJRUmw3L3V0V3lGU0VQd0cxRVlS?=
 =?utf-8?B?YVNyMEgwendrczlxSnE3NFBGR09Lc3UySlhOYytpT0J1K01vV1hwazFIWDhQ?=
 =?utf-8?B?KzRTNW44N05OK01ES0NPbFVPamdjNWt1Y00zeDcycklzSWxBYnRwOGZ3RFdh?=
 =?utf-8?B?ZlFoTC9nWm1Bb2xlTjZUSEZsZEJ0Q3E3Tk9JVW9jazg3cnZValc2SnloM29K?=
 =?utf-8?B?dzV1aVBKVjNQNlBmUFlHVGtodnFiK2VYWTE4UWZCMm0wMExsckRqS1lmZmhN?=
 =?utf-8?B?NjVtMlA4N2tvaERHbnJuSHZ0WXpzYU5NemhrZkpqelRLN3pQSG9RVUozZFp5?=
 =?utf-8?B?RFZjbGx1aXh5MU9EQnQ4cVduaTJmMDViK3dXNmhaMjJhUzB2Z1h6bkdyNC9R?=
 =?utf-8?B?S3NES0NtSGlPNkc4UjlJZmMvZUduK1NaaGpwOWZueHlPckZYVVZKQ3FzcWtm?=
 =?utf-8?B?eVFpbjZJSXFHNDI4MTlaU0NnNFZtVHpscHRRUTFNNGpjUjdrWW5WVFptNG43?=
 =?utf-8?B?Zkc4OEJETUNJTk1BZlk2WWd5M3hrK2dtNmxGdHduRzZ1ejYzYzB4T0k0TWFt?=
 =?utf-8?B?RjBMZG0xTTkyQ1RGd1BBbEJZb29pN2ZZcmhUZlI3dUl5K2tGTzhRQU5EZW9T?=
 =?utf-8?B?a1R3OWkrdWQ1OHhhTWUySHNFNlQ1aVJMNjdtUkVyekxWSUFQcEY5QWdDNzV4?=
 =?utf-8?B?NEdLVXUwVHg2UmE1WjdmMFRqd1c4QVlkaitSajhjSUFYUWJacmsrSXhXTito?=
 =?utf-8?B?c20zd1JybHNHSDRHZm1oekZhd3RGYndVOHpOTmcwcVpwMGpiSXdRTzF5Y1cw?=
 =?utf-8?B?YzR3MWhWN2s2Mk9hb1d1eDc4dWZURDU4eEphMEpFaXFqczIxeGQvdEQ4TEFz?=
 =?utf-8?B?WEF2TVgwbnV6VUpTUS9kUndqb3ArMktSNE1Pak9xQmw0cWtuczZKSVo4eHJq?=
 =?utf-8?B?bkdoR3BGbElmRnhEQTZGSTV6Wm5CM3kwTGNIa2MvcFBid0tqQS95eit5Nlc1?=
 =?utf-8?B?ZUF3UFlRejFGcC9wYjR4Zk4rSTBzZ0xxQitqRnJndzJ3VVQzMm5DZGdoNEYx?=
 =?utf-8?B?bUFURkJKNmNIVHUycS8yQVBsYmUxZWxiSjJ2SlV3bEwweVRNc2FVSnEyOVdB?=
 =?utf-8?B?eld3Qnl6NFpkaHJIMGxMQ1k4dERBY2RTWGJ6YUpOOVBmNGp5SDl2aHFnN3Iw?=
 =?utf-8?B?Nm5TcStTUzBLZ1BUd2FtRnludkY5Z0FQRm1USnhld1Bua0lDaS92OWNsTDVh?=
 =?utf-8?B?VDRRU3BmeVZvV2VUSncxUWxiVUFxVGY1eEhLTmZCYVNodElLdGhyY0IzWERR?=
 =?utf-8?Q?IVhTWHLWmcS/Qlpb3AIK/04=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 575e72e1-30ab-4b76-803c-08dbfcc1d134
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Dec 2023 16:29:17.2890
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: e94ec9da-9183-471e-83b3-51baa8eb804f
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: SRJ8HHRJx/+UAhYN9w/LsaFE+QI7qJeb4U4E6qMnEg0DUW5hWYQDLvUsUkXPOoZwncH1YnIVmd7b02bbhCdpxC1JbPofY+WqzuDBCtgRnfk=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU0PR08MB8302
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Thu, 14 Dec 2023 08:29:55 -0800 (PST)

The TPS6598x PD controller supports firmware updates that can be loaded
either from an external flash memory or a host using the device's I2C
host interface. This patch implements the second approach, which is
especially relevant if no flash memory is available.

In order to make patch bundle updates, a series of tasks (special
commands) must be sent to the device as it is documented in the
TPS65987DDH and TPS65988DH Host Interface Technical Reference Manual[1],
section 4.11 (Patch Bundle Update Tasks).

The update sequence is as follows:
1. PTCs - Start Patch Load Sequence: the proposed approach includes
   device and application configuration data.
2. PTCd - Patch Download: 64-byte data chunks must be sent until the end
   of the firmware file is reached (the last chunk may be shorter).
3. PTCc - Patch Data Transfer Complete: ends the patch loading sequence.

After this sequence and if no errors occurred, the device will change
its mode to 'APP' after SETUP_MS milliseconds, and then it will be ready
for normal operation.

[1] https://www.ti.com/lit/ug/slvubh2b/slvubh2b.pdf?ts=1697623299919&ref_url=https%253A%252F%252Fwww.ti.com%252Fproduct%252FTPS65987D

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 drivers/usb/typec/tipd/core.c     | 68 ++++++++++++++++++++++++++++++++++++++-
 drivers/usb/typec/tipd/tps6598x.h | 18 +++++++++++
 2 files changed, 85 insertions(+), 1 deletion(-)

diff --git a/drivers/usb/typec/tipd/core.c b/drivers/usb/typec/tipd/core.c
index 7f4bbc0629b0..a956eb976906 100644
--- a/drivers/usb/typec/tipd/core.c
+++ b/drivers/usb/typec/tipd/core.c
@@ -1125,6 +1125,71 @@ static int tps25750_apply_patch(struct tps6598x *tps)
 	return 0;
 };
 
+static int tps6598x_apply_patch(struct tps6598x *tps)
+{
+	u8 in = TPS_PTCS_CONTENT_DEV | TPS_PTCS_CONTENT_APP;
+	u8 out[TPS_MAX_LEN] = {0};
+	size_t in_len = sizeof(in);
+	size_t copied_bytes = 0;
+	size_t bytes_left;
+	const struct firmware *fw;
+	const char *firmware_name;
+	int ret;
+
+	ret = device_property_read_string(tps->dev, "firmware-name",
+					  &firmware_name);
+	if (ret)
+		return ret;
+
+	ret = tps_request_firmware(tps, &fw);
+	if (ret)
+		return ret;
+
+	ret = tps6598x_exec_cmd(tps, "PTCs", in_len, &in,
+				TPS_PTCS_OUT_BYTES, out);
+	if (ret || out[TPS_PTCS_STATUS] == TPS_PTCS_STATUS_FAIL) {
+		if (!ret)
+			ret = -EBUSY;
+		dev_err(tps->dev, "Update start failed (%d)\n", ret);
+		goto release_fw;
+	}
+
+	bytes_left = fw->size;
+	while (bytes_left) {
+		if (bytes_left < TPS_MAX_LEN)
+			in_len = bytes_left;
+		else
+			in_len = TPS_MAX_LEN;
+		ret = tps6598x_exec_cmd(tps, "PTCd", in_len,
+					fw->data + copied_bytes,
+					TPS_PTCD_OUT_BYTES, out);
+		if (ret || out[TPS_PTCD_TRANSFER_STATUS] ||
+		    out[TPS_PTCD_LOADING_STATE] == TPS_PTCD_LOAD_ERR) {
+			if (!ret)
+				ret = -EBUSY;
+			dev_err(tps->dev, "Patch download failed (%d)\n", ret);
+			goto release_fw;
+		}
+		copied_bytes += in_len;
+		bytes_left -= in_len;
+	}
+
+	ret = tps6598x_exec_cmd(tps, "PTCc", 0, NULL, TPS_PTCC_OUT_BYTES, out);
+	if (ret || out[TPS_PTCC_DEV] || out[TPS_PTCC_APP]) {
+		if (!ret)
+			ret = -EBUSY;
+		dev_err(tps->dev, "Update completion failed (%d)\n", ret);
+		goto release_fw;
+	}
+	msleep(TPS_SETUP_MS);
+	dev_info(tps->dev, "Firmware update succeeded\n");
+
+release_fw:
+	release_firmware(fw);
+
+	return ret;
+};
+
 static int cd321x_init(struct tps6598x *tps)
 {
 	return 0;
@@ -1150,7 +1215,7 @@ static int tps25750_init(struct tps6598x *tps)
 
 static int tps6598x_init(struct tps6598x *tps)
 {
-	return 0;
+	return tps->data->apply_patch(tps);
 }
 
 static int cd321x_reset(struct tps6598x *tps)
@@ -1468,6 +1533,7 @@ static const struct tipd_data tps6598x_data = {
 	.register_port = tps6598x_register_port,
 	.trace_power_status = trace_tps6598x_power_status,
 	.trace_status = trace_tps6598x_status,
+	.apply_patch = tps6598x_apply_patch,
 	.init = tps6598x_init,
 	.reset = tps6598x_reset,
 };
diff --git a/drivers/usb/typec/tipd/tps6598x.h b/drivers/usb/typec/tipd/tps6598x.h
index 01609bf509e4..89b24519463a 100644
--- a/drivers/usb/typec/tipd/tps6598x.h
+++ b/drivers/usb/typec/tipd/tps6598x.h
@@ -235,4 +235,22 @@
 /* SLEEP CONF REG */
 #define TPS_SLEEP_CONF_SLEEP_MODE_ALLOWED	BIT(0)
 
+/* Start Patch Download Sequence */
+#define TPS_PTCS_CONTENT_APP			BIT(0)
+#define TPS_PTCS_CONTENT_DEV			BIT(1)
+#define TPS_PTCS_OUT_BYTES			4
+#define TPS_PTCS_STATUS				1
+
+#define TPS_PTCS_STATUS_FAIL			0x80
+/* Patch Download */
+#define TPS_PTCD_OUT_BYTES			10
+#define TPS_PTCD_TRANSFER_STATUS		1
+#define TPS_PTCD_LOADING_STATE			2
+
+#define TPS_PTCD_LOAD_ERR			0x09
+/* Patch Download Complete */
+#define TPS_PTCC_OUT_BYTES			4
+#define TPS_PTCC_DEV				2
+#define TPS_PTCC_APP				3
+
 #endif /* __TPS6598X_H__ */

-- 
2.39.2