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