drivers/infiniband/hw/hfi1/sdma.h

   1 #ifndef _HFI1_SDMA_H
   2 #define _HFI1_SDMA_H
   3 /*
   4  * Copyright(c) 2015, 2016 Intel Corporation.
   5  *
   6  * This file is provided under a dual BSD/GPLv2 license.  When using or
   7  * redistributing this file, you may do so under either license.
   8  *
   9  * GPL LICENSE SUMMARY
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * BSD LICENSE
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  *
  26  *  - Redistributions of source code must retain the above copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  *  - Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in
  30  *    the documentation and/or other materials provided with the
  31  *    distribution.
  32  *  - Neither the name of Intel Corporation nor the names of its
  33  *    contributors may be used to endorse or promote products derived
  34  *    from this software without specific prior written permission.
  35  *
  36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  37  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  38  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  39  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  40  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  43  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  44  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  45  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  46  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  47  *
  48  */
  49
  50 #include <linux/types.h>
  51 #include <linux/list.h>
  52 #include <asm/byteorder.h>
  53 #include <linux/workqueue.h>
  54 #include <linux/rculist.h>
  55
  56 #include "hfi.h"
  57 #include "verbs.h"
  58 #include "sdma_txreq.h"
  59
  60 /* Hardware limit */
  61 #define MAX_DESC 64
  62 /* Hardware limit for SDMA packet size */
  63 #define MAX_SDMA_PKT_SIZE ((16 * 1024) - 1)
  64
  65 #define SDMA_TXREQ_S_OK        0
  66 #define SDMA_TXREQ_S_SENDERROR 1
  67 #define SDMA_TXREQ_S_ABORTED   2
  68 #define SDMA_TXREQ_S_SHUTDOWN  3
  69
  70 /* flags bits */
  71 #define SDMA_TXREQ_F_URGENT       0x0001
  72 #define SDMA_TXREQ_F_AHG_COPY     0x0002
  73 #define SDMA_TXREQ_F_USE_AHG      0x0004
  74
  75 #define SDMA_MAP_NONE          0
  76 #define SDMA_MAP_SINGLE        1
  77 #define SDMA_MAP_PAGE          2
  78
  79 #define SDMA_AHG_VALUE_MASK          0xffff
  80 #define SDMA_AHG_VALUE_SHIFT         0
  81 #define SDMA_AHG_INDEX_MASK          0xf
  82 #define SDMA_AHG_INDEX_SHIFT         16
  83 #define SDMA_AHG_FIELD_LEN_MASK      0xf
  84 #define SDMA_AHG_FIELD_LEN_SHIFT     20
  85 #define SDMA_AHG_FIELD_START_MASK    0x1f
  86 #define SDMA_AHG_FIELD_START_SHIFT   24
  87 #define SDMA_AHG_UPDATE_ENABLE_MASK  0x1
  88 #define SDMA_AHG_UPDATE_ENABLE_SHIFT 31
  89
  90 /* AHG modes */
  91
  92 /*
  93  * Be aware the ordering and values
  94  * for SDMA_AHG_APPLY_UPDATE[123]
  95  * are assumed in generating a skip
  96  * count in submit_tx() in sdma.c
  97  */
  98 #define SDMA_AHG_NO_AHG              0
  99 #define SDMA_AHG_COPY                1
 100 #define SDMA_AHG_APPLY_UPDATE1       2
 101 #define SDMA_AHG_APPLY_UPDATE2       3
 102 #define SDMA_AHG_APPLY_UPDATE3       4
 103
 104 /*
 105  * Bits defined in the send DMA descriptor.
 106  */
 107 #define SDMA_DESC0_FIRST_DESC_FLAG      BIT_ULL(63)
 108 #define SDMA_DESC0_LAST_DESC_FLAG       BIT_ULL(62)
 109 #define SDMA_DESC0_BYTE_COUNT_SHIFT     48
 110 #define SDMA_DESC0_BYTE_COUNT_WIDTH     14
 111 #define SDMA_DESC0_BYTE_COUNT_MASK \
 112         ((1ULL << SDMA_DESC0_BYTE_COUNT_WIDTH) - 1)
 113 #define SDMA_DESC0_BYTE_COUNT_SMASK \
 114         (SDMA_DESC0_BYTE_COUNT_MASK << SDMA_DESC0_BYTE_COUNT_SHIFT)
 115 #define SDMA_DESC0_PHY_ADDR_SHIFT       0
 116 #define SDMA_DESC0_PHY_ADDR_WIDTH       48
 117 #define SDMA_DESC0_PHY_ADDR_MASK \
 118         ((1ULL << SDMA_DESC0_PHY_ADDR_WIDTH) - 1)
 119 #define SDMA_DESC0_PHY_ADDR_SMASK \
 120         (SDMA_DESC0_PHY_ADDR_MASK << SDMA_DESC0_PHY_ADDR_SHIFT)
 121
 122 #define SDMA_DESC1_HEADER_UPDATE1_SHIFT 32
 123 #define SDMA_DESC1_HEADER_UPDATE1_WIDTH 32
 124 #define SDMA_DESC1_HEADER_UPDATE1_MASK \
 125         ((1ULL << SDMA_DESC1_HEADER_UPDATE1_WIDTH) - 1)
 126 #define SDMA_DESC1_HEADER_UPDATE1_SMASK \
 127         (SDMA_DESC1_HEADER_UPDATE1_MASK << SDMA_DESC1_HEADER_UPDATE1_SHIFT)
 128 #define SDMA_DESC1_HEADER_MODE_SHIFT    13
 129 #define SDMA_DESC1_HEADER_MODE_WIDTH    3
 130 #define SDMA_DESC1_HEADER_MODE_MASK \
 131         ((1ULL << SDMA_DESC1_HEADER_MODE_WIDTH) - 1)
 132 #define SDMA_DESC1_HEADER_MODE_SMASK \
 133         (SDMA_DESC1_HEADER_MODE_MASK << SDMA_DESC1_HEADER_MODE_SHIFT)
 134 #define SDMA_DESC1_HEADER_INDEX_SHIFT   8
 135 #define SDMA_DESC1_HEADER_INDEX_WIDTH   5
 136 #define SDMA_DESC1_HEADER_INDEX_MASK \
 137         ((1ULL << SDMA_DESC1_HEADER_INDEX_WIDTH) - 1)
 138 #define SDMA_DESC1_HEADER_INDEX_SMASK \
 139         (SDMA_DESC1_HEADER_INDEX_MASK << SDMA_DESC1_HEADER_INDEX_SHIFT)
 140 #define SDMA_DESC1_HEADER_DWS_SHIFT     4
 141 #define SDMA_DESC1_HEADER_DWS_WIDTH     4
 142 #define SDMA_DESC1_HEADER_DWS_MASK \
 143         ((1ULL << SDMA_DESC1_HEADER_DWS_WIDTH) - 1)
 144 #define SDMA_DESC1_HEADER_DWS_SMASK \
 145         (SDMA_DESC1_HEADER_DWS_MASK << SDMA_DESC1_HEADER_DWS_SHIFT)
 146 #define SDMA_DESC1_GENERATION_SHIFT     2
 147 #define SDMA_DESC1_GENERATION_WIDTH     2
 148 #define SDMA_DESC1_GENERATION_MASK \
 149         ((1ULL << SDMA_DESC1_GENERATION_WIDTH) - 1)
 150 #define SDMA_DESC1_GENERATION_SMASK \
 151         (SDMA_DESC1_GENERATION_MASK << SDMA_DESC1_GENERATION_SHIFT)
 152 #define SDMA_DESC1_INT_REQ_FLAG         BIT_ULL(1)
 153 #define SDMA_DESC1_HEAD_TO_HOST_FLAG    BIT_ULL(0)
 154
 155 enum sdma_states {
 156         sdma_state_s00_hw_down,
 157         sdma_state_s10_hw_start_up_halt_wait,
 158         sdma_state_s15_hw_start_up_clean_wait,
 159         sdma_state_s20_idle,
 160         sdma_state_s30_sw_clean_up_wait,
 161         sdma_state_s40_hw_clean_up_wait,
 162         sdma_state_s50_hw_halt_wait,
 163         sdma_state_s60_idle_halt_wait,
 164         sdma_state_s80_hw_freeze,
 165         sdma_state_s82_freeze_sw_clean,
 166         sdma_state_s99_running,
 167 };
 168
 169 enum sdma_events {
 170         sdma_event_e00_go_hw_down,
 171         sdma_event_e10_go_hw_start,
 172         sdma_event_e15_hw_halt_done,
 173         sdma_event_e25_hw_clean_up_done,
 174         sdma_event_e30_go_running,
 175         sdma_event_e40_sw_cleaned,
 176         sdma_event_e50_hw_cleaned,
 177         sdma_event_e60_hw_halted,
 178         sdma_event_e70_go_idle,
 179         sdma_event_e80_hw_freeze,
 180         sdma_event_e81_hw_frozen,
 181         sdma_event_e82_hw_unfreeze,
 182         sdma_event_e85_link_down,
 183         sdma_event_e90_sw_halted,
 184 };
 185
 186 struct sdma_set_state_action {
 187         unsigned op_enable:1;
 188         unsigned op_intenable:1;
 189         unsigned op_halt:1;
 190         unsigned op_cleanup:1;
 191         unsigned go_s99_running_tofalse:1;
 192         unsigned go_s99_running_totrue:1;
 193 };
 194
 195 struct sdma_state {
 196         struct kref          kref;
 197         struct completion    comp;
 198         enum sdma_states current_state;
 199         unsigned             current_op;
 200         unsigned             go_s99_running;
 201         /* debugging/development */
 202         enum sdma_states previous_state;
 203         unsigned             previous_op;
 204         enum sdma_events last_event;
 205 };
 206
 207 /**
 208  * DOC: sdma exported routines
 209  *
 210  * These sdma routines fit into three categories:
 211  * - The SDMA API for building and submitting packets
 212  *   to the ring
 213  *
 214  * - Initialization and tear down routines to buildup
 215  *   and tear down SDMA
 216  *
 217  * - ISR entrances to handle interrupts, state changes
 218  *   and errors
 219  */
 220
 221 /**
 222  * DOC: sdma PSM/verbs API
 223  *
 224  * The sdma API is designed to be used by both PSM
 225  * and verbs to supply packets to the SDMA ring.
 226  *
 227  * The usage of the API is as follows:
 228  *
 229  * Embed a struct iowait in the QP or
 230  * PQ.  The iowait should be initialized with a
 231  * call to iowait_init().
 232  *
 233  * The user of the API should create an allocation method
 234  * for their version of the txreq. slabs, pre-allocated lists,
 235  * and dma pools can be used.  Once the user's overload of
 236  * the sdma_txreq has been allocated, the sdma_txreq member
 237  * must be initialized with sdma_txinit() or sdma_txinit_ahg().
 238  *
 239  * The txreq must be declared with the sdma_txreq first.
 240  *
 241  * The tx request, once initialized,  is manipulated with calls to
 242  * sdma_txadd_daddr(), sdma_txadd_page(), or sdma_txadd_kvaddr()
 243  * for each disjoint memory location.  It is the user's responsibility
 244  * to understand the packet boundaries and page boundaries to do the
 245  * appropriate number of sdma_txadd_* calls..  The user
 246  * must be prepared to deal with failures from these routines due to
 247  * either memory allocation or dma_mapping failures.
 248  *
 249  * The mapping specifics for each memory location are recorded
 250  * in the tx. Memory locations added with sdma_txadd_page()
 251  * and sdma_txadd_kvaddr() are automatically mapped when added
 252  * to the tx and nmapped as part of the progress processing in the
 253  * SDMA interrupt handling.
 254  *
 255  * sdma_txadd_daddr() is used to add an dma_addr_t memory to the
 256  * tx.   An example of a use case would be a pre-allocated
 257  * set of headers allocated via dma_pool_alloc() or
 258  * dma_alloc_coherent().  For these memory locations, it
 259  * is the responsibility of the user to handle that unmapping.
 260  * (This would usually be at an unload or job termination.)
 261  *
 262  * The routine sdma_send_txreq() is used to submit
 263  * a tx to the ring after the appropriate number of
 264  * sdma_txadd_* have been done.
 265  *
 266  * If it is desired to send a burst of sdma_txreqs, sdma_send_txlist()
 267  * can be used to submit a list of packets.
 268  *
 269  * The user is free to use the link overhead in the struct sdma_txreq as
 270  * long as the tx isn't in flight.
 271  *
 272  * The extreme degenerate case of the number of descriptors
 273  * exceeding the ring size is automatically handled as
 274  * memory locations are added.  An overflow of the descriptor
 275  * array that is part of the sdma_txreq is also automatically
 276  * handled.
 277  *
 278  */
 279
 280 /**
 281  * DOC: Infrastructure calls
 282  *
 283  * sdma_init() is used to initialize data structures and
 284  * CSRs for the desired number of SDMA engines.
 285  *
 286  * sdma_start() is used to kick the SDMA engines initialized
 287  * with sdma_init().   Interrupts must be enabled at this
 288  * point since aspects of the state machine are interrupt
 289  * driven.
 290  *
 291  * sdma_engine_error() and sdma_engine_interrupt() are
 292  * entrances for interrupts.
 293  *
 294  * sdma_map_init() is for the management of the mapping
 295  * table when the number of vls is changed.
 296  *
 297  */
 298
 299 /*
 300  * struct hw_sdma_desc - raw 128 bit SDMA descriptor
 301  *
 302  * This is the raw descriptor in the SDMA ring
 303  */
 304 struct hw_sdma_desc {
 305         /* private:  don't use directly */
 306         __le64 qw[2];
 307 };
 308
 309 /**
 310  * struct sdma_engine - Data pertaining to each SDMA engine.
 311  * @dd: a back-pointer to the device data
 312  * @ppd: per port back-pointer
 313  * @imask: mask for irq manipulation
 314  * @idle_mask: mask for determining if an interrupt is due to sdma_idle
 315  *
 316  * This structure has the state for each sdma_engine.
 317  *
 318  * Accessing to non public fields are not supported
 319  * since the private members are subject to change.
 320  */
 321 struct sdma_engine {
 322         /* read mostly */
 323         struct hfi1_devdata *dd;
 324         struct hfi1_pportdata *ppd;
 325         /* private: */
 326         void __iomem *tail_csr;
 327         u64 imask;                      /* clear interrupt mask */
 328         u64 idle_mask;
 329         u64 progress_mask;
 330         u64 int_mask;
 331         /* private: */
 332         volatile __le64      *head_dma; /* DMA'ed by chip */
 333         /* private: */
 334         dma_addr_t            head_phys;
 335         /* private: */
 336         struct hw_sdma_desc *descq;
 337         /* private: */
 338         unsigned descq_full_count;
 339         struct sdma_txreq **tx_ring;
 340         /* private: */
 341         dma_addr_t            descq_phys;
 342         /* private */
 343         u32 sdma_mask;
 344         /* private */
 345         struct sdma_state state;
 346         /* private */
 347         int cpu;
 348         /* private: */
 349         u8 sdma_shift;
 350         /* private: */
 351         u8 this_idx; /* zero relative engine */
 352         /* protect changes to senddmactrl shadow */
 353         spinlock_t senddmactrl_lock;
 354         /* private: */
 355         u64 p_senddmactrl;              /* shadow per-engine SendDmaCtrl */
 356
 357         /* read/write using tail_lock */
 358         spinlock_t            tail_lock ____cacheline_aligned_in_smp;
 359 #ifdef CONFIG_HFI1_DEBUG_SDMA_ORDER
 360         /* private: */
 361         u64                   tail_sn;
 362 #endif
 363         /* private: */
 364         u32                   descq_tail;
 365         /* private: */
 366         unsigned long         ahg_bits;
 367         /* private: */
 368         u16                   desc_avail;
 369         /* private: */
 370         u16                   tx_tail;
 371         /* private: */
 372         u16 descq_cnt;
 373
 374         /* read/write using head_lock */
 375         /* private: */
 376         seqlock_t            head_lock ____cacheline_aligned_in_smp;
 377 #ifdef CONFIG_HFI1_DEBUG_SDMA_ORDER
 378         /* private: */
 379         u64                   head_sn;
 380 #endif
 381         /* private: */
 382         u32                   descq_head;
 383         /* private: */
 384         u16                   tx_head;
 385         /* private: */
 386         u64                   last_status;
 387         /* private */
 388         u64                     err_cnt;
 389         /* private */
 390         u64                     sdma_int_cnt;
 391         u64                     idle_int_cnt;
 392         u64                     progress_int_cnt;
 393
 394         /* private: */
 395         struct list_head      dmawait;
 396
 397         /* CONFIG SDMA for now, just blindly duplicate */
 398         /* private: */
 399         struct tasklet_struct sdma_hw_clean_up_task
 400                 ____cacheline_aligned_in_smp;
 401
 402         /* private: */
 403         struct tasklet_struct sdma_sw_clean_up_task
 404                 ____cacheline_aligned_in_smp;
 405         /* private: */
 406         struct work_struct err_halt_worker;
 407         /* private */
 408         struct timer_list     err_progress_check_timer;
 409         u32                   progress_check_head;
 410         /* private: */
 411         struct work_struct flush_worker;
 412         /* protect flush list */
 413         spinlock_t flushlist_lock;
 414         /* private: */
 415         struct list_head flushlist;
 416 };
 417
 418 int sdma_init(struct hfi1_devdata *dd, u8 port);
 419 void sdma_start(struct hfi1_devdata *dd);
 420 void sdma_exit(struct hfi1_devdata *dd);
 421 void sdma_all_running(struct hfi1_devdata *dd);
 422 void sdma_all_idle(struct hfi1_devdata *dd);
 423 void sdma_freeze_notify(struct hfi1_devdata *dd, int go_idle);
 424 void sdma_freeze(struct hfi1_devdata *dd);
 425 void sdma_unfreeze(struct hfi1_devdata *dd);
 426 void sdma_wait(struct hfi1_devdata *dd);
 427
 428 /**
 429  * sdma_empty() - idle engine test
 430  * @engine: sdma engine
 431  *
 432  * Currently used by verbs as a latency optimization.
 433  *
 434  * Return:
 435  * 1 - empty, 0 - non-empty
 436  */
 437 static inline int sdma_empty(struct sdma_engine *sde)
 438 {
 439         return sde->descq_tail == sde->descq_head;
 440 }
 441
 442 static inline u16 sdma_descq_freecnt(struct sdma_engine *sde)
 443 {
 444         return sde->descq_cnt -
 445                 (sde->descq_tail -
 446                  ACCESS_ONCE(sde->descq_head)) - 1;
 447 }
 448
 449 static inline u16 sdma_descq_inprocess(struct sdma_engine *sde)
 450 {
 451         return sde->descq_cnt - sdma_descq_freecnt(sde);
 452 }
 453
 454 /*
 455  * Either head_lock or tail lock required to see
 456  * a steady state.
 457  */
 458 static inline int __sdma_running(struct sdma_engine *engine)
 459 {
 460         return engine->state.current_state == sdma_state_s99_running;
 461 }
 462
 463 /**
 464  * sdma_running() - state suitability test
 465  * @engine: sdma engine
 466  *
 467  * sdma_running probes the internal state to determine if it is suitable
 468  * for submitting packets.
 469  *
 470  * Return:
 471  * 1 - ok to submit, 0 - not ok to submit
 472  *
 473  */
 474 static inline int sdma_running(struct sdma_engine *engine)
 475 {
 476         unsigned long flags;
 477         int ret;
 478
 479         spin_lock_irqsave(&engine->tail_lock, flags);
 480         ret = __sdma_running(engine);
 481         spin_unlock_irqrestore(&engine->tail_lock, flags);
 482         return ret;
 483 }
 484
 485 void _sdma_txreq_ahgadd(
 486         struct sdma_txreq *tx,
 487         u8 num_ahg,
 488         u8 ahg_entry,
 489         u32 *ahg,
 490         u8 ahg_hlen);
 491
 492 /**
 493  * sdma_txinit_ahg() - initialize an sdma_txreq struct with AHG
 494  * @tx: tx request to initialize
 495  * @flags: flags to key last descriptor additions
 496  * @tlen: total packet length (pbc + headers + data)
 497  * @ahg_entry: ahg entry to use  (0 - 31)
 498  * @num_ahg: ahg descriptor for first descriptor (0 - 9)
 499  * @ahg: array of AHG descriptors (up to 9 entries)
 500  * @ahg_hlen: number of bytes from ASIC entry to use
 501  * @cb: callback
 502  *
 503  * The allocation of the sdma_txreq and it enclosing structure is user
 504  * dependent.  This routine must be called to initialize the user independent
 505  * fields.
 506  *
 507  * The currently supported flags are SDMA_TXREQ_F_URGENT,
 508  * SDMA_TXREQ_F_AHG_COPY, and SDMA_TXREQ_F_USE_AHG.
 509  *
 510  * SDMA_TXREQ_F_URGENT is used for latency sensitive situations where the
 511  * completion is desired as soon as possible.
 512  *
 513  * SDMA_TXREQ_F_AHG_COPY causes the header in the first descriptor to be
 514  * copied to chip entry. SDMA_TXREQ_F_USE_AHG causes the code to add in
 515  * the AHG descriptors into the first 1 to 3 descriptors.
 516  *
 517  * Completions of submitted requests can be gotten on selected
 518  * txreqs by giving a completion routine callback to sdma_txinit() or
 519  * sdma_txinit_ahg().  The environment in which the callback runs
 520  * can be from an ISR, a tasklet, or a thread, so no sleeping
 521  * kernel routines can be used.   Aspects of the sdma ring may
 522  * be locked so care should be taken with locking.
 523  *
 524  * The callback pointer can be NULL to avoid any callback for the packet
 525  * being submitted. The callback will be provided this tx, a status, and a flag.
 526  *
 527  * The status will be one of SDMA_TXREQ_S_OK, SDMA_TXREQ_S_SENDERROR,
 528  * SDMA_TXREQ_S_ABORTED, or SDMA_TXREQ_S_SHUTDOWN.
 529  *
 530  * The flag, if the is the iowait had been used, indicates the iowait
 531  * sdma_busy count has reached zero.
 532  *
 533  * user data portion of tlen should be precise.   The sdma_txadd_* entrances
 534  * will pad with a descriptor references 1 - 3 bytes when the number of bytes
 535  * specified in tlen have been supplied to the sdma_txreq.
 536  *
 537  * ahg_hlen is used to determine the number of on-chip entry bytes to
 538  * use as the header.   This is for cases where the stored header is
 539  * larger than the header to be used in a packet.  This is typical
 540  * for verbs where an RDMA_WRITE_FIRST is larger than the packet in
 541  * and RDMA_WRITE_MIDDLE.
 542  *
 543  */
 544 static inline int sdma_txinit_ahg(
 545         struct sdma_txreq *tx,
 546         u16 flags,
 547         u16 tlen,
 548         u8 ahg_entry,
 549         u8 num_ahg,
 550         u32 *ahg,
 551         u8 ahg_hlen,
 552         void (*cb)(struct sdma_txreq *, int))
 553 {
 554         if (tlen == 0)
 555                 return -ENODATA;
 556         if (tlen > MAX_SDMA_PKT_SIZE)
 557                 return -EMSGSIZE;
 558         tx->desc_limit = ARRAY_SIZE(tx->descs);
 559         tx->descp = &tx->descs[0];
 560         INIT_LIST_HEAD(&tx->list);
 561         tx->num_desc = 0;
 562         tx->flags = flags;
 563         tx->complete = cb;
 564         tx->coalesce_buf = NULL;
 565         tx->wait = NULL;
 566         tx->packet_len = tlen;
 567         tx->tlen = tx->packet_len;
 568         tx->descs[0].qw[0] = SDMA_DESC0_FIRST_DESC_FLAG;
 569         tx->descs[0].qw[1] = 0;
 570         if (flags & SDMA_TXREQ_F_AHG_COPY)
 571                 tx->descs[0].qw[1] |=
 572                         (((u64)ahg_entry & SDMA_DESC1_HEADER_INDEX_MASK)
 573                                 << SDMA_DESC1_HEADER_INDEX_SHIFT) |
 574                         (((u64)SDMA_AHG_COPY & SDMA_DESC1_HEADER_MODE_MASK)
 575                                 << SDMA_DESC1_HEADER_MODE_SHIFT);
 576         else if (flags & SDMA_TXREQ_F_USE_AHG && num_ahg)
 577                 _sdma_txreq_ahgadd(tx, num_ahg, ahg_entry, ahg, ahg_hlen);
 578         return 0;
 579 }
 580
 581 /**
 582  * sdma_txinit() - initialize an sdma_txreq struct (no AHG)
 583  * @tx: tx request to initialize
 584  * @flags: flags to key last descriptor additions
 585  * @tlen: total packet length (pbc + headers + data)
 586  * @cb: callback pointer
 587  *
 588  * The allocation of the sdma_txreq and it enclosing structure is user
 589  * dependent.  This routine must be called to initialize the user
 590  * independent fields.
 591  *
 592  * The currently supported flags is SDMA_TXREQ_F_URGENT.
 593  *
 594  * SDMA_TXREQ_F_URGENT is used for latency sensitive situations where the
 595  * completion is desired as soon as possible.
 596  *
 597  * Completions of submitted requests can be gotten on selected
 598  * txreqs by giving a completion routine callback to sdma_txinit() or
 599  * sdma_txinit_ahg().  The environment in which the callback runs
 600  * can be from an ISR, a tasklet, or a thread, so no sleeping
 601  * kernel routines can be used.   The head size of the sdma ring may
 602  * be locked so care should be taken with locking.
 603  *
 604  * The callback pointer can be NULL to avoid any callback for the packet
 605  * being submitted.
 606  *
 607  * The callback, if non-NULL,  will be provided this tx and a status.  The
 608  * status will be one of SDMA_TXREQ_S_OK, SDMA_TXREQ_S_SENDERROR,
 609  * SDMA_TXREQ_S_ABORTED, or SDMA_TXREQ_S_SHUTDOWN.
 610  *
 611  */
 612 static inline int sdma_txinit(
 613         struct sdma_txreq *tx,
 614         u16 flags,
 615         u16 tlen,
 616         void (*cb)(struct sdma_txreq *, int))
 617 {
 618         return sdma_txinit_ahg(tx, flags, tlen, 0, 0, NULL, 0, cb);
 619 }
 620
 621 /* helpers - don't use */
 622 static inline int sdma_mapping_type(struct sdma_desc *d)
 623 {
 624         return (d->qw[1] & SDMA_DESC1_GENERATION_SMASK)
 625                 >> SDMA_DESC1_GENERATION_SHIFT;
 626 }
 627
 628 static inline size_t sdma_mapping_len(struct sdma_desc *d)
 629 {
 630         return (d->qw[0] & SDMA_DESC0_BYTE_COUNT_SMASK)
 631                 >> SDMA_DESC0_BYTE_COUNT_SHIFT;
 632 }
 633
 634 static inline dma_addr_t sdma_mapping_addr(struct sdma_desc *d)
 635 {
 636         return (d->qw[0] & SDMA_DESC0_PHY_ADDR_SMASK)
 637                 >> SDMA_DESC0_PHY_ADDR_SHIFT;
 638 }
 639
 640 static inline void make_tx_sdma_desc(
 641         struct sdma_txreq *tx,
 642         int type,
 643         dma_addr_t addr,
 644         size_t len)
 645 {
 646         struct sdma_desc *desc = &tx->descp[tx->num_desc];
 647
 648         if (!tx->num_desc) {
 649                 /* qw[0] zero; qw[1] first, ahg mode already in from init */
 650                 desc->qw[1] |= ((u64)type & SDMA_DESC1_GENERATION_MASK)
 651                                 << SDMA_DESC1_GENERATION_SHIFT;
 652         } else {
 653                 desc->qw[0] = 0;
 654                 desc->qw[1] = ((u64)type & SDMA_DESC1_GENERATION_MASK)
 655                                 << SDMA_DESC1_GENERATION_SHIFT;
 656         }
 657         desc->qw[0] |= (((u64)addr & SDMA_DESC0_PHY_ADDR_MASK)
 658                                 << SDMA_DESC0_PHY_ADDR_SHIFT) |
 659                         (((u64)len & SDMA_DESC0_BYTE_COUNT_MASK)
 660                                 << SDMA_DESC0_BYTE_COUNT_SHIFT);
 661 }
 662
 663 /* helper to extend txreq */
 664 int ext_coal_sdma_tx_descs(struct hfi1_devdata *dd, struct sdma_txreq *tx,
 665                            int type, void *kvaddr, struct page *page,
 666                            unsigned long offset, u16 len);
 667 int _pad_sdma_tx_descs(struct hfi1_devdata *, struct sdma_txreq *);
 668 void sdma_txclean(struct hfi1_devdata *, struct sdma_txreq *);
 669
 670 /* helpers used by public routines */
 671 static inline void _sdma_close_tx(struct hfi1_devdata *dd,
 672                                   struct sdma_txreq *tx)
 673 {
 674         tx->descp[tx->num_desc].qw[0] |=
 675                 SDMA_DESC0_LAST_DESC_FLAG;
 676         tx->descp[tx->num_desc].qw[1] |=
 677                 dd->default_desc1;
 678         if (tx->flags & SDMA_TXREQ_F_URGENT)
 679                 tx->descp[tx->num_desc].qw[1] |=
 680                         (SDMA_DESC1_HEAD_TO_HOST_FLAG |
 681                          SDMA_DESC1_INT_REQ_FLAG);
 682 }
 683
 684 static inline int _sdma_txadd_daddr(
 685         struct hfi1_devdata *dd,
 686         int type,
 687         struct sdma_txreq *tx,
 688         dma_addr_t addr,
 689         u16 len)
 690 {
 691         int rval = 0;
 692
 693         make_tx_sdma_desc(
 694                 tx,
 695                 type,
 696                 addr, len);
 697         WARN_ON(len > tx->tlen);
 698         tx->tlen -= len;
 699         /* special cases for last */
 700         if (!tx->tlen) {
 701                 if (tx->packet_len & (sizeof(u32) - 1)) {
 702                         rval = _pad_sdma_tx_descs(dd, tx);
 703                         if (rval)
 704                                 return rval;
 705                 } else {
 706                         _sdma_close_tx(dd, tx);
 707                 }
 708         }
 709         tx->num_desc++;
 710         return rval;
 711 }
 712
 713 /**
 714  * sdma_txadd_page() - add a page to the sdma_txreq
 715  * @dd: the device to use for mapping
 716  * @tx: tx request to which the page is added
 717  * @page: page to map
 718  * @offset: offset within the page
 719  * @len: length in bytes
 720  *
 721  * This is used to add a page/offset/length descriptor.
 722  *
 723  * The mapping/unmapping of the page/offset/len is automatically handled.
 724  *
 725  * Return:
 726  * 0 - success, -ENOSPC - mapping fail, -ENOMEM - couldn't
 727  * extend/coalesce descriptor array
 728  */
 729 static inline int sdma_txadd_page(
 730         struct hfi1_devdata *dd,
 731         struct sdma_txreq *tx,
 732         struct page *page,
 733         unsigned long offset,
 734         u16 len)
 735 {
 736         dma_addr_t addr;
 737         int rval;
 738
 739         if ((unlikely(tx->num_desc == tx->desc_limit))) {
 740                 rval = ext_coal_sdma_tx_descs(dd, tx, SDMA_MAP_PAGE,
 741                                               NULL, page, offset, len);
 742                 if (rval <= 0)
 743                         return rval;
 744         }
 745
 746         addr = dma_map_page(
 747                        &dd->pcidev->dev,
 748                        page,
 749                        offset,
 750                        len,
 751                        DMA_TO_DEVICE);
 752
 753         if (unlikely(dma_mapping_error(&dd->pcidev->dev, addr))) {
 754                 sdma_txclean(dd, tx);
 755                 return -ENOSPC;
 756         }
 757
 758         return _sdma_txadd_daddr(
 759                         dd, SDMA_MAP_PAGE, tx, addr, len);
 760 }
 761
 762 /**
 763  * sdma_txadd_daddr() - add a dma address to the sdma_txreq
 764  * @dd: the device to use for mapping
 765  * @tx: sdma_txreq to which the page is added
 766  * @addr: dma address mapped by caller
 767  * @len: length in bytes
 768  *
 769  * This is used to add a descriptor for memory that is already dma mapped.
 770  *
 771  * In this case, there is no unmapping as part of the progress processing for
 772  * this memory location.
 773  *
 774  * Return:
 775  * 0 - success, -ENOMEM - couldn't extend descriptor array
 776  */
 777
 778 static inline int sdma_txadd_daddr(
 779         struct hfi1_devdata *dd,
 780         struct sdma_txreq *tx,
 781         dma_addr_t addr,
 782         u16 len)
 783 {
 784         int rval;
 785
 786         if ((unlikely(tx->num_desc == tx->desc_limit))) {
 787                 rval = ext_coal_sdma_tx_descs(dd, tx, SDMA_MAP_NONE,
 788                                               NULL, NULL, 0, 0);
 789                 if (rval <= 0)
 790                         return rval;
 791         }
 792
 793         return _sdma_txadd_daddr(dd, SDMA_MAP_NONE, tx, addr, len);
 794 }
 795
 796 /**
 797  * sdma_txadd_kvaddr() - add a kernel virtual address to sdma_txreq
 798  * @dd: the device to use for mapping
 799  * @tx: sdma_txreq to which the page is added
 800  * @kvaddr: the kernel virtual address
 801  * @len: length in bytes
 802  *
 803  * This is used to add a descriptor referenced by the indicated kvaddr and
 804  * len.
 805  *
 806  * The mapping/unmapping of the kvaddr and len is automatically handled.
 807  *
 808  * Return:
 809  * 0 - success, -ENOSPC - mapping fail, -ENOMEM - couldn't extend/coalesce
 810  * descriptor array
 811  */
 812 static inline int sdma_txadd_kvaddr(
 813         struct hfi1_devdata *dd,
 814         struct sdma_txreq *tx,
 815         void *kvaddr,
 816         u16 len)
 817 {
 818         dma_addr_t addr;
 819         int rval;
 820
 821         if ((unlikely(tx->num_desc == tx->desc_limit))) {
 822                 rval = ext_coal_sdma_tx_descs(dd, tx, SDMA_MAP_SINGLE,
 823                                               kvaddr, NULL, 0, len);
 824                 if (rval <= 0)
 825                         return rval;
 826         }
 827
 828         addr = dma_map_single(
 829                        &dd->pcidev->dev,
 830                        kvaddr,
 831                        len,
 832                        DMA_TO_DEVICE);
 833
 834         if (unlikely(dma_mapping_error(&dd->pcidev->dev, addr))) {
 835                 sdma_txclean(dd, tx);
 836                 return -ENOSPC;
 837         }
 838
 839         return _sdma_txadd_daddr(
 840                         dd, SDMA_MAP_SINGLE, tx, addr, len);
 841 }
 842
 843 struct iowait;
 844
 845 int sdma_send_txreq(struct sdma_engine *sde,
 846                     struct iowait *wait,
 847                     struct sdma_txreq *tx);
 848 int sdma_send_txlist(struct sdma_engine *sde,
 849                      struct iowait *wait,
 850                      struct list_head *tx_list);
 851
 852 int sdma_ahg_alloc(struct sdma_engine *sde);
 853 void sdma_ahg_free(struct sdma_engine *sde, int ahg_index);
 854
 855 /**
 856  * sdma_build_ahg - build ahg descriptor
 857  * @data
 858  * @dwindex
 859  * @startbit
 860  * @bits
 861  *
 862  * Build and return a 32 bit descriptor.
 863  */
 864 static inline u32 sdma_build_ahg_descriptor(
 865         u16 data,
 866         u8 dwindex,
 867         u8 startbit,
 868         u8 bits)
 869 {
 870         return (u32)(1UL << SDMA_AHG_UPDATE_ENABLE_SHIFT |
 871                 ((startbit & SDMA_AHG_FIELD_START_MASK) <<
 872                 SDMA_AHG_FIELD_START_SHIFT) |
 873                 ((bits & SDMA_AHG_FIELD_LEN_MASK) <<
 874                 SDMA_AHG_FIELD_LEN_SHIFT) |
 875                 ((dwindex & SDMA_AHG_INDEX_MASK) <<
 876                 SDMA_AHG_INDEX_SHIFT) |
 877                 ((data & SDMA_AHG_VALUE_MASK) <<
 878                 SDMA_AHG_VALUE_SHIFT));
 879 }
 880
 881 /**
 882  * sdma_progress - use seq number of detect head progress
 883  * @sde: sdma_engine to check
 884  * @seq: base seq count
 885  * @tx: txreq for which we need to check descriptor availability
 886  *
 887  * This is used in the appropriate spot in the sleep routine
 888  * to check for potential ring progress.  This routine gets the
 889  * seqcount before queuing the iowait structure for progress.
 890  *
 891  * If the seqcount indicates that progress needs to be checked,
 892  * re-submission is detected by checking whether the descriptor
 893  * queue has enough descriptor for the txreq.
 894  */
 895 static inline unsigned sdma_progress(struct sdma_engine *sde, unsigned seq,
 896                                      struct sdma_txreq *tx)
 897 {
 898         if (read_seqretry(&sde->head_lock, seq)) {
 899                 sde->desc_avail = sdma_descq_freecnt(sde);
 900                 if (tx->num_desc > sde->desc_avail)
 901                         return 0;
 902                 return 1;
 903         }
 904         return 0;
 905 }
 906
 907 /**
 908  * sdma_iowait_schedule() - initialize wait structure
 909  * @sde: sdma_engine to schedule
 910  * @wait: wait struct to schedule
 911  *
 912  * This function initializes the iowait
 913  * structure embedded in the QP or PQ.
 914  *
 915  */
 916 static inline void sdma_iowait_schedule(
 917         struct sdma_engine *sde,
 918         struct iowait *wait)
 919 {
 920         struct hfi1_pportdata *ppd = sde->dd->pport;
 921
 922         iowait_schedule(wait, ppd->hfi1_wq, sde->cpu);
 923 }
 924
 925 /* for use by interrupt handling */
 926 void sdma_engine_error(struct sdma_engine *sde, u64 status);
 927 void sdma_engine_interrupt(struct sdma_engine *sde, u64 status);
 928
 929 /*
 930  *
 931  * The diagram below details the relationship of the mapping structures
 932  *
 933  * Since the mapping now allows for non-uniform engines per vl, the
 934  * number of engines for a vl is either the vl_engines[vl] or
 935  * a computation based on num_sdma/num_vls:
 936  *
 937  * For example:
 938  * nactual = vl_engines ? vl_engines[vl] : num_sdma/num_vls
 939  *
 940  * n = roundup to next highest power of 2 using nactual
 941  *
 942  * In the case where there are num_sdma/num_vls doesn't divide
 943  * evenly, the extras are added from the last vl downward.
 944  *
 945  * For the case where n > nactual, the engines are assigned
 946  * in a round robin fashion wrapping back to the first engine
 947  * for a particular vl.
 948  *
 949  *               dd->sdma_map
 950  *                    |                                   sdma_map_elem[0]
 951  *                    |                                +--------------------+
 952  *                    v                                |       mask         |
 953  *               sdma_vl_map                           |--------------------|
 954  *      +--------------------------+                   | sde[0] -> eng 1    |
 955  *      |    list (RCU)            |                   |--------------------|
 956  *      |--------------------------|                 ->| sde[1] -> eng 2    |
 957  *      |    mask                  |              --/  |--------------------|
 958  *      |--------------------------|            -/     |        *           |
 959  *      |    actual_vls (max 8)    |          -/       |--------------------|
 960  *      |--------------------------|       --/         | sde[n] -> eng n    |
 961  *      |    vls (max 8)           |     -/            +--------------------+
 962  *      |--------------------------|  --/
 963  *      |    map[0]                |-/
 964  *      |--------------------------|                   +--------------------+
 965  *      |    map[1]                |---                |       mask         |
 966  *      |--------------------------|   \----           |--------------------|
 967  *      |           *              |        \--        | sde[0] -> eng 1+n  |
 968  *      |           *              |           \----   |--------------------|
 969  *      |           *              |                \->| sde[1] -> eng 2+n  |
 970  *      |--------------------------|                   |--------------------|
 971  *      |   map[vls - 1]           |-                  |         *          |
 972  *      +--------------------------+ \-                |--------------------|
 973  *                                     \-              | sde[m] -> eng m+n  |
 974  *                                       \             +--------------------+
 975  *                                        \-
 976  *                                          \
 977  *                                           \-        +--------------------+
 978  *                                             \-      |       mask         |
 979  *                                               \     |--------------------|
 980  *                                                \-   | sde[0] -> eng 1+m+n|
 981  *                                                  \- |--------------------|
 982  *                                                    >| sde[1] -> eng 2+m+n|
 983  *                                                     |--------------------|
 984  *                                                     |         *          |
 985  *                                                     |--------------------|
 986  *                                                     | sde[o] -> eng o+m+n|
 987  *                                                     +--------------------+
 988  *
 989  */
 990
 991 /**
 992  * struct sdma_map_elem - mapping for a vl
 993  * @mask - selector mask
 994  * @sde - array of engines for this vl
 995  *
 996  * The mask is used to "mod" the selector
 997  * to produce index into the trailing
 998  * array of sdes.
 999  */
1000 struct sdma_map_elem {
1001         u32 mask;
1002         struct sdma_engine *sde[0];
1003 };
1004
1005 /**
1006  * struct sdma_map_el - mapping for a vl
1007  * @engine_to_vl - map of an engine to a vl
1008  * @list - rcu head for free callback
1009  * @mask - vl mask to "mod" the vl to produce an index to map array
1010  * @actual_vls - number of vls
1011  * @vls - number of vls rounded to next power of 2
1012  * @map - array of sdma_map_elem entries
1013  *
1014  * This is the parent mapping structure.  The trailing
1015  * members of the struct point to sdma_map_elem entries, which
1016  * in turn point to an array of sde's for that vl.
1017  */
1018 struct sdma_vl_map {
1019         s8 engine_to_vl[TXE_NUM_SDMA_ENGINES];
1020         struct rcu_head list;
1021         u32 mask;
1022         u8 actual_vls;
1023         u8 vls;
1024         struct sdma_map_elem *map[0];
1025 };
1026
1027 int sdma_map_init(
1028         struct hfi1_devdata *dd,
1029         u8 port,
1030         u8 num_vls,
1031         u8 *vl_engines);
1032
1033 /* slow path */
1034 void _sdma_engine_progress_schedule(struct sdma_engine *sde);
1035
1036 /**
1037  * sdma_engine_progress_schedule() - schedule progress on engine
1038  * @sde: sdma_engine to schedule progress
1039  *
1040  * This is the fast path.
1041  *
1042  */
1043 static inline void sdma_engine_progress_schedule(
1044         struct sdma_engine *sde)
1045 {
1046         if (!sde || sdma_descq_inprocess(sde) < (sde->descq_cnt / 8))
1047                 return;
1048         _sdma_engine_progress_schedule(sde);
1049 }
1050
1051 struct sdma_engine *sdma_select_engine_sc(
1052         struct hfi1_devdata *dd,
1053         u32 selector,
1054         u8 sc5);
1055
1056 struct sdma_engine *sdma_select_engine_vl(
1057         struct hfi1_devdata *dd,
1058         u32 selector,
1059         u8 vl);
1060
1061 void sdma_seqfile_dump_sde(struct seq_file *s, struct sdma_engine *);
1062
1063 #ifdef CONFIG_SDMA_VERBOSITY
1064 void sdma_dumpstate(struct sdma_engine *);
1065 #endif
1066 static inline char *slashstrip(char *s)
1067 {
1068         char *r = s;
1069
1070         while (*s)
1071                 if (*s++ == '/')
1072                         r = s;
1073         return r;
1074 }
1075
1076 u16 sdma_get_descq_cnt(void);
1077
1078 extern uint mod_num_sdma;
1079
1080 void sdma_update_lmc(struct hfi1_devdata *dd, u64 mask, u32 lid);
1081
1082 #endif