Merge tag 'media/v5.15-2' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[platform/kernel/linux-starfive.git] / net / ncsi / internal.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright Gavin Shan, IBM Corporation 2016.
4  */
5
6 #ifndef __NCSI_INTERNAL_H__
7 #define __NCSI_INTERNAL_H__
8
9 enum {
10         NCSI_CAP_BASE           = 0,
11         NCSI_CAP_GENERIC        = 0,
12         NCSI_CAP_BC,
13         NCSI_CAP_MC,
14         NCSI_CAP_BUFFER,
15         NCSI_CAP_AEN,
16         NCSI_CAP_VLAN,
17         NCSI_CAP_MAX
18 };
19
20 enum {
21         NCSI_CAP_GENERIC_HWA             = 0x01, /* HW arbitration           */
22         NCSI_CAP_GENERIC_HDS             = 0x02, /* HNC driver status change */
23         NCSI_CAP_GENERIC_FC              = 0x04, /* HNC to MC flow control   */
24         NCSI_CAP_GENERIC_FC1             = 0x08, /* MC to HNC flow control   */
25         NCSI_CAP_GENERIC_MC              = 0x10, /* Global MC filtering      */
26         NCSI_CAP_GENERIC_HWA_UNKNOWN     = 0x00, /* Unknown HW arbitration   */
27         NCSI_CAP_GENERIC_HWA_SUPPORT     = 0x20, /* Supported HW arbitration */
28         NCSI_CAP_GENERIC_HWA_NOT_SUPPORT = 0x40, /* No HW arbitration        */
29         NCSI_CAP_GENERIC_HWA_RESERVED    = 0x60, /* Reserved HW arbitration  */
30         NCSI_CAP_GENERIC_HWA_MASK        = 0x60, /* Mask for HW arbitration  */
31         NCSI_CAP_GENERIC_MASK            = 0x7f,
32         NCSI_CAP_BC_ARP                  = 0x01, /* ARP packet filtering     */
33         NCSI_CAP_BC_DHCPC                = 0x02, /* DHCP client filtering    */
34         NCSI_CAP_BC_DHCPS                = 0x04, /* DHCP server filtering    */
35         NCSI_CAP_BC_NETBIOS              = 0x08, /* NetBIOS packet filtering */
36         NCSI_CAP_BC_MASK                 = 0x0f,
37         NCSI_CAP_MC_IPV6_NEIGHBOR        = 0x01, /* IPv6 neighbor filtering  */
38         NCSI_CAP_MC_IPV6_ROUTER          = 0x02, /* IPv6 router filering     */
39         NCSI_CAP_MC_DHCPV6_RELAY         = 0x04, /* DHCPv6 relay / server MC */
40         NCSI_CAP_MC_DHCPV6_WELL_KNOWN    = 0x08, /* DHCPv6 well-known MC     */
41         NCSI_CAP_MC_IPV6_MLD             = 0x10, /* IPv6 MLD filtering       */
42         NCSI_CAP_MC_IPV6_NEIGHBOR_S      = 0x20, /* IPv6 neighbour filtering */
43         NCSI_CAP_MC_MASK                 = 0x3f,
44         NCSI_CAP_AEN_LSC                 = 0x01, /* Link status change       */
45         NCSI_CAP_AEN_CR                  = 0x02, /* Configuration required   */
46         NCSI_CAP_AEN_HDS                 = 0x04, /* HNC driver status        */
47         NCSI_CAP_AEN_MASK                = 0x07,
48         NCSI_CAP_VLAN_ONLY               = 0x01, /* Filter VLAN packet only  */
49         NCSI_CAP_VLAN_NO                 = 0x02, /* Filter VLAN and non-VLAN */
50         NCSI_CAP_VLAN_ANY                = 0x04, /* Filter Any-and-non-VLAN  */
51         NCSI_CAP_VLAN_MASK               = 0x07
52 };
53
54 enum {
55         NCSI_MODE_BASE          = 0,
56         NCSI_MODE_ENABLE        = 0,
57         NCSI_MODE_TX_ENABLE,
58         NCSI_MODE_LINK,
59         NCSI_MODE_VLAN,
60         NCSI_MODE_BC,
61         NCSI_MODE_MC,
62         NCSI_MODE_AEN,
63         NCSI_MODE_FC,
64         NCSI_MODE_MAX
65 };
66
67 /* Supported media status bits for Mellanox Mac affinity command.
68  * Bit (0-2) for different protocol support; Bit 1 for RBT support,
69  * bit 1 for SMBUS support and bit 2 for PCIE support. Bit (3-5)
70  * for different protocol availability. Bit 4 for RBT, bit 4 for
71  * SMBUS and bit 5 for PCIE.
72  */
73 enum {
74         MLX_MC_RBT_SUPPORT  = 0x01, /* MC supports RBT         */
75         MLX_MC_RBT_AVL      = 0x08, /* RBT medium is available */
76 };
77
78 /* OEM Vendor Manufacture ID */
79 #define NCSI_OEM_MFR_MLX_ID             0x8119
80 #define NCSI_OEM_MFR_BCM_ID             0x113d
81 #define NCSI_OEM_MFR_INTEL_ID           0x157
82 /* Intel specific OEM command */
83 #define NCSI_OEM_INTEL_CMD_GMA          0x06   /* CMD ID for Get MAC */
84 #define NCSI_OEM_INTEL_CMD_KEEP_PHY     0x20   /* CMD ID for Keep PHY up */
85 /* Broadcom specific OEM Command */
86 #define NCSI_OEM_BCM_CMD_GMA            0x01   /* CMD ID for Get MAC */
87 /* Mellanox specific OEM Command */
88 #define NCSI_OEM_MLX_CMD_GMA            0x00   /* CMD ID for Get MAC */
89 #define NCSI_OEM_MLX_CMD_GMA_PARAM      0x1b   /* Parameter for GMA  */
90 #define NCSI_OEM_MLX_CMD_SMAF           0x01   /* CMD ID for Set MC Affinity */
91 #define NCSI_OEM_MLX_CMD_SMAF_PARAM     0x07   /* Parameter for SMAF         */
92 /* OEM Command payload lengths*/
93 #define NCSI_OEM_INTEL_CMD_GMA_LEN      5
94 #define NCSI_OEM_INTEL_CMD_KEEP_PHY_LEN 7
95 #define NCSI_OEM_BCM_CMD_GMA_LEN        12
96 #define NCSI_OEM_MLX_CMD_GMA_LEN        8
97 #define NCSI_OEM_MLX_CMD_SMAF_LEN        60
98 /* Offset in OEM request */
99 #define MLX_SMAF_MAC_ADDR_OFFSET         8     /* Offset for MAC in SMAF    */
100 #define MLX_SMAF_MED_SUPPORT_OFFSET      14    /* Offset for medium in SMAF */
101 /* Mac address offset in OEM response */
102 #define BCM_MAC_ADDR_OFFSET             28
103 #define MLX_MAC_ADDR_OFFSET             8
104 #define INTEL_MAC_ADDR_OFFSET           1
105
106
107 struct ncsi_channel_version {
108         u32 version;            /* Supported BCD encoded NCSI version */
109         u32 alpha2;             /* Supported BCD encoded NCSI version */
110         u8  fw_name[12];        /* Firmware name string                */
111         u32 fw_version;         /* Firmware version                   */
112         u16 pci_ids[4];         /* PCI identification                 */
113         u32 mf_id;              /* Manufacture ID                     */
114 };
115
116 struct ncsi_channel_cap {
117         u32 index;      /* Index of channel capabilities */
118         u32 cap;        /* NCSI channel capability       */
119 };
120
121 struct ncsi_channel_mode {
122         u32 index;      /* Index of channel modes      */
123         u32 enable;     /* Enabled or disabled         */
124         u32 size;       /* Valid entries in ncm_data[] */
125         u32 data[8];    /* Data entries                */
126 };
127
128 struct ncsi_channel_mac_filter {
129         u8      n_uc;
130         u8      n_mc;
131         u8      n_mixed;
132         u64     bitmap;
133         unsigned char   *addrs;
134 };
135
136 struct ncsi_channel_vlan_filter {
137         u8      n_vids;
138         u64     bitmap;
139         u16     *vids;
140 };
141
142 struct ncsi_channel_stats {
143         u32 hnc_cnt_hi;         /* Counter cleared            */
144         u32 hnc_cnt_lo;         /* Counter cleared            */
145         u32 hnc_rx_bytes;       /* Rx bytes                   */
146         u32 hnc_tx_bytes;       /* Tx bytes                   */
147         u32 hnc_rx_uc_pkts;     /* Rx UC packets              */
148         u32 hnc_rx_mc_pkts;     /* Rx MC packets              */
149         u32 hnc_rx_bc_pkts;     /* Rx BC packets              */
150         u32 hnc_tx_uc_pkts;     /* Tx UC packets              */
151         u32 hnc_tx_mc_pkts;     /* Tx MC packets              */
152         u32 hnc_tx_bc_pkts;     /* Tx BC packets              */
153         u32 hnc_fcs_err;        /* FCS errors                 */
154         u32 hnc_align_err;      /* Alignment errors           */
155         u32 hnc_false_carrier;  /* False carrier detection    */
156         u32 hnc_runt_pkts;      /* Rx runt packets            */
157         u32 hnc_jabber_pkts;    /* Rx jabber packets          */
158         u32 hnc_rx_pause_xon;   /* Rx pause XON frames        */
159         u32 hnc_rx_pause_xoff;  /* Rx XOFF frames             */
160         u32 hnc_tx_pause_xon;   /* Tx XON frames              */
161         u32 hnc_tx_pause_xoff;  /* Tx XOFF frames             */
162         u32 hnc_tx_s_collision; /* Single collision frames    */
163         u32 hnc_tx_m_collision; /* Multiple collision frames  */
164         u32 hnc_l_collision;    /* Late collision frames      */
165         u32 hnc_e_collision;    /* Excessive collision frames */
166         u32 hnc_rx_ctl_frames;  /* Rx control frames          */
167         u32 hnc_rx_64_frames;   /* Rx 64-bytes frames         */
168         u32 hnc_rx_127_frames;  /* Rx 65-127 bytes frames     */
169         u32 hnc_rx_255_frames;  /* Rx 128-255 bytes frames    */
170         u32 hnc_rx_511_frames;  /* Rx 256-511 bytes frames    */
171         u32 hnc_rx_1023_frames; /* Rx 512-1023 bytes frames   */
172         u32 hnc_rx_1522_frames; /* Rx 1024-1522 bytes frames  */
173         u32 hnc_rx_9022_frames; /* Rx 1523-9022 bytes frames  */
174         u32 hnc_tx_64_frames;   /* Tx 64-bytes frames         */
175         u32 hnc_tx_127_frames;  /* Tx 65-127 bytes frames     */
176         u32 hnc_tx_255_frames;  /* Tx 128-255 bytes frames    */
177         u32 hnc_tx_511_frames;  /* Tx 256-511 bytes frames    */
178         u32 hnc_tx_1023_frames; /* Tx 512-1023 bytes frames   */
179         u32 hnc_tx_1522_frames; /* Tx 1024-1522 bytes frames  */
180         u32 hnc_tx_9022_frames; /* Tx 1523-9022 bytes frames  */
181         u32 hnc_rx_valid_bytes; /* Rx valid bytes             */
182         u32 hnc_rx_runt_pkts;   /* Rx error runt packets      */
183         u32 hnc_rx_jabber_pkts; /* Rx error jabber packets    */
184         u32 ncsi_rx_cmds;       /* Rx NCSI commands           */
185         u32 ncsi_dropped_cmds;  /* Dropped commands           */
186         u32 ncsi_cmd_type_errs; /* Command type errors        */
187         u32 ncsi_cmd_csum_errs; /* Command checksum errors    */
188         u32 ncsi_rx_pkts;       /* Rx NCSI packets            */
189         u32 ncsi_tx_pkts;       /* Tx NCSI packets            */
190         u32 ncsi_tx_aen_pkts;   /* Tx AEN packets             */
191         u32 pt_tx_pkts;         /* Tx packets                 */
192         u32 pt_tx_dropped;      /* Tx dropped packets         */
193         u32 pt_tx_channel_err;  /* Tx channel errors          */
194         u32 pt_tx_us_err;       /* Tx undersize errors        */
195         u32 pt_rx_pkts;         /* Rx packets                 */
196         u32 pt_rx_dropped;      /* Rx dropped packets         */
197         u32 pt_rx_channel_err;  /* Rx channel errors          */
198         u32 pt_rx_us_err;       /* Rx undersize errors        */
199         u32 pt_rx_os_err;       /* Rx oversize errors         */
200 };
201
202 struct ncsi_dev_priv;
203 struct ncsi_package;
204
205 #define NCSI_PACKAGE_SHIFT      5
206 #define NCSI_PACKAGE_INDEX(c)   (((c) >> NCSI_PACKAGE_SHIFT) & 0x7)
207 #define NCSI_RESERVED_CHANNEL   0x1f
208 #define NCSI_CHANNEL_INDEX(c)   ((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1))
209 #define NCSI_TO_CHANNEL(p, c)   (((p) << NCSI_PACKAGE_SHIFT) | (c))
210 #define NCSI_MAX_PACKAGE        8
211 #define NCSI_MAX_CHANNEL        32
212
213 struct ncsi_channel {
214         unsigned char               id;
215         int                         state;
216 #define NCSI_CHANNEL_INACTIVE           1
217 #define NCSI_CHANNEL_ACTIVE             2
218 #define NCSI_CHANNEL_INVISIBLE          3
219         bool                        reconfigure_needed;
220         spinlock_t                  lock;       /* Protect filters etc */
221         struct ncsi_package         *package;
222         struct ncsi_channel_version version;
223         struct ncsi_channel_cap     caps[NCSI_CAP_MAX];
224         struct ncsi_channel_mode    modes[NCSI_MODE_MAX];
225         /* Filtering Settings */
226         struct ncsi_channel_mac_filter  mac_filter;
227         struct ncsi_channel_vlan_filter vlan_filter;
228         struct ncsi_channel_stats   stats;
229         struct {
230                 struct timer_list   timer;
231                 bool                enabled;
232                 unsigned int        state;
233 #define NCSI_CHANNEL_MONITOR_START      0
234 #define NCSI_CHANNEL_MONITOR_RETRY      1
235 #define NCSI_CHANNEL_MONITOR_WAIT       2
236 #define NCSI_CHANNEL_MONITOR_WAIT_MAX   5
237         } monitor;
238         struct list_head            node;
239         struct list_head            link;
240 };
241
242 struct ncsi_package {
243         unsigned char        id;          /* NCSI 3-bits package ID */
244         unsigned char        uuid[16];    /* UUID                   */
245         struct ncsi_dev_priv *ndp;        /* NCSI device            */
246         spinlock_t           lock;        /* Protect the package    */
247         unsigned int         channel_num; /* Number of channels     */
248         struct list_head     channels;    /* List of channels        */
249         struct list_head     node;        /* Form list of packages  */
250
251         bool                 multi_channel; /* Enable multiple channels  */
252         u32                  channel_whitelist; /* Channels to configure */
253         struct ncsi_channel  *preferred_channel; /* Primary channel      */
254 };
255
256 struct ncsi_request {
257         unsigned char        id;      /* Request ID - 0 to 255           */
258         bool                 used;    /* Request that has been assigned  */
259         unsigned int         flags;   /* NCSI request property           */
260 #define NCSI_REQ_FLAG_EVENT_DRIVEN      1
261 #define NCSI_REQ_FLAG_NETLINK_DRIVEN    2
262         struct ncsi_dev_priv *ndp;    /* Associated NCSI device          */
263         struct sk_buff       *cmd;    /* Associated NCSI command packet  */
264         struct sk_buff       *rsp;    /* Associated NCSI response packet */
265         struct timer_list    timer;   /* Timer on waiting for response   */
266         bool                 enabled; /* Time has been enabled or not    */
267         u32                  snd_seq;     /* netlink sending sequence number */
268         u32                  snd_portid;  /* netlink portid of sender        */
269         struct nlmsghdr      nlhdr;       /* netlink message header          */
270 };
271
272 enum {
273         ncsi_dev_state_major            = 0xff00,
274         ncsi_dev_state_minor            = 0x00ff,
275         ncsi_dev_state_probe_deselect   = 0x0201,
276         ncsi_dev_state_probe_package,
277         ncsi_dev_state_probe_channel,
278         ncsi_dev_state_probe_mlx_gma,
279         ncsi_dev_state_probe_mlx_smaf,
280         ncsi_dev_state_probe_cis,
281         ncsi_dev_state_probe_keep_phy,
282         ncsi_dev_state_probe_gvi,
283         ncsi_dev_state_probe_gc,
284         ncsi_dev_state_probe_gls,
285         ncsi_dev_state_probe_dp,
286         ncsi_dev_state_config_sp        = 0x0301,
287         ncsi_dev_state_config_cis,
288         ncsi_dev_state_config_oem_gma,
289         ncsi_dev_state_config_clear_vids,
290         ncsi_dev_state_config_svf,
291         ncsi_dev_state_config_ev,
292         ncsi_dev_state_config_sma,
293         ncsi_dev_state_config_ebf,
294         ncsi_dev_state_config_dgmf,
295         ncsi_dev_state_config_ecnt,
296         ncsi_dev_state_config_ec,
297         ncsi_dev_state_config_ae,
298         ncsi_dev_state_config_gls,
299         ncsi_dev_state_config_done,
300         ncsi_dev_state_suspend_select   = 0x0401,
301         ncsi_dev_state_suspend_gls,
302         ncsi_dev_state_suspend_dcnt,
303         ncsi_dev_state_suspend_dc,
304         ncsi_dev_state_suspend_deselect,
305         ncsi_dev_state_suspend_done
306 };
307
308 struct vlan_vid {
309         struct list_head list;
310         __be16 proto;
311         u16 vid;
312 };
313
314 struct ncsi_dev_priv {
315         struct ncsi_dev     ndev;            /* Associated NCSI device     */
316         unsigned int        flags;           /* NCSI device flags          */
317 #define NCSI_DEV_PROBED         1            /* Finalized NCSI topology    */
318 #define NCSI_DEV_HWA            2            /* Enabled HW arbitration     */
319 #define NCSI_DEV_RESHUFFLE      4
320 #define NCSI_DEV_RESET          8            /* Reset state of NC          */
321         unsigned int        gma_flag;        /* OEM GMA flag               */
322         spinlock_t          lock;            /* Protect the NCSI device    */
323         unsigned int        package_probe_id;/* Current ID during probe    */
324         unsigned int        package_num;     /* Number of packages         */
325         struct list_head    packages;        /* List of packages           */
326         struct ncsi_channel *hot_channel;    /* Channel was ever active    */
327         struct ncsi_request requests[256];   /* Request table              */
328         unsigned int        request_id;      /* Last used request ID       */
329 #define NCSI_REQ_START_IDX      1
330         unsigned int        pending_req_num; /* Number of pending requests */
331         struct ncsi_package *active_package; /* Currently handled package  */
332         struct ncsi_channel *active_channel; /* Currently handled channel  */
333         struct list_head    channel_queue;   /* Config queue of channels   */
334         struct work_struct  work;            /* For channel management     */
335         struct packet_type  ptype;           /* NCSI packet Rx handler     */
336         struct list_head    node;            /* Form NCSI device list      */
337 #define NCSI_MAX_VLAN_VIDS      15
338         struct list_head    vlan_vids;       /* List of active VLAN IDs */
339
340         bool                multi_package;   /* Enable multiple packages   */
341         bool                mlx_multi_host;  /* Enable multi host Mellanox */
342         u32                 package_whitelist; /* Packages to configure    */
343 };
344
345 struct ncsi_cmd_arg {
346         struct ncsi_dev_priv *ndp;        /* Associated NCSI device        */
347         unsigned char        type;        /* Command in the NCSI packet    */
348         unsigned char        id;          /* Request ID (sequence number)  */
349         unsigned char        package;     /* Destination package ID        */
350         unsigned char        channel;     /* Destination channel ID or 0x1f */
351         unsigned short       payload;     /* Command packet payload length */
352         unsigned int         req_flags;   /* NCSI request properties       */
353         union {
354                 unsigned char  bytes[16]; /* Command packet specific data  */
355                 unsigned short words[8];
356                 unsigned int   dwords[4];
357         };
358         unsigned char        *data;       /* NCSI OEM data                 */
359         struct genl_info     *info;       /* Netlink information           */
360 };
361
362 extern struct list_head ncsi_dev_list;
363 extern spinlock_t ncsi_dev_lock;
364
365 #define TO_NCSI_DEV_PRIV(nd) \
366         container_of(nd, struct ncsi_dev_priv, ndev)
367 #define NCSI_FOR_EACH_DEV(ndp) \
368         list_for_each_entry_rcu(ndp, &ncsi_dev_list, node)
369 #define NCSI_FOR_EACH_PACKAGE(ndp, np) \
370         list_for_each_entry_rcu(np, &ndp->packages, node)
371 #define NCSI_FOR_EACH_CHANNEL(np, nc) \
372         list_for_each_entry_rcu(nc, &np->channels, node)
373
374 /* Resources */
375 int ncsi_reset_dev(struct ncsi_dev *nd);
376 void ncsi_start_channel_monitor(struct ncsi_channel *nc);
377 void ncsi_stop_channel_monitor(struct ncsi_channel *nc);
378 struct ncsi_channel *ncsi_find_channel(struct ncsi_package *np,
379                                        unsigned char id);
380 struct ncsi_channel *ncsi_add_channel(struct ncsi_package *np,
381                                       unsigned char id);
382 struct ncsi_package *ncsi_find_package(struct ncsi_dev_priv *ndp,
383                                        unsigned char id);
384 struct ncsi_package *ncsi_add_package(struct ncsi_dev_priv *ndp,
385                                       unsigned char id);
386 void ncsi_remove_package(struct ncsi_package *np);
387 void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp,
388                                    unsigned char id,
389                                    struct ncsi_package **np,
390                                    struct ncsi_channel **nc);
391 struct ncsi_request *ncsi_alloc_request(struct ncsi_dev_priv *ndp,
392                                         unsigned int req_flags);
393 void ncsi_free_request(struct ncsi_request *nr);
394 struct ncsi_dev *ncsi_find_dev(struct net_device *dev);
395 int ncsi_process_next_channel(struct ncsi_dev_priv *ndp);
396 bool ncsi_channel_has_link(struct ncsi_channel *channel);
397 bool ncsi_channel_is_last(struct ncsi_dev_priv *ndp,
398                           struct ncsi_channel *channel);
399 int ncsi_update_tx_channel(struct ncsi_dev_priv *ndp,
400                            struct ncsi_package *np,
401                            struct ncsi_channel *disable,
402                            struct ncsi_channel *enable);
403
404 /* Packet handlers */
405 u32 ncsi_calculate_checksum(unsigned char *data, int len);
406 int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca);
407 int ncsi_rcv_rsp(struct sk_buff *skb, struct net_device *dev,
408                  struct packet_type *pt, struct net_device *orig_dev);
409 int ncsi_aen_handler(struct ncsi_dev_priv *ndp, struct sk_buff *skb);
410
411 #endif /* __NCSI_INTERNAL_H__ */