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