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_osn {
 263        __u8 id;
 264        __u8 reserved;
 265        __u16 seq_no;
 266        __u16 reserved2;
 267        __u16 control_flags;
 268        __u16 pdu_length;
 269        __u8 reserved3[18];
 270        __u32 ccid;
 271} __attribute__ ((packed));
 272
 273struct qeth_hdr {
 274        union {
 275                struct qeth_hdr_layer2 l2;
 276                struct qeth_hdr_layer3 l3;
 277                struct qeth_hdr_osn    osn;
 278        } hdr;
 279} __attribute__ ((packed));
 280
 281#define QETH_QIB_PQUE_ORDER_RR          0
 282#define QETH_QIB_PQUE_UNITS_SBAL        2
 283#define QETH_QIB_PQUE_PRIO_DEFAULT      4
 284
 285struct qeth_qib_parms {
 286        char pcit_magic[4];
 287        u32 pcit_a;
 288        u32 pcit_b;
 289        u32 pcit_c;
 290        char blkt_magic[4];
 291        u32 blkt_total;
 292        u32 blkt_inter_packet;
 293        u32 blkt_inter_packet_jumbo;
 294        char pque_magic[4];
 295        u8 pque_order;
 296        u8 pque_units;
 297        u16 reserved;
 298        u32 pque_priority[4];
 299};
 300
 301/*TCP Segmentation Offload header*/
 302struct qeth_hdr_ext_tso {
 303        __u16 hdr_tot_len;
 304        __u8  imb_hdr_no;
 305        __u8  reserved;
 306        __u8  hdr_type;
 307        __u8  hdr_version;
 308        __u16 hdr_len;
 309        __u32 payload_len;
 310        __u16 mss;
 311        __u16 dg_hdr_len;
 312        __u8  padding[16];
 313} __attribute__ ((packed));
 314
 315struct qeth_hdr_tso {
 316        struct qeth_hdr hdr;    /*hdr->hdr.l3.xxx*/
 317        struct qeth_hdr_ext_tso ext;
 318} __attribute__ ((packed));
 319
 320
 321/* flags for qeth_hdr.flags */
 322#define QETH_HDR_PASSTHRU 0x10
 323#define QETH_HDR_IPV6     0x80
 324#define QETH_HDR_CAST_MASK 0x07
 325enum qeth_cast_flags {
 326        QETH_CAST_UNICAST   = 0x06,
 327        QETH_CAST_MULTICAST = 0x04,
 328        QETH_CAST_BROADCAST = 0x05,
 329        QETH_CAST_ANYCAST   = 0x07,
 330        QETH_CAST_NOCAST    = 0x00,
 331};
 332
 333enum qeth_layer2_frame_flags {
 334        QETH_LAYER2_FLAG_MULTICAST = 0x01,
 335        QETH_LAYER2_FLAG_BROADCAST = 0x02,
 336        QETH_LAYER2_FLAG_UNICAST   = 0x04,
 337        QETH_LAYER2_FLAG_VLAN      = 0x10,
 338};
 339
 340enum qeth_header_ids {
 341        QETH_HEADER_TYPE_LAYER3 = 0x01,
 342        QETH_HEADER_TYPE_LAYER2 = 0x02,
 343        QETH_HEADER_TYPE_L3_TSO = 0x03,
 344        QETH_HEADER_TYPE_OSN    = 0x04,
 345        QETH_HEADER_TYPE_L2_TSO = 0x06,
 346        QETH_HEADER_MASK_INVAL  = 0x80,
 347};
 348/* flags for qeth_hdr.ext_flags */
 349#define QETH_HDR_EXT_VLAN_FRAME       0x01
 350#define QETH_HDR_EXT_TOKEN_ID         0x02
 351#define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
 352#define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
 353#define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
 354#define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
 355#define QETH_HDR_EXT_UDP              0x40 /*bit off for TCP*/
 356
 357static inline bool qeth_l2_same_vlan(struct qeth_hdr_layer2 *h1,
 358                                     struct qeth_hdr_layer2 *h2)
 359{
 360        return !((h1->flags[2] ^ h2->flags[2]) & QETH_LAYER2_FLAG_VLAN) &&
 361               h1->vlan_id == h2->vlan_id;
 362}
 363
 364static inline bool qeth_l3_iqd_same_vlan(struct qeth_hdr_layer3 *h1,
 365                                         struct qeth_hdr_layer3 *h2)
 366{
 367        return !((h1->ext_flags ^ h2->ext_flags) & QETH_HDR_EXT_VLAN_FRAME) &&
 368               h1->vlan_id == h2->vlan_id;
 369}
 370
 371static inline bool qeth_l3_same_next_hop(struct qeth_hdr_layer3 *h1,
 372                                         struct qeth_hdr_layer3 *h2)
 373{
 374        return !((h1->flags ^ h2->flags) & QETH_HDR_IPV6) &&
 375               ipv6_addr_equal(&h1->next_hop.addr, &h2->next_hop.addr);
 376}
 377
 378struct qeth_local_addr {
 379        struct hlist_node hnode;
 380        struct rcu_head rcu;
 381        struct in6_addr addr;
 382};
 383
 384enum qeth_qdio_info_states {
 385        QETH_QDIO_UNINITIALIZED,
 386        QETH_QDIO_ALLOCATED,
 387        QETH_QDIO_ESTABLISHED,
 388        QETH_QDIO_CLEANING
 389};
 390
 391struct qeth_buffer_pool_entry {
 392        struct list_head list;
 393        struct list_head init_list;
 394        struct page *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
 395};
 396
 397struct qeth_qdio_buffer_pool {
 398        struct list_head entry_list;
 399        int buf_count;
 400};
 401
 402struct qeth_qdio_buffer {
 403        struct qdio_buffer *buffer;
 404        /* the buffer pool entry currently associated to this buffer */
 405        struct qeth_buffer_pool_entry *pool_entry;
 406        struct sk_buff *rx_skb;
 407};
 408
 409struct qeth_qdio_q {
 410        struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
 411        struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
 412        int next_buf_to_init;
 413};
 414
 415enum qeth_qdio_out_buffer_state {
 416        /* Owned by driver, in order to be filled. */
 417        QETH_QDIO_BUF_EMPTY,
 418        /* Filled by driver; owned by hardware in order to be sent. */
 419        QETH_QDIO_BUF_PRIMED,
 420};
 421
 422enum qeth_qaob_state {
 423        QETH_QAOB_ISSUED,
 424        QETH_QAOB_PENDING,
 425        QETH_QAOB_DONE,
 426};
 427
 428struct qeth_qaob_priv1 {
 429        unsigned int state;
 430        u8 queue_no;
 431};
 432
 433struct qeth_qdio_out_buffer {
 434        struct qdio_buffer *buffer;
 435        atomic_t state;
 436        int next_element_to_fill;
 437        unsigned int frames;
 438        unsigned int bytes;
 439        struct sk_buff_head skb_list;
 440        DECLARE_BITMAP(from_kmem_cache, QDIO_MAX_ELEMENTS_PER_BUFFER);
 441
 442        struct list_head list_entry;
 443        struct qaob *aob;
 444};
 445
 446struct qeth_card;
 447
 448#define QETH_CARD_STAT_ADD(_c, _stat, _val)     ((_c)->stats._stat += (_val))
 449#define QETH_CARD_STAT_INC(_c, _stat)           QETH_CARD_STAT_ADD(_c, _stat, 1)
 450
 451#define QETH_TXQ_STAT_ADD(_q, _stat, _val)      ((_q)->stats._stat += (_val))
 452#define QETH_TXQ_STAT_INC(_q, _stat)            QETH_TXQ_STAT_ADD(_q, _stat, 1)
 453
 454struct qeth_card_stats {
 455        u64 rx_bufs;
 456        u64 rx_skb_csum;
 457        u64 rx_sg_skbs;
 458        u64 rx_sg_frags;
 459        u64 rx_sg_alloc_page;
 460
 461        u64 rx_dropped_nomem;
 462        u64 rx_dropped_notsupp;
 463        u64 rx_dropped_runt;
 464
 465        /* rtnl_link_stats64 */
 466        u64 rx_packets;
 467        u64 rx_bytes;
 468        u64 rx_multicast;
 469        u64 rx_length_errors;
 470        u64 rx_frame_errors;
 471        u64 rx_fifo_errors;
 472};
 473
 474struct qeth_out_q_stats {
 475        u64 bufs;
 476        u64 bufs_pack;
 477        u64 buf_elements;
 478        u64 skbs_pack;
 479        u64 skbs_sg;
 480        u64 skbs_csum;
 481        u64 skbs_tso;
 482        u64 skbs_linearized;
 483        u64 skbs_linearized_fail;
 484        u64 tso_bytes;
 485        u64 packing_mode_switch;
 486        u64 stopped;
 487        u64 doorbell;
 488        u64 coal_frames;
 489        u64 completion_irq;
 490        u64 completion_yield;
 491        u64 completion_timer;
 492
 493        /* rtnl_link_stats64 */
 494        u64 tx_packets;
 495        u64 tx_bytes;
 496        u64 tx_errors;
 497        u64 tx_dropped;
 498};
 499
 500#define QETH_TX_MAX_COALESCED_FRAMES    1
 501#define QETH_TX_COALESCE_USECS          25
 502#define QETH_TX_TIMER_USECS             500
 503
 504struct qeth_qdio_out_q {
 505        struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
 506        struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
 507        struct list_head pending_bufs;
 508        struct qeth_out_q_stats stats;
 509        spinlock_t lock;
 510        unsigned int priority;
 511        u8 next_buf_to_fill;
 512        u8 max_elements;
 513        u8 queue_no;
 514        u8 do_pack;
 515        struct qeth_card *card;
 516        /*
 517         * number of buffers that are currently filled (PRIMED)
 518         * -> these buffers are hardware-owned
 519         */
 520        atomic_t used_buffers;
 521        /* indicates whether PCI flag must be set (or if one is outstanding) */
 522        atomic_t set_pci_flags_count;
 523        struct napi_struct napi;
 524        struct timer_list timer;
 525        struct qeth_hdr *prev_hdr;
 526        unsigned int coalesced_frames;
 527        u8 bulk_start;
 528        u8 bulk_count;
 529        u8 bulk_max;
 530
 531        unsigned int coalesce_usecs;
 532        unsigned int max_coalesced_frames;
 533        unsigned int rescan_usecs;
 534};
 535
 536#define qeth_for_each_output_queue(card, q, i)          \
 537        for (i = 0; i < card->qdio.no_out_queues &&     \
 538                    (q = card->qdio.out_qs[i]); i++)
 539
 540#define qeth_napi_to_out_queue(n) container_of(n, struct qeth_qdio_out_q, napi)
 541
 542static inline void qeth_tx_arm_timer(struct qeth_qdio_out_q *queue,
 543                                     unsigned long usecs)
 544{
 545        timer_reduce(&queue->timer, usecs_to_jiffies(usecs) + jiffies);
 546}
 547
 548static inline bool qeth_out_queue_is_full(struct qeth_qdio_out_q *queue)
 549{
 550        return atomic_read(&queue->used_buffers) >= QDIO_MAX_BUFFERS_PER_Q;
 551}
 552
 553static inline bool qeth_out_queue_is_empty(struct qeth_qdio_out_q *queue)
 554{
 555        return atomic_read(&queue->used_buffers) == 0;
 556}
 557
 558struct qeth_qdio_info {
 559        atomic_t state;
 560        /* input */
 561        int no_in_queues;
 562        struct qeth_qdio_q *in_q;
 563        struct qeth_qdio_q *c_q;
 564        struct qeth_qdio_buffer_pool in_buf_pool;
 565        struct qeth_qdio_buffer_pool init_pool;
 566        int in_buf_size;
 567
 568        /* output */
 569        unsigned int no_out_queues;
 570        struct qeth_qdio_out_q *out_qs[QETH_MAX_OUT_QUEUES];
 571
 572        /* priority queueing */
 573        int do_prio_queueing;
 574        int default_out_queue;
 575};
 576
 577/**
 578 *  channel state machine
 579 */
 580enum qeth_channel_states {
 581        CH_STATE_UP,
 582        CH_STATE_DOWN,
 583        CH_STATE_HALTED,
 584        CH_STATE_STOPPED,
 585};
 586/**
 587 * card state machine
 588 */
 589enum qeth_card_states {
 590        CARD_STATE_DOWN,
 591        CARD_STATE_SOFTSETUP,
 592};
 593
 594/**
 595 * Protocol versions
 596 */
 597enum qeth_prot_versions {
 598        QETH_PROT_NONE = 0x0000,
 599        QETH_PROT_IPV4 = 0x0004,
 600        QETH_PROT_IPV6 = 0x0006,
 601};
 602
 603enum qeth_cq {
 604        QETH_CQ_DISABLED = 0,
 605        QETH_CQ_ENABLED = 1,
 606        QETH_CQ_NOTAVAILABLE = 2,
 607};
 608
 609struct qeth_ipato {
 610        bool enabled;
 611        bool invert4;
 612        bool invert6;
 613        struct list_head entries;
 614};
 615
 616struct qeth_channel {
 617        struct ccw_device *ccwdev;
 618        struct qeth_cmd_buffer *active_cmd;
 619        enum qeth_channel_states state;
 620};
 621
 622struct qeth_reply {
 623        int (*callback)(struct qeth_card *card, struct qeth_reply *reply,
 624                        unsigned long data);
 625        void *param;
 626};
 627
 628struct qeth_cmd_buffer {
 629        struct list_head list_entry;
 630        struct completion done;
 631        spinlock_t lock;
 632        unsigned int length;
 633        refcount_t ref_count;
 634        struct qeth_channel *channel;
 635        struct qeth_reply reply;
 636        long timeout;
 637        unsigned char *data;
 638        void (*finalize)(struct qeth_card *card, struct qeth_cmd_buffer *iob);
 639        bool (*match)(struct qeth_cmd_buffer *iob,
 640                      struct qeth_cmd_buffer *reply);
 641        void (*callback)(struct qeth_card *card, struct qeth_cmd_buffer *iob,
 642                         unsigned int data_length);
 643        int rc;
 644};
 645
 646static inline void qeth_get_cmd(struct qeth_cmd_buffer *iob)
 647{
 648        refcount_inc(&iob->ref_count);
 649}
 650
 651static inline struct qeth_ipa_cmd *__ipa_reply(struct qeth_cmd_buffer *iob)
 652{
 653        if (!IS_IPA(iob->data))
 654                return NULL;
 655
 656        return (struct qeth_ipa_cmd *) PDU_ENCAPSULATION(iob->data);
 657}
 658
 659static inline struct qeth_ipa_cmd *__ipa_cmd(struct qeth_cmd_buffer *iob)
 660{
 661        return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
 662}
 663
 664static inline struct ccw1 *__ccw_from_cmd(struct qeth_cmd_buffer *iob)
 665{
 666        return (struct ccw1 *)(iob->data + ALIGN(iob->length, 8));
 667}
 668
 669/**
 670 *  OSA card related definitions
 671 */
 672struct qeth_token {
 673        __u32 issuer_rm_w;
 674        __u32 issuer_rm_r;
 675        __u32 cm_filter_w;
 676        __u32 cm_filter_r;
 677        __u32 cm_connection_w;
 678        __u32 cm_connection_r;
 679        __u32 ulp_filter_w;
 680        __u32 ulp_filter_r;
 681        __u32 ulp_connection_w;
 682        __u32 ulp_connection_r;
 683};
 684
 685struct qeth_seqno {
 686        __u32 trans_hdr;
 687        __u32 pdu_hdr;
 688        __u32 pdu_hdr_ack;
 689        __u16 ipa;
 690};
 691
 692struct qeth_card_blkt {
 693        int time_total;
 694        int inter_packet;
 695        int inter_packet_jumbo;
 696};
 697
 698enum qeth_pnso_mode {
 699        QETH_PNSO_NONE,
 700        QETH_PNSO_BRIDGEPORT,
 701        QETH_PNSO_ADDR_INFO,
 702};
 703
 704enum qeth_link_mode {
 705        QETH_LINK_MODE_UNKNOWN,
 706        QETH_LINK_MODE_FIBRE_SHORT,
 707        QETH_LINK_MODE_FIBRE_LONG,
 708};
 709
 710struct qeth_link_info {
 711        u32 speed;
 712        u8 duplex;
 713        u8 port;
 714        enum qeth_link_mode link_mode;
 715};
 716
 717#define QETH_BROADCAST_WITH_ECHO    0x01
 718#define QETH_BROADCAST_WITHOUT_ECHO 0x02
 719struct qeth_card_info {
 720        unsigned short unit_addr2;
 721        unsigned short cula;
 722        __u16 func_level;
 723        char mcl_level[QETH_MCL_LENGTH + 1];
 724        /* doubleword below corresponds to net_if_token */
 725        u16 ddev_devno;
 726        u8 cssid;
 727        u8 iid;
 728        u8 ssid;
 729        u8 chpid;
 730        u16 chid;
 731        u8 ids_valid:1; /* cssid,iid,chid */
 732        u8 dev_addr_is_registered:1;
 733        u8 open_when_online:1;
 734        u8 promisc_mode:1;
 735        u8 use_v1_blkt:1;
 736        u8 is_vm_nic:1;
 737        /* no bitfield, we take a pointer on these two: */
 738        u8 has_lp2lp_cso_v6;
 739        u8 has_lp2lp_cso_v4;
 740        enum qeth_pnso_mode pnso_mode;
 741        enum qeth_card_types type;
 742        enum qeth_link_types link_type;
 743        int broadcast_capable;
 744        bool layer_enforced;
 745        struct qeth_card_blkt blkt;
 746        __u32 diagass_support;
 747        __u32 hwtrap;
 748        struct qeth_link_info link_info;
 749};
 750
 751enum qeth_discipline_id {
 752        QETH_DISCIPLINE_UNDETERMINED = -1,
 753        QETH_DISCIPLINE_LAYER3 = 0,
 754        QETH_DISCIPLINE_LAYER2 = 1,
 755};
 756
 757struct qeth_card_options {
 758        struct qeth_ipa_caps ipa4;
 759        struct qeth_ipa_caps ipa6;
 760        struct qeth_routing_info route4;
 761        struct qeth_routing_info route6;
 762        struct qeth_ipa_caps adp; /* Adapter parameters */
 763        struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
 764        struct qeth_vnicc_info vnicc; /* VNICC options */
 765        enum qeth_discipline_id layer;
 766        enum qeth_ipa_isolation_modes isolation;
 767        int sniffer;
 768        enum qeth_cq cq;
 769        char hsuid[9];
 770};
 771
 772#define IS_LAYER2(card) ((card)->options.layer == QETH_DISCIPLINE_LAYER2)
 773#define IS_LAYER3(card) ((card)->options.layer == QETH_DISCIPLINE_LAYER3)
 774
 775/*
 776 * thread bits for qeth_card thread masks
 777 */
 778enum qeth_threads {
 779        QETH_RECOVER_THREAD = 1,
 780};
 781
 782struct qeth_osn_info {
 783        int (*assist_cb)(struct net_device *dev, void *data);
 784        int (*data_cb)(struct sk_buff *skb);
 785};
 786
 787struct qeth_discipline {
 788        const struct device_type *devtype;
 789        int (*setup) (struct ccwgroup_device *);
 790        void (*remove) (struct ccwgroup_device *);
 791        int (*set_online)(struct qeth_card *card, bool carrier_ok);
 792        void (*set_offline)(struct qeth_card *card);
 793        int (*do_ioctl)(struct net_device *dev, struct ifreq *rq, int cmd);
 794        int (*control_event_handler)(struct qeth_card *card,
 795                                        struct qeth_ipa_cmd *cmd);
 796};
 797
 798enum qeth_addr_disposition {
 799        QETH_DISP_ADDR_DELETE = 0,
 800        QETH_DISP_ADDR_DO_NOTHING = 1,
 801        QETH_DISP_ADDR_ADD = 2,
 802};
 803
 804struct qeth_rx {
 805        int b_count;
 806        int b_index;
 807        u8 buf_element;
 808        int e_offset;
 809        int qdio_err;
 810        u8 bufs_refill;
 811};
 812
 813struct qeth_switch_info {
 814        __u32 capabilities;
 815        __u32 settings;
 816};
 817
 818struct qeth_priv {
 819        unsigned int rx_copybreak;
 820        unsigned int tx_wanted_queues;
 821        u32 brport_hw_features;
 822        u32 brport_features;
 823};
 824
 825#define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
 826
 827struct qeth_card {
 828        enum qeth_card_states state;
 829        spinlock_t lock;
 830        struct ccwgroup_device *gdev;
 831        struct qeth_cmd_buffer *read_cmd;
 832        struct qeth_channel read;
 833        struct qeth_channel write;
 834        struct qeth_channel data;
 835
 836        struct net_device *dev;
 837        struct dentry *debugfs;
 838        struct qeth_card_stats stats;
 839        struct qeth_card_info info;
 840        struct qeth_token token;
 841        struct qeth_seqno seqno;
 842        struct qeth_card_options options;
 843
 844        struct workqueue_struct *event_wq;
 845        struct workqueue_struct *cmd_wq;
 846        wait_queue_head_t wait_q;
 847
 848        struct mutex ip_lock;
 849        /* protected by ip_lock: */
 850        DECLARE_HASHTABLE(ip_htable, 4);
 851        struct qeth_ipato ipato;
 852
 853        DECLARE_HASHTABLE(local_addrs4, 4);
 854        DECLARE_HASHTABLE(local_addrs6, 4);
 855        spinlock_t local_addrs4_lock;
 856        spinlock_t local_addrs6_lock;
 857        DECLARE_HASHTABLE(rx_mode_addrs, 4);
 858        struct work_struct rx_mode_work;
 859        struct work_struct kernel_thread_starter;
 860        spinlock_t thread_mask_lock;
 861        unsigned long thread_start_mask;
 862        unsigned long thread_allowed_mask;
 863        unsigned long thread_running_mask;
 864        struct list_head cmd_waiter_list;
 865        /* QDIO buffer handling */
 866        struct qeth_qdio_info qdio;
 867        int read_or_write_problem;
 868        struct qeth_osn_info osn_info;
 869        const struct qeth_discipline *discipline;
 870        atomic_t force_alloc_skb;
 871        struct service_level qeth_service_level;
 872        struct qdio_ssqd_desc ssqd;
 873        debug_info_t *debug;
 874        struct mutex sbp_lock;
 875        struct mutex conf_mutex;
 876        struct mutex discipline_mutex;
 877        struct napi_struct napi;
 878        struct qeth_rx rx;
 879        struct delayed_work buffer_reclaim_work;
 880        struct work_struct close_dev_work;
 881};
 882
 883static inline bool qeth_card_hw_is_reachable(struct qeth_card *card)
 884{
 885        return card->state == CARD_STATE_SOFTSETUP;
 886}
 887
 888static inline bool qeth_use_tx_irqs(struct qeth_card *card)
 889{
 890        return !IS_IQD(card);
 891}
 892
 893static inline void qeth_unlock_channel(struct qeth_card *card,
 894                                       struct qeth_channel *channel)
 895{
 896        xchg(&channel->active_cmd, NULL);
 897        wake_up(&card->wait_q);
 898}
 899
 900static inline bool qeth_trylock_channel(struct qeth_channel *channel,
 901                                        struct qeth_cmd_buffer *cmd)
 902{
 903        return cmpxchg(&channel->active_cmd, NULL, cmd) == NULL;
 904}
 905
 906struct qeth_trap_id {
 907        __u16 lparnr;
 908        char vmname[8];
 909        __u8 chpid;
 910        __u8 ssid;
 911        __u16 devno;
 912} __packed;
 913
 914static inline bool qeth_uses_tx_prio_queueing(struct qeth_card *card)
 915{
 916        return card->qdio.do_prio_queueing != QETH_NO_PRIO_QUEUEING;
 917}
 918
 919static inline unsigned int qeth_tx_actual_queues(struct qeth_card *card)
 920{
 921        struct qeth_priv *priv = netdev_priv(card->dev);
 922
 923        if (qeth_uses_tx_prio_queueing(card))
 924                return min(card->dev->num_tx_queues, card->qdio.no_out_queues);
 925
 926        return min(priv->tx_wanted_queues, card->qdio.no_out_queues);
 927}
 928
 929static inline u16 qeth_iqd_translate_txq(struct net_device *dev, u16 txq)
 930{
 931        if (txq == QETH_IQD_MCAST_TXQ)
 932                return dev->num_tx_queues - 1;
 933        if (txq == dev->num_tx_queues - 1)
 934                return QETH_IQD_MCAST_TXQ;
 935        return txq;
 936}
 937
 938static inline bool qeth_iqd_is_mcast_queue(struct qeth_card *card,
 939                                           struct qeth_qdio_out_q *queue)
 940{
 941        return qeth_iqd_translate_txq(card->dev, queue->queue_no) ==
 942               QETH_IQD_MCAST_TXQ;
 943}
 944
 945static inline void qeth_scrub_qdio_buffer(struct qdio_buffer *buf,
 946                                          unsigned int elements)
 947{
 948        unsigned int i;
 949
 950        for (i = 0; i < elements; i++)
 951                memset(&buf->element[i], 0, sizeof(struct qdio_buffer_element));
 952        buf->element[14].sflags = 0;
 953        buf->element[15].sflags = 0;
 954}
 955
 956/**
 957 * qeth_get_elements_for_range() -      find number of SBALEs to cover range.
 958 * @start:                              Start of the address range.
 959 * @end:                                Address after the end of the range.
 960 *
 961 * Returns the number of pages, and thus QDIO buffer elements, needed to cover
 962 * the specified address range.
 963 */
 964static inline int qeth_get_elements_for_range(addr_t start, addr_t end)
 965{
 966        return PFN_UP(end) - PFN_DOWN(start);
 967}
 968
 969static inline int qeth_get_ether_cast_type(struct sk_buff *skb)
 970{
 971        u8 *addr = eth_hdr(skb)->h_dest;
 972
 973        if (is_multicast_ether_addr(addr))
 974                return is_broadcast_ether_addr(addr) ? RTN_BROADCAST :
 975                                                       RTN_MULTICAST;
 976        return RTN_UNICAST;
 977}
 978
 979static inline struct dst_entry *qeth_dst_check_rcu(struct sk_buff *skb,
 980                                                   __be16 proto)
 981{
 982        struct dst_entry *dst = skb_dst(skb);
 983        struct rt6_info *rt;
 984
 985        rt = (struct rt6_info *) dst;
 986        if (dst) {
 987                if (proto == htons(ETH_P_IPV6))
 988                        dst = dst_check(dst, rt6_get_cookie(rt));
 989                else
 990                        dst = dst_check(dst, 0);
 991        }
 992
 993        return dst;
 994}
 995
 996static inline __be32 qeth_next_hop_v4_rcu(struct sk_buff *skb,
 997                                          struct dst_entry *dst)
 998{
 999        struct rtable *rt = (struct rtable *) dst;
1000
1001        return (rt) ? rt_nexthop(rt, ip_hdr(skb)->daddr) : ip_hdr(skb)->daddr;
1002}
1003
1004static inline struct in6_addr *qeth_next_hop_v6_rcu(struct sk_buff *skb,
1005                                                    struct dst_entry *dst)
1006{
1007        struct rt6_info *rt = (struct rt6_info *) dst;
1008
1009        if (rt && !ipv6_addr_any(&rt->rt6i_gateway))
1010                return &rt->rt6i_gateway;
1011        else
1012                return &ipv6_hdr(skb)->daddr;
1013}
1014
1015static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, __be16 proto)
1016{
1017        *flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
1018        if ((proto == htons(ETH_P_IP) && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
1019            (proto == htons(ETH_P_IPV6) && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
1020                *flags |= QETH_HDR_EXT_UDP;
1021}
1022
1023static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
1024                struct qeth_buffer_pool_entry *entry)
1025{
1026        list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
1027}
1028
1029static inline int qeth_is_diagass_supported(struct qeth_card *card,
1030                enum qeth_diags_cmds cmd)
1031{
1032        return card->info.diagass_support & (__u32)cmd;
1033}
1034
1035int qeth_send_simple_setassparms_prot(struct qeth_card *card,
1036                                      enum qeth_ipa_funcs ipa_func,
1037                                      u16 cmd_code, u32 *data,
1038                                      enum qeth_prot_versions prot);
1039/* IPv4 variant */
1040static inline int qeth_send_simple_setassparms(struct qeth_card *card,
1041                                               enum qeth_ipa_funcs ipa_func,
1042                                               u16 cmd_code, u32 *data)
1043{
1044        return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
1045                                                 data, QETH_PROT_IPV4);
1046}
1047
1048static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
1049                                                  enum qeth_ipa_funcs ipa_func,
1050                                                  u16 cmd_code, u32 *data)
1051{
1052        return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
1053                                                 data, QETH_PROT_IPV6);
1054}
1055
1056int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb);
1057
1058extern const struct qeth_discipline qeth_l2_discipline;
1059extern const struct qeth_discipline qeth_l3_discipline;
1060extern const struct ethtool_ops qeth_ethtool_ops;
1061extern const struct ethtool_ops qeth_osn_ethtool_ops;
1062extern const struct attribute_group *qeth_dev_groups[];
1063extern const struct attribute_group *qeth_osn_dev_groups[];
1064extern const struct device_type qeth_generic_devtype;
1065
1066const char *qeth_get_cardname_short(struct qeth_card *);
1067int qeth_resize_buffer_pool(struct qeth_card *card, unsigned int count);
1068int qeth_setup_discipline(struct qeth_card *card, enum qeth_discipline_id disc);
1069void qeth_remove_discipline(struct qeth_card *card);
1070
1071/* exports for qeth discipline device drivers */
1072extern struct kmem_cache *qeth_core_header_cache;
1073extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
1074
1075struct net_device *qeth_clone_netdev(struct net_device *orig);
1076struct qeth_card *qeth_get_card_by_busid(char *bus_id);
1077void qeth_set_allowed_threads(struct qeth_card *card, unsigned long threads,
1078                              int clear_start_mask);
1079int qeth_threads_running(struct qeth_card *, unsigned long);
1080int qeth_set_offline(struct qeth_card *card, const struct qeth_discipline *disc,
1081                     bool resetting);
1082
1083int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
1084                  int (*reply_cb)
1085                  (struct qeth_card *, struct qeth_reply *, unsigned long),
1086                  void *);
1087struct qeth_cmd_buffer *qeth_ipa_alloc_cmd(struct qeth_card *card,
1088                                           enum qeth_ipa_cmds cmd_code,
1089                                           enum qeth_prot_versions prot,
1090                                           unsigned int data_length);
1091struct qeth_cmd_buffer *qeth_alloc_cmd(struct qeth_channel *channel,
1092                                       unsigned int length, unsigned int ccws,
1093                                       long timeout);
1094struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *card,
1095                                                 enum qeth_ipa_funcs ipa_func,
1096                                                 u16 cmd_code,
1097                                                 unsigned int data_length,
1098                                                 enum qeth_prot_versions prot);
1099struct qeth_cmd_buffer *qeth_get_diag_cmd(struct qeth_card *card,
1100                                          enum qeth_diags_cmds sub_cmd,
1101                                          unsigned int data_length);
1102void qeth_notify_cmd(struct qeth_cmd_buffer *iob, int reason);
1103void qeth_put_cmd(struct qeth_cmd_buffer *iob);
1104
1105int qeth_schedule_recovery(struct qeth_card *card);
1106int qeth_poll(struct napi_struct *napi, int budget);
1107void qeth_setadp_promisc_mode(struct qeth_card *card, bool enable);
1108int qeth_setadpparms_change_macaddr(struct qeth_card *);
1109void qeth_tx_timeout(struct net_device *, unsigned int txqueue);
1110void qeth_prepare_ipa_cmd(struct qeth_card *card, struct qeth_cmd_buffer *iob,
1111                          u16 cmd_length,
1112                          bool (*match)(struct qeth_cmd_buffer *iob,
1113                                        struct qeth_cmd_buffer *reply));
1114int qeth_query_switch_attributes(struct qeth_card *card,
1115                                  struct qeth_switch_info *sw_info);
1116int qeth_query_card_info(struct qeth_card *card,
1117                         struct qeth_link_info *link_info);
1118int qeth_setadpparms_set_access_ctrl(struct qeth_card *card,
1119                                     enum qeth_ipa_isolation_modes mode);
1120
1121unsigned int qeth_count_elements(struct sk_buff *skb, unsigned int data_offset);
1122int qeth_do_send_packet(struct qeth_card *card, struct qeth_qdio_out_q *queue,
1123                        struct sk_buff *skb, struct qeth_hdr *hdr,
1124                        unsigned int offset, unsigned int hd_len,
1125                        int elements_needed);
1126int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1127void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1128int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1129int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1130int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1131int qeth_set_features(struct net_device *, netdev_features_t);
1132void qeth_enable_hw_features(struct net_device *dev);
1133netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1134netdev_features_t qeth_features_check(struct sk_buff *skb,
1135                                      struct net_device *dev,
1136                                      netdev_features_t features);
1137void qeth_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats);
1138int qeth_set_real_num_tx_queues(struct qeth_card *card, unsigned int count);
1139u16 qeth_iqd_select_queue(struct net_device *dev, struct sk_buff *skb,
1140                          u8 cast_type, struct net_device *sb_dev);
1141int qeth_open(struct net_device *dev);
1142int qeth_stop(struct net_device *dev);
1143
1144int qeth_vm_request_mac(struct qeth_card *card);
1145int qeth_xmit(struct qeth_card *card, struct sk_buff *skb,
1146              struct qeth_qdio_out_q *queue, __be16 proto,
1147              void (*fill_header)(struct qeth_qdio_out_q *queue,
1148                                  struct qeth_hdr *hdr, struct sk_buff *skb,
1149                                  __be16 proto, unsigned int data_len));
1150
1151/* exports for OSN */
1152int qeth_osn_assist(struct net_device *, void *, int);
1153int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
1154                int (*assist_cb)(struct net_device *, void *),
1155                int (*data_cb)(struct sk_buff *));
1156void qeth_osn_deregister(struct net_device *);
1157
1158#endif /* __QETH_CORE_H__ */
1159