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