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