Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Date:   Thu, 07 Dec 2023 12:51:09 +0100
Subject: [PATCH 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-v1-4-dc21b5301d91@wolfvision.net>
References: <20231207-tps6598x_update-v1-0-dc21b5301d91@wolfvision.net>
In-Reply-To: <20231207-tps6598x_update-v1-0-dc21b5301d91@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?Z09iemZWNEtCWDBlTER3QTg1NTNEdUNzaVF3NTNrVWNDeWUrZnpmQlpETFVH?=
 =?utf-8?B?YzIwRHV1YVBlcWRCUko5NlpGdjlrbnJZT21mdDlxU05MWXpZNHdCNHk2YjlS?=
 =?utf-8?B?ajQzenpFYTBhbXkrRm9hVURxTG4vejhTa3BqUE5jQkdIWkcyTW5vV3RyZWJL?=
 =?utf-8?B?bk9IcVVDNlRMOHpTc09YSkcva2VKR29aUS92T2VZcTNnbzB4RzFnaDlJdWNz?=
 =?utf-8?B?ZHBmVlZWeXp4bHZoSEpFekFPbEgybitHaVFjYXpkU2UycnpVY2lvZGY2dGNy?=
 =?utf-8?B?NTZYUDJKS2VEdGZxNElTRXVjSXFURVE4VWJBd085NVVPYkJhWnJtTEd2Sm9G?=
 =?utf-8?B?d2xka0UzQWhFSE95OUYvTUgrcUkzL2tLWFhKVWNGTUVoWWNONEJEVDdvcFZO?=
 =?utf-8?B?U29YTTJXUlZjN3p6cVp1QVFQWDZHMnVFZmRMK1YvYTREVXJLNWphVXRpQ2pq?=
 =?utf-8?B?UzdTZC9FZlhmMm1ORURVSG9oQ3dNVnl2M21QVjlhSWRuZmRyaFJLSm9zUnMx?=
 =?utf-8?B?WlZjMGhBNUhlbnJCMFU2WEQ0RmNJN2hoV0Z4VXV5KzU4cGpPaThMZmV2KzBr?=
 =?utf-8?B?cjU2Vit6WXg3OGR0WlU5c1MrVDhEN1pMc1BjRXc4QzlVYnpxMXc0K1FyT2xY?=
 =?utf-8?B?VlhnZkxrajVMNXJUalVRNG1la1pFdS9VV0RtY3lYTEVjUXQvUm1RZ1YrbVo2?=
 =?utf-8?B?THg0a0ozckdIMUZyaHVqOXgzMStycDdNVW9nK2tsZG9mMXNmb3JpaWZJNldo?=
 =?utf-8?B?TmlhV0pQaXBTTWFjbGRTWnpGMUhPOFg0c0JrSngzbVgzcmdOdnFoenJHc1Zp?=
 =?utf-8?B?ZUVvNloybWNwN050UGVNZWNDcWo4NkZEZlFNSWRGQndnWFFPWDhZNVQ1bysv?=
 =?utf-8?B?MVduL2pqcUJJNkxHYldMb3pPaWpzK3Y4Mmc5TG05VWpDdWN2MW12Z205SGFm?=
 =?utf-8?B?TEtzY0ZMUVE4U3pKMXpwRVk4cVFNajBhRmFYb21KOE1OSHJOSVp5Y3JJQkJi?=
 =?utf-8?B?cmpBaS9TV2xXS0tpSVV2bk9vaW82ZENUbUxNNmtiZkxDTndleWdQMjluOFVG?=
 =?utf-8?B?dCt1UGFDUTNzdGtrTWl4T2ErQzF4OXZKakZCR1BNSWlmZG1MQmxyZWJrVk9X?=
 =?utf-8?B?Skoya0wxS1BoMmEyVVRhSmJ6ejB4UXA5OEdta1dXRjJDYjcyTHVIYTJ5Nzl3?=
 =?utf-8?B?bUhGOGF6Szg3WnhhV1VVMXRtb1FpQlhxL0pkb0FndTFlSEFETlg0cU0zT0Y5?=
 =?utf-8?B?NXlZRXhQWG5CeHZiRytXam5ZZUJyRCs1a1hENENXclo3MHFhV3FWOXdqb1Ba?=
 =?utf-8?B?TisrZTVVQ1IyZ0RnY2R5M1ZmR1h1ejJoWjFEZjVMRUU3ZUNwWmE4SkJUVW1j?=
 =?utf-8?B?YzlzZVRmM3NOQ0JJMGtqL3ZKdlNvVWN6QWtFczZhSjFNczdMVUxWSjM5ZVh6?=
 =?utf-8?B?M1gvTk1ESEF0N2wzSUlCNUdLdU9vTFpHU1dtM2NOMWd0Z0hSbXh4YmNKdDF1?=
 =?utf-8?B?M291T1Z6QU11KzdQK3gyUFhKejNWbjVQQ3E3dzFIdTI3NC93aE5obE9UbnRL?=
 =?utf-8?B?SStiTmRSS3Fyb1FRM0ZKdEw2YUl2ZTdPbmJPbFVieENDSFNaeFNnZUxFZ0NC?=
 =?utf-8?B?MG1mMDlxQnRHMXppeXplV3YvNU9wd0FRdW1xL0dBanJGM0gwYlF4d2VWTGdW?=
 =?utf-8?B?aWhPSTRKWDhMRVhzU3FKZ2NQN3FYa2NYbUg0QzcyYWpzK0h2WWp0eWZhdlAz?=
 =?utf-8?B?eGpselUveHJrbUZoZGhXcDVKVjBXY21WN1RLdW5GaUljdkFzRm1sRFd5VVFL?=
 =?utf-8?B?d1VZSFAvajV5eUVDaVJyZW1Cb2lTU2VBdGVPYXVLMHltb2tXQnpWTVhrZXJO?=
 =?utf-8?B?YlhUNWFYc0ZyOWh4OTY2UDJzQzBHb2tLeTByeGhqUnlPNGUwVnhyNTFmdWh4?=
 =?utf-8?B?ZFdaQ2JSU2xMdmIvV3VmQ2IzN2QzWVQyNkRJUTYrR3JDMGdUa1UzRXRGUDln?=
 =?utf-8?B?NmZqeXJhN3I5SkZpZks5dktaTHZXVE9RditSRDBOTjVPdlFJdTNNQjgvckZN?=
 =?utf-8?B?ZGFLM3JSTVEvbHlNdVgrMGFvRHAyTkVFdXFQYW1GbDE5ZDZWOUlydXF4aVcr?=
 =?utf-8?B?VVplTFVMbnhyVmtxelhyaXYwV3dncGw1Q2pmNU0yRnE4cUVuTTZJN1NpYVhl?=
 =?utf-8?Q?UE71IRj/e7WYS+Mj9ZHteR4=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 9cf6b13d-2e9e-44a6-9a05-08dbf71ad0ba
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Dec 2023 11:51:14.7491
 (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: k2yfNRbvqz1G0seD2Fw7I68G+Q9bgm89W9beT3QPT2sUnz42OJuhzbixntewoMNlHr4r+tVM2sMTdL8qiqNlTHloD7sLmIE7agnXFzzxICQ=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR08MB5300
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 fry.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 (fry.vger.email [0.0.0.0]); Thu, 07 Dec 2023 03:52:00 -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 cd5214c9799e..a4a50c52253d 100644
--- a/drivers/usb/typec/tipd/core.c
+++ b/drivers/usb/typec/tipd/core.c
@@ -1126,6 +1126,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;
@@ -1151,7 +1216,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)
@@ -1469,6 +1534,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