53da4064072b7829e4dd285a13513a6c64480f41
[lede.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 };
40
41 enum {
42         BCM5325_DEVICE_ID = 0x25,
43         BCM5365_DEVICE_ID = 0x65,
44         BCM5395_DEVICE_ID = 0x95,
45         BCM5397_DEVICE_ID = 0x97,
46         BCM5398_DEVICE_ID = 0x98,
47         BCM53115_DEVICE_ID = 0x53115,
48         BCM53125_DEVICE_ID = 0x53125,
49         BCM63XX_DEVICE_ID = 0x6300,
50 };
51
52 #define B53_N_PORTS     9
53 #define B53_N_PORTS_25  6
54
55 struct b53_vlan {
56         unsigned int    members:B53_N_PORTS;
57         unsigned int    untag:B53_N_PORTS;
58 };
59
60 struct b53_port {
61         unsigned int    pvid:12;
62 };
63
64 struct b53_device {
65         struct switch_dev sw_dev;
66         struct b53_platform_data *pdata;
67
68         struct mutex reg_mutex;
69         const struct b53_io_ops *ops;
70
71         /* chip specific data */
72         u32 chip_id;
73         u8 core_rev;
74         u8 vta_regs[3];
75         u8 duplex_reg;
76         u8 jumbo_pm_reg;
77         u8 jumbo_size_reg;
78         int reset_gpio;
79
80         /* used ports mask */
81         u16 enabled_ports;
82
83         /* connect specific data */
84         u8 current_page;
85         struct device *dev;
86         void *priv;
87
88         /* run time configuration */
89         unsigned enable_vlan:1;
90         unsigned enable_jumbo:1;
91         unsigned allow_vid_4095:1;
92
93         struct b53_port *ports;
94         struct b53_vlan *vlans;
95
96         char *buf;
97 };
98
99 #define b53_for_each_port(dev, i) \
100         for (i = 0; i < B53_N_PORTS; i++) \
101                 if (dev->enabled_ports & BIT(i))
102
103
104
105 static inline int is5325(struct b53_device *dev)
106 {
107         return dev->chip_id == BCM5325_DEVICE_ID;
108 }
109
110 static inline int is5365(struct b53_device *dev)
111 {
112 #ifdef CONFIG_BCM47XX
113         return dev->chip_id == BCM5365_DEVICE_ID;
114 #else
115         return 0;
116 #endif
117 }
118
119 static inline int is5397_98(struct b53_device *dev)
120 {
121         return dev->chip_id == BCM5397_DEVICE_ID ||
122                 dev->chip_id == BCM5398_DEVICE_ID;
123 }
124
125 static inline int is531x5(struct b53_device *dev)
126 {
127         return dev->chip_id == BCM53115_DEVICE_ID ||
128                 dev->chip_id == BCM53125_DEVICE_ID;
129 }
130
131 static inline int is63xx(struct b53_device *dev)
132 {
133 #ifdef CONFIG_BCM63XX
134         return dev->chip_id == BCM63XX_DEVICE_ID;
135 #else
136         return 0;
137 #endif
138 }
139
140 #define B53_CPU_PORT_25 5
141 #define B53_CPU_PORT    8
142
143 static inline int is_cpu_port(struct b53_device *dev, int port)
144 {
145         return dev->sw_dev.cpu_port == port;
146 }
147
148 static inline struct b53_device *sw_to_b53(struct switch_dev *sw)
149 {
150         return container_of(sw, struct b53_device, sw_dev);
151 }
152
153 struct b53_device *b53_switch_alloc(struct device *base, struct b53_io_ops *ops,
154                                     void *priv);
155
156 int b53_switch_detect(struct b53_device *dev);
157
158 int b53_switch_register(struct b53_device *dev);
159
160 static inline void b53_switch_remove(struct b53_device *dev)
161 {
162         unregister_switch(&dev->sw_dev);
163 }
164
165 static inline int b53_read8(struct b53_device *dev, u8 page, u8 reg, u8 *val)
166 {
167         int ret;
168
169         mutex_lock(&dev->reg_mutex);
170         ret = dev->ops->read8(dev, page, reg, val);
171         mutex_unlock(&dev->reg_mutex);
172
173         return ret;
174 }
175
176 static inline int b53_read16(struct b53_device *dev, u8 page, u8 reg, u16 *val)
177 {
178         int ret;
179
180         mutex_lock(&dev->reg_mutex);
181         ret = dev->ops->read16(dev, page, reg, val);
182         mutex_unlock(&dev->reg_mutex);
183
184         return ret;
185 }
186
187 static inline int b53_read32(struct b53_device *dev, u8 page, u8 reg, u32 *val)
188 {
189         int ret;
190
191         mutex_lock(&dev->reg_mutex);
192         ret = dev->ops->read32(dev, page, reg, val);
193         mutex_unlock(&dev->reg_mutex);
194
195         return ret;
196 }
197
198 static inline int b53_read48(struct b53_device *dev, u8 page, u8 reg, u64 *val)
199 {
200         int ret;
201
202         mutex_lock(&dev->reg_mutex);
203         ret = dev->ops->read48(dev, page, reg, val);
204         mutex_unlock(&dev->reg_mutex);
205
206         return ret;
207 }
208
209 static inline int b53_read64(struct b53_device *dev, u8 page, u8 reg, u64 *val)
210 {
211         int ret;
212
213         mutex_lock(&dev->reg_mutex);
214         ret = dev->ops->read64(dev, page, reg, val);
215         mutex_unlock(&dev->reg_mutex);
216
217         return ret;
218 }
219
220 static inline int b53_write8(struct b53_device *dev, u8 page, u8 reg, u8 value)
221 {
222         int ret;
223
224         mutex_lock(&dev->reg_mutex);
225         ret = dev->ops->write8(dev, page, reg, value);
226         mutex_unlock(&dev->reg_mutex);
227
228         return ret;
229 }
230
231 static inline int b53_write16(struct b53_device *dev, u8 page, u8 reg,
232                               u16 value)
233 {
234         int ret;
235
236         mutex_lock(&dev->reg_mutex);
237         ret = dev->ops->write16(dev, page, reg, value);
238         mutex_unlock(&dev->reg_mutex);
239
240         return ret;
241 }
242
243 static inline int b53_write32(struct b53_device *dev, u8 page, u8 reg,
244                               u32 value)
245 {
246         int ret;
247
248         mutex_lock(&dev->reg_mutex);
249         ret = dev->ops->write32(dev, page, reg, value);
250         mutex_unlock(&dev->reg_mutex);
251
252         return ret;
253 }
254
255 static inline int b53_write48(struct b53_device *dev, u8 page, u8 reg,
256                               u64 value)
257 {
258         int ret;
259
260         mutex_lock(&dev->reg_mutex);
261         ret = dev->ops->write48(dev, page, reg, value);
262         mutex_unlock(&dev->reg_mutex);
263
264         return ret;
265 }
266
267 static inline int b53_write64(struct b53_device *dev, u8 page, u8 reg,
268                                u64 value)
269 {
270         int ret;
271
272         mutex_lock(&dev->reg_mutex);
273         ret = dev->ops->write64(dev, page, reg, value);
274         mutex_unlock(&dev->reg_mutex);
275
276         return ret;
277 }
278
279 #ifdef CONFIG_BCM47XX
280
281 #include <bcm47xx_nvram.h>
282 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
283 {
284        return bcm47xx_nvram_gpio_pin("robo_reset");
285 }
286 #else
287 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
288 {
289        return -ENOENT;
290 }
291 #endif
292 #endif