drivers/net/dsa/realtek-smi.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /* Realtek SMI interface driver defines
   3  *
   4  * Copyright (C) 2017 Linus Walleij <linus.walleij@linaro.org>
   5  * Copyright (C) 2009-2010 Gabor Juhos <juhosg@openwrt.org>
   6  */
   7
   8 #ifndef _REALTEK_SMI_H
   9 #define _REALTEK_SMI_H
  10
  11 #include <linux/phy.h>
  12 #include <linux/platform_device.h>
  13 #include <linux/gpio/consumer.h>
  14 #include <net/dsa.h>
  15
  16 struct realtek_smi_ops;
  17 struct dentry;
  18 struct inode;
  19 struct file;
  20
  21 struct rtl8366_mib_counter {
  22         unsigned int    base;
  23         unsigned int    offset;
  24         unsigned int    length;
  25         const char      *name;
  26 };
  27
  28 /**
  29  * struct rtl8366_vlan_mc - Virtual LAN member configuration
  30  */
  31 struct rtl8366_vlan_mc {
  32         u16     vid;
  33         u16     untag;
  34         u16     member;
  35         u8      fid;
  36         u8      priority;
  37 };
  38
  39 struct rtl8366_vlan_4k {
  40         u16     vid;
  41         u16     untag;
  42         u16     member;
  43         u8      fid;
  44 };
  45
  46 struct realtek_smi {
  47         struct device           *dev;
  48         struct gpio_desc        *reset;
  49         struct gpio_desc        *mdc;
  50         struct gpio_desc        *mdio;
  51         struct regmap           *map;
  52         struct mii_bus          *slave_mii_bus;
  53
  54         unsigned int            clk_delay;
  55         u8                      cmd_read;
  56         u8                      cmd_write;
  57         spinlock_t              lock; /* Locks around command writes */
  58         struct dsa_switch       *ds;
  59         struct irq_domain       *irqdomain;
  60         bool                    leds_disabled;
  61
  62         unsigned int            cpu_port;
  63         unsigned int            num_ports;
  64         unsigned int            num_vlan_mc;
  65         unsigned int            num_mib_counters;
  66         struct rtl8366_mib_counter *mib_counters;
  67
  68         const struct realtek_smi_ops *ops;
  69
  70         int                     vlan_enabled;
  71         int                     vlan4k_enabled;
  72
  73         char                    buf[4096];
  74 };
  75
  76 /**
  77  * struct realtek_smi_ops - vtable for the per-SMI-chiptype operations
  78  * @detect: detects the chiptype
  79  */
  80 struct realtek_smi_ops {
  81         int     (*detect)(struct realtek_smi *smi);
  82         int     (*reset_chip)(struct realtek_smi *smi);
  83         int     (*setup)(struct realtek_smi *smi);
  84         void    (*cleanup)(struct realtek_smi *smi);
  85         int     (*get_mib_counter)(struct realtek_smi *smi,
  86                                    int port,
  87                                    struct rtl8366_mib_counter *mib,
  88                                    u64 *mibvalue);
  89         int     (*get_vlan_mc)(struct realtek_smi *smi, u32 index,
  90                                struct rtl8366_vlan_mc *vlanmc);
  91         int     (*set_vlan_mc)(struct realtek_smi *smi, u32 index,
  92                                const struct rtl8366_vlan_mc *vlanmc);
  93         int     (*get_vlan_4k)(struct realtek_smi *smi, u32 vid,
  94                                struct rtl8366_vlan_4k *vlan4k);
  95         int     (*set_vlan_4k)(struct realtek_smi *smi,
  96                                const struct rtl8366_vlan_4k *vlan4k);
  97         int     (*get_mc_index)(struct realtek_smi *smi, int port, int *val);
  98         int     (*set_mc_index)(struct realtek_smi *smi, int port, int index);
  99         bool    (*is_vlan_valid)(struct realtek_smi *smi, unsigned int vlan);
 100         int     (*enable_vlan)(struct realtek_smi *smi, bool enable);
 101         int     (*enable_vlan4k)(struct realtek_smi *smi, bool enable);
 102         int     (*enable_port)(struct realtek_smi *smi, int port, bool enable);
 103         int     (*phy_read)(struct realtek_smi *smi, int phy, int regnum);
 104         int     (*phy_write)(struct realtek_smi *smi, int phy, int regnum,
 105                              u16 val);
 106 };
 107
 108 struct realtek_smi_variant {
 109         const struct dsa_switch_ops *ds_ops;
 110         const struct realtek_smi_ops *ops;
 111         unsigned int clk_delay;
 112         u8 cmd_read;
 113         u8 cmd_write;
 114 };
 115
 116 /* SMI core calls */
 117 int realtek_smi_write_reg_noack(struct realtek_smi *smi, u32 addr,
 118                                 u32 data);
 119 int realtek_smi_setup_mdio(struct realtek_smi *smi);
 120
 121 /* RTL8366 library helpers */
 122 int rtl8366_mc_is_used(struct realtek_smi *smi, int mc_index, int *used);
 123 int rtl8366_set_vlan(struct realtek_smi *smi, int vid, u32 member,
 124                      u32 untag, u32 fid);
 125 int rtl8366_set_pvid(struct realtek_smi *smi, unsigned int port,
 126                      unsigned int vid);
 127 int rtl8366_enable_vlan4k(struct realtek_smi *smi, bool enable);
 128 int rtl8366_enable_vlan(struct realtek_smi *smi, bool enable);
 129 int rtl8366_reset_vlan(struct realtek_smi *smi);
 130 int rtl8366_init_vlan(struct realtek_smi *smi);
 131 int rtl8366_vlan_filtering(struct dsa_switch *ds, int port,
 132                            bool vlan_filtering);
 133 int rtl8366_vlan_prepare(struct dsa_switch *ds, int port,
 134                          const struct switchdev_obj_port_vlan *vlan);
 135 void rtl8366_vlan_add(struct dsa_switch *ds, int port,
 136                       const struct switchdev_obj_port_vlan *vlan);
 137 int rtl8366_vlan_del(struct dsa_switch *ds, int port,
 138                      const struct switchdev_obj_port_vlan *vlan);
 139 void rtl8366_get_strings(struct dsa_switch *ds, int port, u32 stringset,
 140                          uint8_t *data);
 141 int rtl8366_get_sset_count(struct dsa_switch *ds, int port, int sset);
 142 void rtl8366_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data);
 143
 144 extern const struct realtek_smi_variant rtl8366rb_variant;
 145
 146 #endif /*  _REALTEK_SMI_H */