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         u8   major;             /* NCSI version major */
 109         u8   minor;             /* NCSI version minor */
 110         u8   update;            /* NCSI version update */
 111         char alpha1;            /* NCSI version alpha1 */
 112         char alpha2;            /* NCSI version alpha2 */
 113         u8  fw_name[12];        /* Firmware name string                */
 114         u32 fw_version;         /* Firmware version                   */
 115         u16 pci_ids[4];         /* PCI identification                 */
 116         u32 mf_id;              /* Manufacture ID                     */
 117 };
 118
 119 struct ncsi_channel_cap {
 120         u32 index;      /* Index of channel capabilities */
 121         u32 cap;        /* NCSI channel capability       */
 122 };
 123
 124 struct ncsi_channel_mode {
 125         u32 index;      /* Index of channel modes      */
 126         u32 enable;     /* Enabled or disabled         */
 127         u32 size;       /* Valid entries in ncm_data[] */
 128         u32 data[8];    /* Data entries                */
 129 };
 130
 131 struct ncsi_channel_mac_filter {
 132         u8      n_uc;
 133         u8      n_mc;
 134         u8      n_mixed;
 135         u64     bitmap;
 136         unsigned char   *addrs;
 137 };
 138
 139 struct ncsi_channel_vlan_filter {
 140         u8      n_vids;
 141         u64     bitmap;
 142         u16     *vids;
 143 };
 144
 145 struct ncsi_channel_stats {
 146         u64 hnc_cnt;            /* Counter cleared            */
 147         u64 hnc_rx_bytes;       /* Rx bytes                   */
 148         u64 hnc_tx_bytes;       /* Tx bytes                   */
 149         u64 hnc_rx_uc_pkts;     /* Rx UC packets              */
 150         u64 hnc_rx_mc_pkts;     /* Rx MC packets              */
 151         u64 hnc_rx_bc_pkts;     /* Rx BC packets              */
 152         u64 hnc_tx_uc_pkts;     /* Tx UC packets              */
 153         u64 hnc_tx_mc_pkts;     /* Tx MC packets              */
 154         u64 hnc_tx_bc_pkts;     /* Tx BC packets              */
 155         u32 hnc_fcs_err;        /* FCS errors                 */
 156         u32 hnc_align_err;      /* Alignment errors           */
 157         u32 hnc_false_carrier;  /* False carrier detection    */
 158         u32 hnc_runt_pkts;      /* Rx runt packets            */
 159         u32 hnc_jabber_pkts;    /* Rx jabber packets          */
 160         u32 hnc_rx_pause_xon;   /* Rx pause XON frames        */
 161         u32 hnc_rx_pause_xoff;  /* Rx XOFF frames             */
 162         u32 hnc_tx_pause_xon;   /* Tx XON frames              */
 163         u32 hnc_tx_pause_xoff;  /* Tx XOFF frames             */
 164         u32 hnc_tx_s_collision; /* Single collision frames    */
 165         u32 hnc_tx_m_collision; /* Multiple collision frames  */
 166         u32 hnc_l_collision;    /* Late collision frames      */
 167         u32 hnc_e_collision;    /* Excessive collision frames */
 168         u32 hnc_rx_ctl_frames;  /* Rx control frames          */
 169         u32 hnc_rx_64_frames;   /* Rx 64-bytes frames         */
 170         u32 hnc_rx_127_frames;  /* Rx 65-127 bytes frames     */
 171         u32 hnc_rx_255_frames;  /* Rx 128-255 bytes frames    */
 172         u32 hnc_rx_511_frames;  /* Rx 256-511 bytes frames    */
 173         u32 hnc_rx_1023_frames; /* Rx 512-1023 bytes frames   */
 174         u32 hnc_rx_1522_frames; /* Rx 1024-1522 bytes frames  */
 175         u32 hnc_rx_9022_frames; /* Rx 1523-9022 bytes frames  */
 176         u32 hnc_tx_64_frames;   /* Tx 64-bytes frames         */
 177         u32 hnc_tx_127_frames;  /* Tx 65-127 bytes frames     */
 178         u32 hnc_tx_255_frames;  /* Tx 128-255 bytes frames    */
 179         u32 hnc_tx_511_frames;  /* Tx 256-511 bytes frames    */
 180         u32 hnc_tx_1023_frames; /* Tx 512-1023 bytes frames   */
 181         u32 hnc_tx_1522_frames; /* Tx 1024-1522 bytes frames  */
 182         u32 hnc_tx_9022_frames; /* Tx 1523-9022 bytes frames  */
 183         u64 hnc_rx_valid_bytes; /* Rx valid bytes             */
 184         u32 hnc_rx_runt_pkts;   /* Rx error runt packets      */
 185         u32 hnc_rx_jabber_pkts; /* Rx error jabber packets    */
 186         u32 ncsi_rx_cmds;       /* Rx NCSI commands           */
 187         u32 ncsi_dropped_cmds;  /* Dropped commands           */
 188         u32 ncsi_cmd_type_errs; /* Command type errors        */
 189         u32 ncsi_cmd_csum_errs; /* Command checksum errors    */
 190         u32 ncsi_rx_pkts;       /* Rx NCSI packets            */
 191         u32 ncsi_tx_pkts;       /* Tx NCSI packets            */
 192         u32 ncsi_tx_aen_pkts;   /* Tx AEN packets             */
 193         u32 pt_tx_pkts;         /* Tx packets                 */
 194         u32 pt_tx_dropped;      /* Tx dropped packets         */
 195         u32 pt_tx_channel_err;  /* Tx channel errors          */
 196         u32 pt_tx_us_err;       /* Tx undersize errors        */
 197         u32 pt_rx_pkts;         /* Rx packets                 */
 198         u32 pt_rx_dropped;      /* Rx dropped packets         */
 199         u32 pt_rx_channel_err;  /* Rx channel errors          */
 200         u32 pt_rx_us_err;       /* Rx undersize errors        */
 201         u32 pt_rx_os_err;       /* Rx oversize errors         */
 202 };
 203
 204 struct ncsi_dev_priv;
 205 struct ncsi_package;
 206
 207 #define NCSI_PACKAGE_SHIFT      5
 208 #define NCSI_PACKAGE_INDEX(c)   (((c) >> NCSI_PACKAGE_SHIFT) & 0x7)
 209 #define NCSI_RESERVED_CHANNEL   0x1f
 210 #define NCSI_CHANNEL_INDEX(c)   ((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1))
 211 #define NCSI_TO_CHANNEL(p, c)   (((p) << NCSI_PACKAGE_SHIFT) | (c))
 212 #define NCSI_MAX_PACKAGE        8
 213 #define NCSI_MAX_CHANNEL        32
 214
 215 struct ncsi_channel {
 216         unsigned char               id;
 217         int                         state;
 218 #define NCSI_CHANNEL_INACTIVE           1
 219 #define NCSI_CHANNEL_ACTIVE             2
 220 #define NCSI_CHANNEL_INVISIBLE          3
 221         bool                        reconfigure_needed;
 222         spinlock_t                  lock;       /* Protect filters etc */
 223         struct ncsi_package         *package;
 224         struct ncsi_channel_version version;
 225         struct ncsi_channel_cap     caps[NCSI_CAP_MAX];
 226         struct ncsi_channel_mode    modes[NCSI_MODE_MAX];
 227         /* Filtering Settings */
 228         struct ncsi_channel_mac_filter  mac_filter;
 229         struct ncsi_channel_vlan_filter vlan_filter;
 230         struct ncsi_channel_stats   stats;
 231         struct {
 232                 struct timer_list   timer;
 233                 bool                enabled;
 234                 unsigned int        state;
 235 #define NCSI_CHANNEL_MONITOR_START      0
 236 #define NCSI_CHANNEL_MONITOR_RETRY      1
 237 #define NCSI_CHANNEL_MONITOR_WAIT       2
 238 #define NCSI_CHANNEL_MONITOR_WAIT_MAX   5
 239         } monitor;
 240         struct list_head            node;
 241         struct list_head            link;
 242 };
 243
 244 struct ncsi_package {
 245         unsigned char        id;          /* NCSI 3-bits package ID */
 246         unsigned char        uuid[16];    /* UUID                   */
 247         struct ncsi_dev_priv *ndp;        /* NCSI device            */
 248         spinlock_t           lock;        /* Protect the package    */
 249         unsigned int         channel_num; /* Number of channels     */
 250         struct list_head     channels;    /* List of channels        */
 251         struct list_head     node;        /* Form list of packages  */
 252
 253         bool                 multi_channel; /* Enable multiple channels  */
 254         u32                  channel_whitelist; /* Channels to configure */
 255         struct ncsi_channel  *preferred_channel; /* Primary channel      */
 256 };
 257
 258 struct ncsi_request {
 259         unsigned char        id;      /* Request ID - 0 to 255           */
 260         bool                 used;    /* Request that has been assigned  */
 261         unsigned int         flags;   /* NCSI request property           */
 262 #define NCSI_REQ_FLAG_EVENT_DRIVEN      1
 263 #define NCSI_REQ_FLAG_NETLINK_DRIVEN    2
 264         struct ncsi_dev_priv *ndp;    /* Associated NCSI device          */
 265         struct sk_buff       *cmd;    /* Associated NCSI command packet  */
 266         struct sk_buff       *rsp;    /* Associated NCSI response packet */
 267         struct timer_list    timer;   /* Timer on waiting for response   */
 268         bool                 enabled; /* Time has been enabled or not    */
 269         u32                  snd_seq;     /* netlink sending sequence number */
 270         u32                  snd_portid;  /* netlink portid of sender        */
 271         struct nlmsghdr      nlhdr;       /* netlink message header          */
 272 };
 273
 274 enum {
 275         ncsi_dev_state_major            = 0xff00,
 276         ncsi_dev_state_minor            = 0x00ff,
 277         ncsi_dev_state_probe_deselect   = 0x0201,
 278         ncsi_dev_state_probe_package,
 279         ncsi_dev_state_probe_channel,
 280         ncsi_dev_state_probe_mlx_gma,
 281         ncsi_dev_state_probe_mlx_smaf,
 282         ncsi_dev_state_probe_cis,
 283         ncsi_dev_state_probe_keep_phy,
 284         ncsi_dev_state_probe_gvi,
 285         ncsi_dev_state_probe_gc,
 286         ncsi_dev_state_probe_gls,
 287         ncsi_dev_state_probe_dp,
 288         ncsi_dev_state_config_sp        = 0x0301,
 289         ncsi_dev_state_config_cis,
 290         ncsi_dev_state_config_oem_gma,
 291         ncsi_dev_state_config_apply_mac,
 292         ncsi_dev_state_config_clear_vids,
 293         ncsi_dev_state_config_svf,
 294         ncsi_dev_state_config_ev,
 295         ncsi_dev_state_config_sma,
 296         ncsi_dev_state_config_ebf,
 297         ncsi_dev_state_config_dgmf,
 298         ncsi_dev_state_config_ecnt,
 299         ncsi_dev_state_config_ec,
 300         ncsi_dev_state_config_ae,
 301         ncsi_dev_state_config_gls,
 302         ncsi_dev_state_config_done,
 303         ncsi_dev_state_suspend_select   = 0x0401,
 304         ncsi_dev_state_suspend_gls,
 305         ncsi_dev_state_suspend_dcnt,
 306         ncsi_dev_state_suspend_dc,
 307         ncsi_dev_state_suspend_deselect,
 308         ncsi_dev_state_suspend_done
 309 };
 310
 311 struct vlan_vid {
 312         struct list_head list;
 313         __be16 proto;
 314         u16 vid;
 315 };
 316
 317 struct ncsi_dev_priv {
 318         struct ncsi_dev     ndev;            /* Associated NCSI device     */
 319         unsigned int        flags;           /* NCSI device flags          */
 320 #define NCSI_DEV_PROBED         1            /* Finalized NCSI topology    */
 321 #define NCSI_DEV_HWA            2            /* Enabled HW arbitration     */
 322 #define NCSI_DEV_RESHUFFLE      4
 323 #define NCSI_DEV_RESET          8            /* Reset state of NC          */
 324         unsigned int        gma_flag;        /* OEM GMA flag               */
 325         struct sockaddr_storage pending_mac; /* MAC address received from GMA */
 326         spinlock_t          lock;            /* Protect the NCSI device    */
 327         unsigned int        package_probe_id;/* Current ID during probe    */
 328         unsigned int        package_num;     /* Number of packages         */
 329         unsigned int        channel_probe_id;/* Current cahnnel ID during probe */
 330         struct list_head    packages;        /* List of packages           */
 331         struct ncsi_channel *hot_channel;    /* Channel was ever active    */
 332         struct ncsi_request requests[256];   /* Request table              */
 333         unsigned int        request_id;      /* Last used request ID       */
 334 #define NCSI_REQ_START_IDX      1
 335         unsigned int        pending_req_num; /* Number of pending requests */
 336         struct ncsi_package *active_package; /* Currently handled package  */
 337         struct ncsi_channel *active_channel; /* Currently handled channel  */
 338         struct list_head    channel_queue;   /* Config queue of channels   */
 339         struct work_struct  work;            /* For channel management     */
 340         struct packet_type  ptype;           /* NCSI packet Rx handler     */
 341         struct list_head    node;            /* Form NCSI device list      */
 342 #define NCSI_MAX_VLAN_VIDS      15
 343         struct list_head    vlan_vids;       /* List of active VLAN IDs */
 344
 345         bool                multi_package;   /* Enable multiple packages   */
 346         bool                mlx_multi_host;  /* Enable multi host Mellanox */
 347         u32                 package_whitelist; /* Packages to configure    */
 348         unsigned char       channel_count;     /* Num of channels to probe   */
 349 };
 350
 351 struct ncsi_cmd_arg {
 352         struct ncsi_dev_priv *ndp;        /* Associated NCSI device        */
 353         unsigned char        type;        /* Command in the NCSI packet    */
 354         unsigned char        id;          /* Request ID (sequence number)  */
 355         unsigned char        package;     /* Destination package ID        */
 356         unsigned char        channel;     /* Destination channel ID or 0x1f */
 357         unsigned short       payload;     /* Command packet payload length */
 358         unsigned int         req_flags;   /* NCSI request properties       */
 359         union {
 360                 unsigned char  bytes[16]; /* Command packet specific data  */
 361                 unsigned short words[8];
 362                 unsigned int   dwords[4];
 363         };
 364         unsigned char        *data;       /* NCSI OEM data                 */
 365         struct genl_info     *info;       /* Netlink information           */
 366 };
 367
 368 extern struct list_head ncsi_dev_list;
 369 extern spinlock_t ncsi_dev_lock;
 370
 371 #define TO_NCSI_DEV_PRIV(nd) \
 372         container_of(nd, struct ncsi_dev_priv, ndev)
 373 #define NCSI_FOR_EACH_DEV(ndp) \
 374         list_for_each_entry_rcu(ndp, &ncsi_dev_list, node)
 375 #define NCSI_FOR_EACH_PACKAGE(ndp, np) \
 376         list_for_each_entry_rcu(np, &ndp->packages, node)
 377 #define NCSI_FOR_EACH_CHANNEL(np, nc) \
 378         list_for_each_entry_rcu(nc, &np->channels, node)
 379
 380 /* Resources */
 381 int ncsi_reset_dev(struct ncsi_dev *nd);
 382 void ncsi_start_channel_monitor(struct ncsi_channel *nc);
 383 void ncsi_stop_channel_monitor(struct ncsi_channel *nc);
 384 struct ncsi_channel *ncsi_find_channel(struct ncsi_package *np,
 385                                        unsigned char id);
 386 struct ncsi_channel *ncsi_add_channel(struct ncsi_package *np,
 387                                       unsigned char id);
 388 struct ncsi_package *ncsi_find_package(struct ncsi_dev_priv *ndp,
 389                                        unsigned char id);
 390 struct ncsi_package *ncsi_add_package(struct ncsi_dev_priv *ndp,
 391                                       unsigned char id);
 392 void ncsi_remove_package(struct ncsi_package *np);
 393 void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp,
 394                                    unsigned char id,
 395                                    struct ncsi_package **np,
 396                                    struct ncsi_channel **nc);
 397 struct ncsi_request *ncsi_alloc_request(struct ncsi_dev_priv *ndp,
 398                                         unsigned int req_flags);
 399 void ncsi_free_request(struct ncsi_request *nr);
 400 struct ncsi_dev *ncsi_find_dev(struct net_device *dev);
 401 int ncsi_process_next_channel(struct ncsi_dev_priv *ndp);
 402 bool ncsi_channel_has_link(struct ncsi_channel *channel);
 403 bool ncsi_channel_is_last(struct ncsi_dev_priv *ndp,
 404                           struct ncsi_channel *channel);
 405 int ncsi_update_tx_channel(struct ncsi_dev_priv *ndp,
 406                            struct ncsi_package *np,
 407                            struct ncsi_channel *disable,
 408                            struct ncsi_channel *enable);
 409
 410 /* Packet handlers */
 411 u32 ncsi_calculate_checksum(unsigned char *data, int len);
 412 int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca);
 413 int ncsi_rcv_rsp(struct sk_buff *skb, struct net_device *dev,
 414                  struct packet_type *pt, struct net_device *orig_dev);
 415 int ncsi_aen_handler(struct ncsi_dev_priv *ndp, struct sk_buff *skb);
 416
 417 #endif /* __NCSI_INTERNAL_H__ */