Patrick Georgi submitted this change.

View Change

Approvals: build bot (Jenkins): Verified Felix Held: Looks good to me, approved HAOUAS Elyes: Looks good to me, approved Arthur Heymans: Looks good to me, approved
include/superio/hwm5_conf.h: Fix copy-pasted comments

Comments say `port`, but the actual function signature uses `base`.

Change-Id: I28a2f24a9701aec2fb990ca2f38e5f2794e15f0c
Signed-off-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/45226
Reviewed-by: HAOUAS Elyes <ehaouas@noos.fr>
Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
Reviewed-by: Felix Held <felix-coreboot@felixheld.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
---
M src/include/superio/hwm5_conf.h
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/include/superio/hwm5_conf.h b/src/include/superio/hwm5_conf.h
index 9102de2..2cf13c6 100644
--- a/src/include/superio/hwm5_conf.h
+++ b/src/include/superio/hwm5_conf.h
@@ -12,14 +12,14 @@
* of the corresponding IO address region, but at offset 5 and 6. */

/*
- * u8 pnp_read_hwm5_index(u16 port, u8 reg)
+ * u8 pnp_read_hwm5_index(u16 base, u8 reg)
* Description:
* This routine reads indexed I/O registers. The reg byte is written
- * to the index register at I/O address = port + 5. The result is then
- * read from the data register at I/O address = port + 6.
+ * to the index register at I/O address = base + 5. The result is then
+ * read from the data register at I/O address = base + 6.
*
* Parameters:
- * @param[in] u16 base = The I/O address of the port index register.
+ * @param[in] u16 base = The I/O address of the base index register.
* @param[in] u8 reg = The offset within the indexed space.
* @param[out] u8 result = The value read back from the data register.
*/
@@ -29,14 +29,14 @@
}

/*
- * void pnp_write_hwm5_index(u16 port, u8 reg, u8 value)
+ * void pnp_write_hwm5_index(u16 base, u8 reg, u8 value)
* Description:
* This routine writes indexed I/O registers. The reg byte is written
- * to the index register at I/O address = port + 5. The value byte is then
- * written to the data register at I/O address = port + 6.
+ * to the index register at I/O address = base + 5. The value byte is then
+ * written to the data register at I/O address = base + 6.
*
* Parameters:
- * @param[in] u16 base = The address of the port index register.
+ * @param[in] u16 base = The address of the base index register.
* @param[in] u8 reg = The offset within the indexed space.
* @param[in] u8 value = The value to be written to the data register.
*/

To view, visit change 45226. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-Change-Id: I28a2f24a9701aec2fb990ca2f38e5f2794e15f0c
Gerrit-Change-Number: 45226
Gerrit-PatchSet: 3
Gerrit-Owner: Angel Pons <th3fanbus@gmail.com>
Gerrit-Reviewer: Arthur Heymans <arthur@aheymans.xyz>
Gerrit-Reviewer: Felix Held <felix-coreboot@felixheld.de>
Gerrit-Reviewer: HAOUAS Elyes <ehaouas@noos.fr>
Gerrit-Reviewer: Nico Huber <nico.h@gmx.de>
Gerrit-Reviewer: Patrick Georgi <pgeorgi@google.com>
Gerrit-Reviewer: Patrick Rudolph <siro@das-labor.org>
Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org>
Gerrit-MessageType: merged