1 // SPDX-License-Identifier: GPL-2.0-only
3 * aQuantia Corporation Network Driver
4 * Copyright (C) 2014-2019 aQuantia Corporation. All rights reserved
7 /* File hw_atl_utils_fw2x.c: Definition of firmware 2.x functions for
8 * Atlantic hardware abstraction layer.
12 #include "../aq_hw_utils.h"
13 #include "../aq_pci_func.h"
14 #include "../aq_ring.h"
15 #include "../aq_vec.h"
16 #include "../aq_nic.h"
17 #include "hw_atl_utils.h"
18 #include "hw_atl_llh.h"
20 #define HW_ATL_FW2X_MPI_LED_ADDR 0x31c
21 #define HW_ATL_FW2X_MPI_RPC_ADDR 0x334
23 #define HW_ATL_FW2X_MPI_MBOX_ADDR 0x360
24 #define HW_ATL_FW2X_MPI_EFUSE_ADDR 0x364
25 #define HW_ATL_FW2X_MPI_CONTROL_ADDR 0x368
26 #define HW_ATL_FW2X_MPI_CONTROL2_ADDR 0x36C
27 #define HW_ATL_FW2X_MPI_STATE_ADDR 0x370
28 #define HW_ATL_FW2X_MPI_STATE2_ADDR 0x374
30 #define HW_ATL_FW3X_EXT_CONTROL_ADDR 0x378
31 #define HW_ATL_FW3X_EXT_STATE_ADDR 0x37c
33 #define HW_ATL_FW3X_PTP_ADJ_LSW_ADDR 0x50a0
34 #define HW_ATL_FW3X_PTP_ADJ_MSW_ADDR 0x50a4
36 #define HW_ATL_FW2X_CAP_PAUSE BIT(CAPS_HI_PAUSE)
37 #define HW_ATL_FW2X_CAP_ASYM_PAUSE BIT(CAPS_HI_ASYMMETRIC_PAUSE)
38 #define HW_ATL_FW2X_CAP_SLEEP_PROXY BIT(CAPS_HI_SLEEP_PROXY)
39 #define HW_ATL_FW2X_CAP_WOL BIT(CAPS_HI_WOL)
41 #define HW_ATL_FW2X_CTRL_WAKE_ON_LINK BIT(CTRL_WAKE_ON_LINK)
42 #define HW_ATL_FW2X_CTRL_SLEEP_PROXY BIT(CTRL_SLEEP_PROXY)
43 #define HW_ATL_FW2X_CTRL_WOL BIT(CTRL_WOL)
44 #define HW_ATL_FW2X_CTRL_LINK_DROP BIT(CTRL_LINK_DROP)
45 #define HW_ATL_FW2X_CTRL_PAUSE BIT(CTRL_PAUSE)
46 #define HW_ATL_FW2X_CTRL_TEMPERATURE BIT(CTRL_TEMPERATURE)
47 #define HW_ATL_FW2X_CTRL_ASYMMETRIC_PAUSE BIT(CTRL_ASYMMETRIC_PAUSE)
48 #define HW_ATL_FW2X_CTRL_INT_LOOPBACK BIT(CTRL_INT_LOOPBACK)
49 #define HW_ATL_FW2X_CTRL_EXT_LOOPBACK BIT(CTRL_EXT_LOOPBACK)
50 #define HW_ATL_FW2X_CTRL_DOWNSHIFT BIT(CTRL_DOWNSHIFT)
51 #define HW_ATL_FW2X_CTRL_FORCE_RECONNECT BIT(CTRL_FORCE_RECONNECT)
53 #define HW_ATL_FW2X_CAP_EEE_1G_MASK BIT(CAPS_HI_1000BASET_FD_EEE)
54 #define HW_ATL_FW2X_CAP_EEE_2G5_MASK BIT(CAPS_HI_2P5GBASET_FD_EEE)
55 #define HW_ATL_FW2X_CAP_EEE_5G_MASK BIT(CAPS_HI_5GBASET_FD_EEE)
56 #define HW_ATL_FW2X_CAP_EEE_10G_MASK BIT(CAPS_HI_10GBASET_FD_EEE)
58 #define HAL_ATLANTIC_WOL_FILTERS_COUNT 8
59 #define HAL_ATLANTIC_UTILS_FW2X_MSG_WOL 0x0E
61 #define HW_ATL_FW_VER_LED 0x03010026U
62 #define HW_ATL_FW_VER_MEDIA_CONTROL 0x0301005aU
64 struct __packed fw2x_msg_wol_pattern {
69 struct __packed fw2x_msg_wol {
72 u8 magic_packet_enabled;
74 struct fw2x_msg_wol_pattern filter[HAL_ATLANTIC_WOL_FILTERS_COUNT];
79 u32 link_down_timeout;
82 static int aq_fw2x_set_link_speed(struct aq_hw_s *self, u32 speed);
83 static int aq_fw2x_set_state(struct aq_hw_s *self,
84 enum hal_atl_utils_fw_state_e state);
86 static u32 aq_fw2x_mbox_get(struct aq_hw_s *self);
87 static u32 aq_fw2x_rpc_get(struct aq_hw_s *self);
88 static int aq_fw2x_settings_get(struct aq_hw_s *self, u32 *addr);
89 static u32 aq_fw2x_state2_get(struct aq_hw_s *self);
91 static int aq_fw2x_init(struct aq_hw_s *self)
95 /* check 10 times by 1ms */
96 err = readx_poll_timeout_atomic(aq_fw2x_mbox_get,
97 self, self->mbox_addr,
98 self->mbox_addr != 0U,
101 err = readx_poll_timeout_atomic(aq_fw2x_rpc_get,
102 self, self->rpc_addr,
103 self->rpc_addr != 0U,
106 err = aq_fw2x_settings_get(self, &self->settings_addr);
111 static int aq_fw2x_deinit(struct aq_hw_s *self)
113 int err = aq_fw2x_set_link_speed(self, 0);
116 err = aq_fw2x_set_state(self, MPI_DEINIT);
121 static enum hw_atl_fw2x_rate link_speed_mask_2fw2x_ratemask(u32 speed)
123 enum hw_atl_fw2x_rate rate = 0;
125 if (speed & AQ_NIC_RATE_10G)
126 rate |= FW2X_RATE_10G;
128 if (speed & AQ_NIC_RATE_5G)
129 rate |= FW2X_RATE_5G;
131 if (speed & AQ_NIC_RATE_5GSR)
132 rate |= FW2X_RATE_5G;
134 if (speed & AQ_NIC_RATE_2GS)
135 rate |= FW2X_RATE_2G5;
137 if (speed & AQ_NIC_RATE_1G)
138 rate |= FW2X_RATE_1G;
140 if (speed & AQ_NIC_RATE_100M)
141 rate |= FW2X_RATE_100M;
146 static u32 fw2x_to_eee_mask(u32 speed)
150 if (speed & HW_ATL_FW2X_CAP_EEE_10G_MASK)
151 rate |= AQ_NIC_RATE_EEE_10G;
152 if (speed & HW_ATL_FW2X_CAP_EEE_5G_MASK)
153 rate |= AQ_NIC_RATE_EEE_5G;
154 if (speed & HW_ATL_FW2X_CAP_EEE_2G5_MASK)
155 rate |= AQ_NIC_RATE_EEE_2GS;
156 if (speed & HW_ATL_FW2X_CAP_EEE_1G_MASK)
157 rate |= AQ_NIC_RATE_EEE_1G;
162 static u32 eee_mask_to_fw2x(u32 speed)
166 if (speed & AQ_NIC_RATE_EEE_10G)
167 rate |= HW_ATL_FW2X_CAP_EEE_10G_MASK;
168 if (speed & AQ_NIC_RATE_EEE_5G)
169 rate |= HW_ATL_FW2X_CAP_EEE_5G_MASK;
170 if (speed & AQ_NIC_RATE_EEE_2GS)
171 rate |= HW_ATL_FW2X_CAP_EEE_2G5_MASK;
172 if (speed & AQ_NIC_RATE_EEE_1G)
173 rate |= HW_ATL_FW2X_CAP_EEE_1G_MASK;
178 static int aq_fw2x_set_link_speed(struct aq_hw_s *self, u32 speed)
180 u32 val = link_speed_mask_2fw2x_ratemask(speed);
182 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL_ADDR, val);
187 static void aq_fw2x_upd_flow_control_bits(struct aq_hw_s *self,
188 u32 *mpi_state, u32 fc)
190 *mpi_state &= ~(HW_ATL_FW2X_CTRL_PAUSE |
191 HW_ATL_FW2X_CTRL_ASYMMETRIC_PAUSE);
194 /* There is not explicit mode of RX only pause frames,
195 * thus, we join this mode with FC full.
196 * FC full is either Rx, either Tx, or both.
200 *mpi_state |= HW_ATL_FW2X_CTRL_PAUSE |
201 HW_ATL_FW2X_CTRL_ASYMMETRIC_PAUSE;
204 *mpi_state |= HW_ATL_FW2X_CTRL_ASYMMETRIC_PAUSE;
209 static void aq_fw2x_upd_eee_rate_bits(struct aq_hw_s *self, u32 *mpi_opts,
212 *mpi_opts &= ~(HW_ATL_FW2X_CAP_EEE_1G_MASK |
213 HW_ATL_FW2X_CAP_EEE_2G5_MASK |
214 HW_ATL_FW2X_CAP_EEE_5G_MASK |
215 HW_ATL_FW2X_CAP_EEE_10G_MASK);
217 *mpi_opts |= eee_mask_to_fw2x(eee_speeds);
220 static int aq_fw2x_set_state(struct aq_hw_s *self,
221 enum hal_atl_utils_fw_state_e state)
223 u32 mpi_state = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
224 struct aq_nic_cfg_s *cfg = self->aq_nic_cfg;
228 mpi_state &= ~BIT(CAPS_HI_LINK_DROP);
229 aq_fw2x_upd_eee_rate_bits(self, &mpi_state, cfg->eee_speeds);
230 aq_fw2x_upd_flow_control_bits(self, &mpi_state,
231 self->aq_nic_cfg->fc.req);
234 mpi_state |= BIT(CAPS_HI_LINK_DROP);
241 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_state);
246 static int aq_fw2x_update_link_status(struct aq_hw_s *self)
248 struct aq_hw_link_status_s *link_status = &self->aq_link_status;
252 mpi_state = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_STATE_ADDR);
253 speed = mpi_state & (FW2X_RATE_100M | FW2X_RATE_1G |
254 FW2X_RATE_2G5 | FW2X_RATE_5G |
258 if (speed & FW2X_RATE_10G)
259 link_status->mbps = 10000;
260 else if (speed & FW2X_RATE_5G)
261 link_status->mbps = 5000;
262 else if (speed & FW2X_RATE_2G5)
263 link_status->mbps = 2500;
264 else if (speed & FW2X_RATE_1G)
265 link_status->mbps = 1000;
266 else if (speed & FW2X_RATE_100M)
267 link_status->mbps = 100;
269 link_status->mbps = 10000;
271 link_status->mbps = 0;
277 static int aq_fw2x_get_mac_permanent(struct aq_hw_s *self, u8 *mac)
279 u32 efuse_addr = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_EFUSE_ADDR);
280 u32 mac_addr[2] = { 0 };
285 if (efuse_addr != 0) {
286 err = hw_atl_utils_fw_downld_dwords(self,
287 efuse_addr + (40U * 4U),
289 ARRAY_SIZE(mac_addr));
292 mac_addr[0] = __swab32(mac_addr[0]);
293 mac_addr[1] = __swab32(mac_addr[1]);
296 ether_addr_copy(mac, (u8 *)mac_addr);
298 if ((mac[0] & 0x01U) || ((mac[0] | mac[1] | mac[2]) == 0x00U)) {
299 unsigned int rnd = 0;
301 get_random_bytes(&rnd, sizeof(unsigned int));
303 l = 0xE3000000U | (0xFFFFU & rnd) | (0x00 << 16);
306 mac[5] = (u8)(0xFFU & l);
308 mac[4] = (u8)(0xFFU & l);
310 mac[3] = (u8)(0xFFU & l);
312 mac[2] = (u8)(0xFFU & l);
313 mac[1] = (u8)(0xFFU & h);
315 mac[0] = (u8)(0xFFU & h);
321 static int aq_fw2x_update_stats(struct aq_hw_s *self)
323 u32 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
324 u32 orig_stats_val = mpi_opts & BIT(CAPS_HI_STATISTICS);
328 /* Toggle statistics bit for FW to update */
329 mpi_opts = mpi_opts ^ BIT(CAPS_HI_STATISTICS);
330 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
332 /* Wait FW to report back */
333 err = readx_poll_timeout_atomic(aq_fw2x_state2_get,
335 orig_stats_val != (stats_val &
336 BIT(CAPS_HI_STATISTICS)),
341 return hw_atl_utils_update_stats(self);
344 static int aq_fw2x_get_phy_temp(struct aq_hw_s *self, int *temp)
346 u32 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
347 u32 temp_val = mpi_opts & HW_ATL_FW2X_CTRL_TEMPERATURE;
353 phy_temp_offset = self->mbox_addr + offsetof(struct hw_atl_utils_mbox,
354 info.phy_temperature);
356 /* Toggle statistics bit for FW to 0x36C.18 (CTRL_TEMPERATURE) */
357 mpi_opts = mpi_opts ^ HW_ATL_FW2X_CTRL_TEMPERATURE;
358 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
359 /* Wait FW to report back */
360 err = readx_poll_timeout_atomic(aq_fw2x_state2_get, self, val,
362 (val & HW_ATL_FW2X_CTRL_TEMPERATURE),
364 err = hw_atl_utils_fw_downld_dwords(self, phy_temp_offset,
370 /* Convert PHY temperature from 1/256 degree Celsius
371 * to 1/1000 degree Celsius.
373 *temp = (temp_res & 0xFFFF) * 1000 / 256;
378 static int aq_fw2x_set_wol(struct aq_hw_s *self, u8 *mac)
380 struct hw_atl_utils_fw_rpc *rpc = NULL;
381 struct offload_info *info = NULL;
387 if (self->aq_nic_cfg->wol & WAKE_PHY) {
388 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR,
389 HW_ATL_FW2X_CTRL_LINK_DROP);
390 readx_poll_timeout_atomic(aq_fw2x_state2_get, self, val,
392 HW_ATL_FW2X_CTRL_LINK_DROP) != 0,
394 wol_bits |= HW_ATL_FW2X_CTRL_WAKE_ON_LINK;
397 if (self->aq_nic_cfg->wol & WAKE_MAGIC) {
398 wol_bits |= HW_ATL_FW2X_CTRL_SLEEP_PROXY |
399 HW_ATL_FW2X_CTRL_WOL;
401 err = hw_atl_utils_fw_rpc_wait(self, &rpc);
405 rpc_size = sizeof(*info) +
406 offsetof(struct hw_atl_utils_fw_rpc, fw2x_offloads);
407 memset(rpc, 0, rpc_size);
408 info = &rpc->fw2x_offloads;
409 memcpy(info->mac_addr, mac, ETH_ALEN);
410 info->len = sizeof(*info);
412 err = hw_atl_utils_fw_rpc_call(self, rpc_size);
417 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, wol_bits);
423 static int aq_fw2x_set_power(struct aq_hw_s *self, unsigned int power_state,
428 if (self->aq_nic_cfg->wol)
429 err = aq_fw2x_set_wol(self, mac);
434 static int aq_fw2x_send_fw_request(struct aq_hw_s *self,
435 const struct hw_fw_request_iface *fw_req,
438 u32 ctrl2, orig_ctrl2;
443 /* Write data to drvIface Mailbox */
444 dword_cnt = size / sizeof(u32);
445 if (size % sizeof(u32))
447 err = hw_atl_write_fwcfg_dwords(self, (void *)fw_req, dword_cnt);
451 /* Toggle statistics bit for FW to update */
452 ctrl2 = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
453 orig_ctrl2 = ctrl2 & BIT(CAPS_HI_FW_REQUEST);
454 ctrl2 = ctrl2 ^ BIT(CAPS_HI_FW_REQUEST);
455 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, ctrl2);
457 /* Wait FW to report back */
458 err = readx_poll_timeout_atomic(aq_fw2x_state2_get, self, val,
460 BIT(CAPS_HI_FW_REQUEST)),
467 static void aq_fw3x_enable_ptp(struct aq_hw_s *self, int enable)
469 u32 ptp_opts = aq_hw_read_reg(self, HW_ATL_FW3X_EXT_STATE_ADDR);
470 u32 all_ptp_features = BIT(CAPS_EX_PHY_PTP_EN) |
471 BIT(CAPS_EX_PTP_GPIO_EN);
474 ptp_opts |= all_ptp_features;
476 ptp_opts &= ~all_ptp_features;
478 aq_hw_write_reg(self, HW_ATL_FW3X_EXT_CONTROL_ADDR, ptp_opts);
481 static void aq_fw3x_adjust_ptp(struct aq_hw_s *self, uint64_t adj)
483 aq_hw_write_reg(self, HW_ATL_FW3X_PTP_ADJ_LSW_ADDR,
484 (adj >> 0) & 0xffffffff);
485 aq_hw_write_reg(self, HW_ATL_FW3X_PTP_ADJ_MSW_ADDR,
486 (adj >> 32) & 0xffffffff);
489 static int aq_fw2x_led_control(struct aq_hw_s *self, u32 mode)
491 if (self->fw_ver_actual < HW_ATL_FW_VER_LED)
494 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_LED_ADDR, mode);
499 static int aq_fw2x_set_eee_rate(struct aq_hw_s *self, u32 speed)
501 u32 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
503 aq_fw2x_upd_eee_rate_bits(self, &mpi_opts, speed);
505 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
510 static int aq_fw2x_get_eee_rate(struct aq_hw_s *self, u32 *rate,
511 u32 *supported_rates)
518 offset = self->mbox_addr + offsetof(struct hw_atl_utils_mbox,
521 err = hw_atl_utils_fw_downld_dwords(self, offset, &caps_hi, 1);
526 *supported_rates = fw2x_to_eee_mask(caps_hi);
528 mpi_state = aq_fw2x_state2_get(self);
529 *rate = fw2x_to_eee_mask(mpi_state);
534 static int aq_fw2x_renegotiate(struct aq_hw_s *self)
536 u32 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
538 mpi_opts |= BIT(CTRL_FORCE_RECONNECT);
540 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
545 static int aq_fw2x_set_flow_control(struct aq_hw_s *self)
547 u32 mpi_state = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
549 aq_fw2x_upd_flow_control_bits(self, &mpi_state,
550 self->aq_nic_cfg->fc.req);
552 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_state);
557 static u32 aq_fw2x_get_flow_control(struct aq_hw_s *self, u32 *fcmode)
559 u32 mpi_state = aq_fw2x_state2_get(self);
562 if (mpi_state & HW_ATL_FW2X_CAP_PAUSE)
563 *fcmode |= AQ_NIC_FC_RX;
565 if (mpi_state & HW_ATL_FW2X_CAP_ASYM_PAUSE)
566 *fcmode |= AQ_NIC_FC_TX;
571 static int aq_fw2x_set_phyloopback(struct aq_hw_s *self, u32 mode, bool enable)
576 case AQ_HW_LOOPBACK_PHYINT_SYS:
577 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
579 mpi_opts |= HW_ATL_FW2X_CTRL_INT_LOOPBACK;
581 mpi_opts &= ~HW_ATL_FW2X_CTRL_INT_LOOPBACK;
582 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
584 case AQ_HW_LOOPBACK_PHYEXT_SYS:
585 mpi_opts = aq_hw_read_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR);
587 mpi_opts |= HW_ATL_FW2X_CTRL_EXT_LOOPBACK;
589 mpi_opts &= ~HW_ATL_FW2X_CTRL_EXT_LOOPBACK;
590 aq_hw_write_reg(self, HW_ATL_FW2X_MPI_CONTROL2_ADDR, mpi_opts);
599 static u32 aq_fw2x_mbox_get(struct aq_hw_s *self)
601 return aq_hw_read_reg(self, HW_ATL_FW2X_MPI_MBOX_ADDR);
604 static u32 aq_fw2x_rpc_get(struct aq_hw_s *self)
606 return aq_hw_read_reg(self, HW_ATL_FW2X_MPI_RPC_ADDR);
609 static int aq_fw2x_settings_get(struct aq_hw_s *self, u32 *addr)
614 offset = self->mbox_addr + offsetof(struct hw_atl_utils_mbox,
615 info.setting_address);
617 err = hw_atl_utils_fw_downld_dwords(self, offset, addr, 1);
622 static u32 aq_fw2x_state2_get(struct aq_hw_s *self)
624 return aq_hw_read_reg(self, HW_ATL_FW2X_MPI_STATE2_ADDR);
627 const struct aq_fw_ops aq_fw_2x_ops = {
628 .init = aq_fw2x_init,
629 .deinit = aq_fw2x_deinit,
631 .renegotiate = aq_fw2x_renegotiate,
632 .get_mac_permanent = aq_fw2x_get_mac_permanent,
633 .set_link_speed = aq_fw2x_set_link_speed,
634 .set_state = aq_fw2x_set_state,
635 .update_link_status = aq_fw2x_update_link_status,
636 .update_stats = aq_fw2x_update_stats,
637 .get_phy_temp = aq_fw2x_get_phy_temp,
638 .set_power = aq_fw2x_set_power,
639 .set_eee_rate = aq_fw2x_set_eee_rate,
640 .get_eee_rate = aq_fw2x_get_eee_rate,
641 .set_flow_control = aq_fw2x_set_flow_control,
642 .get_flow_control = aq_fw2x_get_flow_control,
643 .send_fw_request = aq_fw2x_send_fw_request,
644 .enable_ptp = aq_fw3x_enable_ptp,
645 .led_control = aq_fw2x_led_control,
646 .set_phyloopback = aq_fw2x_set_phyloopback,
647 .adjust_ptp = aq_fw3x_adjust_ptp,