LXR linux/net/ncsi/internal.h

   1/*
   2 * Copyright Gavin Shan, IBM Corporation 2016.
   3 *
   4 * This program is free software; you can redistribute it and/or modify
   5 * it under the terms of the GNU General Public License as published by
   6 * the Free Software Foundation; either version 2 of the License, or
   7 * (at your option) any later version.
   8 */
   9
  10#ifndef __NCSI_INTERNAL_H__
  11#define __NCSI_INTERNAL_H__
  12
  13enum {
  14        NCSI_CAP_BASE           = 0,
  15        NCSI_CAP_GENERIC        = 0,
  16        NCSI_CAP_BC,
  17        NCSI_CAP_MC,
  18        NCSI_CAP_BUFFER,
  19        NCSI_CAP_AEN,
  20        NCSI_CAP_VLAN,
  21        NCSI_CAP_MAX
  22};
  23
  24enum {
  25        NCSI_CAP_GENERIC_HWA             = 0x01, /* HW arbitration           */
  26        NCSI_CAP_GENERIC_HDS             = 0x02, /* HNC driver status change */
  27        NCSI_CAP_GENERIC_FC              = 0x04, /* HNC to MC flow control   */
  28        NCSI_CAP_GENERIC_FC1             = 0x08, /* MC to HNC flow control   */
  29        NCSI_CAP_GENERIC_MC              = 0x10, /* Global MC filtering      */
  30        NCSI_CAP_GENERIC_HWA_UNKNOWN     = 0x00, /* Unknown HW arbitration   */
  31        NCSI_CAP_GENERIC_HWA_SUPPORT     = 0x20, /* Supported HW arbitration */
  32        NCSI_CAP_GENERIC_HWA_NOT_SUPPORT = 0x40, /* No HW arbitration        */
  33        NCSI_CAP_GENERIC_HWA_RESERVED    = 0x60, /* Reserved HW arbitration  */
  34        NCSI_CAP_GENERIC_HWA_MASK        = 0x60, /* Mask for HW arbitration  */
  35        NCSI_CAP_GENERIC_MASK            = 0x7f,
  36        NCSI_CAP_BC_ARP                  = 0x01, /* ARP packet filtering     */
  37        NCSI_CAP_BC_DHCPC                = 0x02, /* DHCP client filtering    */
  38        NCSI_CAP_BC_DHCPS                = 0x04, /* DHCP server filtering    */
  39        NCSI_CAP_BC_NETBIOS              = 0x08, /* NetBIOS packet filtering */
  40        NCSI_CAP_BC_MASK                 = 0x0f,
  41        NCSI_CAP_MC_IPV6_NEIGHBOR        = 0x01, /* IPv6 neighbor filtering  */
  42        NCSI_CAP_MC_IPV6_ROUTER          = 0x02, /* IPv6 router filering     */
  43        NCSI_CAP_MC_DHCPV6_RELAY         = 0x04, /* DHCPv6 relay / server MC */
  44        NCSI_CAP_MC_DHCPV6_WELL_KNOWN    = 0x08, /* DHCPv6 well-known MC     */
  45        NCSI_CAP_MC_IPV6_MLD             = 0x10, /* IPv6 MLD filtering       */
  46        NCSI_CAP_MC_IPV6_NEIGHBOR_S      = 0x20, /* IPv6 neighbour filtering */
  47        NCSI_CAP_MC_MASK                 = 0x3f,
  48        NCSI_CAP_AEN_LSC                 = 0x01, /* Link status change       */
  49        NCSI_CAP_AEN_CR                  = 0x02, /* Configuration required   */
  50        NCSI_CAP_AEN_HDS                 = 0x04, /* HNC driver status        */
  51        NCSI_CAP_AEN_MASK                = 0x07,
  52        NCSI_CAP_VLAN_ONLY               = 0x01, /* Filter VLAN packet only  */
  53        NCSI_CAP_VLAN_NO                 = 0x02, /* Filter VLAN and non-VLAN */
  54        NCSI_CAP_VLAN_ANY                = 0x04, /* Filter Any-and-non-VLAN  */
  55        NCSI_CAP_VLAN_MASK               = 0x07
  56};
  57
  58enum {
  59        NCSI_MODE_BASE          = 0,
  60        NCSI_MODE_ENABLE        = 0,
  61        NCSI_MODE_TX_ENABLE,
  62        NCSI_MODE_LINK,
  63        NCSI_MODE_VLAN,
  64        NCSI_MODE_BC,
  65        NCSI_MODE_MC,
  66        NCSI_MODE_AEN,
  67        NCSI_MODE_FC,
  68        NCSI_MODE_MAX
  69};
  70
  71struct ncsi_channel_version {
  72        u32 version;            /* Supported BCD encoded NCSI version */
  73        u32 alpha2;             /* Supported BCD encoded NCSI version */
  74        u8  fw_name[12];        /* Firware name string                */
  75        u32 fw_version;         /* Firmware version                   */
  76        u16 pci_ids[4];         /* PCI identification                 */
  77        u32 mf_id;              /* Manufacture ID                     */
  78};
  79
  80struct ncsi_channel_cap {
  81        u32 index;      /* Index of channel capabilities */
  82        u32 cap;        /* NCSI channel capability       */
  83};
  84
  85struct ncsi_channel_mode {
  86        u32 index;      /* Index of channel modes      */
  87        u32 enable;     /* Enabled or disabled         */
  88        u32 size;       /* Valid entries in ncm_data[] */
  89        u32 data[8];    /* Data entries                */
  90};
  91
  92struct ncsi_channel_mac_filter {
  93        u8      n_uc;
  94        u8      n_mc;
  95        u8      n_mixed;
  96        u64     bitmap;
  97        unsigned char   *addrs;
  98};
  99
 100struct ncsi_channel_vlan_filter {
 101        u8      n_vids;
 102        u64     bitmap;
 103        u16     *vids;
 104};
 105
 106struct ncsi_channel_stats {
 107        u32 hnc_cnt_hi;         /* Counter cleared            */
 108        u32 hnc_cnt_lo;         /* Counter cleared            */
 109        u32 hnc_rx_bytes;       /* Rx bytes                   */
 110        u32 hnc_tx_bytes;       /* Tx bytes                   */
 111        u32 hnc_rx_uc_pkts;     /* Rx UC packets              */
 112        u32 hnc_rx_mc_pkts;     /* Rx MC packets              */
 113        u32 hnc_rx_bc_pkts;     /* Rx BC packets              */
 114        u32 hnc_tx_uc_pkts;     /* Tx UC packets              */
 115        u32 hnc_tx_mc_pkts;     /* Tx MC packets              */
 116        u32 hnc_tx_bc_pkts;     /* Tx BC packets              */
 117        u32 hnc_fcs_err;        /* FCS errors                 */
 118        u32 hnc_align_err;      /* Alignment errors           */
 119        u32 hnc_false_carrier;  /* False carrier detection    */
 120        u32 hnc_runt_pkts;      /* Rx runt packets            */
 121        u32 hnc_jabber_pkts;    /* Rx jabber packets          */
 122        u32 hnc_rx_pause_xon;   /* Rx pause XON frames        */
 123        u32 hnc_rx_pause_xoff;  /* Rx XOFF frames             */
 124        u32 hnc_tx_pause_xon;   /* Tx XON frames              */
 125        u32 hnc_tx_pause_xoff;  /* Tx XOFF frames             */
 126        u32 hnc_tx_s_collision; /* Single collision frames    */
 127        u32 hnc_tx_m_collision; /* Multiple collision frames  */
 128        u32 hnc_l_collision;    /* Late collision frames      */
 129        u32 hnc_e_collision;    /* Excessive collision frames */
 130        u32 hnc_rx_ctl_frames;  /* Rx control frames          */
 131        u32 hnc_rx_64_frames;   /* Rx 64-bytes frames         */
 132        u32 hnc_rx_127_frames;  /* Rx 65-127 bytes frames     */
 133        u32 hnc_rx_255_frames;  /* Rx 128-255 bytes frames    */
 134        u32 hnc_rx_511_frames;  /* Rx 256-511 bytes frames    */
 135        u32 hnc_rx_1023_frames; /* Rx 512-1023 bytes frames   */
 136        u32 hnc_rx_1522_frames; /* Rx 1024-1522 bytes frames  */
 137        u32 hnc_rx_9022_frames; /* Rx 1523-9022 bytes frames  */
 138        u32 hnc_tx_64_frames;   /* Tx 64-bytes frames         */
 139        u32 hnc_tx_127_frames;  /* Tx 65-127 bytes frames     */
 140        u32 hnc_tx_255_frames;  /* Tx 128-255 bytes frames    */
 141        u32 hnc_tx_511_frames;  /* Tx 256-511 bytes frames    */
 142        u32 hnc_tx_1023_frames; /* Tx 512-1023 bytes frames   */
 143        u32 hnc_tx_1522_frames; /* Tx 1024-1522 bytes frames  */
 144        u32 hnc_tx_9022_frames; /* Tx 1523-9022 bytes frames  */
 145        u32 hnc_rx_valid_bytes; /* Rx valid bytes             */
 146        u32 hnc_rx_runt_pkts;   /* Rx error runt packets      */
 147        u32 hnc_rx_jabber_pkts; /* Rx error jabber packets    */
 148        u32 ncsi_rx_cmds;       /* Rx NCSI commands           */
 149        u32 ncsi_dropped_cmds;  /* Dropped commands           */
 150        u32 ncsi_cmd_type_errs; /* Command type errors        */
 151        u32 ncsi_cmd_csum_errs; /* Command checksum errors    */
 152        u32 ncsi_rx_pkts;       /* Rx NCSI packets            */
 153        u32 ncsi_tx_pkts;       /* Tx NCSI packets            */
 154        u32 ncsi_tx_aen_pkts;   /* Tx AEN packets             */
 155        u32 pt_tx_pkts;         /* Tx packets                 */
 156        u32 pt_tx_dropped;      /* Tx dropped packets         */
 157        u32 pt_tx_channel_err;  /* Tx channel errors          */
 158        u32 pt_tx_us_err;       /* Tx undersize errors        */
 159        u32 pt_rx_pkts;         /* Rx packets                 */
 160        u32 pt_rx_dropped;      /* Rx dropped packets         */
 161        u32 pt_rx_channel_err;  /* Rx channel errors          */
 162        u32 pt_rx_us_err;       /* Rx undersize errors        */
 163        u32 pt_rx_os_err;       /* Rx oversize errors         */
 164};
 165
 166struct ncsi_dev_priv;
 167struct ncsi_package;
 168
 169#define NCSI_PACKAGE_SHIFT      5
 170#define NCSI_PACKAGE_INDEX(c)   (((c) >> NCSI_PACKAGE_SHIFT) & 0x7)
 171#define NCSI_RESERVED_CHANNEL   0x1f
 172#define NCSI_CHANNEL_INDEX(c)   ((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1))
 173#define NCSI_TO_CHANNEL(p, c)   (((p) << NCSI_PACKAGE_SHIFT) | (c))
 174
 175struct ncsi_channel {
 176        unsigned char               id;
 177        int                         state;
 178#define NCSI_CHANNEL_INACTIVE           1
 179#define NCSI_CHANNEL_ACTIVE             2
 180#define NCSI_CHANNEL_INVISIBLE          3
 181        bool                        reconfigure_needed;
 182        spinlock_t                  lock;       /* Protect filters etc */
 183        struct ncsi_package         *package;
 184        struct ncsi_channel_version version;
 185        struct ncsi_channel_cap     caps[NCSI_CAP_MAX];
 186        struct ncsi_channel_mode    modes[NCSI_MODE_MAX];
 187        /* Filtering Settings */
 188        struct ncsi_channel_mac_filter  mac_filter;
 189        struct ncsi_channel_vlan_filter vlan_filter;
 190        struct ncsi_channel_stats   stats;
 191        struct {
 192                struct timer_list   timer;
 193                bool                enabled;
 194                unsigned int        state;
 195#define NCSI_CHANNEL_MONITOR_START      0
 196#define NCSI_CHANNEL_MONITOR_RETRY      1
 197#define NCSI_CHANNEL_MONITOR_WAIT       2
 198#define NCSI_CHANNEL_MONITOR_WAIT_MAX   5
 199        } monitor;
 200        struct list_head            node;
 201        struct list_head            link;
 202};
 203
 204struct ncsi_package {
 205        unsigned char        id;          /* NCSI 3-bits package ID */
 206        unsigned char        uuid[16];    /* UUID                   */
 207        struct ncsi_dev_priv *ndp;        /* NCSI device            */
 208        spinlock_t           lock;        /* Protect the package    */
 209        unsigned int         channel_num; /* Number of channels     */
 210        struct list_head     channels;    /* List of chanels        */
 211        struct list_head     node;        /* Form list of packages  */
 212};
 213
 214struct ncsi_request {
 215        unsigned char        id;      /* Request ID - 0 to 255           */
 216        bool                 used;    /* Request that has been assigned  */
 217        unsigned int         flags;   /* NCSI request property           */
 218#define NCSI_REQ_FLAG_EVENT_DRIVEN      1
 219        struct ncsi_dev_priv *ndp;    /* Associated NCSI device          */
 220        struct sk_buff       *cmd;    /* Associated NCSI command packet  */
 221        struct sk_buff       *rsp;    /* Associated NCSI response packet */
 222        struct timer_list    timer;   /* Timer on waiting for response   */
 223        bool                 enabled; /* Time has been enabled or not    */
 224};
 225
 226enum {
 227        ncsi_dev_state_major            = 0xff00,
 228        ncsi_dev_state_minor            = 0x00ff,
 229        ncsi_dev_state_probe_deselect   = 0x0201,
 230        ncsi_dev_state_probe_package,
 231        ncsi_dev_state_probe_channel,
 232        ncsi_dev_state_probe_cis,
 233        ncsi_dev_state_probe_gvi,
 234        ncsi_dev_state_probe_gc,
 235        ncsi_dev_state_probe_gls,
 236        ncsi_dev_state_probe_dp,
 237        ncsi_dev_state_config_sp        = 0x0301,
 238        ncsi_dev_state_config_cis,
 239        ncsi_dev_state_config_clear_vids,
 240        ncsi_dev_state_config_svf,
 241        ncsi_dev_state_config_ev,
 242        ncsi_dev_state_config_sma,
 243        ncsi_dev_state_config_ebf,
 244#if IS_ENABLED(CONFIG_IPV6)
 245        ncsi_dev_state_config_egmf,
 246#endif
 247        ncsi_dev_state_config_ecnt,
 248        ncsi_dev_state_config_ec,
 249        ncsi_dev_state_config_ae,
 250        ncsi_dev_state_config_gls,
 251        ncsi_dev_state_config_done,
 252        ncsi_dev_state_suspend_select   = 0x0401,
 253        ncsi_dev_state_suspend_gls,
 254        ncsi_dev_state_suspend_dcnt,
 255        ncsi_dev_state_suspend_dc,
 256        ncsi_dev_state_suspend_deselect,
 257        ncsi_dev_state_suspend_done
 258};
 259
 260struct vlan_vid {
 261        struct list_head list;
 262        __be16 proto;
 263        u16 vid;
 264};
 265
 266struct ncsi_dev_priv {
 267        struct ncsi_dev     ndev;            /* Associated NCSI device     */
 268        unsigned int        flags;           /* NCSI device flags          */
 269#define NCSI_DEV_PROBED         1            /* Finalized NCSI topology    */
 270#define NCSI_DEV_HWA            2            /* Enabled HW arbitration     */
 271#define NCSI_DEV_RESHUFFLE      4
 272        spinlock_t          lock;            /* Protect the NCSI device    */
 273#if IS_ENABLED(CONFIG_IPV6)
 274        unsigned int        inet6_addr_num;  /* Number of IPv6 addresses   */
 275#endif
 276        unsigned int        package_num;     /* Number of packages         */
 277        struct list_head    packages;        /* List of packages           */
 278        struct ncsi_channel *hot_channel;    /* Channel was ever active    */
 279        struct ncsi_package *force_package;  /* Force a specific package   */
 280        struct ncsi_channel *force_channel;  /* Force a specific channel   */
 281        struct ncsi_request requests[256];   /* Request table              */
 282        unsigned int        request_id;      /* Last used request ID       */
 283#define NCSI_REQ_START_IDX      1
 284        unsigned int        pending_req_num; /* Number of pending requests */
 285        struct ncsi_package *active_package; /* Currently handled package  */
 286        struct ncsi_channel *active_channel; /* Currently handled channel  */
 287        struct list_head    channel_queue;   /* Config queue of channels   */
 288        struct work_struct  work;            /* For channel management     */
 289        struct packet_type  ptype;           /* NCSI packet Rx handler     */
 290        struct list_head    node;            /* Form NCSI device list      */
 291#define NCSI_MAX_VLAN_VIDS      15
 292        struct list_head    vlan_vids;       /* List of active VLAN IDs */
 293};
 294
 295struct ncsi_cmd_arg {
 296        struct ncsi_dev_priv *ndp;        /* Associated NCSI device        */
 297        unsigned char        type;        /* Command in the NCSI packet    */
 298        unsigned char        id;          /* Request ID (sequence number)  */
 299        unsigned char        package;     /* Destination package ID        */
 300        unsigned char        channel;     /* Detination channel ID or 0x1f */
 301        unsigned short       payload;     /* Command packet payload length */
 302        unsigned int         req_flags;   /* NCSI request properties       */
 303        union {
 304                unsigned char  bytes[16]; /* Command packet specific data  */
 305                unsigned short words[8];
 306                unsigned int   dwords[4];
 307        };
 308};
 309
 310extern struct list_head ncsi_dev_list;
 311extern spinlock_t ncsi_dev_lock;
 312
 313#define TO_NCSI_DEV_PRIV(nd) \
 314        container_of(nd, struct ncsi_dev_priv, ndev)
 315#define NCSI_FOR_EACH_DEV(ndp) \
 316        list_for_each_entry_rcu(ndp, &ncsi_dev_list, node)
 317#define NCSI_FOR_EACH_PACKAGE(ndp, np) \
 318        list_for_each_entry_rcu(np, &ndp->packages, node)
 319#define NCSI_FOR_EACH_CHANNEL(np, nc) \
 320        list_for_each_entry_rcu(nc, &np->channels, node)
 321
 322/* Resources */
 323void ncsi_start_channel_monitor(struct ncsi_channel *nc);
 324void ncsi_stop_channel_monitor(struct ncsi_channel *nc);
 325struct ncsi_channel *ncsi_find_channel(struct ncsi_package *np,
 326                                       unsigned char id);
 327struct ncsi_channel *ncsi_add_channel(struct ncsi_package *np,
 328                                      unsigned char id);
 329struct ncsi_package *ncsi_find_package(struct ncsi_dev_priv *ndp,
 330                                       unsigned char id);
 331struct ncsi_package *ncsi_add_package(struct ncsi_dev_priv *ndp,
 332                                      unsigned char id);
 333void ncsi_remove_package(struct ncsi_package *np);
 334void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp,
 335                                   unsigned char id,
 336                                   struct ncsi_package **np,
 337                                   struct ncsi_channel **nc);
 338struct ncsi_request *ncsi_alloc_request(struct ncsi_dev_priv *ndp,
 339                                        unsigned int req_flags);
 340void ncsi_free_request(struct ncsi_request *nr);
 341struct ncsi_dev *ncsi_find_dev(struct net_device *dev);
 342int ncsi_process_next_channel(struct ncsi_dev_priv *ndp);
 343
 344/* Packet handlers */
 345u32 ncsi_calculate_checksum(unsigned char *data, int len);
 346int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca);
 347int ncsi_rcv_rsp(struct sk_buff *skb, struct net_device *dev,
 348                 struct packet_type *pt, struct net_device *orig_dev);
 349int ncsi_aen_handler(struct ncsi_dev_priv *ndp, struct sk_buff *skb);
 350
 351#endif /* __NCSI_INTERNAL_H__ */
 352