Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.15.
  1// SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
  2/* Copyright 2020 NXP
  3 * Lynx PCS MDIO helpers
  4 */
  5
  6#include <linux/mdio.h>
  7#include <linux/phylink.h>
  8#include <linux/pcs-lynx.h>
  9
 10#define SGMII_CLOCK_PERIOD_NS		8 /* PCS is clocked at 125 MHz */
 11#define LINK_TIMER_VAL(ns)		((u32)((ns) / SGMII_CLOCK_PERIOD_NS))
 12
 13#define SGMII_AN_LINK_TIMER_NS		1600000 /* defined by SGMII spec */
 14#define IEEE8023_LINK_TIMER_NS		10000000
 15
 16#define LINK_TIMER_LO			0x12
 17#define LINK_TIMER_HI			0x13
 18#define IF_MODE				0x14
 19#define IF_MODE_SGMII_EN		BIT(0)
 20#define IF_MODE_USE_SGMII_AN		BIT(1)
 21#define IF_MODE_SPEED(x)		(((x) << 2) & GENMASK(3, 2))
 22#define IF_MODE_SPEED_MSK		GENMASK(3, 2)
 23#define IF_MODE_HALF_DUPLEX		BIT(4)
 24
 25enum sgmii_speed {
 26	SGMII_SPEED_10		= 0,
 27	SGMII_SPEED_100		= 1,
 28	SGMII_SPEED_1000	= 2,
 29	SGMII_SPEED_2500	= 2,
 30};
 31
 32#define phylink_pcs_to_lynx(pl_pcs) container_of((pl_pcs), struct lynx_pcs, pcs)
 33
 34static void lynx_pcs_get_state_usxgmii(struct mdio_device *pcs,
 35				       struct phylink_link_state *state)
 36{
 37	struct mii_bus *bus = pcs->bus;
 38	int addr = pcs->addr;
 39	int status, lpa;
 40
 41	status = mdiobus_c45_read(bus, addr, MDIO_MMD_VEND2, MII_BMSR);
 42	if (status < 0)
 43		return;
 44
 45	state->link = !!(status & MDIO_STAT1_LSTATUS);
 46	state->an_complete = !!(status & MDIO_AN_STAT1_COMPLETE);
 47	if (!state->link || !state->an_complete)
 48		return;
 49
 50	lpa = mdiobus_c45_read(bus, addr, MDIO_MMD_VEND2, MII_LPA);
 51	if (lpa < 0)
 52		return;
 53
 54	phylink_decode_usxgmii_word(state, lpa);
 55}
 56
 57static void lynx_pcs_get_state_2500basex(struct mdio_device *pcs,
 58					 struct phylink_link_state *state)
 59{
 60	struct mii_bus *bus = pcs->bus;
 61	int addr = pcs->addr;
 62	int bmsr, lpa;
 63
 64	bmsr = mdiobus_read(bus, addr, MII_BMSR);
 65	lpa = mdiobus_read(bus, addr, MII_LPA);
 66	if (bmsr < 0 || lpa < 0) {
 67		state->link = false;
 68		return;
 69	}
 70
 71	state->link = !!(bmsr & BMSR_LSTATUS);
 72	state->an_complete = !!(bmsr & BMSR_ANEGCOMPLETE);
 73	if (!state->link)
 74		return;
 75
 76	state->speed = SPEED_2500;
 77	state->pause |= MLO_PAUSE_TX | MLO_PAUSE_RX;
 78	state->duplex = DUPLEX_FULL;
 79}
 80
 81static void lynx_pcs_get_state(struct phylink_pcs *pcs,
 82			       struct phylink_link_state *state)
 83{
 84	struct lynx_pcs *lynx = phylink_pcs_to_lynx(pcs);
 85
 86	switch (state->interface) {
 87	case PHY_INTERFACE_MODE_1000BASEX:
 88	case PHY_INTERFACE_MODE_SGMII:
 89	case PHY_INTERFACE_MODE_QSGMII:
 90		phylink_mii_c22_pcs_get_state(lynx->mdio, state);
 91		break;
 92	case PHY_INTERFACE_MODE_2500BASEX:
 93		lynx_pcs_get_state_2500basex(lynx->mdio, state);
 94		break;
 95	case PHY_INTERFACE_MODE_USXGMII:
 96		lynx_pcs_get_state_usxgmii(lynx->mdio, state);
 97		break;
 98	case PHY_INTERFACE_MODE_10GBASER:
 99		phylink_mii_c45_pcs_get_state(lynx->mdio, state);
100		break;
101	default:
102		break;
103	}
104
105	dev_dbg(&lynx->mdio->dev,
106		"mode=%s/%s/%s link=%u an_enabled=%u an_complete=%u\n",
107		phy_modes(state->interface),
108		phy_speed_to_str(state->speed),
109		phy_duplex_to_str(state->duplex),
110		state->link, state->an_enabled, state->an_complete);
111}
112
113static int lynx_pcs_config_1000basex(struct mdio_device *pcs,
114				     unsigned int mode,
115				     const unsigned long *advertising)
116{
117	struct mii_bus *bus = pcs->bus;
118	int addr = pcs->addr;
119	u32 link_timer;
120	int err;
121
122	link_timer = LINK_TIMER_VAL(IEEE8023_LINK_TIMER_NS);
123	mdiobus_write(bus, addr, LINK_TIMER_LO, link_timer & 0xffff);
124	mdiobus_write(bus, addr, LINK_TIMER_HI, link_timer >> 16);
125
126	err = mdiobus_modify(bus, addr, IF_MODE,
127			     IF_MODE_SGMII_EN | IF_MODE_USE_SGMII_AN,
128			     0);
129	if (err)
130		return err;
131
132	return phylink_mii_c22_pcs_config(pcs, mode,
133					  PHY_INTERFACE_MODE_1000BASEX,
134					  advertising);
135}
136
137static int lynx_pcs_config_sgmii(struct mdio_device *pcs, unsigned int mode,
138				 const unsigned long *advertising)
139{
140	struct mii_bus *bus = pcs->bus;
141	int addr = pcs->addr;
142	u16 if_mode;
143	int err;
144
145	if_mode = IF_MODE_SGMII_EN;
146	if (mode == MLO_AN_INBAND) {
147		u32 link_timer;
148
149		if_mode |= IF_MODE_USE_SGMII_AN;
150
151		/* Adjust link timer for SGMII */
152		link_timer = LINK_TIMER_VAL(SGMII_AN_LINK_TIMER_NS);
153		mdiobus_write(bus, addr, LINK_TIMER_LO, link_timer & 0xffff);
154		mdiobus_write(bus, addr, LINK_TIMER_HI, link_timer >> 16);
155	}
156	err = mdiobus_modify(bus, addr, IF_MODE,
157			     IF_MODE_SGMII_EN | IF_MODE_USE_SGMII_AN,
158			     if_mode);
159	if (err)
160		return err;
161
162	return phylink_mii_c22_pcs_config(pcs, mode, PHY_INTERFACE_MODE_SGMII,
163					 advertising);
164}
165
166static int lynx_pcs_config_usxgmii(struct mdio_device *pcs, unsigned int mode,
167				   const unsigned long *advertising)
168{
169	struct mii_bus *bus = pcs->bus;
170	int addr = pcs->addr;
171
172	if (!phylink_autoneg_inband(mode)) {
173		dev_err(&pcs->dev, "USXGMII only supports in-band AN for now\n");
174		return -EOPNOTSUPP;
175	}
176
177	/* Configure device ability for the USXGMII Replicator */
178	return mdiobus_c45_write(bus, addr, MDIO_MMD_VEND2, MII_ADVERTISE,
179				 MDIO_USXGMII_10G | MDIO_USXGMII_LINK |
180				 MDIO_USXGMII_FULL_DUPLEX |
181				 ADVERTISE_SGMII | ADVERTISE_LPACK);
182}
183
184static int lynx_pcs_config(struct phylink_pcs *pcs, unsigned int mode,
185			   phy_interface_t ifmode,
186			   const unsigned long *advertising,
187			   bool permit)
188{
189	struct lynx_pcs *lynx = phylink_pcs_to_lynx(pcs);
190
191	switch (ifmode) {
192	case PHY_INTERFACE_MODE_1000BASEX:
193		return lynx_pcs_config_1000basex(lynx->mdio, mode, advertising);
194	case PHY_INTERFACE_MODE_SGMII:
195	case PHY_INTERFACE_MODE_QSGMII:
196		return lynx_pcs_config_sgmii(lynx->mdio, mode, advertising);
197	case PHY_INTERFACE_MODE_2500BASEX:
198		if (phylink_autoneg_inband(mode)) {
199			dev_err(&lynx->mdio->dev,
200				"AN not supported on 3.125GHz SerDes lane\n");
201			return -EOPNOTSUPP;
202		}
203		break;
204	case PHY_INTERFACE_MODE_USXGMII:
205		return lynx_pcs_config_usxgmii(lynx->mdio, mode, advertising);
206	case PHY_INTERFACE_MODE_10GBASER:
207		/* Nothing to do here for 10GBASER */
208		break;
209	default:
210		return -EOPNOTSUPP;
211	}
212
213	return 0;
214}
215
216static void lynx_pcs_an_restart(struct phylink_pcs *pcs)
217{
218	struct lynx_pcs *lynx = phylink_pcs_to_lynx(pcs);
219
220	phylink_mii_c22_pcs_an_restart(lynx->mdio);
221}
222
223static void lynx_pcs_link_up_sgmii(struct mdio_device *pcs, unsigned int mode,
224				   int speed, int duplex)
225{
226	struct mii_bus *bus = pcs->bus;
227	u16 if_mode = 0, sgmii_speed;
228	int addr = pcs->addr;
229
230	/* The PCS needs to be configured manually only
231	 * when not operating on in-band mode
232	 */
233	if (mode == MLO_AN_INBAND)
234		return;
235
236	if (duplex == DUPLEX_HALF)
237		if_mode |= IF_MODE_HALF_DUPLEX;
238
239	switch (speed) {
240	case SPEED_1000:
241		sgmii_speed = SGMII_SPEED_1000;
242		break;
243	case SPEED_100:
244		sgmii_speed = SGMII_SPEED_100;
245		break;
246	case SPEED_10:
247		sgmii_speed = SGMII_SPEED_10;
248		break;
249	case SPEED_UNKNOWN:
250		/* Silently don't do anything */
251		return;
252	default:
253		dev_err(&pcs->dev, "Invalid PCS speed %d\n", speed);
254		return;
255	}
256	if_mode |= IF_MODE_SPEED(sgmii_speed);
257
258	mdiobus_modify(bus, addr, IF_MODE,
259		       IF_MODE_HALF_DUPLEX | IF_MODE_SPEED_MSK,
260		       if_mode);
261}
262
263/* 2500Base-X is SerDes protocol 7 on Felix and 6 on ENETC. It is a SerDes lane
264 * clocked at 3.125 GHz which encodes symbols with 8b/10b and does not have
265 * auto-negotiation of any link parameters. Electrically it is compatible with
266 * a single lane of XAUI.
267 * The hardware reference manual wants to call this mode SGMII, but it isn't
268 * really, since the fundamental features of SGMII:
269 * - Downgrading the link speed by duplicating symbols
270 * - Auto-negotiation
271 * are not there.
272 * The speed is configured at 1000 in the IF_MODE because the clock frequency
273 * is actually given by a PLL configured in the Reset Configuration Word (RCW).
274 * Since there is no difference between fixed speed SGMII w/o AN and 802.3z w/o
275 * AN, we call this PHY interface type 2500Base-X. In case a PHY negotiates a
276 * lower link speed on line side, the system-side interface remains fixed at
277 * 2500 Mbps and we do rate adaptation through pause frames.
278 */
279static void lynx_pcs_link_up_2500basex(struct mdio_device *pcs,
280				       unsigned int mode,
281				       int speed, int duplex)
282{
283	struct mii_bus *bus = pcs->bus;
284	int addr = pcs->addr;
285	u16 if_mode = 0;
286
287	if (mode == MLO_AN_INBAND) {
288		dev_err(&pcs->dev, "AN not supported for 2500BaseX\n");
289		return;
290	}
291
292	if (duplex == DUPLEX_HALF)
293		if_mode |= IF_MODE_HALF_DUPLEX;
294	if_mode |= IF_MODE_SPEED(SGMII_SPEED_2500);
295
296	mdiobus_modify(bus, addr, IF_MODE,
297		       IF_MODE_HALF_DUPLEX | IF_MODE_SPEED_MSK,
298		       if_mode);
299}
300
301static void lynx_pcs_link_up(struct phylink_pcs *pcs, unsigned int mode,
302			     phy_interface_t interface,
303			     int speed, int duplex)
304{
305	struct lynx_pcs *lynx = phylink_pcs_to_lynx(pcs);
306
307	switch (interface) {
308	case PHY_INTERFACE_MODE_SGMII:
309	case PHY_INTERFACE_MODE_QSGMII:
310		lynx_pcs_link_up_sgmii(lynx->mdio, mode, speed, duplex);
311		break;
312	case PHY_INTERFACE_MODE_2500BASEX:
313		lynx_pcs_link_up_2500basex(lynx->mdio, mode, speed, duplex);
314		break;
315	case PHY_INTERFACE_MODE_USXGMII:
316		/* At the moment, only in-band AN is supported for USXGMII
317		 * so nothing to do in link_up
318		 */
319		break;
320	default:
321		break;
322	}
323}
324
325static const struct phylink_pcs_ops lynx_pcs_phylink_ops = {
326	.pcs_get_state = lynx_pcs_get_state,
327	.pcs_config = lynx_pcs_config,
328	.pcs_an_restart = lynx_pcs_an_restart,
329	.pcs_link_up = lynx_pcs_link_up,
330};
331
332struct lynx_pcs *lynx_pcs_create(struct mdio_device *mdio)
333{
334	struct lynx_pcs *lynx_pcs;
335
336	lynx_pcs = kzalloc(sizeof(*lynx_pcs), GFP_KERNEL);
337	if (!lynx_pcs)
338		return NULL;
339
340	lynx_pcs->mdio = mdio;
341	lynx_pcs->pcs.ops = &lynx_pcs_phylink_ops;
342	lynx_pcs->pcs.poll = true;
343
344	return lynx_pcs;
345}
346EXPORT_SYMBOL(lynx_pcs_create);
347
348void lynx_pcs_destroy(struct lynx_pcs *pcs)
349{
350	kfree(pcs);
351}
352EXPORT_SYMBOL(lynx_pcs_destroy);
353
354MODULE_LICENSE("Dual BSD/GPL");