1765c39a4SLuiz Angelo Daros de Luca // SPDX-License-Identifier: GPL-2.0+
2765c39a4SLuiz Angelo Daros de Luca /* Realtek Simple Management Interface (SMI) driver
3765c39a4SLuiz Angelo Daros de Luca * It can be discussed how "simple" this interface is.
4765c39a4SLuiz Angelo Daros de Luca *
5765c39a4SLuiz Angelo Daros de Luca * The SMI protocol piggy-backs the MDIO MDC and MDIO signals levels
6765c39a4SLuiz Angelo Daros de Luca * but the protocol is not MDIO at all. Instead it is a Realtek
7765c39a4SLuiz Angelo Daros de Luca * pecularity that need to bit-bang the lines in a special way to
8765c39a4SLuiz Angelo Daros de Luca * communicate with the switch.
9765c39a4SLuiz Angelo Daros de Luca *
10765c39a4SLuiz Angelo Daros de Luca * ASICs we intend to support with this driver:
11765c39a4SLuiz Angelo Daros de Luca *
12765c39a4SLuiz Angelo Daros de Luca * RTL8366 - The original version, apparently
13765c39a4SLuiz Angelo Daros de Luca * RTL8369 - Similar enough to have the same datsheet as RTL8366
14765c39a4SLuiz Angelo Daros de Luca * RTL8366RB - Probably reads out "RTL8366 revision B", has a quite
15765c39a4SLuiz Angelo Daros de Luca * different register layout from the other two
16765c39a4SLuiz Angelo Daros de Luca * RTL8366S - Is this "RTL8366 super"?
17765c39a4SLuiz Angelo Daros de Luca * RTL8367 - Has an OpenWRT driver as well
18765c39a4SLuiz Angelo Daros de Luca * RTL8368S - Seems to be an alternative name for RTL8366RB
19765c39a4SLuiz Angelo Daros de Luca * RTL8370 - Also uses SMI
20765c39a4SLuiz Angelo Daros de Luca *
21765c39a4SLuiz Angelo Daros de Luca * Copyright (C) 2017 Linus Walleij <linus.walleij@linaro.org>
22765c39a4SLuiz Angelo Daros de Luca * Copyright (C) 2010 Antti Seppälä <a.seppala@gmail.com>
23765c39a4SLuiz Angelo Daros de Luca * Copyright (C) 2010 Roman Yeryomin <roman@advem.lv>
24765c39a4SLuiz Angelo Daros de Luca * Copyright (C) 2011 Colin Leitner <colin.leitner@googlemail.com>
25765c39a4SLuiz Angelo Daros de Luca * Copyright (C) 2009-2010 Gabor Juhos <juhosg@openwrt.org>
26765c39a4SLuiz Angelo Daros de Luca */
27765c39a4SLuiz Angelo Daros de Luca
28765c39a4SLuiz Angelo Daros de Luca #include <linux/kernel.h>
29765c39a4SLuiz Angelo Daros de Luca #include <linux/module.h>
30765c39a4SLuiz Angelo Daros de Luca #include <linux/device.h>
31765c39a4SLuiz Angelo Daros de Luca #include <linux/spinlock.h>
32765c39a4SLuiz Angelo Daros de Luca #include <linux/skbuff.h>
33765c39a4SLuiz Angelo Daros de Luca #include <linux/of.h>
34765c39a4SLuiz Angelo Daros de Luca #include <linux/of_mdio.h>
35765c39a4SLuiz Angelo Daros de Luca #include <linux/delay.h>
36765c39a4SLuiz Angelo Daros de Luca #include <linux/gpio/consumer.h>
37765c39a4SLuiz Angelo Daros de Luca #include <linux/platform_device.h>
38765c39a4SLuiz Angelo Daros de Luca #include <linux/regmap.h>
39765c39a4SLuiz Angelo Daros de Luca #include <linux/bitops.h>
40765c39a4SLuiz Angelo Daros de Luca #include <linux/if_bridge.h>
41765c39a4SLuiz Angelo Daros de Luca
42765c39a4SLuiz Angelo Daros de Luca #include "realtek.h"
43765c39a4SLuiz Angelo Daros de Luca
44765c39a4SLuiz Angelo Daros de Luca #define REALTEK_SMI_ACK_RETRY_COUNT 5
45765c39a4SLuiz Angelo Daros de Luca
realtek_smi_clk_delay(struct realtek_priv * priv)46765c39a4SLuiz Angelo Daros de Luca static inline void realtek_smi_clk_delay(struct realtek_priv *priv)
47765c39a4SLuiz Angelo Daros de Luca {
48765c39a4SLuiz Angelo Daros de Luca ndelay(priv->clk_delay);
49765c39a4SLuiz Angelo Daros de Luca }
50765c39a4SLuiz Angelo Daros de Luca
realtek_smi_start(struct realtek_priv * priv)51765c39a4SLuiz Angelo Daros de Luca static void realtek_smi_start(struct realtek_priv *priv)
52765c39a4SLuiz Angelo Daros de Luca {
53765c39a4SLuiz Angelo Daros de Luca /* Set GPIO pins to output mode, with initial state:
54765c39a4SLuiz Angelo Daros de Luca * SCK = 0, SDA = 1
55765c39a4SLuiz Angelo Daros de Luca */
56765c39a4SLuiz Angelo Daros de Luca gpiod_direction_output(priv->mdc, 0);
57765c39a4SLuiz Angelo Daros de Luca gpiod_direction_output(priv->mdio, 1);
58765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
59765c39a4SLuiz Angelo Daros de Luca
60765c39a4SLuiz Angelo Daros de Luca /* CLK 1: 0 -> 1, 1 -> 0 */
61765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
62765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
63765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
64765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
65765c39a4SLuiz Angelo Daros de Luca
66765c39a4SLuiz Angelo Daros de Luca /* CLK 2: */
67765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
68765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
69765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdio, 0);
70765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
71765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
72765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
73765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdio, 1);
74765c39a4SLuiz Angelo Daros de Luca }
75765c39a4SLuiz Angelo Daros de Luca
realtek_smi_stop(struct realtek_priv * priv)76765c39a4SLuiz Angelo Daros de Luca static void realtek_smi_stop(struct realtek_priv *priv)
77765c39a4SLuiz Angelo Daros de Luca {
78765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
79765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdio, 0);
80765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
81765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
82765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdio, 1);
83765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
84765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
85765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
86765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
87765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
88765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
89765c39a4SLuiz Angelo Daros de Luca
90765c39a4SLuiz Angelo Daros de Luca /* Add a click */
91765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
92765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
93765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
94765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
95765c39a4SLuiz Angelo Daros de Luca
96765c39a4SLuiz Angelo Daros de Luca /* Set GPIO pins to input mode */
97765c39a4SLuiz Angelo Daros de Luca gpiod_direction_input(priv->mdio);
98765c39a4SLuiz Angelo Daros de Luca gpiod_direction_input(priv->mdc);
99765c39a4SLuiz Angelo Daros de Luca }
100765c39a4SLuiz Angelo Daros de Luca
realtek_smi_write_bits(struct realtek_priv * priv,u32 data,u32 len)101765c39a4SLuiz Angelo Daros de Luca static void realtek_smi_write_bits(struct realtek_priv *priv, u32 data, u32 len)
102765c39a4SLuiz Angelo Daros de Luca {
103765c39a4SLuiz Angelo Daros de Luca for (; len > 0; len--) {
104765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
105765c39a4SLuiz Angelo Daros de Luca
106765c39a4SLuiz Angelo Daros de Luca /* Prepare data */
107765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdio, !!(data & (1 << (len - 1))));
108765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
109765c39a4SLuiz Angelo Daros de Luca
110765c39a4SLuiz Angelo Daros de Luca /* Clocking */
111765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
112765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
113765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
114765c39a4SLuiz Angelo Daros de Luca }
115765c39a4SLuiz Angelo Daros de Luca }
116765c39a4SLuiz Angelo Daros de Luca
realtek_smi_read_bits(struct realtek_priv * priv,u32 len,u32 * data)117765c39a4SLuiz Angelo Daros de Luca static void realtek_smi_read_bits(struct realtek_priv *priv, u32 len, u32 *data)
118765c39a4SLuiz Angelo Daros de Luca {
119765c39a4SLuiz Angelo Daros de Luca gpiod_direction_input(priv->mdio);
120765c39a4SLuiz Angelo Daros de Luca
121765c39a4SLuiz Angelo Daros de Luca for (*data = 0; len > 0; len--) {
122765c39a4SLuiz Angelo Daros de Luca u32 u;
123765c39a4SLuiz Angelo Daros de Luca
124765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
125765c39a4SLuiz Angelo Daros de Luca
126765c39a4SLuiz Angelo Daros de Luca /* Clocking */
127765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 1);
128765c39a4SLuiz Angelo Daros de Luca realtek_smi_clk_delay(priv);
129765c39a4SLuiz Angelo Daros de Luca u = !!gpiod_get_value(priv->mdio);
130765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->mdc, 0);
131765c39a4SLuiz Angelo Daros de Luca
132765c39a4SLuiz Angelo Daros de Luca *data |= (u << (len - 1));
133765c39a4SLuiz Angelo Daros de Luca }
134765c39a4SLuiz Angelo Daros de Luca
135765c39a4SLuiz Angelo Daros de Luca gpiod_direction_output(priv->mdio, 0);
136765c39a4SLuiz Angelo Daros de Luca }
137765c39a4SLuiz Angelo Daros de Luca
realtek_smi_wait_for_ack(struct realtek_priv * priv)138765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_wait_for_ack(struct realtek_priv *priv)
139765c39a4SLuiz Angelo Daros de Luca {
140765c39a4SLuiz Angelo Daros de Luca int retry_cnt;
141765c39a4SLuiz Angelo Daros de Luca
142765c39a4SLuiz Angelo Daros de Luca retry_cnt = 0;
143765c39a4SLuiz Angelo Daros de Luca do {
144765c39a4SLuiz Angelo Daros de Luca u32 ack;
145765c39a4SLuiz Angelo Daros de Luca
146765c39a4SLuiz Angelo Daros de Luca realtek_smi_read_bits(priv, 1, &ack);
147765c39a4SLuiz Angelo Daros de Luca if (ack == 0)
148765c39a4SLuiz Angelo Daros de Luca break;
149765c39a4SLuiz Angelo Daros de Luca
150765c39a4SLuiz Angelo Daros de Luca if (++retry_cnt > REALTEK_SMI_ACK_RETRY_COUNT) {
151765c39a4SLuiz Angelo Daros de Luca dev_err(priv->dev, "ACK timeout\n");
152765c39a4SLuiz Angelo Daros de Luca return -ETIMEDOUT;
153765c39a4SLuiz Angelo Daros de Luca }
154765c39a4SLuiz Angelo Daros de Luca } while (1);
155765c39a4SLuiz Angelo Daros de Luca
156765c39a4SLuiz Angelo Daros de Luca return 0;
157765c39a4SLuiz Angelo Daros de Luca }
158765c39a4SLuiz Angelo Daros de Luca
realtek_smi_write_byte(struct realtek_priv * priv,u8 data)159765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_write_byte(struct realtek_priv *priv, u8 data)
160765c39a4SLuiz Angelo Daros de Luca {
161765c39a4SLuiz Angelo Daros de Luca realtek_smi_write_bits(priv, data, 8);
162765c39a4SLuiz Angelo Daros de Luca return realtek_smi_wait_for_ack(priv);
163765c39a4SLuiz Angelo Daros de Luca }
164765c39a4SLuiz Angelo Daros de Luca
realtek_smi_write_byte_noack(struct realtek_priv * priv,u8 data)165765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_write_byte_noack(struct realtek_priv *priv, u8 data)
166765c39a4SLuiz Angelo Daros de Luca {
167765c39a4SLuiz Angelo Daros de Luca realtek_smi_write_bits(priv, data, 8);
168765c39a4SLuiz Angelo Daros de Luca return 0;
169765c39a4SLuiz Angelo Daros de Luca }
170765c39a4SLuiz Angelo Daros de Luca
realtek_smi_read_byte0(struct realtek_priv * priv,u8 * data)171765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_read_byte0(struct realtek_priv *priv, u8 *data)
172765c39a4SLuiz Angelo Daros de Luca {
173765c39a4SLuiz Angelo Daros de Luca u32 t;
174765c39a4SLuiz Angelo Daros de Luca
175765c39a4SLuiz Angelo Daros de Luca /* Read data */
176765c39a4SLuiz Angelo Daros de Luca realtek_smi_read_bits(priv, 8, &t);
177765c39a4SLuiz Angelo Daros de Luca *data = (t & 0xff);
178765c39a4SLuiz Angelo Daros de Luca
179765c39a4SLuiz Angelo Daros de Luca /* Send an ACK */
180765c39a4SLuiz Angelo Daros de Luca realtek_smi_write_bits(priv, 0x00, 1);
181765c39a4SLuiz Angelo Daros de Luca
182765c39a4SLuiz Angelo Daros de Luca return 0;
183765c39a4SLuiz Angelo Daros de Luca }
184765c39a4SLuiz Angelo Daros de Luca
realtek_smi_read_byte1(struct realtek_priv * priv,u8 * data)185765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_read_byte1(struct realtek_priv *priv, u8 *data)
186765c39a4SLuiz Angelo Daros de Luca {
187765c39a4SLuiz Angelo Daros de Luca u32 t;
188765c39a4SLuiz Angelo Daros de Luca
189765c39a4SLuiz Angelo Daros de Luca /* Read data */
190765c39a4SLuiz Angelo Daros de Luca realtek_smi_read_bits(priv, 8, &t);
191765c39a4SLuiz Angelo Daros de Luca *data = (t & 0xff);
192765c39a4SLuiz Angelo Daros de Luca
193765c39a4SLuiz Angelo Daros de Luca /* Send an ACK */
194765c39a4SLuiz Angelo Daros de Luca realtek_smi_write_bits(priv, 0x01, 1);
195765c39a4SLuiz Angelo Daros de Luca
196765c39a4SLuiz Angelo Daros de Luca return 0;
197765c39a4SLuiz Angelo Daros de Luca }
198765c39a4SLuiz Angelo Daros de Luca
realtek_smi_read_reg(struct realtek_priv * priv,u32 addr,u32 * data)199765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_read_reg(struct realtek_priv *priv, u32 addr, u32 *data)
200765c39a4SLuiz Angelo Daros de Luca {
201765c39a4SLuiz Angelo Daros de Luca unsigned long flags;
202765c39a4SLuiz Angelo Daros de Luca u8 lo = 0;
203765c39a4SLuiz Angelo Daros de Luca u8 hi = 0;
204765c39a4SLuiz Angelo Daros de Luca int ret;
205765c39a4SLuiz Angelo Daros de Luca
206765c39a4SLuiz Angelo Daros de Luca spin_lock_irqsave(&priv->lock, flags);
207765c39a4SLuiz Angelo Daros de Luca
208765c39a4SLuiz Angelo Daros de Luca realtek_smi_start(priv);
209765c39a4SLuiz Angelo Daros de Luca
210765c39a4SLuiz Angelo Daros de Luca /* Send READ command */
211765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, priv->cmd_read);
212765c39a4SLuiz Angelo Daros de Luca if (ret)
213765c39a4SLuiz Angelo Daros de Luca goto out;
214765c39a4SLuiz Angelo Daros de Luca
215765c39a4SLuiz Angelo Daros de Luca /* Set ADDR[7:0] */
216765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, addr & 0xff);
217765c39a4SLuiz Angelo Daros de Luca if (ret)
218765c39a4SLuiz Angelo Daros de Luca goto out;
219765c39a4SLuiz Angelo Daros de Luca
220765c39a4SLuiz Angelo Daros de Luca /* Set ADDR[15:8] */
221765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, addr >> 8);
222765c39a4SLuiz Angelo Daros de Luca if (ret)
223765c39a4SLuiz Angelo Daros de Luca goto out;
224765c39a4SLuiz Angelo Daros de Luca
225765c39a4SLuiz Angelo Daros de Luca /* Read DATA[7:0] */
226765c39a4SLuiz Angelo Daros de Luca realtek_smi_read_byte0(priv, &lo);
227765c39a4SLuiz Angelo Daros de Luca /* Read DATA[15:8] */
228765c39a4SLuiz Angelo Daros de Luca realtek_smi_read_byte1(priv, &hi);
229765c39a4SLuiz Angelo Daros de Luca
230765c39a4SLuiz Angelo Daros de Luca *data = ((u32)lo) | (((u32)hi) << 8);
231765c39a4SLuiz Angelo Daros de Luca
232765c39a4SLuiz Angelo Daros de Luca ret = 0;
233765c39a4SLuiz Angelo Daros de Luca
234765c39a4SLuiz Angelo Daros de Luca out:
235765c39a4SLuiz Angelo Daros de Luca realtek_smi_stop(priv);
236765c39a4SLuiz Angelo Daros de Luca spin_unlock_irqrestore(&priv->lock, flags);
237765c39a4SLuiz Angelo Daros de Luca
238765c39a4SLuiz Angelo Daros de Luca return ret;
239765c39a4SLuiz Angelo Daros de Luca }
240765c39a4SLuiz Angelo Daros de Luca
realtek_smi_write_reg(struct realtek_priv * priv,u32 addr,u32 data,bool ack)241765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_write_reg(struct realtek_priv *priv,
242765c39a4SLuiz Angelo Daros de Luca u32 addr, u32 data, bool ack)
243765c39a4SLuiz Angelo Daros de Luca {
244765c39a4SLuiz Angelo Daros de Luca unsigned long flags;
245765c39a4SLuiz Angelo Daros de Luca int ret;
246765c39a4SLuiz Angelo Daros de Luca
247765c39a4SLuiz Angelo Daros de Luca spin_lock_irqsave(&priv->lock, flags);
248765c39a4SLuiz Angelo Daros de Luca
249765c39a4SLuiz Angelo Daros de Luca realtek_smi_start(priv);
250765c39a4SLuiz Angelo Daros de Luca
251765c39a4SLuiz Angelo Daros de Luca /* Send WRITE command */
252765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, priv->cmd_write);
253765c39a4SLuiz Angelo Daros de Luca if (ret)
254765c39a4SLuiz Angelo Daros de Luca goto out;
255765c39a4SLuiz Angelo Daros de Luca
256765c39a4SLuiz Angelo Daros de Luca /* Set ADDR[7:0] */
257765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, addr & 0xff);
258765c39a4SLuiz Angelo Daros de Luca if (ret)
259765c39a4SLuiz Angelo Daros de Luca goto out;
260765c39a4SLuiz Angelo Daros de Luca
261765c39a4SLuiz Angelo Daros de Luca /* Set ADDR[15:8] */
262765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, addr >> 8);
263765c39a4SLuiz Angelo Daros de Luca if (ret)
264765c39a4SLuiz Angelo Daros de Luca goto out;
265765c39a4SLuiz Angelo Daros de Luca
266765c39a4SLuiz Angelo Daros de Luca /* Write DATA[7:0] */
267765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, data & 0xff);
268765c39a4SLuiz Angelo Daros de Luca if (ret)
269765c39a4SLuiz Angelo Daros de Luca goto out;
270765c39a4SLuiz Angelo Daros de Luca
271765c39a4SLuiz Angelo Daros de Luca /* Write DATA[15:8] */
272765c39a4SLuiz Angelo Daros de Luca if (ack)
273765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte(priv, data >> 8);
274765c39a4SLuiz Angelo Daros de Luca else
275765c39a4SLuiz Angelo Daros de Luca ret = realtek_smi_write_byte_noack(priv, data >> 8);
276765c39a4SLuiz Angelo Daros de Luca if (ret)
277765c39a4SLuiz Angelo Daros de Luca goto out;
278765c39a4SLuiz Angelo Daros de Luca
279765c39a4SLuiz Angelo Daros de Luca ret = 0;
280765c39a4SLuiz Angelo Daros de Luca
281765c39a4SLuiz Angelo Daros de Luca out:
282765c39a4SLuiz Angelo Daros de Luca realtek_smi_stop(priv);
283765c39a4SLuiz Angelo Daros de Luca spin_unlock_irqrestore(&priv->lock, flags);
284765c39a4SLuiz Angelo Daros de Luca
285765c39a4SLuiz Angelo Daros de Luca return ret;
286765c39a4SLuiz Angelo Daros de Luca }
287765c39a4SLuiz Angelo Daros de Luca
288765c39a4SLuiz Angelo Daros de Luca /* There is one single case when we need to use this accessor and that
289765c39a4SLuiz Angelo Daros de Luca * is when issueing soft reset. Since the device reset as soon as we write
290765c39a4SLuiz Angelo Daros de Luca * that bit, no ACK will come back for natural reasons.
291765c39a4SLuiz Angelo Daros de Luca */
realtek_smi_write_reg_noack(void * ctx,u32 reg,u32 val)292765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_write_reg_noack(void *ctx, u32 reg, u32 val)
293765c39a4SLuiz Angelo Daros de Luca {
294765c39a4SLuiz Angelo Daros de Luca return realtek_smi_write_reg(ctx, reg, val, false);
295765c39a4SLuiz Angelo Daros de Luca }
296765c39a4SLuiz Angelo Daros de Luca
297765c39a4SLuiz Angelo Daros de Luca /* Regmap accessors */
298765c39a4SLuiz Angelo Daros de Luca
realtek_smi_write(void * ctx,u32 reg,u32 val)299765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_write(void *ctx, u32 reg, u32 val)
300765c39a4SLuiz Angelo Daros de Luca {
301765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = ctx;
302765c39a4SLuiz Angelo Daros de Luca
303765c39a4SLuiz Angelo Daros de Luca return realtek_smi_write_reg(priv, reg, val, true);
304765c39a4SLuiz Angelo Daros de Luca }
305765c39a4SLuiz Angelo Daros de Luca
realtek_smi_read(void * ctx,u32 reg,u32 * val)306765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_read(void *ctx, u32 reg, u32 *val)
307765c39a4SLuiz Angelo Daros de Luca {
308765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = ctx;
309765c39a4SLuiz Angelo Daros de Luca
310765c39a4SLuiz Angelo Daros de Luca return realtek_smi_read_reg(priv, reg, val);
311765c39a4SLuiz Angelo Daros de Luca }
312765c39a4SLuiz Angelo Daros de Luca
realtek_smi_lock(void * ctx)313907e772fSAlvin Šipraga static void realtek_smi_lock(void *ctx)
314907e772fSAlvin Šipraga {
315907e772fSAlvin Šipraga struct realtek_priv *priv = ctx;
316907e772fSAlvin Šipraga
317907e772fSAlvin Šipraga mutex_lock(&priv->map_lock);
318907e772fSAlvin Šipraga }
319907e772fSAlvin Šipraga
realtek_smi_unlock(void * ctx)320907e772fSAlvin Šipraga static void realtek_smi_unlock(void *ctx)
321907e772fSAlvin Šipraga {
322907e772fSAlvin Šipraga struct realtek_priv *priv = ctx;
323907e772fSAlvin Šipraga
324907e772fSAlvin Šipraga mutex_unlock(&priv->map_lock);
325907e772fSAlvin Šipraga }
326907e772fSAlvin Šipraga
327907e772fSAlvin Šipraga static const struct regmap_config realtek_smi_regmap_config = {
328765c39a4SLuiz Angelo Daros de Luca .reg_bits = 10, /* A4..A0 R4..R0 */
329765c39a4SLuiz Angelo Daros de Luca .val_bits = 16,
330765c39a4SLuiz Angelo Daros de Luca .reg_stride = 1,
331765c39a4SLuiz Angelo Daros de Luca /* PHY regs are at 0x8000 */
332765c39a4SLuiz Angelo Daros de Luca .max_register = 0xffff,
333765c39a4SLuiz Angelo Daros de Luca .reg_format_endian = REGMAP_ENDIAN_BIG,
334765c39a4SLuiz Angelo Daros de Luca .reg_read = realtek_smi_read,
335765c39a4SLuiz Angelo Daros de Luca .reg_write = realtek_smi_write,
336765c39a4SLuiz Angelo Daros de Luca .cache_type = REGCACHE_NONE,
337907e772fSAlvin Šipraga .lock = realtek_smi_lock,
338907e772fSAlvin Šipraga .unlock = realtek_smi_unlock,
339907e772fSAlvin Šipraga };
340907e772fSAlvin Šipraga
341907e772fSAlvin Šipraga static const struct regmap_config realtek_smi_nolock_regmap_config = {
342907e772fSAlvin Šipraga .reg_bits = 10, /* A4..A0 R4..R0 */
343907e772fSAlvin Šipraga .val_bits = 16,
344907e772fSAlvin Šipraga .reg_stride = 1,
345907e772fSAlvin Šipraga /* PHY regs are at 0x8000 */
346907e772fSAlvin Šipraga .max_register = 0xffff,
347907e772fSAlvin Šipraga .reg_format_endian = REGMAP_ENDIAN_BIG,
348907e772fSAlvin Šipraga .reg_read = realtek_smi_read,
349907e772fSAlvin Šipraga .reg_write = realtek_smi_write,
350907e772fSAlvin Šipraga .cache_type = REGCACHE_NONE,
351907e772fSAlvin Šipraga .disable_locking = true,
352765c39a4SLuiz Angelo Daros de Luca };
353765c39a4SLuiz Angelo Daros de Luca
realtek_smi_mdio_read(struct mii_bus * bus,int addr,int regnum)354765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_mdio_read(struct mii_bus *bus, int addr, int regnum)
355765c39a4SLuiz Angelo Daros de Luca {
356765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = bus->priv;
357765c39a4SLuiz Angelo Daros de Luca
358765c39a4SLuiz Angelo Daros de Luca return priv->ops->phy_read(priv, addr, regnum);
359765c39a4SLuiz Angelo Daros de Luca }
360765c39a4SLuiz Angelo Daros de Luca
realtek_smi_mdio_write(struct mii_bus * bus,int addr,int regnum,u16 val)361765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_mdio_write(struct mii_bus *bus, int addr, int regnum,
362765c39a4SLuiz Angelo Daros de Luca u16 val)
363765c39a4SLuiz Angelo Daros de Luca {
364765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = bus->priv;
365765c39a4SLuiz Angelo Daros de Luca
366765c39a4SLuiz Angelo Daros de Luca return priv->ops->phy_write(priv, addr, regnum, val);
367765c39a4SLuiz Angelo Daros de Luca }
368765c39a4SLuiz Angelo Daros de Luca
realtek_smi_setup_mdio(struct dsa_switch * ds)369765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_setup_mdio(struct dsa_switch *ds)
370765c39a4SLuiz Angelo Daros de Luca {
371765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = ds->priv;
372765c39a4SLuiz Angelo Daros de Luca struct device_node *mdio_np;
373765c39a4SLuiz Angelo Daros de Luca int ret;
374765c39a4SLuiz Angelo Daros de Luca
375765c39a4SLuiz Angelo Daros de Luca mdio_np = of_get_compatible_child(priv->dev->of_node, "realtek,smi-mdio");
376765c39a4SLuiz Angelo Daros de Luca if (!mdio_np) {
377765c39a4SLuiz Angelo Daros de Luca dev_err(priv->dev, "no MDIO bus node\n");
378765c39a4SLuiz Angelo Daros de Luca return -ENODEV;
379765c39a4SLuiz Angelo Daros de Luca }
380765c39a4SLuiz Angelo Daros de Luca
381765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus = devm_mdiobus_alloc(priv->dev);
382765c39a4SLuiz Angelo Daros de Luca if (!priv->slave_mii_bus) {
383765c39a4SLuiz Angelo Daros de Luca ret = -ENOMEM;
384765c39a4SLuiz Angelo Daros de Luca goto err_put_node;
385765c39a4SLuiz Angelo Daros de Luca }
386765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->priv = priv;
387765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->name = "SMI slave MII";
388765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->read = realtek_smi_mdio_read;
389765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->write = realtek_smi_mdio_write;
390765c39a4SLuiz Angelo Daros de Luca snprintf(priv->slave_mii_bus->id, MII_BUS_ID_SIZE, "SMI-%d",
391765c39a4SLuiz Angelo Daros de Luca ds->index);
392765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->dev.of_node = mdio_np;
393765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->parent = priv->dev;
394765c39a4SLuiz Angelo Daros de Luca ds->slave_mii_bus = priv->slave_mii_bus;
395765c39a4SLuiz Angelo Daros de Luca
396765c39a4SLuiz Angelo Daros de Luca ret = devm_of_mdiobus_register(priv->dev, priv->slave_mii_bus, mdio_np);
397765c39a4SLuiz Angelo Daros de Luca if (ret) {
398765c39a4SLuiz Angelo Daros de Luca dev_err(priv->dev, "unable to register MDIO bus %s\n",
399765c39a4SLuiz Angelo Daros de Luca priv->slave_mii_bus->id);
400765c39a4SLuiz Angelo Daros de Luca goto err_put_node;
401765c39a4SLuiz Angelo Daros de Luca }
402765c39a4SLuiz Angelo Daros de Luca
403765c39a4SLuiz Angelo Daros de Luca return 0;
404765c39a4SLuiz Angelo Daros de Luca
405765c39a4SLuiz Angelo Daros de Luca err_put_node:
406765c39a4SLuiz Angelo Daros de Luca of_node_put(mdio_np);
407765c39a4SLuiz Angelo Daros de Luca
408765c39a4SLuiz Angelo Daros de Luca return ret;
409765c39a4SLuiz Angelo Daros de Luca }
410765c39a4SLuiz Angelo Daros de Luca
realtek_smi_probe(struct platform_device * pdev)411765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_probe(struct platform_device *pdev)
412765c39a4SLuiz Angelo Daros de Luca {
413765c39a4SLuiz Angelo Daros de Luca const struct realtek_variant *var;
414765c39a4SLuiz Angelo Daros de Luca struct device *dev = &pdev->dev;
415765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv;
416907e772fSAlvin Šipraga struct regmap_config rc;
417765c39a4SLuiz Angelo Daros de Luca struct device_node *np;
418765c39a4SLuiz Angelo Daros de Luca int ret;
419765c39a4SLuiz Angelo Daros de Luca
420765c39a4SLuiz Angelo Daros de Luca var = of_device_get_match_data(dev);
421765c39a4SLuiz Angelo Daros de Luca np = dev->of_node;
422765c39a4SLuiz Angelo Daros de Luca
423765c39a4SLuiz Angelo Daros de Luca priv = devm_kzalloc(dev, sizeof(*priv) + var->chip_data_sz, GFP_KERNEL);
424765c39a4SLuiz Angelo Daros de Luca if (!priv)
425765c39a4SLuiz Angelo Daros de Luca return -ENOMEM;
426765c39a4SLuiz Angelo Daros de Luca priv->chip_data = (void *)priv + sizeof(*priv);
427907e772fSAlvin Šipraga
428907e772fSAlvin Šipraga mutex_init(&priv->map_lock);
429907e772fSAlvin Šipraga
430907e772fSAlvin Šipraga rc = realtek_smi_regmap_config;
431907e772fSAlvin Šipraga rc.lock_arg = priv;
432907e772fSAlvin Šipraga priv->map = devm_regmap_init(dev, NULL, priv, &rc);
433765c39a4SLuiz Angelo Daros de Luca if (IS_ERR(priv->map)) {
434765c39a4SLuiz Angelo Daros de Luca ret = PTR_ERR(priv->map);
435765c39a4SLuiz Angelo Daros de Luca dev_err(dev, "regmap init failed: %d\n", ret);
436765c39a4SLuiz Angelo Daros de Luca return ret;
437765c39a4SLuiz Angelo Daros de Luca }
438765c39a4SLuiz Angelo Daros de Luca
439907e772fSAlvin Šipraga rc = realtek_smi_nolock_regmap_config;
440907e772fSAlvin Šipraga priv->map_nolock = devm_regmap_init(dev, NULL, priv, &rc);
441907e772fSAlvin Šipraga if (IS_ERR(priv->map_nolock)) {
442907e772fSAlvin Šipraga ret = PTR_ERR(priv->map_nolock);
443907e772fSAlvin Šipraga dev_err(dev, "regmap init failed: %d\n", ret);
444907e772fSAlvin Šipraga return ret;
445907e772fSAlvin Šipraga }
446907e772fSAlvin Šipraga
447765c39a4SLuiz Angelo Daros de Luca /* Link forward and backward */
448765c39a4SLuiz Angelo Daros de Luca priv->dev = dev;
449765c39a4SLuiz Angelo Daros de Luca priv->clk_delay = var->clk_delay;
450765c39a4SLuiz Angelo Daros de Luca priv->cmd_read = var->cmd_read;
451765c39a4SLuiz Angelo Daros de Luca priv->cmd_write = var->cmd_write;
452765c39a4SLuiz Angelo Daros de Luca priv->ops = var->ops;
453765c39a4SLuiz Angelo Daros de Luca
454765c39a4SLuiz Angelo Daros de Luca priv->setup_interface = realtek_smi_setup_mdio;
455765c39a4SLuiz Angelo Daros de Luca priv->write_reg_noack = realtek_smi_write_reg_noack;
456765c39a4SLuiz Angelo Daros de Luca
457765c39a4SLuiz Angelo Daros de Luca dev_set_drvdata(dev, priv);
458765c39a4SLuiz Angelo Daros de Luca spin_lock_init(&priv->lock);
459765c39a4SLuiz Angelo Daros de Luca
460765c39a4SLuiz Angelo Daros de Luca /* TODO: if power is software controlled, set up any regulators here */
461765c39a4SLuiz Angelo Daros de Luca
4629a236b54SLuiz Angelo Daros de Luca priv->reset = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
463765c39a4SLuiz Angelo Daros de Luca if (IS_ERR(priv->reset)) {
464765c39a4SLuiz Angelo Daros de Luca dev_err(dev, "failed to get RESET GPIO\n");
465765c39a4SLuiz Angelo Daros de Luca return PTR_ERR(priv->reset);
466765c39a4SLuiz Angelo Daros de Luca }
4679a236b54SLuiz Angelo Daros de Luca if (priv->reset) {
4689a236b54SLuiz Angelo Daros de Luca gpiod_set_value(priv->reset, 1);
4699a236b54SLuiz Angelo Daros de Luca dev_dbg(dev, "asserted RESET\n");
47005f7b042SLuiz Angelo Daros de Luca msleep(REALTEK_HW_STOP_DELAY);
471765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->reset, 0);
47205f7b042SLuiz Angelo Daros de Luca msleep(REALTEK_HW_START_DELAY);
4739a236b54SLuiz Angelo Daros de Luca dev_dbg(dev, "deasserted RESET\n");
4749a236b54SLuiz Angelo Daros de Luca }
475765c39a4SLuiz Angelo Daros de Luca
476765c39a4SLuiz Angelo Daros de Luca /* Fetch MDIO pins */
477765c39a4SLuiz Angelo Daros de Luca priv->mdc = devm_gpiod_get_optional(dev, "mdc", GPIOD_OUT_LOW);
478765c39a4SLuiz Angelo Daros de Luca if (IS_ERR(priv->mdc))
479765c39a4SLuiz Angelo Daros de Luca return PTR_ERR(priv->mdc);
480765c39a4SLuiz Angelo Daros de Luca priv->mdio = devm_gpiod_get_optional(dev, "mdio", GPIOD_OUT_LOW);
481765c39a4SLuiz Angelo Daros de Luca if (IS_ERR(priv->mdio))
482765c39a4SLuiz Angelo Daros de Luca return PTR_ERR(priv->mdio);
483765c39a4SLuiz Angelo Daros de Luca
484765c39a4SLuiz Angelo Daros de Luca priv->leds_disabled = of_property_read_bool(np, "realtek,disable-leds");
485765c39a4SLuiz Angelo Daros de Luca
486765c39a4SLuiz Angelo Daros de Luca ret = priv->ops->detect(priv);
487765c39a4SLuiz Angelo Daros de Luca if (ret) {
488765c39a4SLuiz Angelo Daros de Luca dev_err(dev, "unable to detect switch\n");
489765c39a4SLuiz Angelo Daros de Luca return ret;
490765c39a4SLuiz Angelo Daros de Luca }
491765c39a4SLuiz Angelo Daros de Luca
492765c39a4SLuiz Angelo Daros de Luca priv->ds = devm_kzalloc(dev, sizeof(*priv->ds), GFP_KERNEL);
493765c39a4SLuiz Angelo Daros de Luca if (!priv->ds)
494765c39a4SLuiz Angelo Daros de Luca return -ENOMEM;
495765c39a4SLuiz Angelo Daros de Luca
496765c39a4SLuiz Angelo Daros de Luca priv->ds->dev = dev;
497765c39a4SLuiz Angelo Daros de Luca priv->ds->num_ports = priv->num_ports;
498765c39a4SLuiz Angelo Daros de Luca priv->ds->priv = priv;
499765c39a4SLuiz Angelo Daros de Luca
500aac94001SLuiz Angelo Daros de Luca priv->ds->ops = var->ds_ops_smi;
501765c39a4SLuiz Angelo Daros de Luca ret = dsa_register_switch(priv->ds);
502765c39a4SLuiz Angelo Daros de Luca if (ret) {
503765c39a4SLuiz Angelo Daros de Luca dev_err_probe(dev, ret, "unable to register switch\n");
504765c39a4SLuiz Angelo Daros de Luca return ret;
505765c39a4SLuiz Angelo Daros de Luca }
506765c39a4SLuiz Angelo Daros de Luca return 0;
507765c39a4SLuiz Angelo Daros de Luca }
508765c39a4SLuiz Angelo Daros de Luca
realtek_smi_remove(struct platform_device * pdev)509765c39a4SLuiz Angelo Daros de Luca static int realtek_smi_remove(struct platform_device *pdev)
510765c39a4SLuiz Angelo Daros de Luca {
511765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = platform_get_drvdata(pdev);
512765c39a4SLuiz Angelo Daros de Luca
513765c39a4SLuiz Angelo Daros de Luca if (!priv)
514765c39a4SLuiz Angelo Daros de Luca return 0;
515765c39a4SLuiz Angelo Daros de Luca
516765c39a4SLuiz Angelo Daros de Luca dsa_unregister_switch(priv->ds);
517765c39a4SLuiz Angelo Daros de Luca if (priv->slave_mii_bus)
518765c39a4SLuiz Angelo Daros de Luca of_node_put(priv->slave_mii_bus->dev.of_node);
5199a236b54SLuiz Angelo Daros de Luca
5209a236b54SLuiz Angelo Daros de Luca /* leave the device reset asserted */
5219a236b54SLuiz Angelo Daros de Luca if (priv->reset)
522765c39a4SLuiz Angelo Daros de Luca gpiod_set_value(priv->reset, 1);
523765c39a4SLuiz Angelo Daros de Luca
524765c39a4SLuiz Angelo Daros de Luca return 0;
525765c39a4SLuiz Angelo Daros de Luca }
526765c39a4SLuiz Angelo Daros de Luca
realtek_smi_shutdown(struct platform_device * pdev)527765c39a4SLuiz Angelo Daros de Luca static void realtek_smi_shutdown(struct platform_device *pdev)
528765c39a4SLuiz Angelo Daros de Luca {
529765c39a4SLuiz Angelo Daros de Luca struct realtek_priv *priv = platform_get_drvdata(pdev);
530765c39a4SLuiz Angelo Daros de Luca
531765c39a4SLuiz Angelo Daros de Luca if (!priv)
532765c39a4SLuiz Angelo Daros de Luca return;
533765c39a4SLuiz Angelo Daros de Luca
534765c39a4SLuiz Angelo Daros de Luca dsa_switch_shutdown(priv->ds);
535765c39a4SLuiz Angelo Daros de Luca
536765c39a4SLuiz Angelo Daros de Luca platform_set_drvdata(pdev, NULL);
537765c39a4SLuiz Angelo Daros de Luca }
538765c39a4SLuiz Angelo Daros de Luca
539765c39a4SLuiz Angelo Daros de Luca static const struct of_device_id realtek_smi_of_match[] = {
540765c39a4SLuiz Angelo Daros de Luca #if IS_ENABLED(CONFIG_NET_DSA_REALTEK_RTL8366RB)
541765c39a4SLuiz Angelo Daros de Luca {
542765c39a4SLuiz Angelo Daros de Luca .compatible = "realtek,rtl8366rb",
543765c39a4SLuiz Angelo Daros de Luca .data = &rtl8366rb_variant,
544765c39a4SLuiz Angelo Daros de Luca },
545765c39a4SLuiz Angelo Daros de Luca #endif
546765c39a4SLuiz Angelo Daros de Luca #if IS_ENABLED(CONFIG_NET_DSA_REALTEK_RTL8365MB)
547765c39a4SLuiz Angelo Daros de Luca {
548765c39a4SLuiz Angelo Daros de Luca .compatible = "realtek,rtl8365mb",
549765c39a4SLuiz Angelo Daros de Luca .data = &rtl8365mb_variant,
550765c39a4SLuiz Angelo Daros de Luca },
551765c39a4SLuiz Angelo Daros de Luca #endif
552765c39a4SLuiz Angelo Daros de Luca { /* sentinel */ },
553765c39a4SLuiz Angelo Daros de Luca };
554765c39a4SLuiz Angelo Daros de Luca MODULE_DEVICE_TABLE(of, realtek_smi_of_match);
555765c39a4SLuiz Angelo Daros de Luca
556765c39a4SLuiz Angelo Daros de Luca static struct platform_driver realtek_smi_driver = {
557765c39a4SLuiz Angelo Daros de Luca .driver = {
558765c39a4SLuiz Angelo Daros de Luca .name = "realtek-smi",
559*aae249dfSRuan Jinjie .of_match_table = realtek_smi_of_match,
560765c39a4SLuiz Angelo Daros de Luca },
561765c39a4SLuiz Angelo Daros de Luca .probe = realtek_smi_probe,
562765c39a4SLuiz Angelo Daros de Luca .remove = realtek_smi_remove,
563765c39a4SLuiz Angelo Daros de Luca .shutdown = realtek_smi_shutdown,
564765c39a4SLuiz Angelo Daros de Luca };
565765c39a4SLuiz Angelo Daros de Luca module_platform_driver(realtek_smi_driver);
566765c39a4SLuiz Angelo Daros de Luca
567765c39a4SLuiz Angelo Daros de Luca MODULE_AUTHOR("Linus Walleij <linus.walleij@linaro.org>");
568765c39a4SLuiz Angelo Daros de Luca MODULE_DESCRIPTION("Driver for Realtek ethernet switch connected via SMI interface");
569765c39a4SLuiz Angelo Daros de Luca MODULE_LICENSE("GPL");
570