[PATCH] staging: octeon: add kernel-doc to ethernet-sgmii.c functions

From: Oscar Alejandro Sánchez Lucero via B4 Relay

Date: Sat Nov 07 2026 - 12:01:50 EST


From: Oscar Alejandro Sánchez Lucero <aleszlucero@xxxxxxxxx>

Document cvm_oct_sgmii_open() and cvm_oct_sgmii_init() by adding standard
kernel-doc comment blocks. This fixes styling inconsistencies across the
octeon staging subsystem and allows documentation scripts to correctly
parse the function parameters and return values.

Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@xxxxxxxxx>
---
drivers/staging/octeon/ethernet-sgmii.c | 12 ++++++++++++
1 file changed, 12 insertions(+)

diff --git a/drivers/staging/octeon/ethernet-sgmii.c b/drivers/staging/octeon/ethernet-sgmii.c
index d7fbd9159302..2cd717709414 100644
--- a/drivers/staging/octeon/ethernet-sgmii.c
+++ b/drivers/staging/octeon/ethernet-sgmii.c
@@ -16,11 +16,23 @@
#include "ethernet-util.h"
#include "ethernet-mdio.h"

+/**
+ * cvm_oct_sgmii_open - open the SGMII interface
+ * @dev: Net device to open
+ *
+ * Return: Zero on success
+ */
int cvm_oct_sgmii_open(struct net_device *dev)
{
return cvm_oct_common_open(dev, cvm_oct_link_poll);
}

+/**
+ * cvm_oct_sgmii_init - initialize the SGMII interface
+ * @dev: Net device to initialize
+ *
+ * Return: Zero on success
+ */
int cvm_oct_sgmii_init(struct net_device *dev)
{
cvm_oct_common_init(dev);

---
base-commit: ddfe51b0a0f5dc9e415cc2c8ad8db17532dd426b
change-id: 20261107-octeon-sgmii-fixes-a93b14f04c7c

Best regards,
--
Oscar Alejandro Sánchez Lucero <aleszlucero@xxxxxxxxx>