[linux-block.git] / include / linux / sfp.h

#ifndef LINUX_SFP_H
#define LINUX_SFP_H

#include <linux/phy.h>

struct sfp_eeprom_base {
	u8 phys_id;
	u8 phys_ext_id;
	u8 connector;
#if defined __BIG_ENDIAN_BITFIELD
	u8 e10g_base_er:1;
	u8 e10g_base_lrm:1;
	u8 e10g_base_lr:1;
	u8 e10g_base_sr:1;
	u8 if_1x_sx:1;
	u8 if_1x_lx:1;
	u8 if_1x_copper_active:1;
	u8 if_1x_copper_passive:1;

	u8 escon_mmf_1310_led:1;
	u8 escon_smf_1310_laser:1;
	u8 sonet_oc192_short_reach:1;
	u8 sonet_reach_bit1:1;
	u8 sonet_reach_bit2:1;
	u8 sonet_oc48_long_reach:1;
	u8 sonet_oc48_intermediate_reach:1;
	u8 sonet_oc48_short_reach:1;

	u8 unallocated_5_7:1;
	u8 sonet_oc12_smf_long_reach:1;
	u8 sonet_oc12_smf_intermediate_reach:1;
	u8 sonet_oc12_short_reach:1;
	u8 unallocated_5_3:1;
	u8 sonet_oc3_smf_long_reach:1;
	u8 sonet_oc3_smf_intermediate_reach:1;
	u8 sonet_oc3_short_reach:1;

	u8 e_base_px:1;
	u8 e_base_bx10:1;
	u8 e100_base_fx:1;
	u8 e100_base_lx:1;
	u8 e1000_base_t:1;
	u8 e1000_base_cx:1;
	u8 e1000_base_lx:1;
	u8 e1000_base_sx:1;

	u8 fc_ll_v:1;
	u8 fc_ll_s:1;
	u8 fc_ll_i:1;
	u8 fc_ll_l:1;
	u8 fc_ll_m:1;
	u8 fc_tech_sa:1;
	u8 fc_tech_lc:1;
	u8 fc_tech_electrical_inter_enclosure:1;

	u8 fc_tech_electrical_intra_enclosure:1;
	u8 fc_tech_sn:1;
	u8 fc_tech_sl:1;
	u8 fc_tech_ll:1;
	u8 sfp_ct_active:1;
	u8 sfp_ct_passive:1;
	u8 unallocated_8_1:1;
	u8 unallocated_8_0:1;

	u8 fc_media_tw:1;
	u8 fc_media_tp:1;
	u8 fc_media_mi:1;
	u8 fc_media_tv:1;
	u8 fc_media_m6:1;
	u8 fc_media_m5:1;
	u8 unallocated_9_1:1;
	u8 fc_media_sm:1;

	u8 fc_speed_1200:1;
	u8 fc_speed_800:1;
	u8 fc_speed_1600:1;
	u8 fc_speed_400:1;
	u8 fc_speed_3200:1;
	u8 fc_speed_200:1;
	u8 unallocated_10_1:1;
	u8 fc_speed_100:1;
#elif defined __LITTLE_ENDIAN_BITFIELD
	u8 if_1x_copper_passive:1;
	u8 if_1x_copper_active:1;
	u8 if_1x_lx:1;
	u8 if_1x_sx:1;
	u8 e10g_base_sr:1;
	u8 e10g_base_lr:1;
	u8 e10g_base_lrm:1;
	u8 e10g_base_er:1;

	u8 sonet_oc3_short_reach:1;
	u8 sonet_oc3_smf_intermediate_reach:1;
	u8 sonet_oc3_smf_long_reach:1;
	u8 unallocated_5_3:1;
	u8 sonet_oc12_short_reach:1;
	u8 sonet_oc12_smf_intermediate_reach:1;
	u8 sonet_oc12_smf_long_reach:1;
	u8 unallocated_5_7:1;

	u8 sonet_oc48_short_reach:1;
	u8 sonet_oc48_intermediate_reach:1;
	u8 sonet_oc48_long_reach:1;
	u8 sonet_reach_bit2:1;
	u8 sonet_reach_bit1:1;
	u8 sonet_oc192_short_reach:1;
	u8 escon_smf_1310_laser:1;
	u8 escon_mmf_1310_led:1;

	u8 e1000_base_sx:1;
	u8 e1000_base_lx:1;
	u8 e1000_base_cx:1;
	u8 e1000_base_t:1;
	u8 e100_base_lx:1;
	u8 e100_base_fx:1;
	u8 e_base_bx10:1;
	u8 e_base_px:1;

	u8 fc_tech_electrical_inter_enclosure:1;
	u8 fc_tech_lc:1;
	u8 fc_tech_sa:1;
	u8 fc_ll_m:1;
	u8 fc_ll_l:1;
	u8 fc_ll_i:1;
	u8 fc_ll_s:1;
	u8 fc_ll_v:1;

	u8 unallocated_8_0:1;
	u8 unallocated_8_1:1;
	u8 sfp_ct_passive:1;
	u8 sfp_ct_active:1;
	u8 fc_tech_ll:1;
	u8 fc_tech_sl:1;
	u8 fc_tech_sn:1;
	u8 fc_tech_electrical_intra_enclosure:1;

	u8 fc_media_sm:1;
	u8 unallocated_9_1:1;
	u8 fc_media_m5:1;
	u8 fc_media_m6:1;
	u8 fc_media_tv:1;
	u8 fc_media_mi:1;
	u8 fc_media_tp:1;
	u8 fc_media_tw:1;

	u8 fc_speed_100:1;
	u8 unallocated_10_1:1;
	u8 fc_speed_200:1;
	u8 fc_speed_3200:1;
	u8 fc_speed_400:1;
	u8 fc_speed_1600:1;
	u8 fc_speed_800:1;
	u8 fc_speed_1200:1;
#else
#error Unknown Endian
#endif
	u8 encoding;
	u8 br_nominal;
	u8 rate_id;
	u8 link_len[6];
	char vendor_name[16];
	u8 extended_cc;
	char vendor_oui[3];
	char vendor_pn[16];
	char vendor_rev[4];
	union {
		__be16 optical_wavelength;
		__be16 cable_compliance;
		struct {
#if defined __BIG_ENDIAN_BITFIELD
			u8 reserved60_2:6;
			u8 fc_pi_4_app_h:1;
			u8 sff8431_app_e:1;
			u8 reserved61:8;
#elif defined __LITTLE_ENDIAN_BITFIELD
			u8 sff8431_app_e:1;
			u8 fc_pi_4_app_h:1;
			u8 reserved60_2:6;
			u8 reserved61:8;
#else
#error Unknown Endian
#endif
		} __packed passive;
		struct {
#if defined __BIG_ENDIAN_BITFIELD
			u8 reserved60_4:4;
			u8 fc_pi_4_lim:1;
			u8 sff8431_lim:1;
			u8 fc_pi_4_app_h:1;
			u8 sff8431_app_e:1;
			u8 reserved61:8;
#elif defined __LITTLE_ENDIAN_BITFIELD
			u8 sff8431_app_e:1;
			u8 fc_pi_4_app_h:1;
			u8 sff8431_lim:1;
			u8 fc_pi_4_lim:1;
			u8 reserved60_4:4;
			u8 reserved61:8;
#else
#error Unknown Endian
#endif
		} __packed active;
	} __packed;
	u8 reserved62;
	u8 cc_base;
} __packed;

struct sfp_eeprom_ext {
	__be16 options;
	u8 br_max;
	u8 br_min;
	char vendor_sn[16];
	char datecode[8];
	u8 diagmon;
	u8 enhopts;
	u8 sff8472_compliance;
	u8 cc_ext;
} __packed;

/**
 * struct sfp_eeprom_id - raw SFP module identification information
 * @base: base SFP module identification structure
 * @ext: extended SFP module identification structure
 *
 * See the SFF-8472 specification and related documents for the definition
 * of these structure members. This can be obtained from
 * https://www.snia.org/technology-communities/sff/specifications
 */
struct sfp_eeprom_id {
	struct sfp_eeprom_base base;
	struct sfp_eeprom_ext ext;
} __packed;

struct sfp_diag {
	__be16 temp_high_alarm;
	__be16 temp_low_alarm;
	__be16 temp_high_warn;
	__be16 temp_low_warn;
	__be16 volt_high_alarm;
	__be16 volt_low_alarm;
	__be16 volt_high_warn;
	__be16 volt_low_warn;
	__be16 bias_high_alarm;
	__be16 bias_low_alarm;
	__be16 bias_high_warn;
	__be16 bias_low_warn;
	__be16 txpwr_high_alarm;
	__be16 txpwr_low_alarm;
	__be16 txpwr_high_warn;
	__be16 txpwr_low_warn;
	__be16 rxpwr_high_alarm;
	__be16 rxpwr_low_alarm;
	__be16 rxpwr_high_warn;
	__be16 rxpwr_low_warn;
	__be16 laser_temp_high_alarm;
	__be16 laser_temp_low_alarm;
	__be16 laser_temp_high_warn;
	__be16 laser_temp_low_warn;
	__be16 tec_cur_high_alarm;
	__be16 tec_cur_low_alarm;
	__be16 tec_cur_high_warn;
	__be16 tec_cur_low_warn;
	__be32 cal_rxpwr4;
	__be32 cal_rxpwr3;
	__be32 cal_rxpwr2;
	__be32 cal_rxpwr1;
	__be32 cal_rxpwr0;
	__be16 cal_txi_slope;
	__be16 cal_txi_offset;
	__be16 cal_txpwr_slope;
	__be16 cal_txpwr_offset;
	__be16 cal_t_slope;
	__be16 cal_t_offset;
	__be16 cal_v_slope;
	__be16 cal_v_offset;
} __packed;

/* SFF8024 defined constants */
enum {
	SFF8024_ID_UNK			= 0x00,
	SFF8024_ID_SFF_8472		= 0x02,
	SFF8024_ID_SFP			= 0x03,
	SFF8024_ID_DWDM_SFP		= 0x0b,
	SFF8024_ID_QSFP_8438		= 0x0c,
	SFF8024_ID_QSFP_8436_8636	= 0x0d,
	SFF8024_ID_QSFP28_8636		= 0x11,

	SFF8024_ENCODING_UNSPEC		= 0x00,
	SFF8024_ENCODING_8B10B		= 0x01,
	SFF8024_ENCODING_4B5B		= 0x02,
	SFF8024_ENCODING_NRZ		= 0x03,
	SFF8024_ENCODING_8472_MANCHESTER= 0x04,
	SFF8024_ENCODING_8472_SONET	= 0x05,
	SFF8024_ENCODING_8472_64B66B	= 0x06,
	SFF8024_ENCODING_8436_MANCHESTER= 0x06,
	SFF8024_ENCODING_8436_SONET	= 0x04,
	SFF8024_ENCODING_8436_64B66B	= 0x05,
	SFF8024_ENCODING_256B257B	= 0x07,
	SFF8024_ENCODING_PAM4		= 0x08,

	SFF8024_CONNECTOR_UNSPEC	= 0x00,
	/* codes 01-05 not supportable on SFP, but some modules have single SC */
	SFF8024_CONNECTOR_SC		= 0x01,
	SFF8024_CONNECTOR_FIBERJACK	= 0x06,
	SFF8024_CONNECTOR_LC		= 0x07,
	SFF8024_CONNECTOR_MT_RJ		= 0x08,
	SFF8024_CONNECTOR_MU		= 0x09,
	SFF8024_CONNECTOR_SG		= 0x0a,
	SFF8024_CONNECTOR_OPTICAL_PIGTAIL= 0x0b,
	SFF8024_CONNECTOR_MPO_1X12	= 0x0c,
	SFF8024_CONNECTOR_MPO_2X16	= 0x0d,
	SFF8024_CONNECTOR_HSSDC_II	= 0x20,
	SFF8024_CONNECTOR_COPPER_PIGTAIL= 0x21,
	SFF8024_CONNECTOR_RJ45		= 0x22,
	SFF8024_CONNECTOR_NOSEPARATE	= 0x23,
	SFF8024_CONNECTOR_MXC_2X16	= 0x24,

	SFF8024_ECC_UNSPEC		= 0x00,
	SFF8024_ECC_100G_25GAUI_C2M_AOC	= 0x01,
	SFF8024_ECC_100GBASE_SR4_25GBASE_SR = 0x02,
	SFF8024_ECC_100GBASE_LR4_25GBASE_LR = 0x03,
	SFF8024_ECC_100GBASE_ER4_25GBASE_ER = 0x04,
	SFF8024_ECC_100GBASE_SR10	= 0x05,
	SFF8024_ECC_100GBASE_CR4	= 0x0b,
	SFF8024_ECC_25GBASE_CR_S	= 0x0c,
	SFF8024_ECC_25GBASE_CR_N	= 0x0d,
	SFF8024_ECC_10GBASE_T_SFI	= 0x16,
	SFF8024_ECC_10GBASE_T_SR	= 0x1c,
	SFF8024_ECC_5GBASE_T		= 0x1d,
	SFF8024_ECC_2_5GBASE_T		= 0x1e,
};

/* SFP EEPROM registers */
enum {
	SFP_PHYS_ID			= 0,

	SFP_PHYS_EXT_ID			= 1,
	SFP_PHYS_EXT_ID_SFP		= 0x04,

	SFP_CONNECTOR			= 2,
	SFP_COMPLIANCE			= 3,
	SFP_ENCODING			= 11,
	SFP_BR_NOMINAL			= 12,
	SFP_RATE_ID			= 13,
	SFP_LINK_LEN_SM_KM		= 14,
	SFP_LINK_LEN_SM_100M		= 15,
	SFP_LINK_LEN_50UM_OM2_10M	= 16,
	SFP_LINK_LEN_62_5UM_OM1_10M	= 17,
	SFP_LINK_LEN_COPPER_1M		= 18,
	SFP_LINK_LEN_50UM_OM4_10M	= 18,
	SFP_LINK_LEN_50UM_OM3_10M	= 19,
	SFP_VENDOR_NAME			= 20,
	SFP_VENDOR_OUI			= 37,
	SFP_VENDOR_PN			= 40,
	SFP_VENDOR_REV			= 56,
	SFP_OPTICAL_WAVELENGTH_MSB	= 60,
	SFP_OPTICAL_WAVELENGTH_LSB	= 61,
	SFP_CABLE_SPEC			= 60,
	SFP_CC_BASE			= 63,

	SFP_OPTIONS			= 64,	/* 2 bytes, MSB, LSB */
	SFP_OPTIONS_HIGH_POWER_LEVEL	= BIT(13),
	SFP_OPTIONS_PAGING_A2		= BIT(12),
	SFP_OPTIONS_RETIMER		= BIT(11),
	SFP_OPTIONS_COOLED_XCVR		= BIT(10),
	SFP_OPTIONS_POWER_DECL		= BIT(9),
	SFP_OPTIONS_RX_LINEAR_OUT	= BIT(8),
	SFP_OPTIONS_RX_DECISION_THRESH	= BIT(7),
	SFP_OPTIONS_TUNABLE_TX		= BIT(6),
	SFP_OPTIONS_RATE_SELECT		= BIT(5),
	SFP_OPTIONS_TX_DISABLE		= BIT(4),
	SFP_OPTIONS_TX_FAULT		= BIT(3),
	SFP_OPTIONS_LOS_INVERTED	= BIT(2),
	SFP_OPTIONS_LOS_NORMAL		= BIT(1),

	SFP_BR_MAX			= 66,
	SFP_BR_MIN			= 67,
	SFP_VENDOR_SN			= 68,
	SFP_DATECODE			= 84,

	SFP_DIAGMON			= 92,
	SFP_DIAGMON_DDM			= BIT(6),
	SFP_DIAGMON_INT_CAL		= BIT(5),
	SFP_DIAGMON_EXT_CAL		= BIT(4),
	SFP_DIAGMON_RXPWR_AVG		= BIT(3),
	SFP_DIAGMON_ADDRMODE		= BIT(2),

	SFP_ENHOPTS			= 93,
	SFP_ENHOPTS_ALARMWARN		= BIT(7),
	SFP_ENHOPTS_SOFT_TX_DISABLE	= BIT(6),
	SFP_ENHOPTS_SOFT_TX_FAULT	= BIT(5),
	SFP_ENHOPTS_SOFT_RX_LOS		= BIT(4),
	SFP_ENHOPTS_SOFT_RATE_SELECT	= BIT(3),
	SFP_ENHOPTS_APP_SELECT_SFF8079	= BIT(2),
	SFP_ENHOPTS_SOFT_RATE_SFF8431	= BIT(1),

	SFP_SFF8472_COMPLIANCE		= 94,
	SFP_SFF8472_COMPLIANCE_NONE	= 0x00,
	SFP_SFF8472_COMPLIANCE_REV9_3	= 0x01,
	SFP_SFF8472_COMPLIANCE_REV9_5	= 0x02,
	SFP_SFF8472_COMPLIANCE_REV10_2	= 0x03,
	SFP_SFF8472_COMPLIANCE_REV10_4	= 0x04,
	SFP_SFF8472_COMPLIANCE_REV11_0	= 0x05,
	SFP_SFF8472_COMPLIANCE_REV11_3	= 0x06,
	SFP_SFF8472_COMPLIANCE_REV11_4	= 0x07,
	SFP_SFF8472_COMPLIANCE_REV12_0	= 0x08,

	SFP_CC_EXT			= 95,
};

/* SFP Diagnostics */
enum {
	/* Alarm and warnings stored MSB at lower address then LSB */
	SFP_TEMP_HIGH_ALARM		= 0,
	SFP_TEMP_LOW_ALARM		= 2,
	SFP_TEMP_HIGH_WARN		= 4,
	SFP_TEMP_LOW_WARN		= 6,
	SFP_VOLT_HIGH_ALARM		= 8,
	SFP_VOLT_LOW_ALARM		= 10,
	SFP_VOLT_HIGH_WARN		= 12,
	SFP_VOLT_LOW_WARN		= 14,
	SFP_BIAS_HIGH_ALARM		= 16,
	SFP_BIAS_LOW_ALARM		= 18,
	SFP_BIAS_HIGH_WARN		= 20,
	SFP_BIAS_LOW_WARN		= 22,
	SFP_TXPWR_HIGH_ALARM		= 24,
	SFP_TXPWR_LOW_ALARM		= 26,
	SFP_TXPWR_HIGH_WARN		= 28,
	SFP_TXPWR_LOW_WARN		= 30,
	SFP_RXPWR_HIGH_ALARM		= 32,
	SFP_RXPWR_LOW_ALARM		= 34,
	SFP_RXPWR_HIGH_WARN		= 36,
	SFP_RXPWR_LOW_WARN		= 38,
	SFP_LASER_TEMP_HIGH_ALARM	= 40,
	SFP_LASER_TEMP_LOW_ALARM	= 42,
	SFP_LASER_TEMP_HIGH_WARN	= 44,
	SFP_LASER_TEMP_LOW_WARN		= 46,
	SFP_TEC_CUR_HIGH_ALARM		= 48,
	SFP_TEC_CUR_LOW_ALARM		= 50,
	SFP_TEC_CUR_HIGH_WARN		= 52,
	SFP_TEC_CUR_LOW_WARN		= 54,
	SFP_CAL_RXPWR4			= 56,
	SFP_CAL_RXPWR3			= 60,
	SFP_CAL_RXPWR2			= 64,
	SFP_CAL_RXPWR1			= 68,
	SFP_CAL_RXPWR0			= 72,
	SFP_CAL_TXI_SLOPE		= 76,
	SFP_CAL_TXI_OFFSET		= 78,
	SFP_CAL_TXPWR_SLOPE		= 80,
	SFP_CAL_TXPWR_OFFSET		= 82,
	SFP_CAL_T_SLOPE			= 84,
	SFP_CAL_T_OFFSET		= 86,
	SFP_CAL_V_SLOPE			= 88,
	SFP_CAL_V_OFFSET		= 90,
	SFP_CHKSUM			= 95,

	SFP_TEMP			= 96,
	SFP_VCC				= 98,
	SFP_TX_BIAS			= 100,
	SFP_TX_POWER			= 102,
	SFP_RX_POWER			= 104,
	SFP_LASER_TEMP			= 106,
	SFP_TEC_CUR			= 108,

	SFP_STATUS			= 110,
	SFP_STATUS_TX_DISABLE		= BIT(7),
	SFP_STATUS_TX_DISABLE_FORCE	= BIT(6),
	SFP_STATUS_TX_FAULT		= BIT(2),
	SFP_STATUS_RX_LOS		= BIT(1),
	SFP_ALARM0			= 112,
	SFP_ALARM0_TEMP_HIGH		= BIT(7),
	SFP_ALARM0_TEMP_LOW		= BIT(6),
	SFP_ALARM0_VCC_HIGH		= BIT(5),
	SFP_ALARM0_VCC_LOW		= BIT(4),
	SFP_ALARM0_TX_BIAS_HIGH		= BIT(3),
	SFP_ALARM0_TX_BIAS_LOW		= BIT(2),
	SFP_ALARM0_TXPWR_HIGH		= BIT(1),
	SFP_ALARM0_TXPWR_LOW		= BIT(0),

	SFP_ALARM1			= 113,
	SFP_ALARM1_RXPWR_HIGH		= BIT(7),
	SFP_ALARM1_RXPWR_LOW		= BIT(6),

	SFP_WARN0			= 116,
	SFP_WARN0_TEMP_HIGH		= BIT(7),
	SFP_WARN0_TEMP_LOW		= BIT(6),
	SFP_WARN0_VCC_HIGH		= BIT(5),
	SFP_WARN0_VCC_LOW		= BIT(4),
	SFP_WARN0_TX_BIAS_HIGH		= BIT(3),
	SFP_WARN0_TX_BIAS_LOW		= BIT(2),
	SFP_WARN0_TXPWR_HIGH		= BIT(1),
	SFP_WARN0_TXPWR_LOW		= BIT(0),

	SFP_WARN1			= 117,
	SFP_WARN1_RXPWR_HIGH		= BIT(7),
	SFP_WARN1_RXPWR_LOW		= BIT(6),

	SFP_EXT_STATUS			= 118,
	SFP_EXT_STATUS_PWRLVL_SELECT	= BIT(0),

	SFP_VSL				= 120,
	SFP_PAGE			= 127,
};

struct fwnode_handle;
struct ethtool_eeprom;
struct ethtool_modinfo;
struct sfp_bus;

/**
 * struct sfp_upstream_ops - upstream operations structure
 * @attach: called when the sfp socket driver is bound to the upstream
 *   (mandatory).
 * @detach: called when the sfp socket driver is unbound from the upstream
 *   (mandatory).
 * @module_insert: called after a module has been detected to determine
 *   whether the module is supported for the upstream device.
 * @module_remove: called after the module has been removed.
 * @module_start: called after the PHY probe step
 * @module_stop: called before the PHY is removed
 * @link_down: called when the link is non-operational for whatever
 *   reason.
 * @link_up: called when the link is operational.
 * @connect_phy: called when an I2C accessible PHY has been detected
 *   on the module.
 * @disconnect_phy: called when a module with an I2C accessible PHY has
 *   been removed.
 */
struct sfp_upstream_ops {
	void (*attach)(void *priv, struct sfp_bus *bus);
	void (*detach)(void *priv, struct sfp_bus *bus);
	int (*module_insert)(void *priv, const struct sfp_eeprom_id *id);
	void (*module_remove)(void *priv);
	int (*module_start)(void *priv);
	void (*module_stop)(void *priv);
	void (*link_down)(void *priv);
	void (*link_up)(void *priv);
	int (*connect_phy)(void *priv, struct phy_device *);
	void (*disconnect_phy)(void *priv);
};

#if IS_ENABLED(CONFIG_SFP)
int sfp_parse_port(struct sfp_bus *bus, const struct sfp_eeprom_id *id,
		   unsigned long *support);
bool sfp_may_have_phy(struct sfp_bus *bus, const struct sfp_eeprom_id *id);
void sfp_parse_support(struct sfp_bus *bus, const struct sfp_eeprom_id *id,
		       unsigned long *support, unsigned long *interfaces);
phy_interface_t sfp_select_interface(struct sfp_bus *bus,
				     unsigned long *link_modes);

int sfp_get_module_info(struct sfp_bus *bus, struct ethtool_modinfo *modinfo);
int sfp_get_module_eeprom(struct sfp_bus *bus, struct ethtool_eeprom *ee,
			  u8 *data);
int sfp_get_module_eeprom_by_page(struct sfp_bus *bus,
				  const struct ethtool_module_eeprom *page,
				  struct netlink_ext_ack *extack);
void sfp_upstream_start(struct sfp_bus *bus);
void sfp_upstream_stop(struct sfp_bus *bus);
void sfp_bus_put(struct sfp_bus *bus);
struct sfp_bus *sfp_bus_find_fwnode(const struct fwnode_handle *fwnode);
int sfp_bus_add_upstream(struct sfp_bus *bus, void *upstream,
			 const struct sfp_upstream_ops *ops);
void sfp_bus_del_upstream(struct sfp_bus *bus);
#else
static inline int sfp_parse_port(struct sfp_bus *bus,
				 const struct sfp_eeprom_id *id,
				 unsigned long *support)
{
	return PORT_OTHER;
}

static inline bool sfp_may_have_phy(struct sfp_bus *bus,
				    const struct sfp_eeprom_id *id)
{
	return false;
}

static inline void sfp_parse_support(struct sfp_bus *bus,
				     const struct sfp_eeprom_id *id,
				     unsigned long *support,
				     unsigned long *interfaces)
{
}

static inline phy_interface_t sfp_select_interface(struct sfp_bus *bus,
						   unsigned long *link_modes)
{
	return PHY_INTERFACE_MODE_NA;
}

static inline int sfp_get_module_info(struct sfp_bus *bus,
				      struct ethtool_modinfo *modinfo)
{
	return -EOPNOTSUPP;
}

static inline int sfp_get_module_eeprom(struct sfp_bus *bus,
					struct ethtool_eeprom *ee, u8 *data)
{
	return -EOPNOTSUPP;
}

static inline int sfp_get_module_eeprom_by_page(struct sfp_bus *bus,
						const struct ethtool_module_eeprom *page,
						struct netlink_ext_ack *extack)
{
	return -EOPNOTSUPP;
}

static inline void sfp_upstream_start(struct sfp_bus *bus)
{
}

static inline void sfp_upstream_stop(struct sfp_bus *bus)
{
}

static inline void sfp_bus_put(struct sfp_bus *bus)
{
}

static inline struct sfp_bus *
sfp_bus_find_fwnode(const struct fwnode_handle *fwnode)
{
	return NULL;
}

static inline int sfp_bus_add_upstream(struct sfp_bus *bus, void *upstream,
				       const struct sfp_upstream_ops *ops)
{
	return 0;
}

static inline void sfp_bus_del_upstream(struct sfp_bus *bus)
{
}
#endif

#endif
Commit	Line	Data
ce0aa27f RK	1	#ifndef LINUX_SFP_H
	2	#define LINUX_SFP_H
	3
	4	#include <linux/phy.h>
	5
0a6fcd3f	6	struct sfp_eeprom_base {
ce0aa27f RK	7	u8 phys_id;
	8	u8 phys_ext_id;
	9	u8 connector;
	10	#if defined __BIG_ENDIAN_BITFIELD
	11	u8 e10g_base_er:1;
	12	u8 e10g_base_lrm:1;
	13	u8 e10g_base_lr:1;
	14	u8 e10g_base_sr:1;
	15	u8 if_1x_sx:1;
	16	u8 if_1x_lx:1;
	17	u8 if_1x_copper_active:1;
	18	u8 if_1x_copper_passive:1;
	19
	20	u8 escon_mmf_1310_led:1;
	21	u8 escon_smf_1310_laser:1;
	22	u8 sonet_oc192_short_reach:1;
	23	u8 sonet_reach_bit1:1;
	24	u8 sonet_reach_bit2:1;
	25	u8 sonet_oc48_long_reach:1;
	26	u8 sonet_oc48_intermediate_reach:1;
	27	u8 sonet_oc48_short_reach:1;
	28
	29	u8 unallocated_5_7:1;
	30	u8 sonet_oc12_smf_long_reach:1;
	31	u8 sonet_oc12_smf_intermediate_reach:1;
	32	u8 sonet_oc12_short_reach:1;
	33	u8 unallocated_5_3:1;
	34	u8 sonet_oc3_smf_long_reach:1;
	35	u8 sonet_oc3_smf_intermediate_reach:1;
	36	u8 sonet_oc3_short_reach:1;
	37
	38	u8 e_base_px:1;
	39	u8 e_base_bx10:1;
	40	u8 e100_base_fx:1;
	41	u8 e100_base_lx:1;
	42	u8 e1000_base_t:1;
	43	u8 e1000_base_cx:1;
	44	u8 e1000_base_lx:1;
	45	u8 e1000_base_sx:1;
	46
	47	u8 fc_ll_v:1;
	48	u8 fc_ll_s:1;
	49	u8 fc_ll_i:1;
	50	u8 fc_ll_l:1;
	51	u8 fc_ll_m:1;
	52	u8 fc_tech_sa:1;
	53	u8 fc_tech_lc:1;
	54	u8 fc_tech_electrical_inter_enclosure:1;
	55
	56	u8 fc_tech_electrical_intra_enclosure:1;
	57	u8 fc_tech_sn:1;
	58	u8 fc_tech_sl:1;
	59	u8 fc_tech_ll:1;
	60	u8 sfp_ct_active:1;
	61	u8 sfp_ct_passive:1;
	62	u8 unallocated_8_1:1;
	63	u8 unallocated_8_0:1;
	64
	65	u8 fc_media_tw:1;
	66	u8 fc_media_tp:1;
	67	u8 fc_media_mi:1;
	68	u8 fc_media_tv:1;
	69	u8 fc_media_m6:1;
	70	u8 fc_media_m5:1;
71	u8 unallocated_9_1:1;
72	u8 fc_media_sm:1;
73
74	u8 fc_speed_1200:1;
75	u8 fc_speed_800:1;
76	u8 fc_speed_1600:1;
77	u8 fc_speed_400:1;
78	u8 fc_speed_3200:1;
79	u8 fc_speed_200:1;
80	u8 unallocated_10_1:1;
81	u8 fc_speed_100:1;
82	#elif defined __LITTLE_ENDIAN_BITFIELD
83	u8 if_1x_copper_passive:1;
84	u8 if_1x_copper_active:1;
85	u8 if_1x_lx:1;
86	u8 if_1x_sx:1;
87	u8 e10g_base_sr:1;
88	u8 e10g_base_lr:1;
89	u8 e10g_base_lrm:1;
90	u8 e10g_base_er:1;
91
92	u8 sonet_oc3_short_reach:1;
93	u8 sonet_oc3_smf_intermediate_reach:1;
94	u8 sonet_oc3_smf_long_reach:1;
95	u8 unallocated_5_3:1;
96	u8 sonet_oc12_short_reach:1;
97	u8 sonet_oc12_smf_intermediate_reach:1;
98	u8 sonet_oc12_smf_long_reach:1;
99	u8 unallocated_5_7:1;
100
101	u8 sonet_oc48_short_reach:1;
102	u8 sonet_oc48_intermediate_reach:1;
103	u8 sonet_oc48_long_reach:1;
104	u8 sonet_reach_bit2:1;
105	u8 sonet_reach_bit1:1;
106	u8 sonet_oc192_short_reach:1;
107	u8 escon_smf_1310_laser:1;
108	u8 escon_mmf_1310_led:1;
109
110	u8 e1000_base_sx:1;
111	u8 e1000_base_lx:1;
112	u8 e1000_base_cx:1;
113	u8 e1000_base_t:1;
114	u8 e100_base_lx:1;
115	u8 e100_base_fx:1;
116	u8 e_base_bx10:1;
117	u8 e_base_px:1;
118
119	u8 fc_tech_electrical_inter_enclosure:1;
120	u8 fc_tech_lc:1;
121	u8 fc_tech_sa:1;
122	u8 fc_ll_m:1;
123	u8 fc_ll_l:1;
124	u8 fc_ll_i:1;
125	u8 fc_ll_s:1;
126	u8 fc_ll_v:1;
127
128	u8 unallocated_8_0:1;
129	u8 unallocated_8_1:1;
130	u8 sfp_ct_passive:1;
131	u8 sfp_ct_active:1;
132	u8 fc_tech_ll:1;
133	u8 fc_tech_sl:1;
134	u8 fc_tech_sn:1;
135	u8 fc_tech_electrical_intra_enclosure:1;
136
137	u8 fc_media_sm:1;
138	u8 unallocated_9_1:1;
139	u8 fc_media_m5:1;
140	u8 fc_media_m6:1;
141	u8 fc_media_tv:1;
142	u8 fc_media_mi:1;
143	u8 fc_media_tp:1;
144	u8 fc_media_tw:1;
145
146	u8 fc_speed_100:1;
147	u8 unallocated_10_1:1;
148	u8 fc_speed_200:1;
149	u8 fc_speed_3200:1;
150	u8 fc_speed_400:1;
151	u8 fc_speed_1600:1;
152	u8 fc_speed_800:1;
153	u8 fc_speed_1200:1;
154	#else
155	#error Unknown Endian
156	#endif
157	u8 encoding;
158	u8 br_nominal;
159	u8 rate_id;
160	u8 link_len[6];
161	char vendor_name[16];
162	u8 extended_cc;
163	char vendor_oui[3];
164	char vendor_pn[16];
165	char vendor_rev[4];
166	union {
167	__be16 optical_wavelength;
f10fcbcf RK	168	__be16 cable_compliance;
	169	struct {
	170	#if defined __BIG_ENDIAN_BITFIELD
	171	u8 reserved60_2:6;
	172	u8 fc_pi_4_app_h:1;
	173	u8 sff8431_app_e:1;
	174	u8 reserved61:8;
	175	#elif defined __LITTLE_ENDIAN_BITFIELD
	176	u8 sff8431_app_e:1;
	177	u8 fc_pi_4_app_h:1;
	178	u8 reserved60_2:6;
	179	u8 reserved61:8;
	180	#else
	181	#error Unknown Endian
	182	#endif
	183	} __packed passive;
	184	struct {
	185	#if defined __BIG_ENDIAN_BITFIELD
	186	u8 reserved60_4:4;
	187	u8 fc_pi_4_lim:1;
	188	u8 sff8431_lim:1;
	189	u8 fc_pi_4_app_h:1;
	190	u8 sff8431_app_e:1;
	191	u8 reserved61:8;
	192	#elif defined __LITTLE_ENDIAN_BITFIELD
	193	u8 sff8431_app_e:1;
	194	u8 fc_pi_4_app_h:1;
	195	u8 sff8431_lim:1;
	196	u8 fc_pi_4_lim:1;
	197	u8 reserved60_4:4;
	198	u8 reserved61:8;
	199	#else
	200	#error Unknown Endian
	201	#endif
	202	} __packed active;
0a6fcd3f	203	} __packed;
ce0aa27f RK	204	u8 reserved62;
ce0aa27f RK	205	u8 cc_base;
0a6fcd3f	206	} __packed;
ce0aa27f	207
0a6fcd3f	208	struct sfp_eeprom_ext {
ce0aa27f RK	209	__be16 options;
	210	u8 br_max;
	211	u8 br_min;
	212	char vendor_sn[16];
	213	char datecode[8];
	214	u8 diagmon;
	215	u8 enhopts;
	216	u8 sff8472_compliance;
	217	u8 cc_ext;
0a6fcd3f	218	} __packed;
ce0aa27f	219
0a6fcd3f RK	220	/**
	221	* struct sfp_eeprom_id - raw SFP module identification information
	222	* @base: base SFP module identification structure
	223	* @ext: extended SFP module identification structure
	224	*
	225	* See the SFF-8472 specification and related documents for the definition
	226	* of these structure members. This can be obtained from
90230968	227	* https://www.snia.org/technology-communities/sff/specifications
0a6fcd3f RK	228	*/
0a6fcd3f RK	229	struct sfp_eeprom_id {
ce0aa27f RK	230	struct sfp_eeprom_base base;
ce0aa27f RK	231	struct sfp_eeprom_ext ext;
0a6fcd3f	232	} __packed;
ce0aa27f	233
1323061a AL	234	struct sfp_diag {
	235	__be16 temp_high_alarm;
	236	__be16 temp_low_alarm;
	237	__be16 temp_high_warn;
	238	__be16 temp_low_warn;
	239	__be16 volt_high_alarm;
	240	__be16 volt_low_alarm;
	241	__be16 volt_high_warn;
	242	__be16 volt_low_warn;
	243	__be16 bias_high_alarm;
	244	__be16 bias_low_alarm;
	245	__be16 bias_high_warn;
	246	__be16 bias_low_warn;
	247	__be16 txpwr_high_alarm;
	248	__be16 txpwr_low_alarm;
	249	__be16 txpwr_high_warn;
	250	__be16 txpwr_low_warn;
	251	__be16 rxpwr_high_alarm;
	252	__be16 rxpwr_low_alarm;
	253	__be16 rxpwr_high_warn;
	254	__be16 rxpwr_low_warn;
	255	__be16 laser_temp_high_alarm;
	256	__be16 laser_temp_low_alarm;
	257	__be16 laser_temp_high_warn;
	258	__be16 laser_temp_low_warn;
	259	__be16 tec_cur_high_alarm;
	260	__be16 tec_cur_low_alarm;
	261	__be16 tec_cur_high_warn;
	262	__be16 tec_cur_low_warn;
	263	__be32 cal_rxpwr4;
	264	__be32 cal_rxpwr3;
	265	__be32 cal_rxpwr2;
	266	__be32 cal_rxpwr1;
	267	__be32 cal_rxpwr0;
	268	__be16 cal_txi_slope;
	269	__be16 cal_txi_offset;
	270	__be16 cal_txpwr_slope;
	271	__be16 cal_txpwr_offset;
	272	__be16 cal_t_slope;
	273	__be16 cal_t_offset;
	274	__be16 cal_v_slope;
	275	__be16 cal_v_offset;
	276	} __packed;
	277
0fbd26a9 RK	278	/* SFF8024 defined constants */
	279	enum {
	280	SFF8024_ID_UNK = 0x00,
	281	SFF8024_ID_SFF_8472 = 0x02,
	282	SFF8024_ID_SFP = 0x03,
	283	SFF8024_ID_DWDM_SFP = 0x0b,
	284	SFF8024_ID_QSFP_8438 = 0x0c,
	285	SFF8024_ID_QSFP_8436_8636 = 0x0d,
	286	SFF8024_ID_QSFP28_8636 = 0x11,
	287
	288	SFF8024_ENCODING_UNSPEC = 0x00,
	289	SFF8024_ENCODING_8B10B = 0x01,
	290	SFF8024_ENCODING_4B5B = 0x02,
	291	SFF8024_ENCODING_NRZ = 0x03,
	292	SFF8024_ENCODING_8472_MANCHESTER= 0x04,
	293	SFF8024_ENCODING_8472_SONET = 0x05,
	294	SFF8024_ENCODING_8472_64B66B = 0x06,
	295	SFF8024_ENCODING_8436_MANCHESTER= 0x06,
	296	SFF8024_ENCODING_8436_SONET = 0x04,
	297	SFF8024_ENCODING_8436_64B66B = 0x05,
	298	SFF8024_ENCODING_256B257B = 0x07,
	299	SFF8024_ENCODING_PAM4 = 0x08,
	300
	301	SFF8024_CONNECTOR_UNSPEC = 0x00,
	302	/* codes 01-05 not supportable on SFP, but some modules have single SC */
	303	SFF8024_CONNECTOR_SC = 0x01,
	304	SFF8024_CONNECTOR_FIBERJACK = 0x06,
	305	SFF8024_CONNECTOR_LC = 0x07,
	306	SFF8024_CONNECTOR_MT_RJ = 0x08,
	307	SFF8024_CONNECTOR_MU = 0x09,
	308	SFF8024_CONNECTOR_SG = 0x0a,
	309	SFF8024_CONNECTOR_OPTICAL_PIGTAIL= 0x0b,
	310	SFF8024_CONNECTOR_MPO_1X12 = 0x0c,
	311	SFF8024_CONNECTOR_MPO_2X16 = 0x0d,
	312	SFF8024_CONNECTOR_HSSDC_II = 0x20,
	313	SFF8024_CONNECTOR_COPPER_PIGTAIL= 0x21,
	314	SFF8024_CONNECTOR_RJ45 = 0x22,
	315	SFF8024_CONNECTOR_NOSEPARATE = 0x23,
	316	SFF8024_CONNECTOR_MXC_2X16 = 0x24,
	317
	318	SFF8024_ECC_UNSPEC = 0x00,
	319	SFF8024_ECC_100G_25GAUI_C2M_AOC = 0x01,
	320	SFF8024_ECC_100GBASE_SR4_25GBASE_SR = 0x02,
	321	SFF8024_ECC_100GBASE_LR4_25GBASE_LR = 0x03,
	322	SFF8024_ECC_100GBASE_ER4_25GBASE_ER = 0x04,
	323	SFF8024_ECC_100GBASE_SR10 = 0x05,
	324	SFF8024_ECC_100GBASE_CR4 = 0x0b,
	325	SFF8024_ECC_25GBASE_CR_S = 0x0c,
	326	SFF8024_ECC_25GBASE_CR_N = 0x0d,
	327	SFF8024_ECC_10GBASE_T_SFI = 0x16,
	328	SFF8024_ECC_10GBASE_T_SR = 0x1c,
	329	SFF8024_ECC_5GBASE_T = 0x1d,
	330	SFF8024_ECC_2_5GBASE_T = 0x1e,
	331	};
	332
ce0aa27f RK	333	/* SFP EEPROM registers */
ce0aa27f RK	334	enum {
17dd3611	335	SFP_PHYS_ID = 0,
d83845d2	336
17dd3611	337	SFP_PHYS_EXT_ID = 1,
d83845d2 RKO	338	SFP_PHYS_EXT_ID_SFP = 0x04,
d83845d2 RKO	339
17dd3611 RKO	340	SFP_CONNECTOR = 2,
	341	SFP_COMPLIANCE = 3,
	342	SFP_ENCODING = 11,
	343	SFP_BR_NOMINAL = 12,
	344	SFP_RATE_ID = 13,
	345	SFP_LINK_LEN_SM_KM = 14,
	346	SFP_LINK_LEN_SM_100M = 15,
	347	SFP_LINK_LEN_50UM_OM2_10M = 16,
	348	SFP_LINK_LEN_62_5UM_OM1_10M = 17,
	349	SFP_LINK_LEN_COPPER_1M = 18,
	350	SFP_LINK_LEN_50UM_OM4_10M = 18,
	351	SFP_LINK_LEN_50UM_OM3_10M = 19,
	352	SFP_VENDOR_NAME = 20,
	353	SFP_VENDOR_OUI = 37,
	354	SFP_VENDOR_PN = 40,
	355	SFP_VENDOR_REV = 56,
	356	SFP_OPTICAL_WAVELENGTH_MSB = 60,
	357	SFP_OPTICAL_WAVELENGTH_LSB = 61,
	358	SFP_CABLE_SPEC = 60,
	359	SFP_CC_BASE = 63,
ce0aa27f	360
d83845d2	361	SFP_OPTIONS = 64, /* 2 bytes, MSB, LSB */
ce0aa27f RK	362	SFP_OPTIONS_HIGH_POWER_LEVEL = BIT(13),
	363	SFP_OPTIONS_PAGING_A2 = BIT(12),
	364	SFP_OPTIONS_RETIMER = BIT(11),
	365	SFP_OPTIONS_COOLED_XCVR = BIT(10),
	366	SFP_OPTIONS_POWER_DECL = BIT(9),
	367	SFP_OPTIONS_RX_LINEAR_OUT = BIT(8),
	368	SFP_OPTIONS_RX_DECISION_THRESH = BIT(7),
	369	SFP_OPTIONS_TUNABLE_TX = BIT(6),
	370	SFP_OPTIONS_RATE_SELECT = BIT(5),
	371	SFP_OPTIONS_TX_DISABLE = BIT(4),
	372	SFP_OPTIONS_TX_FAULT = BIT(3),
	373	SFP_OPTIONS_LOS_INVERTED = BIT(2),
	374	SFP_OPTIONS_LOS_NORMAL = BIT(1),
d83845d2 RKO	375
	376	SFP_BR_MAX = 66,
	377	SFP_BR_MIN = 67,
	378	SFP_VENDOR_SN = 68,
	379	SFP_DATECODE = 84,
	380
	381	SFP_DIAGMON = 92,
ce0aa27f RK	382	SFP_DIAGMON_DDM = BIT(6),
	383	SFP_DIAGMON_INT_CAL = BIT(5),
	384	SFP_DIAGMON_EXT_CAL = BIT(4),
	385	SFP_DIAGMON_RXPWR_AVG = BIT(3),
	386	SFP_DIAGMON_ADDRMODE = BIT(2),
d83845d2 RKO	387
d83845d2 RKO	388	SFP_ENHOPTS = 93,
ce0aa27f RK	389	SFP_ENHOPTS_ALARMWARN = BIT(7),
	390	SFP_ENHOPTS_SOFT_TX_DISABLE = BIT(6),
	391	SFP_ENHOPTS_SOFT_TX_FAULT = BIT(5),
	392	SFP_ENHOPTS_SOFT_RX_LOS = BIT(4),
	393	SFP_ENHOPTS_SOFT_RATE_SELECT = BIT(3),
	394	SFP_ENHOPTS_APP_SELECT_SFF8079 = BIT(2),
	395	SFP_ENHOPTS_SOFT_RATE_SFF8431 = BIT(1),
d83845d2 RKO	396
d83845d2 RKO	397	SFP_SFF8472_COMPLIANCE = 94,
ce0aa27f RK	398	SFP_SFF8472_COMPLIANCE_NONE = 0x00,
	399	SFP_SFF8472_COMPLIANCE_REV9_3 = 0x01,
	400	SFP_SFF8472_COMPLIANCE_REV9_5 = 0x02,
	401	SFP_SFF8472_COMPLIANCE_REV10_2 = 0x03,
	402	SFP_SFF8472_COMPLIANCE_REV10_4 = 0x04,
	403	SFP_SFF8472_COMPLIANCE_REV11_0 = 0x05,
	404	SFP_SFF8472_COMPLIANCE_REV11_3 = 0x06,
	405	SFP_SFF8472_COMPLIANCE_REV11_4 = 0x07,
	406	SFP_SFF8472_COMPLIANCE_REV12_0 = 0x08,
d83845d2 RKO	407
d83845d2 RKO	408	SFP_CC_EXT = 95,
ce0aa27f RK	409	};
	410
	411	/* SFP Diagnostics */
	412	enum {
	413	/* Alarm and warnings stored MSB at lower address then LSB */
17dd3611 RKO	414	SFP_TEMP_HIGH_ALARM = 0,
	415	SFP_TEMP_LOW_ALARM = 2,
	416	SFP_TEMP_HIGH_WARN = 4,
	417	SFP_TEMP_LOW_WARN = 6,
	418	SFP_VOLT_HIGH_ALARM = 8,
	419	SFP_VOLT_LOW_ALARM = 10,
	420	SFP_VOLT_HIGH_WARN = 12,
	421	SFP_VOLT_LOW_WARN = 14,
	422	SFP_BIAS_HIGH_ALARM = 16,
	423	SFP_BIAS_LOW_ALARM = 18,
	424	SFP_BIAS_HIGH_WARN = 20,
	425	SFP_BIAS_LOW_WARN = 22,
	426	SFP_TXPWR_HIGH_ALARM = 24,
	427	SFP_TXPWR_LOW_ALARM = 26,
	428	SFP_TXPWR_HIGH_WARN = 28,
	429	SFP_TXPWR_LOW_WARN = 30,
	430	SFP_RXPWR_HIGH_ALARM = 32,
	431	SFP_RXPWR_LOW_ALARM = 34,
	432	SFP_RXPWR_HIGH_WARN = 36,
	433	SFP_RXPWR_LOW_WARN = 38,
	434	SFP_LASER_TEMP_HIGH_ALARM = 40,
	435	SFP_LASER_TEMP_LOW_ALARM = 42,
	436	SFP_LASER_TEMP_HIGH_WARN = 44,
	437	SFP_LASER_TEMP_LOW_WARN = 46,
	438	SFP_TEC_CUR_HIGH_ALARM = 48,
	439	SFP_TEC_CUR_LOW_ALARM = 50,
	440	SFP_TEC_CUR_HIGH_WARN = 52,
	441	SFP_TEC_CUR_LOW_WARN = 54,
	442	SFP_CAL_RXPWR4 = 56,
	443	SFP_CAL_RXPWR3 = 60,
	444	SFP_CAL_RXPWR2 = 64,
	445	SFP_CAL_RXPWR1 = 68,
	446	SFP_CAL_RXPWR0 = 72,
	447	SFP_CAL_TXI_SLOPE = 76,
	448	SFP_CAL_TXI_OFFSET = 78,
	449	SFP_CAL_TXPWR_SLOPE = 80,
	450	SFP_CAL_TXPWR_OFFSET = 82,
	451	SFP_CAL_T_SLOPE = 84,
	452	SFP_CAL_T_OFFSET = 86,
	453	SFP_CAL_V_SLOPE = 88,
	454	SFP_CAL_V_OFFSET = 90,
	455	SFP_CHKSUM = 95,
	456
	457	SFP_TEMP = 96,
	458	SFP_VCC = 98,
	459	SFP_TX_BIAS = 100,
	460	SFP_TX_POWER = 102,
	461	SFP_RX_POWER = 104,
	462	SFP_LASER_TEMP = 106,
	463	SFP_TEC_CUR = 108,
	464
	465	SFP_STATUS = 110,
f3c9a666 RK	466	SFP_STATUS_TX_DISABLE = BIT(7),
	467	SFP_STATUS_TX_DISABLE_FORCE = BIT(6),
	468	SFP_STATUS_TX_FAULT = BIT(2),
	469	SFP_STATUS_RX_LOS = BIT(1),
17dd3611	470	SFP_ALARM0 = 112,
1323061a AL	471	SFP_ALARM0_TEMP_HIGH = BIT(7),
	472	SFP_ALARM0_TEMP_LOW = BIT(6),
	473	SFP_ALARM0_VCC_HIGH = BIT(5),
	474	SFP_ALARM0_VCC_LOW = BIT(4),
	475	SFP_ALARM0_TX_BIAS_HIGH = BIT(3),
	476	SFP_ALARM0_TX_BIAS_LOW = BIT(2),
	477	SFP_ALARM0_TXPWR_HIGH = BIT(1),
	478	SFP_ALARM0_TXPWR_LOW = BIT(0),
	479
17dd3611	480	SFP_ALARM1 = 113,
1323061a AL	481	SFP_ALARM1_RXPWR_HIGH = BIT(7),
	482	SFP_ALARM1_RXPWR_LOW = BIT(6),
	483
17dd3611	484	SFP_WARN0 = 116,
1323061a AL	485	SFP_WARN0_TEMP_HIGH = BIT(7),
	486	SFP_WARN0_TEMP_LOW = BIT(6),
	487	SFP_WARN0_VCC_HIGH = BIT(5),
	488	SFP_WARN0_VCC_LOW = BIT(4),
	489	SFP_WARN0_TX_BIAS_HIGH = BIT(3),
	490	SFP_WARN0_TX_BIAS_LOW = BIT(2),
	491	SFP_WARN0_TXPWR_HIGH = BIT(1),
	492	SFP_WARN0_TXPWR_LOW = BIT(0),
	493
17dd3611	494	SFP_WARN1 = 117,
1323061a AL	495	SFP_WARN1_RXPWR_HIGH = BIT(7),
1323061a AL	496	SFP_WARN1_RXPWR_LOW = BIT(6),
ce0aa27f	497
17dd3611	498	SFP_EXT_STATUS = 118,
39890049 RKO	499	SFP_EXT_STATUS_PWRLVL_SELECT = BIT(0),
39890049 RKO	500
17dd3611 RKO	501	SFP_VSL = 120,
17dd3611 RKO	502	SFP_PAGE = 127,
ce0aa27f RK	503	};
ce0aa27f RK	504
c19bb000	505	struct fwnode_handle;
ce0aa27f RK	506	struct ethtool_eeprom;
ce0aa27f RK	507	struct ethtool_modinfo;
ce0aa27f RK	508	struct sfp_bus;
ce0aa27f RK	509
0a6fcd3f RK	510	/**
0a6fcd3f RK	511	* struct sfp_upstream_ops - upstream operations structure
320587e6 RK	512	* @attach: called when the sfp socket driver is bound to the upstream
	513	* (mandatory).
	514	* @detach: called when the sfp socket driver is unbound from the upstream
	515	* (mandatory).
0a6fcd3f RK	516	* @module_insert: called after a module has been detected to determine
	517	* whether the module is supported for the upstream device.
	518	* @module_remove: called after the module has been removed.
74c551ca RK	519	* @module_start: called after the PHY probe step
74c551ca RK	520	* @module_stop: called before the PHY is removed
0a6fcd3f RK	521	* @link_down: called when the link is non-operational for whatever
	522	* reason.
	523	* @link_up: called when the link is operational.
	524	* @connect_phy: called when an I2C accessible PHY has been detected
	525	* on the module.
	526	* @disconnect_phy: called when a module with an I2C accessible PHY has
	527	* been removed.
	528	*/
ce0aa27f	529	struct sfp_upstream_ops {
320587e6 RK	530	void (attach)(void priv, struct sfp_bus *bus);
320587e6 RK	531	void (detach)(void priv, struct sfp_bus *bus);
0a6fcd3f RK	532	int (module_insert)(void priv, const struct sfp_eeprom_id *id);
0a6fcd3f RK	533	void (module_remove)(void priv);
74c551ca RK	534	int (module_start)(void priv);
74c551ca RK	535	void (module_stop)(void priv);
0a6fcd3f RK	536	void (link_down)(void priv);
	537	void (link_up)(void priv);
	538	int (connect_phy)(void priv, struct phy_device *);
	539	void (disconnect_phy)(void priv);
ce0aa27f RK	540	};
	541
	542	#if IS_ENABLED(CONFIG_SFP)
	543	int sfp_parse_port(struct sfp_bus bus, const struct sfp_eeprom_id id,
	544	unsigned long *support);
52c95600	545	bool sfp_may_have_phy(struct sfp_bus bus, const struct sfp_eeprom_id id);
ce0aa27f	546	void sfp_parse_support(struct sfp_bus bus, const struct sfp_eeprom_id id,
fd580c98	547	unsigned long support, unsigned long interfaces);
a9c79364	548	phy_interface_t sfp_select_interface(struct sfp_bus *bus,
a9c79364	549	unsigned long *link_modes);
ce0aa27f RK	550
	551	int sfp_get_module_info(struct sfp_bus bus, struct ethtool_modinfo modinfo);
	552	int sfp_get_module_eeprom(struct sfp_bus bus, struct ethtool_eeprom ee,
	553	u8 *data);
d740513f AL	554	int sfp_get_module_eeprom_by_page(struct sfp_bus *bus,
	555	const struct ethtool_module_eeprom *page,
	556	struct netlink_ext_ack *extack);
ce0aa27f RK	557	void sfp_upstream_start(struct sfp_bus *bus);
ce0aa27f RK	558	void sfp_upstream_stop(struct sfp_bus *bus);
727b3668	559	void sfp_bus_put(struct sfp_bus *bus);
a90ac762	560	struct sfp_bus sfp_bus_find_fwnode(const struct fwnode_handle fwnode);
727b3668 RK	561	int sfp_bus_add_upstream(struct sfp_bus bus, void upstream,
	562	const struct sfp_upstream_ops *ops);
	563	void sfp_bus_del_upstream(struct sfp_bus *bus);
ce0aa27f RK	564	#else
	565	static inline int sfp_parse_port(struct sfp_bus *bus,
	566	const struct sfp_eeprom_id *id,
	567	unsigned long *support)
	568	{
	569	return PORT_OTHER;
	570	}
	571
52c95600 RK	572	static inline bool sfp_may_have_phy(struct sfp_bus *bus,
	573	const struct sfp_eeprom_id *id)
	574	{
	575	return false;
	576	}
	577
ce0aa27f RK	578	static inline void sfp_parse_support(struct sfp_bus *bus,
ce0aa27f RK	579	const struct sfp_eeprom_id *id,
fd580c98 RK	580	unsigned long *support,
fd580c98 RK	581	unsigned long *interfaces)
ce0aa27f RK	582	{
	583	}
	584
a9c79364	585	static inline phy_interface_t sfp_select_interface(struct sfp_bus *bus,
a9c79364 RK	586	unsigned long *link_modes)
	587	{
	588	return PHY_INTERFACE_MODE_NA;
	589	}
	590
ce0aa27f RK	591	static inline int sfp_get_module_info(struct sfp_bus *bus,
	592	struct ethtool_modinfo *modinfo)
	593	{
	594	return -EOPNOTSUPP;
	595	}
	596
	597	static inline int sfp_get_module_eeprom(struct sfp_bus *bus,
	598	struct ethtool_eeprom ee, u8 data)
	599	{
	600	return -EOPNOTSUPP;
	601	}
	602
d740513f AL	603	static inline int sfp_get_module_eeprom_by_page(struct sfp_bus *bus,
	604	const struct ethtool_module_eeprom *page,
	605	struct netlink_ext_ack *extack)
	606	{
	607	return -EOPNOTSUPP;
	608	}
	609
ce0aa27f RK	610	static inline void sfp_upstream_start(struct sfp_bus *bus)
	611	{
	612	}
	613
	614	static inline void sfp_upstream_stop(struct sfp_bus *bus)
	615	{
	616	}
	617
727b3668 RK	618	static inline void sfp_bus_put(struct sfp_bus *bus)
	619	{
	620	}
	621
a90ac762 RKO	622	static inline struct sfp_bus *
a90ac762 RKO	623	sfp_bus_find_fwnode(const struct fwnode_handle *fwnode)
ce0aa27f	624	{
2203cbf2	625	return NULL;
ce0aa27f RK	626	}
ce0aa27f RK	627
6c086702 RK	628	static inline int sfp_bus_add_upstream(struct sfp_bus bus, void upstream,
6c086702 RK	629	const struct sfp_upstream_ops *ops)
727b3668 RK	630	{
	631	return 0;
	632	}
	633
	634	static inline void sfp_bus_del_upstream(struct sfp_bus *bus)
ce0aa27f RK	635	{
	636	}
	637	#endif
	638
	639	#endif