Something went wrong. Try again.
(I'm so sorry!) Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849#ifndef NETDEV_PCS_H#define NETDEV_PCS_H
#include <linux/phy.h>#include <linux/spinlock.h>#include <linux/workqueue.h>
#include <net/eee.h>
struct device_node;struct ethtool_cmd;struct fwnode_handle;struct net_device;struct phylink;
enum { MLO_PAUSE_NONE, MLO_PAUSE_RX = BIT(0), MLO_PAUSE_TX = BIT(1), MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX, MLO_PAUSE_AN = BIT(2),
MLO_AN_PHY = 0, /* Conventional PHY */ MLO_AN_FIXED, /* Fixed-link mode */ MLO_AN_INBAND, /* In-band protocol */
/* PCS "negotiation" mode. * PHYLINK_PCS_NEG_NONE - protocol has no inband capability * PHYLINK_PCS_NEG_OUTBAND - some out of band or fixed link setting * PHYLINK_PCS_NEG_INBAND_DISABLED - inband mode disabled, e.g. * 1000base-X with autoneg off * PHYLINK_PCS_NEG_INBAND_ENABLED - inband mode enabled * Additionally, this can be tested using bitmasks: * PHYLINK_PCS_NEG_INBAND - inband mode selected * PHYLINK_PCS_NEG_ENABLED - negotiation mode enabled */ PHYLINK_PCS_NEG_NONE = 0, PHYLINK_PCS_NEG_ENABLED = BIT(4), PHYLINK_PCS_NEG_OUTBAND = BIT(5), PHYLINK_PCS_NEG_INBAND = BIT(6), PHYLINK_PCS_NEG_INBAND_DISABLED = PHYLINK_PCS_NEG_INBAND, PHYLINK_PCS_NEG_INBAND_ENABLED = PHYLINK_PCS_NEG_INBAND | PHYLINK_PCS_NEG_ENABLED,
/* MAC_SYM_PAUSE and MAC_ASYM_PAUSE are used when configuring our * autonegotiation advertisement. They correspond to the PAUSE and * ASM_DIR bits defined by 802.3, respectively. * * The following table lists the values of tx_pause and rx_pause which * might be requested in mac_link_up. The exact values depend on either * the results of autonegotation (if MLO_PAUSE_AN is set) or user * configuration (if MLO_PAUSE_AN is not set). * * MAC_SYM_PAUSE MAC_ASYM_PAUSE MLO_PAUSE_AN tx_pause/rx_pause * ============= ============== ============ ================== * 0 0 0 0/0 * 0 0 1 0/0 * 0 1 0 0/0, 0/1, 1/0, 1/1 * 0 1 1 0/0, 1/0 * 1 0 0 0/0, 1/1 * 1 0 1 0/0, 1/1 * 1 1 0 0/0, 0/1, 1/0, 1/1 * 1 1 1 0/0, 0/1, 1/1 * * If you set MAC_ASYM_PAUSE, the user may request any combination of * tx_pause and rx_pause. You do not have to support these * combinations. * * However, you should support combinations of tx_pause and rx_pause * which might be the result of autonegotation. For example, don't set * MAC_SYM_PAUSE unless your device can support tx_pause and rx_pause * at the same time. */ MAC_SYM_PAUSE = BIT(0), MAC_ASYM_PAUSE = BIT(1), MAC_10HD = BIT(2), MAC_10FD = BIT(3), MAC_10 = MAC_10HD | MAC_10FD, MAC_100HD = BIT(4), MAC_100FD = BIT(5), MAC_100 = MAC_100HD | MAC_100FD, MAC_1000HD = BIT(6), MAC_1000FD = BIT(7), MAC_1000 = MAC_1000HD | MAC_1000FD, MAC_2500FD = BIT(8), MAC_5000FD = BIT(9), MAC_10000FD = BIT(10), MAC_20000FD = BIT(11), MAC_25000FD = BIT(12), MAC_40000FD = BIT(13), MAC_50000FD = BIT(14), MAC_56000FD = BIT(15), MAC_80000FD = BIT(16), MAC_100000FD = BIT(17), MAC_200000FD = BIT(18), MAC_400000FD = BIT(19),};
static inline bool phylink_autoneg_inband(unsigned int mode){ return mode == MLO_AN_INBAND;}
/** * struct phylink_link_state - link state structure * @advertising: ethtool bitmask containing advertised link modes * @lp_advertising: ethtool bitmask containing link partner advertised link * modes * @interface: link &typedef phy_interface_t mode * @speed: link speed, one of the SPEED_* constants. * @duplex: link duplex mode, one of DUPLEX_* constants. * @pause: link pause state, described by MLO_PAUSE_* constants. * @rate_matching: rate matching being performed, one of the RATE_MATCH_* * constants. If rate matching is taking place, then the speed/duplex of * the medium link mode (@speed and @duplex) and the speed/duplex of the phy * interface mode (@interface) are different. * @link: true if the link is up. * @an_complete: true if autonegotiation has completed. */struct phylink_link_state { __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising); __ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising); phy_interface_t interface; int speed; int duplex; int pause; int rate_matching; unsigned int link:1; unsigned int an_complete:1;};
enum phylink_op_type { PHYLINK_NETDEV = 0, PHYLINK_DEV,};
/** * struct phylink_config - PHYLINK configuration structure * @dev: a pointer to a struct device associated with the MAC * @type: operation type of PHYLINK instance * @poll_fixed_state: if true, starts link_poll, * if MAC link is at %MLO_AN_FIXED mode. * @mac_managed_pm: if true, indicate the MAC driver is responsible for PHY PM. * @mac_requires_rxc: if true, the MAC always requires a receive clock from PHY. * The PHY driver should start the clock signal as soon as * possible and avoid stopping it during suspend events. * @default_an_inband: if true, defaults to MLO_AN_INBAND rather than * MLO_AN_PHY. A fixed-link specification will override. * @eee_rx_clk_stop_enable: if true, PHY can stop the receive clock during LPI * @get_fixed_state: callback to execute to determine the fixed link state, * if MAC link is at %MLO_AN_FIXED mode. * @supported_interfaces: bitmap describing which PHY_INTERFACE_MODE_xxx * are supported by the MAC/PCS. * @lpi_interfaces: bitmap describing which PHY interface modes can support * LPI signalling. * @mac_capabilities: MAC pause/speed/duplex capabilities. * @lpi_capabilities: MAC speeds which can support LPI signalling * @lpi_timer_default: Default EEE LPI timer setting. * @eee_enabled_default: If set, EEE will be enabled by phylink at creation time * @wol_phy_legacy: Use Wake-on-Lan with PHY even if phy_can_wakeup() is false * @wol_phy_speed_ctrl: Use phy speed control on suspend/resume * @wol_mac_support: Bitmask of MAC supported %WAKE_* options */struct phylink_config { struct device *dev; enum phylink_op_type type; bool poll_fixed_state; bool mac_managed_pm; bool mac_requires_rxc; bool default_an_inband; bool eee_rx_clk_stop_enable; void (*get_fixed_state)(struct phylink_config *config, struct phylink_link_state *state); DECLARE_PHY_INTERFACE_MASK(supported_interfaces); DECLARE_PHY_INTERFACE_MASK(lpi_interfaces); unsigned long mac_capabilities; unsigned long lpi_capabilities; u32 lpi_timer_default; bool eee_enabled_default;
/* Wake-on-Lan support */ bool wol_phy_legacy; bool wol_phy_speed_ctrl; u32 wol_mac_support;};
void phylink_limit_mac_speed(struct phylink_config *config, u32 max_speed);
/** * struct phylink_mac_ops - MAC operations structure. * @mac_get_caps: Get MAC capabilities for interface mode. * @mac_select_pcs: Select a PCS for the interface mode. * @mac_prepare: prepare for a major reconfiguration of the interface. * @mac_config: configure the MAC for the selected mode and state. * @mac_finish: finish a major reconfiguration of the interface. * @mac_link_down: take the link down. * @mac_link_up: allow the link to come up. * @mac_disable_tx_lpi: disable LPI. * @mac_enable_tx_lpi: enable and configure LPI. * @mac_wol_set: configure Wake-on-Lan settings at the MAC. * * The individual methods are described more fully below. */struct phylink_mac_ops { unsigned long (*mac_get_caps)(struct phylink_config *config, phy_interface_t interface); struct phylink_pcs *(*mac_select_pcs)(struct phylink_config *config, phy_interface_t interface); int (*mac_prepare)(struct phylink_config *config, unsigned int mode, phy_interface_t iface); void (*mac_config)(struct phylink_config *config, unsigned int mode, const struct phylink_link_state *state); int (*mac_finish)(struct phylink_config *config, unsigned int mode, phy_interface_t iface); void (*mac_link_down)(struct phylink_config *config, unsigned int mode, phy_interface_t interface); void (*mac_link_up)(struct phylink_config *config, struct phy_device *phy, unsigned int mode, phy_interface_t interface, int speed, int duplex, bool tx_pause, bool rx_pause); void (*mac_disable_tx_lpi)(struct phylink_config *config); int (*mac_enable_tx_lpi)(struct phylink_config *config, u32 timer, bool tx_clk_stop);
int (*mac_wol_set)(struct phylink_config *config, u32 wolopts, const u8 *sopass);};
#if 0 /* For kernel-doc purposes only. *//** * mac_get_caps: Get MAC capabilities for interface mode. * @config: a pointer to a &struct phylink_config. * @interface: PHY interface mode. * * Optional method. When not provided, config->mac_capabilities will be used. * When implemented, this returns the MAC capabilities for the specified * interface mode where there is some special handling required by the MAC * driver (e.g. not supporting half-duplex in certain interface modes.) */unsigned long mac_get_caps(struct phylink_config *config, phy_interface_t interface);/** * mac_select_pcs: Select a PCS for the interface mode. * @config: a pointer to a &struct phylink_config. * @interface: PHY interface mode for PCS * * Return the &struct phylink_pcs for the specified interface mode, or * NULL if none is required, or an error pointer on error. * * This must not modify any state. It is used to query which PCS should * be used. Phylink will use this during validation to ensure that the * configuration is valid, and when setting a configuration to internally * set the PCS that will be used. */struct phylink_pcs *mac_select_pcs(struct phylink_config *config, phy_interface_t interface);
/** * mac_prepare() - prepare to change the PHY interface mode * @config: a pointer to a &struct phylink_config. * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND. * @iface: interface mode to switch to * * phylink will call this method at the beginning of a full initialisation * of the link, which includes changing the interface mode or at initial * startup time. It may be called for the current mode. The MAC driver * should perform whatever actions are required, e.g. disabling the * Serdes PHY. * * This will be the first call in the sequence: * - mac_prepare() * - mac_config() * - pcs_config() * - possible pcs_an_restart() * - mac_finish() * * Returns zero on success, or negative errno on failure which will be * reported to the kernel log. */int mac_prepare(struct phylink_config *config, unsigned int mode, phy_interface_t iface);
/** * mac_config() - configure the MAC for the selected mode and state * @config: a pointer to a &struct phylink_config. * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND. * @state: a pointer to a &struct phylink_link_state. * * Note - not all members of @state are valid. In particular, * @state->lp_advertising, @state->link, @state->an_complete are never * guaranteed to be correct, and so any mac_config() implementation must * never reference these fields. * * This will only be called to reconfigure the MAC for a "major" change in * e.g. interface mode. It will not be called for changes in speed, duplex * or pause modes or to change the in-band advertisement. * * In all negotiation modes, as defined by @mode, @state->pause indicates the * pause settings which should be applied as follows. If %MLO_PAUSE_AN is not * set, %MLO_PAUSE_TX and %MLO_PAUSE_RX indicate whether the MAC should send * pause frames and/or act on received pause frames respectively. Otherwise, * the results of in-band negotiation/status from the MAC PCS should be used * to control the MAC pause mode settings. * * The action performed depends on the currently selected mode: * * %MLO_AN_FIXED, %MLO_AN_PHY: * Configure for non-inband negotiation mode, where the link settings * are completely communicated via mac_link_up(). The physical link * protocol from the MAC is specified by @state->interface. * * @state->advertising may be used, but is not required. * * Older drivers (prior to the mac_link_up() change) may use @state->speed, * @state->duplex and @state->pause to configure the MAC, but this is * deprecated; such drivers should be converted to use mac_link_up(). * * Other members of @state must be ignored. * * Valid state members: interface, advertising. * Deprecated state members: speed, duplex, pause. * * %MLO_AN_INBAND: * place the link in an inband negotiation mode (such as 802.3z * 1000base-X or Cisco SGMII mode depending on the @state->interface * mode). In both cases, link state management (whether the link * is up or not) is performed by the MAC, and reported via the * pcs_get_state() callback. Changes in link state must be made * by calling phylink_mac_change(). * * Interface mode specific details are mentioned below. * * If in 802.3z mode, the link speed is fixed, dependent on the * @state->interface. Duplex and pause modes are negotiated via * the in-band configuration word. Advertised pause modes are set * according to @state->advertising. Beware of MACs which only * support full duplex at gigabit and higher speeds. * * If in Cisco SGMII mode, the link speed and duplex mode are passed * in the serial bitstream 16-bit configuration word, and the MAC * should be configured to read these bits and acknowledge the * configuration word. Nothing is advertised by the MAC. The MAC is * responsible for reading the configuration word and configuring * itself accordingly. * * Valid state members: interface, pause, advertising. * * Implementations are expected to update the MAC to reflect the * requested settings - i.o.w., if nothing has changed between two * calls, no action is expected. If only flow control settings have * changed, flow control should be updated *without* taking the link * down. This "update" behaviour is critical to avoid bouncing the * link up status. */void mac_config(struct phylink_config *config, unsigned int mode, const struct phylink_link_state *state);
/** * mac_finish() - finish a to change the PHY interface mode * @config: a pointer to a &struct phylink_config. * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND. * @iface: interface mode to switch to * * phylink will call this if it called mac_prepare() to allow the MAC to * complete any necessary steps after the MAC and PCS have been configured * for the @mode and @iface. E.g. a MAC driver may wish to re-enable the * Serdes PHY here if it was previously disabled by mac_prepare(). * * Returns zero on success, or negative errno on failure which will be * reported to the kernel log. */int mac_finish(struct phylink_config *config, unsigned int mode, phy_interface_t iface);
/** * mac_link_down() - notification that the link has gone down * @config: a pointer to a &struct phylink_config. * @mode: link autonegotiation mode * @interface: link &typedef phy_interface_t mode * * Notifies the MAC that the link has gone down. This will not be called * unless mac_link_up() has been previously called. * * The MAC should stop processing packets for transmission and reception. * phylink will have called netif_carrier_off() to notify the networking * stack that the link has gone down, so MAC drivers should not make this * call. * * If @mode is %MLO_AN_INBAND, then this function must not prevent the * link coming up. */void mac_link_down(struct phylink_config *config, unsigned int mode, phy_interface_t interface);
/** * mac_link_up() - notification that the link has come up * @config: a pointer to a &struct phylink_config. * @phy: any attached phy (deprecated - please use LPI interfaces) * @mode: link autonegotiation mode * @interface: link &typedef phy_interface_t mode * @speed: link speed * @duplex: link duplex * @tx_pause: link transmit pause enablement status * @rx_pause: link receive pause enablement status * * Notifies the MAC that the link has come up, and the parameters of the * link as seen from the MACs point of view. If mac_link_up() has been * called previously, there will be an intervening call to mac_link_down() * before this method will be subsequently called. * * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link * settings, and should be used to configure the MAC block appropriately * where these settings are not automatically conveyed from the PCS block, * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode)) * is disabled. * * Note that when 802.3z in-band negotiation is in use, it is possible * that the user wishes to override the pause settings, and this should * be allowed when considering the implementation of this method. * * Once configured, the MAC may begin to process packets for transmission * and reception. * * Interface type selection must be done in mac_config(). */void mac_link_up(struct phylink_config *config, struct phy_device *phy, unsigned int mode, phy_interface_t interface, int speed, int duplex, bool tx_pause, bool rx_pause);
/** * mac_disable_tx_lpi() - disable LPI generation at the MAC * @config: a pointer to a &struct phylink_config. * * Disable generation of LPI at the MAC, effectively preventing the MAC * from indicating that it is idle. */void mac_disable_tx_lpi(struct phylink_config *config);
/** * mac_enable_tx_lpi() - configure and enable LPI generation at the MAC * @config: a pointer to a &struct phylink_config. * @timer: LPI timeout in microseconds. * @tx_clk_stop: allow xMII transmit clock to be stopped during LPI * * Configure the LPI timeout accordingly. This will only be called when * the link is already up, to cater for situations where the hardware * needs to be programmed according to the link speed. * * Enable LPI generation at the MAC, and configure whether the xMII transmit * clock may be stopped. * * Returns: 0 on success. Please consult with rmk before returning an error. */int mac_enable_tx_lpi(struct phylink_config *config, u32 timer, bool tx_clk_stop);
/** * mac_wol_set() - configure the Wake-on-Lan parameters * @config: a pointer to a &struct phylink_config. * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes. * @sopass: SecureOn(tm) password; meaningful only for %WAKE_MAGICSECURE * * Enable the specified Wake-on-Lan options at the MAC. Options that the * PHY can handle will have been removed from @wolopts. * * The presence of this method enables phylink-managed WoL support. * * Returns: 0 on success. */int (*mac_wol_set)(struct phylink_config *config, u32 wolopts, const u8 *sopass);#endif
struct phylink_pcs_ops;
/** * struct phylink_pcs - PHYLINK PCS instance * @supported_interfaces: describing which PHY_INTERFACE_MODE_xxx * are supported by this PCS. * @ops: a pointer to the &struct phylink_pcs_ops structure * @phylink: pointer to &struct phylink_config * @poll: poll the PCS for link changes * @rxc_always_on: The MAC driver requires the reference clock * to always be on. Standalone PCS drivers which * do not have access to a PHY device can check * this instead of PHY_F_RXC_ALWAYS_ON. * * This structure is designed to be embedded within the PCS private data, * and will be passed between phylink and the PCS. * * The @phylink member is private to phylink and must not be touched by * the PCS driver. */struct phylink_pcs { DECLARE_PHY_INTERFACE_MASK(supported_interfaces); const struct phylink_pcs_ops *ops; struct phylink *phylink; bool poll; bool rxc_always_on;};
/** * struct phylink_pcs_ops - MAC PCS operations structure. * @pcs_validate: validate the link configuration. * @pcs_inband_caps: query inband support for interface mode. * @pcs_enable: enable the PCS. * @pcs_disable: disable the PCS. * @pcs_pre_config: pre-mac_config method (for errata) * @pcs_post_config: post-mac_config method (for arrata) * @pcs_get_state: read the current MAC PCS link state from the hardware. * @pcs_config: configure the MAC PCS for the selected mode and state. * @pcs_an_restart: restart 802.3z BaseX autonegotiation. * @pcs_link_up: program the PCS for the resolved link configuration * (where necessary). * @pcs_disable_eee: optional notification to PCS that EEE has been disabled * at the MAC. * @pcs_enable_eee: optional notification to PCS that EEE will be enabled at * the MAC. * @pcs_pre_init: configure PCS components necessary for MAC hardware * initialization e.g. RX clock for stmmac. */struct phylink_pcs_ops { int (*pcs_validate)(struct phylink_pcs *pcs, unsigned long *supported, const struct phylink_link_state *state); unsigned int (*pcs_inband_caps)(struct phylink_pcs *pcs, phy_interface_t interface); int (*pcs_enable)(struct phylink_pcs *pcs); void (*pcs_disable)(struct phylink_pcs *pcs); void (*pcs_pre_config)(struct phylink_pcs *pcs, phy_interface_t interface); int (*pcs_post_config)(struct phylink_pcs *pcs, phy_interface_t interface); void (*pcs_get_state)(struct phylink_pcs *pcs, unsigned int neg_mode, struct phylink_link_state *state); int (*pcs_config)(struct phylink_pcs *pcs, unsigned int neg_mode, phy_interface_t interface, const unsigned long *advertising, bool permit_pause_to_mac); void (*pcs_an_restart)(struct phylink_pcs *pcs); void (*pcs_link_up)(struct phylink_pcs *pcs, unsigned int neg_mode, phy_interface_t interface, int speed, int duplex); void (*pcs_disable_eee)(struct phylink_pcs *pcs); void (*pcs_enable_eee)(struct phylink_pcs *pcs); int (*pcs_pre_init)(struct phylink_pcs *pcs);};
#if 0 /* For kernel-doc purposes only. *//** * pcs_validate() - validate the link configuration. * @pcs: a pointer to a &struct phylink_pcs. * @supported: ethtool bitmask for supported link modes. * @state: a const pointer to a &struct phylink_link_state. * * Validate the interface mode, and advertising's autoneg bit, removing any * media ethtool link modes that would not be supportable from the supported * mask. Phylink will propagate the changes to the advertising mask. See the * &struct phylink_mac_ops validate() method. * * Returns -EINVAL if the interface mode/autoneg mode is not supported. * Returns non-zero positive if the link state can be supported. */int pcs_validate(struct phylink_pcs *pcs, unsigned long *supported, const struct phylink_link_state *state);
/** * pcs_inband_caps - query PCS in-band capabilities for interface mode. * @pcs: a pointer to a &struct phylink_pcs. * @interface: interface mode to be queried * * Returns zero if it is unknown what in-band signalling is supported by the * PHY (e.g. because the PHY driver doesn't implement the method.) Otherwise, * returns a bit mask of the LINK_INBAND_* values from * &enum link_inband_signalling to describe which inband modes are supported * for this interface mode. */unsigned int pcs_inband_caps(struct phylink_pcs *pcs, phy_interface_t interface);
/** * pcs_enable() - enable the PCS. * @pcs: a pointer to a &struct phylink_pcs. */int pcs_enable(struct phylink_pcs *pcs);
/** * pcs_disable() - disable the PCS. * @pcs: a pointer to a &struct phylink_pcs. */void pcs_disable(struct phylink_pcs *pcs);
/** * pcs_get_state() - Read the current inband link state from the hardware * @pcs: a pointer to a &struct phylink_pcs. * @neg_mode: link negotiation mode (PHYLINK_PCS_NEG_xxx) * @state: a pointer to a &struct phylink_link_state. * * Read the current inband link state from the MAC PCS, reporting the * current speed in @state->speed, duplex mode in @state->duplex, pause * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits, * negotiation completion state in @state->an_complete, and link up state * in @state->link. If possible, @state->lp_advertising should also be * populated. * * Note that the @neg_mode parameter is always the PHYLINK_PCS_NEG_xxx * state, not MLO_AN_xxx. */void pcs_get_state(struct phylink_pcs *pcs, unsigned int neg_mode, struct phylink_link_state *state);
/** * pcs_config() - Configure the PCS mode and advertisement * @pcs: a pointer to a &struct phylink_pcs. * @neg_mode: link negotiation mode (see below) * @interface: interface mode to be used * @advertising: adertisement ethtool link mode mask * @permit_pause_to_mac: permit forwarding pause resolution to MAC * * Configure the PCS for the operating mode, the interface mode, and set * the advertisement mask. @permit_pause_to_mac indicates whether the * hardware may forward the pause mode resolution to the MAC. * * When operating in %MLO_AN_INBAND, inband should always be enabled, * otherwise inband should be disabled. * * For SGMII, there is no advertisement from the MAC side, the PCS should * be programmed to acknowledge the inband word from the PHY. * * For 1000BASE-X, the advertisement should be programmed into the PCS. * * For most 10GBASE-R, there is no advertisement. * * The %neg_mode argument should be tested via the phylink_mode_*() family of * functions, or for PCS that set pcs->neg_mode true, should be tested * against the PHYLINK_PCS_NEG_* definitions. * * pcs_config() will be called when configuration of the PCS is required * or when the advertisement is possibly updated. It must not unnecessarily * disrupt an established link. * * When an autonegotiation restart is required for 802.3z modes, .pcs_config() * should return a positive non-zero integer (e.g. 1) to indicate to phylink * to call the pcs_an_restart() method. */int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode, phy_interface_t interface, const unsigned long *advertising, bool permit_pause_to_mac);
/** * pcs_an_restart() - restart 802.3z BaseX autonegotiation * @pcs: a pointer to a &struct phylink_pcs. * * When PCS ops are present, this overrides mac_an_restart() in &struct * phylink_mac_ops. */void pcs_an_restart(struct phylink_pcs *pcs);
/** * pcs_link_up() - program the PCS for the resolved link configuration * @pcs: a pointer to a &struct phylink_pcs. * @neg_mode: link negotiation mode (see below) * @interface: link &typedef phy_interface_t mode * @speed: link speed * @duplex: link duplex * * This call will be made just before mac_link_up() to inform the PCS of * the resolved link parameters. For example, a PCS operating in SGMII * mode without in-band AN needs to be manually configured for the link * and duplex setting. Otherwise, this should be a no-op. * * The %mode argument should be tested via the phylink_mode_*() family of * functions, or for PCS that set pcs->neg_mode true, should be tested * against the PHYLINK_PCS_NEG_* definitions. */void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode, phy_interface_t interface, int speed, int duplex);
/** * pcs_disable_eee() - Disable EEE at the PCS * @pcs: a pointer to a &struct phylink_pcs * * Optional method informing the PCS that EEE has been disabled at the MAC. */void pcs_disable_eee(struct phylink_pcs *pcs);
/** * pcs_enable_eee() - Enable EEE at the PCS * @pcs: a pointer to a &struct phylink_pcs * * Optional method informing the PCS that EEE is about to be enabled at the MAC. */void pcs_enable_eee(struct phylink_pcs *pcs);
/** * pcs_pre_init() - Configure PCS components necessary for MAC initialization * @pcs: a pointer to a &struct phylink_pcs. * * This function can be called by MAC drivers through the * phylink_pcs_pre_init() wrapper, before their hardware is initialized. It * should not be called after the link is brought up, as reconfiguring the PCS * at this point could break the link. * * Some MAC devices require specific hardware initialization to be performed by * their associated PCS device before they can properly initialize their own * hardware. An example of this is the initialization of stmmac controllers, * which requires an active REF_CLK signal to be provided by the PHY/PCS. * * By calling phylink_pcs_pre_init(), MAC drivers can ensure that the PCS is * setup in a way that allows for successful hardware initialization. * * The specific configuration performed by pcs_pre_init() is dependent on the * model of PCS and the requirements of the MAC device attached to it. PCS * driver authors should consider whether their target device is to be used in * conjunction with a MAC device whose driver calls phylink_pcs_pre_init(). MAC * driver authors should document their requirements for the PCS * pre-initialization. * */int pcs_pre_init(struct phylink_pcs *pcs);
#endif
struct phylink *phylink_create(struct phylink_config *, const struct fwnode_handle *, phy_interface_t, const struct phylink_mac_ops *);void phylink_destroy(struct phylink *);bool phylink_expects_phy(struct phylink *pl);
int phylink_connect_phy(struct phylink *, struct phy_device *);int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);int phylink_fwnode_phy_connect(struct phylink *pl, const struct fwnode_handle *fwnode, u32 flags);void phylink_disconnect_phy(struct phylink *);int phylink_set_fixed_link(struct phylink *, const struct phylink_link_state *);
void phylink_mac_change(struct phylink *, bool up);void phylink_pcs_change(struct phylink_pcs *, bool up);
int phylink_pcs_pre_init(struct phylink *pl, struct phylink_pcs *pcs);
void phylink_start(struct phylink *);void phylink_stop(struct phylink *);
void phylink_rx_clk_stop_block(struct phylink *);void phylink_rx_clk_stop_unblock(struct phylink *);
void phylink_suspend(struct phylink *pl, bool mac_wol);void phylink_prepare_resume(struct phylink *pl);void phylink_resume(struct phylink *pl);
void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
int phylink_ethtool_ksettings_get(struct phylink *, struct ethtool_link_ksettings *);int phylink_ethtool_ksettings_set(struct phylink *, const struct ethtool_link_ksettings *);int phylink_ethtool_nway_reset(struct phylink *);void phylink_ethtool_get_pauseparam(struct phylink *, struct ethtool_pauseparam *);int phylink_ethtool_set_pauseparam(struct phylink *, struct ethtool_pauseparam *);int phylink_get_eee_err(struct phylink *);int phylink_ethtool_get_eee(struct phylink *link, struct ethtool_keee *eee);int phylink_ethtool_set_eee(struct phylink *link, struct ethtool_keee *eee);int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);int phylink_speed_down(struct phylink *pl, bool sync);int phylink_speed_up(struct phylink *pl);
#define phylink_zero(bm) \ bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)#define __phylink_do_bit(op, bm, mode) \ op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
#define phylink_set(bm, mode) __phylink_do_bit(__set_bit, bm, mode)#define phylink_clear(bm, mode) __phylink_do_bit(__clear_bit, bm, mode)#define phylink_test(bm, mode) __phylink_do_bit(test_bit, bm, mode)
void phylink_set_port_modes(unsigned long *bits);
/** * phylink_get_link_timer_ns - return the PCS link timer value * @interface: link &typedef phy_interface_t mode * * Return the PCS link timer setting in nanoseconds for the PHY @interface * mode, or -EINVAL if not appropriate. */static inline int phylink_get_link_timer_ns(phy_interface_t interface){ switch (interface) { case PHY_INTERFACE_MODE_SGMII: case PHY_INTERFACE_MODE_PSGMII: case PHY_INTERFACE_MODE_QSGMII: case PHY_INTERFACE_MODE_USXGMII: case PHY_INTERFACE_MODE_10G_QXGMII: return 1600000;
case PHY_INTERFACE_MODE_1000BASEX: case PHY_INTERFACE_MODE_2500BASEX: return 10000000;
default: return -EINVAL; }}
/** * phylink_mac_implements_lpi() - determine if MAC implements LPI ops * @ops: phylink_mac_ops structure * * Returns true if the phylink MAC operations structure indicates that the * LPI operations have been implemented, false otherwise. */static inline bool phylink_mac_implements_lpi(const struct phylink_mac_ops *ops){ return ops && ops->mac_disable_tx_lpi && ops->mac_enable_tx_lpi;}
void phylink_mii_c22_pcs_decode_state(struct phylink_link_state *state, unsigned int neg_mode, u16 bmsr, u16 lpa);void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs, unsigned int neg_mode, struct phylink_link_state *state);int phylink_mii_c22_pcs_encode_advertisement(phy_interface_t interface, const unsigned long *advertising);int phylink_mii_c22_pcs_config(struct mdio_device *pcs, phy_interface_t interface, const unsigned long *advertising, unsigned int neg_mode);void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs);
void phylink_resolve_c73(struct phylink_link_state *state);
void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs, struct phylink_link_state *state);
void phylink_decode_usxgmii_word(struct phylink_link_state *state, uint16_t lpa);
void phylink_replay_link_begin(struct phylink *pl);
void phylink_replay_link_end(struct phylink *pl);
void phylink_update_mac_pause_capabilities(struct phylink *pl, unsigned long mac_pause);
#endif