1 #ifndef NETDEV_PCS_H 1 #ifndef NETDEV_PCS_H
2 #define NETDEV_PCS_H 2 #define NETDEV_PCS_H
3 3
4 #include <linux/phy.h> 4 #include <linux/phy.h>
5 #include <linux/spinlock.h> 5 #include <linux/spinlock.h>
6 #include <linux/workqueue.h> 6 #include <linux/workqueue.h>
7 7
8 struct device_node; 8 struct device_node;
9 struct ethtool_cmd; 9 struct ethtool_cmd;
10 struct fwnode_handle; 10 struct fwnode_handle;
11 struct net_device; 11 struct net_device;
12 struct phylink; <<
13 12
14 enum { 13 enum {
15 MLO_PAUSE_NONE, 14 MLO_PAUSE_NONE,
16 MLO_PAUSE_RX = BIT(0), 15 MLO_PAUSE_RX = BIT(0),
17 MLO_PAUSE_TX = BIT(1), 16 MLO_PAUSE_TX = BIT(1),
18 MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | M 17 MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX,
19 MLO_PAUSE_AN = BIT(2), 18 MLO_PAUSE_AN = BIT(2),
20 19
21 MLO_AN_PHY = 0, /* Conventional PHY */ 20 MLO_AN_PHY = 0, /* Conventional PHY */
22 MLO_AN_FIXED, /* Fixed-link mode */ 21 MLO_AN_FIXED, /* Fixed-link mode */
23 MLO_AN_INBAND, /* In-band protocol */ 22 MLO_AN_INBAND, /* In-band protocol */
24 <<
25 /* PCS "negotiation" mode. <<
26 * PHYLINK_PCS_NEG_NONE - protocol ha <<
27 * PHYLINK_PCS_NEG_OUTBAND - some out <<
28 * PHYLINK_PCS_NEG_INBAND_DISABLED - <<
29 * <<
30 * PHYLINK_PCS_NEG_INBAND_ENABLED - i <<
31 * Additionally, this can be tested us <<
32 * PHYLINK_PCS_NEG_INBAND - inband mo <<
33 * PHYLINK_PCS_NEG_ENABLED - negotiat <<
34 */ <<
35 PHYLINK_PCS_NEG_NONE = 0, <<
36 PHYLINK_PCS_NEG_ENABLED = BIT(4), <<
37 PHYLINK_PCS_NEG_OUTBAND = BIT(5), <<
38 PHYLINK_PCS_NEG_INBAND = BIT(6), <<
39 PHYLINK_PCS_NEG_INBAND_DISABLED = PHYL <<
40 PHYLINK_PCS_NEG_INBAND_ENABLED = PHYLI <<
41 PHYLI <<
42 <<
43 /* MAC_SYM_PAUSE and MAC_ASYM_PAUSE ar <<
44 * autonegotiation advertisement. They <<
45 * ASM_DIR bits defined by 802.3, resp <<
46 * <<
47 * The following table lists the value <<
48 * might be requested in mac_link_up. <<
49 * the results of autonegotation (if M <<
50 * configuration (if MLO_PAUSE_AN is n <<
51 * <<
52 * MAC_SYM_PAUSE MAC_ASYM_PAUSE MLO_PA <<
53 * ============= ============== ====== <<
54 * 0 0 <<
55 * 0 0 <<
56 * 0 1 <<
57 * 0 1 <<
58 * 1 0 <<
59 * 1 0 <<
60 * 1 1 <<
61 * 1 1 <<
62 * <<
63 * If you set MAC_ASYM_PAUSE, the user <<
64 * tx_pause and rx_pause. You do not h <<
65 * combinations. <<
66 * <<
67 * However, you should support combina <<
68 * which might be the result of autone <<
69 * MAC_SYM_PAUSE unless your device ca <<
70 * at the same time. <<
71 */ <<
72 MAC_SYM_PAUSE = BIT(0), <<
73 MAC_ASYM_PAUSE = BIT(1), <<
74 MAC_10HD = BIT(2), <<
75 MAC_10FD = BIT(3), <<
76 MAC_10 = MAC_10HD | MAC_10FD, <<
77 MAC_100HD = BIT(4), <<
78 MAC_100FD = BIT(5), <<
79 MAC_100 = MAC_100HD | MAC_100F <<
80 MAC_1000HD = BIT(6), <<
81 MAC_1000FD = BIT(7), <<
82 MAC_1000 = MAC_1000HD | MAC_100 <<
83 MAC_2500FD = BIT(8), <<
84 MAC_5000FD = BIT(9), <<
85 MAC_10000FD = BIT(10), <<
86 MAC_20000FD = BIT(11), <<
87 MAC_25000FD = BIT(12), <<
88 MAC_40000FD = BIT(13), <<
89 MAC_50000FD = BIT(14), <<
90 MAC_56000FD = BIT(15), <<
91 MAC_100000FD = BIT(16), <<
92 MAC_200000FD = BIT(17), <<
93 MAC_400000FD = BIT(18), <<
94 }; 23 };
95 24
96 static inline bool phylink_autoneg_inband(unsi 25 static inline bool phylink_autoneg_inband(unsigned int mode)
97 { 26 {
98 return mode == MLO_AN_INBAND; 27 return mode == MLO_AN_INBAND;
99 } 28 }
100 29
101 /** 30 /**
102 * struct phylink_link_state - link state stru 31 * struct phylink_link_state - link state structure
103 * @advertising: ethtool bitmask containing ad 32 * @advertising: ethtool bitmask containing advertised link modes
104 * @lp_advertising: ethtool bitmask containing 33 * @lp_advertising: ethtool bitmask containing link partner advertised link
105 * modes 34 * modes
106 * @interface: link &typedef phy_interface_t m 35 * @interface: link &typedef phy_interface_t mode
107 * @speed: link speed, one of the SPEED_* cons 36 * @speed: link speed, one of the SPEED_* constants.
108 * @duplex: link duplex mode, one of DUPLEX_* 37 * @duplex: link duplex mode, one of DUPLEX_* constants.
109 * @pause: link pause state, described by MLO_ 38 * @pause: link pause state, described by MLO_PAUSE_* constants.
110 * @rate_matching: rate matching being perform <<
111 * constants. If rate matching is taking pla <<
112 * the medium link mode (@speed and @duplex) <<
113 * interface mode (@interface) are different <<
114 * @link: true if the link is up. 39 * @link: true if the link is up.
>> 40 * @an_enabled: true if autonegotiation is enabled/desired.
115 * @an_complete: true if autonegotiation has c 41 * @an_complete: true if autonegotiation has completed.
116 */ 42 */
117 struct phylink_link_state { 43 struct phylink_link_state {
118 __ETHTOOL_DECLARE_LINK_MODE_MASK(adver 44 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
119 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_ad 45 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
120 phy_interface_t interface; 46 phy_interface_t interface;
121 int speed; 47 int speed;
122 int duplex; 48 int duplex;
123 int pause; 49 int pause;
124 int rate_matching; <<
125 unsigned int link:1; 50 unsigned int link:1;
>> 51 unsigned int an_enabled:1;
126 unsigned int an_complete:1; 52 unsigned int an_complete:1;
127 }; 53 };
128 54
129 enum phylink_op_type { 55 enum phylink_op_type {
130 PHYLINK_NETDEV = 0, 56 PHYLINK_NETDEV = 0,
131 PHYLINK_DEV, 57 PHYLINK_DEV,
132 }; 58 };
133 59
134 /** 60 /**
135 * struct phylink_config - PHYLINK configurati 61 * struct phylink_config - PHYLINK configuration structure
136 * @dev: a pointer to a struct device associat 62 * @dev: a pointer to a struct device associated with the MAC
137 * @type: operation type of PHYLINK instance 63 * @type: operation type of PHYLINK instance
>> 64 * @pcs_poll: MAC PCS cannot provide link change interrupt
138 * @poll_fixed_state: if true, starts link_pol 65 * @poll_fixed_state: if true, starts link_poll,
139 * if MAC link is at %MLO_A 66 * if MAC link is at %MLO_AN_FIXED mode.
140 * @mac_managed_pm: if true, indicate the MAC <<
141 * @mac_requires_rxc: if true, the MAC always <<
142 * The PHY driver should st <<
143 * possible and avoid stopp <<
144 * @default_an_inband: if true, defaults to ML <<
145 * MLO_AN_PHY. A fixed-lin <<
146 * @get_fixed_state: callback to execute to de 67 * @get_fixed_state: callback to execute to determine the fixed link state,
147 * if MAC link is at %MLO_AN 68 * if MAC link is at %MLO_AN_FIXED mode.
148 * @supported_interfaces: bitmap describing wh <<
149 * are supported by the <<
150 * @mac_capabilities: MAC pause/speed/duplex c <<
151 */ 69 */
152 struct phylink_config { 70 struct phylink_config {
153 struct device *dev; 71 struct device *dev;
154 enum phylink_op_type type; 72 enum phylink_op_type type;
>> 73 bool pcs_poll;
155 bool poll_fixed_state; 74 bool poll_fixed_state;
156 bool mac_managed_pm; <<
157 bool mac_requires_rxc; <<
158 bool default_an_inband; <<
159 void (*get_fixed_state)(struct phylink 75 void (*get_fixed_state)(struct phylink_config *config,
160 struct phylink 76 struct phylink_link_state *state);
161 DECLARE_PHY_INTERFACE_MASK(supported_i <<
162 unsigned long mac_capabilities; <<
163 }; 77 };
164 78
165 void phylink_limit_mac_speed(struct phylink_co <<
166 <<
167 /** 79 /**
168 * struct phylink_mac_ops - MAC operations str 80 * struct phylink_mac_ops - MAC operations structure.
169 * @mac_get_caps: Get MAC capabilities for int !! 81 * @validate: Validate and update the link configuration.
170 * @mac_select_pcs: Select a PCS for the inter !! 82 * @mac_pcs_get_state: Read the current link state from the hardware.
171 * @mac_prepare: prepare for a major reconfigu 83 * @mac_prepare: prepare for a major reconfiguration of the interface.
172 * @mac_config: configure the MAC for the sele 84 * @mac_config: configure the MAC for the selected mode and state.
173 * @mac_finish: finish a major reconfiguration 85 * @mac_finish: finish a major reconfiguration of the interface.
>> 86 * @mac_an_restart: restart 802.3z BaseX autonegotiation.
174 * @mac_link_down: take the link down. 87 * @mac_link_down: take the link down.
175 * @mac_link_up: allow the link to come up. 88 * @mac_link_up: allow the link to come up.
176 * 89 *
177 * The individual methods are described more f 90 * The individual methods are described more fully below.
178 */ 91 */
179 struct phylink_mac_ops { 92 struct phylink_mac_ops {
180 unsigned long (*mac_get_caps)(struct p !! 93 void (*validate)(struct phylink_config *config,
181 phy_inte !! 94 unsigned long *supported,
182 struct phylink_pcs *(*mac_select_pcs)( !! 95 struct phylink_link_state *state);
183 !! 96 void (*mac_pcs_get_state)(struct phylink_config *config,
>> 97 struct phylink_link_state *state);
184 int (*mac_prepare)(struct phylink_conf 98 int (*mac_prepare)(struct phylink_config *config, unsigned int mode,
185 phy_interface_t ifa 99 phy_interface_t iface);
186 void (*mac_config)(struct phylink_conf 100 void (*mac_config)(struct phylink_config *config, unsigned int mode,
187 const struct phylin 101 const struct phylink_link_state *state);
188 int (*mac_finish)(struct phylink_confi 102 int (*mac_finish)(struct phylink_config *config, unsigned int mode,
189 phy_interface_t ifac 103 phy_interface_t iface);
>> 104 void (*mac_an_restart)(struct phylink_config *config);
190 void (*mac_link_down)(struct phylink_c 105 void (*mac_link_down)(struct phylink_config *config, unsigned int mode,
191 phy_interface_t 106 phy_interface_t interface);
192 void (*mac_link_up)(struct phylink_con 107 void (*mac_link_up)(struct phylink_config *config,
193 struct phy_device 108 struct phy_device *phy, unsigned int mode,
194 phy_interface_t in 109 phy_interface_t interface, int speed, int duplex,
195 bool tx_pause, boo 110 bool tx_pause, bool rx_pause);
196 }; 111 };
197 112
198 #if 0 /* For kernel-doc purposes only. */ 113 #if 0 /* For kernel-doc purposes only. */
199 /** 114 /**
200 * mac_get_caps: Get MAC capabilities for inte !! 115 * validate - Validate and update the link configuration
201 * @config: a pointer to a &struct phylink_con 116 * @config: a pointer to a &struct phylink_config.
202 * @interface: PHY interface mode. !! 117 * @supported: ethtool bitmask for supported link modes.
>> 118 * @state: a pointer to a &struct phylink_link_state.
>> 119 *
>> 120 * Clear bits in the @supported and @state->advertising masks that
>> 121 * are not supportable by the MAC.
>> 122 *
>> 123 * Note that the PHY may be able to transform from one connection
>> 124 * technology to another, so, eg, don't clear 1000BaseX just
>> 125 * because the MAC is unable to BaseX mode. This is more about
>> 126 * clearing unsupported speeds and duplex settings. The port modes
>> 127 * should not be cleared; phylink_set_port_modes() will help with this.
>> 128 *
>> 129 * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX
>> 130 * or %PHY_INTERFACE_MODE_2500BASEX, select the appropriate mode
>> 131 * based on @state->advertising and/or @state->speed and update
>> 132 * @state->interface accordingly. See phylink_helper_basex_speed().
>> 133 *
>> 134 * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink expects the
>> 135 * MAC driver to return all supported link modes.
203 * 136 *
204 * Optional method. When not provided, config- !! 137 * If the @state->interface mode is not supported, then the @supported
205 * When implemented, this returns the MAC capa !! 138 * mask must be cleared.
206 * interface mode where there is some special <<
207 * driver (e.g. not supporting half-duplex in <<
208 */ 139 */
209 unsigned long mac_get_caps(struct phylink_conf !! 140 void validate(struct phylink_config *config, unsigned long *supported,
210 phy_interface_t int !! 141 struct phylink_link_state *state);
>> 142
211 /** 143 /**
212 * mac_select_pcs: Select a PCS for the interf !! 144 * mac_pcs_get_state() - Read the current inband link state from the hardware
213 * @config: a pointer to a &struct phylink_con 145 * @config: a pointer to a &struct phylink_config.
214 * @interface: PHY interface mode for PCS !! 146 * @state: a pointer to a &struct phylink_link_state.
215 * <<
216 * Return the &struct phylink_pcs for the spec <<
217 * NULL if none is required, or an error point <<
218 * 147 *
219 * This must not modify any state. It is used !! 148 * Read the current inband link state from the MAC PCS, reporting the
220 * be used. Phylink will use this during valid !! 149 * current speed in @state->speed, duplex mode in @state->duplex, pause
221 * configuration is valid, and when setting a !! 150 * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
222 * set the PCS that will be used. !! 151 * negotiation completion state in @state->an_complete, and link up state
>> 152 * in @state->link. If possible, @state->lp_advertising should also be
>> 153 * populated.
223 */ 154 */
224 struct phylink_pcs *mac_select_pcs(struct phyl !! 155 void mac_pcs_get_state(struct phylink_config *config,
225 phy_interfa !! 156 struct phylink_link_state *state);
226 157
227 /** 158 /**
228 * mac_prepare() - prepare to change the PHY i 159 * mac_prepare() - prepare to change the PHY interface mode
229 * @config: a pointer to a &struct phylink_con 160 * @config: a pointer to a &struct phylink_config.
230 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, % 161 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
231 * @iface: interface mode to switch to 162 * @iface: interface mode to switch to
232 * 163 *
233 * phylink will call this method at the beginn 164 * phylink will call this method at the beginning of a full initialisation
234 * of the link, which includes changing the in 165 * of the link, which includes changing the interface mode or at initial
235 * startup time. It may be called for the curr 166 * startup time. It may be called for the current mode. The MAC driver
236 * should perform whatever actions are require 167 * should perform whatever actions are required, e.g. disabling the
237 * Serdes PHY. 168 * Serdes PHY.
238 * 169 *
239 * This will be the first call in the sequence 170 * This will be the first call in the sequence:
240 * - mac_prepare() 171 * - mac_prepare()
241 * - mac_config() 172 * - mac_config()
242 * - pcs_config() 173 * - pcs_config()
243 * - possible pcs_an_restart() 174 * - possible pcs_an_restart()
244 * - mac_finish() 175 * - mac_finish()
245 * 176 *
246 * Returns zero on success, or negative errno 177 * Returns zero on success, or negative errno on failure which will be
247 * reported to the kernel log. 178 * reported to the kernel log.
248 */ 179 */
249 int mac_prepare(struct phylink_config *config, 180 int mac_prepare(struct phylink_config *config, unsigned int mode,
250 phy_interface_t iface); 181 phy_interface_t iface);
251 182
252 /** 183 /**
253 * mac_config() - configure the MAC for the se 184 * mac_config() - configure the MAC for the selected mode and state
254 * @config: a pointer to a &struct phylink_con 185 * @config: a pointer to a &struct phylink_config.
255 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, % 186 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
256 * @state: a pointer to a &struct phylink_link 187 * @state: a pointer to a &struct phylink_link_state.
257 * 188 *
258 * Note - not all members of @state are valid. 189 * Note - not all members of @state are valid. In particular,
259 * @state->lp_advertising, @state->link, @stat 190 * @state->lp_advertising, @state->link, @state->an_complete are never
260 * guaranteed to be correct, and so any mac_co 191 * guaranteed to be correct, and so any mac_config() implementation must
261 * never reference these fields. 192 * never reference these fields.
262 * 193 *
263 * This will only be called to reconfigure the !! 194 * (this requires a rewrite - please refer to mac_link_up() for situations
264 * e.g. interface mode. It will not be called !! 195 * where the PCS and MAC are not tightly integrated.)
265 * or pause modes or to change the in-band adv <<
266 * 196 *
267 * In all negotiation modes, as defined by @mo 197 * In all negotiation modes, as defined by @mode, @state->pause indicates the
268 * pause settings which should be applied as f 198 * pause settings which should be applied as follows. If %MLO_PAUSE_AN is not
269 * set, %MLO_PAUSE_TX and %MLO_PAUSE_RX indica 199 * set, %MLO_PAUSE_TX and %MLO_PAUSE_RX indicate whether the MAC should send
270 * pause frames and/or act on received pause f 200 * pause frames and/or act on received pause frames respectively. Otherwise,
271 * the results of in-band negotiation/status f 201 * the results of in-band negotiation/status from the MAC PCS should be used
272 * to control the MAC pause mode settings. 202 * to control the MAC pause mode settings.
273 * 203 *
274 * The action performed depends on the current 204 * The action performed depends on the currently selected mode:
275 * 205 *
276 * %MLO_AN_FIXED, %MLO_AN_PHY: 206 * %MLO_AN_FIXED, %MLO_AN_PHY:
277 * Configure for non-inband negotiation mode 207 * Configure for non-inband negotiation mode, where the link settings
278 * are completely communicated via mac_link_ 208 * are completely communicated via mac_link_up(). The physical link
279 * protocol from the MAC is specified by @st 209 * protocol from the MAC is specified by @state->interface.
280 * 210 *
281 * @state->advertising may be used, but is n 211 * @state->advertising may be used, but is not required.
282 * 212 *
283 * Older drivers (prior to the mac_link_up() 213 * Older drivers (prior to the mac_link_up() change) may use @state->speed,
284 * @state->duplex and @state->pause to confi 214 * @state->duplex and @state->pause to configure the MAC, but this is
285 * deprecated; such drivers should be conver 215 * deprecated; such drivers should be converted to use mac_link_up().
286 * 216 *
287 * Other members of @state must be ignored. 217 * Other members of @state must be ignored.
288 * 218 *
289 * Valid state members: interface, advertisi 219 * Valid state members: interface, advertising.
290 * Deprecated state members: speed, duplex, 220 * Deprecated state members: speed, duplex, pause.
291 * 221 *
292 * %MLO_AN_INBAND: 222 * %MLO_AN_INBAND:
293 * place the link in an inband negotiation m 223 * place the link in an inband negotiation mode (such as 802.3z
294 * 1000base-X or Cisco SGMII mode depending 224 * 1000base-X or Cisco SGMII mode depending on the @state->interface
295 * mode). In both cases, link state manageme 225 * mode). In both cases, link state management (whether the link
296 * is up or not) is performed by the MAC, an 226 * is up or not) is performed by the MAC, and reported via the
297 * pcs_get_state() callback. Changes in link !! 227 * mac_pcs_get_state() callback. Changes in link state must be made
298 * by calling phylink_mac_change(). 228 * by calling phylink_mac_change().
299 * 229 *
300 * Interface mode specific details are menti 230 * Interface mode specific details are mentioned below.
301 * 231 *
302 * If in 802.3z mode, the link speed is fixe 232 * If in 802.3z mode, the link speed is fixed, dependent on the
303 * @state->interface. Duplex and pause modes 233 * @state->interface. Duplex and pause modes are negotiated via
304 * the in-band configuration word. Advertise 234 * the in-band configuration word. Advertised pause modes are set
305 * according to the @state->an_enabled and @ 235 * according to the @state->an_enabled and @state->advertising
306 * flags. Beware of MACs which only support 236 * flags. Beware of MACs which only support full duplex at gigabit
307 * and higher speeds. 237 * and higher speeds.
308 * 238 *
309 * If in Cisco SGMII mode, the link speed an 239 * If in Cisco SGMII mode, the link speed and duplex mode are passed
310 * in the serial bitstream 16-bit configurat 240 * in the serial bitstream 16-bit configuration word, and the MAC
311 * should be configured to read these bits a 241 * should be configured to read these bits and acknowledge the
312 * configuration word. Nothing is advertised 242 * configuration word. Nothing is advertised by the MAC. The MAC is
313 * responsible for reading the configuration 243 * responsible for reading the configuration word and configuring
314 * itself accordingly. 244 * itself accordingly.
315 * 245 *
316 * Valid state members: interface, an_enable 246 * Valid state members: interface, an_enabled, pause, advertising.
317 * 247 *
318 * Implementations are expected to update the 248 * Implementations are expected to update the MAC to reflect the
319 * requested settings - i.o.w., if nothing has 249 * requested settings - i.o.w., if nothing has changed between two
320 * calls, no action is expected. If only flow 250 * calls, no action is expected. If only flow control settings have
321 * changed, flow control should be updated *wi 251 * changed, flow control should be updated *without* taking the link
322 * down. This "update" behaviour is critical 252 * down. This "update" behaviour is critical to avoid bouncing the
323 * link up status. 253 * link up status.
324 */ 254 */
325 void mac_config(struct phylink_config *config, 255 void mac_config(struct phylink_config *config, unsigned int mode,
326 const struct phylink_link_stat 256 const struct phylink_link_state *state);
327 257
328 /** 258 /**
329 * mac_finish() - finish a to change the PHY i 259 * mac_finish() - finish a to change the PHY interface mode
330 * @config: a pointer to a &struct phylink_con 260 * @config: a pointer to a &struct phylink_config.
331 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, % 261 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
332 * @iface: interface mode to switch to 262 * @iface: interface mode to switch to
333 * 263 *
334 * phylink will call this if it called mac_pre 264 * phylink will call this if it called mac_prepare() to allow the MAC to
335 * complete any necessary steps after the MAC 265 * complete any necessary steps after the MAC and PCS have been configured
336 * for the @mode and @iface. E.g. a MAC driver 266 * for the @mode and @iface. E.g. a MAC driver may wish to re-enable the
337 * Serdes PHY here if it was previously disabl 267 * Serdes PHY here if it was previously disabled by mac_prepare().
338 * 268 *
339 * Returns zero on success, or negative errno 269 * Returns zero on success, or negative errno on failure which will be
340 * reported to the kernel log. 270 * reported to the kernel log.
341 */ 271 */
342 int mac_finish(struct phylink_config *config, 272 int mac_finish(struct phylink_config *config, unsigned int mode,
343 phy_interface_t iface); 273 phy_interface_t iface);
344 274
345 /** 275 /**
>> 276 * mac_an_restart() - restart 802.3z BaseX autonegotiation
>> 277 * @config: a pointer to a &struct phylink_config.
>> 278 */
>> 279 void mac_an_restart(struct phylink_config *config);
>> 280
>> 281 /**
346 * mac_link_down() - take the link down 282 * mac_link_down() - take the link down
347 * @config: a pointer to a &struct phylink_con 283 * @config: a pointer to a &struct phylink_config.
348 * @mode: link autonegotiation mode 284 * @mode: link autonegotiation mode
349 * @interface: link &typedef phy_interface_t m 285 * @interface: link &typedef phy_interface_t mode
350 * 286 *
351 * If @mode is not an in-band negotiation mode 287 * If @mode is not an in-band negotiation mode (as defined by
352 * phylink_autoneg_inband()), force the link d 288 * phylink_autoneg_inband()), force the link down and disable any
353 * Energy Efficient Ethernet MAC configuration 289 * Energy Efficient Ethernet MAC configuration. Interface type
354 * selection must be done in mac_config(). 290 * selection must be done in mac_config().
355 */ 291 */
356 void mac_link_down(struct phylink_config *conf 292 void mac_link_down(struct phylink_config *config, unsigned int mode,
357 phy_interface_t interface); 293 phy_interface_t interface);
358 294
359 /** 295 /**
360 * mac_link_up() - allow the link to come up 296 * mac_link_up() - allow the link to come up
361 * @config: a pointer to a &struct phylink_con 297 * @config: a pointer to a &struct phylink_config.
362 * @phy: any attached phy 298 * @phy: any attached phy
363 * @mode: link autonegotiation mode 299 * @mode: link autonegotiation mode
364 * @interface: link &typedef phy_interface_t m 300 * @interface: link &typedef phy_interface_t mode
365 * @speed: link speed 301 * @speed: link speed
366 * @duplex: link duplex 302 * @duplex: link duplex
367 * @tx_pause: link transmit pause enablement s 303 * @tx_pause: link transmit pause enablement status
368 * @rx_pause: link receive pause enablement st 304 * @rx_pause: link receive pause enablement status
369 * 305 *
370 * Configure the MAC for an established link. 306 * Configure the MAC for an established link.
371 * 307 *
372 * @speed, @duplex, @tx_pause and @rx_pause in 308 * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link
373 * settings, and should be used to configure t 309 * settings, and should be used to configure the MAC block appropriately
374 * where these settings are not automatically 310 * where these settings are not automatically conveyed from the PCS block,
375 * or if in-band negotiation (as defined by ph 311 * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
376 * is disabled. 312 * is disabled.
377 * 313 *
378 * Note that when 802.3z in-band negotiation i 314 * Note that when 802.3z in-band negotiation is in use, it is possible
379 * that the user wishes to override the pause 315 * that the user wishes to override the pause settings, and this should
380 * be allowed when considering the implementat 316 * be allowed when considering the implementation of this method.
381 * 317 *
382 * If in-band negotiation mode is disabled, al 318 * If in-band negotiation mode is disabled, allow the link to come up. If
383 * @phy is non-%NULL, configure Energy Efficie 319 * @phy is non-%NULL, configure Energy Efficient Ethernet by calling
384 * phy_init_eee() and perform appropriate MAC 320 * phy_init_eee() and perform appropriate MAC configuration for EEE.
385 * Interface type selection must be done in ma 321 * Interface type selection must be done in mac_config().
386 */ 322 */
387 void mac_link_up(struct phylink_config *config 323 void mac_link_up(struct phylink_config *config, struct phy_device *phy,
388 unsigned int mode, phy_interf 324 unsigned int mode, phy_interface_t interface,
389 int speed, int duplex, bool t 325 int speed, int duplex, bool tx_pause, bool rx_pause);
390 #endif 326 #endif
391 327
392 struct phylink_pcs_ops; 328 struct phylink_pcs_ops;
393 329
394 /** 330 /**
395 * struct phylink_pcs - PHYLINK PCS instance 331 * struct phylink_pcs - PHYLINK PCS instance
396 * @ops: a pointer to the &struct phylink_pcs_ 332 * @ops: a pointer to the &struct phylink_pcs_ops structure
397 * @phylink: pointer to &struct phylink_config <<
398 * @neg_mode: provide PCS neg mode via "mode" <<
399 * @poll: poll the PCS for link changes 333 * @poll: poll the PCS for link changes
400 * @rxc_always_on: The MAC driver requires the <<
401 * to always be on. Standalone <<
402 * do not have access to a PHY <<
403 * this instead of PHY_F_RXC_A <<
404 * 334 *
405 * This structure is designed to be embedded w 335 * This structure is designed to be embedded within the PCS private data,
406 * and will be passed between phylink and the 336 * and will be passed between phylink and the PCS.
407 * <<
408 * The @phylink member is private to phylink a <<
409 * the PCS driver. <<
410 */ 337 */
411 struct phylink_pcs { 338 struct phylink_pcs {
412 const struct phylink_pcs_ops *ops; 339 const struct phylink_pcs_ops *ops;
413 struct phylink *phylink; <<
414 bool neg_mode; <<
415 bool poll; 340 bool poll;
416 bool rxc_always_on; <<
417 }; 341 };
418 342
419 /** 343 /**
420 * struct phylink_pcs_ops - MAC PCS operations 344 * struct phylink_pcs_ops - MAC PCS operations structure.
421 * @pcs_validate: validate the link configurat <<
422 * @pcs_enable: enable the PCS. <<
423 * @pcs_disable: disable the PCS. <<
424 * @pcs_pre_config: pre-mac_config method (for <<
425 * @pcs_post_config: post-mac_config method (f <<
426 * @pcs_get_state: read the current MAC PCS li 345 * @pcs_get_state: read the current MAC PCS link state from the hardware.
427 * @pcs_config: configure the MAC PCS for the 346 * @pcs_config: configure the MAC PCS for the selected mode and state.
428 * @pcs_an_restart: restart 802.3z BaseX auton 347 * @pcs_an_restart: restart 802.3z BaseX autonegotiation.
429 * @pcs_link_up: program the PCS for the resol 348 * @pcs_link_up: program the PCS for the resolved link configuration
430 * (where necessary). 349 * (where necessary).
431 * @pcs_pre_init: configure PCS components nec <<
432 * initialization e.g. RX clock <<
433 */ 350 */
434 struct phylink_pcs_ops { 351 struct phylink_pcs_ops {
435 int (*pcs_validate)(struct phylink_pcs <<
436 const struct phyli <<
437 int (*pcs_enable)(struct phylink_pcs * <<
438 void (*pcs_disable)(struct phylink_pcs <<
439 void (*pcs_pre_config)(struct phylink_ <<
440 phy_interface_t <<
441 int (*pcs_post_config)(struct phylink_ <<
442 phy_interface_t <<
443 void (*pcs_get_state)(struct phylink_p 352 void (*pcs_get_state)(struct phylink_pcs *pcs,
444 struct phylink_l 353 struct phylink_link_state *state);
445 int (*pcs_config)(struct phylink_pcs * !! 354 int (*pcs_config)(struct phylink_pcs *pcs, unsigned int mode,
446 phy_interface_t inte 355 phy_interface_t interface,
447 const unsigned long 356 const unsigned long *advertising,
448 bool permit_pause_to 357 bool permit_pause_to_mac);
449 void (*pcs_an_restart)(struct phylink_ 358 void (*pcs_an_restart)(struct phylink_pcs *pcs);
450 void (*pcs_link_up)(struct phylink_pcs !! 359 void (*pcs_link_up)(struct phylink_pcs *pcs, unsigned int mode,
451 phy_interface_t in 360 phy_interface_t interface, int speed, int duplex);
452 int (*pcs_pre_init)(struct phylink_pcs <<
453 }; 361 };
454 362
455 #if 0 /* For kernel-doc purposes only. */ 363 #if 0 /* For kernel-doc purposes only. */
456 /** 364 /**
457 * pcs_validate() - validate the link configur <<
458 * @pcs: a pointer to a &struct phylink_pcs. <<
459 * @supported: ethtool bitmask for supported l <<
460 * @state: a const pointer to a &struct phylin <<
461 * <<
462 * Validate the interface mode, and advertisin <<
463 * media ethtool link modes that would not be <<
464 * mask. Phylink will propagate the changes to <<
465 * &struct phylink_mac_ops validate() method. <<
466 * <<
467 * Returns -EINVAL if the interface mode/auton <<
468 * Returns non-zero positive if the link state <<
469 */ <<
470 int pcs_validate(struct phylink_pcs *pcs, unsi <<
471 const struct phylink_link_sta <<
472 <<
473 /** <<
474 * pcs_enable() - enable the PCS. <<
475 * @pcs: a pointer to a &struct phylink_pcs. <<
476 */ <<
477 int pcs_enable(struct phylink_pcs *pcs); <<
478 <<
479 /** <<
480 * pcs_disable() - disable the PCS. <<
481 * @pcs: a pointer to a &struct phylink_pcs. <<
482 */ <<
483 void pcs_disable(struct phylink_pcs *pcs); <<
484 <<
485 /** <<
486 * pcs_get_state() - Read the current inband l 365 * pcs_get_state() - Read the current inband link state from the hardware
487 * @pcs: a pointer to a &struct phylink_pcs. 366 * @pcs: a pointer to a &struct phylink_pcs.
488 * @state: a pointer to a &struct phylink_link 367 * @state: a pointer to a &struct phylink_link_state.
489 * 368 *
490 * Read the current inband link state from the 369 * Read the current inband link state from the MAC PCS, reporting the
491 * current speed in @state->speed, duplex mode 370 * current speed in @state->speed, duplex mode in @state->duplex, pause
492 * mode in @state->pause using the %MLO_PAUSE_ 371 * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
493 * negotiation completion state in @state->an_ 372 * negotiation completion state in @state->an_complete, and link up state
494 * in @state->link. If possible, @state->lp_ad 373 * in @state->link. If possible, @state->lp_advertising should also be
495 * populated. 374 * populated.
>> 375 *
>> 376 * When present, this overrides mac_pcs_get_state() in &struct
>> 377 * phylink_mac_ops.
496 */ 378 */
497 void pcs_get_state(struct phylink_pcs *pcs, 379 void pcs_get_state(struct phylink_pcs *pcs,
498 struct phylink_link_state * 380 struct phylink_link_state *state);
499 381
500 /** 382 /**
501 * pcs_config() - Configure the PCS mode and a 383 * pcs_config() - Configure the PCS mode and advertisement
502 * @pcs: a pointer to a &struct phylink_pcs. 384 * @pcs: a pointer to a &struct phylink_pcs.
503 * @neg_mode: link negotiation mode (see below !! 385 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
504 * @interface: interface mode to be used 386 * @interface: interface mode to be used
505 * @advertising: adertisement ethtool link mod 387 * @advertising: adertisement ethtool link mode mask
506 * @permit_pause_to_mac: permit forwarding pau 388 * @permit_pause_to_mac: permit forwarding pause resolution to MAC
507 * 389 *
508 * Configure the PCS for the operating mode, t 390 * Configure the PCS for the operating mode, the interface mode, and set
509 * the advertisement mask. @permit_pause_to_ma 391 * the advertisement mask. @permit_pause_to_mac indicates whether the
510 * hardware may forward the pause mode resolut 392 * hardware may forward the pause mode resolution to the MAC.
511 * 393 *
512 * When operating in %MLO_AN_INBAND, inband sh 394 * When operating in %MLO_AN_INBAND, inband should always be enabled,
513 * otherwise inband should be disabled. 395 * otherwise inband should be disabled.
514 * 396 *
515 * For SGMII, there is no advertisement from t 397 * For SGMII, there is no advertisement from the MAC side, the PCS should
516 * be programmed to acknowledge the inband wor 398 * be programmed to acknowledge the inband word from the PHY.
517 * 399 *
518 * For 1000BASE-X, the advertisement should be 400 * For 1000BASE-X, the advertisement should be programmed into the PCS.
519 * 401 *
520 * For most 10GBASE-R, there is no advertiseme 402 * For most 10GBASE-R, there is no advertisement.
521 * <<
522 * The %neg_mode argument should be tested via <<
523 * functions, or for PCS that set pcs->neg_mod <<
524 * against the PHYLINK_PCS_NEG_* definitions. <<
525 */ 403 */
526 int pcs_config(struct phylink_pcs *pcs, unsign !! 404 int pcs_config(struct phylink_pcs *pcs, unsigned int mode,
527 phy_interface_t interface, cons 405 phy_interface_t interface, const unsigned long *advertising,
528 bool permit_pause_to_mac); 406 bool permit_pause_to_mac);
529 407
530 /** 408 /**
531 * pcs_an_restart() - restart 802.3z BaseX aut 409 * pcs_an_restart() - restart 802.3z BaseX autonegotiation
532 * @pcs: a pointer to a &struct phylink_pcs. 410 * @pcs: a pointer to a &struct phylink_pcs.
533 * 411 *
534 * When PCS ops are present, this overrides ma 412 * When PCS ops are present, this overrides mac_an_restart() in &struct
535 * phylink_mac_ops. 413 * phylink_mac_ops.
536 */ 414 */
537 void pcs_an_restart(struct phylink_pcs *pcs); 415 void pcs_an_restart(struct phylink_pcs *pcs);
538 416
539 /** 417 /**
540 * pcs_link_up() - program the PCS for the res 418 * pcs_link_up() - program the PCS for the resolved link configuration
541 * @pcs: a pointer to a &struct phylink_pcs. 419 * @pcs: a pointer to a &struct phylink_pcs.
542 * @neg_mode: link negotiation mode (see below !! 420 * @mode: link autonegotiation mode
543 * @interface: link &typedef phy_interface_t m 421 * @interface: link &typedef phy_interface_t mode
544 * @speed: link speed 422 * @speed: link speed
545 * @duplex: link duplex 423 * @duplex: link duplex
546 * 424 *
547 * This call will be made just before mac_link 425 * This call will be made just before mac_link_up() to inform the PCS of
548 * the resolved link parameters. For example, 426 * the resolved link parameters. For example, a PCS operating in SGMII
549 * mode without in-band AN needs to be manuall 427 * mode without in-band AN needs to be manually configured for the link
550 * and duplex setting. Otherwise, this should 428 * and duplex setting. Otherwise, this should be a no-op.
551 * <<
552 * The %mode argument should be tested via the <<
553 * functions, or for PCS that set pcs->neg_mod <<
554 * against the PHYLINK_PCS_NEG_* definitions. <<
555 */ 429 */
556 void pcs_link_up(struct phylink_pcs *pcs, unsi !! 430 void pcs_link_up(struct phylink_pcs *pcs, unsigned int mode,
557 phy_interface_t interface, in 431 phy_interface_t interface, int speed, int duplex);
558 <<
559 /** <<
560 * pcs_pre_init() - Configure PCS components n <<
561 * @pcs: a pointer to a &struct phylink_pcs. <<
562 * <<
563 * This function can be called by MAC drivers <<
564 * phylink_pcs_pre_init() wrapper, before thei <<
565 * should not be called after the link is brou <<
566 * at this point could break the link. <<
567 * <<
568 * Some MAC devices require specific hardware <<
569 * their associated PCS device before they can <<
570 * hardware. An example of this is the initial <<
571 * which requires an active REF_CLK signal to <<
572 * <<
573 * By calling phylink_pcs_pre_init(), MAC driv <<
574 * setup in a way that allows for successful h <<
575 * <<
576 * The specific configuration performed by pcs <<
577 * model of PCS and the requirements of the MA <<
578 * driver authors should consider whether thei <<
579 * conjunction with a MAC device whose driver <<
580 * driver authors should document their requir <<
581 * pre-initialization. <<
582 * <<
583 */ <<
584 int pcs_pre_init(struct phylink_pcs *pcs); <<
585 <<
586 #endif 432 #endif
587 433
588 struct phylink *phylink_create(struct phylink_ !! 434 struct phylink *phylink_create(struct phylink_config *, struct fwnode_handle *,
589 const struct fw !! 435 phy_interface_t iface,
590 phy_interface_t !! 436 const struct phylink_mac_ops *mac_ops);
591 const struct ph !! 437 void phylink_set_pcs(struct phylink *, struct phylink_pcs *pcs);
592 void phylink_destroy(struct phylink *); 438 void phylink_destroy(struct phylink *);
593 bool phylink_expects_phy(struct phylink *pl); <<
594 439
595 int phylink_connect_phy(struct phylink *, stru 440 int phylink_connect_phy(struct phylink *, struct phy_device *);
596 int phylink_of_phy_connect(struct phylink *, s 441 int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);
597 int phylink_fwnode_phy_connect(struct phylink <<
598 const struct fw <<
599 u32 flags); <<
600 void phylink_disconnect_phy(struct phylink *); 442 void phylink_disconnect_phy(struct phylink *);
601 int phylink_set_fixed_link(struct phylink *, <<
602 const struct phylin <<
603 443
604 void phylink_mac_change(struct phylink *, bool 444 void phylink_mac_change(struct phylink *, bool up);
605 void phylink_pcs_change(struct phylink_pcs *, <<
606 <<
607 int phylink_pcs_pre_init(struct phylink *pl, s <<
608 445
609 void phylink_start(struct phylink *); 446 void phylink_start(struct phylink *);
610 void phylink_stop(struct phylink *); 447 void phylink_stop(struct phylink *);
611 448
612 void phylink_suspend(struct phylink *pl, bool <<
613 void phylink_resume(struct phylink *pl); <<
614 <<
615 void phylink_ethtool_get_wol(struct phylink *, 449 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
616 int phylink_ethtool_set_wol(struct phylink *, 450 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
617 451
618 int phylink_ethtool_ksettings_get(struct phyli 452 int phylink_ethtool_ksettings_get(struct phylink *,
619 struct ethto 453 struct ethtool_link_ksettings *);
620 int phylink_ethtool_ksettings_set(struct phyli 454 int phylink_ethtool_ksettings_set(struct phylink *,
621 const struct 455 const struct ethtool_link_ksettings *);
622 int phylink_ethtool_nway_reset(struct phylink 456 int phylink_ethtool_nway_reset(struct phylink *);
623 void phylink_ethtool_get_pauseparam(struct phy 457 void phylink_ethtool_get_pauseparam(struct phylink *,
624 struct eth 458 struct ethtool_pauseparam *);
625 int phylink_ethtool_set_pauseparam(struct phyl 459 int phylink_ethtool_set_pauseparam(struct phylink *,
626 struct etht 460 struct ethtool_pauseparam *);
627 int phylink_get_eee_err(struct phylink *); 461 int phylink_get_eee_err(struct phylink *);
628 int phylink_init_eee(struct phylink *, bool); 462 int phylink_init_eee(struct phylink *, bool);
629 int phylink_ethtool_get_eee(struct phylink *li !! 463 int phylink_ethtool_get_eee(struct phylink *, struct ethtool_eee *);
630 int phylink_ethtool_set_eee(struct phylink *li !! 464 int phylink_ethtool_set_eee(struct phylink *, struct ethtool_eee *);
631 int phylink_mii_ioctl(struct phylink *, struct 465 int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);
632 int phylink_speed_down(struct phylink *pl, boo 466 int phylink_speed_down(struct phylink *pl, bool sync);
633 int phylink_speed_up(struct phylink *pl); 467 int phylink_speed_up(struct phylink *pl);
634 468
635 #define phylink_zero(bm) \ 469 #define phylink_zero(bm) \
636 bitmap_zero(bm, __ETHTOOL_LINK_MODE_MA 470 bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)
637 #define __phylink_do_bit(op, bm, mode) \ 471 #define __phylink_do_bit(op, bm, mode) \
638 op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, 472 op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
639 473
640 #define phylink_set(bm, mode) __phylink_do_b 474 #define phylink_set(bm, mode) __phylink_do_bit(__set_bit, bm, mode)
641 #define phylink_clear(bm, mode) __phylink_do_b 475 #define phylink_clear(bm, mode) __phylink_do_bit(__clear_bit, bm, mode)
642 #define phylink_test(bm, mode) __phylink_do_b 476 #define phylink_test(bm, mode) __phylink_do_bit(test_bit, bm, mode)
643 477
644 void phylink_set_port_modes(unsigned long *bit 478 void phylink_set_port_modes(unsigned long *bits);
>> 479 void phylink_helper_basex_speed(struct phylink_link_state *state);
645 480
646 /** <<
647 * phylink_get_link_timer_ns - return the PCS <<
648 * @interface: link &typedef phy_interface_t m <<
649 * <<
650 * Return the PCS link timer setting in nanose <<
651 * mode, or -EINVAL if not appropriate. <<
652 */ <<
653 static inline int phylink_get_link_timer_ns(ph <<
654 { <<
655 switch (interface) { <<
656 case PHY_INTERFACE_MODE_SGMII: <<
657 case PHY_INTERFACE_MODE_QSGMII: <<
658 case PHY_INTERFACE_MODE_USXGMII: <<
659 case PHY_INTERFACE_MODE_10G_QXGMII: <<
660 return 1600000; <<
661 <<
662 case PHY_INTERFACE_MODE_1000BASEX: <<
663 case PHY_INTERFACE_MODE_2500BASEX: <<
664 return 10000000; <<
665 <<
666 default: <<
667 return -EINVAL; <<
668 } <<
669 } <<
670 <<
671 void phylink_mii_c22_pcs_decode_state(struct p <<
672 u16 bmsr <<
673 void phylink_mii_c22_pcs_get_state(struct mdio 481 void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
674 struct phyl 482 struct phylink_link_state *state);
675 int phylink_mii_c22_pcs_encode_advertisement(p !! 483 int phylink_mii_c22_pcs_set_advertisement(struct mdio_device *pcs,
676 c !! 484 phy_interface_t interface,
677 int phylink_mii_c22_pcs_config(struct mdio_dev !! 485 const unsigned long *advertising);
>> 486 int phylink_mii_c22_pcs_config(struct mdio_device *pcs, unsigned int mode,
678 phy_interface_t 487 phy_interface_t interface,
679 const unsigned !! 488 const unsigned long *advertising);
680 unsigned int ne <<
681 void phylink_mii_c22_pcs_an_restart(struct mdi 489 void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs);
682 490
683 void phylink_resolve_c73(struct phylink_link_s <<
684 <<
685 void phylink_mii_c45_pcs_get_state(struct mdio 491 void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
686 struct phyl 492 struct phylink_link_state *state);
687 <<
688 void phylink_decode_usxgmii_word(struct phylin <<
689 uint16_t lpa) <<
690 #endif 493 #endif
691 494
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.