drivers/s390/net/qeth_core.h

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