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