net: emaclite: Fix kernel doc warnings

This patch fixes the kernel doc warnings
in the driver.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
Signed-off-by: Michal Simek <michal.simek@xilinx.com>

diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
index fefa788c1edf6e2f07bfa8043761d5a9a48610e3..ae810bf7c4071c463681f072750bf7753a3d36fa 100644 (file)
--- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c
+++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
@@ -490,7 +490,7 @@ static void xemaclite_update_address(struct net_local *drvdata,
 /**
  * xemaclite_set_mac_address - Set the MAC address for this device
  * @dev:       Pointer to the network device instance
- * @addr:      Void pointer to the sockaddr structure
+ * @address:   Void pointer to the sockaddr structure
  *
  * This function copies the HW address from the sockaddr strucutre to the
  * net_device structure and updates the address in HW.
@@ -641,6 +641,8 @@ static void xemaclite_rx_handler(struct net_device *dev)
  * @dev_id:    Void pointer to the network device instance used as callback
  *             reference
  *
+ * Return: IRQ_HANDLED.
+ *
  * This function handles the Tx and Rx interrupts of the EmacLite device.
  */
 static irqreturn_t xemaclite_interrupt(int irq, void *dev_id)
@@ -774,6 +776,8 @@ static int xemaclite_mdio_read(struct mii_bus *bus, int phy_id, int reg)
  *
  * This function waits till the device is ready to accept a new MDIO
  * request and then writes the val to the MDIO Write Data register.
+ *
+ * Return:     0 upon success or a negative error upon failure
  */
 static int xemaclite_mdio_write(struct mii_bus *bus, int phy_id, int reg,
                                u16 val)
@@ -807,7 +811,7 @@ static int xemaclite_mdio_write(struct mii_bus *bus, int phy_id, int reg,
 /**
  * xemaclite_mdio_setup - Register mii_bus for the Emaclite device
  * @lp:                Pointer to the Emaclite device private data
- * @ofdev:     Pointer to OF device structure
+ * @dev:       Pointer to OF device structure
  *
  * This function enables MDIO bus in the Emaclite device and registers a
  * mii_bus.
@@ -904,6 +908,10 @@ static void xemaclite_adjust_link(struct net_device *ndev)
  * xemaclite_open - Open the network device
  * @dev:       Pointer to the network device
  *
+ * Return: 0, on success.
+ *         -ENODEV, if PHY cannot be connected to
+ *         non-zero error value on failure
+ *
  * This function sets the MAC address, requests an IRQ and enables interrupts
  * for the Emaclite device and starts the Tx queue.
  * It also connects to the phy device, if MDIO is included in Emaclite device.
@@ -977,6 +985,8 @@ static int xemaclite_open(struct net_device *dev)
  * This function stops the Tx queue, disables interrupts and frees the IRQ for
  * the Emaclite device.
  * It also disconnects the phy device associated with the Emaclite device.
+ *
+ * Return:     0, always.
  */
 static int xemaclite_close(struct net_device *dev)
 {
@@ -1068,7 +1078,6 @@ static const struct net_device_ops xemaclite_netdev_ops;
 /**
  * xemaclite_of_probe - Probe method for the Emaclite device.
  * @ofdev:     Pointer to OF device structure
- * @match:     Pointer to the structure used for matching a device
  *
  * This function probes for the Emaclite device in the device tree.
  * It initializes the driver data structure and the hardware, sets the MAC