xref: /openbmc/u-boot/drivers/net/phy/cortina.c (revision cf0bcd7d)
1 /*
2  * Cortina CS4315/CS4340 10G PHY drivers
3  *
4  * SPDX-License-Identifier:     GPL-2.0+
5  *
6  * Copyright 2014 Freescale Semiconductor, Inc.
7  * Copyright 2018 NXP
8  *
9  */
10 
11 #include <config.h>
12 #include <common.h>
13 #include <malloc.h>
14 #include <linux/ctype.h>
15 #include <linux/string.h>
16 #include <linux/err.h>
17 #include <phy.h>
18 #include <cortina.h>
19 #ifdef CONFIG_SYS_CORTINA_FW_IN_NAND
20 #include <nand.h>
21 #elif defined(CONFIG_SYS_CORTINA_FW_IN_SPIFLASH)
22 #include <spi_flash.h>
23 #elif defined(CONFIG_SYS_CORTINA_FW_IN_MMC)
24 #include <mmc.h>
25 #endif
26 
27 #ifndef CONFIG_PHYLIB_10G
28 #error The Cortina PHY needs 10G support
29 #endif
30 
31 #ifndef CORTINA_NO_FW_UPLOAD
32 struct cortina_reg_config cortina_reg_cfg[] = {
33 	/* CS4315_enable_sr_mode */
34 	{VILLA_GLOBAL_MSEQCLKCTRL, 0x8004},
35 	{VILLA_MSEQ_OPTIONS, 0xf},
36 	{VILLA_MSEQ_PC, 0x0},
37 	{VILLA_MSEQ_BANKSELECT,	   0x4},
38 	{VILLA_LINE_SDS_COMMON_SRX0_RX_CPA, 0x55},
39 	{VILLA_LINE_SDS_COMMON_SRX0_RX_LOOP_FILTER, 0x30},
40 	{VILLA_DSP_SDS_SERDES_SRX_DFE0_SELECT, 0x1},
41 	{VILLA_DSP_SDS_DSP_COEF_DFE0_SELECT, 0x2},
42 	{VILLA_LINE_SDS_COMMON_SRX0_RX_CPB, 0x2003},
43 	{VILLA_DSP_SDS_SERDES_SRX_FFE_DELAY_CTRL, 0xF047},
44 	{VILLA_MSEQ_ENABLE_MSB, 0x0000},
45 	{VILLA_MSEQ_SPARE21_LSB, 0x6},
46 	{VILLA_MSEQ_RESET_COUNT_LSB, 0x0},
47 	{VILLA_MSEQ_SPARE12_MSB, 0x0000},
48 	/*
49 	 * to invert the receiver path, uncomment the next line
50 	 * write (VILLA_MSEQ_SPARE12_MSB, 0x4000)
51 	 *
52 	 * SPARE2_LSB is used to configure the device while in sr mode to
53 	 * enable power savings and to use the optical module LOS signal.
54 	 * in power savings mode, the internal prbs checker can not be used.
55 	 * if the optical module LOS signal is used as an input to the micro
56 	 * code, then the micro code will wait until the optical module
57 	 * LOS = 0 before turning on the adaptive equalizer.
58 	 * Setting SPARE2_LSB bit 0 to 1 places the devie in power savings mode
59 	 * while setting bit 0 to 0 disables power savings mode.
60 	 * Setting SPARE2_LSB bit 2 to 0 configures the device to use the
61 	 * optical module LOS signal while setting bit 2 to 1 configures the
62 	 * device so that it will ignore the optical module LOS SPARE2_LSB = 0
63 	 */
64 
65 	/* enable power savings, ignore optical module LOS */
66 	{VILLA_MSEQ_SPARE2_LSB, 0x5},
67 
68 	{VILLA_MSEQ_SPARE7_LSB, 0x1e},
69 	{VILLA_MSEQ_BANKSELECT, 0x4},
70 	{VILLA_MSEQ_SPARE9_LSB, 0x2},
71 	{VILLA_MSEQ_SPARE3_LSB, 0x0F53},
72 	{VILLA_MSEQ_SPARE3_MSB, 0x2006},
73 	{VILLA_MSEQ_SPARE8_LSB, 0x3FF7},
74 	{VILLA_MSEQ_SPARE8_MSB, 0x0A46},
75 	{VILLA_MSEQ_COEF8_FFE0_LSB, 0xD500},
76 	{VILLA_MSEQ_COEF8_FFE1_LSB, 0x0200},
77 	{VILLA_MSEQ_COEF8_FFE2_LSB, 0xBA00},
78 	{VILLA_MSEQ_COEF8_FFE3_LSB, 0x0100},
79 	{VILLA_MSEQ_COEF8_FFE4_LSB, 0x0300},
80 	{VILLA_MSEQ_COEF8_FFE5_LSB, 0x0300},
81 	{VILLA_MSEQ_COEF8_DFE0_LSB, 0x0700},
82 	{VILLA_MSEQ_COEF8_DFE0N_LSB, 0x0E00},
83 	{VILLA_MSEQ_COEF8_DFE1_LSB, 0x0B00},
84 	{VILLA_DSP_SDS_DSP_COEF_LARGE_LEAK, 0x2},
85 	{VILLA_DSP_SDS_SERDES_SRX_DAC_ENABLEB_LSB, 0xD000},
86 	{VILLA_MSEQ_POWER_DOWN_LSB, 0xFFFF},
87 	{VILLA_MSEQ_POWER_DOWN_MSB, 0x0},
88 	{VILLA_MSEQ_CAL_RX_SLICER, 0x80},
89 	{VILLA_DSP_SDS_SERDES_SRX_DAC_BIAS_SELECT1_MSB, 0x3f},
90 	{VILLA_GLOBAL_MSEQCLKCTRL, 0x4},
91 	{VILLA_MSEQ_OPTIONS, 0x7},
92 
93 	/* set up min value for ffe1 */
94 	{VILLA_MSEQ_COEF_INIT_SEL, 0x2},
95 	{VILLA_DSP_SDS_DSP_PRECODEDINITFFE21, 0x41},
96 
97 	/* CS4315_sr_rx_pre_eq_set_4in */
98 	{VILLA_GLOBAL_MSEQCLKCTRL, 0x8004},
99 	{VILLA_MSEQ_OPTIONS, 0xf},
100 	{VILLA_MSEQ_BANKSELECT, 0x4},
101 	{VILLA_MSEQ_PC, 0x0},
102 
103 	/* for lengths from 3.5 to 4.5inches */
104 	{VILLA_MSEQ_SERDES_PARAM_LSB, 0x0306},
105 	{VILLA_MSEQ_SPARE25_LSB, 0x0306},
106 	{VILLA_MSEQ_SPARE21_LSB, 0x2},
107 	{VILLA_MSEQ_SPARE23_LSB, 0x2},
108 	{VILLA_MSEQ_CAL_RX_DFE_EQ, 0x0},
109 
110 	{VILLA_GLOBAL_MSEQCLKCTRL, 0x4},
111 	{VILLA_MSEQ_OPTIONS, 0x7},
112 
113 	/* CS4315_rx_drive_4inch */
114 	/* for length  4inches */
115 	{VILLA_GLOBAL_VILLA2_COMPATIBLE, 0x0000},
116 	{VILLA_HOST_SDS_COMMON_STX0_TX_OUTPUT_CTRLA, 0x3023},
117 	{VILLA_LINE_SDS_COMMON_STX0_TX_OUTPUT_CTRLB, 0xc01E},
118 
119 	/* CS4315_tx_drive_4inch */
120 	/* for length  4inches */
121 	{VILLA_GLOBAL_VILLA2_COMPATIBLE, 0x0000},
122 	{VILLA_LINE_SDS_COMMON_STX0_TX_OUTPUT_CTRLA, 0x3023},
123 	{VILLA_LINE_SDS_COMMON_STX0_TX_OUTPUT_CTRLB, 0xc01E},
124 };
125 
126 void cs4340_upload_firmware(struct phy_device *phydev)
127 {
128 	char line_temp[0x50] = {0};
129 	char reg_addr[0x50] = {0};
130 	char reg_data[0x50] = {0};
131 	int i, line_cnt = 0, column_cnt = 0;
132 	struct cortina_reg_config fw_temp;
133 	char *addr = NULL;
134 
135 #if defined(CONFIG_SYS_CORTINA_FW_IN_NOR) || \
136 	defined(CONFIG_SYS_CORTINA_FW_IN_REMOTE)
137 
138 	addr = (char *)CONFIG_CORTINA_FW_ADDR;
139 #elif defined(CONFIG_SYS_CORTINA_FW_IN_NAND)
140 	int ret;
141 	size_t fw_length = CONFIG_CORTINA_FW_LENGTH;
142 
143 	addr = malloc(CONFIG_CORTINA_FW_LENGTH);
144 	ret = nand_read(get_nand_dev_by_index(0),
145 			(loff_t)CONFIG_CORTINA_FW_ADDR,
146 			&fw_length, (u_char *)addr);
147 	if (ret == -EUCLEAN) {
148 		printf("NAND read of Cortina firmware at 0x%x failed %d\n",
149 		       CONFIG_CORTINA_FW_ADDR, ret);
150 	}
151 #elif defined(CONFIG_SYS_CORTINA_FW_IN_SPIFLASH)
152 	int ret;
153 	struct spi_flash *ucode_flash;
154 
155 	addr = malloc(CONFIG_CORTINA_FW_LENGTH);
156 	ucode_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
157 				CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
158 	if (!ucode_flash) {
159 		puts("SF: probe for Cortina ucode failed\n");
160 	} else {
161 		ret = spi_flash_read(ucode_flash, CONFIG_CORTINA_FW_ADDR,
162 				     CONFIG_CORTINA_FW_LENGTH, addr);
163 		if (ret)
164 			puts("SF: read for Cortina ucode failed\n");
165 		spi_flash_free(ucode_flash);
166 	}
167 #elif defined(CONFIG_SYS_CORTINA_FW_IN_MMC)
168 	int dev = CONFIG_SYS_MMC_ENV_DEV;
169 	u32 cnt = CONFIG_CORTINA_FW_LENGTH / 512;
170 	u32 blk = CONFIG_CORTINA_FW_ADDR / 512;
171 	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
172 
173 	if (!mmc) {
174 		puts("Failed to find MMC device for Cortina ucode\n");
175 	} else {
176 		addr = malloc(CONFIG_CORTINA_FW_LENGTH);
177 		printf("MMC read: dev # %u, block # %u, count %u ...\n",
178 		       dev, blk, cnt);
179 		mmc_init(mmc);
180 		(void)mmc->block_dev.block_read(&mmc->block_dev, blk, cnt,
181 						addr);
182 	}
183 #endif
184 
185 	while (*addr != 'Q') {
186 		i = 0;
187 
188 		while (*addr != 0x0a) {
189 			line_temp[i++] = *addr++;
190 			if (0x50 < i) {
191 				printf("Not found Cortina PHY ucode at 0x%p\n",
192 				       (char *)CONFIG_CORTINA_FW_ADDR);
193 				return;
194 			}
195 		}
196 
197 		addr++;  /* skip '\n' */
198 		line_cnt++;
199 		column_cnt = i;
200 		line_temp[column_cnt] = '\0';
201 
202 		if (CONFIG_CORTINA_FW_LENGTH < line_cnt)
203 			return;
204 
205 		for (i = 0; i < column_cnt; i++) {
206 			if (isspace(line_temp[i++]))
207 				break;
208 		}
209 
210 		memcpy(reg_addr, line_temp, i);
211 		memcpy(reg_data, &line_temp[i], column_cnt - i);
212 		strim(reg_addr);
213 		strim(reg_data);
214 		fw_temp.reg_addr = (simple_strtoul(reg_addr, NULL, 0)) & 0xffff;
215 		fw_temp.reg_value = (simple_strtoul(reg_data, NULL, 0)) &
216 				     0xffff;
217 		phy_write(phydev, 0x00, fw_temp.reg_addr, fw_temp.reg_value);
218 	}
219 }
220 #endif
221 
222 int cs4340_phy_init(struct phy_device *phydev)
223 {
224 #ifndef CORTINA_NO_FW_UPLOAD
225 	int timeout = 100;  /* 100ms */
226 #endif
227 	int reg_value;
228 
229 	/*
230 	 * Cortina phy has provision to store
231 	 * phy firmware in attached dedicated EEPROM.
232 	 * Boards designed with EEPROM attached to Cortina
233 	 * does not require FW upload.
234 	 */
235 #ifndef CORTINA_NO_FW_UPLOAD
236 	/* step1: BIST test */
237 	phy_write(phydev, 0x00, VILLA_GLOBAL_MSEQCLKCTRL,     0x0004);
238 	phy_write(phydev, 0x00, VILLA_GLOBAL_LINE_SOFT_RESET, 0x0000);
239 	phy_write(phydev, 0x00, VILLA_GLOBAL_BIST_CONTROL,    0x0001);
240 	while (--timeout) {
241 		reg_value = phy_read(phydev, 0x00, VILLA_GLOBAL_BIST_STATUS);
242 		if (reg_value & mseq_edc_bist_done) {
243 			if (0 == (reg_value & mseq_edc_bist_fail))
244 				break;
245 		}
246 		udelay(1000);
247 	}
248 
249 	if (!timeout) {
250 		printf("%s BIST mseq_edc_bist_done timeout!\n", __func__);
251 		return -1;
252 	}
253 
254 	/* setp2: upload ucode */
255 	cs4340_upload_firmware(phydev);
256 #endif
257 	reg_value = phy_read(phydev, 0x00, VILLA_GLOBAL_DWNLD_CHECKSUM_STATUS);
258 	if (reg_value) {
259 		debug("%s checksum status failed.\n", __func__);
260 		return -1;
261 	}
262 
263 	return 0;
264 }
265 
266 int cs4340_config(struct phy_device *phydev)
267 {
268 	cs4340_phy_init(phydev);
269 	return 0;
270 }
271 
272 int cs4340_probe(struct phy_device *phydev)
273 {
274 	phydev->flags = PHY_FLAG_BROKEN_RESET;
275 	return 0;
276 }
277 
278 int cs4340_startup(struct phy_device *phydev)
279 {
280 	phydev->link = 1;
281 
282 	/* For now just lie and say it's 10G all the time */
283 	phydev->speed = SPEED_10000;
284 	phydev->duplex = DUPLEX_FULL;
285 	return 0;
286 }
287 
288 struct phy_driver cs4340_driver = {
289 	.name = "Cortina CS4315/CS4340",
290 	.uid = PHY_UID_CS4340,
291 	.mask = 0xfffffff0,
292 	.features = PHY_10G_FEATURES,
293 	.mmds = (MDIO_DEVS_PMAPMD | MDIO_DEVS_PCS |
294 		 MDIO_DEVS_PHYXS | MDIO_DEVS_AN |
295 		 MDIO_DEVS_VEND1 | MDIO_DEVS_VEND2),
296 	.config = &cs4340_config,
297 	.probe	= &cs4340_probe,
298 	.startup = &cs4340_startup,
299 	.shutdown = &gen10g_shutdown,
300 };
301 
302 int phy_cortina_init(void)
303 {
304 	phy_register(&cs4340_driver);
305 	return 0;
306 }
307 
308 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
309 {
310 	int phy_reg;
311 
312 	/* Cortina PHY has non-standard offset of PHY ID registers */
313 	phy_reg = bus->read(bus, addr, 0, VILLA_GLOBAL_CHIP_ID_LSB);
314 	if (phy_reg < 0)
315 		return -EIO;
316 	*phy_id = (phy_reg & 0xffff) << 16;
317 
318 	phy_reg = bus->read(bus, addr, 0, VILLA_GLOBAL_CHIP_ID_MSB);
319 	if (phy_reg < 0)
320 		return -EIO;
321 	*phy_id |= (phy_reg & 0xffff);
322 
323 	if (*phy_id == PHY_UID_CS4340)
324 		return 0;
325 
326 	/*
327 	 * If Cortina PHY not detected,
328 	 * try generic way to find PHY ID registers
329 	 */
330 	phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
331 	if (phy_reg < 0)
332 		return -EIO;
333 	*phy_id = (phy_reg & 0xffff) << 16;
334 
335 	phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
336 	if (phy_reg < 0)
337 		return -EIO;
338 	*phy_id |= (phy_reg & 0xffff);
339 
340 	return 0;
341 }
342