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