From 9beb57362fd36ffc47e901625357add249e4f101 Mon Sep 17 00:00:00 2001
From: Anup Patel <anup.patel@wdc.com>
Date: Fri, 27 Dec 2019 08:54:24 +0530
Subject: firmware: Improve comments for fw_prev_arg1() and fw_next_arg1()

The state of a0, a1, and a2 registers in fw_prev_arg1() and
fw_next_arg1() is same as passed by previous booting stage
so we add this info in comments for both these functions.

Signed-off-by: Anup Patel <anup.patel@wdc.com>
---
 firmware/fw_dynamic.S | 4 ++++
 firmware/fw_jump.S    | 4 ++++
 firmware/fw_payload.S | 4 ++++
 3 files changed, 12 insertions(+)

(limited to 'firmware')

diff --git a/firmware/fw_dynamic.S b/firmware/fw_dynamic.S
index ba9394d..192698a 100644
--- a/firmware/fw_dynamic.S
+++ b/firmware/fw_dynamic.S
@@ -91,6 +91,8 @@ fw_save_info:
 	.global fw_prev_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The previous arg1 should be returned in 'a0'.
 	 */
 fw_prev_arg1:
@@ -102,6 +104,8 @@ fw_prev_arg1:
 	.global fw_next_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The next arg1 should be returned in 'a0'.
 	 */
 fw_next_arg1:
diff --git a/firmware/fw_jump.S b/firmware/fw_jump.S
index 0015a80..e0a3b53 100644
--- a/firmware/fw_jump.S
+++ b/firmware/fw_jump.S
@@ -39,6 +39,8 @@ fw_save_info:
 	.global fw_prev_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The previous arg1 should be returned in 'a0'.
 	 */
 fw_prev_arg1:
@@ -50,6 +52,8 @@ fw_prev_arg1:
 	.global fw_next_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The next arg1 should be returned in 'a0'.
 	 */
 fw_next_arg1:
diff --git a/firmware/fw_payload.S b/firmware/fw_payload.S
index b9cb151..84d9ad4 100644
--- a/firmware/fw_payload.S
+++ b/firmware/fw_payload.S
@@ -39,6 +39,8 @@ fw_save_info:
 	.global fw_prev_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The previous arg1 should be returned in 'a0'.
 	 */
 fw_prev_arg1:
@@ -54,6 +56,8 @@ fw_prev_arg1:
 	.global fw_next_arg1
 	/*
 	 * We can only use a0, a1, and a2 registers here.
+	 * The a0, a1, and a2 registers will be same as passed by
+	 * previous booting stage.
 	 * The next arg1 should be returned in 'a0'.
 	 */
 fw_next_arg1:
-- 
cgit v1.2.3