Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
  1/*
  2 * Copyright (C) 2015-2017 Broadcom
  3 *
  4 * This program is free software; you can redistribute it and/or
  5 * modify it under the terms of the GNU General Public License as
  6 * published by the Free Software Foundation version 2.
  7 *
  8 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
  9 * kind, whether express or implied; without even the implied warranty
 10 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 11 * GNU General Public License for more details.
 12 */
 13
 14#include "bcm-phy-lib.h"
 15#include <linux/brcmphy.h>
 16#include <linux/export.h>
 17#include <linux/mdio.h>
 18#include <linux/module.h>
 19#include <linux/phy.h>
 20#include <linux/ethtool.h>
 21
 22#define MII_BCM_CHANNEL_WIDTH     0x2000
 23#define BCM_CL45VEN_EEE_ADV       0x3c
 24
 25int bcm_phy_write_exp(struct phy_device *phydev, u16 reg, u16 val)
 26{
 27	int rc;
 28
 29	rc = phy_write(phydev, MII_BCM54XX_EXP_SEL, reg);
 30	if (rc < 0)
 31		return rc;
 32
 33	return phy_write(phydev, MII_BCM54XX_EXP_DATA, val);
 34}
 35EXPORT_SYMBOL_GPL(bcm_phy_write_exp);
 36
 37int bcm_phy_read_exp(struct phy_device *phydev, u16 reg)
 38{
 39	int val;
 40
 41	val = phy_write(phydev, MII_BCM54XX_EXP_SEL, reg);
 42	if (val < 0)
 43		return val;
 44
 45	val = phy_read(phydev, MII_BCM54XX_EXP_DATA);
 46
 47	/* Restore default value.  It's O.K. if this write fails. */
 48	phy_write(phydev, MII_BCM54XX_EXP_SEL, 0);
 49
 50	return val;
 51}
 52EXPORT_SYMBOL_GPL(bcm_phy_read_exp);
 53
 54int bcm54xx_auxctl_read(struct phy_device *phydev, u16 regnum)
 55{
 56	/* The register must be written to both the Shadow Register Select and
 57	 * the Shadow Read Register Selector
 58	 */
 59	phy_write(phydev, MII_BCM54XX_AUX_CTL, MII_BCM54XX_AUXCTL_SHDWSEL_MASK |
 60		  regnum << MII_BCM54XX_AUXCTL_SHDWSEL_READ_SHIFT);
 61	return phy_read(phydev, MII_BCM54XX_AUX_CTL);
 62}
 63EXPORT_SYMBOL_GPL(bcm54xx_auxctl_read);
 64
 65int bcm54xx_auxctl_write(struct phy_device *phydev, u16 regnum, u16 val)
 66{
 67	return phy_write(phydev, MII_BCM54XX_AUX_CTL, regnum | val);
 68}
 69EXPORT_SYMBOL(bcm54xx_auxctl_write);
 70
 71int bcm_phy_write_misc(struct phy_device *phydev,
 72		       u16 reg, u16 chl, u16 val)
 73{
 74	int rc;
 75	int tmp;
 76
 77	rc = phy_write(phydev, MII_BCM54XX_AUX_CTL,
 78		       MII_BCM54XX_AUXCTL_SHDWSEL_MISC);
 79	if (rc < 0)
 80		return rc;
 81
 82	tmp = phy_read(phydev, MII_BCM54XX_AUX_CTL);
 83	tmp |= MII_BCM54XX_AUXCTL_ACTL_SMDSP_ENA;
 84	rc = phy_write(phydev, MII_BCM54XX_AUX_CTL, tmp);
 85	if (rc < 0)
 86		return rc;
 87
 88	tmp = (chl * MII_BCM_CHANNEL_WIDTH) | reg;
 89	rc = bcm_phy_write_exp(phydev, tmp, val);
 90
 91	return rc;
 92}
 93EXPORT_SYMBOL_GPL(bcm_phy_write_misc);
 94
 95int bcm_phy_read_misc(struct phy_device *phydev,
 96		      u16 reg, u16 chl)
 97{
 98	int rc;
 99	int tmp;
100
101	rc = phy_write(phydev, MII_BCM54XX_AUX_CTL,
102		       MII_BCM54XX_AUXCTL_SHDWSEL_MISC);
103	if (rc < 0)
104		return rc;
105
106	tmp = phy_read(phydev, MII_BCM54XX_AUX_CTL);
107	tmp |= MII_BCM54XX_AUXCTL_ACTL_SMDSP_ENA;
108	rc = phy_write(phydev, MII_BCM54XX_AUX_CTL, tmp);
109	if (rc < 0)
110		return rc;
111
112	tmp = (chl * MII_BCM_CHANNEL_WIDTH) | reg;
113	rc = bcm_phy_read_exp(phydev, tmp);
114
115	return rc;
116}
117EXPORT_SYMBOL_GPL(bcm_phy_read_misc);
118
119int bcm_phy_ack_intr(struct phy_device *phydev)
120{
121	int reg;
122
123	/* Clear pending interrupts.  */
124	reg = phy_read(phydev, MII_BCM54XX_ISR);
125	if (reg < 0)
126		return reg;
127
128	return 0;
129}
130EXPORT_SYMBOL_GPL(bcm_phy_ack_intr);
131
132int bcm_phy_config_intr(struct phy_device *phydev)
133{
134	int reg;
135
136	reg = phy_read(phydev, MII_BCM54XX_ECR);
137	if (reg < 0)
138		return reg;
139
140	if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
141		reg &= ~MII_BCM54XX_ECR_IM;
142	else
143		reg |= MII_BCM54XX_ECR_IM;
144
145	return phy_write(phydev, MII_BCM54XX_ECR, reg);
146}
147EXPORT_SYMBOL_GPL(bcm_phy_config_intr);
148
149int bcm_phy_read_shadow(struct phy_device *phydev, u16 shadow)
150{
151	phy_write(phydev, MII_BCM54XX_SHD, MII_BCM54XX_SHD_VAL(shadow));
152	return MII_BCM54XX_SHD_DATA(phy_read(phydev, MII_BCM54XX_SHD));
153}
154EXPORT_SYMBOL_GPL(bcm_phy_read_shadow);
155
156int bcm_phy_write_shadow(struct phy_device *phydev, u16 shadow,
157			 u16 val)
158{
159	return phy_write(phydev, MII_BCM54XX_SHD,
160			 MII_BCM54XX_SHD_WRITE |
161			 MII_BCM54XX_SHD_VAL(shadow) |
162			 MII_BCM54XX_SHD_DATA(val));
163}
164EXPORT_SYMBOL_GPL(bcm_phy_write_shadow);
165
166int bcm_phy_enable_apd(struct phy_device *phydev, bool dll_pwr_down)
167{
168	int val;
169
170	if (dll_pwr_down) {
171		val = bcm_phy_read_shadow(phydev, BCM54XX_SHD_SCR3);
172		if (val < 0)
173			return val;
174
175		val |= BCM54XX_SHD_SCR3_DLLAPD_DIS;
176		bcm_phy_write_shadow(phydev, BCM54XX_SHD_SCR3, val);
177	}
178
179	val = bcm_phy_read_shadow(phydev, BCM54XX_SHD_APD);
180	if (val < 0)
181		return val;
182
183	/* Clear APD bits */
184	val &= BCM_APD_CLR_MASK;
185
186	if (phydev->autoneg == AUTONEG_ENABLE)
187		val |= BCM54XX_SHD_APD_EN;
188	else
189		val |= BCM_NO_ANEG_APD_EN;
190
191	/* Enable energy detect single link pulse for easy wakeup */
192	val |= BCM_APD_SINGLELP_EN;
193
194	/* Enable Auto Power-Down (APD) for the PHY */
195	return bcm_phy_write_shadow(phydev, BCM54XX_SHD_APD, val);
196}
197EXPORT_SYMBOL_GPL(bcm_phy_enable_apd);
198
199int bcm_phy_set_eee(struct phy_device *phydev, bool enable)
200{
201	int val;
202
203	/* Enable EEE at PHY level */
204	val = phy_read_mmd(phydev, MDIO_MMD_AN, BRCM_CL45VEN_EEE_CONTROL);
205	if (val < 0)
206		return val;
207
208	if (enable)
209		val |= LPI_FEATURE_EN | LPI_FEATURE_EN_DIG1000X;
210	else
211		val &= ~(LPI_FEATURE_EN | LPI_FEATURE_EN_DIG1000X);
212
213	phy_write_mmd(phydev, MDIO_MMD_AN, BRCM_CL45VEN_EEE_CONTROL, (u32)val);
214
215	/* Advertise EEE */
216	val = phy_read_mmd(phydev, MDIO_MMD_AN, BCM_CL45VEN_EEE_ADV);
217	if (val < 0)
218		return val;
219
220	if (enable)
221		val |= (MDIO_EEE_100TX | MDIO_EEE_1000T);
222	else
223		val &= ~(MDIO_EEE_100TX | MDIO_EEE_1000T);
224
225	phy_write_mmd(phydev, MDIO_MMD_AN, BCM_CL45VEN_EEE_ADV, (u32)val);
226
227	return 0;
228}
229EXPORT_SYMBOL_GPL(bcm_phy_set_eee);
230
231int bcm_phy_downshift_get(struct phy_device *phydev, u8 *count)
232{
233	int val;
234
235	val = bcm54xx_auxctl_read(phydev, MII_BCM54XX_AUXCTL_SHDWSEL_MISC);
236	if (val < 0)
237		return val;
238
239	/* Check if wirespeed is enabled or not */
240	if (!(val & MII_BCM54XX_AUXCTL_SHDWSEL_MISC_WIRESPEED_EN)) {
241		*count = DOWNSHIFT_DEV_DISABLE;
242		return 0;
243	}
244
245	val = bcm_phy_read_shadow(phydev, BCM54XX_SHD_SCR2);
246	if (val < 0)
247		return val;
248
249	/* Downgrade after one link attempt */
250	if (val & BCM54XX_SHD_SCR2_WSPD_RTRY_DIS) {
251		*count = 1;
252	} else {
253		/* Downgrade after configured retry count */
254		val >>= BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_SHIFT;
255		val &= BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_MASK;
256		*count = val + BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_OFFSET;
257	}
258
259	return 0;
260}
261EXPORT_SYMBOL_GPL(bcm_phy_downshift_get);
262
263int bcm_phy_downshift_set(struct phy_device *phydev, u8 count)
264{
265	int val = 0, ret = 0;
266
267	/* Range check the number given */
268	if (count - BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_OFFSET >
269	    BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_MASK &&
270	    count != DOWNSHIFT_DEV_DEFAULT_COUNT) {
271		return -ERANGE;
272	}
273
274	val = bcm54xx_auxctl_read(phydev, MII_BCM54XX_AUXCTL_SHDWSEL_MISC);
275	if (val < 0)
276		return val;
277
278	/* Se the write enable bit */
279	val |= MII_BCM54XX_AUXCTL_MISC_WREN;
280
281	if (count == DOWNSHIFT_DEV_DISABLE) {
282		val &= ~MII_BCM54XX_AUXCTL_SHDWSEL_MISC_WIRESPEED_EN;
283		return bcm54xx_auxctl_write(phydev,
284					    MII_BCM54XX_AUXCTL_SHDWSEL_MISC,
285					    val);
286	} else {
287		val |= MII_BCM54XX_AUXCTL_SHDWSEL_MISC_WIRESPEED_EN;
288		ret = bcm54xx_auxctl_write(phydev,
289					   MII_BCM54XX_AUXCTL_SHDWSEL_MISC,
290					   val);
291		if (ret < 0)
292			return ret;
293	}
294
295	val = bcm_phy_read_shadow(phydev, BCM54XX_SHD_SCR2);
296	val &= ~(BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_MASK <<
297		 BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_SHIFT |
298		 BCM54XX_SHD_SCR2_WSPD_RTRY_DIS);
299
300	switch (count) {
301	case 1:
302		val |= BCM54XX_SHD_SCR2_WSPD_RTRY_DIS;
303		break;
304	case DOWNSHIFT_DEV_DEFAULT_COUNT:
305		val |= 1 << BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_SHIFT;
306		break;
307	default:
308		val |= (count - BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_OFFSET) <<
309			BCM54XX_SHD_SCR2_WSPD_RTRY_LMT_SHIFT;
310		break;
311	}
312
313	return bcm_phy_write_shadow(phydev, BCM54XX_SHD_SCR2, val);
314}
315EXPORT_SYMBOL_GPL(bcm_phy_downshift_set);
316
317struct bcm_phy_hw_stat {
318	const char *string;
319	u8 reg;
320	u8 shift;
321	u8 bits;
322};
323
324/* Counters freeze at either 0xffff or 0xff, better than nothing */
325static const struct bcm_phy_hw_stat bcm_phy_hw_stats[] = {
326	{ "phy_receive_errors", MII_BRCM_CORE_BASE12, 0, 16 },
327	{ "phy_serdes_ber_errors", MII_BRCM_CORE_BASE13, 8, 8 },
328	{ "phy_false_carrier_sense_errors", MII_BRCM_CORE_BASE13, 0, 8 },
329	{ "phy_local_rcvr_nok", MII_BRCM_CORE_BASE14, 8, 8 },
330	{ "phy_remote_rcv_nok", MII_BRCM_CORE_BASE14, 0, 8 },
331};
332
333int bcm_phy_get_sset_count(struct phy_device *phydev)
334{
335	return ARRAY_SIZE(bcm_phy_hw_stats);
336}
337EXPORT_SYMBOL_GPL(bcm_phy_get_sset_count);
338
339void bcm_phy_get_strings(struct phy_device *phydev, u8 *data)
340{
341	unsigned int i;
342
343	for (i = 0; i < ARRAY_SIZE(bcm_phy_hw_stats); i++)
344		strlcpy(data + i * ETH_GSTRING_LEN,
345			bcm_phy_hw_stats[i].string, ETH_GSTRING_LEN);
346}
347EXPORT_SYMBOL_GPL(bcm_phy_get_strings);
348
349#ifndef UINT64_MAX
350#define UINT64_MAX              (u64)(~((u64)0))
351#endif
352
353/* Caller is supposed to provide appropriate storage for the library code to
354 * access the shadow copy
355 */
356static u64 bcm_phy_get_stat(struct phy_device *phydev, u64 *shadow,
357			    unsigned int i)
358{
359	struct bcm_phy_hw_stat stat = bcm_phy_hw_stats[i];
360	int val;
361	u64 ret;
362
363	val = phy_read(phydev, stat.reg);
364	if (val < 0) {
365		ret = UINT64_MAX;
366	} else {
367		val >>= stat.shift;
368		val = val & ((1 << stat.bits) - 1);
369		shadow[i] += val;
370		ret = shadow[i];
371	}
372
373	return ret;
374}
375
376void bcm_phy_get_stats(struct phy_device *phydev, u64 *shadow,
377		       struct ethtool_stats *stats, u64 *data)
378{
379	unsigned int i;
380
381	for (i = 0; i < ARRAY_SIZE(bcm_phy_hw_stats); i++)
382		data[i] = bcm_phy_get_stat(phydev, shadow, i);
383}
384EXPORT_SYMBOL_GPL(bcm_phy_get_stats);
385
386MODULE_DESCRIPTION("Broadcom PHY Library");
387MODULE_LICENSE("GPL v2");
388MODULE_AUTHOR("Broadcom Corporation");