[PATCH 0/3] add hix5hd2 mac driver

[PATCH 0/3] add hix5hd2 mac driver

[Zhangfei Gao]

Zhangfei Gao (3):
  hix5hd2-clock: add complex clk
  Documentation: add Device tree bindings for Hisilicon hix5hd2
    ethernet
  net: hisilicon: add hix5hd2 mac driver

 .../bindings/net/hisilicon-hix5hd2-net.txt         |   37 +
 drivers/clk/hisilicon/clk-hix5hd2.c                |  182 ++++
 drivers/net/ethernet/Kconfig                       |    1 +
 drivers/net/ethernet/Makefile                      |    1 +
 drivers/net/ethernet/hisilicon/Kconfig             |   27 +
 drivers/net/ethernet/hisilicon/Makefile            |    5 +
 drivers/net/ethernet/hisilicon/hix5hd2.c           | 1078 ++++++++++++++++++++
 include/dt-bindings/clock/hix5hd2-clock.h          |    9 +
 8 files changed, 1340 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt
 create mode 100644 drivers/net/ethernet/hisilicon/Kconfig
 create mode 100644 drivers/net/ethernet/hisilicon/Makefile
 create mode 100644 drivers/net/ethernet/hisilicon/hix5hd2.c

-- 
1.7.9.5

[PATCH 1/3] hix5hd2-clock: add complex clk

[Zhangfei Gao]

Signed-off-by: Jiancheng Xue <xuejiancheng@huawei.com>
Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
---
 drivers/clk/hisilicon/clk-hix5hd2.c       |  182 +++++++++++++++++++++++++++++
 include/dt-bindings/clock/hix5hd2-clock.h |    9 ++
 2 files changed, 191 insertions(+)

diff --git a/drivers/clk/hisilicon/clk-hix5hd2.c b/drivers/clk/hisilicon/clk-hix5hd2.c
index e5fcfb4..1b1347f 100644
--- a/drivers/clk/hisilicon/clk-hix5hd2.c
+++ b/drivers/clk/hisilicon/clk-hix5hd2.c
@@ -9,6 +9,8 @@
 
 #include <linux/of_address.h>
 #include <dt-bindings/clock/hix5hd2-clock.h>
+#include <linux/slab.h>
+#include <linux/delay.h>
 #include "clk.h"
 
 static struct hisi_fixed_rate_clock hix5hd2_fixed_rate_clks[] __initdata = {
@@ -79,8 +81,186 @@ static struct hisi_gate_clock hix5hd2_gate_clks[] __initdata = {
 		CLK_SET_RATE_PARENT, 0xa0, 1, 0, },
 	{ HIX5HD2_MMC_CIU_RST, "rst_mmc_ciu", "clk_mmc_ciu",
 		CLK_SET_RATE_PARENT, 0xa0, 4, CLK_GATE_SET_TO_DISABLE, },
+	/*gsf*/
+	{ HIX5HD2_FWD_BUS_CLK, "clk_fwd_bus", NULL, 0, 0xcc, 0, 0, },
+	{ HIX5HD2_FWD_SYS_CLK, "clk_fwd_sys", "clk_fwd_bus", 0, 0xcc, 5, 0, },
+	{ HIX5HD2_MAC0_PHY_CLK, "clk_fephy", "clk_fwd_sys",
+		 CLK_SET_RATE_PARENT, 0x120, 0, 0, },
 };
 
+enum {TYPE_COMPLEX, TYPE_ETHER};
+
+struct hix5hd2_complex_clock {
+	unsigned int	id;
+	const char	*name;
+	const char	*parent_name;
+	u32		ctrl_reg;
+	u32		ctrl_clk_mask;
+	u32		ctrl_rst_mask;
+	u32		phy_reg;
+	u32		phy_clk_mask;
+	u32		phy_rst_mask;
+	u32		type;
+};
+
+struct hix5hd2_clk_complex {
+	struct clk_hw	hw;
+	u32		id;
+	void __iomem	*ctrl_reg;
+	u32		ctrl_clk_mask;
+	u32		ctrl_rst_mask;
+	void __iomem	*phy_reg;
+	u32		phy_clk_mask;
+	u32		phy_rst_mask;
+};
+
+static struct hix5hd2_complex_clock hix5hd2_complex_clks[] __initdata = {
+	{HIX5HD2_MAC0_CLK, "clk_mac0", "clk_fephy",
+		0xcc, 0xa, 0x500, 0x120, 0, 0x10, TYPE_ETHER},
+	{HIX5HD2_MAC1_CLK, "clk_mac1", "clk_fwd_sys",
+		0xcc, 0x14, 0xa00, 0x168, 0x2, 0, TYPE_ETHER},
+	{HIX5HD2_SATA_CLK, "clk_sata", NULL,
+		0xa8, 0x1f, 0x300, 0xac, 0x1, 0x0, TYPE_COMPLEX},
+	{HIX5HD2_USB_CLK, "clk_usb", NULL,
+		0xb8, 0xff, 0x3f00, 0xbc, 0x7, 0x3f00, TYPE_COMPLEX},
+};
+
+#define to_complex_clk(_hw) container_of(_hw, struct hix5hd2_clk_complex, hw)
+
+static int clk_ether_enable(struct clk_hw *hw)
+{
+	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
+	u32 val;
+
+	val = readl(clk->ctrl_reg);
+	val |= clk->ctrl_clk_mask | clk->ctrl_rst_mask;
+	writel(val, clk->ctrl_reg);
+	udelay(50);
+	val &= ~(clk->ctrl_rst_mask);
+	writel(val, clk->ctrl_reg);
+
+	val = readl(clk->phy_reg);
+	val |= clk->phy_clk_mask;
+	val &= ~(clk->phy_rst_mask);
+	writel(val, clk->phy_reg);
+	mdelay(10);
+
+	val &= ~(clk->phy_clk_mask);
+	val |= clk->phy_rst_mask;
+	writel(val, clk->phy_reg);
+	mdelay(10);
+
+	val |= clk->phy_clk_mask;
+	val &= ~(clk->phy_rst_mask);
+	writel(val, clk->phy_reg);
+	mdelay(30);
+	return 0;
+}
+
+static void clk_ether_disable(struct clk_hw *hw)
+{
+	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
+	u32 val;
+
+	val = readl(clk->ctrl_reg);
+	val &= ~(clk->ctrl_clk_mask);
+	writel(val, clk->ctrl_reg);
+}
+
+static struct clk_ops clk_ether_ops = {
+	.enable = clk_ether_enable,
+	.disable = clk_ether_disable,
+};
+
+static int clk_complex_enable(struct clk_hw *hw)
+{
+	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
+	u32 val;
+
+	val = readl(clk->ctrl_reg);
+	val |= clk->ctrl_clk_mask;
+	val &= ~(clk->ctrl_rst_mask);
+	writel(val, clk->ctrl_reg);
+
+	val = readl(clk->phy_reg);
+	val |= clk->phy_clk_mask;
+	val &= ~(clk->phy_rst_mask);
+	writel(val, clk->phy_reg);
+
+	return 0;
+}
+
+static void clk_complex_disable(struct clk_hw *hw)
+{
+	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
+	u32 val;
+
+	val = readl(clk->ctrl_reg);
+	val |= clk->ctrl_rst_mask;
+	val &= ~(clk->ctrl_clk_mask);
+	writel(val, clk->ctrl_reg);
+
+	val = readl(clk->phy_reg);
+	val |= clk->phy_rst_mask;
+	val &= ~(clk->phy_clk_mask);
+	writel(val, clk->phy_reg);
+
+	return;
+}
+
+static struct clk_ops clk_complex_ops = {
+	.enable = clk_complex_enable,
+	.disable = clk_complex_disable,
+};
+
+void __init hix5hd2_clk_register_complex_clk(struct hix5hd2_complex_clock *clks,
+				       int nums, struct hisi_clock_data *data)
+{
+	void __iomem *base = data->base;
+	int i;
+
+	for (i = 0; i < nums; i++) {
+		struct hix5hd2_clk_complex *p_clk;
+		struct clk *clk;
+		struct clk_init_data init;
+
+		p_clk = kzalloc(sizeof(*p_clk), GFP_KERNEL);
+		if (!p_clk) {
+			pr_err("%s: fail to allocate clk\n", __func__);
+			return;
+		}
+
+		init.name = clks[i].name;
+		if (clks[i].type == TYPE_ETHER)
+			init.ops = &clk_ether_ops;
+		else
+			init.ops = &clk_complex_ops;
+
+		init.flags = CLK_IS_BASIC;
+		init.parent_names =
+			(clks[i].parent_name ? &clks[i].parent_name : NULL);
+		init.num_parents = (clks[i].parent_name ? 1 : 0);
+
+		p_clk->ctrl_reg = base + clks[i].ctrl_reg;
+		p_clk->ctrl_clk_mask = clks[i].ctrl_clk_mask;
+		p_clk->ctrl_rst_mask = clks[i].ctrl_rst_mask;
+		p_clk->phy_reg = base + clks[i].phy_reg;
+		p_clk->phy_clk_mask = clks[i].phy_clk_mask;
+		p_clk->phy_rst_mask = clks[i].phy_rst_mask;
+		p_clk->hw.init = &init;
+
+		clk = clk_register(NULL, &p_clk->hw);
+		if (IS_ERR(clk)) {
+			kfree(p_clk);
+			pr_err("%s: failed to register clock %s\n",
+			       __func__, clks[i].name);
+			continue;
+		}
+
+		data->clk_data.clks[clks[i].id] = clk;
+	}
+}
+
 static void __init hix5hd2_clk_init(struct device_node *np)
 {
 	struct hisi_clock_data *clk_data;
@@ -96,6 +276,8 @@ static void __init hix5hd2_clk_init(struct device_node *np)
 					clk_data);
 	hisi_clk_register_gate(hix5hd2_gate_clks,
 			ARRAY_SIZE(hix5hd2_gate_clks), clk_data);
+	hix5hd2_clk_register_complex_clk(hix5hd2_complex_clks,
+			ARRAY_SIZE(hix5hd2_complex_clks), clk_data);
 }
 
 CLK_OF_DECLARE(hix5hd2_clk, "hisilicon,hix5hd2-clock", hix5hd2_clk_init);
diff --git a/include/dt-bindings/clock/hix5hd2-clock.h b/include/dt-bindings/clock/hix5hd2-clock.h
index aad579a..e328669 100644
--- a/include/dt-bindings/clock/hix5hd2-clock.h
+++ b/include/dt-bindings/clock/hix5hd2-clock.h
@@ -53,6 +53,15 @@
 #define HIX5HD2_MMC_CIU_CLK		130
 #define HIX5HD2_MMC_BIU_CLK		131
 #define HIX5HD2_MMC_CIU_RST		132
+#define HIX5HD2_FWD_BUS_CLK		133
+#define HIX5HD2_FWD_SYS_CLK		134
+#define HIX5HD2_MAC0_PHY_CLK		135
+
+/* complex */
+#define HIX5HD2_MAC0_CLK		192
+#define HIX5HD2_MAC1_CLK		193
+#define HIX5HD2_SATA_CLK		194
+#define HIX5HD2_USB_CLK			195
 
 #define HIX5HD2_NR_CLKS			256
 #endif	/* __DTS_HIX5HD2_CLOCK_H */
-- 
1.7.9.5

RE: [PATCH 1/3] hix5hd2-clock: add complex clk

[David Laight]

From: Zhangfei Gao
...
> diff --git a/drivers/clk/hisilicon/clk-hix5hd2.c b/drivers/clk/hisilicon/clk-hix5hd2.c
> index e5fcfb4..1b1347f 100644
> --- a/drivers/clk/hisilicon/clk-hix5hd2.c
> +++ b/drivers/clk/hisilicon/clk-hix5hd2.c
> @@ -9,6 +9,8 @@
> 
>  #include <linux/of_address.h>
>  #include <dt-bindings/clock/hix5hd2-clock.h>
> +#include <linux/slab.h>
> +#include <linux/delay.h>
>  #include "clk.h"
> 
>  static struct hisi_fixed_rate_clock hix5hd2_fixed_rate_clks[] __initdata = {
> @@ -79,8 +81,186 @@ static struct hisi_gate_clock hix5hd2_gate_clks[] __initdata = {
>  		CLK_SET_RATE_PARENT, 0xa0, 1, 0, },
>  	{ HIX5HD2_MMC_CIU_RST, "rst_mmc_ciu", "clk_mmc_ciu",
>  		CLK_SET_RATE_PARENT, 0xa0, 4, CLK_GATE_SET_TO_DISABLE, },
> +	/*gsf*/
> +	{ HIX5HD2_FWD_BUS_CLK, "clk_fwd_bus", NULL, 0, 0xcc, 0, 0, },
> +	{ HIX5HD2_FWD_SYS_CLK, "clk_fwd_sys", "clk_fwd_bus", 0, 0xcc, 5, 0, },
> +	{ HIX5HD2_MAC0_PHY_CLK, "clk_fephy", "clk_fwd_sys",
> +		 CLK_SET_RATE_PARENT, 0x120, 0, 0, },
>  };
> 
> +enum {TYPE_COMPLEX, TYPE_ETHER};

Shouldn't this be a named enum to make it more obvious
where the values should be used?

> +
> +struct hix5hd2_complex_clock {
> +	unsigned int	id;

Reorder the fields to avoid the implicit pad here.

> +	const char	*name;
> +	const char	*parent_name;
> +	u32		ctrl_reg;
> +	u32		ctrl_clk_mask;
> +	u32		ctrl_rst_mask;
> +	u32		phy_reg;
> +	u32		phy_clk_mask;
> +	u32		phy_rst_mask;
> +	u32		type;
> +};
> +
> +struct hix5hd2_clk_complex {
> +	struct clk_hw	hw;
> +	u32		id;
> +	void __iomem	*ctrl_reg;
> +	u32		ctrl_clk_mask;
> +	u32		ctrl_rst_mask;
> +	void __iomem	*phy_reg;
> +	u32		phy_clk_mask;
> +	u32		phy_rst_mask;
> +};
> +
> +static struct hix5hd2_complex_clock hix5hd2_complex_clks[] __initdata = {
> +	{HIX5HD2_MAC0_CLK, "clk_mac0", "clk_fephy",
> +		0xcc, 0xa, 0x500, 0x120, 0, 0x10, TYPE_ETHER},
> +	{HIX5HD2_MAC1_CLK, "clk_mac1", "clk_fwd_sys",
> +		0xcc, 0x14, 0xa00, 0x168, 0x2, 0, TYPE_ETHER},
> +	{HIX5HD2_SATA_CLK, "clk_sata", NULL,
> +		0xa8, 0x1f, 0x300, 0xac, 0x1, 0x0, TYPE_COMPLEX},
> +	{HIX5HD2_USB_CLK, "clk_usb", NULL,
> +		0xb8, 0xff, 0x3f00, 0xbc, 0x7, 0x3f00, TYPE_COMPLEX},
> +};
> +
> +#define to_complex_clk(_hw) container_of(_hw, struct hix5hd2_clk_complex, hw)
> +
> +static int clk_ether_enable(struct clk_hw *hw)
> +{
> +	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
> +	u32 val;
> +
> +	val = readl(clk->ctrl_reg);
> +	val |= clk->ctrl_clk_mask | clk->ctrl_rst_mask;
> +	writel(val, clk->ctrl_reg);
> +	udelay(50);
> +	val &= ~(clk->ctrl_rst_mask);
> +	writel(val, clk->ctrl_reg);

I'd need to be convinced that the udelay() has the desired effect.
I suspect you are trying to assert reset for a minimum period.
However the first write can be 'posted' by all sorts of hardware
for all sorts of reasons - so the writes can actually be back to back.

	David

> +
> +	val = readl(clk->phy_reg);
> +	val |= clk->phy_clk_mask;
> +	val &= ~(clk->phy_rst_mask);
> +	writel(val, clk->phy_reg);
> +	mdelay(10);
> +
> +	val &= ~(clk->phy_clk_mask);
> +	val |= clk->phy_rst_mask;
> +	writel(val, clk->phy_reg);
> +	mdelay(10);
> +
> +	val |= clk->phy_clk_mask;
> +	val &= ~(clk->phy_rst_mask);
> +	writel(val, clk->phy_reg);
> +	mdelay(30);
> +	return 0;
> +}
> +
> +static void clk_ether_disable(struct clk_hw *hw)
> +{
> +	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
> +	u32 val;
> +
> +	val = readl(clk->ctrl_reg);
> +	val &= ~(clk->ctrl_clk_mask);
> +	writel(val, clk->ctrl_reg);
> +}
> +
> +static struct clk_ops clk_ether_ops = {
> +	.enable = clk_ether_enable,
> +	.disable = clk_ether_disable,
> +};
> +
> +static int clk_complex_enable(struct clk_hw *hw)
> +{
> +	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
> +	u32 val;
> +
> +	val = readl(clk->ctrl_reg);
> +	val |= clk->ctrl_clk_mask;
> +	val &= ~(clk->ctrl_rst_mask);
> +	writel(val, clk->ctrl_reg);
> +
> +	val = readl(clk->phy_reg);
> +	val |= clk->phy_clk_mask;
> +	val &= ~(clk->phy_rst_mask);
> +	writel(val, clk->phy_reg);
> +
> +	return 0;
> +}
> +
> +static void clk_complex_disable(struct clk_hw *hw)
> +{
> +	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
> +	u32 val;
> +
> +	val = readl(clk->ctrl_reg);
> +	val |= clk->ctrl_rst_mask;
> +	val &= ~(clk->ctrl_clk_mask);
> +	writel(val, clk->ctrl_reg);
> +
> +	val = readl(clk->phy_reg);
> +	val |= clk->phy_rst_mask;
> +	val &= ~(clk->phy_clk_mask);
> +	writel(val, clk->phy_reg);
> +
> +	return;
> +}
> +
> +static struct clk_ops clk_complex_ops = {
> +	.enable = clk_complex_enable,
> +	.disable = clk_complex_disable,
> +};
> +
> +void __init hix5hd2_clk_register_complex_clk(struct hix5hd2_complex_clock *clks,
> +				       int nums, struct hisi_clock_data *data)
> +{
> +	void __iomem *base = data->base;
> +	int i;
> +
> +	for (i = 0; i < nums; i++) {
> +		struct hix5hd2_clk_complex *p_clk;
> +		struct clk *clk;
> +		struct clk_init_data init;
> +
> +		p_clk = kzalloc(sizeof(*p_clk), GFP_KERNEL);
> +		if (!p_clk) {
> +			pr_err("%s: fail to allocate clk\n", __func__);
> +			return;
> +		}
> +
> +		init.name = clks[i].name;
> +		if (clks[i].type == TYPE_ETHER)
> +			init.ops = &clk_ether_ops;
> +		else
> +			init.ops = &clk_complex_ops;
> +
> +		init.flags = CLK_IS_BASIC;
> +		init.parent_names =
> +			(clks[i].parent_name ? &clks[i].parent_name : NULL);
> +		init.num_parents = (clks[i].parent_name ? 1 : 0);
> +
> +		p_clk->ctrl_reg = base + clks[i].ctrl_reg;
> +		p_clk->ctrl_clk_mask = clks[i].ctrl_clk_mask;
> +		p_clk->ctrl_rst_mask = clks[i].ctrl_rst_mask;
> +		p_clk->phy_reg = base + clks[i].phy_reg;
> +		p_clk->phy_clk_mask = clks[i].phy_clk_mask;
> +		p_clk->phy_rst_mask = clks[i].phy_rst_mask;
> +		p_clk->hw.init = &init;
> +
> +		clk = clk_register(NULL, &p_clk->hw);
> +		if (IS_ERR(clk)) {
> +			kfree(p_clk);
> +			pr_err("%s: failed to register clock %s\n",
> +			       __func__, clks[i].name);
> +			continue;
> +		}
> +
> +		data->clk_data.clks[clks[i].id] = clk;
> +	}
> +}
> +
>  static void __init hix5hd2_clk_init(struct device_node *np)
>  {
>  	struct hisi_clock_data *clk_data;
> @@ -96,6 +276,8 @@ static void __init hix5hd2_clk_init(struct device_node *np)
>  					clk_data);
>  	hisi_clk_register_gate(hix5hd2_gate_clks,
>  			ARRAY_SIZE(hix5hd2_gate_clks), clk_data);
> +	hix5hd2_clk_register_complex_clk(hix5hd2_complex_clks,
> +			ARRAY_SIZE(hix5hd2_complex_clks), clk_data);
>  }
> 
>  CLK_OF_DECLARE(hix5hd2_clk, "hisilicon,hix5hd2-clock", hix5hd2_clk_init);
> diff --git a/include/dt-bindings/clock/hix5hd2-clock.h b/include/dt-bindings/clock/hix5hd2-clock.h
> index aad579a..e328669 100644
> --- a/include/dt-bindings/clock/hix5hd2-clock.h
> +++ b/include/dt-bindings/clock/hix5hd2-clock.h
> @@ -53,6 +53,15 @@
>  #define HIX5HD2_MMC_CIU_CLK		130
>  #define HIX5HD2_MMC_BIU_CLK		131
>  #define HIX5HD2_MMC_CIU_RST		132
> +#define HIX5HD2_FWD_BUS_CLK		133
> +#define HIX5HD2_FWD_SYS_CLK		134
> +#define HIX5HD2_MAC0_PHY_CLK		135
> +
> +/* complex */
> +#define HIX5HD2_MAC0_CLK		192
> +#define HIX5HD2_MAC1_CLK		193
> +#define HIX5HD2_SATA_CLK		194
> +#define HIX5HD2_USB_CLK			195
> 
>  #define HIX5HD2_NR_CLKS			256
>  #endif	/* __DTS_HIX5HD2_CLOCK_H */
> --
> 1.7.9.5

Re: [PATCH 1/3] hix5hd2-clock: add complex clk

[zhangfei]

Dear David

On 05/19/2014 09:11 PM, David Laight wrote:
> From: Zhangfei Gao
> ...
>> diff --git a/drivers/clk/hisilicon/clk-hix5hd2.c b/drivers/clk/hisilicon/clk-hix5hd2.c
>> index e5fcfb4..1b1347f 100644
>> --- a/drivers/clk/hisilicon/clk-hix5hd2.c
>> +++ b/drivers/clk/hisilicon/clk-hix5hd2.c
>> @@ -9,6 +9,8 @@
>>
>>   #include <linux/of_address.h>
>>   #include <dt-bindings/clock/hix5hd2-clock.h>
>> +#include <linux/slab.h>
>> +#include <linux/delay.h>
>>   #include "clk.h"
>>
>>   static struct hisi_fixed_rate_clock hix5hd2_fixed_rate_clks[] __initdata = {
>> @@ -79,8 +81,186 @@ static struct hisi_gate_clock hix5hd2_gate_clks[] __initdata = {
>>   		CLK_SET_RATE_PARENT, 0xa0, 1, 0, },
>>   	{ HIX5HD2_MMC_CIU_RST, "rst_mmc_ciu", "clk_mmc_ciu",
>>   		CLK_SET_RATE_PARENT, 0xa0, 4, CLK_GATE_SET_TO_DISABLE, },
>> +	/*gsf*/
>> +	{ HIX5HD2_FWD_BUS_CLK, "clk_fwd_bus", NULL, 0, 0xcc, 0, 0, },
>> +	{ HIX5HD2_FWD_SYS_CLK, "clk_fwd_sys", "clk_fwd_bus", 0, 0xcc, 5, 0, },
>> +	{ HIX5HD2_MAC0_PHY_CLK, "clk_fephy", "clk_fwd_sys",
>> +		 CLK_SET_RATE_PARENT, 0x120, 0, 0, },
>>   };
>>
>> +enum {TYPE_COMPLEX, TYPE_ETHER};
>
> Shouldn't this be a named enum to make it more obvious
> where the values should be used?
Yes, it's better.
>
>> +
>> +struct hix5hd2_complex_clock {
>> +	unsigned int	id;
>
> Reorder the fields to avoid the implicit pad here.
Curious, what's the impact if there is a pad.
It may inconsistent with other table.

>
>> +	const char	*name;
>> +	const char	*parent_name;
>> +	u32		ctrl_reg;
>> +	u32		ctrl_clk_mask;
>> +	u32		ctrl_rst_mask;
>> +	u32		phy_reg;
>> +	u32		phy_clk_mask;
>> +	u32		phy_rst_mask;
>> +	u32		type;
>> +};
>> +
>> +struct hix5hd2_clk_complex {
>> +	struct clk_hw	hw;
>> +	u32		id;
>> +	void __iomem	*ctrl_reg;
>> +	u32		ctrl_clk_mask;
>> +	u32		ctrl_rst_mask;
>> +	void __iomem	*phy_reg;
>> +	u32		phy_clk_mask;
>> +	u32		phy_rst_mask;
>> +};
>> +
>> +static struct hix5hd2_complex_clock hix5hd2_complex_clks[] __initdata = {
>> +	{HIX5HD2_MAC0_CLK, "clk_mac0", "clk_fephy",
>> +		0xcc, 0xa, 0x500, 0x120, 0, 0x10, TYPE_ETHER},
>> +	{HIX5HD2_MAC1_CLK, "clk_mac1", "clk_fwd_sys",
>> +		0xcc, 0x14, 0xa00, 0x168, 0x2, 0, TYPE_ETHER},
>> +	{HIX5HD2_SATA_CLK, "clk_sata", NULL,
>> +		0xa8, 0x1f, 0x300, 0xac, 0x1, 0x0, TYPE_COMPLEX},
>> +	{HIX5HD2_USB_CLK, "clk_usb", NULL,
>> +		0xb8, 0xff, 0x3f00, 0xbc, 0x7, 0x3f00, TYPE_COMPLEX},
>> +};
>> +
>> +#define to_complex_clk(_hw) container_of(_hw, struct hix5hd2_clk_complex, hw)
>> +
>> +static int clk_ether_enable(struct clk_hw *hw)
>> +{
>> +	struct hix5hd2_clk_complex *clk = to_complex_clk(hw);
>> +	u32 val;
>> +
>> +	val = readl(clk->ctrl_reg);
>> +	val |= clk->ctrl_clk_mask | clk->ctrl_rst_mask;
>> +	writel(val, clk->ctrl_reg);
>> +	udelay(50);
>> +	val &= ~(clk->ctrl_rst_mask);
>> +	writel(val, clk->ctrl_reg);
>
> I'd need to be convinced that the udelay() has the desired effect.
> I suspect you are trying to assert reset for a minimum period.
Yes, it is just want to make sure the reset takeing effect.
In fact, it works without udelay here, it is not required as timing as 
the following mdelay.

> However the first write can be 'posted' by all sorts of hardware
> for all sorts of reasons - so the writes can actually be back to back.
Sorry, not understand.
Do you mean the first write will not take effect immediately, so the two 
write happens continuously.
What's the recommended behavior?

Will use readl_relaxed & writel_relaxed instead.

>
> 	David
>
>> +
>> +	val = readl(clk->phy_reg);
>> +	val |= clk->phy_clk_mask;
>> +	val &= ~(clk->phy_rst_mask);
>> +	writel(val, clk->phy_reg);
>> +	mdelay(10);
>> +
>> +	val &= ~(clk->phy_clk_mask);
>> +	val |= clk->phy_rst_mask;
>> +	writel(val, clk->phy_reg);
>> +	mdelay(10);
>> +
>> +	val |= clk->phy_clk_mask;
>> +	val &= ~(clk->phy_rst_mask);
>> +	writel(val, clk->phy_reg);
>> +	mdelay(30);
>> +	return 0;
>> +}
>> +

Thanks

[PATCH 2/3] Documentation: add Device tree bindings for Hisilicon hix5hd2 ethernet

[Zhangfei Gao]

Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
---
 .../bindings/net/hisilicon-hix5hd2-net.txt         |   37 ++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt

diff --git a/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt b/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt
new file mode 100644
index 0000000..16b1f0e
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt
@@ -0,0 +1,37 @@
+Hisilicon hix5hd2 Ethernet Controller
+
+Required properties:
+- compatible: should be "hisilicon,hix5hd2-mac".
+- reg : Specifies base physical address(s) and size of the device registers.
+  The first region is the mac register base and size.
+  The second region is external interface control register.
+- interrupts: Should contain the MAC interrupts
+- #address-cells: Must be <1>.
+- #size-cells: Must be <0>.
+- phy-mode: see ethernet.txt [1].
+- phy-handle: see ethernet.txt [1].
+- mac-address: see ethernet.txt [1].
+- clocks: clock phandle and specifier pair.
+
+- phy subnode: inherits from phy binding [2]
+
+[1] Documentation/devicetree/bindings/net/ethernet.txt
+[2] Documentation/devicetree/bindings/net/phy.txt
+
+Example:
+	gmac0: ethernet@f9840000 {
+		compatible = "hisilicon,hix5hd2-mac";
+		reg = <0xf9840000 0x1000>,<0xf984300c 0x4>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		phy-handle = <&phy0>;
+		phy-mode = "mii";
+		mac-address = [00 00 00 00 00 00];
+		interrupts = <0 71 4>;
+		clocks = <&clock HIX5HD2_MAC0_CLK>;
+
+		phy0: ethernet-phy@2 {
+			reg = <2>;
+			compatible = "ethernet-phy-ieee802.3-c22";
+		};
+	};
-- 
1.7.9.5

Re: [PATCH 2/3] Documentation: add Device tree bindings for Hisilicon hix5hd2 ethernet

[Sergei Shtylyov]

Hello.

On 05/19/2014 04:57 PM, Zhangfei Gao wrote:

> Signed-off-by: Zhangfei Gao <zhangfei.gao-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
> ---
>   .../bindings/net/hisilicon-hix5hd2-net.txt         |   37 ++++++++++++++++++++
>   1 file changed, 37 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt

> diff --git a/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt b/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt
> new file mode 100644
> index 0000000..16b1f0e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/hisilicon-hix5hd2-net.txt
> @@ -0,0 +1,37 @@
> +Hisilicon hix5hd2 Ethernet Controller
> +
> +Required properties:
> +- compatible: should be "hisilicon,hix5hd2-mac".
> +- reg : Specifies base physical address(s) and size of the device registers.

    Er, I must note that the colon style here is not consistent with the rest 
of the properties, i.e. there's space before the colon here, while in other 
cases there's none.

> +  The first region is the mac register base and size.

    s/mac/MAC/.

> +  The second region is external interface control register.
> +- interrupts: Should contain the MAC interrupts
> +- #address-cells: Must be <1>.
> +- #size-cells: Must be <0>.

    Descriptions should consistently start with a lower case, I think...

> +- phy-mode: see ethernet.txt [1].
> +- phy-handle: see ethernet.txt [1].
> +- mac-address: see ethernet.txt [1].
> +- clocks: clock phandle and specifier pair.
> +
> +- phy subnode: inherits from phy binding [2]

    s/phy/PHY/.

> +
> +[1] Documentation/devicetree/bindings/net/ethernet.txt
> +[2] Documentation/devicetree/bindings/net/phy.txt
> +
> +Example:
> +	gmac0: ethernet@f9840000 {
> +		compatible = "hisilicon,hix5hd2-mac";
> +		reg = <0xf9840000 0x1000>,<0xf984300c 0x4>;
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +		phy-handle = <&phy0>;
> +		phy-mode = "mii";
> +		mac-address = [00 00 00 00 00 00];

    Don't think that's a good value, unless this is only a placeholder.

> +		interrupts = <0 71 4>;
> +		clocks = <&clock HIX5HD2_MAC0_CLK>;
> +
> +		phy0: ethernet-phy@2 {

    I'd rather label ut phy2...

> +			reg = <2>;
> +			compatible = "ethernet-phy-ieee802.3-c22";

    This is the default "compatible", i.e. there's no need to specify it, IIRC.

> +		};
> +	};

WBR, Sergei

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/3] Documentation: add Device tree bindings for Hisilicon hix5hd2 ethernet

[zhangfei]

On 05/20/2014 12:26 AM, Sergei Shtylyov wrote:
> On 05/19/2014 04:57 PM, Zhangfei Gao wrote:
>> +Hisilicon hix5hd2 Ethernet Controller
>> +
>> +Required properties:
>> +- compatible: should be "hisilicon,hix5hd2-mac".
>> +- reg : Specifies base physical address(s) and size of the device
>> registers.
>
>     Er, I must note that the colon style here is not consistent with the
> rest of the properties, i.e. there's space before the colon here, while
> in other cases there's none.
Will remove the space.

>
>> +  The first region is the mac register base and size.
>
>     s/mac/MAC/.
>
>> +  The second region is external interface control register.
>> +- interrupts: Should contain the MAC interrupts
>> +- #address-cells: Must be <1>.
>> +- #size-cells: Must be <0>.
>
>     Descriptions should consistently start with a lower case, I think...
OK.
>
>> +- phy-mode: see ethernet.txt [1].
>> +- phy-handle: see ethernet.txt [1].
>> +- mac-address: see ethernet.txt [1].
>> +- clocks: clock phandle and specifier pair.
>> +
>> +- phy subnode: inherits from phy binding [2]
>
>     s/phy/PHY/.
>
>> +
>> +[1] Documentation/devicetree/bindings/net/ethernet.txt
>> +[2] Documentation/devicetree/bindings/net/phy.txt
>> +
>> +Example:
>> +    gmac0: ethernet@f9840000 {
>> +        compatible = "hisilicon,hix5hd2-mac";
>> +        reg = <0xf9840000 0x1000>,<0xf984300c 0x4>;
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +        phy-handle = <&phy0>;
>> +        phy-mode = "mii";
>> +        mac-address = [00 00 00 00 00 00];
>
>     Don't think that's a good value, unless this is only a placeholder.
Yes, mac-address is placeholder here and would be filled by boot-loader.
Otherwise random mac addr will be used.

>
>> +        interrupts = <0 71 4>;
>> +        clocks = <&clock HIX5HD2_MAC0_CLK>;
>> +
>> +        phy0: ethernet-phy@2 {
>
>     I'd rather label ut phy2...
OK
>
>> +            reg = <2>;
>> +            compatible = "ethernet-phy-ieee802.3-c22";
>
>     This is the default "compatible", i.e. there's no need to specify
> it, IIRC.
Got it, find it is clarified in phy.txt.

Thanks
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[Zhangfei Gao]

Add support for the hix5hd2 XGMAC 1Gb ethernet device.
The controller requires two queues for tx and two queues for rx.
Controller fetch buffer from free queue and then push to used queue.
Diver should prepare free queue and free buffer from used queue.

Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
---
 drivers/net/ethernet/Kconfig             |    1 +
 drivers/net/ethernet/Makefile            |    1 +
 drivers/net/ethernet/hisilicon/Kconfig   |   27 +
 drivers/net/ethernet/hisilicon/Makefile  |    5 +
 drivers/net/ethernet/hisilicon/hix5hd2.c | 1068 ++++++++++++++++++++++++++++++
 5 files changed, 1102 insertions(+)
 create mode 100644 drivers/net/ethernet/hisilicon/Kconfig
 create mode 100644 drivers/net/ethernet/hisilicon/Makefile
 create mode 100644 drivers/net/ethernet/hisilicon/hix5hd2.c

diff --git a/drivers/net/ethernet/Kconfig b/drivers/net/ethernet/Kconfig
index 39b26fe..0fbdeb1 100644
--- a/drivers/net/ethernet/Kconfig
+++ b/drivers/net/ethernet/Kconfig
@@ -55,6 +55,7 @@ source "drivers/net/ethernet/neterion/Kconfig"
 source "drivers/net/ethernet/faraday/Kconfig"
 source "drivers/net/ethernet/freescale/Kconfig"
 source "drivers/net/ethernet/fujitsu/Kconfig"
+source "drivers/net/ethernet/hisilicon/Kconfig"
 source "drivers/net/ethernet/hp/Kconfig"
 source "drivers/net/ethernet/ibm/Kconfig"
 source "drivers/net/ethernet/intel/Kconfig"
diff --git a/drivers/net/ethernet/Makefile b/drivers/net/ethernet/Makefile
index 545d0b3..dc78996 100644
--- a/drivers/net/ethernet/Makefile
+++ b/drivers/net/ethernet/Makefile
@@ -30,6 +30,7 @@ obj-$(CONFIG_NET_VENDOR_EXAR) += neterion/
 obj-$(CONFIG_NET_VENDOR_FARADAY) += faraday/
 obj-$(CONFIG_NET_VENDOR_FREESCALE) += freescale/
 obj-$(CONFIG_NET_VENDOR_FUJITSU) += fujitsu/
+obj-$(CONFIG_NET_VENDOR_HISILICON) += hisilicon/
 obj-$(CONFIG_NET_VENDOR_HP) += hp/
 obj-$(CONFIG_NET_VENDOR_IBM) += ibm/
 obj-$(CONFIG_NET_VENDOR_INTEL) += intel/
diff --git a/drivers/net/ethernet/hisilicon/Kconfig b/drivers/net/ethernet/hisilicon/Kconfig
new file mode 100644
index 0000000..da144fc
--- /dev/null
+++ b/drivers/net/ethernet/hisilicon/Kconfig
@@ -0,0 +1,27 @@
+#
+# HISILICON device configuration
+#
+
+config NET_VENDOR_HISILICON
+	bool "Hisilicon devices"
+	default y
+	depends on ARM
+	---help---
+	  If you have a network (Ethernet) card belonging to this class, say Y
+	  and read the Ethernet-HOWTO, available from
+	  <http://www.tldp.org/docs.html#howto>.
+
+	  Note that the answer to this question doesn't directly affect the
+	  kernel: saying N will just cause the configurator to skip all
+	  the questions about Hisilicon devices. If you say Y, you will be asked
+	  for your specific card in the following questions.
+
+if NET_VENDOR_HISILICON
+
+config HIX5HD2_GMAC
+	tristate "Hisilicon X5HD2 Family Network Device Support"
+	select PHYLIB
+	help
+	  This selects the hix5hd2 mac family network device.
+
+endif # NET_VENDOR_HISILICON
diff --git a/drivers/net/ethernet/hisilicon/Makefile b/drivers/net/ethernet/hisilicon/Makefile
new file mode 100644
index 0000000..9f6e71a
--- /dev/null
+++ b/drivers/net/ethernet/hisilicon/Makefile
@@ -0,0 +1,5 @@
+#
+# Makefile for the HISILICON network device drivers.
+#
+
+obj-$(CONFIG_HIX5HD2_GMAC) += hix5hd2.o
diff --git a/drivers/net/ethernet/hisilicon/hix5hd2.c b/drivers/net/ethernet/hisilicon/hix5hd2.c
new file mode 100644
index 0000000..f37e893
--- /dev/null
+++ b/drivers/net/ethernet/hisilicon/hix5hd2.c
@@ -0,0 +1,1068 @@
+/* Copyright (c) 2014 Linaro Ltd.
+ * Copyright (c) 2014 Hisilicon Limited.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ */
+
+#include <linux/module.h>
+#include <linux/interrupt.h>
+#include <linux/etherdevice.h>
+#include <linux/platform_device.h>
+#include <linux/of_net.h>
+#include <linux/of_mdio.h>
+#include <linux/clk.h>
+#include <linux/circ_buf.h>
+
+#define STATION_ADDR_LOW		0x0000
+#define STATION_ADDR_HIGH		0x0004
+#define MAC_DUPLEX_HALF_CTRL		0x0008
+#define MAX_FRM_SIZE			0x003c
+#define PORT_MODE			0x0040
+#define PORT_EN				0x0044
+#define BITS_TX_EN			BIT(2)
+#define BITS_RX_EN			BIT(1)
+#define REC_FILT_CONTROL		0x0064
+#define BIT_CRC_ERR_PASS		BIT(5)
+#define BIT_PAUSE_FRM_PASS		BIT(4)
+#define BIT_VLAN_DROP_EN		BIT(3)
+#define BIT_BC_DROP_EN			BIT(2)
+#define BIT_MC_MATCH_EN			BIT(1)
+#define BIT_UC_MATCH_EN			BIT(0)
+#define PORT_MC_ADDR_LOW		0x0068
+#define PORT_MC_ADDR_HIGH		0x006C
+#define CF_CRC_STRIP			0x01b0
+#define MODE_CHANGE_EN			0x01b4
+#define BIT_MODE_CHANGE_EN		BIT(0)
+#define COL_SLOT_TIME			0x01c0
+#define RECV_CONTROL			0x01e0
+#define BIT_STRIP_PAD_EN		BIT(3)
+#define BIT_RUNT_PKT_EN			BIT(4)
+#define CONTROL_WORD			0x0214
+#define MDIO_SINGLE_CMD			0x03c0
+#define MDIO_SINGLE_DATA		0x03c4
+#define MDIO_CTRL			0x03cc
+#define MDIO_RDATA_STATUS		0x03d0
+
+#define MDIO_START			BIT(20)
+#define MDIO_R_VALID			BIT(0)
+#define MDIO_READ			(BIT(17) | MDIO_START)
+#define MDIO_WRITE			(BIT(16) | MDIO_START)
+
+#define RX_FQ_START_ADDR		0x0500
+#define RX_FQ_DEPTH			0x0504
+#define RX_FQ_WR_ADDR			0x0508
+#define RX_FQ_RD_ADDR			0x050c
+#define RX_FQ_VLDDESC_CNT		0x0510
+#define RX_FQ_ALEMPTY_TH		0x0514
+#define RX_FQ_REG_EN			0x0518
+#define BITS_RX_FQ_START_ADDR_EN	BIT(2)
+#define BITS_RX_FQ_DEPTH_EN		BIT(1)
+#define BITS_RX_FQ_RD_ADDR_EN		BIT(0)
+#define RX_FQ_ALFULL_TH			0x051c
+#define RX_BQ_START_ADDR		0x0520
+#define RX_BQ_DEPTH			0x0524
+#define RX_BQ_WR_ADDR			0x0528
+#define RX_BQ_RD_ADDR			0x052c
+#define RX_BQ_FREE_DESC_CNT		0x0530
+#define RX_BQ_ALEMPTY_TH		0x0534
+#define RX_BQ_REG_EN			0x0538
+#define BITS_RX_BQ_START_ADDR_EN	BIT(2)
+#define BITS_RX_BQ_DEPTH_EN		BIT(1)
+#define BITS_RX_BQ_WR_ADDR_EN		BIT(0)
+#define RX_BQ_ALFULL_TH			0x053c
+#define TX_BQ_START_ADDR		0x0580
+#define TX_BQ_DEPTH			0x0584
+#define TX_BQ_WR_ADDR			0x0588
+#define TX_BQ_RD_ADDR			0x058c
+#define TX_BQ_VLDDESC_CNT		0x0590
+#define TX_BQ_ALEMPTY_TH		0x0594
+#define TX_BQ_REG_EN			0x0598
+#define BITS_TX_BQ_START_ADDR_EN	BIT(2)
+#define BITS_TX_BQ_DEPTH_EN		BIT(1)
+#define BITS_TX_BQ_RD_ADDR_EN		BIT(0)
+#define TX_BQ_ALFULL_TH			0x059c
+#define TX_RQ_START_ADDR		0x05a0
+#define TX_RQ_DEPTH			0x05a4
+#define TX_RQ_WR_ADDR			0x05a8
+#define TX_RQ_RD_ADDR			0x05ac
+#define TX_RQ_FREE_DESC_CNT		0x05b0
+#define TX_RQ_ALEMPTY_TH		0x05b4
+#define TX_RQ_REG_EN			0x05b8
+#define BITS_TX_RQ_START_ADDR_EN	BIT(2)
+#define BITS_TX_RQ_DEPTH_EN		BIT(1)
+#define BITS_TX_RQ_WR_ADDR_EN		BIT(0)
+#define TX_RQ_ALFULL_TH			0x05bc
+#define RAW_PMU_INT			0x05c0
+#define ENA_PMU_INT			0x05c4
+#define STATUS_PMU_INT			0x05c8
+#define MAC_FIFO_ERR_IN			BIT(30)
+#define TX_RQ_IN_TIMEOUT_INT		BIT(29)
+#define RX_BQ_IN_TIMEOUT_INT		BIT(28)
+#define TXOUTCFF_FULL_INT		BIT(27)
+#define TXOUTCFF_EMPTY_INT		BIT(26)
+#define TXCFF_FULL_INT			BIT(25)
+#define TXCFF_EMPTY_INT			BIT(24)
+#define RXOUTCFF_FULL_INT		BIT(23)
+#define RXOUTCFF_EMPTY_INT		BIT(22)
+#define RXCFF_FULL_INT			BIT(21)
+#define RXCFF_EMPTY_INT			BIT(20)
+#define TX_RQ_IN_INT			BIT(19)
+#define TX_BQ_OUT_INT			BIT(18)
+#define RX_BQ_IN_INT			BIT(17)
+#define RX_FQ_OUT_INT			BIT(16)
+#define TX_RQ_EMPTY_INT			BIT(15)
+#define TX_RQ_FULL_INT			BIT(14)
+#define TX_RQ_ALEMPTY_INT		BIT(13)
+#define TX_RQ_ALFULL_INT		BIT(12)
+#define TX_BQ_EMPTY_INT			BIT(11)
+#define TX_BQ_FULL_INT			BIT(10)
+#define TX_BQ_ALEMPTY_INT		BIT(9)
+#define TX_BQ_ALFULL_INT		BIT(8)
+#define RX_BQ_EMPTY_INT			BIT(7)
+#define RX_BQ_FULL_INT			BIT(6)
+#define RX_BQ_ALEMPTY_INT		BIT(5)
+#define RX_BQ_ALFULL_INT		BIT(4)
+#define RX_FQ_EMPTY_INT			BIT(3)
+#define RX_FQ_FULL_INT			BIT(2)
+#define RX_FQ_ALEMPTY_INT		BIT(1)
+#define RX_FQ_ALFULL_INT		BIT(0)
+
+#define DEF_INT_MASK			(RX_BQ_IN_INT | RX_BQ_IN_TIMEOUT_INT | \
+					TX_RQ_IN_INT | TX_RQ_IN_TIMEOUT_INT)
+
+#define DESC_WR_RD_ENA			0x05cc
+#define IN_QUEUE_TH			0x05d8
+#define OUT_QUEUE_TH			0x05dc
+#define QUEUE_TX_BQ_SHIFT		16
+#define QUEUE_RX_FQ_SHIFT		0
+#define RX_BQ_IN_TIMEOUT_TH		0x05e0
+#define TX_RQ_IN_TIMEOUT_TH		0x05e4
+#define STOP_CMD			0x05e8
+#define BITS_TX_STOP			BIT(1)
+#define BITS_RX_STOP			BIT(0)
+#define FLUSH_CMD			0x05eC
+#define BITS_TX_FLUSH_CMD		BIT(5)
+#define BITS_RX_FLUSH_CMD		BIT(4)
+#define BITS_TX_FLUSH_FLAG_DOWN		BIT(3)
+#define BITS_TX_FLUSH_FLAG_UP		BIT(2)
+#define BITS_RX_FLUSH_FLAG_DOWN		BIT(1)
+#define BITS_RX_FLUSH_FLAG_UP		BIT(0)
+#define RX_CFF_NUM_REG			0x05f0
+#define PMU_FSM_REG			0x05f8
+#define RX_FIFO_PKT_IN_NUM		0x05fc
+#define RX_FIFO_PKT_OUT_NUM		0x0600
+
+#define RGMII_SPEED_1000		0x2c
+#define RGMII_SPEED_100			0x2f
+#define RGMII_SPEED_10			0x2d
+#define MII_SPEED_100			0x0f
+#define MII_SPEED_10			0x0d
+#define GMAC_SPEED_1000			0x05
+#define GMAC_SPEED_100			0x01
+#define GMAC_SPEED_10			0x00
+#define GMAC_FULL_DUPLEX		BIT(4)
+
+#define RX_BQ_INT_THRESHOLD		0x01
+#define TX_RQ_INT_THRESHOLD		0x01
+#define RX_BQ_IN_TIMEOUT		0x10000
+#define TX_RQ_IN_TIMEOUT		0x50000
+
+#define MAC_MAX_FRAME_SIZE		1600
+#define DESC_SIZE			32
+#define RX_DESC_NUM			1024
+#define TX_DESC_NUM			1024
+
+#define DESC_VLD_FREE			0
+#define DESC_VLD_BUSY			1
+#define DESC_FL_MID			0
+#define DESC_FL_LAST			1
+#define DESC_FL_FIRST			2
+#define DESC_FL_FULL			3
+
+/* DMA descriptor ring helpers */
+#define dma_ring_incr(n, s)		(((n) + 1) & ((s) - 1))
+#define dma_cnt(n)			((n) >> 5)
+#define dma_byte(n)			((n) << 5)
+
+struct hix5hd2_desc {
+	__le32 buff_addr;
+	__le32 buff_len:11;
+	__le32 reserve2:5;
+	__le32 data_len:11;
+	__le32 reserve1:2;
+	__le32 fl:2;
+	__le32 descvid:1;
+} __aligned(32);
+
+struct hix5hd2_desc_sw {
+	struct hix5hd2_desc *desc;
+	dma_addr_t	phys_addr;
+	unsigned int	count;
+	unsigned int	size;
+};
+
+#define QUEUE_NUMS	4
+struct hix5hd2_priv {
+	struct hix5hd2_desc_sw pool[QUEUE_NUMS];
+#define rx_fq		pool[0]
+#define rx_bq		pool[1]
+#define tx_bq		pool[2]
+#define tx_rq		pool[3]
+
+	void __iomem *base;
+	void __iomem *ctrl_base;
+
+	struct sk_buff *tx_skb[TX_DESC_NUM];
+	struct sk_buff *rx_skb[RX_DESC_NUM];
+
+	struct device *dev;
+	struct net_device *netdev;
+
+	struct phy_device *phy;
+	struct device_node *phy_node;
+	phy_interface_t	phy_mode;
+
+	unsigned int speed;
+	unsigned int duplex;
+
+	struct clk *clk;
+	struct mii_bus *bus;
+	struct napi_struct napi;
+	struct work_struct tx_timeout_task;
+};
+
+static void hix5hd2_config_port(struct net_device *dev, u32 speed, u32 duplex)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	u32 val;
+
+	priv->speed = speed;
+	priv->duplex = duplex;
+
+	switch (priv->phy_mode) {
+	case PHY_INTERFACE_MODE_RGMII:
+		if (speed == SPEED_1000)
+			val = RGMII_SPEED_1000;
+		else if (speed == SPEED_100)
+			val = RGMII_SPEED_100;
+		else
+			val = RGMII_SPEED_10;
+		break;
+	case PHY_INTERFACE_MODE_MII:
+		if (speed == SPEED_100)
+			val = MII_SPEED_100;
+		else
+			val = MII_SPEED_10;
+		break;
+	default:
+		netdev_warn(dev, "not supported mode\n");
+		val = MII_SPEED_10;
+		break;
+	}
+
+	if (duplex)
+		val |= GMAC_FULL_DUPLEX;
+	writel_relaxed(val, priv->ctrl_base);
+
+	writel_relaxed(BIT_MODE_CHANGE_EN, priv->base + MODE_CHANGE_EN);
+	if (speed == SPEED_1000)
+		val = GMAC_SPEED_1000;
+	else if (speed == SPEED_100)
+		val = GMAC_SPEED_100;
+	else
+		val = GMAC_SPEED_10;
+	writel_relaxed(val, priv->base + PORT_MODE);
+	writel_relaxed(0, priv->base + MODE_CHANGE_EN);
+	writel_relaxed(duplex, priv->base + MAC_DUPLEX_HALF_CTRL);
+}
+
+static void hix5hd2_set_desc_depth(struct hix5hd2_priv *priv, int rx, int tx)
+{
+	writel_relaxed(BITS_RX_FQ_DEPTH_EN, priv->base + RX_FQ_REG_EN);
+	writel_relaxed(rx << 3, priv->base + RX_FQ_DEPTH);
+	writel_relaxed(0, priv->base + RX_FQ_REG_EN);
+
+	writel_relaxed(BITS_RX_BQ_DEPTH_EN, priv->base + RX_BQ_REG_EN);
+	writel_relaxed(rx << 3, priv->base + RX_BQ_DEPTH);
+	writel_relaxed(0, priv->base + RX_BQ_REG_EN);
+
+	writel_relaxed(BITS_TX_BQ_DEPTH_EN, priv->base + TX_BQ_REG_EN);
+	writel_relaxed(tx << 3, priv->base + TX_BQ_DEPTH);
+	writel_relaxed(0, priv->base + TX_BQ_REG_EN);
+
+	writel_relaxed(BITS_TX_RQ_DEPTH_EN, priv->base + TX_RQ_REG_EN);
+	writel_relaxed(tx << 3, priv->base + TX_RQ_DEPTH);
+	writel_relaxed(0, priv->base + TX_RQ_REG_EN);
+}
+
+static void hix5hd2_set_rx_fq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
+{
+	writel_relaxed(BITS_RX_FQ_START_ADDR_EN, priv->base + RX_FQ_REG_EN);
+	writel_relaxed(phy_addr, priv->base + RX_FQ_START_ADDR);
+	writel_relaxed(0, priv->base + RX_FQ_REG_EN);
+}
+
+static void hix5hd2_set_rx_bq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
+{
+	writel_relaxed(BITS_RX_BQ_START_ADDR_EN, priv->base + RX_BQ_REG_EN);
+	writel_relaxed(phy_addr, priv->base + RX_BQ_START_ADDR);
+	writel_relaxed(0, priv->base + RX_BQ_REG_EN);
+}
+
+static void hix5hd2_set_tx_bq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
+{
+	writel_relaxed(BITS_TX_BQ_START_ADDR_EN, priv->base + TX_BQ_REG_EN);
+	writel_relaxed(phy_addr, priv->base + TX_BQ_START_ADDR);
+	writel_relaxed(0, priv->base + TX_BQ_REG_EN);
+}
+
+static void hix5hd2_set_tx_rq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
+{
+	writel_relaxed(BITS_TX_RQ_START_ADDR_EN, priv->base + TX_RQ_REG_EN);
+	writel_relaxed(phy_addr, priv->base + TX_RQ_START_ADDR);
+	writel_relaxed(0, priv->base + TX_RQ_REG_EN);
+}
+
+static void hix5hd2_set_desc_addr(struct hix5hd2_priv *priv)
+{
+	hix5hd2_set_rx_fq(priv, priv->rx_fq.phys_addr);
+	hix5hd2_set_rx_bq(priv, priv->rx_bq.phys_addr);
+	hix5hd2_set_tx_rq(priv, priv->tx_rq.phys_addr);
+	hix5hd2_set_tx_bq(priv, priv->tx_bq.phys_addr);
+}
+
+static void hix5hd2_hw_init(struct hix5hd2_priv *priv)
+{
+	u32 val;
+
+	/* disable and clear all interrupts */
+	writel_relaxed(0, priv->base + ENA_PMU_INT);
+	writel_relaxed(~0, priv->base + RAW_PMU_INT);
+
+	writel_relaxed(BIT_CRC_ERR_PASS, priv->base + REC_FILT_CONTROL);
+	writel_relaxed(MAC_MAX_FRAME_SIZE, priv->base + CONTROL_WORD);
+	writel_relaxed(0, priv->base + COL_SLOT_TIME);
+
+	val = RX_BQ_INT_THRESHOLD << QUEUE_RX_FQ_SHIFT |
+		TX_RQ_INT_THRESHOLD << QUEUE_TX_BQ_SHIFT;
+	writel_relaxed(val, priv->base + IN_QUEUE_TH);
+
+	writel_relaxed(RX_BQ_IN_TIMEOUT, priv->base + RX_BQ_IN_TIMEOUT_TH);
+	writel_relaxed(TX_RQ_IN_TIMEOUT, priv->base + TX_RQ_IN_TIMEOUT_TH);
+
+	hix5hd2_set_desc_depth(priv, RX_DESC_NUM, TX_DESC_NUM);
+	hix5hd2_set_desc_addr(priv);
+}
+
+static void hix5hd2_irq_enable(struct hix5hd2_priv *priv)
+{
+	writel_relaxed(DEF_INT_MASK, priv->base + ENA_PMU_INT);
+}
+
+static void hix5hd2_irq_disable(struct hix5hd2_priv *priv)
+{
+	writel_relaxed(0, priv->base + ENA_PMU_INT);
+}
+
+static void hix5hd2_port_enable(struct hix5hd2_priv *priv)
+{
+	writel_relaxed(0xf, priv->base + DESC_WR_RD_ENA);
+	writel_relaxed(BITS_RX_EN | BITS_TX_EN, priv->base + PORT_EN);
+}
+
+static void hix5hd2_port_disable(struct hix5hd2_priv *priv)
+{
+	writel_relaxed(~(BITS_RX_EN | BITS_TX_EN), priv->base + PORT_EN);
+	writel_relaxed(0, priv->base + DESC_WR_RD_ENA);
+}
+
+static void hix5hd2_hw_set_mac_addr(struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	unsigned char *mac = dev->dev_addr;
+	u32 val;
+
+	val = mac[1] | (mac[0] << 8);
+	writel_relaxed(val, priv->base + STATION_ADDR_HIGH);
+
+	val = mac[5] | (mac[4] << 8) | (mac[3] << 16) | (mac[2] << 24);
+	writel_relaxed(val, priv->base + STATION_ADDR_LOW);
+}
+
+static int hix5hd2_net_set_mac_address(struct net_device *dev, void *p)
+{
+	int ret;
+
+	ret = eth_mac_addr(dev, p);
+	if (!ret)
+		hix5hd2_hw_set_mac_addr(dev);
+
+	return ret;
+}
+
+static void hix5hd2_adjust_link(struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	struct phy_device *phy = priv->phy;
+
+	if ((priv->speed != phy->speed) || (priv->duplex != phy->duplex)) {
+		hix5hd2_config_port(dev, phy->speed, phy->duplex);
+		phy_print_status(phy);
+	}
+}
+
+static void hix5hd2_rx_refill(struct hix5hd2_priv *priv)
+{
+	struct hix5hd2_desc *desc;
+	struct sk_buff *skb;
+	u32 start, end, num, pos, i;
+
+	/* software write pointer */
+	start = dma_cnt(readl_relaxed(priv->base + RX_FQ_WR_ADDR));
+	/* logic read pointer */
+	end = dma_cnt(readl_relaxed(priv->base + RX_FQ_RD_ADDR));
+	num = CIRC_SPACE(start, end, RX_DESC_NUM);
+
+	for (i = 0, pos = start; i < num; i++) {
+		if (priv->rx_skb[pos])
+			break;
+		else {
+			skb = netdev_alloc_skb_ip_align(priv->netdev,
+				MAC_MAX_FRAME_SIZE);
+			if (unlikely(skb == NULL))
+				break;
+		}
+
+		desc = priv->rx_fq.desc + pos;
+		desc->buff_addr =
+			dma_map_single(priv->dev, skb->data,
+					MAC_MAX_FRAME_SIZE, DMA_FROM_DEVICE);
+		if (dma_mapping_error(priv->dev, desc->buff_addr)) {
+			dev_kfree_skb_any(skb);
+			break;
+		}
+
+		priv->rx_skb[pos] = skb;
+		desc->buff_len = MAC_MAX_FRAME_SIZE - 1;
+		desc->data_len = 0;
+		desc->fl = 0;
+		desc->descvid = DESC_VLD_FREE;
+		pos = dma_ring_incr(pos, RX_DESC_NUM);
+	}
+
+	if (pos != start)
+		writel(dma_byte(pos), priv->base + RX_FQ_WR_ADDR);
+}
+
+static int hix5hd2_rx(struct net_device *dev, int limit)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	struct sk_buff *skb;
+	struct hix5hd2_desc *desc;
+	dma_addr_t dma_addr;
+	u32 start, end, num, pos, i, len;
+
+	/* software read pointer */
+	start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
+	/* logic write pointer */
+	end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));
+	num = CIRC_CNT(end, start, RX_DESC_NUM);
+	if (num > limit)
+		num = limit;
+
+	for (i = 0, pos = start; i < num; i++) {
+		skb = priv->rx_skb[pos];
+		if (unlikely(!skb)) {
+			netdev_err(dev, "inconsistent rx_skb\n");
+			break;
+		}
+		priv->rx_skb[pos] = NULL;
+
+		desc = priv->rx_bq.desc + pos;
+		len = desc->data_len;
+		dma_addr = desc->buff_addr;
+		dma_unmap_single(priv->dev, dma_addr, MAC_MAX_FRAME_SIZE,
+				DMA_FROM_DEVICE);
+
+		skb_put(skb, len);
+		if (skb->len > MAC_MAX_FRAME_SIZE) {
+			netdev_err(dev, "rcv len err, len = %d\n", skb->len);
+			dev->stats.rx_errors++;
+			dev->stats.rx_length_errors++;
+			dev_kfree_skb_any(skb);
+			goto next;
+		}
+
+		skb->protocol = eth_type_trans(skb, dev);
+		napi_gro_receive(&priv->napi, skb);
+		dev->stats.rx_packets++;
+		dev->stats.rx_bytes += skb->len;
+		dev->last_rx = jiffies;
+next:
+		pos = dma_ring_incr(pos, RX_DESC_NUM);
+	}
+
+	if (pos != start)
+		writel(dma_byte(pos), priv->base + RX_BQ_RD_ADDR);
+
+	hix5hd2_rx_refill(priv);
+
+	return num;
+}
+
+static void hix5hd2_xmit_reclaim(struct net_device *dev)
+{
+	struct sk_buff *skb;
+	struct hix5hd2_desc *desc;
+	dma_addr_t dma_addr;
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	unsigned int bytes_compl = 0, pkts_compl = 0;
+	u32 start, end, num, pos, i;
+
+	netif_tx_lock(dev);
+
+	/* software read */
+	start = dma_cnt(readl_relaxed(priv->base + TX_RQ_RD_ADDR));
+	/* logic write */
+	end = dma_cnt(readl_relaxed(priv->base + TX_RQ_WR_ADDR));
+	num = CIRC_CNT(end, start, TX_DESC_NUM);
+
+	for (i = 0, pos = start; i < num; i++) {
+		skb = priv->tx_skb[pos];
+		if (unlikely(!skb)) {
+			netdev_err(dev, "inconsistent tx_skb\n");
+			break;
+		}
+
+		pkts_compl++;
+		bytes_compl += skb->len;
+		desc = priv->tx_rq.desc + pos;
+		dma_addr = desc->buff_addr;
+		dma_unmap_single(priv->dev, dma_addr, skb->len, DMA_TO_DEVICE);
+		priv->tx_skb[pos] = NULL;
+		dev_consume_skb_any(skb);
+		pos = dma_ring_incr(pos, TX_DESC_NUM);
+	}
+
+	if (pos != start)
+		writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);
+
+	netif_tx_unlock(dev);
+
+	if (pkts_compl || bytes_compl)
+		netdev_completed_queue(dev, pkts_compl, bytes_compl);
+
+	if (unlikely(netif_queue_stopped(priv->netdev)) && pkts_compl)
+		netif_wake_queue(priv->netdev);
+}
+
+static int hix5hd2_poll(struct napi_struct *napi, int budget)
+{
+	struct hix5hd2_priv *priv = container_of(napi,
+				struct hix5hd2_priv, napi);
+	struct net_device *dev = priv->netdev;
+	int work_done = 0, task = budget;
+	int ints, num;
+
+	do {
+		hix5hd2_xmit_reclaim(dev);
+		num = hix5hd2_rx(dev, task);
+		work_done += num;
+		task -= num;
+		if ((work_done >= budget) || (num == 0))
+			break;
+
+		ints = readl_relaxed(priv->base + RAW_PMU_INT);
+		writel_relaxed(ints, priv->base + RAW_PMU_INT);
+	} while (ints & DEF_INT_MASK);
+
+	if (work_done < budget) {
+		napi_complete(napi);
+		hix5hd2_irq_enable(priv);
+	}
+
+	return work_done;
+}
+
+static irqreturn_t hix5hd2_interrupt(int irq, void *dev_id)
+{
+	struct net_device *dev = (struct net_device *)dev_id;
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	int ints = readl_relaxed(priv->base + RAW_PMU_INT);
+
+	writel_relaxed(ints, priv->base + RAW_PMU_INT);
+	if (likely(ints & DEF_INT_MASK)) {
+		hix5hd2_irq_disable(priv);
+		napi_schedule(&priv->napi);
+	}
+
+	return IRQ_HANDLED;
+}
+
+static int hix5hd2_net_xmit(struct sk_buff *skb, struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	struct hix5hd2_desc *desc;
+	u32 pos;
+
+	/* software write pointer */
+	pos = dma_cnt(readl_relaxed(priv->base + TX_BQ_WR_ADDR));
+	if (unlikely(priv->tx_skb[pos])) {
+		dev->stats.tx_dropped++;
+		dev->stats.tx_fifo_errors++;
+		netif_stop_queue(dev);
+		return NETDEV_TX_BUSY;
+	}
+
+	desc = priv->tx_bq.desc + pos;
+	desc->buff_addr =
+		dma_map_single(priv->dev, skb->data, skb->len, DMA_TO_DEVICE);
+	if (dma_mapping_error(priv->dev, desc->buff_addr)) {
+		dev_kfree_skb_any(skb);
+		return NETDEV_TX_OK;
+	}
+
+	priv->tx_skb[pos] = skb;
+	desc->buff_len = skb->len;
+	desc->data_len = skb->len;
+	desc->fl = DESC_FL_FULL;
+	desc->descvid = DESC_VLD_BUSY;
+
+	pos = dma_ring_incr(pos, TX_DESC_NUM);
+	writel(dma_byte(pos), priv->base + TX_BQ_WR_ADDR);
+
+	dev->trans_start = jiffies;
+	dev->stats.tx_packets++;
+	dev->stats.tx_bytes += skb->len;
+	netdev_sent_queue(dev, skb->len);
+
+	return NETDEV_TX_OK;
+}
+
+static void hix5hd2_free_dma_desc_rings(struct hix5hd2_priv *priv)
+{
+	struct hix5hd2_desc *desc;
+	int i;
+
+	for (i = 0; i < RX_DESC_NUM; i++) {
+		struct sk_buff *skb = priv->rx_skb[i];
+		if (skb == NULL)
+			continue;
+
+		desc = priv->rx_fq.desc + i;
+		dma_unmap_single(priv->dev, desc->buff_addr,
+				 MAC_MAX_FRAME_SIZE, DMA_FROM_DEVICE);
+		dev_kfree_skb_any(skb);
+		priv->rx_skb[i] = NULL;
+	}
+
+	for (i = 0; i < TX_DESC_NUM; i++) {
+		struct sk_buff *skb = priv->tx_skb[i];
+		if (skb == NULL)
+			continue;
+
+		desc = priv->tx_rq.desc + i;
+		dma_unmap_single(priv->dev, desc->buff_addr,
+				 skb->len, DMA_TO_DEVICE);
+		dev_kfree_skb_any(skb);
+		priv->tx_skb[i] = NULL;
+	}
+}
+
+static int hix5hd2_net_open(struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+	int ret;
+
+	ret = clk_prepare_enable(priv->clk);
+	if (ret < 0) {
+		netdev_err(dev, "failed to enable clk %d\n", ret);
+		return ret;
+	}
+
+	priv->phy = of_phy_connect(dev, priv->phy_node,
+		&hix5hd2_adjust_link, 0, priv->phy_mode);
+	if (!priv->phy)
+		return -ENODEV;
+
+	phy_start(priv->phy);
+	hix5hd2_hw_init(priv);
+	hix5hd2_rx_refill(priv);
+
+	netdev_reset_queue(dev);
+	netif_start_queue(dev);
+	napi_enable(&priv->napi);
+
+	hix5hd2_port_enable(priv);
+	hix5hd2_irq_enable(priv);
+
+	return 0;
+}
+
+static int hix5hd2_net_close(struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+
+	hix5hd2_port_disable(priv);
+	hix5hd2_irq_disable(priv);
+	napi_disable(&priv->napi);
+	netif_stop_queue(dev);
+	hix5hd2_free_dma_desc_rings(priv);
+
+	if (priv->phy) {
+		phy_stop(priv->phy);
+		phy_disconnect(priv->phy);
+	}
+
+	clk_disable_unprepare(priv->clk);
+
+	return 0;
+}
+
+static void hix5hd2_tx_timeout_task(struct work_struct *work)
+{
+	struct hix5hd2_priv *priv;
+
+	priv = container_of(work, struct hix5hd2_priv, tx_timeout_task);
+	hix5hd2_net_close(priv->netdev);
+	hix5hd2_net_open(priv->netdev);
+}
+
+static void hix5hd2_net_timeout(struct net_device *dev)
+{
+	struct hix5hd2_priv *priv = netdev_priv(dev);
+
+	schedule_work(&priv->tx_timeout_task);
+}
+
+static struct net_device_stats *hix5hd2_net_get_stats(struct net_device *dev)
+{
+	return &dev->stats;
+}
+
+static const struct net_device_ops hix5hd2_netdev_ops = {
+	.ndo_open		= hix5hd2_net_open,
+	.ndo_stop		= hix5hd2_net_close,
+	.ndo_start_xmit		= hix5hd2_net_xmit,
+	.ndo_tx_timeout		= hix5hd2_net_timeout,
+	.ndo_set_mac_address	= hix5hd2_net_set_mac_address,
+	.ndo_get_stats		= hix5hd2_net_get_stats,
+};
+
+static int hix5hd2_get_settings(struct net_device *net_dev,
+		struct ethtool_cmd *cmd)
+{
+	struct hix5hd2_priv *priv = netdev_priv(net_dev);
+
+	if (!priv->phy)
+		return -ENODEV;
+
+	return phy_ethtool_gset(priv->phy, cmd);
+}
+
+static int hix5hd2_set_settings(struct net_device *net_dev,
+		struct ethtool_cmd *cmd)
+{
+	struct hix5hd2_priv *priv = netdev_priv(net_dev);
+
+	if (!priv->phy)
+		return -ENODEV;
+
+	return phy_ethtool_sset(priv->phy, cmd);
+}
+
+static struct ethtool_ops hix5hd2_ethtools_ops = {
+	.get_link		= ethtool_op_get_link,
+	.get_settings		= hix5hd2_get_settings,
+	.set_settings		= hix5hd2_set_settings,
+};
+
+static int hix5hd2_mdio_wait_ready(struct mii_bus *bus)
+{
+	struct hix5hd2_priv *priv = bus->priv;
+	void __iomem *base = priv->base;
+	int i, timeout = 10000;
+
+	for (i = 0; readl_relaxed(base + MDIO_SINGLE_CMD) & MDIO_START; i++) {
+		if (i == timeout)
+			return -ETIMEDOUT;
+		udelay(1);
+	}
+
+	return 0;
+}
+
+static int hix5hd2_mdio_read(struct mii_bus *bus, int phy, int reg)
+{
+	struct hix5hd2_priv *priv = bus->priv;
+	void __iomem *base = priv->base;
+	int val, ret;
+
+	ret = hix5hd2_mdio_wait_ready(bus);
+	if (ret < 0)
+		goto out;
+
+	writel_relaxed(MDIO_READ | phy << 8 | reg, base + MDIO_SINGLE_CMD);
+	ret = hix5hd2_mdio_wait_ready(bus);
+	if (ret < 0)
+		goto out;
+
+	val = readl_relaxed(base + MDIO_RDATA_STATUS);
+	if (val & MDIO_R_VALID) {
+		dev_err(bus->parent, "SMI bus read not valid\n");
+		ret = -ENODEV;
+		goto out;
+	}
+
+	val = readl_relaxed(priv->base + MDIO_SINGLE_DATA);
+	ret = (val >> 16) & 0xFFFF;
+out:
+	return ret;
+}
+
+static int hix5hd2_mdio_write(struct mii_bus *bus, int phy, int reg, u16 val)
+{
+	struct hix5hd2_priv *priv = bus->priv;
+	void __iomem *base = priv->base;
+	int ret;
+
+	ret = hix5hd2_mdio_wait_ready(bus);
+	if (ret < 0)
+		goto out;
+
+	writel_relaxed(val, base + MDIO_SINGLE_DATA);
+	writel_relaxed(MDIO_WRITE | phy << 8 | reg, base + MDIO_SINGLE_CMD);
+	ret = hix5hd2_mdio_wait_ready(bus);
+out:
+	return ret;
+}
+
+static void hix5hd2_destroy_hw_desc_queue(struct hix5hd2_priv *priv)
+{
+	int i;
+
+	for (i = 0; i < QUEUE_NUMS; i++) {
+		if (priv->pool[i].desc) {
+			dma_free_coherent(priv->dev, priv->pool[i].size,
+					priv->pool[i].desc,
+					priv->pool[i].phys_addr);
+			priv->pool[i].desc = NULL;
+		}
+	}
+}
+
+static int hix5hd2_init_hw_desc_queue(struct hix5hd2_priv *priv)
+{
+	struct device *dev = priv->dev;
+	struct hix5hd2_desc *virt_addr;
+	dma_addr_t phys_addr;
+	int size, i;
+
+	priv->rx_fq.count = RX_DESC_NUM;
+	priv->rx_bq.count = RX_DESC_NUM;
+	priv->tx_bq.count = TX_DESC_NUM;
+	priv->tx_rq.count = TX_DESC_NUM;
+
+	for (i = 0; i < QUEUE_NUMS; i++) {
+		size = priv->pool[i].count * sizeof(struct hix5hd2_desc);
+		virt_addr = dma_alloc_coherent(dev, size, &phys_addr,
+				GFP_KERNEL);
+		if (virt_addr == NULL)
+			goto error_free_pool;
+
+		memset(virt_addr, 0, size);
+		priv->pool[i].size = size;
+		priv->pool[i].desc = virt_addr;
+		priv->pool[i].phys_addr = phys_addr;
+	}
+	return 0;
+
+error_free_pool:
+	hix5hd2_destroy_hw_desc_queue(priv);
+
+	return -ENOMEM;
+}
+
+static int hix5hd2_dev_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct device_node *node = dev->of_node;
+	struct net_device *ndev;
+	struct hix5hd2_priv *priv;
+	struct resource *res;
+	struct mii_bus *bus;
+	const char *mac_addr;
+	int ret;
+
+	ndev = alloc_etherdev(sizeof(struct hix5hd2_priv));
+	if (!ndev)
+		return -ENOMEM;
+
+	platform_set_drvdata(pdev, ndev);
+
+	priv = netdev_priv(ndev);
+	priv->dev = dev;
+	priv->netdev = ndev;
+
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	priv->base = devm_ioremap_resource(dev, res);
+	if (IS_ERR(priv->base)) {
+		ret = PTR_ERR(priv->base);
+		goto out_free_netdev;
+	}
+
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
+	priv->ctrl_base = devm_ioremap_resource(dev, res);
+	if (IS_ERR(priv->ctrl_base)) {
+		ret = PTR_ERR(priv->ctrl_base);
+		goto out_free_netdev;
+	}
+
+	priv->clk = devm_clk_get(&pdev->dev, NULL);
+	if (IS_ERR(priv->clk)) {
+		netdev_err(ndev, "failed to get clk\n");
+		ret = -ENODEV;
+		goto out_free_netdev;
+	}
+
+	ret = clk_prepare_enable(priv->clk);
+	if (ret < 0) {
+		netdev_err(ndev, "failed to enable clk %d\n", ret);
+		goto out_free_netdev;
+	}
+
+	bus = mdiobus_alloc();
+	if (bus == NULL) {
+		ret = -ENOMEM;
+		goto out_free_netdev;
+	}
+
+	bus->priv = priv;
+	bus->name = "hix5hd2_mii_bus";
+	bus->read = hix5hd2_mdio_read;
+	bus->write = hix5hd2_mdio_write;
+	bus->parent = &pdev->dev;
+	snprintf(bus->id, MII_BUS_ID_SIZE, "%s-mii", dev_name(&pdev->dev));
+	priv->bus = bus;
+
+	ret = of_mdiobus_register(bus, node);
+	if (ret)
+		goto err_free_mdio;
+
+	priv->phy_mode = of_get_phy_mode(node);
+	if (priv->phy_mode < 0) {
+		netdev_err(ndev, "not find phy-mode\n");
+		ret = -EINVAL;
+		goto err_mdiobus;
+	}
+
+	priv->phy_node = of_parse_phandle(node, "phy-handle", 0);
+	if (!priv->phy_node) {
+		netdev_err(ndev, "not find phy-handle\n");
+		ret = -EINVAL;
+		goto err_mdiobus;
+	}
+
+	ndev->irq = platform_get_irq(pdev, 0);
+	if (ndev->irq <= 0) {
+		netdev_err(ndev, "No irq resource\n");
+		ret = -EINVAL;
+		goto out_phy_node;
+	}
+
+	ret = devm_request_irq(dev, ndev->irq, hix5hd2_interrupt,
+				0, pdev->name, ndev);
+	if (ret) {
+		netdev_err(ndev, "devm_request_irq failed\n");
+		goto out_phy_node;
+	}
+
+	mac_addr = of_get_mac_address(node);
+	if (mac_addr)
+		ether_addr_copy(ndev->dev_addr, mac_addr);
+	if (!is_valid_ether_addr(ndev->dev_addr)) {
+		eth_hw_addr_random(ndev);
+		netdev_warn(ndev, "using random MAC address %pM\n",
+			 ndev->dev_addr);
+	}
+
+	INIT_WORK(&priv->tx_timeout_task, hix5hd2_tx_timeout_task);
+	ether_setup(ndev);
+	ndev->watchdog_timeo = 6 * HZ;
+	ndev->priv_flags |= IFF_UNICAST_FLT;
+	ndev->netdev_ops = &hix5hd2_netdev_ops;
+	ndev->ethtool_ops = &hix5hd2_ethtools_ops;
+	SET_NETDEV_DEV(ndev, dev);
+
+	ret = hix5hd2_init_hw_desc_queue(priv);
+	if (ret)
+		goto out_phy_node;
+
+	netif_napi_add(ndev, &priv->napi, hix5hd2_poll, NAPI_POLL_WEIGHT);
+	ret = register_netdev(priv->netdev);
+	if (ret) {
+		netdev_err(ndev, "register_netdev failed!");
+		goto out_destroy_queue;
+	}
+
+	clk_disable_unprepare(priv->clk);
+
+	return ret;
+
+out_destroy_queue:
+	netif_napi_del(&priv->napi);
+	hix5hd2_destroy_hw_desc_queue(priv);
+out_phy_node:
+	of_node_put(priv->phy_node);
+err_mdiobus:
+	mdiobus_unregister(bus);
+err_free_mdio:
+	mdiobus_free(bus);
+out_free_netdev:
+	free_netdev(ndev);
+
+	return ret;
+}
+
+static int hix5hd2_dev_remove(struct platform_device *pdev)
+{
+	struct net_device *ndev = platform_get_drvdata(pdev);
+	struct hix5hd2_priv *priv = netdev_priv(ndev);
+
+	netif_napi_del(&priv->napi);
+	unregister_netdev(ndev);
+	mdiobus_unregister(priv->bus);
+	mdiobus_free(priv->bus);
+
+	hix5hd2_destroy_hw_desc_queue(priv);
+	of_node_put(priv->phy_node);
+	cancel_work_sync(&priv->tx_timeout_task);
+	free_netdev(ndev);
+
+	return 0;
+}
+
+static const struct of_device_id hix5hd2_of_match[] = {
+	{.compatible = "hisilicon,hix5hd2-mac",},
+	{},
+};
+
+MODULE_DEVICE_TABLE(of, hix5hd2_of_match);
+
+static struct platform_driver hix5hd2_dev_driver = {
+	.driver = {
+		.name = "hix5hd2-mac",
+		.of_match_table = hix5hd2_of_match,
+	},
+	.probe = hix5hd2_dev_probe,
+	.remove = hix5hd2_dev_remove,
+};
+
+module_platform_driver(hix5hd2_dev_driver);
+
+MODULE_DESCRIPTION("HISILICON X5HD2 Ethernet driver");
+MODULE_LICENSE("GPL v2");
+MODULE_ALIAS("platform:hix5hd2-ether");
-- 
1.7.9.5

Re: [PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[zhangfei]

Any comments, thanks a lot.

On 05/19/2014 08:57 PM, Zhangfei Gao wrote:
> Add support for the hix5hd2 XGMAC 1Gb ethernet device.
> The controller requires two queues for tx and two queues for rx.
> Controller fetch buffer from free queue and then push to used queue.
> Diver should prepare free queue and free buffer from used queue.
>
> Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
> ---
>   drivers/net/ethernet/Kconfig             |    1 +
>   drivers/net/ethernet/Makefile            |    1 +
>   drivers/net/ethernet/hisilicon/Kconfig   |   27 +
>   drivers/net/ethernet/hisilicon/Makefile  |    5 +
>   drivers/net/ethernet/hisilicon/hix5hd2.c | 1068 ++++++++++++++++++++++++++++++
>   5 files changed, 1102 insertions(+)
>   create mode 100644 drivers/net/ethernet/hisilicon/Kconfig
>   create mode 100644 drivers/net/ethernet/hisilicon/Makefile
>   create mode 100644 drivers/net/ethernet/hisilicon/hix5hd2.c
>
> diff --git a/drivers/net/ethernet/Kconfig b/drivers/net/ethernet/Kconfig
> index 39b26fe..0fbdeb1 100644
> --- a/drivers/net/ethernet/Kconfig
> +++ b/drivers/net/ethernet/Kconfig
> @@ -55,6 +55,7 @@ source "drivers/net/ethernet/neterion/Kconfig"
>   source "drivers/net/ethernet/faraday/Kconfig"
>   source "drivers/net/ethernet/freescale/Kconfig"
>   source "drivers/net/ethernet/fujitsu/Kconfig"
> +source "drivers/net/ethernet/hisilicon/Kconfig"
>   source "drivers/net/ethernet/hp/Kconfig"
>   source "drivers/net/ethernet/ibm/Kconfig"
>   source "drivers/net/ethernet/intel/Kconfig"
> diff --git a/drivers/net/ethernet/Makefile b/drivers/net/ethernet/Makefile
> index 545d0b3..dc78996 100644
> --- a/drivers/net/ethernet/Makefile
> +++ b/drivers/net/ethernet/Makefile
> @@ -30,6 +30,7 @@ obj-$(CONFIG_NET_VENDOR_EXAR) += neterion/
>   obj-$(CONFIG_NET_VENDOR_FARADAY) += faraday/
>   obj-$(CONFIG_NET_VENDOR_FREESCALE) += freescale/
>   obj-$(CONFIG_NET_VENDOR_FUJITSU) += fujitsu/
> +obj-$(CONFIG_NET_VENDOR_HISILICON) += hisilicon/
>   obj-$(CONFIG_NET_VENDOR_HP) += hp/
>   obj-$(CONFIG_NET_VENDOR_IBM) += ibm/
>   obj-$(CONFIG_NET_VENDOR_INTEL) += intel/
> diff --git a/drivers/net/ethernet/hisilicon/Kconfig b/drivers/net/ethernet/hisilicon/Kconfig
> new file mode 100644
> index 0000000..da144fc
> --- /dev/null
> +++ b/drivers/net/ethernet/hisilicon/Kconfig
> @@ -0,0 +1,27 @@
> +#
> +# HISILICON device configuration
> +#
> +
> +config NET_VENDOR_HISILICON
> +	bool "Hisilicon devices"
> +	default y
> +	depends on ARM
> +	---help---
> +	  If you have a network (Ethernet) card belonging to this class, say Y
> +	  and read the Ethernet-HOWTO, available from
> +	  <http://www.tldp.org/docs.html#howto>.
> +
> +	  Note that the answer to this question doesn't directly affect the
> +	  kernel: saying N will just cause the configurator to skip all
> +	  the questions about Hisilicon devices. If you say Y, you will be asked
> +	  for your specific card in the following questions.
> +
> +if NET_VENDOR_HISILICON
> +
> +config HIX5HD2_GMAC
> +	tristate "Hisilicon X5HD2 Family Network Device Support"
> +	select PHYLIB
> +	help
> +	  This selects the hix5hd2 mac family network device.
> +
> +endif # NET_VENDOR_HISILICON
> diff --git a/drivers/net/ethernet/hisilicon/Makefile b/drivers/net/ethernet/hisilicon/Makefile
> new file mode 100644
> index 0000000..9f6e71a
> --- /dev/null
> +++ b/drivers/net/ethernet/hisilicon/Makefile
> @@ -0,0 +1,5 @@
> +#
> +# Makefile for the HISILICON network device drivers.
> +#
> +
> +obj-$(CONFIG_HIX5HD2_GMAC) += hix5hd2.o
> diff --git a/drivers/net/ethernet/hisilicon/hix5hd2.c b/drivers/net/ethernet/hisilicon/hix5hd2.c
> new file mode 100644
> index 0000000..f37e893
> --- /dev/null
> +++ b/drivers/net/ethernet/hisilicon/hix5hd2.c
> @@ -0,0 +1,1068 @@
> +/* Copyright (c) 2014 Linaro Ltd.
> + * Copyright (c) 2014 Hisilicon Limited.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + */
> +
> +#include <linux/module.h>
> +#include <linux/interrupt.h>
> +#include <linux/etherdevice.h>
> +#include <linux/platform_device.h>
> +#include <linux/of_net.h>
> +#include <linux/of_mdio.h>
> +#include <linux/clk.h>
> +#include <linux/circ_buf.h>
> +
> +#define STATION_ADDR_LOW		0x0000
> +#define STATION_ADDR_HIGH		0x0004
> +#define MAC_DUPLEX_HALF_CTRL		0x0008
> +#define MAX_FRM_SIZE			0x003c
> +#define PORT_MODE			0x0040
> +#define PORT_EN				0x0044
> +#define BITS_TX_EN			BIT(2)
> +#define BITS_RX_EN			BIT(1)
> +#define REC_FILT_CONTROL		0x0064
> +#define BIT_CRC_ERR_PASS		BIT(5)
> +#define BIT_PAUSE_FRM_PASS		BIT(4)
> +#define BIT_VLAN_DROP_EN		BIT(3)
> +#define BIT_BC_DROP_EN			BIT(2)
> +#define BIT_MC_MATCH_EN			BIT(1)
> +#define BIT_UC_MATCH_EN			BIT(0)
> +#define PORT_MC_ADDR_LOW		0x0068
> +#define PORT_MC_ADDR_HIGH		0x006C
> +#define CF_CRC_STRIP			0x01b0
> +#define MODE_CHANGE_EN			0x01b4
> +#define BIT_MODE_CHANGE_EN		BIT(0)
> +#define COL_SLOT_TIME			0x01c0
> +#define RECV_CONTROL			0x01e0
> +#define BIT_STRIP_PAD_EN		BIT(3)
> +#define BIT_RUNT_PKT_EN			BIT(4)
> +#define CONTROL_WORD			0x0214
> +#define MDIO_SINGLE_CMD			0x03c0
> +#define MDIO_SINGLE_DATA		0x03c4
> +#define MDIO_CTRL			0x03cc
> +#define MDIO_RDATA_STATUS		0x03d0
> +
> +#define MDIO_START			BIT(20)
> +#define MDIO_R_VALID			BIT(0)
> +#define MDIO_READ			(BIT(17) | MDIO_START)
> +#define MDIO_WRITE			(BIT(16) | MDIO_START)
> +
> +#define RX_FQ_START_ADDR		0x0500
> +#define RX_FQ_DEPTH			0x0504
> +#define RX_FQ_WR_ADDR			0x0508
> +#define RX_FQ_RD_ADDR			0x050c
> +#define RX_FQ_VLDDESC_CNT		0x0510
> +#define RX_FQ_ALEMPTY_TH		0x0514
> +#define RX_FQ_REG_EN			0x0518
> +#define BITS_RX_FQ_START_ADDR_EN	BIT(2)
> +#define BITS_RX_FQ_DEPTH_EN		BIT(1)
> +#define BITS_RX_FQ_RD_ADDR_EN		BIT(0)
> +#define RX_FQ_ALFULL_TH			0x051c
> +#define RX_BQ_START_ADDR		0x0520
> +#define RX_BQ_DEPTH			0x0524
> +#define RX_BQ_WR_ADDR			0x0528
> +#define RX_BQ_RD_ADDR			0x052c
> +#define RX_BQ_FREE_DESC_CNT		0x0530
> +#define RX_BQ_ALEMPTY_TH		0x0534
> +#define RX_BQ_REG_EN			0x0538
> +#define BITS_RX_BQ_START_ADDR_EN	BIT(2)
> +#define BITS_RX_BQ_DEPTH_EN		BIT(1)
> +#define BITS_RX_BQ_WR_ADDR_EN		BIT(0)
> +#define RX_BQ_ALFULL_TH			0x053c
> +#define TX_BQ_START_ADDR		0x0580
> +#define TX_BQ_DEPTH			0x0584
> +#define TX_BQ_WR_ADDR			0x0588
> +#define TX_BQ_RD_ADDR			0x058c
> +#define TX_BQ_VLDDESC_CNT		0x0590
> +#define TX_BQ_ALEMPTY_TH		0x0594
> +#define TX_BQ_REG_EN			0x0598
> +#define BITS_TX_BQ_START_ADDR_EN	BIT(2)
> +#define BITS_TX_BQ_DEPTH_EN		BIT(1)
> +#define BITS_TX_BQ_RD_ADDR_EN		BIT(0)
> +#define TX_BQ_ALFULL_TH			0x059c
> +#define TX_RQ_START_ADDR		0x05a0
> +#define TX_RQ_DEPTH			0x05a4
> +#define TX_RQ_WR_ADDR			0x05a8
> +#define TX_RQ_RD_ADDR			0x05ac
> +#define TX_RQ_FREE_DESC_CNT		0x05b0
> +#define TX_RQ_ALEMPTY_TH		0x05b4
> +#define TX_RQ_REG_EN			0x05b8
> +#define BITS_TX_RQ_START_ADDR_EN	BIT(2)
> +#define BITS_TX_RQ_DEPTH_EN		BIT(1)
> +#define BITS_TX_RQ_WR_ADDR_EN		BIT(0)
> +#define TX_RQ_ALFULL_TH			0x05bc
> +#define RAW_PMU_INT			0x05c0
> +#define ENA_PMU_INT			0x05c4
> +#define STATUS_PMU_INT			0x05c8
> +#define MAC_FIFO_ERR_IN			BIT(30)
> +#define TX_RQ_IN_TIMEOUT_INT		BIT(29)
> +#define RX_BQ_IN_TIMEOUT_INT		BIT(28)
> +#define TXOUTCFF_FULL_INT		BIT(27)
> +#define TXOUTCFF_EMPTY_INT		BIT(26)
> +#define TXCFF_FULL_INT			BIT(25)
> +#define TXCFF_EMPTY_INT			BIT(24)
> +#define RXOUTCFF_FULL_INT		BIT(23)
> +#define RXOUTCFF_EMPTY_INT		BIT(22)
> +#define RXCFF_FULL_INT			BIT(21)
> +#define RXCFF_EMPTY_INT			BIT(20)
> +#define TX_RQ_IN_INT			BIT(19)
> +#define TX_BQ_OUT_INT			BIT(18)
> +#define RX_BQ_IN_INT			BIT(17)
> +#define RX_FQ_OUT_INT			BIT(16)
> +#define TX_RQ_EMPTY_INT			BIT(15)
> +#define TX_RQ_FULL_INT			BIT(14)
> +#define TX_RQ_ALEMPTY_INT		BIT(13)
> +#define TX_RQ_ALFULL_INT		BIT(12)
> +#define TX_BQ_EMPTY_INT			BIT(11)
> +#define TX_BQ_FULL_INT			BIT(10)
> +#define TX_BQ_ALEMPTY_INT		BIT(9)
> +#define TX_BQ_ALFULL_INT		BIT(8)
> +#define RX_BQ_EMPTY_INT			BIT(7)
> +#define RX_BQ_FULL_INT			BIT(6)
> +#define RX_BQ_ALEMPTY_INT		BIT(5)
> +#define RX_BQ_ALFULL_INT		BIT(4)
> +#define RX_FQ_EMPTY_INT			BIT(3)
> +#define RX_FQ_FULL_INT			BIT(2)
> +#define RX_FQ_ALEMPTY_INT		BIT(1)
> +#define RX_FQ_ALFULL_INT		BIT(0)
> +
> +#define DEF_INT_MASK			(RX_BQ_IN_INT | RX_BQ_IN_TIMEOUT_INT | \
> +					TX_RQ_IN_INT | TX_RQ_IN_TIMEOUT_INT)
> +
> +#define DESC_WR_RD_ENA			0x05cc
> +#define IN_QUEUE_TH			0x05d8
> +#define OUT_QUEUE_TH			0x05dc
> +#define QUEUE_TX_BQ_SHIFT		16
> +#define QUEUE_RX_FQ_SHIFT		0
> +#define RX_BQ_IN_TIMEOUT_TH		0x05e0
> +#define TX_RQ_IN_TIMEOUT_TH		0x05e4
> +#define STOP_CMD			0x05e8
> +#define BITS_TX_STOP			BIT(1)
> +#define BITS_RX_STOP			BIT(0)
> +#define FLUSH_CMD			0x05eC
> +#define BITS_TX_FLUSH_CMD		BIT(5)
> +#define BITS_RX_FLUSH_CMD		BIT(4)
> +#define BITS_TX_FLUSH_FLAG_DOWN		BIT(3)
> +#define BITS_TX_FLUSH_FLAG_UP		BIT(2)
> +#define BITS_RX_FLUSH_FLAG_DOWN		BIT(1)
> +#define BITS_RX_FLUSH_FLAG_UP		BIT(0)
> +#define RX_CFF_NUM_REG			0x05f0
> +#define PMU_FSM_REG			0x05f8
> +#define RX_FIFO_PKT_IN_NUM		0x05fc
> +#define RX_FIFO_PKT_OUT_NUM		0x0600
> +
> +#define RGMII_SPEED_1000		0x2c
> +#define RGMII_SPEED_100			0x2f
> +#define RGMII_SPEED_10			0x2d
> +#define MII_SPEED_100			0x0f
> +#define MII_SPEED_10			0x0d
> +#define GMAC_SPEED_1000			0x05
> +#define GMAC_SPEED_100			0x01
> +#define GMAC_SPEED_10			0x00
> +#define GMAC_FULL_DUPLEX		BIT(4)
> +
> +#define RX_BQ_INT_THRESHOLD		0x01
> +#define TX_RQ_INT_THRESHOLD		0x01
> +#define RX_BQ_IN_TIMEOUT		0x10000
> +#define TX_RQ_IN_TIMEOUT		0x50000
> +
> +#define MAC_MAX_FRAME_SIZE		1600
> +#define DESC_SIZE			32
> +#define RX_DESC_NUM			1024
> +#define TX_DESC_NUM			1024
> +
> +#define DESC_VLD_FREE			0
> +#define DESC_VLD_BUSY			1
> +#define DESC_FL_MID			0
> +#define DESC_FL_LAST			1
> +#define DESC_FL_FIRST			2
> +#define DESC_FL_FULL			3
> +
> +/* DMA descriptor ring helpers */
> +#define dma_ring_incr(n, s)		(((n) + 1) & ((s) - 1))
> +#define dma_cnt(n)			((n) >> 5)
> +#define dma_byte(n)			((n) << 5)
> +
> +struct hix5hd2_desc {
> +	__le32 buff_addr;
> +	__le32 buff_len:11;
> +	__le32 reserve2:5;
> +	__le32 data_len:11;
> +	__le32 reserve1:2;
> +	__le32 fl:2;
> +	__le32 descvid:1;
> +} __aligned(32);
> +
> +struct hix5hd2_desc_sw {
> +	struct hix5hd2_desc *desc;
> +	dma_addr_t	phys_addr;
> +	unsigned int	count;
> +	unsigned int	size;
> +};
> +
> +#define QUEUE_NUMS	4
> +struct hix5hd2_priv {
> +	struct hix5hd2_desc_sw pool[QUEUE_NUMS];
> +#define rx_fq		pool[0]
> +#define rx_bq		pool[1]
> +#define tx_bq		pool[2]
> +#define tx_rq		pool[3]
> +
> +	void __iomem *base;
> +	void __iomem *ctrl_base;
> +
> +	struct sk_buff *tx_skb[TX_DESC_NUM];
> +	struct sk_buff *rx_skb[RX_DESC_NUM];
> +
> +	struct device *dev;
> +	struct net_device *netdev;
> +
> +	struct phy_device *phy;
> +	struct device_node *phy_node;
> +	phy_interface_t	phy_mode;
> +
> +	unsigned int speed;
> +	unsigned int duplex;
> +
> +	struct clk *clk;
> +	struct mii_bus *bus;
> +	struct napi_struct napi;
> +	struct work_struct tx_timeout_task;
> +};
> +
> +static void hix5hd2_config_port(struct net_device *dev, u32 speed, u32 duplex)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	u32 val;
> +
> +	priv->speed = speed;
> +	priv->duplex = duplex;
> +
> +	switch (priv->phy_mode) {
> +	case PHY_INTERFACE_MODE_RGMII:
> +		if (speed == SPEED_1000)
> +			val = RGMII_SPEED_1000;
> +		else if (speed == SPEED_100)
> +			val = RGMII_SPEED_100;
> +		else
> +			val = RGMII_SPEED_10;
> +		break;
> +	case PHY_INTERFACE_MODE_MII:
> +		if (speed == SPEED_100)
> +			val = MII_SPEED_100;
> +		else
> +			val = MII_SPEED_10;
> +		break;
> +	default:
> +		netdev_warn(dev, "not supported mode\n");
> +		val = MII_SPEED_10;
> +		break;
> +	}
> +
> +	if (duplex)
> +		val |= GMAC_FULL_DUPLEX;
> +	writel_relaxed(val, priv->ctrl_base);
> +
> +	writel_relaxed(BIT_MODE_CHANGE_EN, priv->base + MODE_CHANGE_EN);
> +	if (speed == SPEED_1000)
> +		val = GMAC_SPEED_1000;
> +	else if (speed == SPEED_100)
> +		val = GMAC_SPEED_100;
> +	else
> +		val = GMAC_SPEED_10;
> +	writel_relaxed(val, priv->base + PORT_MODE);
> +	writel_relaxed(0, priv->base + MODE_CHANGE_EN);
> +	writel_relaxed(duplex, priv->base + MAC_DUPLEX_HALF_CTRL);
> +}
> +
> +static void hix5hd2_set_desc_depth(struct hix5hd2_priv *priv, int rx, int tx)
> +{
> +	writel_relaxed(BITS_RX_FQ_DEPTH_EN, priv->base + RX_FQ_REG_EN);
> +	writel_relaxed(rx << 3, priv->base + RX_FQ_DEPTH);
> +	writel_relaxed(0, priv->base + RX_FQ_REG_EN);
> +
> +	writel_relaxed(BITS_RX_BQ_DEPTH_EN, priv->base + RX_BQ_REG_EN);
> +	writel_relaxed(rx << 3, priv->base + RX_BQ_DEPTH);
> +	writel_relaxed(0, priv->base + RX_BQ_REG_EN);
> +
> +	writel_relaxed(BITS_TX_BQ_DEPTH_EN, priv->base + TX_BQ_REG_EN);
> +	writel_relaxed(tx << 3, priv->base + TX_BQ_DEPTH);
> +	writel_relaxed(0, priv->base + TX_BQ_REG_EN);
> +
> +	writel_relaxed(BITS_TX_RQ_DEPTH_EN, priv->base + TX_RQ_REG_EN);
> +	writel_relaxed(tx << 3, priv->base + TX_RQ_DEPTH);
> +	writel_relaxed(0, priv->base + TX_RQ_REG_EN);
> +}
> +
> +static void hix5hd2_set_rx_fq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
> +{
> +	writel_relaxed(BITS_RX_FQ_START_ADDR_EN, priv->base + RX_FQ_REG_EN);
> +	writel_relaxed(phy_addr, priv->base + RX_FQ_START_ADDR);
> +	writel_relaxed(0, priv->base + RX_FQ_REG_EN);
> +}
> +
> +static void hix5hd2_set_rx_bq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
> +{
> +	writel_relaxed(BITS_RX_BQ_START_ADDR_EN, priv->base + RX_BQ_REG_EN);
> +	writel_relaxed(phy_addr, priv->base + RX_BQ_START_ADDR);
> +	writel_relaxed(0, priv->base + RX_BQ_REG_EN);
> +}
> +
> +static void hix5hd2_set_tx_bq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
> +{
> +	writel_relaxed(BITS_TX_BQ_START_ADDR_EN, priv->base + TX_BQ_REG_EN);
> +	writel_relaxed(phy_addr, priv->base + TX_BQ_START_ADDR);
> +	writel_relaxed(0, priv->base + TX_BQ_REG_EN);
> +}
> +
> +static void hix5hd2_set_tx_rq(struct hix5hd2_priv *priv, dma_addr_t phy_addr)
> +{
> +	writel_relaxed(BITS_TX_RQ_START_ADDR_EN, priv->base + TX_RQ_REG_EN);
> +	writel_relaxed(phy_addr, priv->base + TX_RQ_START_ADDR);
> +	writel_relaxed(0, priv->base + TX_RQ_REG_EN);
> +}
> +
> +static void hix5hd2_set_desc_addr(struct hix5hd2_priv *priv)
> +{
> +	hix5hd2_set_rx_fq(priv, priv->rx_fq.phys_addr);
> +	hix5hd2_set_rx_bq(priv, priv->rx_bq.phys_addr);
> +	hix5hd2_set_tx_rq(priv, priv->tx_rq.phys_addr);
> +	hix5hd2_set_tx_bq(priv, priv->tx_bq.phys_addr);
> +}
> +
> +static void hix5hd2_hw_init(struct hix5hd2_priv *priv)
> +{
> +	u32 val;
> +
> +	/* disable and clear all interrupts */
> +	writel_relaxed(0, priv->base + ENA_PMU_INT);
> +	writel_relaxed(~0, priv->base + RAW_PMU_INT);
> +
> +	writel_relaxed(BIT_CRC_ERR_PASS, priv->base + REC_FILT_CONTROL);
> +	writel_relaxed(MAC_MAX_FRAME_SIZE, priv->base + CONTROL_WORD);
> +	writel_relaxed(0, priv->base + COL_SLOT_TIME);
> +
> +	val = RX_BQ_INT_THRESHOLD << QUEUE_RX_FQ_SHIFT |
> +		TX_RQ_INT_THRESHOLD << QUEUE_TX_BQ_SHIFT;
> +	writel_relaxed(val, priv->base + IN_QUEUE_TH);
> +
> +	writel_relaxed(RX_BQ_IN_TIMEOUT, priv->base + RX_BQ_IN_TIMEOUT_TH);
> +	writel_relaxed(TX_RQ_IN_TIMEOUT, priv->base + TX_RQ_IN_TIMEOUT_TH);
> +
> +	hix5hd2_set_desc_depth(priv, RX_DESC_NUM, TX_DESC_NUM);
> +	hix5hd2_set_desc_addr(priv);
> +}
> +
> +static void hix5hd2_irq_enable(struct hix5hd2_priv *priv)
> +{
> +	writel_relaxed(DEF_INT_MASK, priv->base + ENA_PMU_INT);
> +}
> +
> +static void hix5hd2_irq_disable(struct hix5hd2_priv *priv)
> +{
> +	writel_relaxed(0, priv->base + ENA_PMU_INT);
> +}
> +
> +static void hix5hd2_port_enable(struct hix5hd2_priv *priv)
> +{
> +	writel_relaxed(0xf, priv->base + DESC_WR_RD_ENA);
> +	writel_relaxed(BITS_RX_EN | BITS_TX_EN, priv->base + PORT_EN);
> +}
> +
> +static void hix5hd2_port_disable(struct hix5hd2_priv *priv)
> +{
> +	writel_relaxed(~(BITS_RX_EN | BITS_TX_EN), priv->base + PORT_EN);
> +	writel_relaxed(0, priv->base + DESC_WR_RD_ENA);
> +}
> +
> +static void hix5hd2_hw_set_mac_addr(struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	unsigned char *mac = dev->dev_addr;
> +	u32 val;
> +
> +	val = mac[1] | (mac[0] << 8);
> +	writel_relaxed(val, priv->base + STATION_ADDR_HIGH);
> +
> +	val = mac[5] | (mac[4] << 8) | (mac[3] << 16) | (mac[2] << 24);
> +	writel_relaxed(val, priv->base + STATION_ADDR_LOW);
> +}
> +
> +static int hix5hd2_net_set_mac_address(struct net_device *dev, void *p)
> +{
> +	int ret;
> +
> +	ret = eth_mac_addr(dev, p);
> +	if (!ret)
> +		hix5hd2_hw_set_mac_addr(dev);
> +
> +	return ret;
> +}
> +
> +static void hix5hd2_adjust_link(struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	struct phy_device *phy = priv->phy;
> +
> +	if ((priv->speed != phy->speed) || (priv->duplex != phy->duplex)) {
> +		hix5hd2_config_port(dev, phy->speed, phy->duplex);
> +		phy_print_status(phy);
> +	}
> +}
> +
> +static void hix5hd2_rx_refill(struct hix5hd2_priv *priv)
> +{
> +	struct hix5hd2_desc *desc;
> +	struct sk_buff *skb;
> +	u32 start, end, num, pos, i;
> +
> +	/* software write pointer */
> +	start = dma_cnt(readl_relaxed(priv->base + RX_FQ_WR_ADDR));
> +	/* logic read pointer */
> +	end = dma_cnt(readl_relaxed(priv->base + RX_FQ_RD_ADDR));
> +	num = CIRC_SPACE(start, end, RX_DESC_NUM);
> +
> +	for (i = 0, pos = start; i < num; i++) {
> +		if (priv->rx_skb[pos])
> +			break;
> +		else {
> +			skb = netdev_alloc_skb_ip_align(priv->netdev,
> +				MAC_MAX_FRAME_SIZE);
> +			if (unlikely(skb == NULL))
> +				break;
> +		}
> +
> +		desc = priv->rx_fq.desc + pos;
> +		desc->buff_addr =
> +			dma_map_single(priv->dev, skb->data,
> +					MAC_MAX_FRAME_SIZE, DMA_FROM_DEVICE);
> +		if (dma_mapping_error(priv->dev, desc->buff_addr)) {
> +			dev_kfree_skb_any(skb);
> +			break;
> +		}
> +
> +		priv->rx_skb[pos] = skb;
> +		desc->buff_len = MAC_MAX_FRAME_SIZE - 1;
> +		desc->data_len = 0;
> +		desc->fl = 0;
> +		desc->descvid = DESC_VLD_FREE;
> +		pos = dma_ring_incr(pos, RX_DESC_NUM);
> +	}
> +
> +	if (pos != start)
> +		writel(dma_byte(pos), priv->base + RX_FQ_WR_ADDR);
> +}
> +
> +static int hix5hd2_rx(struct net_device *dev, int limit)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	struct sk_buff *skb;
> +	struct hix5hd2_desc *desc;
> +	dma_addr_t dma_addr;
> +	u32 start, end, num, pos, i, len;
> +
> +	/* software read pointer */
> +	start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
> +	/* logic write pointer */
> +	end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));
> +	num = CIRC_CNT(end, start, RX_DESC_NUM);
> +	if (num > limit)
> +		num = limit;
> +
> +	for (i = 0, pos = start; i < num; i++) {
> +		skb = priv->rx_skb[pos];
> +		if (unlikely(!skb)) {
> +			netdev_err(dev, "inconsistent rx_skb\n");
> +			break;
> +		}
> +		priv->rx_skb[pos] = NULL;
> +
> +		desc = priv->rx_bq.desc + pos;
> +		len = desc->data_len;
> +		dma_addr = desc->buff_addr;
> +		dma_unmap_single(priv->dev, dma_addr, MAC_MAX_FRAME_SIZE,
> +				DMA_FROM_DEVICE);
> +
> +		skb_put(skb, len);
> +		if (skb->len > MAC_MAX_FRAME_SIZE) {
> +			netdev_err(dev, "rcv len err, len = %d\n", skb->len);
> +			dev->stats.rx_errors++;
> +			dev->stats.rx_length_errors++;
> +			dev_kfree_skb_any(skb);
> +			goto next;
> +		}
> +
> +		skb->protocol = eth_type_trans(skb, dev);
> +		napi_gro_receive(&priv->napi, skb);
> +		dev->stats.rx_packets++;
> +		dev->stats.rx_bytes += skb->len;
> +		dev->last_rx = jiffies;
> +next:
> +		pos = dma_ring_incr(pos, RX_DESC_NUM);
> +	}
> +
> +	if (pos != start)
> +		writel(dma_byte(pos), priv->base + RX_BQ_RD_ADDR);
> +
> +	hix5hd2_rx_refill(priv);
> +
> +	return num;
> +}
> +
> +static void hix5hd2_xmit_reclaim(struct net_device *dev)
> +{
> +	struct sk_buff *skb;
> +	struct hix5hd2_desc *desc;
> +	dma_addr_t dma_addr;
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	unsigned int bytes_compl = 0, pkts_compl = 0;
> +	u32 start, end, num, pos, i;
> +
> +	netif_tx_lock(dev);
> +
> +	/* software read */
> +	start = dma_cnt(readl_relaxed(priv->base + TX_RQ_RD_ADDR));
> +	/* logic write */
> +	end = dma_cnt(readl_relaxed(priv->base + TX_RQ_WR_ADDR));
> +	num = CIRC_CNT(end, start, TX_DESC_NUM);
> +
> +	for (i = 0, pos = start; i < num; i++) {
> +		skb = priv->tx_skb[pos];
> +		if (unlikely(!skb)) {
> +			netdev_err(dev, "inconsistent tx_skb\n");
> +			break;
> +		}
> +
> +		pkts_compl++;
> +		bytes_compl += skb->len;
> +		desc = priv->tx_rq.desc + pos;
> +		dma_addr = desc->buff_addr;
> +		dma_unmap_single(priv->dev, dma_addr, skb->len, DMA_TO_DEVICE);
> +		priv->tx_skb[pos] = NULL;
> +		dev_consume_skb_any(skb);
> +		pos = dma_ring_incr(pos, TX_DESC_NUM);
> +	}
> +
> +	if (pos != start)
> +		writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);
> +
> +	netif_tx_unlock(dev);
> +
> +	if (pkts_compl || bytes_compl)
> +		netdev_completed_queue(dev, pkts_compl, bytes_compl);
> +
> +	if (unlikely(netif_queue_stopped(priv->netdev)) && pkts_compl)
> +		netif_wake_queue(priv->netdev);
> +}
> +
> +static int hix5hd2_poll(struct napi_struct *napi, int budget)
> +{
> +	struct hix5hd2_priv *priv = container_of(napi,
> +				struct hix5hd2_priv, napi);
> +	struct net_device *dev = priv->netdev;
> +	int work_done = 0, task = budget;
> +	int ints, num;
> +
> +	do {
> +		hix5hd2_xmit_reclaim(dev);
> +		num = hix5hd2_rx(dev, task);
> +		work_done += num;
> +		task -= num;
> +		if ((work_done >= budget) || (num == 0))
> +			break;
> +
> +		ints = readl_relaxed(priv->base + RAW_PMU_INT);
> +		writel_relaxed(ints, priv->base + RAW_PMU_INT);
> +	} while (ints & DEF_INT_MASK);
> +
> +	if (work_done < budget) {
> +		napi_complete(napi);
> +		hix5hd2_irq_enable(priv);
> +	}
> +
> +	return work_done;
> +}
> +
> +static irqreturn_t hix5hd2_interrupt(int irq, void *dev_id)
> +{
> +	struct net_device *dev = (struct net_device *)dev_id;
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	int ints = readl_relaxed(priv->base + RAW_PMU_INT);
> +
> +	writel_relaxed(ints, priv->base + RAW_PMU_INT);
> +	if (likely(ints & DEF_INT_MASK)) {
> +		hix5hd2_irq_disable(priv);
> +		napi_schedule(&priv->napi);
> +	}
> +
> +	return IRQ_HANDLED;
> +}
> +
> +static int hix5hd2_net_xmit(struct sk_buff *skb, struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	struct hix5hd2_desc *desc;
> +	u32 pos;
> +
> +	/* software write pointer */
> +	pos = dma_cnt(readl_relaxed(priv->base + TX_BQ_WR_ADDR));
> +	if (unlikely(priv->tx_skb[pos])) {
> +		dev->stats.tx_dropped++;
> +		dev->stats.tx_fifo_errors++;
> +		netif_stop_queue(dev);
> +		return NETDEV_TX_BUSY;
> +	}
> +
> +	desc = priv->tx_bq.desc + pos;
> +	desc->buff_addr =
> +		dma_map_single(priv->dev, skb->data, skb->len, DMA_TO_DEVICE);
> +	if (dma_mapping_error(priv->dev, desc->buff_addr)) {
> +		dev_kfree_skb_any(skb);
> +		return NETDEV_TX_OK;
> +	}
> +
> +	priv->tx_skb[pos] = skb;
> +	desc->buff_len = skb->len;
> +	desc->data_len = skb->len;
> +	desc->fl = DESC_FL_FULL;
> +	desc->descvid = DESC_VLD_BUSY;
> +
> +	pos = dma_ring_incr(pos, TX_DESC_NUM);
> +	writel(dma_byte(pos), priv->base + TX_BQ_WR_ADDR);
> +
> +	dev->trans_start = jiffies;
> +	dev->stats.tx_packets++;
> +	dev->stats.tx_bytes += skb->len;
> +	netdev_sent_queue(dev, skb->len);
> +
> +	return NETDEV_TX_OK;
> +}
> +
> +static void hix5hd2_free_dma_desc_rings(struct hix5hd2_priv *priv)
> +{
> +	struct hix5hd2_desc *desc;
> +	int i;
> +
> +	for (i = 0; i < RX_DESC_NUM; i++) {
> +		struct sk_buff *skb = priv->rx_skb[i];
> +		if (skb == NULL)
> +			continue;
> +
> +		desc = priv->rx_fq.desc + i;
> +		dma_unmap_single(priv->dev, desc->buff_addr,
> +				 MAC_MAX_FRAME_SIZE, DMA_FROM_DEVICE);
> +		dev_kfree_skb_any(skb);
> +		priv->rx_skb[i] = NULL;
> +	}
> +
> +	for (i = 0; i < TX_DESC_NUM; i++) {
> +		struct sk_buff *skb = priv->tx_skb[i];
> +		if (skb == NULL)
> +			continue;
> +
> +		desc = priv->tx_rq.desc + i;
> +		dma_unmap_single(priv->dev, desc->buff_addr,
> +				 skb->len, DMA_TO_DEVICE);
> +		dev_kfree_skb_any(skb);
> +		priv->tx_skb[i] = NULL;
> +	}
> +}
> +
> +static int hix5hd2_net_open(struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	int ret;
> +
> +	ret = clk_prepare_enable(priv->clk);
> +	if (ret < 0) {
> +		netdev_err(dev, "failed to enable clk %d\n", ret);
> +		return ret;
> +	}
> +
> +	priv->phy = of_phy_connect(dev, priv->phy_node,
> +		&hix5hd2_adjust_link, 0, priv->phy_mode);
> +	if (!priv->phy)
> +		return -ENODEV;
> +
> +	phy_start(priv->phy);
> +	hix5hd2_hw_init(priv);
> +	hix5hd2_rx_refill(priv);
> +
> +	netdev_reset_queue(dev);
> +	netif_start_queue(dev);
> +	napi_enable(&priv->napi);
> +
> +	hix5hd2_port_enable(priv);
> +	hix5hd2_irq_enable(priv);
> +
> +	return 0;
> +}
> +
> +static int hix5hd2_net_close(struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +
> +	hix5hd2_port_disable(priv);
> +	hix5hd2_irq_disable(priv);
> +	napi_disable(&priv->napi);
> +	netif_stop_queue(dev);
> +	hix5hd2_free_dma_desc_rings(priv);
> +
> +	if (priv->phy) {
> +		phy_stop(priv->phy);
> +		phy_disconnect(priv->phy);
> +	}
> +
> +	clk_disable_unprepare(priv->clk);
> +
> +	return 0;
> +}
> +
> +static void hix5hd2_tx_timeout_task(struct work_struct *work)
> +{
> +	struct hix5hd2_priv *priv;
> +
> +	priv = container_of(work, struct hix5hd2_priv, tx_timeout_task);
> +	hix5hd2_net_close(priv->netdev);
> +	hix5hd2_net_open(priv->netdev);
> +}
> +
> +static void hix5hd2_net_timeout(struct net_device *dev)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +
> +	schedule_work(&priv->tx_timeout_task);
> +}
> +
> +static struct net_device_stats *hix5hd2_net_get_stats(struct net_device *dev)
> +{
> +	return &dev->stats;
> +}
> +
> +static const struct net_device_ops hix5hd2_netdev_ops = {
> +	.ndo_open		= hix5hd2_net_open,
> +	.ndo_stop		= hix5hd2_net_close,
> +	.ndo_start_xmit		= hix5hd2_net_xmit,
> +	.ndo_tx_timeout		= hix5hd2_net_timeout,
> +	.ndo_set_mac_address	= hix5hd2_net_set_mac_address,
> +	.ndo_get_stats		= hix5hd2_net_get_stats,
> +};
> +
> +static int hix5hd2_get_settings(struct net_device *net_dev,
> +		struct ethtool_cmd *cmd)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(net_dev);
> +
> +	if (!priv->phy)
> +		return -ENODEV;
> +
> +	return phy_ethtool_gset(priv->phy, cmd);
> +}
> +
> +static int hix5hd2_set_settings(struct net_device *net_dev,
> +		struct ethtool_cmd *cmd)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(net_dev);
> +
> +	if (!priv->phy)
> +		return -ENODEV;
> +
> +	return phy_ethtool_sset(priv->phy, cmd);
> +}
> +
> +static struct ethtool_ops hix5hd2_ethtools_ops = {
> +	.get_link		= ethtool_op_get_link,
> +	.get_settings		= hix5hd2_get_settings,
> +	.set_settings		= hix5hd2_set_settings,
> +};
> +
> +static int hix5hd2_mdio_wait_ready(struct mii_bus *bus)
> +{
> +	struct hix5hd2_priv *priv = bus->priv;
> +	void __iomem *base = priv->base;
> +	int i, timeout = 10000;
> +
> +	for (i = 0; readl_relaxed(base + MDIO_SINGLE_CMD) & MDIO_START; i++) {
> +		if (i == timeout)
> +			return -ETIMEDOUT;
> +		udelay(1);
> +	}
> +
> +	return 0;
> +}
> +
> +static int hix5hd2_mdio_read(struct mii_bus *bus, int phy, int reg)
> +{
> +	struct hix5hd2_priv *priv = bus->priv;
> +	void __iomem *base = priv->base;
> +	int val, ret;
> +
> +	ret = hix5hd2_mdio_wait_ready(bus);
> +	if (ret < 0)
> +		goto out;
> +
> +	writel_relaxed(MDIO_READ | phy << 8 | reg, base + MDIO_SINGLE_CMD);
> +	ret = hix5hd2_mdio_wait_ready(bus);
> +	if (ret < 0)
> +		goto out;
> +
> +	val = readl_relaxed(base + MDIO_RDATA_STATUS);
> +	if (val & MDIO_R_VALID) {
> +		dev_err(bus->parent, "SMI bus read not valid\n");
> +		ret = -ENODEV;
> +		goto out;
> +	}
> +
> +	val = readl_relaxed(priv->base + MDIO_SINGLE_DATA);
> +	ret = (val >> 16) & 0xFFFF;
> +out:
> +	return ret;
> +}
> +
> +static int hix5hd2_mdio_write(struct mii_bus *bus, int phy, int reg, u16 val)
> +{
> +	struct hix5hd2_priv *priv = bus->priv;
> +	void __iomem *base = priv->base;
> +	int ret;
> +
> +	ret = hix5hd2_mdio_wait_ready(bus);
> +	if (ret < 0)
> +		goto out;
> +
> +	writel_relaxed(val, base + MDIO_SINGLE_DATA);
> +	writel_relaxed(MDIO_WRITE | phy << 8 | reg, base + MDIO_SINGLE_CMD);
> +	ret = hix5hd2_mdio_wait_ready(bus);
> +out:
> +	return ret;
> +}
> +
> +static void hix5hd2_destroy_hw_desc_queue(struct hix5hd2_priv *priv)
> +{
> +	int i;
> +
> +	for (i = 0; i < QUEUE_NUMS; i++) {
> +		if (priv->pool[i].desc) {
> +			dma_free_coherent(priv->dev, priv->pool[i].size,
> +					priv->pool[i].desc,
> +					priv->pool[i].phys_addr);
> +			priv->pool[i].desc = NULL;
> +		}
> +	}
> +}
> +
> +static int hix5hd2_init_hw_desc_queue(struct hix5hd2_priv *priv)
> +{
> +	struct device *dev = priv->dev;
> +	struct hix5hd2_desc *virt_addr;
> +	dma_addr_t phys_addr;
> +	int size, i;
> +
> +	priv->rx_fq.count = RX_DESC_NUM;
> +	priv->rx_bq.count = RX_DESC_NUM;
> +	priv->tx_bq.count = TX_DESC_NUM;
> +	priv->tx_rq.count = TX_DESC_NUM;
> +
> +	for (i = 0; i < QUEUE_NUMS; i++) {
> +		size = priv->pool[i].count * sizeof(struct hix5hd2_desc);
> +		virt_addr = dma_alloc_coherent(dev, size, &phys_addr,
> +				GFP_KERNEL);
> +		if (virt_addr == NULL)
> +			goto error_free_pool;
> +
> +		memset(virt_addr, 0, size);
> +		priv->pool[i].size = size;
> +		priv->pool[i].desc = virt_addr;
> +		priv->pool[i].phys_addr = phys_addr;
> +	}
> +	return 0;
> +
> +error_free_pool:
> +	hix5hd2_destroy_hw_desc_queue(priv);
> +
> +	return -ENOMEM;
> +}
> +
> +static int hix5hd2_dev_probe(struct platform_device *pdev)
> +{
> +	struct device *dev = &pdev->dev;
> +	struct device_node *node = dev->of_node;
> +	struct net_device *ndev;
> +	struct hix5hd2_priv *priv;
> +	struct resource *res;
> +	struct mii_bus *bus;
> +	const char *mac_addr;
> +	int ret;
> +
> +	ndev = alloc_etherdev(sizeof(struct hix5hd2_priv));
> +	if (!ndev)
> +		return -ENOMEM;
> +
> +	platform_set_drvdata(pdev, ndev);
> +
> +	priv = netdev_priv(ndev);
> +	priv->dev = dev;
> +	priv->netdev = ndev;
> +
> +	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> +	priv->base = devm_ioremap_resource(dev, res);
> +	if (IS_ERR(priv->base)) {
> +		ret = PTR_ERR(priv->base);
> +		goto out_free_netdev;
> +	}
> +
> +	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
> +	priv->ctrl_base = devm_ioremap_resource(dev, res);
> +	if (IS_ERR(priv->ctrl_base)) {
> +		ret = PTR_ERR(priv->ctrl_base);
> +		goto out_free_netdev;
> +	}
> +
> +	priv->clk = devm_clk_get(&pdev->dev, NULL);
> +	if (IS_ERR(priv->clk)) {
> +		netdev_err(ndev, "failed to get clk\n");
> +		ret = -ENODEV;
> +		goto out_free_netdev;
> +	}
> +
> +	ret = clk_prepare_enable(priv->clk);
> +	if (ret < 0) {
> +		netdev_err(ndev, "failed to enable clk %d\n", ret);
> +		goto out_free_netdev;
> +	}
> +
> +	bus = mdiobus_alloc();
> +	if (bus == NULL) {
> +		ret = -ENOMEM;
> +		goto out_free_netdev;
> +	}
> +
> +	bus->priv = priv;
> +	bus->name = "hix5hd2_mii_bus";
> +	bus->read = hix5hd2_mdio_read;
> +	bus->write = hix5hd2_mdio_write;
> +	bus->parent = &pdev->dev;
> +	snprintf(bus->id, MII_BUS_ID_SIZE, "%s-mii", dev_name(&pdev->dev));
> +	priv->bus = bus;
> +
> +	ret = of_mdiobus_register(bus, node);
> +	if (ret)
> +		goto err_free_mdio;
> +
> +	priv->phy_mode = of_get_phy_mode(node);
> +	if (priv->phy_mode < 0) {
> +		netdev_err(ndev, "not find phy-mode\n");
> +		ret = -EINVAL;
> +		goto err_mdiobus;
> +	}
> +
> +	priv->phy_node = of_parse_phandle(node, "phy-handle", 0);
> +	if (!priv->phy_node) {
> +		netdev_err(ndev, "not find phy-handle\n");
> +		ret = -EINVAL;
> +		goto err_mdiobus;
> +	}
> +
> +	ndev->irq = platform_get_irq(pdev, 0);
> +	if (ndev->irq <= 0) {
> +		netdev_err(ndev, "No irq resource\n");
> +		ret = -EINVAL;
> +		goto out_phy_node;
> +	}
> +
> +	ret = devm_request_irq(dev, ndev->irq, hix5hd2_interrupt,
> +				0, pdev->name, ndev);
> +	if (ret) {
> +		netdev_err(ndev, "devm_request_irq failed\n");
> +		goto out_phy_node;
> +	}
> +
> +	mac_addr = of_get_mac_address(node);
> +	if (mac_addr)
> +		ether_addr_copy(ndev->dev_addr, mac_addr);
> +	if (!is_valid_ether_addr(ndev->dev_addr)) {
> +		eth_hw_addr_random(ndev);
> +		netdev_warn(ndev, "using random MAC address %pM\n",
> +			 ndev->dev_addr);
> +	}
> +
> +	INIT_WORK(&priv->tx_timeout_task, hix5hd2_tx_timeout_task);
> +	ether_setup(ndev);
> +	ndev->watchdog_timeo = 6 * HZ;
> +	ndev->priv_flags |= IFF_UNICAST_FLT;
> +	ndev->netdev_ops = &hix5hd2_netdev_ops;
> +	ndev->ethtool_ops = &hix5hd2_ethtools_ops;
> +	SET_NETDEV_DEV(ndev, dev);
> +
> +	ret = hix5hd2_init_hw_desc_queue(priv);
> +	if (ret)
> +		goto out_phy_node;
> +
> +	netif_napi_add(ndev, &priv->napi, hix5hd2_poll, NAPI_POLL_WEIGHT);
> +	ret = register_netdev(priv->netdev);
> +	if (ret) {
> +		netdev_err(ndev, "register_netdev failed!");
> +		goto out_destroy_queue;
> +	}
> +
> +	clk_disable_unprepare(priv->clk);
> +
> +	return ret;
> +
> +out_destroy_queue:
> +	netif_napi_del(&priv->napi);
> +	hix5hd2_destroy_hw_desc_queue(priv);
> +out_phy_node:
> +	of_node_put(priv->phy_node);
> +err_mdiobus:
> +	mdiobus_unregister(bus);
> +err_free_mdio:
> +	mdiobus_free(bus);
> +out_free_netdev:
> +	free_netdev(ndev);
> +
> +	return ret;
> +}
> +
> +static int hix5hd2_dev_remove(struct platform_device *pdev)
> +{
> +	struct net_device *ndev = platform_get_drvdata(pdev);
> +	struct hix5hd2_priv *priv = netdev_priv(ndev);
> +
> +	netif_napi_del(&priv->napi);
> +	unregister_netdev(ndev);
> +	mdiobus_unregister(priv->bus);
> +	mdiobus_free(priv->bus);
> +
> +	hix5hd2_destroy_hw_desc_queue(priv);
> +	of_node_put(priv->phy_node);
> +	cancel_work_sync(&priv->tx_timeout_task);
> +	free_netdev(ndev);
> +
> +	return 0;
> +}
> +
> +static const struct of_device_id hix5hd2_of_match[] = {
> +	{.compatible = "hisilicon,hix5hd2-mac",},
> +	{},
> +};
> +
> +MODULE_DEVICE_TABLE(of, hix5hd2_of_match);
> +
> +static struct platform_driver hix5hd2_dev_driver = {
> +	.driver = {
> +		.name = "hix5hd2-mac",
> +		.of_match_table = hix5hd2_of_match,
> +	},
> +	.probe = hix5hd2_dev_probe,
> +	.remove = hix5hd2_dev_remove,
> +};
> +
> +module_platform_driver(hix5hd2_dev_driver);
> +
> +MODULE_DESCRIPTION("HISILICON X5HD2 Ethernet driver");
> +MODULE_LICENSE("GPL v2");
> +MODULE_ALIAS("platform:hix5hd2-ether");
>

Re: [PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[Arnd Bergmann]

On Monday 19 May 2014, Zhangfei Gao wrote:

I only noticed one real issue with the driver:

> +struct hix5hd2_desc {
> +	__le32 buff_addr;
> +	__le32 buff_len:11;
> +	__le32 reserve2:5;
> +	__le32 data_len:11;
> +	__le32 reserve1:2;
> +	__le32 fl:2;
> +	__le32 descvid:1;
> +} __aligned(32);
> +

You should generall not use bitfields in hardware data structures, as that is
not endian safe and will prevent running a big-endian kernel on this machine.
Better convert this to a set of __le32 fields and explicit shifts and masks.

Two smaller things you should think about, I'm not entirely sure about these:

> +static int hix5hd2_rx(struct net_device *dev, int limit)
> +{
> +	struct hix5hd2_priv *priv = netdev_priv(dev);
> +	struct sk_buff *skb;
> +	struct hix5hd2_desc *desc;
> +	dma_addr_t dma_addr;
> +	u32 start, end, num, pos, i, len;
> +
> +	/* software read pointer */
> +	start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
> +	/* logic write pointer */
> +	end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));

I think one of these needs to be readl() instead of readl_relaxed(),
to ensure the data is correctly ordered with regard to the pointer
access.

> +	if (pos != start)
> +		writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);

While this looks like it could be writel_relaxed().

	Arnd

Re: [PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[zhangfei]

Hi Arnd,

Thanks for the kind suggestions.

On 05/26/2014 10:51 PM, Arnd Bergmann wrote:
> On Monday 19 May 2014, Zhangfei Gao wrote:
>
> I only noticed one real issue with the driver:
>
>> +struct hix5hd2_desc {
>> +	__le32 buff_addr;
>> +	__le32 buff_len:11;
>> +	__le32 reserve2:5;
>> +	__le32 data_len:11;
>> +	__le32 reserve1:2;
>> +	__le32 fl:2;
>> +	__le32 descvid:1;
>> +} __aligned(32);
>> +
>
> You should generall not use bitfields in hardware data structures, as that is
> not endian safe and will prevent running a big-endian kernel on this machine.
> Better convert this to a set of __le32 fields and explicit shifts and masks.

Got it, will update.

More knowledge about big-endian kernel is appreciated, in which case we 
should consider such kernel.
Can we only consider this driver is only running on arm, which is 
little-endian.

>
> Two smaller things you should think about, I'm not entirely sure about these:
>
>> +static int hix5hd2_rx(struct net_device *dev, int limit)
>> +{
>> +	struct hix5hd2_priv *priv = netdev_priv(dev);
>> +	struct sk_buff *skb;
>> +	struct hix5hd2_desc *desc;
>> +	dma_addr_t dma_addr;
>> +	u32 start, end, num, pos, i, len;
>> +
>> +	/* software read pointer */
>> +	start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
>> +	/* logic write pointer */
>> +	end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));
>
> I think one of these needs to be readl() instead of readl_relaxed(),
> to ensure the data is correctly ordered with regard to the pointer
> access.
readl_relaxed can ensure the sequence.

>
>> +	if (pos != start)
>> +		writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);
>
> While this looks like it could be writel_relaxed().
>
En, I think all three cases can use xxx_relaxed.
These accesses are just update pointer used by internal logic and get 
pointer updated by internal logic.

Thanks

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[Arnd Bergmann]

On Tuesday 27 May 2014, zhangfei wrote:
> On 05/26/2014 10:51 PM, Arnd Bergmann wrote:
> > On Monday 19 May 2014, Zhangfei Gao wrote:
> >
> > I only noticed one real issue with the driver:
> >
> >> +struct hix5hd2_desc {
> >> +    __le32 buff_addr;
> >> +    __le32 buff_len:11;
> >> +    __le32 reserve2:5;
> >> +    __le32 data_len:11;
> >> +    __le32 reserve1:2;
> >> +    __le32 fl:2;
> >> +    __le32 descvid:1;
> >> +} __aligned(32);
> >> +
> >
> > You should generall not use bitfields in hardware data structures, as that is
> > not endian safe and will prevent running a big-endian kernel on this machine.
> > Better convert this to a set of __le32 fields and explicit shifts and masks.
> 
> Got it, will update.
> 
> More knowledge about big-endian kernel is appreciated, in which case we 
> should consider such kernel.
> Can we only consider this driver is only running on arm, which is 
> little-endian.

The main user of big-endian kernels that I know of are network infrastructure
people that have a ton of legacy user-space code written in non-portable
big-endian style.

There is no real technical advantage in running one endianess or the other
on ARM, so generally everyone uses little-endian because that is what their
user space is, except for the few people that have ported over their
code from PowerPC or MIPSeb.

> > Two smaller things you should think about, I'm not entirely sure about these:
> >
> >> +static int hix5hd2_rx(struct net_device *dev, int limit)
> >> +{
> >> +    struct hix5hd2_priv *priv = netdev_priv(dev);
> >> +    struct sk_buff *skb;
> >> +    struct hix5hd2_desc *desc;
> >> +    dma_addr_t dma_addr;
> >> +    u32 start, end, num, pos, i, len;
> >> +
> >> +    /* software read pointer */
> >> +    start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
> >> +    /* logic write pointer */
> >> +    end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));
> >
> > I think one of these needs to be readl() instead of readl_relaxed(),
> > to ensure the data is correctly ordered with regard to the pointer
> > access.
> readl_relaxed can ensure the sequence.
> 
> >
> >> +    if (pos != start)
> >> +            writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);
> >
> > While this looks like it could be writel_relaxed().
> >
> En, I think all three cases can use xxx_relaxed.
> These accesses are just update pointer used by internal logic and get 
> pointer updated by internal logic.

You always need a barrier between the access to a buffer from the kernel
and the register access communicating with the hardware about that
buffer:

For tx:

	a) write to DMA descriptor
	b) wmb()
	c) writel_relaxed(register)

writel() is the short form of b+c. If you omit the __iowmb(), the decriptor
access may still be inside of the CPU write buffer (or the cache on coherent
systems) by the time the hardware reads the descriptor.

for rx:

	a) readl_relaxed(register)
	b) rmb()
	c) read from descriptor or skb data

If you leave out the __iormb() here, it's possible that the CPU can prefetch
the access to the descriptor while waiting for the register data, and read
stale data.

If your particular machine doesn't need rmb() or wmb() (e.g. for
non-SMP ARMv6 or older), the build process should replace them with
do{}while(0) them automatically.

	Arnd

Re: [PATCH 3/3] net: hisilicon: add hix5hd2 mac driver

[zhangfei]

On 05/27/2014 09:25 PM, Arnd Bergmann wrote:
> On Tuesday 27 May 2014, zhangfei wrote:
>> On 05/26/2014 10:51 PM, Arnd Bergmann wrote:
>>> On Monday 19 May 2014, Zhangfei Gao wrote:
>>>
>>> I only noticed one real issue with the driver:
>>>
>>>> +struct hix5hd2_desc {
>>>> +    __le32 buff_addr;
>>>> +    __le32 buff_len:11;
>>>> +    __le32 reserve2:5;
>>>> +    __le32 data_len:11;
>>>> +    __le32 reserve1:2;
>>>> +    __le32 fl:2;
>>>> +    __le32 descvid:1;
>>>> +} __aligned(32);
>>>> +
>>>
>>> You should generall not use bitfields in hardware data structures, as that is
>>> not endian safe and will prevent running a big-endian kernel on this machine.
>>> Better convert this to a set of __le32 fields and explicit shifts and masks.
>>
>> Got it, will update.
>>
>> More knowledge about big-endian kernel is appreciated, in which case we
>> should consider such kernel.
>> Can we only consider this driver is only running on arm, which is
>> little-endian.
>
> The main user of big-endian kernels that I know of are network infrastructure
> people that have a ton of legacy user-space code written in non-portable
> big-endian style.
>
> There is no real technical advantage in running one endianess or the other
> on ARM, so generally everyone uses little-endian because that is what their
> user space is, except for the few people that have ported over their
> code from PowerPC or MIPSeb.
>
>>> Two smaller things you should think about, I'm not entirely sure about these:
>>>
>>>> +static int hix5hd2_rx(struct net_device *dev, int limit)
>>>> +{
>>>> +    struct hix5hd2_priv *priv = netdev_priv(dev);
>>>> +    struct sk_buff *skb;
>>>> +    struct hix5hd2_desc *desc;
>>>> +    dma_addr_t dma_addr;
>>>> +    u32 start, end, num, pos, i, len;
>>>> +
>>>> +    /* software read pointer */
>>>> +    start = dma_cnt(readl_relaxed(priv->base + RX_BQ_RD_ADDR));
>>>> +    /* logic write pointer */
>>>> +    end = dma_cnt(readl_relaxed(priv->base + RX_BQ_WR_ADDR));
>>>
>>> I think one of these needs to be readl() instead of readl_relaxed(),
>>> to ensure the data is correctly ordered with regard to the pointer
>>> access.
>> readl_relaxed can ensure the sequence.
>>
>>>
>>>> +    if (pos != start)
>>>> +            writel(dma_byte(pos), priv->base + TX_RQ_RD_ADDR);
>>>
>>> While this looks like it could be writel_relaxed().
>>>
>> En, I think all three cases can use xxx_relaxed.
>> These accesses are just update pointer used by internal logic and get
>> pointer updated by internal logic.
>
> You always need a barrier between the access to a buffer from the kernel
> and the register access communicating with the hardware about that
> buffer:
>
> For tx:
>
> 	a) write to DMA descriptor
> 	b) wmb()
> 	c) writel_relaxed(register)
>
> writel() is the short form of b+c. If you omit the __iowmb(), the decriptor
> access may still be inside of the CPU write buffer (or the cache on coherent
> systems) by the time the hardware reads the descriptor.
>
> for rx:
>
> 	a) readl_relaxed(register)
> 	b) rmb()
> 	c) read from descriptor or skb data
>
> If you leave out the __iormb() here, it's possible that the CPU can prefetch
> the access to the descriptor while waiting for the register data, and read
> stale data.
>
> If your particular machine doesn't need rmb() or wmb() (e.g. for
> non-SMP ARMv6 or older), the build process should replace them with
> do{}while(0) them automatically.

Thanks Arnd,
Yes, understand, barrier still required.

What I thought was the dma in this controller keeps running and not need 
desc to trigger, only update pointer, so no need barrier.
Even so, desc still need to be sync via barrier, otherwise, desc with 
stale info may be used.

Will add barrier accordingly.

Thanks