kernel: b53: drop support for old location of bcm47xx_nvram.h
[openwrt/openwrt.git] / target / linux / generic / files / drivers / net / phy / b53 / b53_priv.h
1 /*
2 * B53 common definitions
3 *
4 * Copyright (C) 2011-2013 Jonas Gorski <jogo@openwrt.org>
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19 #ifndef __B53_PRIV_H
20 #define __B53_PRIV_H
21
22 #include <linux/kernel.h>
23 #include <linux/mutex.h>
24 #include <linux/switch.h>
25
26 struct b53_device;
27
28 struct b53_io_ops {
29 int (*read8)(struct b53_device *dev, u8 page, u8 reg, u8 *value);
30 int (*read16)(struct b53_device *dev, u8 page, u8 reg, u16 *value);
31 int (*read32)(struct b53_device *dev, u8 page, u8 reg, u32 *value);
32 int (*read48)(struct b53_device *dev, u8 page, u8 reg, u64 *value);
33 int (*read64)(struct b53_device *dev, u8 page, u8 reg, u64 *value);
34 int (*write8)(struct b53_device *dev, u8 page, u8 reg, u8 value);
35 int (*write16)(struct b53_device *dev, u8 page, u8 reg, u16 value);
36 int (*write32)(struct b53_device *dev, u8 page, u8 reg, u32 value);
37 int (*write48)(struct b53_device *dev, u8 page, u8 reg, u64 value);
38 int (*write64)(struct b53_device *dev, u8 page, u8 reg, u64 value);
39 int (*phy_read16)(struct b53_device *dev, int addr, u8 reg, u16 *value);
40 int (*phy_write16)(struct b53_device *dev, int addr, u8 reg, u16 value);
41 };
42
43 enum {
44 BCM5325_DEVICE_ID = 0x25,
45 BCM5365_DEVICE_ID = 0x65,
46 BCM5395_DEVICE_ID = 0x95,
47 BCM5397_DEVICE_ID = 0x97,
48 BCM5398_DEVICE_ID = 0x98,
49 BCM53115_DEVICE_ID = 0x53115,
50 BCM53125_DEVICE_ID = 0x53125,
51 BCM53128_DEVICE_ID = 0x53128,
52 BCM63XX_DEVICE_ID = 0x6300,
53 BCM53010_DEVICE_ID = 0x53010,
54 BCM53011_DEVICE_ID = 0x53011,
55 BCM53012_DEVICE_ID = 0x53012,
56 BCM53018_DEVICE_ID = 0x53018,
57 BCM53019_DEVICE_ID = 0x53019,
58 };
59
60 #define B53_N_PORTS 9
61 #define B53_N_PORTS_25 6
62
63 struct b53_vlan {
64 unsigned int members:B53_N_PORTS;
65 unsigned int untag:B53_N_PORTS;
66 };
67
68 struct b53_port {
69 unsigned int pvid:12;
70 };
71
72 struct b53_device {
73 struct switch_dev sw_dev;
74 struct b53_platform_data *pdata;
75
76 struct mutex reg_mutex;
77 const struct b53_io_ops *ops;
78
79 /* chip specific data */
80 u32 chip_id;
81 u8 core_rev;
82 u8 vta_regs[3];
83 u8 duplex_reg;
84 u8 jumbo_pm_reg;
85 u8 jumbo_size_reg;
86 int reset_gpio;
87
88 /* used ports mask */
89 u16 enabled_ports;
90
91 /* connect specific data */
92 u8 current_page;
93 struct device *dev;
94 void *priv;
95
96 /* run time configuration */
97 unsigned enable_vlan:1;
98 unsigned enable_jumbo:1;
99 unsigned allow_vid_4095:1;
100
101 struct b53_port *ports;
102 struct b53_vlan *vlans;
103
104 char *buf;
105 };
106
107 #define b53_for_each_port(dev, i) \
108 for (i = 0; i < B53_N_PORTS; i++) \
109 if (dev->enabled_ports & BIT(i))
110
111
112
113 static inline int is5325(struct b53_device *dev)
114 {
115 return dev->chip_id == BCM5325_DEVICE_ID;
116 }
117
118 static inline int is5365(struct b53_device *dev)
119 {
120 #ifdef CONFIG_BCM47XX
121 return dev->chip_id == BCM5365_DEVICE_ID;
122 #else
123 return 0;
124 #endif
125 }
126
127 static inline int is5397_98(struct b53_device *dev)
128 {
129 return dev->chip_id == BCM5397_DEVICE_ID ||
130 dev->chip_id == BCM5398_DEVICE_ID;
131 }
132
133 static inline int is539x(struct b53_device *dev)
134 {
135 return dev->chip_id == BCM5395_DEVICE_ID ||
136 dev->chip_id == BCM5397_DEVICE_ID ||
137 dev->chip_id == BCM5398_DEVICE_ID;
138 }
139
140 static inline int is531x5(struct b53_device *dev)
141 {
142 return dev->chip_id == BCM53115_DEVICE_ID ||
143 dev->chip_id == BCM53125_DEVICE_ID ||
144 dev->chip_id == BCM53128_DEVICE_ID;
145 }
146
147 static inline int is63xx(struct b53_device *dev)
148 {
149 #ifdef CONFIG_BCM63XX
150 return dev->chip_id == BCM63XX_DEVICE_ID;
151 #else
152 return 0;
153 #endif
154 }
155
156 static inline int is5301x(struct b53_device *dev)
157 {
158 return dev->chip_id == BCM53010_DEVICE_ID ||
159 dev->chip_id == BCM53011_DEVICE_ID ||
160 dev->chip_id == BCM53012_DEVICE_ID ||
161 dev->chip_id == BCM53018_DEVICE_ID ||
162 dev->chip_id == BCM53019_DEVICE_ID;
163 }
164
165 #define B53_CPU_PORT_25 5
166 #define B53_CPU_PORT 8
167
168 static inline int is_cpu_port(struct b53_device *dev, int port)
169 {
170 return dev->sw_dev.cpu_port == port;
171 }
172
173 static inline int is_imp_port(struct b53_device *dev, int port)
174 {
175 if (is5325(dev) || is5365(dev))
176 return port == B53_CPU_PORT_25;
177 else
178 return port == B53_CPU_PORT;
179 }
180
181 static inline struct b53_device *sw_to_b53(struct switch_dev *sw)
182 {
183 return container_of(sw, struct b53_device, sw_dev);
184 }
185
186 struct b53_device *b53_switch_alloc(struct device *base, struct b53_io_ops *ops,
187 void *priv);
188
189 int b53_switch_detect(struct b53_device *dev);
190
191 int b53_switch_register(struct b53_device *dev);
192
193 static inline void b53_switch_remove(struct b53_device *dev)
194 {
195 unregister_switch(&dev->sw_dev);
196 }
197
198 static inline int b53_read8(struct b53_device *dev, u8 page, u8 reg, u8 *val)
199 {
200 int ret;
201
202 mutex_lock(&dev->reg_mutex);
203 ret = dev->ops->read8(dev, page, reg, val);
204 mutex_unlock(&dev->reg_mutex);
205
206 return ret;
207 }
208
209 static inline int b53_read16(struct b53_device *dev, u8 page, u8 reg, u16 *val)
210 {
211 int ret;
212
213 mutex_lock(&dev->reg_mutex);
214 ret = dev->ops->read16(dev, page, reg, val);
215 mutex_unlock(&dev->reg_mutex);
216
217 return ret;
218 }
219
220 static inline int b53_read32(struct b53_device *dev, u8 page, u8 reg, u32 *val)
221 {
222 int ret;
223
224 mutex_lock(&dev->reg_mutex);
225 ret = dev->ops->read32(dev, page, reg, val);
226 mutex_unlock(&dev->reg_mutex);
227
228 return ret;
229 }
230
231 static inline int b53_read48(struct b53_device *dev, u8 page, u8 reg, u64 *val)
232 {
233 int ret;
234
235 mutex_lock(&dev->reg_mutex);
236 ret = dev->ops->read48(dev, page, reg, val);
237 mutex_unlock(&dev->reg_mutex);
238
239 return ret;
240 }
241
242 static inline int b53_read64(struct b53_device *dev, u8 page, u8 reg, u64 *val)
243 {
244 int ret;
245
246 mutex_lock(&dev->reg_mutex);
247 ret = dev->ops->read64(dev, page, reg, val);
248 mutex_unlock(&dev->reg_mutex);
249
250 return ret;
251 }
252
253 static inline int b53_write8(struct b53_device *dev, u8 page, u8 reg, u8 value)
254 {
255 int ret;
256
257 mutex_lock(&dev->reg_mutex);
258 ret = dev->ops->write8(dev, page, reg, value);
259 mutex_unlock(&dev->reg_mutex);
260
261 return ret;
262 }
263
264 static inline int b53_write16(struct b53_device *dev, u8 page, u8 reg,
265 u16 value)
266 {
267 int ret;
268
269 mutex_lock(&dev->reg_mutex);
270 ret = dev->ops->write16(dev, page, reg, value);
271 mutex_unlock(&dev->reg_mutex);
272
273 return ret;
274 }
275
276 static inline int b53_write32(struct b53_device *dev, u8 page, u8 reg,
277 u32 value)
278 {
279 int ret;
280
281 mutex_lock(&dev->reg_mutex);
282 ret = dev->ops->write32(dev, page, reg, value);
283 mutex_unlock(&dev->reg_mutex);
284
285 return ret;
286 }
287
288 static inline int b53_write48(struct b53_device *dev, u8 page, u8 reg,
289 u64 value)
290 {
291 int ret;
292
293 mutex_lock(&dev->reg_mutex);
294 ret = dev->ops->write48(dev, page, reg, value);
295 mutex_unlock(&dev->reg_mutex);
296
297 return ret;
298 }
299
300 static inline int b53_write64(struct b53_device *dev, u8 page, u8 reg,
301 u64 value)
302 {
303 int ret;
304
305 mutex_lock(&dev->reg_mutex);
306 ret = dev->ops->write64(dev, page, reg, value);
307 mutex_unlock(&dev->reg_mutex);
308
309 return ret;
310 }
311
312 #ifdef CONFIG_BCM47XX
313 #include <bcm47xx_board.h>
314
315 #include <linux/version.h>
316 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 1, 0))
317 #include <linux/bcm47xx_nvram.h>
318 #endif
319 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
320 {
321 enum bcm47xx_board board = bcm47xx_board_get();
322
323 switch (board) {
324 case BCM47XX_BOARD_LINKSYS_WRT300NV11:
325 case BCM47XX_BOARD_LINKSYS_WRT310NV1:
326 return 8;
327 default:
328 return bcm47xx_nvram_gpio_pin("robo_reset");
329 }
330 }
331 #else
332 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
333 {
334 return -ENOENT;
335 }
336 #endif
337 #endif