linux-stable/drivers/net/ethernet/arc/emac_arc.c
Jesse Brandeburg f410f157f4 drivers/net/ethernet: add some basic kdoc tags
A couple of drivers had a "generic documentation" section that
would trigger a "can't understand" message from W=1 compiles.

Fix by using correct DOC: tags in the generic sections.

Fixed Warnings:
drivers/net/ethernet/arc/emac_arc.c:4: info: Scanning doc for c
drivers/net/ethernet/cadence/macb_pci.c:3: warning: missing initial short description on line:
 * Cadence GEM PCI wrapper.
drivers/net/ethernet/cadence/macb_pci.c:3: info: Scanning doc for Cadence

Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2020-09-25 16:29:00 -07:00

90 lines
1.9 KiB
C

// SPDX-License-Identifier: GPL-2.0-or-later
/**
* DOC: emac_arc.c - ARC EMAC specific glue layer
*
* Copyright (C) 2014 Romain Perier
*
* Romain Perier <romain.perier@gmail.com>
*/
#include <linux/etherdevice.h>
#include <linux/module.h>
#include <linux/of_net.h>
#include <linux/platform_device.h>
#include "emac.h"
#define DRV_NAME "emac_arc"
static int emac_arc_probe(struct platform_device *pdev)
{
struct device *dev = &pdev->dev;
struct arc_emac_priv *priv;
phy_interface_t interface;
struct net_device *ndev;
int err;
if (!dev->of_node)
return -ENODEV;
ndev = alloc_etherdev(sizeof(struct arc_emac_priv));
if (!ndev)
return -ENOMEM;
platform_set_drvdata(pdev, ndev);
SET_NETDEV_DEV(ndev, dev);
priv = netdev_priv(ndev);
priv->drv_name = DRV_NAME;
err = of_get_phy_mode(dev->of_node, &interface);
if (err) {
if (err == -ENODEV)
interface = PHY_INTERFACE_MODE_MII;
else
goto out_netdev;
}
priv->clk = devm_clk_get(dev, "hclk");
if (IS_ERR(priv->clk)) {
dev_err(dev, "failed to retrieve host clock from device tree\n");
err = -EINVAL;
goto out_netdev;
}
err = arc_emac_probe(ndev, interface);
out_netdev:
if (err)
free_netdev(ndev);
return err;
}
static int emac_arc_remove(struct platform_device *pdev)
{
struct net_device *ndev = platform_get_drvdata(pdev);
int err;
err = arc_emac_remove(ndev);
free_netdev(ndev);
return err;
}
static const struct of_device_id emac_arc_dt_ids[] = {
{ .compatible = "snps,arc-emac" },
{ /* Sentinel */ }
};
MODULE_DEVICE_TABLE(of, emac_arc_dt_ids);
static struct platform_driver emac_arc_driver = {
.probe = emac_arc_probe,
.remove = emac_arc_remove,
.driver = {
.name = DRV_NAME,
.of_match_table = emac_arc_dt_ids,
},
};
module_platform_driver(emac_arc_driver);
MODULE_AUTHOR("Romain Perier <romain.perier@gmail.com>");
MODULE_DESCRIPTION("ARC EMAC platform driver");
MODULE_LICENSE("GPL");