linux/drivers/s390/net/qeth_core.h
<<
>>
Prefs
   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 *    Copyright IBM Corp. 2007
   4 *    Author(s): Utz Bacher <utz.bacher@de.ibm.com>,
   5 *               Frank Pavlic <fpavlic@de.ibm.com>,
   6 *               Thomas Spatzier <tspat@de.ibm.com>,
   7 *               Frank Blaschka <frank.blaschka@de.ibm.com>
   8 */
   9
  10#ifndef __QETH_CORE_H__
  11#define __QETH_CORE_H__
  12
  13#include <linux/completion.h>
  14#include <linux/debugfs.h>
  15#include <linux/if.h>
  16#include <linux/if_arp.h>
  17#include <linux/etherdevice.h>
  18#include <linux/if_vlan.h>
  19#include <linux/ctype.h>
  20#include <linux/in6.h>
  21#include <linux/bitops.h>
  22#include <linux/seq_file.h>
  23#include <linux/hashtable.h>
  24#include <linux/ip.h>
  25#include <linux/rcupdate.h>
  26#include <linux/refcount.h>
  27#include <linux/timer.h>
  28#include <linux/types.h>
  29#include <linux/wait.h>
  30#include <linux/workqueue.h>
  31
  32#include <net/dst.h>
  33#include <net/ip6_fib.h>
  34#include <net/ipv6.h>
  35#include <net/if_inet6.h>
  36#include <net/addrconf.h>
  37#include <net/route.h>
  38#include <net/sch_generic.h>
  39#include <net/tcp.h>
  40
  41#include <asm/debug.h>
  42#include <asm/qdio.h>
  43#include <asm/ccwdev.h>
  44#include <asm/ccwgroup.h>
  45#include <asm/sysinfo.h>
  46
  47#include <uapi/linux/if_link.h>
  48
  49#include "qeth_core_mpc.h"
  50
  51/**
  52 * Debug Facility stuff
  53 */
  54enum qeth_dbf_names {
  55        QETH_DBF_SETUP,
  56        QETH_DBF_MSG,
  57        QETH_DBF_CTRL,
  58        QETH_DBF_INFOS  /* must be last element */
  59};
  60
  61struct qeth_dbf_info {
  62        char name[DEBUG_MAX_NAME_LEN];
  63        int pages;
  64        int areas;
  65        int len;
  66        int level;
  67        struct debug_view *view;
  68        debug_info_t *id;
  69};
  70
  71#define QETH_DBF_CTRL_LEN 256U
  72
  73#define QETH_DBF_TEXT(name, level, text) \
  74        debug_text_event(qeth_dbf[QETH_DBF_##name].id, level, text)
  75
  76#define QETH_DBF_HEX(name, level, addr, len) \
  77        debug_event(qeth_dbf[QETH_DBF_##name].id, level, (void *)(addr), len)
  78
  79#define QETH_DBF_MESSAGE(level, text...) \
  80        debug_sprintf_event(qeth_dbf[QETH_DBF_MSG].id, level, text)
  81
  82#define QETH_DBF_TEXT_(name, level, text...) \
  83        qeth_dbf_longtext(qeth_dbf[QETH_DBF_##name].id, level, text)
  84
  85#define QETH_CARD_TEXT(card, level, text) \
  86        debug_text_event(card->debug, level, text)
  87
  88#define QETH_CARD_HEX(card, level, addr, len) \
  89        debug_event(card->debug, level, (void *)(addr), len)
  90
  91#define QETH_CARD_MESSAGE(card, text...) \
  92        debug_sprintf_event(card->debug, level, text)
  93
  94#define QETH_CARD_TEXT_(card, level, text...) \
  95        qeth_dbf_longtext(card->debug, level, text)
  96
  97#define SENSE_COMMAND_REJECT_BYTE 0
  98#define SENSE_COMMAND_REJECT_FLAG 0x80
  99#define SENSE_RESETTING_EVENT_BYTE 1
 100#define SENSE_RESETTING_EVENT_FLAG 0x80
 101
 102static inline u32 qeth_get_device_id(struct ccw_device *cdev)
 103{
 104        struct ccw_dev_id dev_id;
 105        u32 id;
 106
 107        ccw_device_get_id(cdev, &dev_id);
 108        id = dev_id.devno;
 109        id |= (u32) (dev_id.ssid << 16);
 110
 111        return id;
 112}
 113
 114/*
 115 * Common IO related definitions
 116 */
 117#define CARD_RDEV(card) card->read.ccwdev
 118#define CARD_WDEV(card) card->write.ccwdev
 119#define CARD_DDEV(card) card->data.ccwdev
 120#define CARD_BUS_ID(card) dev_name(&card->gdev->dev)
 121#define CARD_RDEV_ID(card) dev_name(&card->read.ccwdev->dev)
 122#define CARD_WDEV_ID(card) dev_name(&card->write.ccwdev->dev)
 123#define CARD_DDEV_ID(card) dev_name(&card->data.ccwdev->dev)
 124#define CCW_DEVID(cdev)         (qeth_get_device_id(cdev))
 125#define CARD_DEVID(card)        (CCW_DEVID(CARD_RDEV(card)))
 126
 127/* Routing stuff */
 128struct qeth_routing_info {
 129        enum qeth_routing_types type;
 130};
 131
 132/* SETBRIDGEPORT stuff */
 133enum qeth_sbp_roles {
 134        QETH_SBP_ROLE_NONE      = 0,
 135        QETH_SBP_ROLE_PRIMARY   = 1,
 136        QETH_SBP_ROLE_SECONDARY = 2,
 137};
 138
 139enum qeth_sbp_states {
 140        QETH_SBP_STATE_INACTIVE = 0,
 141        QETH_SBP_STATE_STANDBY  = 1,
 142        QETH_SBP_STATE_ACTIVE   = 2,
 143};
 144
 145#define QETH_SBP_HOST_NOTIFICATION 1
 146
 147struct qeth_sbp_info {
 148        __u32 supported_funcs;
 149        enum qeth_sbp_roles role;
 150        __u32 hostnotification:1;
 151        __u32 reflect_promisc:1;
 152        __u32 reflect_promisc_primary:1;
 153};
 154
 155struct qeth_vnicc_info {
 156        /* supported/currently configured VNICCs; updated in IPA exchanges */
 157        u32 sup_chars;
 158        u32 cur_chars;
 159        /* supported commands: bitmasks which VNICCs support respective cmd */
 160        u32 set_char_sup;
 161        u32 getset_timeout_sup;
 162        /* timeout value for the learning characteristic */
 163        u32 learning_timeout;
 164        /* characteristics wanted/configured by user */
 165        u32 wanted_chars;
 166        /* has user explicitly enabled rx_bcast while online? */
 167        bool rx_bcast_enabled;
 168};
 169
 170#define QETH_IDX_FUNC_LEVEL_OSD          0x0101
 171#define QETH_IDX_FUNC_LEVEL_IQD          0x4108
 172
 173#define QETH_BUFSIZE            4096
 174#define CCW_CMD_WRITE           0x01
 175#define CCW_CMD_READ            0x02
 176
 177/**
 178 * some more defs
 179 */
 180#define QETH_TX_TIMEOUT         (100 * HZ)
 181#define QETH_RCD_TIMEOUT        (60 * HZ)
 182#define QETH_RECLAIM_WORK_TIME  HZ
 183#define QETH_MAX_PORTNO         15
 184
 185/*****************************************************************************/
 186/* QDIO queue and buffer handling                                            */
 187/*****************************************************************************/
 188#define QETH_MAX_OUT_QUEUES     4
 189#define QETH_IQD_MIN_TXQ        2       /* One for ucast, one for mcast. */
 190#define QETH_IQD_MCAST_TXQ      0
 191#define QETH_IQD_MIN_UCAST_TXQ  1
 192
 193#define QETH_MAX_IN_QUEUES      2
 194#define QETH_RX_COPYBREAK      (PAGE_SIZE >> 1)
 195#define QETH_IN_BUF_SIZE_DEFAULT 65536
 196#define QETH_IN_BUF_COUNT_DEFAULT 64
 197#define QETH_IN_BUF_COUNT_HSDEFAULT 128
 198#define QETH_IN_BUF_COUNT_MIN   8U
 199#define QETH_IN_BUF_COUNT_MAX   128U
 200#define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
 201#define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
 202                 ((card)->qdio.in_buf_pool.buf_count / 2)
 203
 204/* buffers we have to be behind before we get a PCI */
 205#define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
 206/*enqueued free buffers left before we get a PCI*/
 207#define QETH_PCI_THRESHOLD_B(card) 0
 208/*not used unless the microcode gets patched*/
 209#define QETH_PCI_TIMER_VALUE(card) 3
 210
 211/* priority queing */
 212#define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
 213#define QETH_DEFAULT_QUEUE    2
 214#define QETH_NO_PRIO_QUEUEING 0
 215#define QETH_PRIO_Q_ING_PREC  1
 216#define QETH_PRIO_Q_ING_TOS   2
 217#define QETH_PRIO_Q_ING_SKB   3
 218#define QETH_PRIO_Q_ING_VLAN  4
 219#define QETH_PRIO_Q_ING_FIXED 5
 220
 221/* Packing */
 222#define QETH_LOW_WATERMARK_PACK  2
 223#define QETH_HIGH_WATERMARK_PACK 5
 224#define QETH_WATERMARK_PACK_FUZZ 1
 225
 226struct qeth_hdr_layer3 {
 227        __u8  id;
 228        __u8  flags;
 229        __u16 inbound_checksum; /*TSO:__u16 seqno */
 230        __u32 token;            /*TSO: __u32 reserved */
 231        __u16 length;
 232        __u8  vlan_prio;
 233        __u8  ext_flags;
 234        __u16 vlan_id;
 235        __u16 frame_offset;
 236        union {
 237                /* TX: */
 238                struct in6_addr addr;
 239                /* RX: */
 240                struct rx {
 241                        u8 res1[2];
 242                        u8 src_mac[6];
 243                        u8 res2[4];
 244                        u16 vlan_id;
 245                        u8 res3[2];
 246                } rx;
 247        } next_hop;
 248};
 249
 250struct qeth_hdr_layer2 {
 251        __u8 id;
 252        __u8 flags[3];
 253        __u8 port_no;
 254        __u8 hdr_length;
 255        __u16 pkt_length;
 256        __u16 seq_no;
 257        __u16 vlan_id;
 258        __u32 reserved;
 259        __u8 reserved2[16];
 260} __attribute__ ((packed));
 261
 262struct qeth_hdr {
 263        union {
 264                struct qeth_hdr_layer2 l2;
 265                struct qeth_hdr_layer3 l3;
 266        } hdr;
 267} __attribute__ ((packed));
 268
 269#define QETH_QIB_PQUE_ORDER_RR          0
 270#define QETH_QIB_PQUE_UNITS_SBAL        2
 271#define QETH_QIB_PQUE_PRIO_DEFAULT      4
 272
 273struct qeth_qib_parms {
 274        char pcit_magic[4];
 275        u32 pcit_a;
 276        u32 pcit_b;
 277        u32 pcit_c;
 278        char blkt_magic[4];
 279        u32 blkt_total;
 280        u32 blkt_inter_packet;
 281        u32 blkt_inter_packet_jumbo;
 282        char pque_magic[4];
 283        u8 pque_order;
 284        u8 pque_units;
 285        u16 reserved;
 286        u32 pque_priority[4];
 287};
 288
 289/*TCP Segmentation Offload header*/
 290struct qeth_hdr_ext_tso {
 291        __u16 hdr_tot_len;
 292        __u8  imb_hdr_no;
 293        __u8  reserved;
 294        __u8  hdr_type;
 295        __u8  hdr_version;
 296        __u16 hdr_len;
 297        __u32 payload_len;
 298        __u16 mss;
 299        __u16 dg_hdr_len;
 300        __u8  padding[16];
 301} __attribute__ ((packed));
 302
 303struct qeth_hdr_tso {
 304        struct qeth_hdr hdr;    /*hdr->hdr.l3.xxx*/
 305        struct qeth_hdr_ext_tso ext;
 306} __attribute__ ((packed));
 307
 308
 309/* flags for qeth_hdr.flags */
 310#define QETH_HDR_PASSTHRU 0x10
 311#define QETH_HDR_IPV6     0x80
 312#define QETH_HDR_CAST_MASK 0x07
 313enum qeth_cast_flags {
 314        QETH_CAST_UNICAST   = 0x06,
 315        QETH_CAST_MULTICAST = 0x04,
 316        QETH_CAST_BROADCAST = 0x05,
 317        QETH_CAST_ANYCAST   = 0x07,
 318        QETH_CAST_NOCAST    = 0x00,
 319};
 320
 321enum qeth_layer2_frame_flags {
 322        QETH_LAYER2_FLAG_MULTICAST = 0x01,
 323        QETH_LAYER2_FLAG_BROADCAST = 0x02,
 324        QETH_LAYER2_FLAG_UNICAST   = 0x04,
 325        QETH_LAYER2_FLAG_VLAN      = 0x10,
 326};
 327
 328enum qeth_header_ids {
 329        QETH_HEADER_TYPE_LAYER3 = 0x01,
 330        QETH_HEADER_TYPE_LAYER2 = 0x02,
 331        QETH_HEADER_TYPE_L3_TSO = 0x03,
 332        QETH_HEADER_TYPE_L2_TSO = 0x06,
 333        QETH_HEADER_MASK_INVAL  = 0x80,
 334};
 335/* flags for qeth_hdr.ext_flags */
 336#define QETH_HDR_EXT_VLAN_FRAME       0x01
 337#define QETH_HDR_EXT_TOKEN_ID         0x02
 338#define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
 339#define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
 340#define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
 341#define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
 342#define QETH_HDR_EXT_UDP              0x40 /*bit off for TCP*/
 343
 344static inline bool qeth_l2_same_vlan(struct qeth_hdr_layer2 *h1,
 345                                     struct qeth_hdr_layer2 *h2)
 346{
 347        return !((h1->flags[2] ^ h2->flags[2]) & QETH_LAYER2_FLAG_VLAN) &&
 348               h1->vlan_id == h2->vlan_id;
 349}
 350
 351static inline bool qeth_l3_iqd_same_vlan(struct qeth_hdr_layer3 *h1,
 352                                         struct qeth_hdr_layer3 *h2)
 353{
 354        return !((h1->ext_flags ^ h2->ext_flags) & QETH_HDR_EXT_VLAN_FRAME) &&
 355               h1->vlan_id == h2->vlan_id;
 356}
 357
 358static inline bool qeth_l3_same_next_hop(struct qeth_hdr_layer3 *h1,
 359                                         struct qeth_hdr_layer3 *h2)
 360{
 361        return !((h1->flags ^ h2->flags) & QETH_HDR_IPV6) &&
 362               ipv6_addr_equal(&h1->next_hop.addr, &h2->next_hop.addr);
 363}
 364
 365struct qeth_local_addr {
 366        struct hlist_node hnode;
 367        struct rcu_head rcu;
 368        struct in6_addr addr;
 369};
 370
 371enum qeth_qdio_info_states {
 372        QETH_QDIO_UNINITIALIZED,
 373        QETH_QDIO_ALLOCATED,
 374        QETH_QDIO_ESTABLISHED,
 375        QETH_QDIO_CLEANING
 376};
 377
 378struct qeth_buffer_pool_entry {
 379        struct list_head list;
 380        struct list_head init_list;
 381        struct page *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
 382};
 383
 384struct qeth_qdio_buffer_pool {
 385        struct list_head entry_list;
 386        int buf_count;
 387};
 388
 389struct qeth_qdio_buffer {
 390        struct qdio_buffer *buffer;
 391        /* the buffer pool entry currently associated to this buffer */
 392        struct qeth_buffer_pool_entry *pool_entry;
 393        struct sk_buff *rx_skb;
 394};
 395
 396struct qeth_qdio_q {
 397        struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
 398        struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
 399        int next_buf_to_init;
 400};
 401
 402enum qeth_qdio_out_buffer_state {
 403        /* Owned by driver, in order to be filled. */
 404        QETH_QDIO_BUF_EMPTY,
 405        /* Filled by driver; owned by hardware in order to be sent. */
 406        QETH_QDIO_BUF_PRIMED,
 407};
 408
 409enum qeth_qaob_state {
 410        QETH_QAOB_ISSUED,
 411        QETH_QAOB_PENDING,
 412        QETH_QAOB_DONE,
 413};
 414
 415struct qeth_qaob_priv1 {
 416        unsigned int state;
 417        u8 queue_no;
 418};
 419
 420struct qeth_qdio_out_buffer {
 421        struct qdio_buffer *buffer;
 422        atomic_t state;
 423        int next_element_to_fill;
 424        unsigned int frames;
 425        unsigned int bytes;
 426        struct sk_buff_head skb_list;
 427        DECLARE_BITMAP(from_kmem_cache, QDIO_MAX_ELEMENTS_PER_BUFFER);
 428
 429        struct list_head list_entry;
 430        struct qaob *aob;
 431};
 432
 433struct qeth_card;
 434
 435#define QETH_CARD_STAT_ADD(_c, _stat, _val)     ((_c)->stats._stat += (_val))
 436#define QETH_CARD_STAT_INC(_c, _stat)           QETH_CARD_STAT_ADD(_c, _stat, 1)
 437
 438#define QETH_TXQ_STAT_ADD(_q, _stat, _val)      ((_q)->stats._stat += (_val))
 439#define QETH_TXQ_STAT_INC(_q, _stat)            QETH_TXQ_STAT_ADD(_q, _stat, 1)
 440
 441struct qeth_card_stats {
 442        u64 rx_bufs;
 443        u64 rx_skb_csum;
 444        u64 rx_sg_skbs;
 445        u64 rx_sg_frags;
 446        u64 rx_sg_alloc_page;
 447
 448        u64 rx_dropped_nomem;
 449        u64 rx_dropped_notsupp;
 450        u64 rx_dropped_runt;
 451
 452        /* rtnl_link_stats64 */
 453        u64 rx_packets;
 454        u64 rx_bytes;
 455        u64 rx_multicast;
 456        u64 rx_length_errors;
 457        u64 rx_frame_errors;
 458        u64 rx_fifo_errors;
 459};
 460
 461struct qeth_out_q_stats {
 462        u64 bufs;
 463        u64 bufs_pack;
 464        u64 buf_elements;
 465        u64 skbs_pack;
 466        u64 skbs_sg;
 467        u64 skbs_csum;
 468        u64 skbs_tso;
 469        u64 skbs_linearized;
 470        u64 skbs_linearized_fail;
 471        u64 tso_bytes;
 472        u64 packing_mode_switch;
 473        u64 stopped;
 474        u64 doorbell;
 475        u64 coal_frames;
 476        u64 completion_irq;
 477        u64 completion_yield;
 478        u64 completion_timer;
 479
 480        /* rtnl_link_stats64 */
 481        u64 tx_packets;
 482        u64 tx_bytes;
 483        u64 tx_errors;
 484        u64 tx_dropped;
 485};
 486
 487#define QETH_TX_MAX_COALESCED_FRAMES    1
 488#define QETH_TX_COALESCE_USECS          25
 489#define QETH_TX_TIMER_USECS             500
 490
 491struct qeth_qdio_out_q {
 492        struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
 493        struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
 494        struct list_head pending_bufs;
 495        struct qeth_out_q_stats stats;
 496        spinlock_t lock;
 497        unsigned int priority;
 498        u8 next_buf_to_fill;
 499        u8 max_elements;
 500        u8 queue_no;
 501        u8 do_pack;
 502        struct qeth_card *card;
 503        /*
 504         * number of buffers that are currently filled (PRIMED)
 505         * -> these buffers are hardware-owned
 506         */
 507        atomic_t used_buffers;
 508        /* indicates whether PCI flag must be set (or if one is outstanding) */
 509        atomic_t set_pci_flags_count;
 510        struct napi_struct napi;
 511        struct timer_list timer;
 512        struct qeth_hdr *prev_hdr;
 513        unsigned int coalesced_frames;
 514        u8 bulk_start;
 515        u8 bulk_count;
 516        u8 bulk_max;
 517
 518        unsigned int coalesce_usecs;
 519        unsigned int max_coalesced_frames;
 520        unsigned int rescan_usecs;
 521};
 522
 523#define qeth_for_each_output_queue(card, q, i)          \
 524        for (i = 0; i < card->qdio.no_out_queues &&     \
 525                    (q = card->qdio.out_qs[i]); i++)
 526
 527#define qeth_napi_to_out_queue(n) container_of(n, struct qeth_qdio_out_q, napi)
 528
 529static inline void qeth_tx_arm_timer(struct qeth_qdio_out_q *queue,
 530                                     unsigned long usecs)
 531{
 532        timer_reduce(&queue->timer, usecs_to_jiffies(usecs) + jiffies);
 533}
 534
 535static inline bool qeth_out_queue_is_full(struct qeth_qdio_out_q *queue)
 536{
 537        return atomic_read(&queue->used_buffers) >= QDIO_MAX_BUFFERS_PER_Q;
 538}
 539
 540static inline bool qeth_out_queue_is_empty(struct qeth_qdio_out_q *queue)
 541{
 542        return atomic_read(&queue->used_buffers) == 0;
 543}
 544
 545struct qeth_qdio_info {
 546        atomic_t state;
 547        /* input */
 548        int no_in_queues;
 549        struct qeth_qdio_q *in_q;
 550        struct qeth_qdio_q *c_q;
 551        struct qeth_qdio_buffer_pool in_buf_pool;
 552        struct qeth_qdio_buffer_pool init_pool;
 553        int in_buf_size;
 554
 555        /* output */
 556        unsigned int no_out_queues;
 557        struct qeth_qdio_out_q *out_qs[QETH_MAX_OUT_QUEUES];
 558
 559        /* priority queueing */
 560        int do_prio_queueing;
 561        int default_out_queue;
 562};
 563
 564/**
 565 *  channel state machine
 566 */
 567enum qeth_channel_states {
 568        CH_STATE_UP,
 569        CH_STATE_DOWN,
 570        CH_STATE_HALTED,
 571        CH_STATE_STOPPED,
 572};
 573/**
 574 * card state machine
 575 */
 576enum qeth_card_states {
 577        CARD_STATE_DOWN,
 578        CARD_STATE_SOFTSETUP,
 579};
 580
 581/**
 582 * Protocol versions
 583 */
 584enum qeth_prot_versions {
 585        QETH_PROT_NONE = 0x0000,
 586        QETH_PROT_IPV4 = 0x0004,
 587        QETH_PROT_IPV6 = 0x0006,
 588};
 589
 590enum qeth_cq {
 591        QETH_CQ_DISABLED = 0,
 592        QETH_CQ_ENABLED = 1,
 593        QETH_CQ_NOTAVAILABLE = 2,
 594};
 595
 596struct qeth_ipato {
 597        bool enabled;
 598        bool invert4;
 599        bool invert6;
 600        struct list_head entries;
 601};
 602
 603struct qeth_channel {
 604        struct ccw_device *ccwdev;
 605        struct qeth_cmd_buffer *active_cmd;
 606        enum qeth_channel_states state;
 607};
 608
 609struct qeth_reply {
 610        int (*callback)(struct qeth_card *card, struct qeth_reply *reply,
 611                        unsigned long data);
 612        void *param;
 613};
 614
 615struct qeth_cmd_buffer {
 616        struct list_head list_entry;
 617        struct completion done;
 618        spinlock_t lock;
 619        unsigned int length;
 620        refcount_t ref_count;
 621        struct qeth_channel *channel;
 622        struct qeth_reply reply;
 623        long timeout;
 624        unsigned char *data;
 625        void (*finalize)(struct qeth_card *card, struct qeth_cmd_buffer *iob);
 626        bool (*match)(struct qeth_cmd_buffer *iob,
 627                      struct qeth_cmd_buffer *reply);
 628        void (*callback)(struct qeth_card *card, struct qeth_cmd_buffer *iob,
 629                         unsigned int data_length);
 630        int rc;
 631};
 632
 633static inline void qeth_get_cmd(struct qeth_cmd_buffer *iob)
 634{
 635        refcount_inc(&iob->ref_count);
 636}
 637
 638static inline struct qeth_ipa_cmd *__ipa_reply(struct qeth_cmd_buffer *iob)
 639{
 640        if (!IS_IPA(iob->data))
 641                return NULL;
 642
 643        return (struct qeth_ipa_cmd *) PDU_ENCAPSULATION(iob->data);
 644}
 645
 646static inline struct qeth_ipa_cmd *__ipa_cmd(struct qeth_cmd_buffer *iob)
 647{
 648        return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
 649}
 650
 651static inline struct ccw1 *__ccw_from_cmd(struct qeth_cmd_buffer *iob)
 652{
 653        return (struct ccw1 *)(iob->data + ALIGN(iob->length, 8));
 654}
 655
 656/**
 657 *  OSA card related definitions
 658 */
 659struct qeth_token {
 660        __u32 issuer_rm_w;
 661        __u32 issuer_rm_r;
 662        __u32 cm_filter_w;
 663        __u32 cm_filter_r;
 664        __u32 cm_connection_w;
 665        __u32 cm_connection_r;
 666        __u32 ulp_filter_w;
 667        __u32 ulp_filter_r;
 668        __u32 ulp_connection_w;
 669        __u32 ulp_connection_r;
 670};
 671
 672struct qeth_seqno {
 673        __u32 trans_hdr;
 674        __u32 pdu_hdr;
 675        __u32 pdu_hdr_ack;
 676        __u16 ipa;
 677};
 678
 679struct qeth_card_blkt {
 680        int time_total;
 681        int inter_packet;
 682        int inter_packet_jumbo;
 683};
 684
 685enum qeth_pnso_mode {
 686        QETH_PNSO_NONE,
 687        QETH_PNSO_BRIDGEPORT,
 688        QETH_PNSO_ADDR_INFO,
 689};
 690
 691enum qeth_link_mode {
 692        QETH_LINK_MODE_UNKNOWN,
 693        QETH_LINK_MODE_FIBRE_SHORT,
 694        QETH_LINK_MODE_FIBRE_LONG,
 695};
 696
 697struct qeth_link_info {
 698        u32 speed;
 699        u8 duplex;
 700        u8 port;
 701        enum qeth_link_mode link_mode;
 702};
 703
 704#define QETH_BROADCAST_WITH_ECHO    0x01
 705#define QETH_BROADCAST_WITHOUT_ECHO 0x02
 706struct qeth_card_info {
 707        unsigned short unit_addr2;
 708        unsigned short cula;
 709        __u16 func_level;
 710        char mcl_level[QETH_MCL_LENGTH + 1];
 711        /* doubleword below corresponds to net_if_token */
 712        u16 ddev_devno;
 713        u8 cssid;
 714        u8 iid;
 715        u8 ssid;
 716        u8 chpid;
 717        u16 chid;
 718        u8 ids_valid:1; /* cssid,iid,chid */
 719        u8 dev_addr_is_registered:1;
 720        u8 open_when_online:1;
 721        u8 promisc_mode:1;
 722        u8 use_v1_blkt:1;
 723        u8 is_vm_nic:1;
 724        /* no bitfield, we take a pointer on these two: */
 725        u8 has_lp2lp_cso_v6;
 726        u8 has_lp2lp_cso_v4;
 727        enum qeth_pnso_mode pnso_mode;
 728        enum qeth_card_types type;
 729        enum qeth_link_types link_type;
 730        int broadcast_capable;
 731        bool layer_enforced;
 732        struct qeth_card_blkt blkt;
 733        __u32 diagass_support;
 734        __u32 hwtrap;
 735        struct qeth_link_info link_info;
 736};
 737
 738enum qeth_discipline_id {
 739        QETH_DISCIPLINE_UNDETERMINED = -1,
 740        QETH_DISCIPLINE_LAYER3 = 0,
 741        QETH_DISCIPLINE_LAYER2 = 1,
 742};
 743
 744struct qeth_card_options {
 745        struct qeth_ipa_caps ipa4;
 746        struct qeth_ipa_caps ipa6;
 747        struct qeth_routing_info route4;
 748        struct qeth_routing_info route6;
 749        struct qeth_ipa_caps adp; /* Adapter parameters */
 750        struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
 751        struct qeth_vnicc_info vnicc; /* VNICC options */
 752        enum qeth_discipline_id layer;
 753        enum qeth_ipa_isolation_modes isolation;
 754        int sniffer;
 755        enum qeth_cq cq;
 756        char hsuid[9];
 757};
 758
 759#define IS_LAYER2(card) ((card)->options.layer == QETH_DISCIPLINE_LAYER2)
 760#define IS_LAYER3(card) ((card)->options.layer == QETH_DISCIPLINE_LAYER3)
 761
 762/*
 763 * thread bits for qeth_card thread masks
 764 */
 765enum qeth_threads {
 766        QETH_RECOVER_THREAD = 1,
 767};
 768
 769struct qeth_discipline {
 770        int (*setup) (struct ccwgroup_device *);
 771        void (*remove) (struct ccwgroup_device *);
 772        int (*set_online)(struct qeth_card *card, bool carrier_ok);
 773        void (*set_offline)(struct qeth_card *card);
 774        int (*do_ioctl)(struct net_device *dev, struct ifreq *rq,
 775                        void __user *data, int cmd);
 776        int (*control_event_handler)(struct qeth_card *card,
 777                                        struct qeth_ipa_cmd *cmd);
 778};
 779
 780enum qeth_addr_disposition {
 781        QETH_DISP_ADDR_DELETE = 0,
 782        QETH_DISP_ADDR_DO_NOTHING = 1,
 783        QETH_DISP_ADDR_ADD = 2,
 784};
 785
 786struct qeth_rx {
 787        int b_count;
 788        int b_index;
 789        u8 buf_element;
 790        int e_offset;
 791        int qdio_err;
 792        u8 bufs_refill;
 793};
 794
 795struct qeth_switch_info {
 796        __u32 capabilities;
 797        __u32 settings;
 798};
 799
 800struct qeth_priv {
 801        unsigned int rx_copybreak;
 802        unsigned int tx_wanted_queues;
 803        u32 brport_hw_features;
 804        u32 brport_features;
 805};
 806
 807#define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
 808
 809struct qeth_card {
 810        enum qeth_card_states state;
 811        spinlock_t lock;
 812        struct ccwgroup_device *gdev;
 813        struct qeth_cmd_buffer *read_cmd;
 814        struct qeth_channel read;
 815        struct qeth_channel write;
 816        struct qeth_channel data;
 817
 818        struct net_device *dev;
 819        struct dentry *debugfs;
 820        struct qeth_card_stats stats;
 821        struct qeth_card_info info;
 822        struct qeth_token token;
 823        struct qeth_seqno seqno;
 824        struct qeth_card_options options;
 825
 826        struct workqueue_struct *event_wq;
 827        struct workqueue_struct *cmd_wq;
 828        wait_queue_head_t wait_q;
 829
 830        struct mutex ip_lock;
 831        /* protected by ip_lock: */
 832        DECLARE_HASHTABLE(ip_htable, 4);
 833        struct qeth_ipato ipato;
 834
 835        DECLARE_HASHTABLE(local_addrs4, 4);
 836        DECLARE_HASHTABLE(local_addrs6, 4);
 837        spinlock_t local_addrs4_lock;
 838        spinlock_t local_addrs6_lock;
 839        DECLARE_HASHTABLE(rx_mode_addrs, 4);
 840        struct work_struct rx_mode_work;
 841        struct work_struct kernel_thread_starter;
 842        spinlock_t thread_mask_lock;
 843        unsigned long thread_start_mask;
 844        unsigned long thread_allowed_mask;
 845        unsigned long thread_running_mask;
 846        struct list_head cmd_waiter_list;
 847        /* QDIO buffer handling */
 848        struct qeth_qdio_info qdio;
 849        int read_or_write_problem;
 850        const struct qeth_discipline *discipline;
 851        atomic_t force_alloc_skb;
 852        struct service_level qeth_service_level;
 853        struct qdio_ssqd_desc ssqd;
 854        debug_info_t *debug;
 855        struct mutex sbp_lock;
 856        struct mutex conf_mutex;
 857        struct mutex discipline_mutex;
 858        struct napi_struct napi;
 859        struct qeth_rx rx;
 860        struct delayed_work buffer_reclaim_work;
 861};
 862
 863static inline bool qeth_card_hw_is_reachable(struct qeth_card *card)
 864{
 865        return card->state == CARD_STATE_SOFTSETUP;
 866}
 867
 868static inline bool qeth_use_tx_irqs(struct qeth_card *card)
 869{
 870        return !IS_IQD(card);
 871}
 872
 873static inline void qeth_unlock_channel(struct qeth_card *card,
 874                                       struct qeth_channel *channel)
 875{
 876        xchg(&channel->active_cmd, NULL);
 877        wake_up(&card->wait_q);
 878}
 879
 880static inline bool qeth_trylock_channel(struct qeth_channel *channel,
 881                                        struct qeth_cmd_buffer *cmd)
 882{
 883        return cmpxchg(&channel->active_cmd, NULL, cmd) == NULL;
 884}
 885
 886struct qeth_trap_id {
 887        __u16 lparnr;
 888        char vmname[8];
 889        __u8 chpid;
 890        __u8 ssid;
 891        __u16 devno;
 892} __packed;
 893
 894static inline bool qeth_uses_tx_prio_queueing(struct qeth_card *card)
 895{
 896        return card->qdio.do_prio_queueing != QETH_NO_PRIO_QUEUEING;
 897}
 898
 899static inline unsigned int qeth_tx_actual_queues(struct qeth_card *card)
 900{
 901        struct qeth_priv *priv = netdev_priv(card->dev);
 902
 903        if (qeth_uses_tx_prio_queueing(card))
 904                return min(card->dev->num_tx_queues, card->qdio.no_out_queues);
 905
 906        return min(priv->tx_wanted_queues, card->qdio.no_out_queues);
 907}
 908
 909static inline u16 qeth_iqd_translate_txq(struct net_device *dev, u16 txq)
 910{
 911        if (txq == QETH_IQD_MCAST_TXQ)
 912                return dev->num_tx_queues - 1;
 913        if (txq == dev->num_tx_queues - 1)
 914                return QETH_IQD_MCAST_TXQ;
 915        return txq;
 916}
 917
 918static inline bool qeth_iqd_is_mcast_queue(struct qeth_card *card,
 919                                           struct qeth_qdio_out_q *queue)
 920{
 921        return qeth_iqd_translate_txq(card->dev, queue->queue_no) ==
 922               QETH_IQD_MCAST_TXQ;
 923}
 924
 925static inline void qeth_scrub_qdio_buffer(struct qdio_buffer *buf,
 926                                          unsigned int elements)
 927{
 928        unsigned int i;
 929
 930        for (i = 0; i < elements; i++)
 931                memset(&buf->element[i], 0, sizeof(struct qdio_buffer_element));
 932        buf->element[14].sflags = 0;
 933        buf->element[15].sflags = 0;
 934}
 935
 936/**
 937 * qeth_get_elements_for_range() -      find number of SBALEs to cover range.
 938 * @start:                              Start of the address range.
 939 * @end:                                Address after the end of the range.
 940 *
 941 * Returns the number of pages, and thus QDIO buffer elements, needed to cover
 942 * the specified address range.
 943 */
 944static inline int qeth_get_elements_for_range(addr_t start, addr_t end)
 945{
 946        return PFN_UP(end) - PFN_DOWN(start);
 947}
 948
 949static inline int qeth_get_ether_cast_type(struct sk_buff *skb)
 950{
 951        u8 *addr = eth_hdr(skb)->h_dest;
 952
 953        if (is_multicast_ether_addr(addr))
 954                return is_broadcast_ether_addr(addr) ? RTN_BROADCAST :
 955                                                       RTN_MULTICAST;
 956        return RTN_UNICAST;
 957}
 958
 959static inline struct dst_entry *qeth_dst_check_rcu(struct sk_buff *skb,
 960                                                   __be16 proto)
 961{
 962        struct dst_entry *dst = skb_dst(skb);
 963        struct rt6_info *rt;
 964
 965        rt = (struct rt6_info *) dst;
 966        if (dst) {
 967                if (proto == htons(ETH_P_IPV6))
 968                        dst = dst_check(dst, rt6_get_cookie(rt));
 969                else
 970                        dst = dst_check(dst, 0);
 971        }
 972
 973        return dst;
 974}
 975
 976static inline __be32 qeth_next_hop_v4_rcu(struct sk_buff *skb,
 977                                          struct dst_entry *dst)
 978{
 979        struct rtable *rt = (struct rtable *) dst;
 980
 981        return (rt) ? rt_nexthop(rt, ip_hdr(skb)->daddr) : ip_hdr(skb)->daddr;
 982}
 983
 984static inline struct in6_addr *qeth_next_hop_v6_rcu(struct sk_buff *skb,
 985                                                    struct dst_entry *dst)
 986{
 987        struct rt6_info *rt = (struct rt6_info *) dst;
 988
 989        if (rt && !ipv6_addr_any(&rt->rt6i_gateway))
 990                return &rt->rt6i_gateway;
 991        else
 992                return &ipv6_hdr(skb)->daddr;
 993}
 994
 995static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, __be16 proto)
 996{
 997        *flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
 998        if ((proto == htons(ETH_P_IP) && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
 999            (proto == htons(ETH_P_IPV6) && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
1000                *flags |= QETH_HDR_EXT_UDP;
1001}
1002
1003static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
1004                struct qeth_buffer_pool_entry *entry)
1005{
1006        list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
1007}
1008
1009static inline int qeth_is_diagass_supported(struct qeth_card *card,
1010                enum qeth_diags_cmds cmd)
1011{
1012        return card->info.diagass_support & (__u32)cmd;
1013}
1014
1015int qeth_send_simple_setassparms_prot(struct qeth_card *card,
1016                                      enum qeth_ipa_funcs ipa_func,
1017                                      u16 cmd_code, u32 *data,
1018                                      enum qeth_prot_versions prot);
1019/* IPv4 variant */
1020static inline int qeth_send_simple_setassparms(struct qeth_card *card,
1021                                               enum qeth_ipa_funcs ipa_func,
1022                                               u16 cmd_code, u32 *data)
1023{
1024        return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
1025                                                 data, QETH_PROT_IPV4);
1026}
1027
1028static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
1029                                                  enum qeth_ipa_funcs ipa_func,
1030                                                  u16 cmd_code, u32 *data)
1031{
1032        return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
1033                                                 data, QETH_PROT_IPV6);
1034}
1035
1036int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb);
1037
1038extern const struct qeth_discipline qeth_l2_discipline;
1039extern const struct qeth_discipline qeth_l3_discipline;
1040extern const struct ethtool_ops qeth_ethtool_ops;
1041extern const struct attribute_group *qeth_dev_groups[];
1042
1043const char *qeth_get_cardname_short(struct qeth_card *);
1044int qeth_resize_buffer_pool(struct qeth_card *card, unsigned int count);
1045int qeth_setup_discipline(struct qeth_card *card, enum qeth_discipline_id disc);
1046void qeth_remove_discipline(struct qeth_card *card);
1047
1048/* exports for qeth discipline device drivers */
1049extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
1050
1051struct net_device *qeth_clone_netdev(struct net_device *orig);
1052void qeth_set_allowed_threads(struct qeth_card *card, unsigned long threads,
1053                              int clear_start_mask);
1054int qeth_threads_running(struct qeth_card *, unsigned long);
1055int qeth_set_offline(struct qeth_card *card, const struct qeth_discipline *disc,
1056                     bool resetting);
1057
1058int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
1059                  int (*reply_cb)
1060                  (struct qeth_card *, struct qeth_reply *, unsigned long),
1061                  void *);
1062struct qeth_cmd_buffer *qeth_ipa_alloc_cmd(struct qeth_card *card,
1063                                           enum qeth_ipa_cmds cmd_code,
1064                                           enum qeth_prot_versions prot,
1065                                           unsigned int data_length);
1066struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *card,
1067                                                 enum qeth_ipa_funcs ipa_func,
1068                                                 u16 cmd_code,
1069                                                 unsigned int data_length,
1070                                                 enum qeth_prot_versions prot);
1071struct qeth_cmd_buffer *qeth_get_diag_cmd(struct qeth_card *card,
1072                                          enum qeth_diags_cmds sub_cmd,
1073                                          unsigned int data_length);
1074
1075int qeth_schedule_recovery(struct qeth_card *card);
1076int qeth_poll(struct napi_struct *napi, int budget);
1077void qeth_setadp_promisc_mode(struct qeth_card *card, bool enable);
1078int qeth_setadpparms_change_macaddr(struct qeth_card *);
1079void qeth_tx_timeout(struct net_device *, unsigned int txqueue);
1080int qeth_query_switch_attributes(struct qeth_card *card,
1081                                  struct qeth_switch_info *sw_info);
1082int qeth_query_card_info(struct qeth_card *card,
1083                         struct qeth_link_info *link_info);
1084int qeth_setadpparms_set_access_ctrl(struct qeth_card *card,
1085                                     enum qeth_ipa_isolation_modes mode);
1086
1087int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1088int qeth_siocdevprivate(struct net_device *dev, struct ifreq *rq,
1089                        void __user *data, int cmd);
1090void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1091int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1092int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1093int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1094int qeth_set_features(struct net_device *, netdev_features_t);
1095void qeth_enable_hw_features(struct net_device *dev);
1096netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1097netdev_features_t qeth_features_check(struct sk_buff *skb,
1098                                      struct net_device *dev,
1099                                      netdev_features_t features);
1100void qeth_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats);
1101int qeth_set_real_num_tx_queues(struct qeth_card *card, unsigned int count);
1102u16 qeth_iqd_select_queue(struct net_device *dev, struct sk_buff *skb,
1103                          u8 cast_type, struct net_device *sb_dev);
1104int qeth_open(struct net_device *dev);
1105int qeth_stop(struct net_device *dev);
1106
1107int qeth_vm_request_mac(struct qeth_card *card);
1108int qeth_xmit(struct qeth_card *card, struct sk_buff *skb,
1109              struct qeth_qdio_out_q *queue, __be16 proto,
1110              void (*fill_header)(struct qeth_qdio_out_q *queue,
1111                                  struct qeth_hdr *hdr, struct sk_buff *skb,
1112                                  __be16 proto, unsigned int data_len));
1113
1114#endif /* __QETH_CORE_H__ */
1115