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