net/ice/base: print human-friendly PHY types
[dpdk.git] / drivers / net / ice / base / ice_ptp_hw.c
index 8aefcf9..cb32a4f 100644 (file)
@@ -6,7 +6,7 @@
 #include "ice_common.h"
 #include "ice_ptp_hw.h"
 #include "ice_ptp_consts.h"
-
+#include "ice_cgu_regs.h"
 
 /* Low level functions for interacting with and managing the device clock used
  * for the Precision Time Protocol.
@@ -699,6 +699,315 @@ ice_clear_phy_tstamp_e822(struct ice_hw *hw, u8 quad, u8 idx)
        return ICE_SUCCESS;
 }
 
+/**
+ * ice_read_cgu_reg_e822 - Read a CGU register
+ * @hw: pointer to the HW struct
+ * @addr: Register address to read
+ * @val: storage for register value read
+ *
+ * Read the contents of a register of the Clock Generation Unit. Only
+ * applicable to E822 devices.
+ */
+static enum ice_status
+ice_read_cgu_reg_e822(struct ice_hw *hw, u32 addr, u32 *val)
+{
+       struct ice_sbq_msg_input cgu_msg;
+       enum ice_status status;
+
+       cgu_msg.opcode = ice_sbq_msg_rd;
+       cgu_msg.dest_dev = cgu;
+       cgu_msg.msg_addr_low = addr;
+       cgu_msg.msg_addr_high = 0x0;
+
+       status = ice_sbq_rw_reg_lp(hw, &cgu_msg, true);
+       if (status) {
+               ice_debug(hw, ICE_DBG_PTP, "Failed to read CGU register 0x%04x, status %d\n",
+                         addr, status);
+               return status;
+       }
+
+       *val = cgu_msg.data;
+
+       return status;
+}
+
+/**
+ * ice_write_cgu_reg_e822 - Write a CGU register
+ * @hw: pointer to the HW struct
+ * @addr: Register address to write
+ * @val: value to write into the register
+ *
+ * Write the specified value to a register of the Clock Generation Unit. Only
+ * applicable to E822 devices.
+ */
+static enum ice_status
+ice_write_cgu_reg_e822(struct ice_hw *hw, u32 addr, u32 val)
+{
+       struct ice_sbq_msg_input cgu_msg;
+       enum ice_status status;
+
+       cgu_msg.opcode = ice_sbq_msg_wr;
+       cgu_msg.dest_dev = cgu;
+       cgu_msg.msg_addr_low = addr;
+       cgu_msg.msg_addr_high = 0x0;
+       cgu_msg.data = val;
+
+       status = ice_sbq_rw_reg_lp(hw, &cgu_msg, true);
+       if (status) {
+               ice_debug(hw, ICE_DBG_PTP, "Failed to write CGU register 0x%04x, status %d\n",
+                         addr, status);
+               return status;
+       }
+
+       return status;
+}
+
+/**
+ * ice_clk_freq_str - Convert time_ref_freq to string
+ * @clk_freq: Clock frequency
+ *
+ * Convert the specified TIME_REF clock frequency to a string.
+ */
+static const char *ice_clk_freq_str(u8 clk_freq)
+{
+       switch ((enum ice_time_ref_freq)clk_freq) {
+       case ICE_TIME_REF_FREQ_25_000:
+               return "25 MHz";
+       case ICE_TIME_REF_FREQ_122_880:
+               return "122.88 MHz";
+       case ICE_TIME_REF_FREQ_125_000:
+               return "125 MHz";
+       case ICE_TIME_REF_FREQ_153_600:
+               return "153.6 MHz";
+       case ICE_TIME_REF_FREQ_156_250:
+               return "156.25 MHz";
+       case ICE_TIME_REF_FREQ_245_760:
+               return "245.76 MHz";
+       default:
+               return "Unknown";
+       }
+}
+
+/**
+ * ice_clk_src_str - Convert time_ref_src to string
+ * @clk_src: Clock source
+ *
+ * Convert the specified clock source to its string name.
+ */
+static const char *ice_clk_src_str(u8 clk_src)
+{
+       switch ((enum ice_clk_src)clk_src) {
+       case ICE_CLK_SRC_TCX0:
+               return "TCX0";
+       case ICE_CLK_SRC_TIME_REF:
+               return "TIME_REF";
+       default:
+               return "Unknown";
+       }
+}
+
+/**
+ * ice_cfg_cgu_pll_e822 - Configure the Clock Generation Unit
+ * @hw: pointer to the HW struct
+ * @clk_freq: Clock frequency to program
+ * @clk_src: Clock source to select (TIME_REF, or TCX0)
+ *
+ * Configure the Clock Generation Unit with the desired clock frequency and
+ * time reference, enabling the PLL which drives the PTP hardware clock.
+ */
+enum ice_status
+ice_cfg_cgu_pll_e822(struct ice_hw *hw, enum ice_time_ref_freq clk_freq,
+                    enum ice_clk_src clk_src)
+{
+       union tspll_ro_bwm_lf bwm_lf;
+       union nac_cgu_dword19 dw19;
+       union nac_cgu_dword22 dw22;
+       union nac_cgu_dword24 dw24;
+       union nac_cgu_dword9 dw9;
+       enum ice_status status;
+
+       if (clk_freq >= NUM_ICE_TIME_REF_FREQ) {
+               ice_warn(hw, "Invalid TIME_REF frequency %u\n", clk_freq);
+               return ICE_ERR_PARAM;
+       }
+
+       if (clk_src >= NUM_ICE_CLK_SRC) {
+               ice_warn(hw, "Invalid clock source %u\n", clk_src);
+               return ICE_ERR_PARAM;
+       }
+
+       if (clk_src == ICE_CLK_SRC_TCX0 &&
+           clk_freq != ICE_TIME_REF_FREQ_25_000) {
+               ice_warn(hw, "TCX0 only supports 25 MHz frequency\n");
+               return ICE_ERR_PARAM;
+       }
+
+       status = ice_read_cgu_reg_e822(hw, NAC_CGU_DWORD9, &dw9.val);
+       if (status)
+               return status;
+
+       status = ice_read_cgu_reg_e822(hw, NAC_CGU_DWORD24, &dw24.val);
+       if (status)
+               return status;
+
+       status = ice_read_cgu_reg_e822(hw, TSPLL_RO_BWM_LF, &bwm_lf.val);
+       if (status)
+               return status;
+
+       /* Log the current clock configuration */
+       ice_debug(hw, ICE_DBG_PTP, "Current CGU configuration -- %s, clk_src %s, clk_freq %s, PLL %s\n",
+                 dw24.field.ts_pll_enable ? "enabled" : "disabled",
+                 ice_clk_src_str(dw24.field.time_ref_sel),
+                 ice_clk_freq_str(dw9.field.time_ref_freq_sel),
+                 bwm_lf.field.plllock_true_lock_cri ? "locked" : "unlocked");
+
+       /* Disable the PLL before changing the clock source or frequency */
+       if (dw24.field.ts_pll_enable) {
+               dw24.field.ts_pll_enable = 0;
+
+               status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD24, dw24.val);
+               if (status)
+                       return status;
+       }
+
+       /* Set the frequency */
+       dw9.field.time_ref_freq_sel = clk_freq;
+       status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD9, dw9.val);
+       if (status)
+               return status;
+
+       /* Configure the TS PLL feedback divisor */
+       status = ice_read_cgu_reg_e822(hw, NAC_CGU_DWORD19, &dw19.val);
+       if (status)
+               return status;
+
+       dw19.field.tspll_fbdiv_intgr = e822_cgu_params[clk_freq].feedback_div;
+       dw19.field.tspll_ndivratio = 1;
+
+       status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD19, dw19.val);
+       if (status)
+               return status;
+
+       /* Configure the TS PLL post divisor */
+       status = ice_read_cgu_reg_e822(hw, NAC_CGU_DWORD22, &dw22.val);
+       if (status)
+               return status;
+
+       dw22.field.time1588clk_div = e822_cgu_params[clk_freq].post_pll_div;
+       dw22.field.time1588clk_sel_div2 = 0;
+
+       status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD22, dw22.val);
+       if (status)
+               return status;
+
+       /* Configure the TS PLL pre divisor and clock source */
+       status = ice_read_cgu_reg_e822(hw, NAC_CGU_DWORD24, &dw24.val);
+       if (status)
+               return status;
+
+       dw24.field.ref1588_ck_div = e822_cgu_params[clk_freq].refclk_pre_div;
+       dw24.field.tspll_fbdiv_frac = e822_cgu_params[clk_freq].frac_n_div;
+       dw24.field.time_ref_sel = clk_src;
+
+       status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD24, dw24.val);
+       if (status)
+               return status;
+
+       /* Finally, enable the PLL */
+       dw24.field.ts_pll_enable = 1;
+
+       status = ice_write_cgu_reg_e822(hw, NAC_CGU_DWORD24, dw24.val);
+       if (status)
+               return status;
+
+       /* Wait to verify if the PLL locks */
+       ice_msec_delay(1, true);
+
+       status = ice_read_cgu_reg_e822(hw, TSPLL_RO_BWM_LF, &bwm_lf.val);
+       if (status)
+               return status;
+
+       if (!bwm_lf.field.plllock_true_lock_cri) {
+               ice_warn(hw, "CGU PLL failed to lock\n");
+               return ICE_ERR_NOT_READY;
+       }
+
+       /* Log the current clock configuration */
+       ice_debug(hw, ICE_DBG_PTP, "New CGU configuration -- %s, clk_src %s, clk_freq %s, PLL %s\n",
+                 dw24.field.ts_pll_enable ? "enabled" : "disabled",
+                 ice_clk_src_str(dw24.field.time_ref_sel),
+                 ice_clk_freq_str(dw9.field.time_ref_freq_sel),
+                 bwm_lf.field.plllock_true_lock_cri ? "locked" : "unlocked");
+
+
+       return ICE_SUCCESS;
+}
+
+/**
+ * ice_init_cgu_e822 - Initialize CGU with settings from firmware
+ * @hw: pointer to the HW structure
+ *
+ * Initialize the Clock Generation Unit of the E822 device.
+ */
+static enum ice_status ice_init_cgu_e822(struct ice_hw *hw)
+{
+       struct ice_ts_func_info *ts_info = &hw->func_caps.ts_func_info;
+       union tspll_cntr_bist_settings cntr_bist;
+       enum ice_status status;
+
+       status = ice_read_cgu_reg_e822(hw, TSPLL_CNTR_BIST_SETTINGS,
+                                      &cntr_bist.val);
+       if (status)
+               return status;
+
+       /* Disable sticky lock detection so lock status reported is accurate */
+       cntr_bist.field.i_plllock_sel_0 = 0;
+       cntr_bist.field.i_plllock_sel_1 = 0;
+
+       status = ice_write_cgu_reg_e822(hw, TSPLL_CNTR_BIST_SETTINGS,
+                                       cntr_bist.val);
+       if (status)
+               return status;
+
+       /* Configure the CGU PLL using the parameters from the function
+        * capabilities.
+        */
+       status = ice_cfg_cgu_pll_e822(hw, ts_info->time_ref,
+                                     (enum ice_clk_src)ts_info->clk_src);
+       if (status)
+               return status;
+
+       return ICE_SUCCESS;
+}
+
+/**
+ * ice_ptp_init_phc_e822 - Perform E822 specific PHC initialization
+ * @hw: pointer to HW struct
+ *
+ * Perform PHC initialization steps specific to E822 devices.
+ */
+static enum ice_status ice_ptp_init_phc_e822(struct ice_hw *hw)
+{
+       enum ice_status status;
+       u32 regval;
+
+       /* Enable reading switch and PHY registers over the sideband queue */
+#define PF_SB_REM_DEV_CTL_SWITCH_READ BIT(1)
+#define PF_SB_REM_DEV_CTL_PHY0 BIT(2)
+       regval = rd32(hw, PF_SB_REM_DEV_CTL);
+       regval |= (PF_SB_REM_DEV_CTL_SWITCH_READ |
+                  PF_SB_REM_DEV_CTL_PHY0);
+       wr32(hw, PF_SB_REM_DEV_CTL, regval);
+
+       /* Initialize the Clock Generation Unit */
+       status = ice_init_cgu_e822(hw);
+       if (status)
+               return status;
+
+       /* Set window length for all the ports */
+       return ice_ptp_set_vernier_wl(hw);
+}
+
 /**
  * ice_ptp_prep_phy_time_e822 - Prepare PHY port with initial time
  * @hw: pointer to the HW struct
@@ -1445,6 +1754,21 @@ enum ice_status ice_ptp_init_phy_e810(struct ice_hw *hw)
        return status;
 }
 
+/**
+ * ice_ptp_init_phc_e810 - Perform E810 specific PHC initialization
+ * @hw: pointer to HW struct
+ *
+ * Perform E810-specific PTP hardware clock initialization steps.
+ */
+static enum ice_status ice_ptp_init_phc_e810(struct ice_hw *hw)
+{
+       /* Ensure synchronization delay is zero */
+       wr32(hw, GLTSYN_SYNC_DLAY, 0);
+
+       /* Initialize the PHY */
+       return ice_ptp_init_phy_e810(hw);
+}
+
 /**
  * ice_ptp_prep_phy_time_e810 - Prepare PHY port with initial time
  * @hw: Board private structure
@@ -2021,3 +2345,25 @@ ice_clear_phy_tstamp(struct ice_hw *hw, u8 block, u8 idx)
        else
                return ice_clear_phy_tstamp_e822(hw, block, idx);
 }
+
+/**
+ * ice_ptp_init_phc - Initialize PTP hardware clock
+ * @hw: pointer to the HW struct
+ *
+ * Perform the steps required to initialize the PTP hardware clock.
+ */
+enum ice_status ice_ptp_init_phc(struct ice_hw *hw)
+{
+       u8 src_idx = hw->func_caps.ts_func_info.tmr_index_owned;
+
+       /* Enable source clocks */
+       wr32(hw, GLTSYN_ENA(src_idx), GLTSYN_ENA_TSYN_ENA_M);
+
+       /* Clear event status indications for auxiliary pins */
+       (void)rd32(hw, GLTSYN_STAT(src_idx));
+
+       if (ice_is_e810(hw))
+               return ice_ptp_init_phc_e810(hw);
+       else
+               return ice_ptp_init_phc_e822(hw);
+}