[deliverable/linux.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 <asm/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_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_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	(BUS_ID_SIZE - 3)

/* 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 *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 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
};

/* 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-32) */
	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 work_struct state_queue;
	struct timer_list phy_timer;
	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);

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

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

int phy_read(struct phy_device *phydev, u16 regnum);
int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
int phy_clear_interrupt(struct phy_device *phydev);
int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
struct phy_device * phy_attach(struct net_device *dev,
		const char *phy_id, u32 flags, phy_interface_t interface);
struct phy_device * phy_connect(struct net_device *dev, const char *phy_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 mdiobus_register(struct mii_bus *bus);
void mdiobus_unregister(struct mii_bus *bus);
void phy_sanitize_settings(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_config_advert(struct phy_device *phydev);
int genphy_setup_forced(struct phy_device *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);
void phy_driver_unregister(struct phy_driver *drv);
int phy_driver_register(struct phy_driver *new_driver);
void phy_prepare_link(struct phy_device *phydev,
		void (*adjust_link)(struct net_device *));
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 mii_ioctl_data *mii_data, int cmd);
int phy_start_interrupts(struct phy_device *phydev);
void phy_print_status(struct phy_device *phydev);
struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id);
void phy_device_free(struct phy_device *phydev);

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>
00db8189	27
0ac49527 MR	28	#include <asm/atomic.h>
0ac49527 MR	29
00db8189 AF	30	#define PHY_BASIC_FEATURES (SUPPORTED_10baseT_Half \| \
	31	SUPPORTED_10baseT_Full \| \
	32	SUPPORTED_100baseT_Half \| \
	33	SUPPORTED_100baseT_Full \| \
	34	SUPPORTED_Autoneg \| \
	35	SUPPORTED_TP \| \
	36	SUPPORTED_MII)
	37
	38	#define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES \| \
	39	SUPPORTED_1000baseT_Half \| \
	40	SUPPORTED_1000baseT_Full)
	41
	42	/* Set phydev->irq to PHY_POLL if interrupts are not supported,
	43	* or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
	44	* the attached driver handles the interrupt
	45	*/
	46	#define PHY_POLL -1
	47	#define PHY_IGNORE_INTERRUPT -2
	48
	49	#define PHY_HAS_INTERRUPT 0x00000001
	50	#define PHY_HAS_MAGICANEG 0x00000002
	51
e8a2b6a4 AF	52	/* Interface Mode definitions */
	53	typedef enum {
	54	PHY_INTERFACE_MODE_MII,
	55	PHY_INTERFACE_MODE_GMII,
	56	PHY_INTERFACE_MODE_SGMII,
	57	PHY_INTERFACE_MODE_TBI,
	58	PHY_INTERFACE_MODE_RMII,
	59	PHY_INTERFACE_MODE_RGMII,
a999589c	60	PHY_INTERFACE_MODE_RGMII_ID,
7d400a4c KP	61	PHY_INTERFACE_MODE_RGMII_RXID,
7d400a4c KP	62	PHY_INTERFACE_MODE_RGMII_TXID,
e8a2b6a4 AF	63	PHY_INTERFACE_MODE_RTBI
	64	} phy_interface_t;
	65
00db8189	66
e8a2b6a4	67	#define PHY_INIT_TIMEOUT 100000
00db8189 AF	68	#define PHY_STATE_TIME 1
	69	#define PHY_FORCE_TIMEOUT 10
	70	#define PHY_AN_TIMEOUT 10
	71
e8a2b6a4	72	#define PHY_MAX_ADDR 32
00db8189	73
a4d00f17	74	/* Used when trying to connect to a specific phy (mii bus id:phy device id) */
9d9326d3 AF	75	#define PHY_ID_FMT "%s:%02x"
	76
	77	/*
	78	* Need to be a little smaller than phydev->dev.bus_id to leave room
	79	* for the ":%02x"
	80	*/
	81	#define MII_BUS_ID_SIZE (BUS_ID_SIZE - 3)
a4d00f17	82
00db8189 AF	83	/* The Bus class for PHYs. Devices which provide access to
	84	* PHYs should register using this structure */
	85	struct mii_bus {
	86	const char *name;
9d9326d3	87	char id[MII_BUS_ID_SIZE];
00db8189 AF	88	void *priv;
	89	int (read)(struct mii_bus bus, int phy_id, int regnum);
	90	int (write)(struct mii_bus bus, int phy_id, int regnum, u16 val);
	91	int (reset)(struct mii_bus bus);
	92
	93	/* A lock to ensure that only one thing can read/write
	94	* the MDIO bus at a time */
35b5f6b1	95	struct mutex mdio_lock;
00db8189 AF	96
	97	struct device *dev;
	98
	99	/* list of all PHYs on bus */
	100	struct phy_device *phy_map[PHY_MAX_ADDR];
	101
f896424c MP	102	/* Phy addresses to be ignored when probing */
	103	u32 phy_mask;
	104
00db8189 AF	105	/* Pointer to an array of interrupts, each PHY's
	106	* interrupt at the index matching its address */
	107	int *irq;
	108	};
	109
e8a2b6a4 AF	110	#define PHY_INTERRUPT_DISABLED 0x0
e8a2b6a4 AF	111	#define PHY_INTERRUPT_ENABLED 0x80000000
00db8189 AF	112
	113	/* PHY state machine states:
	114	*
	115	* DOWN: PHY device and driver are not ready for anything. probe
	116	* should be called if and only if the PHY is in this state,
	117	* given that the PHY device exists.
	118	* - PHY driver probe function will, depending on the PHY, set
	119	* the state to STARTING or READY
	120	*
	121	* STARTING: PHY device is coming up, and the ethernet driver is
	122	* not ready. PHY drivers may set this in the probe function.
	123	* If they do, they are responsible for making sure the state is
	124	* eventually set to indicate whether the PHY is UP or READY,
	125	* depending on the state when the PHY is done starting up.
	126	* - PHY driver will set the state to READY
	127	* - start will set the state to PENDING
	128	*
	129	* READY: PHY is ready to send and receive packets, but the
	130	* controller is not. By default, PHYs which do not implement
	131	* probe will be set to this state by phy_probe(). If the PHY
	132	* driver knows the PHY is ready, and the PHY state is STARTING,
	133	* then it sets this STATE.
	134	* - start will set the state to UP
	135	*
	136	* PENDING: PHY device is coming up, but the ethernet driver is
	137	* ready. phy_start will set this state if the PHY state is
	138	* STARTING.
	139	* - PHY driver will set the state to UP when the PHY is ready
	140	*
	141	* UP: The PHY and attached device are ready to do work.
	142	* Interrupts should be started here.
	143	* - timer moves to AN
	144	*
	145	* AN: The PHY is currently negotiating the link state. Link is
	146	* therefore down for now. phy_timer will set this state when it
	147	* detects the state is UP. config_aneg will set this state
	148	* whenever called with phydev->autoneg set to AUTONEG_ENABLE.
	149	* - If autonegotiation finishes, but there's no link, it sets
	150	* the state to NOLINK.
	151	* - If aneg finishes with link, it sets the state to RUNNING,
	152	* and calls adjust_link
	153	* - If autonegotiation did not finish after an arbitrary amount
	154	* of time, autonegotiation should be tried again if the PHY
	155	* supports "magic" autonegotiation (back to AN)
	156	* - If it didn't finish, and no magic_aneg, move to FORCING.
	157	*
	158	* NOLINK: PHY is up, but not currently plugged in.
	159	* - If the timer notes that the link comes back, we move to RUNNING
	160	* - config_aneg moves to AN
	161	* - phy_stop moves to HALTED
	162	*
	163	* FORCING: PHY is being configured with forced settings
	164	* - if link is up, move to RUNNING
	165	* - If link is down, we drop to the next highest setting, and
	166	* retry (FORCING) after a timeout
	167	* - phy_stop moves to HALTED
	168	*
	169	* RUNNING: PHY is currently up, running, and possibly sending
	170	* and/or receiving packets
	171	* - timer will set CHANGELINK if we're polling (this ensures the
	172	* link state is polled every other cycle of this state machine,
	173	* which makes it every other second)
	174	* - irq will set CHANGELINK
	175	* - config_aneg will set AN
176	* - phy_stop moves to HALTED
177	*
178	* CHANGELINK: PHY experienced a change in link state
179	* - timer moves to RUNNING if link
180	* - timer moves to NOLINK if the link is down
181	* - phy_stop moves to HALTED
182	*
183	* HALTED: PHY is up, but no polling or interrupts are done. Or
184	* PHY is in an error state.
185	*
186	* - phy_start moves to RESUMING
187	*
188	* RESUMING: PHY was halted, but now wants to run again.
189	* - If we are forcing, or aneg is done, timer moves to RUNNING
190	* - If aneg is not done, timer moves to AN
191	* - phy_stop moves to HALTED
192	*/
193	enum phy_state {
194	PHY_DOWN=0,
195	PHY_STARTING,
196	PHY_READY,
197	PHY_PENDING,
198	PHY_UP,
199	PHY_AN,
200	PHY_RUNNING,
201	PHY_NOLINK,
202	PHY_FORCING,
203	PHY_CHANGELINK,
204	PHY_HALTED,
205	PHY_RESUMING
206	};
207
208	/* phy_device: An instance of a PHY
209	*
210	* drv: Pointer to the driver for this PHY instance
211	* bus: Pointer to the bus this PHY is on
212	* dev: driver model device structure for this PHY
213	* phy_id: UID for this device found during discovery
214	* state: state of the PHY for management purposes
215	* dev_flags: Device-specific flags used by the PHY driver.
216	* addr: Bus address of PHY
217	* link_timeout: The number of timer firings to wait before the
218	* giving up on the current attempt at acquiring a link
219	* irq: IRQ number of the PHY's interrupt (-1 if none)
220	* phy_timer: The timer for handling the state machine
221	* phy_queue: A work_queue for the interrupt
222	* attached_dev: The attached enet driver's device instance ptr
223	* adjust_link: Callback for the enet controller to respond to
224	* changes in the link state.
225	* adjust_state: Callback for the enet driver to respond to
226	* changes in the state machine.
227	*
228	* speed, duplex, pause, supported, advertising, and
229	* autoneg are used like in mii_if_info
230	*
231	* interrupts currently only supports enabled or disabled,
232	* but could be changed in the future to support enabling
233	* and disabling specific interrupts
234	*
235	* Contains some infrastructure for polling and interrupt
236	* handling, as well as handling shifts in PHY hardware state
237	*/
238	struct phy_device {
239	/* Information about the PHY type */
240	/* And management functions */
241	struct phy_driver *drv;
242
243	struct mii_bus *bus;
244
245	struct device dev;
246
247	u32 phy_id;
248
249	enum phy_state state;
250
251	u32 dev_flags;
252
e8a2b6a4 AF	253	phy_interface_t interface;
e8a2b6a4 AF	254
00db8189 AF	255	/* Bus address of the PHY (0-32) */
	256	int addr;
	257
	258	/* forced speed & duplex (no autoneg)
	259	* partner speed & duplex & pause (autoneg)
	260	*/
	261	int speed;
	262	int duplex;
	263	int pause;
	264	int asym_pause;
	265
	266	/* The most recently read link state */
	267	int link;
	268
	269	/* Enabled Interrupts */
	270	u32 interrupts;
	271
	272	/* Union of PHY and Attached devices' supported modes */
	273	/* See mii.h for more info */
	274	u32 supported;
	275	u32 advertising;
	276
	277	int autoneg;
	278
	279	int link_timeout;
	280
	281	/* Interrupt number for this PHY
	282	* -1 means no interrupt */
	283	int irq;
	284
	285	/* private data pointer */
	286	/* For use by PHYs to maintain extra state */
	287	void *priv;
	288
	289	/* Interrupt and Polling infrastructure */
	290	struct work_struct phy_queue;
35b5f6b1	291	struct work_struct state_queue;
00db8189	292	struct timer_list phy_timer;
0ac49527	293	atomic_t irq_disable;
00db8189	294
35b5f6b1	295	struct mutex lock;
00db8189 AF	296
	297	struct net_device *attached_dev;
	298
	299	void (adjust_link)(struct net_device dev);
	300
	301	void (adjust_state)(struct net_device dev);
	302	};
	303	#define to_phy_device(d) container_of(d, struct phy_device, dev)
	304
	305	/* struct phy_driver: Driver structure for a particular PHY type
	306	*
	307	* phy_id: The result of reading the UID registers of this PHY
	308	* type, and ANDing them with the phy_id_mask. This driver
	309	* only works for PHYs with IDs which match this field
	310	* name: The friendly name of this PHY type
	311	* phy_id_mask: Defines the important bits of the phy_id
	312	* features: A list of features (speed, duplex, etc) supported
	313	* by this PHY
	314	* flags: A bitfield defining certain other features this PHY
	315	* supports (like interrupts)
	316	*
	317	* The drivers must implement config_aneg and read_status. All
	318	* other functions are optional. Note that none of these
	319	* functions should be called from interrupt time. The goal is
	320	* for the bus read/write functions to be able to block when the
	321	* bus transaction is happening, and be freed up by an interrupt
	322	* (The MPC85xx has this ability, though it is not currently
	323	* supported in the driver).
	324	*/
	325	struct phy_driver {
	326	u32 phy_id;
	327	char *name;
	328	unsigned int phy_id_mask;
	329	u32 features;
	330	u32 flags;
	331
	332	/* Called to initialize the PHY,
	333	* including after a reset */
	334	int (config_init)(struct phy_device phydev);
	335
	336	/* Called during discovery. Used to set
	337	* up device-specific structures, if any */
	338	int (probe)(struct phy_device phydev);
	339
	340	/* PHY Power Management */
	341	int (suspend)(struct phy_device phydev);
	342	int (resume)(struct phy_device phydev);
	343
	344	/* Configures the advertisement and resets
	345	* autonegotiation if phydev->autoneg is on,
	346	* forces the speed to the current settings in phydev
	347	* if phydev->autoneg is off */
	348	int (config_aneg)(struct phy_device phydev);
	349
	350	/* Determines the negotiated speed and duplex */
	351	int (read_status)(struct phy_device phydev);
	352
	353	/* Clears any pending interrupts */
	354	int (ack_interrupt)(struct phy_device phydev);
	355
	356	/* Enables or disables interrupts */
	357	int (config_intr)(struct phy_device phydev);
	358
	359	/* Clears up any memory if needed */
360	void (remove)(struct phy_device phydev);
361
362	struct device_driver driver;
363	};
364	#define to_phy_driver(d) container_of(d, struct phy_driver, driver)
365
366	int phy_read(struct phy_device *phydev, u16 regnum);
367	int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
368	struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
369	int phy_clear_interrupt(struct phy_device *phydev);
370	int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
e1393456	371	struct phy_device * phy_attach(struct net_device *dev,
e8a2b6a4	372	const char *phy_id, u32 flags, phy_interface_t interface);
e1393456	373	struct phy_device * phy_connect(struct net_device dev, const char phy_id,
e8a2b6a4 AF	374	void (handler)(struct net_device ), u32 flags,
e8a2b6a4 AF	375	phy_interface_t interface);
e1393456 AF	376	void phy_disconnect(struct phy_device *phydev);
	377	void phy_detach(struct phy_device *phydev);
	378	void phy_start(struct phy_device *phydev);
	379	void phy_stop(struct phy_device *phydev);
	380	int phy_start_aneg(struct phy_device *phydev);
	381
	382	int mdiobus_register(struct mii_bus *bus);
	383	void mdiobus_unregister(struct mii_bus *bus);
	384	void phy_sanitize_settings(struct phy_device *phydev);
	385	int phy_stop_interrupts(struct phy_device *phydev);
00db8189 AF	386
	387	static inline int phy_read_status(struct phy_device *phydev) {
	388	return phydev->drv->read_status(phydev);
	389	}
	390
e1393456	391	int genphy_config_advert(struct phy_device *phydev);
00db8189 AF	392	int genphy_setup_forced(struct phy_device *phydev);
	393	int genphy_restart_aneg(struct phy_device *phydev);
	394	int genphy_config_aneg(struct phy_device *phydev);
	395	int genphy_update_link(struct phy_device *phydev);
	396	int genphy_read_status(struct phy_device *phydev);
	397	void phy_driver_unregister(struct phy_driver *drv);
	398	int phy_driver_register(struct phy_driver *new_driver);
	399	void phy_prepare_link(struct phy_device *phydev,
	400	void (adjust_link)(struct net_device ));
	401	void phy_start_machine(struct phy_device *phydev,
	402	void (handler)(struct net_device ));
	403	void phy_stop_machine(struct phy_device *phydev);
	404	int phy_ethtool_sset(struct phy_device phydev, struct ethtool_cmd cmd);
	405	int phy_ethtool_gset(struct phy_device phydev, struct ethtool_cmd cmd);
	406	int phy_mii_ioctl(struct phy_device *phydev,
	407	struct mii_ioctl_data *mii_data, int cmd);
e1393456 AF	408	int phy_start_interrupts(struct phy_device *phydev);
e1393456 AF	409	void phy_print_status(struct phy_device *phydev);
11b0bacd	410	struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id);
6f4a7f41	411	void phy_device_free(struct phy_device *phydev);
00db8189 AF	412
00db8189 AF	413	extern struct bus_type mdio_bus_type;
00db8189	414	#endif /* __PHY_H */