1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*****************************************************************************
3 * *
4 * File: cphy.h *
5 * $Revision: 1.7 $ *
6 * $Date: 2005/06/21 18:29:47 $ *
7 * Description: *
8 * part of the Chelsio 10Gb Ethernet Driver. *
9 * *
10 * *
11 * http://www.chelsio.com *
12 * *
13 * Copyright (c) 2003 - 2005 Chelsio Communications, Inc. *
14 * All rights reserved. *
15 * *
16 * Maintainers: maintainers@chelsio.com *
17 * *
18 * Authors: Dimitrios Michailidis <dm@chelsio.com> *
19 * Tina Yang <tainay@chelsio.com> *
20 * Felix Marti <felix@chelsio.com> *
21 * Scott Bardone <sbardone@chelsio.com> *
22 * Kurt Ottaway <kottaway@chelsio.com> *
23 * Frank DiMambro <frank@chelsio.com> *
24 * *
25 * History: *
26 * *
27 ****************************************************************************/
28
29 #ifndef _CXGB_CPHY_H_
30 #define _CXGB_CPHY_H_
31
32 #include "common.h"
33
34 struct mdio_ops {
35 void (*init)(adapter_t *adapter, const struct board_info *bi);
36 int (*read)(struct net_device *dev, int phy_addr, int mmd_addr,
37 u16 reg_addr);
38 int (*write)(struct net_device *dev, int phy_addr, int mmd_addr,
39 u16 reg_addr, u16 val);
40 unsigned mode_support;
41 };
42
43 /* PHY interrupt types */
44 enum {
45 cphy_cause_link_change = 0x1,
46 cphy_cause_error = 0x2,
47 cphy_cause_fifo_error = 0x3
48 };
49
50 enum {
51 PHY_LINK_UP = 0x1,
52 PHY_AUTONEG_RDY = 0x2,
53 PHY_AUTONEG_EN = 0x4
54 };
55
56 struct cphy;
57
58 /* PHY operations */
59 struct cphy_ops {
60 void (*destroy)(struct cphy *);
61 int (*reset)(struct cphy *, int wait);
62
63 int (*interrupt_enable)(struct cphy *);
64 int (*interrupt_disable)(struct cphy *);
65 int (*interrupt_clear)(struct cphy *);
66 int (*interrupt_handler)(struct cphy *);
67
68 int (*autoneg_enable)(struct cphy *);
69 int (*autoneg_disable)(struct cphy *);
70 int (*autoneg_restart)(struct cphy *);
71
72 int (*advertise)(struct cphy *phy, unsigned int advertise_map);
73 int (*set_loopback)(struct cphy *, int on);
74 int (*set_speed_duplex)(struct cphy *phy, int speed, int duplex);
75 int (*get_link_status)(struct cphy *phy, int *link_ok, int *speed,
76 int *duplex, int *fc);
77
78 u32 mmds;
79 };
80
81 /* A PHY instance */
82 struct cphy {
83 int state; /* Link status state machine */
84 adapter_t *adapter; /* associated adapter */
85
86 struct delayed_work phy_update;
87
88 u16 bmsr;
89 int count;
90 int act_count;
91 int act_on;
92
93 u32 elmer_gpo;
94
95 const struct cphy_ops *ops; /* PHY operations */
96 struct mdio_if_info mdio;
97 struct cphy_instance *instance;
98 };
99
100 /* Convenience MDIO read/write wrappers */
cphy_mdio_read(struct cphy * cphy,int mmd,int reg,unsigned int * valp)101 static inline int cphy_mdio_read(struct cphy *cphy, int mmd, int reg,
102 unsigned int *valp)
103 {
104 int rc = cphy->mdio.mdio_read(cphy->mdio.dev, cphy->mdio.prtad, mmd,
105 reg);
106 *valp = (rc >= 0) ? rc : -1;
107 return (rc >= 0) ? 0 : rc;
108 }
109
cphy_mdio_write(struct cphy * cphy,int mmd,int reg,unsigned int val)110 static inline int cphy_mdio_write(struct cphy *cphy, int mmd, int reg,
111 unsigned int val)
112 {
113 return cphy->mdio.mdio_write(cphy->mdio.dev, cphy->mdio.prtad, mmd,
114 reg, val);
115 }
116
simple_mdio_read(struct cphy * cphy,int reg,unsigned int * valp)117 static inline int simple_mdio_read(struct cphy *cphy, int reg,
118 unsigned int *valp)
119 {
120 return cphy_mdio_read(cphy, MDIO_DEVAD_NONE, reg, valp);
121 }
122
simple_mdio_write(struct cphy * cphy,int reg,unsigned int val)123 static inline int simple_mdio_write(struct cphy *cphy, int reg,
124 unsigned int val)
125 {
126 return cphy_mdio_write(cphy, MDIO_DEVAD_NONE, reg, val);
127 }
128
129 /* Convenience initializer */
cphy_init(struct cphy * phy,struct net_device * dev,int phy_addr,const struct cphy_ops * phy_ops,const struct mdio_ops * mdio_ops)130 static inline void cphy_init(struct cphy *phy, struct net_device *dev,
131 int phy_addr, const struct cphy_ops *phy_ops,
132 const struct mdio_ops *mdio_ops)
133 {
134 struct adapter *adapter = netdev_priv(dev);
135 phy->adapter = adapter;
136 phy->ops = phy_ops;
137 if (mdio_ops) {
138 phy->mdio.prtad = phy_addr;
139 phy->mdio.mmds = phy_ops->mmds;
140 phy->mdio.mode_support = mdio_ops->mode_support;
141 phy->mdio.mdio_read = mdio_ops->read;
142 phy->mdio.mdio_write = mdio_ops->write;
143 }
144 phy->mdio.dev = dev;
145 }
146
147 /* Operations of the PHY-instance factory */
148 struct gphy {
149 /* Construct a PHY instance with the given PHY address */
150 struct cphy *(*create)(struct net_device *dev, int phy_addr,
151 const struct mdio_ops *mdio_ops);
152
153 /*
154 * Reset the PHY chip. This resets the whole PHY chip, not individual
155 * ports.
156 */
157 int (*reset)(adapter_t *adapter);
158 };
159
160 extern const struct gphy t1_my3126_ops;
161 extern const struct gphy t1_mv88e1xxx_ops;
162 extern const struct gphy t1_vsc8244_ops;
163 extern const struct gphy t1_mv88x201x_ops;
164
165 #endif /* _CXGB_CPHY_H_ */
166