123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230 |
- // SPDX-License-Identifier: GPL-2.0+
- /* Framework for configuring and reading PHY devices
- * Based on code in sungem_phy.c and gianfar_phy.c
- *
- * Author: Andy Fleming
- *
- * Copyright (c) 2004 Freescale Semiconductor, Inc.
- * Copyright (c) 2006, 2007 Maciej W. Rozycki
- */
- #include <linux/kernel.h>
- #include <linux/string.h>
- #include <linux/errno.h>
- #include <linux/unistd.h>
- #include <linux/interrupt.h>
- #include <linux/delay.h>
- #include <linux/netdevice.h>
- #include <linux/etherdevice.h>
- #include <linux/skbuff.h>
- #include <linux/mm.h>
- #include <linux/module.h>
- #include <linux/mii.h>
- #include <linux/ethtool.h>
- #include <linux/phy.h>
- #include <linux/phy_led_triggers.h>
- #include <linux/workqueue.h>
- #include <linux/mdio.h>
- #include <linux/io.h>
- #include <linux/uaccess.h>
- #include <linux/atomic.h>
- #define PHY_STATE_TIME HZ
- #define PHY_STATE_STR(_state) \
- case PHY_##_state: \
- return __stringify(_state); \
- static const char *phy_state_to_str(enum phy_state st)
- {
- switch (st) {
- PHY_STATE_STR(DOWN)
- PHY_STATE_STR(READY)
- PHY_STATE_STR(UP)
- PHY_STATE_STR(RUNNING)
- PHY_STATE_STR(NOLINK)
- PHY_STATE_STR(HALTED)
- }
- return NULL;
- }
- static void phy_link_up(struct phy_device *phydev)
- {
- phydev->phy_link_change(phydev, true, true);
- phy_led_trigger_change_speed(phydev);
- }
- static void phy_link_down(struct phy_device *phydev, bool do_carrier)
- {
- phydev->phy_link_change(phydev, false, do_carrier);
- phy_led_trigger_change_speed(phydev);
- }
- static const char *phy_pause_str(struct phy_device *phydev)
- {
- bool local_pause, local_asym_pause;
- if (phydev->autoneg == AUTONEG_DISABLE)
- goto no_pause;
- local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
- phydev->advertising);
- local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
- phydev->advertising);
- if (local_pause && phydev->pause)
- return "rx/tx";
- if (local_asym_pause && phydev->asym_pause) {
- if (local_pause)
- return "rx";
- if (phydev->pause)
- return "tx";
- }
- no_pause:
- return "off";
- }
- /**
- * phy_print_status - Convenience function to print out the current phy status
- * @phydev: the phy_device struct
- */
- void phy_print_status(struct phy_device *phydev)
- {
- if (phydev->link) {
- netdev_info(phydev->attached_dev,
- "Link is Up - %s/%s - flow control %s\n",
- phy_speed_to_str(phydev->speed),
- phy_duplex_to_str(phydev->duplex),
- phy_pause_str(phydev));
- } else {
- netdev_info(phydev->attached_dev, "Link is Down\n");
- }
- }
- EXPORT_SYMBOL(phy_print_status);
- /**
- * phy_clear_interrupt - Ack the phy device's interrupt
- * @phydev: the phy_device struct
- *
- * If the @phydev driver has an ack_interrupt function, call it to
- * ack and clear the phy device's interrupt.
- *
- * Returns 0 on success or < 0 on error.
- */
- static int phy_clear_interrupt(struct phy_device *phydev)
- {
- if (phydev->drv->ack_interrupt)
- return phydev->drv->ack_interrupt(phydev);
- return 0;
- }
- /**
- * phy_config_interrupt - configure the PHY device for the requested interrupts
- * @phydev: the phy_device struct
- * @interrupts: interrupt flags to configure for this @phydev
- *
- * Returns 0 on success or < 0 on error.
- */
- static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
- {
- phydev->interrupts = interrupts ? 1 : 0;
- if (phydev->drv->config_intr)
- return phydev->drv->config_intr(phydev);
- return 0;
- }
- /**
- * phy_restart_aneg - restart auto-negotiation
- * @phydev: target phy_device struct
- *
- * Restart the autonegotiation on @phydev. Returns >= 0 on success or
- * negative errno on error.
- */
- int phy_restart_aneg(struct phy_device *phydev)
- {
- int ret;
- if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
- ret = genphy_c45_restart_aneg(phydev);
- else
- ret = genphy_restart_aneg(phydev);
- return ret;
- }
- EXPORT_SYMBOL_GPL(phy_restart_aneg);
- /**
- * phy_aneg_done - return auto-negotiation status
- * @phydev: target phy_device struct
- *
- * Description: Return the auto-negotiation status from this @phydev
- * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
- * is still pending.
- */
- int phy_aneg_done(struct phy_device *phydev)
- {
- if (phydev->drv && phydev->drv->aneg_done)
- return phydev->drv->aneg_done(phydev);
- else if (phydev->is_c45)
- return genphy_c45_aneg_done(phydev);
- else
- return genphy_aneg_done(phydev);
- }
- EXPORT_SYMBOL(phy_aneg_done);
- /**
- * phy_find_valid - find a PHY setting that matches the requested parameters
- * @speed: desired speed
- * @duplex: desired duplex
- * @supported: mask of supported link modes
- *
- * Locate a supported phy setting that is, in priority order:
- * - an exact match for the specified speed and duplex mode
- * - a match for the specified speed, or slower speed
- * - the slowest supported speed
- * Returns the matched phy_setting entry, or %NULL if no supported phy
- * settings were found.
- */
- static const struct phy_setting *
- phy_find_valid(int speed, int duplex, unsigned long *supported)
- {
- return phy_lookup_setting(speed, duplex, supported, false);
- }
- /**
- * phy_supported_speeds - return all speeds currently supported by a phy device
- * @phy: The phy device to return supported speeds of.
- * @speeds: buffer to store supported speeds in.
- * @size: size of speeds buffer.
- *
- * Description: Returns the number of supported speeds, and fills the speeds
- * buffer with the supported speeds. If speeds buffer is too small to contain
- * all currently supported speeds, will return as many speeds as can fit.
- */
- unsigned int phy_supported_speeds(struct phy_device *phy,
- unsigned int *speeds,
- unsigned int size)
- {
- return phy_speeds(speeds, size, phy->supported);
- }
- /**
- * phy_check_valid - check if there is a valid PHY setting which matches
- * speed, duplex, and feature mask
- * @speed: speed to match
- * @duplex: duplex to match
- * @features: A mask of the valid settings
- *
- * Description: Returns true if there is a valid setting, false otherwise.
- */
- static inline bool phy_check_valid(int speed, int duplex,
- unsigned long *features)
- {
- return !!phy_lookup_setting(speed, duplex, features, true);
- }
- /**
- * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
- * @phydev: the target phy_device struct
- *
- * Description: Make sure the PHY is set to supported speeds and
- * duplexes. Drop down by one in this order: 1000/FULL,
- * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
- */
- static void phy_sanitize_settings(struct phy_device *phydev)
- {
- const struct phy_setting *setting;
- setting = phy_find_valid(phydev->speed, phydev->duplex,
- phydev->supported);
- if (setting) {
- phydev->speed = setting->speed;
- phydev->duplex = setting->duplex;
- } else {
- /* We failed to find anything (no supported speeds?) */
- phydev->speed = SPEED_UNKNOWN;
- phydev->duplex = DUPLEX_UNKNOWN;
- }
- }
- /**
- * phy_ethtool_sset - generic ethtool sset function, handles all the details
- * @phydev: target phy_device struct
- * @cmd: ethtool_cmd
- *
- * A few notes about parameter checking:
- *
- * - We don't set port or transceiver, so we don't care what they
- * were set to.
- * - phy_start_aneg() will make sure forced settings are sane, and
- * choose the next best ones from the ones selected, so we don't
- * care if ethtool tries to give us bad values.
- */
- int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
- {
- __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
- u32 speed = ethtool_cmd_speed(cmd);
- if (cmd->phy_address != phydev->mdio.addr)
- return -EINVAL;
- /* We make sure that we don't pass unsupported values in to the PHY */
- ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
- linkmode_and(advertising, advertising, phydev->supported);
- /* Verify the settings we care about. */
- if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
- return -EINVAL;
- if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
- return -EINVAL;
- if (cmd->autoneg == AUTONEG_DISABLE &&
- ((speed != SPEED_1000 &&
- speed != SPEED_100 &&
- speed != SPEED_10) ||
- (cmd->duplex != DUPLEX_HALF &&
- cmd->duplex != DUPLEX_FULL)))
- return -EINVAL;
- phydev->autoneg = cmd->autoneg;
- phydev->speed = speed;
- linkmode_copy(phydev->advertising, advertising);
- linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
- phydev->advertising, AUTONEG_ENABLE == cmd->autoneg);
- phydev->duplex = cmd->duplex;
- phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
- /* Restart the PHY */
- phy_start_aneg(phydev);
- return 0;
- }
- EXPORT_SYMBOL(phy_ethtool_sset);
- int phy_ethtool_ksettings_set(struct phy_device *phydev,
- const struct ethtool_link_ksettings *cmd)
- {
- __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
- u8 autoneg = cmd->base.autoneg;
- u8 duplex = cmd->base.duplex;
- u32 speed = cmd->base.speed;
- if (cmd->base.phy_address != phydev->mdio.addr)
- return -EINVAL;
- linkmode_copy(advertising, cmd->link_modes.advertising);
- /* We make sure that we don't pass unsupported values in to the PHY */
- linkmode_and(advertising, advertising, phydev->supported);
- /* Verify the settings we care about. */
- if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
- return -EINVAL;
- if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
- return -EINVAL;
- if (autoneg == AUTONEG_DISABLE &&
- ((speed != SPEED_1000 &&
- speed != SPEED_100 &&
- speed != SPEED_10) ||
- (duplex != DUPLEX_HALF &&
- duplex != DUPLEX_FULL)))
- return -EINVAL;
- phydev->autoneg = autoneg;
- if (autoneg == AUTONEG_DISABLE) {
- phydev->speed = speed;
- phydev->duplex = duplex;
- }
- linkmode_copy(phydev->advertising, advertising);
- linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
- phydev->advertising, autoneg == AUTONEG_ENABLE);
- phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
- /* Restart the PHY */
- phy_start_aneg(phydev);
- return 0;
- }
- EXPORT_SYMBOL(phy_ethtool_ksettings_set);
- void phy_ethtool_ksettings_get(struct phy_device *phydev,
- struct ethtool_link_ksettings *cmd)
- {
- linkmode_copy(cmd->link_modes.supported, phydev->supported);
- linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
- linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
- cmd->base.speed = phydev->speed;
- cmd->base.duplex = phydev->duplex;
- if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
- cmd->base.port = PORT_BNC;
- else
- cmd->base.port = PORT_MII;
- cmd->base.transceiver = phy_is_internal(phydev) ?
- XCVR_INTERNAL : XCVR_EXTERNAL;
- cmd->base.phy_address = phydev->mdio.addr;
- cmd->base.autoneg = phydev->autoneg;
- cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
- cmd->base.eth_tp_mdix = phydev->mdix;
- }
- EXPORT_SYMBOL(phy_ethtool_ksettings_get);
- /**
- * phy_mii_ioctl - generic PHY MII ioctl interface
- * @phydev: the phy_device struct
- * @ifr: &struct ifreq for socket ioctl's
- * @cmd: ioctl cmd to execute
- *
- * Note that this function is currently incompatible with the
- * PHYCONTROL layer. It changes registers without regard to
- * current state. Use at own risk.
- */
- int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
- {
- struct mii_ioctl_data *mii_data = if_mii(ifr);
- u16 val = mii_data->val_in;
- bool change_autoneg = false;
- int prtad, devad;
- switch (cmd) {
- case SIOCGMIIPHY:
- mii_data->phy_id = phydev->mdio.addr;
- /* fall through */
- case SIOCGMIIREG:
- if (mdio_phy_id_is_c45(mii_data->phy_id)) {
- prtad = mdio_phy_id_prtad(mii_data->phy_id);
- devad = mdio_phy_id_devad(mii_data->phy_id);
- devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
- } else {
- prtad = mii_data->phy_id;
- devad = mii_data->reg_num;
- }
- mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
- devad);
- return 0;
- case SIOCSMIIREG:
- if (mdio_phy_id_is_c45(mii_data->phy_id)) {
- prtad = mdio_phy_id_prtad(mii_data->phy_id);
- devad = mdio_phy_id_devad(mii_data->phy_id);
- devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
- } else {
- prtad = mii_data->phy_id;
- devad = mii_data->reg_num;
- }
- if (prtad == phydev->mdio.addr) {
- switch (devad) {
- case MII_BMCR:
- if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
- if (phydev->autoneg == AUTONEG_ENABLE)
- change_autoneg = true;
- phydev->autoneg = AUTONEG_DISABLE;
- if (val & BMCR_FULLDPLX)
- phydev->duplex = DUPLEX_FULL;
- else
- phydev->duplex = DUPLEX_HALF;
- if (val & BMCR_SPEED1000)
- phydev->speed = SPEED_1000;
- else if (val & BMCR_SPEED100)
- phydev->speed = SPEED_100;
- else phydev->speed = SPEED_10;
- }
- else {
- if (phydev->autoneg == AUTONEG_DISABLE)
- change_autoneg = true;
- phydev->autoneg = AUTONEG_ENABLE;
- }
- break;
- case MII_ADVERTISE:
- mii_adv_mod_linkmode_adv_t(phydev->advertising,
- val);
- change_autoneg = true;
- break;
- case MII_CTRL1000:
- mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
- val);
- change_autoneg = true;
- break;
- default:
- /* do nothing */
- break;
- }
- }
- mdiobus_write(phydev->mdio.bus, prtad, devad, val);
- if (prtad == phydev->mdio.addr &&
- devad == MII_BMCR &&
- val & BMCR_RESET)
- return phy_init_hw(phydev);
- if (change_autoneg)
- return phy_start_aneg(phydev);
- return 0;
- case SIOCSHWTSTAMP:
- if (phydev->drv && phydev->drv->hwtstamp)
- return phydev->drv->hwtstamp(phydev, ifr);
- /* fall through */
- default:
- return -EOPNOTSUPP;
- }
- }
- EXPORT_SYMBOL(phy_mii_ioctl);
- void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
- {
- mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
- jiffies);
- }
- EXPORT_SYMBOL(phy_queue_state_machine);
- static void phy_trigger_machine(struct phy_device *phydev)
- {
- phy_queue_state_machine(phydev, 0);
- }
- static int phy_config_aneg(struct phy_device *phydev)
- {
- if (phydev->drv->config_aneg)
- return phydev->drv->config_aneg(phydev);
- /* Clause 45 PHYs that don't implement Clause 22 registers are not
- * allowed to call genphy_config_aneg()
- */
- if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
- return genphy_c45_config_aneg(phydev);
- return genphy_config_aneg(phydev);
- }
- /**
- * phy_check_link_status - check link status and set state accordingly
- * @phydev: the phy_device struct
- *
- * Description: Check for link and whether autoneg was triggered / is running
- * and set state accordingly
- */
- static int phy_check_link_status(struct phy_device *phydev)
- {
- int err;
- WARN_ON(!mutex_is_locked(&phydev->lock));
- /* Keep previous state if loopback is enabled because some PHYs
- * report that Link is Down when loopback is enabled.
- */
- if (phydev->loopback_enabled)
- return 0;
- err = phy_read_status(phydev);
- if (err)
- return err;
- if (phydev->link && phydev->state != PHY_RUNNING) {
- phydev->state = PHY_RUNNING;
- phy_link_up(phydev);
- } else if (!phydev->link && phydev->state != PHY_NOLINK) {
- phydev->state = PHY_NOLINK;
- phy_link_down(phydev, true);
- }
- return 0;
- }
- /**
- * phy_start_aneg - start auto-negotiation for this PHY device
- * @phydev: the phy_device struct
- *
- * Description: Sanitizes the settings (if we're not autonegotiating
- * them), and then calls the driver's config_aneg function.
- * If the PHYCONTROL Layer is operating, we change the state to
- * reflect the beginning of Auto-negotiation or forcing.
- */
- int phy_start_aneg(struct phy_device *phydev)
- {
- int err;
- if (!phydev->drv)
- return -EIO;
- mutex_lock(&phydev->lock);
- if (AUTONEG_DISABLE == phydev->autoneg)
- phy_sanitize_settings(phydev);
- err = phy_config_aneg(phydev);
- if (err < 0)
- goto out_unlock;
- if (phy_is_started(phydev))
- err = phy_check_link_status(phydev);
- out_unlock:
- mutex_unlock(&phydev->lock);
- return err;
- }
- EXPORT_SYMBOL(phy_start_aneg);
- static int phy_poll_aneg_done(struct phy_device *phydev)
- {
- unsigned int retries = 100;
- int ret;
- do {
- msleep(100);
- ret = phy_aneg_done(phydev);
- } while (!ret && --retries);
- if (!ret)
- return -ETIMEDOUT;
- return ret < 0 ? ret : 0;
- }
- /**
- * phy_speed_down - set speed to lowest speed supported by both link partners
- * @phydev: the phy_device struct
- * @sync: perform action synchronously
- *
- * Description: Typically used to save energy when waiting for a WoL packet
- *
- * WARNING: Setting sync to false may cause the system being unable to suspend
- * in case the PHY generates an interrupt when finishing the autonegotiation.
- * This interrupt may wake up the system immediately after suspend.
- * Therefore use sync = false only if you're sure it's safe with the respective
- * network chip.
- */
- int phy_speed_down(struct phy_device *phydev, bool sync)
- {
- __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
- int ret;
- if (phydev->autoneg != AUTONEG_ENABLE)
- return 0;
- linkmode_copy(adv_tmp, phydev->advertising);
- ret = phy_speed_down_core(phydev);
- if (ret)
- return ret;
- linkmode_copy(phydev->adv_old, adv_tmp);
- if (linkmode_equal(phydev->advertising, adv_tmp))
- return 0;
- ret = phy_config_aneg(phydev);
- if (ret)
- return ret;
- return sync ? phy_poll_aneg_done(phydev) : 0;
- }
- EXPORT_SYMBOL_GPL(phy_speed_down);
- /**
- * phy_speed_up - (re)set advertised speeds to all supported speeds
- * @phydev: the phy_device struct
- *
- * Description: Used to revert the effect of phy_speed_down
- */
- int phy_speed_up(struct phy_device *phydev)
- {
- __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
- if (phydev->autoneg != AUTONEG_ENABLE)
- return 0;
- if (linkmode_empty(phydev->adv_old))
- return 0;
- linkmode_copy(adv_tmp, phydev->advertising);
- linkmode_copy(phydev->advertising, phydev->adv_old);
- linkmode_zero(phydev->adv_old);
- if (linkmode_equal(phydev->advertising, adv_tmp))
- return 0;
- return phy_config_aneg(phydev);
- }
- EXPORT_SYMBOL_GPL(phy_speed_up);
- /**
- * phy_start_machine - start PHY state machine tracking
- * @phydev: the phy_device struct
- *
- * Description: The PHY infrastructure can run a state machine
- * which tracks whether the PHY is starting up, negotiating,
- * etc. This function starts the delayed workqueue which tracks
- * the state of the PHY. If you want to maintain your own state machine,
- * do not call this function.
- */
- void phy_start_machine(struct phy_device *phydev)
- {
- phy_trigger_machine(phydev);
- }
- EXPORT_SYMBOL_GPL(phy_start_machine);
- /**
- * phy_stop_machine - stop the PHY state machine tracking
- * @phydev: target phy_device struct
- *
- * Description: Stops the state machine delayed workqueue, sets the
- * state to UP (unless it wasn't up yet). This function must be
- * called BEFORE phy_detach.
- */
- void phy_stop_machine(struct phy_device *phydev)
- {
- cancel_delayed_work_sync(&phydev->state_queue);
- mutex_lock(&phydev->lock);
- if (phy_is_started(phydev))
- phydev->state = PHY_UP;
- mutex_unlock(&phydev->lock);
- }
- /**
- * phy_error - enter HALTED state for this PHY device
- * @phydev: target phy_device struct
- *
- * Moves the PHY to the HALTED state in response to a read
- * or write error, and tells the controller the link is down.
- * Must not be called from interrupt context, or while the
- * phydev->lock is held.
- */
- static void phy_error(struct phy_device *phydev)
- {
- WARN_ON(1);
- mutex_lock(&phydev->lock);
- phydev->state = PHY_HALTED;
- mutex_unlock(&phydev->lock);
- phy_trigger_machine(phydev);
- }
- /**
- * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
- * @phydev: target phy_device struct
- */
- static int phy_disable_interrupts(struct phy_device *phydev)
- {
- int err;
- /* Disable PHY interrupts */
- err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
- if (err)
- return err;
- /* Clear the interrupt */
- return phy_clear_interrupt(phydev);
- }
- /**
- * phy_interrupt - PHY interrupt handler
- * @irq: interrupt line
- * @phy_dat: phy_device pointer
- *
- * Description: Handle PHY interrupt
- */
- static irqreturn_t phy_interrupt(int irq, void *phy_dat)
- {
- struct phy_device *phydev = phy_dat;
- if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
- return IRQ_NONE;
- if (phydev->drv->handle_interrupt) {
- if (phydev->drv->handle_interrupt(phydev))
- goto phy_err;
- } else {
- /* reschedule state queue work to run as soon as possible */
- phy_trigger_machine(phydev);
- }
- /* did_interrupt() may have cleared the interrupt already */
- if (!phydev->drv->did_interrupt && phy_clear_interrupt(phydev))
- goto phy_err;
- return IRQ_HANDLED;
- phy_err:
- phy_error(phydev);
- return IRQ_NONE;
- }
- /**
- * phy_enable_interrupts - Enable the interrupts from the PHY side
- * @phydev: target phy_device struct
- */
- static int phy_enable_interrupts(struct phy_device *phydev)
- {
- int err = phy_clear_interrupt(phydev);
- if (err < 0)
- return err;
- return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
- }
- /**
- * phy_request_interrupt - request and enable interrupt for a PHY device
- * @phydev: target phy_device struct
- *
- * Description: Request and enable the interrupt for the given PHY.
- * If this fails, then we set irq to PHY_POLL.
- * This should only be called with a valid IRQ number.
- */
- void phy_request_interrupt(struct phy_device *phydev)
- {
- int err;
- err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
- IRQF_ONESHOT | IRQF_SHARED,
- phydev_name(phydev), phydev);
- if (err) {
- phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
- err, phydev->irq);
- phydev->irq = PHY_POLL;
- } else {
- if (phy_enable_interrupts(phydev)) {
- phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
- phy_free_interrupt(phydev);
- phydev->irq = PHY_POLL;
- }
- }
- }
- EXPORT_SYMBOL(phy_request_interrupt);
- /**
- * phy_free_interrupt - disable and free interrupt for a PHY device
- * @phydev: target phy_device struct
- *
- * Description: Disable and free the interrupt for the given PHY.
- * This should only be called with a valid IRQ number.
- */
- void phy_free_interrupt(struct phy_device *phydev)
- {
- phy_disable_interrupts(phydev);
- free_irq(phydev->irq, phydev);
- }
- EXPORT_SYMBOL(phy_free_interrupt);
- /**
- * phy_stop - Bring down the PHY link, and stop checking the status
- * @phydev: target phy_device struct
- */
- void phy_stop(struct phy_device *phydev)
- {
- if (!phy_is_started(phydev) && phydev->state != PHY_DOWN) {
- WARN(1, "called from state %s\n",
- phy_state_to_str(phydev->state));
- return;
- }
- mutex_lock(&phydev->lock);
- phydev->state = PHY_HALTED;
- mutex_unlock(&phydev->lock);
- phy_state_machine(&phydev->state_queue.work);
- phy_stop_machine(phydev);
- /* Cannot call flush_scheduled_work() here as desired because
- * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
- * will not reenable interrupts.
- */
- }
- EXPORT_SYMBOL(phy_stop);
- /**
- * phy_start - start or restart a PHY device
- * @phydev: target phy_device struct
- *
- * Description: Indicates the attached device's readiness to
- * handle PHY-related work. Used during startup to start the
- * PHY, and after a call to phy_stop() to resume operation.
- * Also used to indicate the MDIO bus has cleared an error
- * condition.
- */
- void phy_start(struct phy_device *phydev)
- {
- mutex_lock(&phydev->lock);
- if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
- WARN(1, "called from state %s\n",
- phy_state_to_str(phydev->state));
- goto out;
- }
- /* if phy was suspended, bring the physical link up again */
- __phy_resume(phydev);
- phydev->state = PHY_UP;
- phy_start_machine(phydev);
- out:
- mutex_unlock(&phydev->lock);
- }
- EXPORT_SYMBOL(phy_start);
- /**
- * phy_state_machine - Handle the state machine
- * @work: work_struct that describes the work to be done
- */
- void phy_state_machine(struct work_struct *work)
- {
- struct delayed_work *dwork = to_delayed_work(work);
- struct phy_device *phydev =
- container_of(dwork, struct phy_device, state_queue);
- bool needs_aneg = false, do_suspend = false;
- enum phy_state old_state;
- int err = 0;
- mutex_lock(&phydev->lock);
- old_state = phydev->state;
- switch (phydev->state) {
- case PHY_DOWN:
- case PHY_READY:
- break;
- case PHY_UP:
- needs_aneg = true;
- break;
- case PHY_NOLINK:
- case PHY_RUNNING:
- err = phy_check_link_status(phydev);
- break;
- case PHY_HALTED:
- if (phydev->link) {
- phydev->link = 0;
- phy_link_down(phydev, true);
- }
- do_suspend = true;
- break;
- }
- mutex_unlock(&phydev->lock);
- if (needs_aneg)
- err = phy_start_aneg(phydev);
- else if (do_suspend)
- phy_suspend(phydev);
- if (err < 0)
- phy_error(phydev);
- if (old_state != phydev->state) {
- phydev_dbg(phydev, "PHY state change %s -> %s\n",
- phy_state_to_str(old_state),
- phy_state_to_str(phydev->state));
- if (phydev->drv && phydev->drv->link_change_notify)
- phydev->drv->link_change_notify(phydev);
- }
- /* Only re-schedule a PHY state machine change if we are polling the
- * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
- * between states from phy_mac_interrupt().
- *
- * In state PHY_HALTED the PHY gets suspended, so rescheduling the
- * state machine would be pointless and possibly error prone when
- * called from phy_disconnect() synchronously.
- */
- mutex_lock(&phydev->lock);
- if (phy_polling_mode(phydev) && phy_is_started(phydev))
- phy_queue_state_machine(phydev, PHY_STATE_TIME);
- mutex_unlock(&phydev->lock);
- }
- /**
- * phy_mac_interrupt - MAC says the link has changed
- * @phydev: phy_device struct with changed link
- *
- * The MAC layer is able to indicate there has been a change in the PHY link
- * status. Trigger the state machine and work a work queue.
- */
- void phy_mac_interrupt(struct phy_device *phydev)
- {
- /* Trigger a state machine change */
- phy_trigger_machine(phydev);
- }
- EXPORT_SYMBOL(phy_mac_interrupt);
- static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
- {
- linkmode_zero(advertising);
- if (eee_adv & MDIO_EEE_100TX)
- linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
- advertising);
- if (eee_adv & MDIO_EEE_1000T)
- linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
- advertising);
- if (eee_adv & MDIO_EEE_10GT)
- linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
- advertising);
- if (eee_adv & MDIO_EEE_1000KX)
- linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
- advertising);
- if (eee_adv & MDIO_EEE_10GKX4)
- linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
- advertising);
- if (eee_adv & MDIO_EEE_10GKR)
- linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
- advertising);
- }
- /**
- * phy_init_eee - init and check the EEE feature
- * @phydev: target phy_device struct
- * @clk_stop_enable: PHY may stop the clock during LPI
- *
- * Description: it checks if the Energy-Efficient Ethernet (EEE)
- * is supported by looking at the MMD registers 3.20 and 7.60/61
- * and it programs the MMD register 3.0 setting the "Clock stop enable"
- * bit if required.
- */
- int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
- {
- if (!phydev->drv)
- return -EIO;
- /* According to 802.3az,the EEE is supported only in full duplex-mode.
- */
- if (phydev->duplex == DUPLEX_FULL) {
- __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
- __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
- __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
- int eee_lp, eee_cap, eee_adv;
- int status;
- u32 cap;
- /* Read phy status to properly get the right settings */
- status = phy_read_status(phydev);
- if (status)
- return status;
- /* First check if the EEE ability is supported */
- eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
- if (eee_cap <= 0)
- goto eee_exit_err;
- cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
- if (!cap)
- goto eee_exit_err;
- /* Check which link settings negotiated and verify it in
- * the EEE advertising registers.
- */
- eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
- if (eee_lp <= 0)
- goto eee_exit_err;
- eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
- if (eee_adv <= 0)
- goto eee_exit_err;
- mmd_eee_adv_to_linkmode(adv, eee_adv);
- mmd_eee_adv_to_linkmode(lp, eee_lp);
- linkmode_and(common, adv, lp);
- if (!phy_check_valid(phydev->speed, phydev->duplex, common))
- goto eee_exit_err;
- if (clk_stop_enable)
- /* Configure the PHY to stop receiving xMII
- * clock while it is signaling LPI.
- */
- phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
- MDIO_PCS_CTRL1_CLKSTOP_EN);
- return 0; /* EEE supported */
- }
- eee_exit_err:
- return -EPROTONOSUPPORT;
- }
- EXPORT_SYMBOL(phy_init_eee);
- /**
- * phy_get_eee_err - report the EEE wake error count
- * @phydev: target phy_device struct
- *
- * Description: it is to report the number of time where the PHY
- * failed to complete its normal wake sequence.
- */
- int phy_get_eee_err(struct phy_device *phydev)
- {
- if (!phydev->drv)
- return -EIO;
- return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
- }
- EXPORT_SYMBOL(phy_get_eee_err);
- /**
- * phy_ethtool_get_eee - get EEE supported and status
- * @phydev: target phy_device struct
- * @data: ethtool_eee data
- *
- * Description: it reportes the Supported/Advertisement/LP Advertisement
- * capabilities.
- */
- int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
- {
- int val;
- if (!phydev->drv)
- return -EIO;
- /* Get Supported EEE */
- val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
- if (val < 0)
- return val;
- data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
- /* Get advertisement EEE */
- val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
- if (val < 0)
- return val;
- data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
- data->eee_enabled = !!data->advertised;
- /* Get LP advertisement EEE */
- val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
- if (val < 0)
- return val;
- data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
- data->eee_active = !!(data->advertised & data->lp_advertised);
- return 0;
- }
- EXPORT_SYMBOL(phy_ethtool_get_eee);
- /**
- * phy_ethtool_set_eee - set EEE supported and status
- * @phydev: target phy_device struct
- * @data: ethtool_eee data
- *
- * Description: it is to program the Advertisement EEE register.
- */
- int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
- {
- int cap, old_adv, adv = 0, ret;
- if (!phydev->drv)
- return -EIO;
- /* Get Supported EEE */
- cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
- if (cap < 0)
- return cap;
- old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
- if (old_adv < 0)
- return old_adv;
- if (data->eee_enabled) {
- adv = !data->advertised ? cap :
- ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
- /* Mask prohibited EEE modes */
- adv &= ~phydev->eee_broken_modes;
- }
- if (old_adv != adv) {
- ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
- if (ret < 0)
- return ret;
- /* Restart autonegotiation so the new modes get sent to the
- * link partner.
- */
- if (phydev->autoneg == AUTONEG_ENABLE) {
- ret = phy_restart_aneg(phydev);
- if (ret < 0)
- return ret;
- }
- }
- return 0;
- }
- EXPORT_SYMBOL(phy_ethtool_set_eee);
- int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
- {
- if (phydev->drv && phydev->drv->set_wol)
- return phydev->drv->set_wol(phydev, wol);
- return -EOPNOTSUPP;
- }
- EXPORT_SYMBOL(phy_ethtool_set_wol);
- void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
- {
- if (phydev->drv && phydev->drv->get_wol)
- phydev->drv->get_wol(phydev, wol);
- }
- EXPORT_SYMBOL(phy_ethtool_get_wol);
- int phy_ethtool_get_link_ksettings(struct net_device *ndev,
- struct ethtool_link_ksettings *cmd)
- {
- struct phy_device *phydev = ndev->phydev;
- if (!phydev)
- return -ENODEV;
- phy_ethtool_ksettings_get(phydev, cmd);
- return 0;
- }
- EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
- int phy_ethtool_set_link_ksettings(struct net_device *ndev,
- const struct ethtool_link_ksettings *cmd)
- {
- struct phy_device *phydev = ndev->phydev;
- if (!phydev)
- return -ENODEV;
- return phy_ethtool_ksettings_set(phydev, cmd);
- }
- EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
- int phy_ethtool_nway_reset(struct net_device *ndev)
- {
- struct phy_device *phydev = ndev->phydev;
- if (!phydev)
- return -ENODEV;
- if (!phydev->drv)
- return -EIO;
- return phy_restart_aneg(phydev);
- }
- EXPORT_SYMBOL(phy_ethtool_nway_reset);
|