net: dsa: mv88e6xxx: add phylink support
[sfrench/cifs-2.6.git] / drivers / net / dsa / mv88e6xxx / chip.h
1 /*
2  * Marvell 88E6xxx Ethernet switch single-chip definition
3  *
4  * Copyright (c) 2008 Marvell Semiconductor
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  */
11
12 #ifndef _MV88E6XXX_CHIP_H
13 #define _MV88E6XXX_CHIP_H
14
15 #include <linux/if_vlan.h>
16 #include <linux/irq.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/kthread.h>
19 #include <linux/phy.h>
20 #include <linux/ptp_clock_kernel.h>
21 #include <linux/timecounter.h>
22 #include <net/dsa.h>
23
24 #define SMI_CMD                 0x00
25 #define SMI_CMD_BUSY            BIT(15)
26 #define SMI_CMD_CLAUSE_22       BIT(12)
27 #define SMI_CMD_OP_22_WRITE     ((1 << 10) | SMI_CMD_BUSY | SMI_CMD_CLAUSE_22)
28 #define SMI_CMD_OP_22_READ      ((2 << 10) | SMI_CMD_BUSY | SMI_CMD_CLAUSE_22)
29 #define SMI_CMD_OP_45_WRITE_ADDR        ((0 << 10) | SMI_CMD_BUSY)
30 #define SMI_CMD_OP_45_WRITE_DATA        ((1 << 10) | SMI_CMD_BUSY)
31 #define SMI_CMD_OP_45_READ_DATA         ((2 << 10) | SMI_CMD_BUSY)
32 #define SMI_CMD_OP_45_READ_DATA_INC     ((3 << 10) | SMI_CMD_BUSY)
33 #define SMI_DATA                0x01
34
35 #define MV88E6XXX_N_FID         4096
36
37 /* PVT limits for 4-bit port and 5-bit switch */
38 #define MV88E6XXX_MAX_PVT_SWITCHES      32
39 #define MV88E6XXX_MAX_PVT_PORTS         16
40
41 #define MV88E6XXX_MAX_GPIO      16
42
43 enum mv88e6xxx_egress_mode {
44         MV88E6XXX_EGRESS_MODE_UNMODIFIED,
45         MV88E6XXX_EGRESS_MODE_UNTAGGED,
46         MV88E6XXX_EGRESS_MODE_TAGGED,
47         MV88E6XXX_EGRESS_MODE_ETHERTYPE,
48 };
49
50 enum mv88e6xxx_frame_mode {
51         MV88E6XXX_FRAME_MODE_NORMAL,
52         MV88E6XXX_FRAME_MODE_DSA,
53         MV88E6XXX_FRAME_MODE_PROVIDER,
54         MV88E6XXX_FRAME_MODE_ETHERTYPE,
55 };
56
57 /* List of supported models */
58 enum mv88e6xxx_model {
59         MV88E6085,
60         MV88E6095,
61         MV88E6097,
62         MV88E6123,
63         MV88E6131,
64         MV88E6141,
65         MV88E6161,
66         MV88E6165,
67         MV88E6171,
68         MV88E6172,
69         MV88E6175,
70         MV88E6176,
71         MV88E6185,
72         MV88E6190,
73         MV88E6190X,
74         MV88E6191,
75         MV88E6240,
76         MV88E6290,
77         MV88E6320,
78         MV88E6321,
79         MV88E6341,
80         MV88E6350,
81         MV88E6351,
82         MV88E6352,
83         MV88E6390,
84         MV88E6390X,
85 };
86
87 enum mv88e6xxx_family {
88         MV88E6XXX_FAMILY_NONE,
89         MV88E6XXX_FAMILY_6065,  /* 6031 6035 6061 6065 */
90         MV88E6XXX_FAMILY_6095,  /* 6092 6095 */
91         MV88E6XXX_FAMILY_6097,  /* 6046 6085 6096 6097 */
92         MV88E6XXX_FAMILY_6165,  /* 6123 6161 6165 */
93         MV88E6XXX_FAMILY_6185,  /* 6108 6121 6122 6131 6152 6155 6182 6185 */
94         MV88E6XXX_FAMILY_6320,  /* 6320 6321 */
95         MV88E6XXX_FAMILY_6341,  /* 6141 6341 */
96         MV88E6XXX_FAMILY_6351,  /* 6171 6175 6350 6351 */
97         MV88E6XXX_FAMILY_6352,  /* 6172 6176 6240 6352 */
98         MV88E6XXX_FAMILY_6390,  /* 6190 6190X 6191 6290 6390 6390X */
99 };
100
101 struct mv88e6xxx_ops;
102
103 struct mv88e6xxx_info {
104         enum mv88e6xxx_family family;
105         u16 prod_num;
106         const char *name;
107         unsigned int num_databases;
108         unsigned int num_ports;
109         unsigned int num_internal_phys;
110         unsigned int num_gpio;
111         unsigned int max_vid;
112         unsigned int port_base_addr;
113         unsigned int phy_base_addr;
114         unsigned int global1_addr;
115         unsigned int global2_addr;
116         unsigned int age_time_coeff;
117         unsigned int g1_irqs;
118         unsigned int g2_irqs;
119         bool pvt;
120
121         /* Multi-chip Addressing Mode.
122          * Some chips respond to only 2 registers of its own SMI device address
123          * when it is non-zero, and use indirect access to internal registers.
124          */
125         bool multi_chip;
126         enum dsa_tag_protocol tag_protocol;
127
128         /* Mask for FromPort and ToPort value of PortVec used in ATU Move
129          * operation. 0 means that the ATU Move operation is not supported.
130          */
131         u8 atu_move_port_mask;
132         const struct mv88e6xxx_ops *ops;
133
134         /* Supports PTP */
135         bool ptp_support;
136 };
137
138 struct mv88e6xxx_atu_entry {
139         u8      state;
140         bool    trunk;
141         u16     portvec;
142         u8      mac[ETH_ALEN];
143 };
144
145 struct mv88e6xxx_vtu_entry {
146         u16     vid;
147         u16     fid;
148         u8      sid;
149         bool    valid;
150         u8      member[DSA_MAX_PORTS];
151         u8      state[DSA_MAX_PORTS];
152 };
153
154 struct mv88e6xxx_bus_ops;
155 struct mv88e6xxx_irq_ops;
156 struct mv88e6xxx_gpio_ops;
157 struct mv88e6xxx_avb_ops;
158 struct mv88e6xxx_ptp_ops;
159
160 struct mv88e6xxx_irq {
161         u16 masked;
162         struct irq_chip chip;
163         struct irq_domain *domain;
164         unsigned int nirqs;
165 };
166
167 /* state flags for mv88e6xxx_port_hwtstamp::state */
168 enum {
169         MV88E6XXX_HWTSTAMP_ENABLED,
170         MV88E6XXX_HWTSTAMP_TX_IN_PROGRESS,
171 };
172
173 struct mv88e6xxx_port_hwtstamp {
174         /* Port index */
175         int port_id;
176
177         /* Timestamping state */
178         unsigned long state;
179
180         /* Resources for receive timestamping */
181         struct sk_buff_head rx_queue;
182         struct sk_buff_head rx_queue2;
183
184         /* Resources for transmit timestamping */
185         unsigned long tx_tstamp_start;
186         struct sk_buff *tx_skb;
187         u16 tx_seq_id;
188
189         /* Current timestamp configuration */
190         struct hwtstamp_config tstamp_config;
191 };
192
193 struct mv88e6xxx_port {
194         u64 serdes_stats[2];
195         u64 atu_member_violation;
196         u64 atu_miss_violation;
197         u64 atu_full_violation;
198         u64 vtu_member_violation;
199         u64 vtu_miss_violation;
200 };
201
202 struct mv88e6xxx_chip {
203         const struct mv88e6xxx_info *info;
204
205         /* The dsa_switch this private structure is related to */
206         struct dsa_switch *ds;
207
208         /* The device this structure is associated to */
209         struct device *dev;
210
211         /* This mutex protects the access to the switch registers */
212         struct mutex reg_lock;
213
214         /* The MII bus and the address on the bus that is used to
215          * communication with the switch
216          */
217         const struct mv88e6xxx_bus_ops *smi_ops;
218         struct mii_bus *bus;
219         int sw_addr;
220
221         /* Handles automatic disabling and re-enabling of the PHY
222          * polling unit.
223          */
224         const struct mv88e6xxx_bus_ops *phy_ops;
225         struct mutex            ppu_mutex;
226         int                     ppu_disabled;
227         struct work_struct      ppu_work;
228         struct timer_list       ppu_timer;
229
230         /* This mutex serialises access to the statistics unit.
231          * Hold this mutex over snapshot + dump sequences.
232          */
233         struct mutex    stats_mutex;
234
235         /* A switch may have a GPIO line tied to its reset pin. Parse
236          * this from the device tree, and use it before performing
237          * switch soft reset.
238          */
239         struct gpio_desc *reset;
240
241         /* set to size of eeprom if supported by the switch */
242         u32 eeprom_len;
243
244         /* List of mdio busses */
245         struct list_head mdios;
246
247         /* There can be two interrupt controllers, which are chained
248          * off a GPIO as interrupt source
249          */
250         struct mv88e6xxx_irq g1_irq;
251         struct mv88e6xxx_irq g2_irq;
252         int irq;
253         int device_irq;
254         int watchdog_irq;
255
256         int atu_prob_irq;
257         int vtu_prob_irq;
258         struct kthread_worker *kworker;
259         struct kthread_delayed_work irq_poll_work;
260
261         /* GPIO resources */
262         u8 gpio_data[2];
263
264         /* This cyclecounter abstracts the switch PTP time.
265          * reg_lock must be held for any operation that read()s.
266          */
267         struct cyclecounter     tstamp_cc;
268         struct timecounter      tstamp_tc;
269         struct delayed_work     overflow_work;
270
271         struct ptp_clock        *ptp_clock;
272         struct ptp_clock_info   ptp_clock_info;
273         struct delayed_work     tai_event_work;
274         struct ptp_pin_desc     pin_config[MV88E6XXX_MAX_GPIO];
275         u16 trig_config;
276         u16 evcap_config;
277         u16 enable_count;
278
279         /* Per-port timestamping resources. */
280         struct mv88e6xxx_port_hwtstamp port_hwtstamp[DSA_MAX_PORTS];
281
282         /* Array of port structures. */
283         struct mv88e6xxx_port ports[DSA_MAX_PORTS];
284 };
285
286 struct mv88e6xxx_bus_ops {
287         int (*read)(struct mv88e6xxx_chip *chip, int addr, int reg, u16 *val);
288         int (*write)(struct mv88e6xxx_chip *chip, int addr, int reg, u16 val);
289 };
290
291 struct mv88e6xxx_mdio_bus {
292         struct mii_bus *bus;
293         struct mv88e6xxx_chip *chip;
294         struct list_head list;
295         bool external;
296 };
297
298 struct mv88e6xxx_ops {
299         int (*ieee_pri_map)(struct mv88e6xxx_chip *chip);
300         int (*ip_pri_map)(struct mv88e6xxx_chip *chip);
301
302         /* Ingress Rate Limit unit (IRL) operations */
303         int (*irl_init_all)(struct mv88e6xxx_chip *chip, int port);
304
305         int (*get_eeprom)(struct mv88e6xxx_chip *chip,
306                           struct ethtool_eeprom *eeprom, u8 *data);
307         int (*set_eeprom)(struct mv88e6xxx_chip *chip,
308                           struct ethtool_eeprom *eeprom, u8 *data);
309
310         int (*set_switch_mac)(struct mv88e6xxx_chip *chip, u8 *addr);
311
312         int (*phy_read)(struct mv88e6xxx_chip *chip,
313                         struct mii_bus *bus,
314                         int addr, int reg, u16 *val);
315         int (*phy_write)(struct mv88e6xxx_chip *chip,
316                          struct mii_bus *bus,
317                          int addr, int reg, u16 val);
318
319         /* Priority Override Table operations */
320         int (*pot_clear)(struct mv88e6xxx_chip *chip);
321
322         /* PHY Polling Unit (PPU) operations */
323         int (*ppu_enable)(struct mv88e6xxx_chip *chip);
324         int (*ppu_disable)(struct mv88e6xxx_chip *chip);
325
326         /* Switch Software Reset */
327         int (*reset)(struct mv88e6xxx_chip *chip);
328
329         /* RGMII Receive/Transmit Timing Control
330          * Add delay on PHY_INTERFACE_MODE_RGMII_*ID, no delay otherwise.
331          */
332         int (*port_set_rgmii_delay)(struct mv88e6xxx_chip *chip, int port,
333                                     phy_interface_t mode);
334
335 #define LINK_FORCED_DOWN        0
336 #define LINK_FORCED_UP          1
337 #define LINK_UNFORCED           -2
338
339         /* Port's MAC link state
340          * Use LINK_FORCED_UP or LINK_FORCED_DOWN to force link up or down,
341          * or LINK_UNFORCED for normal link detection.
342          */
343         int (*port_set_link)(struct mv88e6xxx_chip *chip, int port, int link);
344
345 #define DUPLEX_UNFORCED         -2
346
347         /* Port's MAC duplex mode
348          *
349          * Use DUPLEX_HALF or DUPLEX_FULL to force half or full duplex,
350          * or DUPLEX_UNFORCED for normal duplex detection.
351          */
352         int (*port_set_duplex)(struct mv88e6xxx_chip *chip, int port, int dup);
353
354 #define PAUSE_ON                1
355 #define PAUSE_OFF               0
356
357         /* Enable/disable sending Pause */
358         int (*port_set_pause)(struct mv88e6xxx_chip *chip, int port,
359                               int pause);
360
361 #define SPEED_MAX               INT_MAX
362 #define SPEED_UNFORCED          -2
363
364         /* Port's MAC speed (in Mbps)
365          *
366          * Depending on the chip, 10, 100, 200, 1000, 2500, 10000 are valid.
367          * Use SPEED_UNFORCED for normal detection, SPEED_MAX for max value.
368          */
369         int (*port_set_speed)(struct mv88e6xxx_chip *chip, int port, int speed);
370
371         int (*port_tag_remap)(struct mv88e6xxx_chip *chip, int port);
372
373         int (*port_set_frame_mode)(struct mv88e6xxx_chip *chip, int port,
374                                    enum mv88e6xxx_frame_mode mode);
375         int (*port_set_egress_floods)(struct mv88e6xxx_chip *chip, int port,
376                                       bool unicast, bool multicast);
377         int (*port_set_ether_type)(struct mv88e6xxx_chip *chip, int port,
378                                    u16 etype);
379         int (*port_set_jumbo_size)(struct mv88e6xxx_chip *chip, int port,
380                                    size_t size);
381
382         int (*port_egress_rate_limiting)(struct mv88e6xxx_chip *chip, int port);
383         int (*port_pause_limit)(struct mv88e6xxx_chip *chip, int port, u8 in,
384                                 u8 out);
385         int (*port_disable_learn_limit)(struct mv88e6xxx_chip *chip, int port);
386         int (*port_disable_pri_override)(struct mv88e6xxx_chip *chip, int port);
387
388         /* CMODE control what PHY mode the MAC will use, eg. SGMII, RGMII, etc.
389          * Some chips allow this to be configured on specific ports.
390          */
391         int (*port_set_cmode)(struct mv88e6xxx_chip *chip, int port,
392                               phy_interface_t mode);
393
394         /* Some devices have a per port register indicating what is
395          * the upstream port this port should forward to.
396          */
397         int (*port_set_upstream_port)(struct mv88e6xxx_chip *chip, int port,
398                                       int upstream_port);
399         /* Return the port link state, as required by phylink */
400         int (*port_link_state)(struct mv88e6xxx_chip *chip, int port,
401                                struct phylink_link_state *state);
402
403         /* Snapshot the statistics for a port. The statistics can then
404          * be read back a leisure but still with a consistent view.
405          */
406         int (*stats_snapshot)(struct mv88e6xxx_chip *chip, int port);
407
408         /* Set the histogram mode for statistics, when the control registers
409          * are separated out of the STATS_OP register.
410          */
411         int (*stats_set_histogram)(struct mv88e6xxx_chip *chip);
412
413         /* Return the number of strings describing statistics */
414         int (*stats_get_sset_count)(struct mv88e6xxx_chip *chip);
415         int (*stats_get_strings)(struct mv88e6xxx_chip *chip,  uint8_t *data);
416         int (*stats_get_stats)(struct mv88e6xxx_chip *chip,  int port,
417                                uint64_t *data);
418         int (*set_cpu_port)(struct mv88e6xxx_chip *chip, int port);
419         int (*set_egress_port)(struct mv88e6xxx_chip *chip, int port);
420
421 #define MV88E6XXX_CASCADE_PORT_NONE             0xe
422 #define MV88E6XXX_CASCADE_PORT_MULTIPLE         0xf
423
424         int (*set_cascade_port)(struct mv88e6xxx_chip *chip, int port);
425
426         const struct mv88e6xxx_irq_ops *watchdog_ops;
427
428         int (*mgmt_rsvd2cpu)(struct mv88e6xxx_chip *chip);
429
430         /* Power on/off a SERDES interface */
431         int (*serdes_power)(struct mv88e6xxx_chip *chip, int port, bool on);
432
433         /* Statistics from the SERDES interface */
434         int (*serdes_get_sset_count)(struct mv88e6xxx_chip *chip, int port);
435         int (*serdes_get_strings)(struct mv88e6xxx_chip *chip,  int port,
436                                   uint8_t *data);
437         int (*serdes_get_stats)(struct mv88e6xxx_chip *chip,  int port,
438                                 uint64_t *data);
439
440         /* VLAN Translation Unit operations */
441         int (*vtu_getnext)(struct mv88e6xxx_chip *chip,
442                            struct mv88e6xxx_vtu_entry *entry);
443         int (*vtu_loadpurge)(struct mv88e6xxx_chip *chip,
444                              struct mv88e6xxx_vtu_entry *entry);
445
446         /* GPIO operations */
447         const struct mv88e6xxx_gpio_ops *gpio_ops;
448
449         /* Interface to the AVB/PTP registers */
450         const struct mv88e6xxx_avb_ops *avb_ops;
451
452         /* Remote Management Unit operations */
453         int (*rmu_disable)(struct mv88e6xxx_chip *chip);
454
455         /* Precision Time Protocol operations */
456         const struct mv88e6xxx_ptp_ops *ptp_ops;
457
458         /* Phylink */
459         void (*phylink_validate)(struct mv88e6xxx_chip *chip, int port,
460                                  unsigned long *mask,
461                                  struct phylink_link_state *state);
462 };
463
464 struct mv88e6xxx_irq_ops {
465         /* Action to be performed when the interrupt happens */
466         int (*irq_action)(struct mv88e6xxx_chip *chip, int irq);
467         /* Setup the hardware to generate the interrupt */
468         int (*irq_setup)(struct mv88e6xxx_chip *chip);
469         /* Reset the hardware to stop generating the interrupt */
470         void (*irq_free)(struct mv88e6xxx_chip *chip);
471 };
472
473 struct mv88e6xxx_gpio_ops {
474         /* Get/set data on GPIO pin */
475         int (*get_data)(struct mv88e6xxx_chip *chip, unsigned int pin);
476         int (*set_data)(struct mv88e6xxx_chip *chip, unsigned int pin,
477                         int value);
478
479         /* get/set GPIO direction */
480         int (*get_dir)(struct mv88e6xxx_chip *chip, unsigned int pin);
481         int (*set_dir)(struct mv88e6xxx_chip *chip, unsigned int pin,
482                        bool input);
483
484         /* get/set GPIO pin control */
485         int (*get_pctl)(struct mv88e6xxx_chip *chip, unsigned int pin,
486                         int *func);
487         int (*set_pctl)(struct mv88e6xxx_chip *chip, unsigned int pin,
488                         int func);
489 };
490
491 struct mv88e6xxx_avb_ops {
492         /* Access port-scoped Precision Time Protocol registers */
493         int (*port_ptp_read)(struct mv88e6xxx_chip *chip, int port, int addr,
494                              u16 *data, int len);
495         int (*port_ptp_write)(struct mv88e6xxx_chip *chip, int port, int addr,
496                               u16 data);
497
498         /* Access global Precision Time Protocol registers */
499         int (*ptp_read)(struct mv88e6xxx_chip *chip, int addr, u16 *data,
500                         int len);
501         int (*ptp_write)(struct mv88e6xxx_chip *chip, int addr, u16 data);
502
503         /* Access global Time Application Interface registers */
504         int (*tai_read)(struct mv88e6xxx_chip *chip, int addr, u16 *data,
505                         int len);
506         int (*tai_write)(struct mv88e6xxx_chip *chip, int addr, u16 data);
507 };
508
509 struct mv88e6xxx_ptp_ops {
510         u64 (*clock_read)(const struct cyclecounter *cc);
511         int (*ptp_enable)(struct ptp_clock_info *ptp,
512                           struct ptp_clock_request *rq, int on);
513         int (*ptp_verify)(struct ptp_clock_info *ptp, unsigned int pin,
514                           enum ptp_pin_function func, unsigned int chan);
515         void (*event_work)(struct work_struct *ugly);
516         int (*port_enable)(struct mv88e6xxx_chip *chip, int port);
517         int (*port_disable)(struct mv88e6xxx_chip *chip, int port);
518         int (*global_enable)(struct mv88e6xxx_chip *chip);
519         int (*global_disable)(struct mv88e6xxx_chip *chip);
520         int n_ext_ts;
521         int arr0_sts_reg;
522         int arr1_sts_reg;
523         int dep_sts_reg;
524         u32 rx_filters;
525 };
526
527 #define STATS_TYPE_PORT         BIT(0)
528 #define STATS_TYPE_BANK0        BIT(1)
529 #define STATS_TYPE_BANK1        BIT(2)
530
531 struct mv88e6xxx_hw_stat {
532         char string[ETH_GSTRING_LEN];
533         size_t size;
534         int reg;
535         int type;
536 };
537
538 static inline bool mv88e6xxx_has_pvt(struct mv88e6xxx_chip *chip)
539 {
540         return chip->info->pvt;
541 }
542
543 static inline unsigned int mv88e6xxx_num_databases(struct mv88e6xxx_chip *chip)
544 {
545         return chip->info->num_databases;
546 }
547
548 static inline unsigned int mv88e6xxx_num_ports(struct mv88e6xxx_chip *chip)
549 {
550         return chip->info->num_ports;
551 }
552
553 static inline u16 mv88e6xxx_port_mask(struct mv88e6xxx_chip *chip)
554 {
555         return GENMASK(mv88e6xxx_num_ports(chip) - 1, 0);
556 }
557
558 static inline unsigned int mv88e6xxx_num_gpio(struct mv88e6xxx_chip *chip)
559 {
560         return chip->info->num_gpio;
561 }
562
563 int mv88e6xxx_read(struct mv88e6xxx_chip *chip, int addr, int reg, u16 *val);
564 int mv88e6xxx_write(struct mv88e6xxx_chip *chip, int addr, int reg, u16 val);
565 int mv88e6xxx_update(struct mv88e6xxx_chip *chip, int addr, int reg,
566                      u16 update);
567 int mv88e6xxx_wait(struct mv88e6xxx_chip *chip, int addr, int reg, u16 mask);
568 struct mii_bus *mv88e6xxx_default_mdio_bus(struct mv88e6xxx_chip *chip);
569
570 #endif /* _MV88E6XXX_CHIP_H */