1 #ifndef NETDEV_PCS_H 2 #define NETDEV_PCS_H 3 4 #include <linux/phy.h> 5 #include <linux/spinlock.h> 6 #include <linux/workqueue.h> 7 8 struct device_node; 9 struct ethtool_cmd; 10 struct fwnode_handle; 11 struct net_device; 12 13 enum { 14 MLO_PAUSE_NONE, 15 MLO_PAUSE_ASYM = BIT(0), 16 MLO_PAUSE_SYM = BIT(1), 17 MLO_PAUSE_RX = BIT(2), 18 MLO_PAUSE_TX = BIT(3), 19 MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX, 20 MLO_PAUSE_AN = BIT(4), 21 22 MLO_AN_PHY = 0, /* Conventional PHY */ 23 MLO_AN_FIXED, /* Fixed-link mode */ 24 MLO_AN_INBAND, /* In-band protocol */ 25 }; 26 27 static inline bool phylink_autoneg_inband(unsigned int mode) 28 { 29 return mode == MLO_AN_INBAND; 30 } 31 32 /** 33 * struct phylink_link_state - link state structure 34 * @advertising: ethtool bitmask containing advertised link modes 35 * @lp_advertising: ethtool bitmask containing link partner advertised link 36 * modes 37 * @interface: link &typedef phy_interface_t mode 38 * @speed: link speed, one of the SPEED_* constants. 39 * @duplex: link duplex mode, one of DUPLEX_* constants. 40 * @pause: link pause state, described by MLO_PAUSE_* constants. 41 * @link: true if the link is up. 42 * @an_enabled: true if autonegotiation is enabled/desired. 43 * @an_complete: true if autonegotiation has completed. 44 */ 45 struct phylink_link_state { 46 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); 47 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); 48 phy_interface_t interface; 49 int speed; 50 int duplex; 51 int pause; 52 unsigned int link:1; 53 unsigned int an_enabled:1; 54 unsigned int an_complete:1; 55 }; 56 57 enum phylink_op_type { 58 PHYLINK_NETDEV = 0, 59 PHYLINK_DEV, 60 }; 61 62 /** 63 * struct phylink_config - PHYLINK configuration structure 64 * @dev: a pointer to a struct device associated with the MAC 65 * @type: operation type of PHYLINK instance 66 */ 67 struct phylink_config { 68 struct device *dev; 69 enum phylink_op_type type; 70 }; 71 72 /** 73 * struct phylink_mac_ops - MAC operations structure. 74 * @validate: Validate and update the link configuration. 75 * @mac_pcs_get_state: Read the current link state from the hardware. 76 * @mac_config: configure the MAC for the selected mode and state. 77 * @mac_an_restart: restart 802.3z BaseX autonegotiation. 78 * @mac_link_down: take the link down. 79 * @mac_link_up: allow the link to come up. 80 * 81 * The individual methods are described more fully below. 82 */ 83 struct phylink_mac_ops { 84 void (*validate)(struct phylink_config *config, 85 unsigned long *supported, 86 struct phylink_link_state *state); 87 void (*mac_pcs_get_state)(struct phylink_config *config, 88 struct phylink_link_state *state); 89 void (*mac_config)(struct phylink_config *config, unsigned int mode, 90 const struct phylink_link_state *state); 91 void (*mac_an_restart)(struct phylink_config *config); 92 void (*mac_link_down)(struct phylink_config *config, unsigned int mode, 93 phy_interface_t interface); 94 void (*mac_link_up)(struct phylink_config *config, unsigned int mode, 95 phy_interface_t interface, 96 struct phy_device *phy); 97 }; 98 99 #if 0 /* For kernel-doc purposes only. */ 100 /** 101 * validate - Validate and update the link configuration 102 * @config: a pointer to a &struct phylink_config. 103 * @supported: ethtool bitmask for supported link modes. 104 * @state: a pointer to a &struct phylink_link_state. 105 * 106 * Clear bits in the @supported and @state->advertising masks that 107 * are not supportable by the MAC. 108 * 109 * Note that the PHY may be able to transform from one connection 110 * technology to another, so, eg, don't clear 1000BaseX just 111 * because the MAC is unable to BaseX mode. This is more about 112 * clearing unsupported speeds and duplex settings. The port modes 113 * should not be cleared; phylink_set_port_modes() will help with this. 114 * 115 * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX 116 * or %PHY_INTERFACE_MODE_2500BASEX, select the appropriate mode 117 * based on @state->advertising and/or @state->speed and update 118 * @state->interface accordingly. See phylink_helper_basex_speed(). 119 * 120 * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink expects the 121 * MAC driver to return all supported link modes. 122 * 123 * If the @state->interface mode is not supported, then the @supported 124 * mask must be cleared. 125 */ 126 void validate(struct phylink_config *config, unsigned long *supported, 127 struct phylink_link_state *state); 128 129 /** 130 * mac_pcs_get_state() - Read the current inband link state from the hardware 131 * @config: a pointer to a &struct phylink_config. 132 * @state: a pointer to a &struct phylink_link_state. 133 * 134 * Read the current inband link state from the MAC PCS, reporting the 135 * current speed in @state->speed, duplex mode in @state->duplex, pause 136 * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits, 137 * negotiation completion state in @state->an_complete, and link up state 138 * in @state->link. If possible, @state->lp_advertising should also be 139 * populated. 140 */ 141 void mac_pcs_get_state(struct phylink_config *config, 142 struct phylink_link_state *state); 143 144 /** 145 * mac_config() - configure the MAC for the selected mode and state 146 * @config: a pointer to a &struct phylink_config. 147 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND. 148 * @state: a pointer to a &struct phylink_link_state. 149 * 150 * Note - not all members of @state are valid. In particular, 151 * @state->lp_advertising, @state->link, @state->an_complete are never 152 * guaranteed to be correct, and so any mac_config() implementation must 153 * never reference these fields. 154 * 155 * The action performed depends on the currently selected mode: 156 * 157 * %MLO_AN_FIXED, %MLO_AN_PHY: 158 * Configure the specified @state->speed, @state->duplex and 159 * @state->pause (%MLO_PAUSE_TX / %MLO_PAUSE_RX) modes over a link 160 * specified by @state->interface. @state->advertising may be used, 161 * but is not required. Other members of @state must be ignored. 162 * 163 * Valid state members: interface, speed, duplex, pause, advertising. 164 * 165 * %MLO_AN_INBAND: 166 * place the link in an inband negotiation mode (such as 802.3z 167 * 1000base-X or Cisco SGMII mode depending on the @state->interface 168 * mode). In both cases, link state management (whether the link 169 * is up or not) is performed by the MAC, and reported via the 170 * mac_pcs_get_state() callback. Changes in link state must be made 171 * by calling phylink_mac_change(). 172 * 173 * If in 802.3z mode, the link speed is fixed, dependent on the 174 * @state->interface. Duplex is negotiated, and pause is advertised 175 * according to @state->an_enabled, @state->pause and 176 * @state->advertising flags. Beware of MACs which only support full 177 * duplex at gigabit and higher speeds. 178 * 179 * If in Cisco SGMII mode, the link speed and duplex mode are passed 180 * in the serial bitstream 16-bit configuration word, and the MAC 181 * should be configured to read these bits and acknowledge the 182 * configuration word. Nothing is advertised by the MAC. The MAC is 183 * responsible for reading the configuration word and configuring 184 * itself accordingly. 185 * 186 * Valid state members: interface, an_enabled, pause, advertising. 187 * 188 * Implementations are expected to update the MAC to reflect the 189 * requested settings - i.o.w., if nothing has changed between two 190 * calls, no action is expected. If only flow control settings have 191 * changed, flow control should be updated *without* taking the link 192 * down. This "update" behaviour is critical to avoid bouncing the 193 * link up status. 194 */ 195 void mac_config(struct phylink_config *config, unsigned int mode, 196 const struct phylink_link_state *state); 197 198 /** 199 * mac_an_restart() - restart 802.3z BaseX autonegotiation 200 * @config: a pointer to a &struct phylink_config. 201 */ 202 void mac_an_restart(struct phylink_config *config); 203 204 /** 205 * mac_link_down() - take the link down 206 * @config: a pointer to a &struct phylink_config. 207 * @mode: link autonegotiation mode 208 * @interface: link &typedef phy_interface_t mode 209 * 210 * If @mode is not an in-band negotiation mode (as defined by 211 * phylink_autoneg_inband()), force the link down and disable any 212 * Energy Efficient Ethernet MAC configuration. Interface type 213 * selection must be done in mac_config(). 214 */ 215 void mac_link_down(struct phylink_config *config, unsigned int mode, 216 phy_interface_t interface); 217 218 /** 219 * mac_link_up() - allow the link to come up 220 * @config: a pointer to a &struct phylink_config. 221 * @mode: link autonegotiation mode 222 * @interface: link &typedef phy_interface_t mode 223 * @phy: any attached phy 224 * 225 * If @mode is not an in-band negotiation mode (as defined by 226 * phylink_autoneg_inband()), allow the link to come up. If @phy 227 * is non-%NULL, configure Energy Efficient Ethernet by calling 228 * phy_init_eee() and perform appropriate MAC configuration for EEE. 229 * Interface type selection must be done in mac_config(). 230 */ 231 void mac_link_up(struct phylink_config *config, unsigned int mode, 232 phy_interface_t interface, 233 struct phy_device *phy); 234 #endif 235 236 struct phylink *phylink_create(struct phylink_config *, struct fwnode_handle *, 237 phy_interface_t iface, 238 const struct phylink_mac_ops *ops); 239 void phylink_destroy(struct phylink *); 240 241 int phylink_connect_phy(struct phylink *, struct phy_device *); 242 int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags); 243 void phylink_disconnect_phy(struct phylink *); 244 int phylink_fixed_state_cb(struct phylink *, 245 void (*cb)(struct net_device *dev, 246 struct phylink_link_state *)); 247 248 void phylink_mac_change(struct phylink *, bool up); 249 250 void phylink_start(struct phylink *); 251 void phylink_stop(struct phylink *); 252 253 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *); 254 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *); 255 256 int phylink_ethtool_ksettings_get(struct phylink *, 257 struct ethtool_link_ksettings *); 258 int phylink_ethtool_ksettings_set(struct phylink *, 259 const struct ethtool_link_ksettings *); 260 int phylink_ethtool_nway_reset(struct phylink *); 261 void phylink_ethtool_get_pauseparam(struct phylink *, 262 struct ethtool_pauseparam *); 263 int phylink_ethtool_set_pauseparam(struct phylink *, 264 struct ethtool_pauseparam *); 265 int phylink_get_eee_err(struct phylink *); 266 int phylink_init_eee(struct phylink *, bool); 267 int phylink_ethtool_get_eee(struct phylink *, struct ethtool_eee *); 268 int phylink_ethtool_set_eee(struct phylink *, struct ethtool_eee *); 269 int phylink_mii_ioctl(struct phylink *, struct ifreq *, int); 270 271 #define phylink_zero(bm) \ 272 bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS) 273 #define __phylink_do_bit(op, bm, mode) \ 274 op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm) 275 276 #define phylink_set(bm, mode) __phylink_do_bit(__set_bit, bm, mode) 277 #define phylink_clear(bm, mode) __phylink_do_bit(__clear_bit, bm, mode) 278 #define phylink_test(bm, mode) __phylink_do_bit(test_bit, bm, mode) 279 280 void phylink_set_port_modes(unsigned long *bits); 281 void phylink_helper_basex_speed(struct phylink_link_state *state); 282 283 #endif 284