[mirror_ubuntu-bionic-kernel.git] / include / linux / phy.h

/*
 * include/linux/phy.h
 *
 * Framework and drivers for configuring and reading different PHYs
 * Based on code in sungem_phy.c and gianfar_phy.c
 *
 * Author: Andy Fleming
 *
 * Copyright (c) 2004 Freescale Semiconductor, Inc.
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 */

#ifndef __PHY_H
#define __PHY_H

#include <linux/spinlock.h>
#include <linux/device.h>
#include <linux/ethtool.h>
#include <linux/mii.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <linux/mod_devicetable.h>

#include <linux/atomic.h>

#define PHY_BASIC_FEATURES	(SUPPORTED_10baseT_Half | \
				 SUPPORTED_10baseT_Full | \
				 SUPPORTED_100baseT_Half | \
				 SUPPORTED_100baseT_Full | \
				 SUPPORTED_Autoneg | \
				 SUPPORTED_TP | \
				 SUPPORTED_MII)

#define PHY_GBIT_FEATURES	(PHY_BASIC_FEATURES | \
				 SUPPORTED_1000baseT_Half | \
				 SUPPORTED_1000baseT_Full)

/*
 * Set phydev->irq to PHY_POLL if interrupts are not supported,
 * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
 * the attached driver handles the interrupt
 */
#define PHY_POLL		-1
#define PHY_IGNORE_INTERRUPT	-2

#define PHY_HAS_INTERRUPT	0x00000001
#define PHY_HAS_MAGICANEG	0x00000002

/* Interface Mode definitions */
typedef enum {
	PHY_INTERFACE_MODE_NA,
	PHY_INTERFACE_MODE_MII,
	PHY_INTERFACE_MODE_GMII,
	PHY_INTERFACE_MODE_SGMII,
	PHY_INTERFACE_MODE_TBI,
	PHY_INTERFACE_MODE_RMII,
	PHY_INTERFACE_MODE_RGMII,
	PHY_INTERFACE_MODE_RGMII_ID,
	PHY_INTERFACE_MODE_RGMII_RXID,
	PHY_INTERFACE_MODE_RGMII_TXID,
	PHY_INTERFACE_MODE_RTBI,
	PHY_INTERFACE_MODE_SMII,
} phy_interface_t;


#define PHY_INIT_TIMEOUT	100000
#define PHY_STATE_TIME		1
#define PHY_FORCE_TIMEOUT	10
#define PHY_AN_TIMEOUT		10

#define PHY_MAX_ADDR	32

/* Used when trying to connect to a specific phy (mii bus id:phy device id) */
#define PHY_ID_FMT "%s:%02x"

/*
 * Need to be a little smaller than phydev->dev.bus_id to leave room
 * for the ":%02x"
 */
#define MII_BUS_ID_SIZE	(20 - 3)

/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
   IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
#define MII_ADDR_C45 (1<<30)

/*
 * The Bus class for PHYs.  Devices which provide access to
 * PHYs should register using this structure
 */
struct mii_bus {
	const char *name;
	char id[MII_BUS_ID_SIZE];
	void *priv;
	int (*read)(struct mii_bus *bus, int phy_id, int regnum);
	int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
	int (*reset)(struct mii_bus *bus);

	/*
	 * A lock to ensure that only one thing can read/write
	 * the MDIO bus at a time
	 */
	struct mutex mdio_lock;

	struct device *parent;
	enum {
		MDIOBUS_ALLOCATED = 1,
		MDIOBUS_REGISTERED,
		MDIOBUS_UNREGISTERED,
		MDIOBUS_RELEASED,
	} state;
	struct device dev;

	/* list of all PHYs on bus */
	struct phy_device *phy_map[PHY_MAX_ADDR];

	/* PHY addresses to be ignored when probing */
	u32 phy_mask;

	/*
	 * Pointer to an array of interrupts, each PHY's
	 * interrupt at the index matching its address
	 */
	int *irq;
};
#define to_mii_bus(d) container_of(d, struct mii_bus, dev)

struct mii_bus *mdiobus_alloc_size(size_t);
static inline struct mii_bus *mdiobus_alloc(void)
{
	return mdiobus_alloc_size(0);
}

int mdiobus_register(struct mii_bus *bus);
void mdiobus_unregister(struct mii_bus *bus);
void mdiobus_free(struct mii_bus *bus);
struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);


#define PHY_INTERRUPT_DISABLED	0x0
#define PHY_INTERRUPT_ENABLED	0x80000000

/* PHY state machine states:
 *
 * DOWN: PHY device and driver are not ready for anything.  probe
 * should be called if and only if the PHY is in this state,
 * given that the PHY device exists.
 * - PHY driver probe function will, depending on the PHY, set
 * the state to STARTING or READY
 *
 * STARTING:  PHY device is coming up, and the ethernet driver is
 * not ready.  PHY drivers may set this in the probe function.
 * If they do, they are responsible for making sure the state is
 * eventually set to indicate whether the PHY is UP or READY,
 * depending on the state when the PHY is done starting up.
 * - PHY driver will set the state to READY
 * - start will set the state to PENDING
 *
 * READY: PHY is ready to send and receive packets, but the
 * controller is not.  By default, PHYs which do not implement
 * probe will be set to this state by phy_probe().  If the PHY
 * driver knows the PHY is ready, and the PHY state is STARTING,
 * then it sets this STATE.
 * - start will set the state to UP
 *
 * PENDING: PHY device is coming up, but the ethernet driver is
 * ready.  phy_start will set this state if the PHY state is
 * STARTING.
 * - PHY driver will set the state to UP when the PHY is ready
 *
 * UP: The PHY and attached device are ready to do work.
 * Interrupts should be started here.
 * - timer moves to AN
 *
 * AN: The PHY is currently negotiating the link state.  Link is
 * therefore down for now.  phy_timer will set this state when it
 * detects the state is UP.  config_aneg will set this state
 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
 * - If autonegotiation finishes, but there's no link, it sets
 *   the state to NOLINK.
 * - If aneg finishes with link, it sets the state to RUNNING,
 *   and calls adjust_link
 * - If autonegotiation did not finish after an arbitrary amount
 *   of time, autonegotiation should be tried again if the PHY
 *   supports "magic" autonegotiation (back to AN)
 * - If it didn't finish, and no magic_aneg, move to FORCING.
 *
 * NOLINK: PHY is up, but not currently plugged in.
 * - If the timer notes that the link comes back, we move to RUNNING
 * - config_aneg moves to AN
 * - phy_stop moves to HALTED
 *
 * FORCING: PHY is being configured with forced settings
 * - if link is up, move to RUNNING
 * - If link is down, we drop to the next highest setting, and
 *   retry (FORCING) after a timeout
 * - phy_stop moves to HALTED
 *
 * RUNNING: PHY is currently up, running, and possibly sending
 * and/or receiving packets
 * - timer will set CHANGELINK if we're polling (this ensures the
 *   link state is polled every other cycle of this state machine,
 *   which makes it every other second)
 * - irq will set CHANGELINK
 * - config_aneg will set AN
 * - phy_stop moves to HALTED
 *
 * CHANGELINK: PHY experienced a change in link state
 * - timer moves to RUNNING if link
 * - timer moves to NOLINK if the link is down
 * - phy_stop moves to HALTED
 *
 * HALTED: PHY is up, but no polling or interrupts are done. Or
 * PHY is in an error state.
 *
 * - phy_start moves to RESUMING
 *
 * RESUMING: PHY was halted, but now wants to run again.
 * - If we are forcing, or aneg is done, timer moves to RUNNING
 * - If aneg is not done, timer moves to AN
 * - phy_stop moves to HALTED
 */
enum phy_state {
	PHY_DOWN=0,
	PHY_STARTING,
	PHY_READY,
	PHY_PENDING,
	PHY_UP,
	PHY_AN,
	PHY_RUNNING,
	PHY_NOLINK,
	PHY_FORCING,
	PHY_CHANGELINK,
	PHY_HALTED,
	PHY_RESUMING
};

struct sk_buff;

/* phy_device: An instance of a PHY
 *
 * drv: Pointer to the driver for this PHY instance
 * bus: Pointer to the bus this PHY is on
 * dev: driver model device structure for this PHY
 * phy_id: UID for this device found during discovery
 * state: state of the PHY for management purposes
 * dev_flags: Device-specific flags used by the PHY driver.
 * addr: Bus address of PHY
 * link_timeout: The number of timer firings to wait before the
 * giving up on the current attempt at acquiring a link
 * irq: IRQ number of the PHY's interrupt (-1 if none)
 * phy_timer: The timer for handling the state machine
 * phy_queue: A work_queue for the interrupt
 * attached_dev: The attached enet driver's device instance ptr
 * adjust_link: Callback for the enet controller to respond to
 * changes in the link state.
 * adjust_state: Callback for the enet driver to respond to
 * changes in the state machine.
 *
 * speed, duplex, pause, supported, advertising, and
 * autoneg are used like in mii_if_info
 *
 * interrupts currently only supports enabled or disabled,
 * but could be changed in the future to support enabling
 * and disabling specific interrupts
 *
 * Contains some infrastructure for polling and interrupt
 * handling, as well as handling shifts in PHY hardware state
 */
struct phy_device {
	/* Information about the PHY type */
	/* And management functions */
	struct phy_driver *drv;

	struct mii_bus *bus;

	struct device dev;

	u32 phy_id;

	enum phy_state state;

	u32 dev_flags;

	phy_interface_t interface;

	/* Bus address of the PHY (0-31) */
	int addr;

	/*
	 * forced speed & duplex (no autoneg)
	 * partner speed & duplex & pause (autoneg)
	 */
	int speed;
	int duplex;
	int pause;
	int asym_pause;

	/* The most recently read link state */
	int link;

	/* Enabled Interrupts */
	u32 interrupts;

	/* Union of PHY and Attached devices' supported modes */
	/* See mii.h for more info */
	u32 supported;
	u32 advertising;

	int autoneg;

	int link_timeout;

	/*
	 * Interrupt number for this PHY
	 * -1 means no interrupt
	 */
	int irq;

	/* private data pointer */
	/* For use by PHYs to maintain extra state */
	void *priv;

	/* Interrupt and Polling infrastructure */
	struct work_struct phy_queue;
	struct delayed_work state_queue;
	atomic_t irq_disable;

	struct mutex lock;

	struct net_device *attached_dev;

	void (*adjust_link)(struct net_device *dev);

	void (*adjust_state)(struct net_device *dev);
};
#define to_phy_device(d) container_of(d, struct phy_device, dev)

/* struct phy_driver: Driver structure for a particular PHY type
 *
 * phy_id: The result of reading the UID registers of this PHY
 *   type, and ANDing them with the phy_id_mask.  This driver
 *   only works for PHYs with IDs which match this field
 * name: The friendly name of this PHY type
 * phy_id_mask: Defines the important bits of the phy_id
 * features: A list of features (speed, duplex, etc) supported
 *   by this PHY
 * flags: A bitfield defining certain other features this PHY
 *   supports (like interrupts)
 *
 * The drivers must implement config_aneg and read_status.  All
 * other functions are optional. Note that none of these
 * functions should be called from interrupt time.  The goal is
 * for the bus read/write functions to be able to block when the
 * bus transaction is happening, and be freed up by an interrupt
 * (The MPC85xx has this ability, though it is not currently
 * supported in the driver).
 */
struct phy_driver {
	u32 phy_id;
	char *name;
	unsigned int phy_id_mask;
	u32 features;
	u32 flags;

	/*
	 * Called to initialize the PHY,
	 * including after a reset
	 */
	int (*config_init)(struct phy_device *phydev);

	/*
	 * Called during discovery.  Used to set
	 * up device-specific structures, if any
	 */
	int (*probe)(struct phy_device *phydev);

	/* PHY Power Management */
	int (*suspend)(struct phy_device *phydev);
	int (*resume)(struct phy_device *phydev);

	/*
	 * Configures the advertisement and resets
	 * autonegotiation if phydev->autoneg is on,
	 * forces the speed to the current settings in phydev
	 * if phydev->autoneg is off
	 */
	int (*config_aneg)(struct phy_device *phydev);

	/* Determines the negotiated speed and duplex */
	int (*read_status)(struct phy_device *phydev);

	/* Clears any pending interrupts */
	int (*ack_interrupt)(struct phy_device *phydev);

	/* Enables or disables interrupts */
	int (*config_intr)(struct phy_device *phydev);

	/*
	 * Checks if the PHY generated an interrupt.
	 * For multi-PHY devices with shared PHY interrupt pin
	 */
	int (*did_interrupt)(struct phy_device *phydev);

	/* Clears up any memory if needed */
	void (*remove)(struct phy_device *phydev);

	/* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
	int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);

	/*
	 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
	 * the phy driver promises to deliver it using netif_rx() as
	 * soon as a timestamp becomes available. One of the
	 * PTP_CLASS_ values is passed in 'type'. The function must
	 * return true if the skb is accepted for delivery.
	 */
	bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);

	/*
	 * Requests a Tx timestamp for 'skb'. The phy driver promises
	 * to deliver it using skb_complete_tx_timestamp() as soon as a
	 * timestamp becomes available. One of the PTP_CLASS_ values
	 * is passed in 'type'.
	 */
	void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);

	struct device_driver driver;
};
#define to_phy_driver(d) container_of(d, struct phy_driver, driver)

#define PHY_ANY_ID "MATCH ANY PHY"
#define PHY_ANY_UID 0xffffffff

/* A Structure for boards to register fixups with the PHY Lib */
struct phy_fixup {
	struct list_head list;
	char bus_id[20];
	u32 phy_uid;
	u32 phy_uid_mask;
	int (*run)(struct phy_device *phydev);
};

/**
 * phy_read - Convenience function for reading a given PHY register
 * @phydev: the phy_device struct
 * @regnum: register number to read
 *
 * NOTE: MUST NOT be called from interrupt context,
 * because the bus read/write functions may wait for an interrupt
 * to conclude the operation.
 */
static inline int phy_read(struct phy_device *phydev, u32 regnum)
{
	return mdiobus_read(phydev->bus, phydev->addr, regnum);
}

/**
 * phy_write - Convenience function for writing a given PHY register
 * @phydev: the phy_device struct
 * @regnum: register number to write
 * @val: value to write to @regnum
 *
 * NOTE: MUST NOT be called from interrupt context,
 * because the bus read/write functions may wait for an interrupt
 * to conclude the operation.
 */
static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
{
	return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
}

int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id);
struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
int phy_device_register(struct phy_device *phy);
int phy_init_hw(struct phy_device *phydev);
struct phy_device * phy_attach(struct net_device *dev,
		const char *bus_id, u32 flags, phy_interface_t interface);
struct phy_device *phy_find_first(struct mii_bus *bus);
int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
		void (*handler)(struct net_device *), u32 flags,
		phy_interface_t interface);
struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
		void (*handler)(struct net_device *), u32 flags,
		phy_interface_t interface);
void phy_disconnect(struct phy_device *phydev);
void phy_detach(struct phy_device *phydev);
void phy_start(struct phy_device *phydev);
void phy_stop(struct phy_device *phydev);
int phy_start_aneg(struct phy_device *phydev);

int phy_stop_interrupts(struct phy_device *phydev);

static inline int phy_read_status(struct phy_device *phydev) {
	return phydev->drv->read_status(phydev);
}

int genphy_restart_aneg(struct phy_device *phydev);
int genphy_config_aneg(struct phy_device *phydev);
int genphy_update_link(struct phy_device *phydev);
int genphy_read_status(struct phy_device *phydev);
int genphy_suspend(struct phy_device *phydev);
int genphy_resume(struct phy_device *phydev);
void phy_driver_unregister(struct phy_driver *drv);
int phy_driver_register(struct phy_driver *new_driver);
void phy_state_machine(struct work_struct *work);
void phy_start_machine(struct phy_device *phydev,
		void (*handler)(struct net_device *));
void phy_stop_machine(struct phy_device *phydev);
int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
int phy_mii_ioctl(struct phy_device *phydev,
		struct ifreq *ifr, int cmd);
int phy_start_interrupts(struct phy_device *phydev);
void phy_print_status(struct phy_device *phydev);
void phy_device_free(struct phy_device *phydev);

int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
		int (*run)(struct phy_device *));
int phy_register_fixup_for_id(const char *bus_id,
		int (*run)(struct phy_device *));
int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
		int (*run)(struct phy_device *));
int phy_scan_fixups(struct phy_device *phydev);

int __init mdio_bus_init(void);
void mdio_bus_exit(void);

extern struct bus_type mdio_bus_type;
#endif /* __PHY_H */
Commit	Line	Data
00db8189 AF	1	/*
	2	* include/linux/phy.h
	3	*
	4	* Framework and drivers for configuring and reading different PHYs
	5	* Based on code in sungem_phy.c and gianfar_phy.c
	6	*
	7	* Author: Andy Fleming
	8	*
	9	* Copyright (c) 2004 Freescale Semiconductor, Inc.
	10	*
	11	* This program is free software; you can redistribute it and/or modify it
	12	* under the terms of the GNU General Public License as published by the
	13	* Free Software Foundation; either version 2 of the License, or (at your
	14	* option) any later version.
	15	*
	16	*/
	17
	18	#ifndef __PHY_H
	19	#define __PHY_H
	20
	21	#include <linux/spinlock.h>
	22	#include <linux/device.h>
13df29f6 MR	23	#include <linux/ethtool.h>
	24	#include <linux/mii.h>
	25	#include <linux/timer.h>
	26	#include <linux/workqueue.h>
8626d3b4	27	#include <linux/mod_devicetable.h>
00db8189	28
60063497	29	#include <linux/atomic.h>
0ac49527	30
00db8189 AF	31	#define PHY_BASIC_FEATURES (SUPPORTED_10baseT_Half \| \
	32	SUPPORTED_10baseT_Full \| \
	33	SUPPORTED_100baseT_Half \| \
	34	SUPPORTED_100baseT_Full \| \
	35	SUPPORTED_Autoneg \| \
	36	SUPPORTED_TP \| \
	37	SUPPORTED_MII)
	38
	39	#define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES \| \
	40	SUPPORTED_1000baseT_Half \| \
	41	SUPPORTED_1000baseT_Full)
	42
c5e38a94 AF	43	/*
c5e38a94 AF	44	* Set phydev->irq to PHY_POLL if interrupts are not supported,
00db8189 AF	45	* or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
	46	* the attached driver handles the interrupt
	47	*/
	48	#define PHY_POLL -1
	49	#define PHY_IGNORE_INTERRUPT -2
	50
	51	#define PHY_HAS_INTERRUPT 0x00000001
	52	#define PHY_HAS_MAGICANEG 0x00000002
	53
e8a2b6a4 AF	54	/* Interface Mode definitions */
e8a2b6a4 AF	55	typedef enum {
4157ef1b	56	PHY_INTERFACE_MODE_NA,
e8a2b6a4 AF	57	PHY_INTERFACE_MODE_MII,
	58	PHY_INTERFACE_MODE_GMII,
	59	PHY_INTERFACE_MODE_SGMII,
	60	PHY_INTERFACE_MODE_TBI,
	61	PHY_INTERFACE_MODE_RMII,
	62	PHY_INTERFACE_MODE_RGMII,
a999589c	63	PHY_INTERFACE_MODE_RGMII_ID,
7d400a4c KP	64	PHY_INTERFACE_MODE_RGMII_RXID,
7d400a4c KP	65	PHY_INTERFACE_MODE_RGMII_TXID,
4157ef1b SG	66	PHY_INTERFACE_MODE_RTBI,
4157ef1b SG	67	PHY_INTERFACE_MODE_SMII,
e8a2b6a4 AF	68	} phy_interface_t;
e8a2b6a4 AF	69
00db8189	70
e8a2b6a4	71	#define PHY_INIT_TIMEOUT 100000
00db8189 AF	72	#define PHY_STATE_TIME 1
	73	#define PHY_FORCE_TIMEOUT 10
	74	#define PHY_AN_TIMEOUT 10
	75
e8a2b6a4	76	#define PHY_MAX_ADDR 32
00db8189	77
a4d00f17	78	/* Used when trying to connect to a specific phy (mii bus id:phy device id) */
9d9326d3 AF	79	#define PHY_ID_FMT "%s:%02x"
	80
	81	/*
	82	* Need to be a little smaller than phydev->dev.bus_id to leave room
	83	* for the ":%02x"
	84	*/
8e401ecc	85	#define MII_BUS_ID_SIZE (20 - 3)
a4d00f17	86
abf35df2 JG	87	/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
	88	IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
	89	#define MII_ADDR_C45 (1<<30)
	90
c5e38a94 AF	91	/*
	92	* The Bus class for PHYs. Devices which provide access to
	93	* PHYs should register using this structure
	94	*/
00db8189 AF	95	struct mii_bus {
00db8189 AF	96	const char *name;
9d9326d3	97	char id[MII_BUS_ID_SIZE];
00db8189 AF	98	void *priv;
	99	int (read)(struct mii_bus bus, int phy_id, int regnum);
	100	int (write)(struct mii_bus bus, int phy_id, int regnum, u16 val);
	101	int (reset)(struct mii_bus bus);
	102
c5e38a94 AF	103	/*
	104	* A lock to ensure that only one thing can read/write
	105	* the MDIO bus at a time
	106	*/
35b5f6b1	107	struct mutex mdio_lock;
00db8189	108
18ee49dd	109	struct device *parent;
46abc021 LB	110	enum {
	111	MDIOBUS_ALLOCATED = 1,
	112	MDIOBUS_REGISTERED,
	113	MDIOBUS_UNREGISTERED,
	114	MDIOBUS_RELEASED,
	115	} state;
	116	struct device dev;
00db8189 AF	117
	118	/* list of all PHYs on bus */
	119	struct phy_device *phy_map[PHY_MAX_ADDR];
	120
c6883996	121	/* PHY addresses to be ignored when probing */
f896424c MP	122	u32 phy_mask;
f896424c MP	123
c5e38a94 AF	124	/*
	125	* Pointer to an array of interrupts, each PHY's
	126	* interrupt at the index matching its address
	127	*/
00db8189 AF	128	int *irq;
00db8189 AF	129	};
46abc021	130	#define to_mii_bus(d) container_of(d, struct mii_bus, dev)
00db8189	131
eb8a54a7 TT	132	struct mii_bus *mdiobus_alloc_size(size_t);
	133	static inline struct mii_bus *mdiobus_alloc(void)
	134	{
	135	return mdiobus_alloc_size(0);
	136	}
	137
2e888103 LB	138	int mdiobus_register(struct mii_bus *bus);
	139	void mdiobus_unregister(struct mii_bus *bus);
	140	void mdiobus_free(struct mii_bus *bus);
	141	struct phy_device mdiobus_scan(struct mii_bus bus, int addr);
abf35df2 JG	142	int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
abf35df2 JG	143	int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
2e888103 LB	144
2e888103 LB	145
e8a2b6a4 AF	146	#define PHY_INTERRUPT_DISABLED 0x0
e8a2b6a4 AF	147	#define PHY_INTERRUPT_ENABLED 0x80000000
00db8189 AF	148
	149	/* PHY state machine states:
	150	*
	151	* DOWN: PHY device and driver are not ready for anything. probe
	152	* should be called if and only if the PHY is in this state,
	153	* given that the PHY device exists.
	154	* - PHY driver probe function will, depending on the PHY, set
	155	* the state to STARTING or READY
	156	*
	157	* STARTING: PHY device is coming up, and the ethernet driver is
	158	* not ready. PHY drivers may set this in the probe function.
	159	* If they do, they are responsible for making sure the state is
	160	* eventually set to indicate whether the PHY is UP or READY,
	161	* depending on the state when the PHY is done starting up.
	162	* - PHY driver will set the state to READY
	163	* - start will set the state to PENDING
	164	*
	165	* READY: PHY is ready to send and receive packets, but the
	166	* controller is not. By default, PHYs which do not implement
	167	* probe will be set to this state by phy_probe(). If the PHY
	168	* driver knows the PHY is ready, and the PHY state is STARTING,
	169	* then it sets this STATE.
	170	* - start will set the state to UP
	171	*
	172	* PENDING: PHY device is coming up, but the ethernet driver is
	173	* ready. phy_start will set this state if the PHY state is
	174	* STARTING.
	175	* - PHY driver will set the state to UP when the PHY is ready
	176	*
	177	* UP: The PHY and attached device are ready to do work.
	178	* Interrupts should be started here.
	179	* - timer moves to AN
	180	*
	181	* AN: The PHY is currently negotiating the link state. Link is
	182	* therefore down for now. phy_timer will set this state when it
	183	* detects the state is UP. config_aneg will set this state
	184	* whenever called with phydev->autoneg set to AUTONEG_ENABLE.
	185	* - If autonegotiation finishes, but there's no link, it sets
	186	* the state to NOLINK.
	187	* - If aneg finishes with link, it sets the state to RUNNING,
	188	* and calls adjust_link
	189	* - If autonegotiation did not finish after an arbitrary amount
	190	* of time, autonegotiation should be tried again if the PHY
	191	* supports "magic" autonegotiation (back to AN)
	192	* - If it didn't finish, and no magic_aneg, move to FORCING.
	193	*
	194	* NOLINK: PHY is up, but not currently plugged in.
	195	* - If the timer notes that the link comes back, we move to RUNNING
	196	* - config_aneg moves to AN
	197	* - phy_stop moves to HALTED
	198	*
	199	* FORCING: PHY is being configured with forced settings
	200	* - if link is up, move to RUNNING
	201	* - If link is down, we drop to the next highest setting, and
	202	* retry (FORCING) after a timeout
	203	* - phy_stop moves to HALTED
	204	*
	205	* RUNNING: PHY is currently up, running, and possibly sending
	206	* and/or receiving packets
	207	* - timer will set CHANGELINK if we're polling (this ensures the
	208	* link state is polled every other cycle of this state machine,
	209	* which makes it every other second)
	210	* - irq will set CHANGELINK
	211	* - config_aneg will set AN
212	* - phy_stop moves to HALTED
213	*
214	* CHANGELINK: PHY experienced a change in link state
215	* - timer moves to RUNNING if link
216	* - timer moves to NOLINK if the link is down
217	* - phy_stop moves to HALTED
218	*
219	* HALTED: PHY is up, but no polling or interrupts are done. Or
220	* PHY is in an error state.
221	*
222	* - phy_start moves to RESUMING
223	*
224	* RESUMING: PHY was halted, but now wants to run again.
225	* - If we are forcing, or aneg is done, timer moves to RUNNING
226	* - If aneg is not done, timer moves to AN
227	* - phy_stop moves to HALTED
228	*/
229	enum phy_state {
230	PHY_DOWN=0,
231	PHY_STARTING,
232	PHY_READY,
233	PHY_PENDING,
234	PHY_UP,
235	PHY_AN,
236	PHY_RUNNING,
237	PHY_NOLINK,
238	PHY_FORCING,
239	PHY_CHANGELINK,
240	PHY_HALTED,
241	PHY_RESUMING
242	};
243
c1f19b51 RC	244	struct sk_buff;
c1f19b51 RC	245
00db8189 AF	246	/* phy_device: An instance of a PHY
	247	*
	248	* drv: Pointer to the driver for this PHY instance
	249	* bus: Pointer to the bus this PHY is on
	250	* dev: driver model device structure for this PHY
	251	* phy_id: UID for this device found during discovery
	252	* state: state of the PHY for management purposes
	253	* dev_flags: Device-specific flags used by the PHY driver.
	254	* addr: Bus address of PHY
	255	* link_timeout: The number of timer firings to wait before the
	256	* giving up on the current attempt at acquiring a link
	257	* irq: IRQ number of the PHY's interrupt (-1 if none)
	258	* phy_timer: The timer for handling the state machine
	259	* phy_queue: A work_queue for the interrupt
	260	* attached_dev: The attached enet driver's device instance ptr
	261	* adjust_link: Callback for the enet controller to respond to
	262	* changes in the link state.
	263	* adjust_state: Callback for the enet driver to respond to
	264	* changes in the state machine.
	265	*
	266	* speed, duplex, pause, supported, advertising, and
	267	* autoneg are used like in mii_if_info
	268	*
	269	* interrupts currently only supports enabled or disabled,
	270	* but could be changed in the future to support enabling
	271	* and disabling specific interrupts
	272	*
	273	* Contains some infrastructure for polling and interrupt
	274	* handling, as well as handling shifts in PHY hardware state
	275	*/
	276	struct phy_device {
	277	/* Information about the PHY type */
	278	/* And management functions */
	279	struct phy_driver *drv;
	280
	281	struct mii_bus *bus;
	282
	283	struct device dev;
	284
	285	u32 phy_id;
	286
	287	enum phy_state state;
	288
	289	u32 dev_flags;
	290
e8a2b6a4 AF	291	phy_interface_t interface;
e8a2b6a4 AF	292
c6883996	293	/* Bus address of the PHY (0-31) */
00db8189 AF	294	int addr;
00db8189 AF	295
c5e38a94 AF	296	/*
c5e38a94 AF	297	* forced speed & duplex (no autoneg)
00db8189 AF	298	* partner speed & duplex & pause (autoneg)
	299	*/
	300	int speed;
	301	int duplex;
	302	int pause;
	303	int asym_pause;
	304
	305	/* The most recently read link state */
	306	int link;
	307
	308	/* Enabled Interrupts */
	309	u32 interrupts;
	310
	311	/* Union of PHY and Attached devices' supported modes */
	312	/* See mii.h for more info */
	313	u32 supported;
	314	u32 advertising;
	315
	316	int autoneg;
	317
	318	int link_timeout;
	319
c5e38a94 AF	320	/*
	321	* Interrupt number for this PHY
	322	* -1 means no interrupt
	323	*/
00db8189 AF	324	int irq;
	325
	326	/* private data pointer */
	327	/* For use by PHYs to maintain extra state */
	328	void *priv;
	329
	330	/* Interrupt and Polling infrastructure */
	331	struct work_struct phy_queue;
a390d1f3	332	struct delayed_work state_queue;
0ac49527	333	atomic_t irq_disable;
00db8189	334
35b5f6b1	335	struct mutex lock;
00db8189 AF	336
	337	struct net_device *attached_dev;
	338
	339	void (adjust_link)(struct net_device dev);
	340
	341	void (adjust_state)(struct net_device dev);
	342	};
	343	#define to_phy_device(d) container_of(d, struct phy_device, dev)
	344
	345	/* struct phy_driver: Driver structure for a particular PHY type
	346	*
	347	* phy_id: The result of reading the UID registers of this PHY
	348	* type, and ANDing them with the phy_id_mask. This driver
	349	* only works for PHYs with IDs which match this field
	350	* name: The friendly name of this PHY type
	351	* phy_id_mask: Defines the important bits of the phy_id
	352	* features: A list of features (speed, duplex, etc) supported
	353	* by this PHY
	354	* flags: A bitfield defining certain other features this PHY
	355	* supports (like interrupts)
	356	*
	357	* The drivers must implement config_aneg and read_status. All
	358	* other functions are optional. Note that none of these
	359	* functions should be called from interrupt time. The goal is
	360	* for the bus read/write functions to be able to block when the
	361	* bus transaction is happening, and be freed up by an interrupt
	362	* (The MPC85xx has this ability, though it is not currently
	363	* supported in the driver).
	364	*/
	365	struct phy_driver {
	366	u32 phy_id;
	367	char *name;
	368	unsigned int phy_id_mask;
	369	u32 features;
	370	u32 flags;
	371
c5e38a94 AF	372	/*
	373	* Called to initialize the PHY,
	374	* including after a reset
	375	*/
00db8189 AF	376	int (config_init)(struct phy_device phydev);
00db8189 AF	377
c5e38a94 AF	378	/*
	379	* Called during discovery. Used to set
	380	* up device-specific structures, if any
	381	*/
00db8189 AF	382	int (probe)(struct phy_device phydev);
	383
	384	/* PHY Power Management */
	385	int (suspend)(struct phy_device phydev);
	386	int (resume)(struct phy_device phydev);
	387
c5e38a94 AF	388	/*
c5e38a94 AF	389	* Configures the advertisement and resets
00db8189 AF	390	* autonegotiation if phydev->autoneg is on,
00db8189 AF	391	* forces the speed to the current settings in phydev
c5e38a94 AF	392	* if phydev->autoneg is off
c5e38a94 AF	393	*/
00db8189 AF	394	int (config_aneg)(struct phy_device phydev);
	395
	396	/* Determines the negotiated speed and duplex */
	397	int (read_status)(struct phy_device phydev);
	398
	399	/* Clears any pending interrupts */
	400	int (ack_interrupt)(struct phy_device phydev);
	401
	402	/* Enables or disables interrupts */
	403	int (config_intr)(struct phy_device phydev);
	404
a8729eb3 AG	405	/*
	406	* Checks if the PHY generated an interrupt.
	407	* For multi-PHY devices with shared PHY interrupt pin
	408	*/
	409	int (did_interrupt)(struct phy_device phydev);
	410
00db8189 AF	411	/* Clears up any memory if needed */
	412	void (remove)(struct phy_device phydev);
	413
c1f19b51 RC	414	/* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
	415	int (hwtstamp)(struct phy_device phydev, struct ifreq *ifr);
	416
	417	/*
	418	* Requests a Rx timestamp for 'skb'. If the skb is accepted,
	419	* the phy driver promises to deliver it using netif_rx() as
	420	* soon as a timestamp becomes available. One of the
	421	* PTP_CLASS_ values is passed in 'type'. The function must
	422	* return true if the skb is accepted for delivery.
	423	*/
	424	bool (rxtstamp)(struct phy_device dev, struct sk_buff *skb, int type);
	425
	426	/*
	427	* Requests a Tx timestamp for 'skb'. The phy driver promises
da92b194	428	* to deliver it using skb_complete_tx_timestamp() as soon as a
c1f19b51 RC	429	* timestamp becomes available. One of the PTP_CLASS_ values
	430	* is passed in 'type'.
	431	*/
	432	void (txtstamp)(struct phy_device dev, struct sk_buff *skb, int type);
	433
00db8189 AF	434	struct device_driver driver;
	435	};
	436	#define to_phy_driver(d) container_of(d, struct phy_driver, driver)
	437
f62220d3 AF	438	#define PHY_ANY_ID "MATCH ANY PHY"
	439	#define PHY_ANY_UID 0xffffffff
	440
	441	/* A Structure for boards to register fixups with the PHY Lib */
	442	struct phy_fixup {
	443	struct list_head list;
8e401ecc	444	char bus_id[20];
f62220d3 AF	445	u32 phy_uid;
	446	u32 phy_uid_mask;
	447	int (run)(struct phy_device phydev);
	448	};
	449
2e888103 LB	450	/**
	451	* phy_read - Convenience function for reading a given PHY register
	452	* @phydev: the phy_device struct
	453	* @regnum: register number to read
	454	*
	455	* NOTE: MUST NOT be called from interrupt context,
	456	* because the bus read/write functions may wait for an interrupt
	457	* to conclude the operation.
	458	*/
abf35df2	459	static inline int phy_read(struct phy_device *phydev, u32 regnum)
2e888103 LB	460	{
	461	return mdiobus_read(phydev->bus, phydev->addr, regnum);
	462	}
	463
	464	/**
	465	* phy_write - Convenience function for writing a given PHY register
	466	* @phydev: the phy_device struct
	467	* @regnum: register number to write
	468	* @val: value to write to @regnum
	469	*
	470	* NOTE: MUST NOT be called from interrupt context,
	471	* because the bus read/write functions may wait for an interrupt
	472	* to conclude the operation.
	473	*/
abf35df2	474	static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
2e888103 LB	475	{
	476	return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
	477	}
	478
cac1f3c8	479	int get_phy_id(struct mii_bus bus, int addr, u32 phy_id);
00db8189	480	struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
4dea547f	481	int phy_device_register(struct phy_device *phy);
2f5cb434	482	int phy_init_hw(struct phy_device *phydev);
e1393456	483	struct phy_device * phy_attach(struct net_device *dev,
f62220d3	484	const char *bus_id, u32 flags, phy_interface_t interface);
f8f76db1	485	struct phy_device phy_find_first(struct mii_bus bus);
fa94f6d9 GL	486	int phy_connect_direct(struct net_device dev, struct phy_device phydev,
	487	void (handler)(struct net_device ), u32 flags,
	488	phy_interface_t interface);
f62220d3	489	struct phy_device * phy_connect(struct net_device dev, const char bus_id,
e8a2b6a4 AF	490	void (handler)(struct net_device ), u32 flags,
e8a2b6a4 AF	491	phy_interface_t interface);
e1393456 AF	492	void phy_disconnect(struct phy_device *phydev);
	493	void phy_detach(struct phy_device *phydev);
	494	void phy_start(struct phy_device *phydev);
	495	void phy_stop(struct phy_device *phydev);
	496	int phy_start_aneg(struct phy_device *phydev);
	497
e1393456	498	int phy_stop_interrupts(struct phy_device *phydev);
00db8189 AF	499
	500	static inline int phy_read_status(struct phy_device *phydev) {
	501	return phydev->drv->read_status(phydev);
	502	}
	503
00db8189 AF	504	int genphy_restart_aneg(struct phy_device *phydev);
	505	int genphy_config_aneg(struct phy_device *phydev);
	506	int genphy_update_link(struct phy_device *phydev);
	507	int genphy_read_status(struct phy_device *phydev);
0f0ca340 GC	508	int genphy_suspend(struct phy_device *phydev);
0f0ca340 GC	509	int genphy_resume(struct phy_device *phydev);
00db8189 AF	510	void phy_driver_unregister(struct phy_driver *drv);
00db8189 AF	511	int phy_driver_register(struct phy_driver *new_driver);
4f9c85a1	512	void phy_state_machine(struct work_struct *work);
00db8189 AF	513	void phy_start_machine(struct phy_device *phydev,
	514	void (handler)(struct net_device ));
	515	void phy_stop_machine(struct phy_device *phydev);
	516	int phy_ethtool_sset(struct phy_device phydev, struct ethtool_cmd cmd);
	517	int phy_ethtool_gset(struct phy_device phydev, struct ethtool_cmd cmd);
	518	int phy_mii_ioctl(struct phy_device *phydev,
28b04113	519	struct ifreq *ifr, int cmd);
e1393456 AF	520	int phy_start_interrupts(struct phy_device *phydev);
e1393456 AF	521	void phy_print_status(struct phy_device *phydev);
6f4a7f41	522	void phy_device_free(struct phy_device *phydev);
00db8189	523
f62220d3 AF	524	int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
	525	int (run)(struct phy_device ));
	526	int phy_register_fixup_for_id(const char *bus_id,
	527	int (run)(struct phy_device ));
	528	int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
	529	int (run)(struct phy_device ));
	530	int phy_scan_fixups(struct phy_device *phydev);
	531
9b9a8bfc AF	532	int __init mdio_bus_init(void);
	533	void mdio_bus_exit(void);
	534
00db8189	535	extern struct bus_type mdio_bus_type;
00db8189	536	#endif /* __PHY_H */