ice: implement CPI support for E825C

Add full CPI (Converged PHY Interface) command handling required for
E825C devices. The CPI interface allows the driver to interact with
PHY-side control logic through the LM/PHY command registers, including
enabling/disabling/selection of PHY reference clock.

This patch introduces:
 - a new CPI subsystem (ice_cpi.c / ice_cpi.h) implementing the CPI
   request/acknowledge state machine, including REQ/ACK protocol,
   command execution, and response handling
 - helper functions for reading/writing PHY registers over Sideband
   Queue
 - CPI command execution API (ice_cpi_exec) and a helper for enabling or
   disabling Tx reference clocks (CPI 0xF1 opcode 'Config PHY clocking')
 - assurance of CPI transaction serialization into the CPI core.
   CPI REQ/ACK is a multi-step handshake    and must be executed
   atomically per PHY. Centralize the lock in ice_cpi_exec() and
   use adapter-scoped per-PHY mutexes, which match the hardware sharing
   model across PFs.
 - addition of the non-posted write opcode (wr_np) to SBQ
 - Makefile integration to build CPI support together with the PTP stack

This provides the infrastructure necessary to support PHY-side
configuration flows on E825C and is required for advanced link control
and Tx reference clock management.

Reviewed-by: Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>
Signed-off-by: Grzegorz Nitka <grzegorz.nitka@intel.com>
Link: https://patch.msgid.link/20260607183045.1213735-12-grzegorz.nitka@intel.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Grzegorz Nitka 2026-06-07 20:30:43 +02:00 committed by Jakub Kicinski
parent 5db36ee628
commit fff4ed70ca
8 changed files with 448 additions and 3 deletions

View File

@ -54,7 +54,7 @@ ice-$(CONFIG_PCI_IOV) += \
ice_vf_mbx.o \
ice_vf_vsi_vlan_ops.o \
ice_vf_lib.o
ice-$(CONFIG_PTP_1588_CLOCK) += ice_ptp.o ice_ptp_hw.o ice_dpll.o ice_tspll.o
ice-$(CONFIG_PTP_1588_CLOCK) += ice_ptp.o ice_ptp_hw.o ice_dpll.o ice_tspll.o ice_cpi.o
ice-$(CONFIG_DCB) += ice_dcb.o ice_dcb_nl.o ice_dcb_lib.o
ice-$(CONFIG_RFS_ACCEL) += ice_arfs.o
ice-$(CONFIG_XDP_SOCKETS) += ice_xsk.o

View File

@ -62,6 +62,8 @@ static struct ice_adapter *ice_adapter_new(struct pci_dev *pdev)
adapter->index = ice_adapter_index(pdev);
spin_lock_init(&adapter->ptp_gltsyn_time_lock);
spin_lock_init(&adapter->txq_ctx_lock);
for (int i = 0; i < ARRAY_SIZE(adapter->cpi_phy_lock); i++)
mutex_init(&adapter->cpi_phy_lock[i]);
refcount_set(&adapter->refcount, 1);
mutex_init(&adapter->ports.lock);
@ -73,6 +75,8 @@ static struct ice_adapter *ice_adapter_new(struct pci_dev *pdev)
static void ice_adapter_free(struct ice_adapter *adapter)
{
WARN_ON(!list_empty(&adapter->ports.ports));
for (int i = 0; i < ARRAY_SIZE(adapter->cpi_phy_lock); i++)
mutex_destroy(&adapter->cpi_phy_lock[i]);
mutex_destroy(&adapter->ports.lock);
kfree(adapter);

View File

@ -5,9 +5,12 @@
#define _ICE_ADAPTER_H_
#include <linux/types.h>
#include <linux/mutex.h>
#include <linux/spinlock_types.h>
#include <linux/refcount_types.h>
#include "ice_type.h"
struct pci_dev;
struct ice_pf;
@ -31,6 +34,8 @@ struct ice_port_list {
* @ptp_gltsyn_time_lock: Spinlock protecting access to the GLTSYN_TIME
* register of the PTP clock.
* @txq_ctx_lock: Spinlock protecting access to the GLCOMM_QTX_CNTX_CTL register
* @cpi_phy_lock: Per-PHY mutex serializing CPI REQ/ACK transactions.
* Index 0 = PHY0, index 1 = PHY1. Used on E825C devices.
* @ctrl_pf: Control PF of the adapter
* @ports: Ports list
* @index: 64-bit index cached for collision detection on 32bit systems
@ -41,6 +46,8 @@ struct ice_adapter {
spinlock_t ptp_gltsyn_time_lock;
/* For access to GLCOMM_QTX_CNTX_CTL register */
spinlock_t txq_ctx_lock;
/* Serialize CPI REQ/ACK transactions per PHY (E825C only) */
struct mutex cpi_phy_lock[ICE_E825_MAX_PHYS];
struct ice_pf *ctrl_pf;
struct ice_port_list ports;

View File

@ -0,0 +1,362 @@
// SPDX-License-Identifier: GPL-2.0-only
/* Copyright (C) 2026 Intel Corporation */
#include "ice_type.h"
#include "ice_common.h"
#include "ice_ptp_hw.h"
#include "ice.h"
#include "ice_cpi.h"
/**
* ice_cpi_get_dest_dev - get destination PHY for given phy index
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
*
* Return: sideband queue destination PHY device.
*/
static enum ice_sbq_dev_id ice_cpi_get_dest_dev(struct ice_hw *hw, u8 phy)
{
u8 curr_phy = hw->lane_num / hw->ptp.ports_per_phy;
/* In the driver, lanes 4..7 are in fact 0..3 on a second PHY.
* On a single complex E825C, PHY 0 is always destination device phy_0
* and PHY 1 is phy_0_peer.
* On dual complex E825C, device phy_0 points to PHY on a current
* complex and phy_0_peer to PHY on a different complex.
*/
if ((!ice_is_dual(hw) && phy) ||
(ice_is_dual(hw) && phy != curr_phy))
return ice_sbq_dev_phy_0_peer;
else
return ice_sbq_dev_phy_0;
}
/**
* ice_cpi_write_phy - Write a CPI port register
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @addr: PHY register address
* @val: Value to write
*
* Return:
* * 0 on success
* * other error codes when failed to write to PHY
*/
static int ice_cpi_write_phy(struct ice_hw *hw, u8 phy, u32 addr, u32 val)
{
struct ice_sbq_msg_input msg = {
.dest_dev = ice_cpi_get_dest_dev(hw, phy),
.opcode = ice_sbq_msg_wr_np,
.msg_addr_low = lower_16_bits(addr),
.msg_addr_high = upper_16_bits(addr),
.data = val
};
int err;
err = ice_sbq_rw_reg(hw, &msg, LIBIE_AQ_FLAG_RD);
if (err)
ice_debug(hw, ICE_DBG_PTP,
"Failed to write CPI msg to phy %d, err: %d\n",
phy, err);
return err;
}
/**
* ice_cpi_read_phy - Read a CPI port register
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @addr: PHY register address
* @val: storage for register value
*
* Return:
* * 0 on success
* * other error codes when failed to read from PHY
*/
static int ice_cpi_read_phy(struct ice_hw *hw, u8 phy, u32 addr, u32 *val)
{
struct ice_sbq_msg_input msg = {
.dest_dev = ice_cpi_get_dest_dev(hw, phy),
.opcode = ice_sbq_msg_rd,
.msg_addr_low = lower_16_bits(addr),
.msg_addr_high = upper_16_bits(addr)
};
int err;
err = ice_sbq_rw_reg(hw, &msg, LIBIE_AQ_FLAG_RD);
if (err) {
ice_debug(hw, ICE_DBG_PTP,
"Failed to read CPI msg from phy %d, err: %d\n",
phy, err);
return err;
}
*val = msg.data;
return 0;
}
/**
* ice_cpi_wait_req0_ack0 - waits for CPI interface to be available
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
*
* This function checks if CPI interface is ready to use by CPI client.
* It's done by assuring LM.CMD.REQ and PHY.CMD.ACK bit in CPI
* interface registers to be 0.
*
* Return: 0 on success, negative on error
*/
static int ice_cpi_wait_req0_ack0(struct ice_hw *hw, int phy)
{
u32 phy_val;
u32 lm_val;
for (int i = 0; i < CPI_RETRIES_COUNT; i++) {
int err;
/* check if another CPI Client is also accessing CPI */
err = ice_cpi_read_phy(hw, phy, CPI0_LM1_CMD_DATA, &lm_val);
if (err)
return err;
if (FIELD_GET(CPI_LM_CMD_REQ_M, lm_val))
goto retry;
/* check if PHY.ACK is deasserted */
err = ice_cpi_read_phy(hw, phy, CPI0_PHY1_CMD_DATA, &phy_val);
if (err)
return err;
if (!FIELD_GET(CPI_PHY_CMD_ACK_M, phy_val))
/* req0 and ack0 at this point - ready to go */
return 0;
retry:
msleep(CPI_RETRIES_CADENCE_MS);
}
return -ETIMEDOUT;
}
/**
* ice_cpi_wait_ack - Waits for the PHY.ACK bit to be asserted/deasserted
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @asserted: desired state of PHY.ACK bit
* @data: pointer to the user data where PHY.data is stored
*
* This function checks if PHY.ACK bit is asserted or deasserted, depending
* on the phase of CPI handshake. If 'asserted' state is required, PHY command
* data is stored in the 'data' storage.
*
* Return: 0 on success, negative on error
*/
static int ice_cpi_wait_ack(struct ice_hw *hw, u8 phy, bool asserted,
u32 *data)
{
u32 phy_val;
for (int i = 0; i < CPI_RETRIES_COUNT; i++) {
int err;
err = ice_cpi_read_phy(hw, phy, CPI0_PHY1_CMD_DATA, &phy_val);
if (err)
return err;
if (asserted && FIELD_GET(CPI_PHY_CMD_ERROR_M, phy_val))
return -EFAULT;
if (asserted && FIELD_GET(CPI_PHY_CMD_ACK_M, phy_val)) {
if (data)
*data = phy_val;
return 0;
}
if (!asserted && !FIELD_GET(CPI_PHY_CMD_ACK_M, phy_val))
return 0;
msleep(CPI_RETRIES_CADENCE_MS);
}
return -ETIMEDOUT;
}
#define ice_cpi_wait_ack0(hw, port) \
ice_cpi_wait_ack(hw, port, false, NULL)
#define ice_cpi_wait_ack1(hw, port, data) \
ice_cpi_wait_ack(hw, port, true, data)
/**
* ice_cpi_req0 - deasserts LM.REQ bit
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @data: the command data
*
* Return: 0 on success, negative on CPI write error
*/
static int ice_cpi_req0(struct ice_hw *hw, u8 phy, u32 data)
{
data &= ~CPI_LM_CMD_REQ_M;
return ice_cpi_write_phy(hw, phy, CPI0_LM1_CMD_DATA, data);
}
/**
* ice_cpi_exec_cmd - writes command data to CPI interface
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @data: the command data
*
* Return: 0 on success, otherwise negative on error
*/
static int ice_cpi_exec_cmd(struct ice_hw *hw, int phy, u32 data)
{
return ice_cpi_write_phy(hw, phy, CPI0_LM1_CMD_DATA, data);
}
/**
* ice_cpi_phy_lock - get per-PHY lock for CPI transaction serialization
* @hw: pointer to the HW struct
* @phy: PHY index
*
* Return: pointer to PHY mutex, or %NULL when context is unavailable.
*/
static struct mutex *ice_cpi_phy_lock(struct ice_hw *hw, u8 phy)
{
struct ice_pf *pf = hw->back;
if (!pf || !pf->adapter || phy >= ICE_E825_MAX_PHYS)
return NULL;
return &pf->adapter->cpi_phy_lock[phy];
}
/**
* ice_cpi_exec - executes CPI command
* @hw: pointer to the HW struct
* @phy: phy index of port the CPI action is taken on
* @cmd: pointer to the command struct to execute
* @resp: pointer to user allocated CPI response struct
*
* This function executes CPI request with respect to CPI handshake
* mechanism.
*
* Return: 0 on success, otherwise negative on error
*/
int ice_cpi_exec(struct ice_hw *hw, u8 phy,
const struct ice_cpi_cmd *cmd,
struct ice_cpi_resp *resp)
{
struct mutex *cpi_lock; /* serializes CPI transactions per PHY */
u32 phy_cmd, lm_cmd = 0;
int err, err1 = 0;
if (!cmd || !resp)
return -EINVAL;
cpi_lock = ice_cpi_phy_lock(hw, phy);
if (!cpi_lock)
return -EINVAL;
mutex_lock(cpi_lock);
lm_cmd =
FIELD_PREP(CPI_LM_CMD_REQ_M, CPI_LM_CMD_REQ) |
FIELD_PREP(CPI_LM_CMD_GET_SET_M, cmd->set) |
FIELD_PREP(CPI_LM_CMD_OPCODE_M, cmd->opcode) |
FIELD_PREP(CPI_LM_CMD_PORTLANE_M, cmd->port) |
FIELD_PREP(CPI_LM_CMD_DATA_M, cmd->data);
/* 1. Try to acquire the bus, PHY ACK should be low before we begin */
err = ice_cpi_wait_req0_ack0(hw, phy);
if (err)
goto cpi_exec_exit;
/* 2. We start the CPI request */
err = ice_cpi_exec_cmd(hw, phy, lm_cmd);
if (err)
goto cpi_deassert;
/*
* 3. Wait for CPI confirmation, PHY ACK should be asserted and opcode
* echoed in the response
*/
err = ice_cpi_wait_ack1(hw, phy, &phy_cmd);
if (err)
goto cpi_deassert;
if (FIELD_GET(CPI_LM_CMD_OPCODE_M, lm_cmd) !=
FIELD_GET(CPI_PHY_CMD_OPCODE_M, phy_cmd)) {
err = -EFAULT;
goto cpi_deassert;
}
resp->opcode = FIELD_GET(CPI_PHY_CMD_OPCODE_M, phy_cmd);
resp->data = FIELD_GET(CPI_PHY_CMD_DATA_M, phy_cmd);
resp->port = FIELD_GET(CPI_PHY_CMD_PORTLANE_M, phy_cmd);
cpi_deassert:
/* 4. We deassert REQ */
err1 = ice_cpi_req0(hw, phy, lm_cmd);
if (err1)
goto cpi_exec_exit;
/* 5. PHY ACK should be deasserted in response */
err1 = ice_cpi_wait_ack0(hw, phy);
cpi_exec_exit:
if (!err)
err = err1;
mutex_unlock(cpi_lock);
return err;
}
/**
* ice_cpi_set_cmd - execute CPI SET command
* @hw: pointer to the HW struct
* @opcode: CPI command opcode
* @phy: phy index CPI command is applied for
* @port_lane: ephy index CPI command is applied for
* @data: CPI opcode context specific data
*
* Return: 0 on success, negative error code on failure.
*/
static int ice_cpi_set_cmd(struct ice_hw *hw, u8 opcode, u8 phy, u8 port_lane,
u16 data)
{
struct ice_cpi_resp cpi_resp = {0};
struct ice_cpi_cmd cpi_cmd = {
.opcode = opcode,
.set = true,
.port = port_lane,
.data = data,
};
return ice_cpi_exec(hw, phy, &cpi_cmd, &cpi_resp);
}
/**
* ice_cpi_ena_dis_clk_ref - enables/disables Tx reference clock on port
* @hw: pointer to the HW struct
* @phy: phy index of port for which Tx reference clock is enabled/disabled
* @clk: Tx reference clock to enable or disable
* @enable: bool value to enable or disable Tx reference clock
*
* This function executes CPI request to enable or disable specific
* Tx reference clock on given PHY.
*
* Return: 0 on success, negative error code on failure.
*/
int ice_cpi_ena_dis_clk_ref(struct ice_hw *hw, u8 phy,
enum ice_e825c_ref_clk clk, bool enable)
{
u16 val;
val = FIELD_PREP(CPI_OPCODE_PHY_CLK_PHY_SEL_M, phy) |
FIELD_PREP(CPI_OPCODE_PHY_CLK_REF_CTRL_M,
enable ? CPI_OPCODE_PHY_CLK_ENABLE :
CPI_OPCODE_PHY_CLK_DISABLE) |
FIELD_PREP(CPI_OPCODE_PHY_CLK_REF_SEL_M, clk);
return ice_cpi_set_cmd(hw, CPI_OPCODE_PHY_CLK, phy, 0, val);
}

View File

@ -0,0 +1,58 @@
/* SPDX-License-Identifier: GPL-2.0-only */
/* Copyright (C) 2026 Intel Corporation */
#ifndef _ICE_CPI_H_
#define _ICE_CPI_H_
#include "ice_type.h"
#include "ice_ptp_hw.h"
#define CPI0_PHY1_CMD_DATA 0x7FD028
#define CPI0_LM1_CMD_DATA 0x7FD024
#define CPI_RETRIES_COUNT 10
#define CPI_RETRIES_CADENCE_MS 100
/* CPI PHY CMD DATA register (CPI0_PHY1_CMD_DATA) */
#define CPI_PHY_CMD_DATA_M GENMASK(15, 0)
#define CPI_PHY_CMD_OPCODE_M GENMASK(23, 16)
#define CPI_PHY_CMD_PORTLANE_M GENMASK(26, 24)
#define CPI_PHY_CMD_RSVD_M GENMASK(29, 27)
#define CPI_PHY_CMD_ERROR_M BIT(30)
#define CPI_PHY_CMD_ACK_M BIT(31)
/* CPI LM CMD DATA register (CPI0_LM1_CMD_DATA) */
#define CPI_LM_CMD_DATA_M GENMASK(15, 0)
#define CPI_LM_CMD_OPCODE_M GENMASK(23, 16)
#define CPI_LM_CMD_PORTLANE_M GENMASK(26, 24)
#define CPI_LM_CMD_RSVD_M GENMASK(28, 27)
#define CPI_LM_CMD_GET_SET_M BIT(29)
#define CPI_LM_CMD_REQ_M BIT(31)
#define CPI_OPCODE_PHY_CLK 0xF1
#define CPI_OPCODE_PHY_CLK_PHY_SEL_M GENMASK(9, 6)
#define CPI_OPCODE_PHY_CLK_REF_CTRL_M GENMASK(5, 4)
#define CPI_OPCODE_PHY_CLK_DISABLE 1
#define CPI_OPCODE_PHY_CLK_ENABLE 2
#define CPI_OPCODE_PHY_CLK_REF_SEL_M GENMASK(3, 0)
#define CPI_LM_CMD_REQ 1
struct ice_cpi_cmd {
u8 port;
u8 opcode;
u16 data;
bool set;
};
struct ice_cpi_resp {
u8 port;
u8 opcode;
u16 data;
};
int ice_cpi_exec(struct ice_hw *hw, u8 phy,
const struct ice_cpi_cmd *cmd,
struct ice_cpi_resp *resp);
int ice_cpi_ena_dis_clk_ref(struct ice_hw *hw, u8 phy,
enum ice_e825c_ref_clk clk, bool enable);
#endif /* _ICE_CPI_H_ */

View File

@ -4712,6 +4712,17 @@ static void ice_dpll_init_e825(struct ice_pf *pf)
struct ice_dplls *d = &pf->dplls;
int err;
/* E825 sets ICE_F_PHY_RCLK unconditionally, so DPLL may run without
* PTP. Populate the HW-topology fields the TX-clk path divides by,
* otherwise userspace can trigger div-by-zero in ice_txclk_set_clk().
* When PTP is supported, ice_ptp_init() handles this.
*/
if (!test_bit(ICE_FLAG_PTP_SUPPORTED, pf->flags)) {
ice_ptp_init_hw(&pf->hw);
if (pf->hw.lane_num >= 0)
pf->ptp.port.port_num = pf->hw.lane_num;
}
mutex_init(&d->lock);
init_completion(&d->dpll_init);

View File

@ -54,8 +54,9 @@ enum ice_sbq_dev_id {
};
enum ice_sbq_msg_opcode {
ice_sbq_msg_rd = 0x00,
ice_sbq_msg_wr = 0x01
ice_sbq_msg_rd = 0x00,
ice_sbq_msg_wr = 0x01,
ice_sbq_msg_wr_np = 0x02
};
#define ICE_SBQ_MSG_FLAGS 0x40

View File

@ -893,6 +893,8 @@ struct ice_ptp_hw {
u8 ports_per_phy;
};
#define ICE_E825_MAX_PHYS 2
/* Port hardware description */
struct ice_hw {
u8 __iomem *hw_addr;