[J-u-boot.git] / include / phy.h

/*
 * Copyright 2011 Freescale Semiconductor, Inc.
 *	Andy Fleming <[email protected]>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 *
 * This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h
 */

#ifndef _PHY_H
#define _PHY_H

#include <linux/list.h>
#include <linux/mii.h>
#include <linux/ethtool.h>
#include <linux/mdio.h>

#define PHY_MAX_ADDR 32

#define PHY_FLAG_BROKEN_RESET	(1 << 0) /* soft reset not supported */

#define PHY_DEFAULT_FEATURES	(SUPPORTED_Autoneg | \
				 SUPPORTED_TP | \
				 SUPPORTED_MII)

#define PHY_10BT_FEATURES	(SUPPORTED_10baseT_Half | \
				 SUPPORTED_10baseT_Full)

#define PHY_100BT_FEATURES	(SUPPORTED_100baseT_Half | \
				 SUPPORTED_100baseT_Full)

#define PHY_1000BT_FEATURES	(SUPPORTED_1000baseT_Half | \
				 SUPPORTED_1000baseT_Full)

#define PHY_BASIC_FEATURES	(PHY_10BT_FEATURES | \
				 PHY_100BT_FEATURES | \
				 PHY_DEFAULT_FEATURES)

#define PHY_GBIT_FEATURES	(PHY_BASIC_FEATURES | \
				 PHY_1000BT_FEATURES)

#define PHY_10G_FEATURES	(PHY_GBIT_FEATURES | \
				SUPPORTED_10000baseT_Full)

#ifndef PHY_ANEG_TIMEOUT
#define PHY_ANEG_TIMEOUT	4000
#endif


typedef enum {
	PHY_INTERFACE_MODE_MII,
	PHY_INTERFACE_MODE_GMII,
	PHY_INTERFACE_MODE_SGMII,
	PHY_INTERFACE_MODE_SGMII_2500,
	PHY_INTERFACE_MODE_QSGMII,
	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_XGMII,
	PHY_INTERFACE_MODE_NONE,	/* Must be last */

	PHY_INTERFACE_MODE_COUNT,
} phy_interface_t;

static const char *phy_interface_strings[] = {
	[PHY_INTERFACE_MODE_MII]		= "mii",
	[PHY_INTERFACE_MODE_GMII]		= "gmii",
	[PHY_INTERFACE_MODE_SGMII]		= "sgmii",
	[PHY_INTERFACE_MODE_SGMII_2500]		= "sgmii-2500",
	[PHY_INTERFACE_MODE_QSGMII]		= "qsgmii",
	[PHY_INTERFACE_MODE_TBI]		= "tbi",
	[PHY_INTERFACE_MODE_RMII]		= "rmii",
	[PHY_INTERFACE_MODE_RGMII]		= "rgmii",
	[PHY_INTERFACE_MODE_RGMII_ID]		= "rgmii-id",
	[PHY_INTERFACE_MODE_RGMII_RXID]		= "rgmii-rxid",
	[PHY_INTERFACE_MODE_RGMII_TXID]		= "rgmii-txid",
	[PHY_INTERFACE_MODE_RTBI]		= "rtbi",
	[PHY_INTERFACE_MODE_XGMII]		= "xgmii",
	[PHY_INTERFACE_MODE_NONE]		= "",
};

static inline const char *phy_string_for_interface(phy_interface_t i)
{
	/* Default to unknown */
	if (i > PHY_INTERFACE_MODE_NONE)
		i = PHY_INTERFACE_MODE_NONE;

	return phy_interface_strings[i];
}


struct phy_device;

#define MDIO_NAME_LEN 32

struct mii_dev {
	struct list_head link;
	char name[MDIO_NAME_LEN];
	void *priv;
	int (*read)(struct mii_dev *bus, int addr, int devad, int reg);
	int (*write)(struct mii_dev *bus, int addr, int devad, int reg,
			u16 val);
	int (*reset)(struct mii_dev *bus);
	struct phy_device *phymap[PHY_MAX_ADDR];
	u32 phy_mask;
};

/* struct phy_driver: a structure which defines PHY behavior
 *
 * uid will contain a number which represents the PHY.  During
 * startup, the driver will poll the PHY to find out what its
 * UID--as defined by registers 2 and 3--is.  The 32-bit result
 * gotten from the PHY will be masked to
 * discard any bits which may change based on revision numbers
 * unimportant to functionality
 *
 */
struct phy_driver {
	char *name;
	unsigned int uid;
	unsigned int mask;
	unsigned int mmds;

	u32 features;

	/* Called to do any driver startup necessities */
	/* Will be called during phy_connect */
	int (*probe)(struct phy_device *phydev);

	/* Called to configure the PHY, and modify the controller
	 * based on the results.  Should be called after phy_connect */
	int (*config)(struct phy_device *phydev);

	/* Called when starting up the controller */
	int (*startup)(struct phy_device *phydev);

	/* Called when bringing down the controller */
	int (*shutdown)(struct phy_device *phydev);

	int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
	int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
			u16 val);
	struct list_head list;
};

struct phy_device {
	/* Information about the PHY type */
	/* And management functions */
	struct mii_dev *bus;
	struct phy_driver *drv;
	void *priv;

#ifdef CONFIG_DM_ETH
	struct udevice *dev;
#else
	struct eth_device *dev;
#endif

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

	/* The most recently read link state */
	int link;
	int port;
	phy_interface_t interface;

	u32 advertising;
	u32 supported;
	u32 mmds;

	int autoneg;
	int addr;
	int pause;
	int asym_pause;
	u32 phy_id;
	u32 flags;
};

struct fixed_link {
	int phy_id;
	int duplex;
	int link_speed;
	int pause;
	int asym_pause;
};

static inline int phy_read(struct phy_device *phydev, int devad, int regnum)
{
	struct mii_dev *bus = phydev->bus;

	return bus->read(bus, phydev->addr, devad, regnum);
}

static inline int phy_write(struct phy_device *phydev, int devad, int regnum,
			u16 val)
{
	struct mii_dev *bus = phydev->bus;

	return bus->write(bus, phydev->addr, devad, regnum, val);
}

#ifdef CONFIG_PHYLIB_10G
extern struct phy_driver gen10g_driver;

/* For now, XGMII is the only 10G interface */
static inline int is_10g_interface(phy_interface_t interface)
{
	return interface == PHY_INTERFACE_MODE_XGMII;
}

#endif

int phy_init(void);
int phy_reset(struct phy_device *phydev);
struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
		phy_interface_t interface);
#ifdef CONFIG_DM_ETH
void phy_connect_dev(struct phy_device *phydev, struct udevice *dev);
struct phy_device *phy_connect(struct mii_dev *bus, int addr,
				struct udevice *dev,
				phy_interface_t interface);
#else
void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev);
struct phy_device *phy_connect(struct mii_dev *bus, int addr,
				struct eth_device *dev,
				phy_interface_t interface);
#endif
int phy_startup(struct phy_device *phydev);
int phy_config(struct phy_device *phydev);
int phy_shutdown(struct phy_device *phydev);
int phy_register(struct phy_driver *drv);
int phy_set_supported(struct phy_device *phydev, u32 max_speed);
int genphy_config_aneg(struct phy_device *phydev);
int genphy_restart_aneg(struct phy_device *phydev);
int genphy_update_link(struct phy_device *phydev);
int genphy_parse_link(struct phy_device *phydev);
int genphy_config(struct phy_device *phydev);
int genphy_startup(struct phy_device *phydev);
int genphy_shutdown(struct phy_device *phydev);
int gen10g_config(struct phy_device *phydev);
int gen10g_startup(struct phy_device *phydev);
int gen10g_shutdown(struct phy_device *phydev);
int gen10g_discover_mmds(struct phy_device *phydev);

int phy_mv88e61xx_init(void);
int phy_aquantia_init(void);
int phy_atheros_init(void);
int phy_broadcom_init(void);
int phy_cortina_init(void);
int phy_davicom_init(void);
int phy_et1011c_init(void);
int phy_lxt_init(void);
int phy_marvell_init(void);
int phy_micrel_init(void);
int phy_natsemi_init(void);
int phy_realtek_init(void);
int phy_smsc_init(void);
int phy_teranetics_init(void);
int phy_ti_init(void);
int phy_vitesse_init(void);
int phy_xilinx_init(void);
int phy_mscc_init(void);

int board_phy_config(struct phy_device *phydev);
int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);

/**
 * phy_get_interface_by_name() - Look up a PHY interface name
 *
 * @str:	PHY interface name, e.g. "mii"
 * @return PHY_INTERFACE_MODE_... value, or -1 if not found
 */
int phy_get_interface_by_name(const char *str);

/**
 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
 * is RGMII (all variants)
 * @phydev: the phy_device struct
 */
static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
{
	return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
		phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
}

/**
 * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
 * is SGMII (all variants)
 * @phydev: the phy_device struct
 */
static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
{
	return phydev->interface >= PHY_INTERFACE_MODE_SGMII &&
		phydev->interface <= PHY_INTERFACE_MODE_QSGMII;
}

/* PHY UIDs for various PHYs that are referenced in external code */
#define PHY_UID_CS4340  0x13e51002
#define PHY_UID_TN2020	0x00a19410

#endif
Commit	Line	Data
5f184715 AF	1	/*
5f184715 AF	2	* Copyright 2011 Freescale Semiconductor, Inc.
b21f87a3	3	* Andy Fleming <[email protected]>
5f184715	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
5f184715 AF	6	*
	7	* This file pretty much stolen from Linux's mii.h/ethtool.h/phy.h
	8	*/
	9
	10	#ifndef _PHY_H
	11	#define _PHY_H
	12
	13	#include <linux/list.h>
	14	#include <linux/mii.h>
	15	#include <linux/ethtool.h>
	16	#include <linux/mdio.h>
	17
	18	#define PHY_MAX_ADDR 32
	19
ddcd1f30 SX	20	#define PHY_FLAG_BROKEN_RESET (1 << 0) /* soft reset not supported */
ddcd1f30 SX	21
4dae610b	22	#define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg \| \
5f184715 AF	23	SUPPORTED_TP \| \
	24	SUPPORTED_MII)
	25
4dae610b FF	26	#define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half \| \
	27	SUPPORTED_10baseT_Full)
	28
	29	#define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half \| \
	30	SUPPORTED_100baseT_Full)
	31
	32	#define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half \| \
5f184715 AF	33	SUPPORTED_1000baseT_Full)
5f184715 AF	34
4dae610b FF	35	#define PHY_BASIC_FEATURES (PHY_10BT_FEATURES \| \
	36	PHY_100BT_FEATURES \| \
	37	PHY_DEFAULT_FEATURES)
	38
	39	#define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES \| \
	40	PHY_1000BT_FEATURES)
	41
5f184715 AF	42	#define PHY_10G_FEATURES (PHY_GBIT_FEATURES \| \
	43	SUPPORTED_10000baseT_Full)
	44
4fb3f0c8	45	#ifndef PHY_ANEG_TIMEOUT
5f184715	46	#define PHY_ANEG_TIMEOUT 4000
4fb3f0c8	47	#endif
5f184715 AF	48
	49
	50	typedef enum {
	51	PHY_INTERFACE_MODE_MII,
	52	PHY_INTERFACE_MODE_GMII,
	53	PHY_INTERFACE_MODE_SGMII,
c35f8693	54	PHY_INTERFACE_MODE_SGMII_2500,
7794b1a7	55	PHY_INTERFACE_MODE_QSGMII,
5f184715 AF	56	PHY_INTERFACE_MODE_TBI,
	57	PHY_INTERFACE_MODE_RMII,
	58	PHY_INTERFACE_MODE_RGMII,
	59	PHY_INTERFACE_MODE_RGMII_ID,
	60	PHY_INTERFACE_MODE_RGMII_RXID,
	61	PHY_INTERFACE_MODE_RGMII_TXID,
	62	PHY_INTERFACE_MODE_RTBI,
	63	PHY_INTERFACE_MODE_XGMII,
c74c8e66 SG	64	PHY_INTERFACE_MODE_NONE, /* Must be last */
	65
	66	PHY_INTERFACE_MODE_COUNT,
5f184715 AF	67	} phy_interface_t;
	68
	69	static const char *phy_interface_strings[] = {
	70	[PHY_INTERFACE_MODE_MII] = "mii",
	71	[PHY_INTERFACE_MODE_GMII] = "gmii",
	72	[PHY_INTERFACE_MODE_SGMII] = "sgmii",
c35f8693	73	[PHY_INTERFACE_MODE_SGMII_2500] = "sgmii-2500",
7794b1a7	74	[PHY_INTERFACE_MODE_QSGMII] = "qsgmii",
5f184715 AF	75	[PHY_INTERFACE_MODE_TBI] = "tbi",
	76	[PHY_INTERFACE_MODE_RMII] = "rmii",
	77	[PHY_INTERFACE_MODE_RGMII] = "rgmii",
	78	[PHY_INTERFACE_MODE_RGMII_ID] = "rgmii-id",
	79	[PHY_INTERFACE_MODE_RGMII_RXID] = "rgmii-rxid",
	80	[PHY_INTERFACE_MODE_RGMII_TXID] = "rgmii-txid",
	81	[PHY_INTERFACE_MODE_RTBI] = "rtbi",
	82	[PHY_INTERFACE_MODE_XGMII] = "xgmii",
	83	[PHY_INTERFACE_MODE_NONE] = "",
	84	};
	85
	86	static inline const char *phy_string_for_interface(phy_interface_t i)
	87	{
	88	/* Default to unknown */
	89	if (i > PHY_INTERFACE_MODE_NONE)
	90	i = PHY_INTERFACE_MODE_NONE;
	91
	92	return phy_interface_strings[i];
	93	}
	94
	95
	96	struct phy_device;
	97
	98	#define MDIO_NAME_LEN 32
	99
	100	struct mii_dev {
	101	struct list_head link;
	102	char name[MDIO_NAME_LEN];
	103	void *priv;
	104	int (read)(struct mii_dev bus, int addr, int devad, int reg);
	105	int (write)(struct mii_dev bus, int addr, int devad, int reg,
	106	u16 val);
	107	int (reset)(struct mii_dev bus);
	108	struct phy_device *phymap[PHY_MAX_ADDR];
	109	u32 phy_mask;
	110	};
	111
	112	/* struct phy_driver: a structure which defines PHY behavior
	113	*
	114	* uid will contain a number which represents the PHY. During
	115	* startup, the driver will poll the PHY to find out what its
	116	* UID--as defined by registers 2 and 3--is. The 32-bit result
	117	* gotten from the PHY will be masked to
	118	* discard any bits which may change based on revision numbers
	119	* unimportant to functionality
	120	*
	121	*/
	122	struct phy_driver {
	123	char *name;
	124	unsigned int uid;
	125	unsigned int mask;
	126	unsigned int mmds;
	127
	128	u32 features;
	129
	130	/* Called to do any driver startup necessities */
	131	/* Will be called during phy_connect */
	132	int (probe)(struct phy_device phydev);
	133
	134	/* Called to configure the PHY, and modify the controller
	135	* based on the results. Should be called after phy_connect */
	136	int (config)(struct phy_device phydev);
	137
	138	/* Called when starting up the controller */
139	int (startup)(struct phy_device phydev);
140
141	/* Called when bringing down the controller */
142	int (shutdown)(struct phy_device phydev);
143
b71841b9 SB	144	int (readext)(struct phy_device phydev, int addr, int devad, int reg);
	145	int (writeext)(struct phy_device phydev, int addr, int devad, int reg,
	146	u16 val);
5f184715 AF	147	struct list_head list;
	148	};
	149
	150	struct phy_device {
	151	/* Information about the PHY type */
	152	/* And management functions */
	153	struct mii_dev *bus;
	154	struct phy_driver *drv;
	155	void *priv;
	156
c74c8e66 SG	157	#ifdef CONFIG_DM_ETH
	158	struct udevice *dev;
	159	#else
5f184715	160	struct eth_device *dev;
c74c8e66	161	#endif
5f184715 AF	162
	163	/* forced speed & duplex (no autoneg)
	164	* partner speed & duplex & pause (autoneg)
	165	*/
	166	int speed;
	167	int duplex;
	168
	169	/* The most recently read link state */
	170	int link;
	171	int port;
	172	phy_interface_t interface;
	173
	174	u32 advertising;
	175	u32 supported;
	176	u32 mmds;
	177
	178	int autoneg;
	179	int addr;
	180	int pause;
	181	int asym_pause;
	182	u32 phy_id;
	183	u32 flags;
	184	};
	185
f55a776c SX	186	struct fixed_link {
	187	int phy_id;
	188	int duplex;
	189	int link_speed;
	190	int pause;
	191	int asym_pause;
	192	};
	193
5f184715 AF	194	static inline int phy_read(struct phy_device *phydev, int devad, int regnum)
	195	{
	196	struct mii_dev *bus = phydev->bus;
	197
	198	return bus->read(bus, phydev->addr, devad, regnum);
	199	}
	200
	201	static inline int phy_write(struct phy_device *phydev, int devad, int regnum,
	202	u16 val)
	203	{
	204	struct mii_dev *bus = phydev->bus;
	205
	206	return bus->write(bus, phydev->addr, devad, regnum, val);
	207	}
	208
	209	#ifdef CONFIG_PHYLIB_10G
	210	extern struct phy_driver gen10g_driver;
	211
	212	/* For now, XGMII is the only 10G interface */
	213	static inline int is_10g_interface(phy_interface_t interface)
	214	{
	215	return interface == PHY_INTERFACE_MODE_XGMII;
	216	}
	217
	218	#endif
	219
	220	int phy_init(void);
	221	int phy_reset(struct phy_device *phydev);
1adb406b TK	222	struct phy_device phy_find_by_mask(struct mii_dev bus, unsigned phy_mask,
1adb406b TK	223	phy_interface_t interface);
c74c8e66 SG	224	#ifdef CONFIG_DM_ETH
	225	void phy_connect_dev(struct phy_device phydev, struct udevice dev);
	226	struct phy_device phy_connect(struct mii_dev bus, int addr,
	227	struct udevice *dev,
	228	phy_interface_t interface);
	229	#else
1adb406b	230	void phy_connect_dev(struct phy_device phydev, struct eth_device dev);
5f184715 AF	231	struct phy_device phy_connect(struct mii_dev bus, int addr,
	232	struct eth_device *dev,
	233	phy_interface_t interface);
c74c8e66	234	#endif
5f184715 AF	235	int phy_startup(struct phy_device *phydev);
	236	int phy_config(struct phy_device *phydev);
	237	int phy_shutdown(struct phy_device *phydev);
	238	int phy_register(struct phy_driver *drv);
b18acb0a	239	int phy_set_supported(struct phy_device *phydev, u32 max_speed);
5f184715	240	int genphy_config_aneg(struct phy_device *phydev);
8682aba7	241	int genphy_restart_aneg(struct phy_device *phydev);
5f184715	242	int genphy_update_link(struct phy_device *phydev);
e2043f5c	243	int genphy_parse_link(struct phy_device *phydev);
5f184715 AF	244	int genphy_config(struct phy_device *phydev);
	245	int genphy_startup(struct phy_device *phydev);
	246	int genphy_shutdown(struct phy_device *phydev);
	247	int gen10g_config(struct phy_device *phydev);
	248	int gen10g_startup(struct phy_device *phydev);
	249	int gen10g_shutdown(struct phy_device *phydev);
	250	int gen10g_discover_mmds(struct phy_device *phydev);
	251
24ae3961	252	int phy_mv88e61xx_init(void);
f7c38cf8	253	int phy_aquantia_init(void);
9082eeac AF	254	int phy_atheros_init(void);
9082eeac AF	255	int phy_broadcom_init(void);
9b18e519	256	int phy_cortina_init(void);
9082eeac	257	int phy_davicom_init(void);
f485c8a3	258	int phy_et1011c_init(void);
9082eeac AF	259	int phy_lxt_init(void);
	260	int phy_marvell_init(void);
	261	int phy_micrel_init(void);
	262	int phy_natsemi_init(void);
	263	int phy_realtek_init(void);
b6abf555	264	int phy_smsc_init(void);
9082eeac	265	int phy_teranetics_init(void);
721aed79	266	int phy_ti_init(void);
9082eeac	267	int phy_vitesse_init(void);
ed6fad3e	268	int phy_xilinx_init(void);
a5fd13ad	269	int phy_mscc_init(void);
a836626c	270
2fb63964	271	int board_phy_config(struct phy_device *phydev);
5707d5ff	272	int get_phy_id(struct mii_dev bus, int addr, int devad, u32 phy_id);
2fb63964	273
c74c8e66 SG	274	/**
	275	* phy_get_interface_by_name() - Look up a PHY interface name
	276	*
	277	* @str: PHY interface name, e.g. "mii"
	278	* @return PHY_INTERFACE_MODE_... value, or -1 if not found
	279	*/
	280	int phy_get_interface_by_name(const char *str);
	281
3ab72fe8 DM	282	/**
	283	* phy_interface_is_rgmii - Convenience function for testing if a PHY interface
	284	* is RGMII (all variants)
	285	* @phydev: the phy_device struct
	286	*/
	287	static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
	288	{
	289	return phydev->interface >= PHY_INTERFACE_MODE_RGMII &&
	290	phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID;
	291	}
	292
3c221af3 DM	293	/**
	294	* phy_interface_is_sgmii - Convenience function for testing if a PHY interface
	295	* is SGMII (all variants)
	296	* @phydev: the phy_device struct
	297	*/
	298	static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
	299	{
	300	return phydev->interface >= PHY_INTERFACE_MODE_SGMII &&
	301	phydev->interface <= PHY_INTERFACE_MODE_QSGMII;
	302	}
	303
a836626c	304	/* PHY UIDs for various PHYs that are referenced in external code */
9b18e519	305	#define PHY_UID_CS4340 0x13e51002
a836626c TT	306	#define PHY_UID_TN2020 0x00a19410
a836626c TT	307
5f184715	308	#endif