[u-boot.git] / include / miiphy.h

/* SPDX-License-Identifier: GPL-2.0 OR IBM-pibs */
/*
 * Additions (C) Copyright 2009 Industrie Dial Face S.p.A.
 */
/*----------------------------------------------------------------------------+
|
|  File Name:	miiphy.h
|
|  Function:	Include file defining PHY registers.
|
|  Author:	Mark Wisner
|
+----------------------------------------------------------------------------*/
#ifndef _miiphy_h_
#define _miiphy_h_

#include <linux/mii.h>
#include <linux/list.h>
#include <net.h>
#include <phy.h>

int miiphy_read(const char *devname, unsigned char addr, unsigned char reg,
		 unsigned short *value);
int miiphy_write(const char *devname, unsigned char addr, unsigned char reg,
		  unsigned short value);
int miiphy_info(const char *devname, unsigned char addr, unsigned int *oui,
		 unsigned char *model, unsigned char *rev);
int miiphy_reset(const char *devname, unsigned char addr);
int miiphy_speed(const char *devname, unsigned char addr);
int miiphy_duplex(const char *devname, unsigned char addr);
int miiphy_is_1000base_x(const char *devname, unsigned char addr);
#ifdef CONFIG_SYS_FAULT_ECHO_LINK_DOWN
int miiphy_link(const char *devname, unsigned char addr);
#endif

void miiphy_init(void);

int miiphy_set_current_dev(const char *devname);
const char *miiphy_get_current_dev(void);
struct mii_dev *mdio_get_current_dev(void);
struct list_head *mdio_get_list_head(void);
struct mii_dev *miiphy_get_dev_by_name(const char *devname);
struct phy_device *mdio_phydev_for_ethname(const char *devname);

void miiphy_listdev(void);

struct mii_dev *mdio_alloc(void);
void mdio_free(struct mii_dev *bus);
int mdio_register(struct mii_dev *bus);

/**
 * mdio_register_seq - Register mdio bus with sequence number
 * @bus: mii device structure
 * @seq: sequence number
 *
 * Return: 0 if success, negative value if error
 */
int mdio_register_seq(struct mii_dev *bus, int seq);
int mdio_unregister(struct mii_dev *bus);
void mdio_list_devices(void);

#ifdef CONFIG_BITBANGMII

#define BB_MII_DEVNAME	"bb_miiphy"

struct bb_miiphy_bus {
	char name[MDIO_NAME_LEN];
	int (*init)(struct bb_miiphy_bus *bus);
	int (*mdio_active)(struct bb_miiphy_bus *bus);
	int (*mdio_tristate)(struct bb_miiphy_bus *bus);
	int (*set_mdio)(struct bb_miiphy_bus *bus, int v);
	int (*get_mdio)(struct bb_miiphy_bus *bus, int *v);
	int (*set_mdc)(struct bb_miiphy_bus *bus, int v);
	int (*delay)(struct bb_miiphy_bus *bus);
	void *priv;
};

extern struct bb_miiphy_bus bb_miiphy_buses[];
extern int bb_miiphy_buses_num;

/**
 * bb_miiphy_init() - Initialize bit-banged MII bus driver
 *
 * It is called during the generic post-relocation init sequence.
 *
 * Return: 0 if OK
 */
int bb_miiphy_init(void);

int bb_miiphy_read(struct mii_dev *miidev, int addr, int devad, int reg);
int bb_miiphy_write(struct mii_dev *miidev, int addr, int devad, int reg,
		    u16 value);
#endif

/* phy seed setup */
#define AUTO			99
#define _1000BASET		1000
#define _100BASET		100
#define _10BASET		10
#define HALF			22
#define FULL			44

/* phy register offsets */
#define MII_MIPSCR		0x11

/* MII_LPA */
#define PHY_ANLPAR_PSB_802_3	0x0001
#define PHY_ANLPAR_PSB_802_9	0x0002

/* MII_CTRL1000 masks */
#define PHY_1000BTCR_1000FD	0x0200
#define PHY_1000BTCR_1000HD	0x0100

/* MII_STAT1000 masks */
#define PHY_1000BTSR_MSCF	0x8000
#define PHY_1000BTSR_MSCR	0x4000
#define PHY_1000BTSR_LRS	0x2000
#define PHY_1000BTSR_RRS	0x1000
#define PHY_1000BTSR_1000FD	0x0800
#define PHY_1000BTSR_1000HD	0x0400

/* phy EXSR */
#define ESTATUS_1000XF		0x8000
#define ESTATUS_1000XH		0x4000

/**
 * struct mdio_perdev_priv - Per-device class data for MDIO DM
 *
 * @mii_bus: Supporting MII legacy bus
 */
struct mdio_perdev_priv {
	struct mii_dev *mii_bus;
};

/**
 * struct mdio_ops - MDIO bus operations
 *
 * @read: Read from a PHY register
 * @write: Write to a PHY register
 * @reset: Reset the MDIO bus, NULL if not supported
 */
struct mdio_ops {
	int (*read)(struct udevice *mdio_dev, int addr, int devad, int reg);
	int (*write)(struct udevice *mdio_dev, int addr, int devad, int reg,
		     u16 val);
	int (*reset)(struct udevice *mdio_dev);
};

#define mdio_get_ops(dev) ((struct mdio_ops *)(dev)->driver->ops)

/**
 * dm_mdio_probe_devices - Call probe on all MII devices, currently used for
 * MDIO console commands.
 */
void dm_mdio_probe_devices(void);

/**
 * dm_mdio_read - Wrapper over .read() operation for DM MDIO
 *
 * @mdiodev: mdio device
 * @addr: PHY address on MDIO bus
 * @devad: device address on PHY if C45; should be MDIO_DEVAD_NONE if C22
 * @reg: register address
 * Return: register value if non-negative, -error code otherwise
 */
int dm_mdio_read(struct udevice *mdio_dev, int addr, int devad, int reg);

/**
 * dm_mdio_write - Wrapper over .write() operation for DM MDIO
 *
 * @mdiodev: mdio device
 * @addr: PHY address on MDIO bus
 * @devad: device address on PHY if C45; should be MDIO_DEVAD_NONE if C22
 * @reg: register address
 * @val: value to write
 * Return: 0 on success, -error code otherwise
 */
int dm_mdio_write(struct udevice *mdio_dev, int addr, int devad, int reg, u16 val);

/**
 * dm_mdio_reset - Wrapper over .reset() operation for DM MDIO
 *
 * @mdiodev: mdio device
 * Return: 0 on success, -error code otherwise
 */
int dm_mdio_reset(struct udevice *mdio_dev);

/**
 * dm_phy_find_by_ofnode - Find PHY device by ofnode
 *
 * @phynode: PHY's ofnode
 *
 * Return: pointer to phy_device, or NULL on error
 */
struct phy_device *dm_phy_find_by_ofnode(ofnode phynode);

/**
 * dm_mdio_phy_connect - Wrapper over phy_connect for DM MDIO
 *
 * @mdiodev: mdio device the PHY is accesible on
 * @phyaddr: PHY address on MDIO bus
 * @ethdev: ethernet device to connect to the PHY
 * @interface: MAC-PHY protocol
 *
 * Return: pointer to phy_device, or 0 on error
 */
struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr,
				       struct udevice *ethdev,
				       phy_interface_t interface);

/**
 * dm_eth_phy_connect - Connect an Eth device to a PHY based on device tree
 *
 * Picks up the DT phy-handle and phy-mode from ethernet device node and
 * connects the ethernet device to the linked PHY.
 *
 * @ethdev: ethernet device
 *
 * Return: pointer to phy_device, or 0 on error
 */
struct phy_device *dm_eth_phy_connect(struct udevice *ethdev);

/* indicates none of the child buses is selected */
#define MDIO_MUX_SELECT_NONE	-1

/**
 * struct mdio_mux_ops - MDIO MUX operations
 *
 * @select: Selects a child bus
 * @deselect: Clean up selection.  Optional, can be NULL
 */
struct mdio_mux_ops {
	int (*select)(struct udevice *mux, int cur, int sel);
	int (*deselect)(struct udevice *mux, int sel);
};

#define mdio_mux_get_ops(dev) ((struct mdio_mux_ops *)(dev)->driver->ops)

#endif
Commit	Line	Data
4549e789	1	/* SPDX-License-Identifier: GPL-2.0 OR IBM-pibs */
46263f2d	2	/*
46263f2d WD	3	* Additions (C) Copyright 2009 Industrie Dial Face S.p.A.
46263f2d WD	4	*/
214ec6bb WD	5	/*----------------------------------------------------------------------------+
214ec6bb WD	6	\|
65bd0e28	7	\| File Name: miiphy.h
214ec6bb	8	\|
65bd0e28	9	\| Function: Include file defining PHY registers.
214ec6bb	10	\|
65bd0e28	11	\| Author: Mark Wisner
214ec6bb	12	\|
214ec6bb WD	13	+----------------------------------------------------------------------------*/
	14	#ifndef _miiphy_h_
	15	#define _miiphy_h_
	16
8ef583a0	17	#include <linux/mii.h>
5f184715	18	#include <linux/list.h>
63ff004c	19	#include <net.h>
5f184715 AF	20	#include <phy.h>
5f184715 AF	21
f915c931	22	int miiphy_read(const char *devname, unsigned char addr, unsigned char reg,
298035df	23	unsigned short *value);
f915c931	24	int miiphy_write(const char *devname, unsigned char addr, unsigned char reg,
298035df	25	unsigned short value);
16a53238	26	int miiphy_info(const char devname, unsigned char addr, unsigned int oui,
298035df	27	unsigned char model, unsigned char rev);
16a53238 AF	28	int miiphy_reset(const char *devname, unsigned char addr);
	29	int miiphy_speed(const char *devname, unsigned char addr);
	30	int miiphy_duplex(const char *devname, unsigned char addr);
	31	int miiphy_is_1000base_x(const char *devname, unsigned char addr);
6d0f6bcf	32	#ifdef CONFIG_SYS_FAULT_ECHO_LINK_DOWN
16a53238	33	int miiphy_link(const char *devname, unsigned char addr);
fc3e2165	34	#endif
214ec6bb	35
16a53238	36	void miiphy_init(void);
d9785c14	37
16a53238 AF	38	int miiphy_set_current_dev(const char *devname);
16a53238 AF	39	const char *miiphy_get_current_dev(void);
5f184715	40	struct mii_dev *mdio_get_current_dev(void);
9215bb1f	41	struct list_head *mdio_get_list_head(void);
5f184715 AF	42	struct mii_dev miiphy_get_dev_by_name(const char devname);
5f184715 AF	43	struct phy_device mdio_phydev_for_ethname(const char devname);
63ff004c	44
16a53238	45	void miiphy_listdev(void);
63ff004c	46
5f184715	47	struct mii_dev *mdio_alloc(void);
cb6baca7	48	void mdio_free(struct mii_dev *bus);
5f184715	49	int mdio_register(struct mii_dev *bus);
79e2a6a0 MS	50
	51	/**
	52	* mdio_register_seq - Register mdio bus with sequence number
	53	* @bus: mii device structure
	54	* @seq: sequence number
	55	*
	56	* Return: 0 if success, negative value if error
	57	*/
	58	int mdio_register_seq(struct mii_dev *bus, int seq);
cb6baca7	59	int mdio_unregister(struct mii_dev *bus);
5f184715 AF	60	void mdio_list_devices(void);
5f184715 AF	61
4ba31ab3 LCM	62	#ifdef CONFIG_BITBANGMII
	63
	64	#define BB_MII_DEVNAME "bb_miiphy"
	65
	66	struct bb_miiphy_bus {
d624a3e9	67	char name[MDIO_NAME_LEN];
4ba31ab3 LCM	68	int (init)(struct bb_miiphy_bus bus);
	69	int (mdio_active)(struct bb_miiphy_bus bus);
	70	int (mdio_tristate)(struct bb_miiphy_bus bus);
	71	int (set_mdio)(struct bb_miiphy_bus bus, int v);
	72	int (get_mdio)(struct bb_miiphy_bus bus, int *v);
	73	int (set_mdc)(struct bb_miiphy_bus bus, int v);
	74	int (delay)(struct bb_miiphy_bus bus);
4ba31ab3	75	void *priv;
4ba31ab3 LCM	76	};
	77
	78	extern struct bb_miiphy_bus bb_miiphy_buses[];
	79	extern int bb_miiphy_buses_num;
63ff004c	80
c65abc70 OP	81	/**
	82	* bb_miiphy_init() - Initialize bit-banged MII bus driver
	83	*
	84	* It is called during the generic post-relocation init sequence.
	85	*
	86	* Return: 0 if OK
	87	*/
	88	int bb_miiphy_init(void);
	89
dfcc496e JH	90	int bb_miiphy_read(struct mii_dev *miidev, int addr, int devad, int reg);
	91	int bb_miiphy_write(struct mii_dev *miidev, int addr, int devad, int reg,
	92	u16 value);
4ba31ab3	93	#endif
214ec6bb WD	94
214ec6bb WD	95	/* phy seed setup */
65bd0e28	96	#define AUTO 99
298035df	97	#define _1000BASET 1000
65bd0e28 WD	98	#define _100BASET 100
	99	#define _10BASET 10
	100	#define HALF 22
	101	#define FULL 44
214ec6bb WD	102
214ec6bb WD	103	/* phy register offsets */
8ef583a0 MF	104	#define MII_MIPSCR 0x11
	105
	106	/* MII_LPA */
298035df LJ	107	#define PHY_ANLPAR_PSB_802_3 0x0001
	108	#define PHY_ANLPAR_PSB_802_9 0x0002
	109
8ef583a0	110	/* MII_CTRL1000 masks */
71bc6e64 LJ	111	#define PHY_1000BTCR_1000FD 0x0200
	112	#define PHY_1000BTCR_1000HD 0x0100
	113
8ef583a0	114	/* MII_STAT1000 masks */
298035df LJ	115	#define PHY_1000BTSR_MSCF 0x8000
	116	#define PHY_1000BTSR_MSCR 0x4000
	117	#define PHY_1000BTSR_LRS 0x2000
	118	#define PHY_1000BTSR_RRS 0x1000
	119	#define PHY_1000BTSR_1000FD 0x0800
	120	#define PHY_1000BTSR_1000HD 0x0400
855a496f	121
71bc6e64	122	/* phy EXSR */
8ef583a0 MF	123	#define ESTATUS_1000XF 0x8000
8ef583a0 MF	124	#define ESTATUS_1000XH 0x4000
71bc6e64	125
c3452b50 AM	126	/**
	127	* struct mdio_perdev_priv - Per-device class data for MDIO DM
	128	*
	129	* @mii_bus: Supporting MII legacy bus
	130	*/
	131	struct mdio_perdev_priv {
	132	struct mii_dev *mii_bus;
	133	};
	134
	135	/**
	136	* struct mdio_ops - MDIO bus operations
	137	*
	138	* @read: Read from a PHY register
	139	* @write: Write to a PHY register
	140	* @reset: Reset the MDIO bus, NULL if not supported
	141	*/
	142	struct mdio_ops {
	143	int (read)(struct udevice mdio_dev, int addr, int devad, int reg);
	144	int (write)(struct udevice mdio_dev, int addr, int devad, int reg,
	145	u16 val);
	146	int (reset)(struct udevice mdio_dev);
	147	};
	148
	149	#define mdio_get_ops(dev) ((struct mdio_ops *)(dev)->driver->ops)
	150
	151	/**
	152	* dm_mdio_probe_devices - Call probe on all MII devices, currently used for
	153	* MDIO console commands.
	154	*/
	155	void dm_mdio_probe_devices(void);
	156
351bfa6e MB	157	/**
	158	* dm_mdio_read - Wrapper over .read() operation for DM MDIO
	159	*
	160	* @mdiodev: mdio device
	161	* @addr: PHY address on MDIO bus
	162	* @devad: device address on PHY if C45; should be MDIO_DEVAD_NONE if C22
	163	* @reg: register address
	164	* Return: register value if non-negative, -error code otherwise
	165	*/
	166	int dm_mdio_read(struct udevice *mdio_dev, int addr, int devad, int reg);
	167
	168	/**
	169	* dm_mdio_write - Wrapper over .write() operation for DM MDIO
	170	*
	171	* @mdiodev: mdio device
	172	* @addr: PHY address on MDIO bus
	173	* @devad: device address on PHY if C45; should be MDIO_DEVAD_NONE if C22
	174	* @reg: register address
	175	* @val: value to write
	176	* Return: 0 on success, -error code otherwise
	177	*/
	178	int dm_mdio_write(struct udevice *mdio_dev, int addr, int devad, int reg, u16 val);
	179
	180	/**
	181	* dm_mdio_reset - Wrapper over .reset() operation for DM MDIO
	182	*
	183	* @mdiodev: mdio device
	184	* Return: 0 on success, -error code otherwise
	185	*/
	186	int dm_mdio_reset(struct udevice *mdio_dev);
	187
00b1bad9 MB	188	/**
	189	* dm_phy_find_by_ofnode - Find PHY device by ofnode
	190	*
	191	* @phynode: PHY's ofnode
	192	*
	193	* Return: pointer to phy_device, or NULL on error
	194	*/
	195	struct phy_device *dm_phy_find_by_ofnode(ofnode phynode);
	196
c3452b50 AM	197	/**
	198	* dm_mdio_phy_connect - Wrapper over phy_connect for DM MDIO
	199	*
a5d32c37 AM	200	* @mdiodev: mdio device the PHY is accesible on
a5d32c37 AM	201	* @phyaddr: PHY address on MDIO bus
c3452b50 AM	202	* @ethdev: ethernet device to connect to the PHY
	203	* @interface: MAC-PHY protocol
	204	*
185f812c	205	* Return: pointer to phy_device, or 0 on error
c3452b50	206	*/
a5d32c37	207	struct phy_device dm_mdio_phy_connect(struct udevice mdiodev, int phyaddr,
c3452b50 AM	208	struct udevice *ethdev,
	209	phy_interface_t interface);
	210
2f624559 AM	211	/**
	212	* dm_eth_phy_connect - Connect an Eth device to a PHY based on device tree
	213	*
	214	* Picks up the DT phy-handle and phy-mode from ethernet device node and
	215	* connects the ethernet device to the linked PHY.
	216	*
	217	* @ethdev: ethernet device
	218	*
185f812c	219	* Return: pointer to phy_device, or 0 on error
2f624559 AM	220	*/
	221	struct phy_device dm_eth_phy_connect(struct udevice ethdev);
	222
8880edba AM	223	/* indicates none of the child buses is selected */
	224	#define MDIO_MUX_SELECT_NONE -1
	225
	226	/**
	227	* struct mdio_mux_ops - MDIO MUX operations
	228	*
	229	* @select: Selects a child bus
	230	* @deselect: Clean up selection. Optional, can be NULL
	231	*/
	232	struct mdio_mux_ops {
	233	int (select)(struct udevice mux, int cur, int sel);
	234	int (deselect)(struct udevice mux, int sel);
	235	};
	236
	237	#define mdio_mux_get_ops(dev) ((struct mdio_mux_ops *)(dev)->driver->ops)
	238
	239	#endif