include/linux/phylink.h

   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 /**
  58  * struct phylink_mac_ops - MAC operations structure.
  59  * @validate: Validate and update the link configuration.
  60  * @mac_link_state: Read the current link state from the hardware.
  61  * @mac_config: configure the MAC for the selected mode and state.
  62  * @mac_an_restart: restart 802.3z BaseX autonegotiation.
  63  * @mac_link_down: take the link down.
  64  * @mac_link_up: allow the link to come up.
  65  *
  66  * The individual methods are described more fully below.
  67  */
  68 struct phylink_mac_ops {
  69         void (*validate)(struct net_device *ndev, unsigned long *supported,
  70                          struct phylink_link_state *state);
  71         int (*mac_link_state)(struct net_device *ndev,
  72                               struct phylink_link_state *state);
  73         void (*mac_config)(struct net_device *ndev, unsigned int mode,
  74                            const struct phylink_link_state *state);
  75         void (*mac_an_restart)(struct net_device *ndev);
  76         void (*mac_link_down)(struct net_device *ndev, unsigned int mode);
  77         void (*mac_link_up)(struct net_device *ndev, unsigned int mode,
  78                             struct phy_device *phy);
  79 };
  80
  81 #if 0 /* For kernel-doc purposes only. */
  82 /**
  83  * validate - Validate and update the link configuration
  84  * @ndev: a pointer to a &struct net_device for the MAC.
  85  * @supported: ethtool bitmask for supported link modes.
  86  * @state: a pointer to a &struct phylink_link_state.
  87  *
  88  * Clear bits in the @supported and @state->advertising masks that
  89  * are not supportable by the MAC.
  90  *
  91  * Note that the PHY may be able to transform from one connection
  92  * technology to another, so, eg, don't clear 1000BaseX just
  93  * because the MAC is unable to BaseX mode. This is more about
  94  * clearing unsupported speeds and duplex settings.
  95  *
  96  * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX
  97  * or %PHY_INTERFACE_MODE_2500BASEX, select the appropriate mode
  98  * based on @state->advertising and/or @state->speed and update
  99  * @state->interface accordingly.
 100  */
 101 void validate(struct net_device *ndev, unsigned long *supported,
 102               struct phylink_link_state *state);
 103
 104 /**
 105  * mac_link_state() - Read the current link state from the hardware
 106  * @ndev: a pointer to a &struct net_device for the MAC.
 107  * @state: a pointer to a &struct phylink_link_state.
 108  *
 109  * Read the current link state from the MAC, reporting the current
 110  * speed in @state->speed, duplex mode in @state->duplex, pause mode
 111  * in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
 112  * negotiation completion state in @state->an_complete, and link
 113  * up state in @state->link.
 114  */
 115 int mac_link_state(struct net_device *ndev,
 116                    struct phylink_link_state *state);
 117
 118 /**
 119  * mac_config() - configure the MAC for the selected mode and state
 120  * @ndev: a pointer to a &struct net_device for the MAC.
 121  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
 122  * @state: a pointer to a &struct phylink_link_state.
 123  *
 124  * The action performed depends on the currently selected mode:
 125  *
 126  * %MLO_AN_FIXED, %MLO_AN_PHY:
 127  *   Configure the specified @state->speed, @state->duplex and
 128  *   @state->pause (%MLO_PAUSE_TX / %MLO_PAUSE_RX) mode.
 129  *
 130  * %MLO_AN_INBAND:
 131  *   place the link in an inband negotiation mode (such as 802.3z
 132  *   1000base-X or Cisco SGMII mode depending on the @state->interface
 133  *   mode). In both cases, link state management (whether the link
 134  *   is up or not) is performed by the MAC, and reported via the
 135  *   mac_link_state() callback. Changes in link state must be made
 136  *   by calling phylink_mac_change().
 137  *
 138  *   If in 802.3z mode, the link speed is fixed, dependent on the
 139  *   @state->interface. Duplex is negotiated, and pause is advertised
 140  *   according to @state->an_enabled, @state->pause and
 141  *   @state->advertising flags. Beware of MACs which only support full
 142  *   duplex at gigabit and higher speeds.
 143  *
 144  *   If in Cisco SGMII mode, the link speed and duplex mode are passed
 145  *   in the serial bitstream 16-bit configuration word, and the MAC
 146  *   should be configured to read these bits and acknowledge the
 147  *   configuration word. Nothing is advertised by the MAC. The MAC is
 148  *   responsible for reading the configuration word and configuring
 149  *   itself accordingly.
 150  */
 151 void mac_config(struct net_device *ndev, unsigned int mode,
 152                 const struct phylink_link_state *state);
 153
 154 /**
 155  * mac_an_restart() - restart 802.3z BaseX autonegotiation
 156  * @ndev: a pointer to a &struct net_device for the MAC.
 157  */
 158 void mac_an_restart(struct net_device *ndev);
 159
 160 /**
 161  * mac_link_down() - take the link down
 162  * @ndev: a pointer to a &struct net_device for the MAC.
 163  * @mode: link autonegotiation mode
 164  *
 165  * If @mode is not an in-band negotiation mode (as defined by
 166  * phylink_autoneg_inband()), force the link down and disable any
 167  * Energy Efficient Ethernet MAC configuration.
 168  */
 169 void mac_link_down(struct net_device *ndev, unsigned int mode);
 170
 171 /**
 172  * mac_link_up() - allow the link to come up
 173  * @ndev: a pointer to a &struct net_device for the MAC.
 174  * @mode: link autonegotiation mode
 175  * @phy: any attached phy
 176  *
 177  * If @mode is not an in-band negotiation mode (as defined by
 178  * phylink_autoneg_inband()), allow the link to come up. If @phy
 179  * is non-%NULL, configure Energy Efficient Ethernet by calling
 180  * phy_init_eee() and perform appropriate MAC configuration for EEE.
 181  */
 182 void mac_link_up(struct net_device *ndev, unsigned int mode,
 183                  struct phy_device *phy);
 184 #endif
 185
 186 struct phylink *phylink_create(struct net_device *, struct fwnode_handle *,
 187         phy_interface_t iface, const struct phylink_mac_ops *ops);
 188 void phylink_destroy(struct phylink *);
 189
 190 int phylink_connect_phy(struct phylink *, struct phy_device *);
 191 int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);
 192 void phylink_disconnect_phy(struct phylink *);
 193 int phylink_fixed_state_cb(struct phylink *,
 194                            void (*cb)(struct net_device *dev,
 195                                       struct phylink_link_state *));
 196
 197 void phylink_mac_change(struct phylink *, bool up);
 198
 199 void phylink_start(struct phylink *);
 200 void phylink_stop(struct phylink *);
 201
 202 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
 203 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
 204
 205 int phylink_ethtool_ksettings_get(struct phylink *,
 206                                   struct ethtool_link_ksettings *);
 207 int phylink_ethtool_ksettings_set(struct phylink *,
 208                                   const struct ethtool_link_ksettings *);
 209 int phylink_ethtool_nway_reset(struct phylink *);
 210 void phylink_ethtool_get_pauseparam(struct phylink *,
 211                                     struct ethtool_pauseparam *);
 212 int phylink_ethtool_set_pauseparam(struct phylink *,
 213                                    struct ethtool_pauseparam *);
 214 int phylink_ethtool_get_module_info(struct phylink *, struct ethtool_modinfo *);
 215 int phylink_ethtool_get_module_eeprom(struct phylink *,
 216                                       struct ethtool_eeprom *, u8 *);
 217 int phylink_get_eee_err(struct phylink *);
 218 int phylink_ethtool_get_eee(struct phylink *, struct ethtool_eee *);
 219 int phylink_ethtool_set_eee(struct phylink *, struct ethtool_eee *);
 220 int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);
 221
 222 #define phylink_zero(bm) \
 223         bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)
 224 #define __phylink_do_bit(op, bm, mode) \
 225         op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
 226
 227 #define phylink_set(bm, mode)   __phylink_do_bit(__set_bit, bm, mode)
 228 #define phylink_clear(bm, mode) __phylink_do_bit(__clear_bit, bm, mode)
 229 #define phylink_test(bm, mode)  __phylink_do_bit(test_bit, bm, mode)
 230
 231 void phylink_set_port_modes(unsigned long *bits);
 232
 233 #endif