drivers/infiniband/hw/mthca/mthca_dev.h

   1 /*
   2  * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   4  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
   5  * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
   6  * Copyright (c) 2004 Voltaire, Inc. All rights reserved.
   7  *
   8  * This software is available to you under a choice of one of two
   9  * licenses.  You may choose to be licensed under the terms of the GNU
  10  * General Public License (GPL) Version 2, available from the file
  11  * COPYING in the main directory of this source tree, or the
  12  * OpenIB.org BSD license below:
  13  *
  14  *     Redistribution and use in source and binary forms, with or
  15  *     without modification, are permitted provided that the following
  16  *     conditions are met:
  17  *
  18  *      - Redistributions of source code must retain the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer.
  21  *
  22  *      - Redistributions in binary form must reproduce the above
  23  *        copyright notice, this list of conditions and the following
  24  *        disclaimer in the documentation and/or other materials
  25  *        provided with the distribution.
  26  *
  27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  28  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  29  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  30  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  31  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  32  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  33  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  34  * SOFTWARE.
  35  *
  36  * $Id: mthca_dev.h 1349 2004-12-16 21:09:43Z roland $
  37  */
  38
  39 #ifndef MTHCA_DEV_H
  40 #define MTHCA_DEV_H
  41
  42 #include <linux/spinlock.h>
  43 #include <linux/kernel.h>
  44 #include <linux/pci.h>
  45 #include <linux/dma-mapping.h>
  46 #include <asm/semaphore.h>
  47
  48 #include "mthca_provider.h"
  49 #include "mthca_doorbell.h"
  50
  51 #define DRV_NAME        "ib_mthca"
  52 #define PFX             DRV_NAME ": "
  53 #define DRV_VERSION     "0.06"
  54 #define DRV_RELDATE     "June 23, 2005"
  55
  56 enum {
  57         MTHCA_FLAG_DDR_HIDDEN = 1 << 1,
  58         MTHCA_FLAG_SRQ        = 1 << 2,
  59         MTHCA_FLAG_MSI        = 1 << 3,
  60         MTHCA_FLAG_MSI_X      = 1 << 4,
  61         MTHCA_FLAG_NO_LAM     = 1 << 5,
  62         MTHCA_FLAG_FMR        = 1 << 6,
  63         MTHCA_FLAG_MEMFREE    = 1 << 7,
  64         MTHCA_FLAG_PCIE       = 1 << 8
  65 };
  66
  67 enum {
  68         MTHCA_MAX_PORTS = 2
  69 };
  70
  71 enum {
  72         MTHCA_BOARD_ID_LEN = 64
  73 };
  74
  75 enum {
  76         MTHCA_EQ_CONTEXT_SIZE =  0x40,
  77         MTHCA_CQ_CONTEXT_SIZE =  0x40,
  78         MTHCA_QP_CONTEXT_SIZE = 0x200,
  79         MTHCA_RDB_ENTRY_SIZE  =  0x20,
  80         MTHCA_AV_SIZE         =  0x20,
  81         MTHCA_MGM_ENTRY_SIZE  =  0x40,
  82
  83         /* Arbel FW gives us these, but we need them for Tavor */
  84         MTHCA_MPT_ENTRY_SIZE  =  0x40,
  85         MTHCA_MTT_SEG_SIZE    =  0x40,
  86 };
  87
  88 enum {
  89         MTHCA_EQ_CMD,
  90         MTHCA_EQ_ASYNC,
  91         MTHCA_EQ_COMP,
  92         MTHCA_NUM_EQ
  93 };
  94
  95 enum {
  96         MTHCA_OPCODE_NOP            = 0x00,
  97         MTHCA_OPCODE_RDMA_WRITE     = 0x08,
  98         MTHCA_OPCODE_RDMA_WRITE_IMM = 0x09,
  99         MTHCA_OPCODE_SEND           = 0x0a,
 100         MTHCA_OPCODE_SEND_IMM       = 0x0b,
 101         MTHCA_OPCODE_RDMA_READ      = 0x10,
 102         MTHCA_OPCODE_ATOMIC_CS      = 0x11,
 103         MTHCA_OPCODE_ATOMIC_FA      = 0x12,
 104         MTHCA_OPCODE_BIND_MW        = 0x18,
 105         MTHCA_OPCODE_INVALID        = 0xff
 106 };
 107
 108 struct mthca_cmd {
 109         struct pci_pool          *pool;
 110         int                       use_events;
 111         struct semaphore          hcr_sem;
 112         struct semaphore          poll_sem;
 113         struct semaphore          event_sem;
 114         int                       max_cmds;
 115         spinlock_t                context_lock;
 116         int                       free_head;
 117         struct mthca_cmd_context *context;
 118         u16                       token_mask;
 119 };
 120
 121 struct mthca_limits {
 122         int      num_ports;
 123         int      vl_cap;
 124         int      mtu_cap;
 125         int      gid_table_len;
 126         int      pkey_table_len;
 127         int      local_ca_ack_delay;
 128         int      num_uars;
 129         int      max_sg;
 130         int      num_qps;
 131         int      reserved_qps;
 132         int      num_srqs;
 133         int      reserved_srqs;
 134         int      num_eecs;
 135         int      reserved_eecs;
 136         int      num_cqs;
 137         int      reserved_cqs;
 138         int      num_eqs;
 139         int      reserved_eqs;
 140         int      num_mpts;
 141         int      num_mtt_segs;
 142         int      fmr_reserved_mtts;
 143         int      reserved_mtts;
 144         int      reserved_mrws;
 145         int      reserved_uars;
 146         int      num_mgms;
 147         int      num_amgms;
 148         int      reserved_mcgs;
 149         int      num_pds;
 150         int      reserved_pds;
 151 };
 152
 153 struct mthca_alloc {
 154         u32            last;
 155         u32            top;
 156         u32            max;
 157         u32            mask;
 158         spinlock_t     lock;
 159         unsigned long *table;
 160 };
 161
 162 struct mthca_array {
 163         struct {
 164                 void    **page;
 165                 int       used;
 166         } *page_list;
 167 };
 168
 169 struct mthca_uar_table {
 170         struct mthca_alloc alloc;
 171         u64                uarc_base;
 172         int                uarc_size;
 173 };
 174
 175 struct mthca_pd_table {
 176         struct mthca_alloc alloc;
 177 };
 178
 179 struct mthca_buddy {
 180         unsigned long **bits;
 181         int             max_order;
 182         spinlock_t      lock;
 183 };
 184
 185 struct mthca_mr_table {
 186         struct mthca_alloc      mpt_alloc;
 187         struct mthca_buddy      mtt_buddy;
 188         struct mthca_buddy     *fmr_mtt_buddy;
 189         u64                     mtt_base;
 190         u64                     mpt_base;
 191         struct mthca_icm_table *mtt_table;
 192         struct mthca_icm_table *mpt_table;
 193         struct {
 194                 void __iomem   *mpt_base;
 195                 void __iomem   *mtt_base;
 196                 struct mthca_buddy mtt_buddy;
 197         } tavor_fmr;
 198 };
 199
 200 struct mthca_eq_table {
 201         struct mthca_alloc alloc;
 202         void __iomem      *clr_int;
 203         u32                clr_mask;
 204         u32                arm_mask;
 205         struct mthca_eq    eq[MTHCA_NUM_EQ];
 206         u64                icm_virt;
 207         struct page       *icm_page;
 208         dma_addr_t         icm_dma;
 209         int                have_irq;
 210         u8                 inta_pin;
 211 };
 212
 213 struct mthca_cq_table {
 214         struct mthca_alloc      alloc;
 215         spinlock_t              lock;
 216         struct mthca_array      cq;
 217         struct mthca_icm_table *table;
 218 };
 219
 220 struct mthca_qp_table {
 221         struct mthca_alloc      alloc;
 222         u32                     rdb_base;
 223         int                     rdb_shift;
 224         int                     sqp_start;
 225         spinlock_t              lock;
 226         struct mthca_array      qp;
 227         struct mthca_icm_table *qp_table;
 228         struct mthca_icm_table *eqp_table;
 229         struct mthca_icm_table *rdb_table;
 230 };
 231
 232 struct mthca_av_table {
 233         struct pci_pool   *pool;
 234         int                num_ddr_avs;
 235         u64                ddr_av_base;
 236         void __iomem      *av_map;
 237         struct mthca_alloc alloc;
 238 };
 239
 240 struct mthca_mcg_table {
 241         struct semaphore        sem;
 242         struct mthca_alloc      alloc;
 243         struct mthca_icm_table *table;
 244 };
 245
 246 struct mthca_dev {
 247         struct ib_device  ib_dev;
 248         struct pci_dev   *pdev;
 249
 250         int              hca_type;
 251         unsigned long    mthca_flags;
 252         unsigned long    device_cap_flags;
 253
 254         u32              rev_id;
 255         char             board_id[MTHCA_BOARD_ID_LEN];
 256
 257         /* firmware info */
 258         u64              fw_ver;
 259         union {
 260                 struct {
 261                         u64 fw_start;
 262                         u64 fw_end;
 263                 }        tavor;
 264                 struct {
 265                         u64 clr_int_base;
 266                         u64 eq_arm_base;
 267                         u64 eq_set_ci_base;
 268                         struct mthca_icm *fw_icm;
 269                         struct mthca_icm *aux_icm;
 270                         u16 fw_pages;
 271                 }        arbel;
 272         }                fw;
 273
 274         u64              ddr_start;
 275         u64              ddr_end;
 276
 277         MTHCA_DECLARE_DOORBELL_LOCK(doorbell_lock)
 278         struct semaphore cap_mask_mutex;
 279
 280         void __iomem    *hcr;
 281         void __iomem    *kar;
 282         void __iomem    *clr_base;
 283         union {
 284                 struct {
 285                         void __iomem *ecr_base;
 286                 } tavor;
 287                 struct {
 288                         void __iomem *eq_arm;
 289                         void __iomem *eq_set_ci_base;
 290                 } arbel;
 291         } eq_regs;
 292
 293         struct mthca_cmd    cmd;
 294         struct mthca_limits limits;
 295
 296         struct mthca_uar_table uar_table;
 297         struct mthca_pd_table  pd_table;
 298         struct mthca_mr_table  mr_table;
 299         struct mthca_eq_table  eq_table;
 300         struct mthca_cq_table  cq_table;
 301         struct mthca_qp_table  qp_table;
 302         struct mthca_av_table  av_table;
 303         struct mthca_mcg_table mcg_table;
 304
 305         struct mthca_uar       driver_uar;
 306         struct mthca_db_table *db_tab;
 307         struct mthca_pd        driver_pd;
 308         struct mthca_mr        driver_mr;
 309
 310         struct ib_mad_agent  *send_agent[MTHCA_MAX_PORTS][2];
 311         struct ib_ah         *sm_ah[MTHCA_MAX_PORTS];
 312         spinlock_t            sm_lock;
 313 };
 314
 315 #define mthca_dbg(mdev, format, arg...) \
 316         dev_dbg(&mdev->pdev->dev, format, ## arg)
 317 #define mthca_err(mdev, format, arg...) \
 318         dev_err(&mdev->pdev->dev, format, ## arg)
 319 #define mthca_info(mdev, format, arg...) \
 320         dev_info(&mdev->pdev->dev, format, ## arg)
 321 #define mthca_warn(mdev, format, arg...) \
 322         dev_warn(&mdev->pdev->dev, format, ## arg)
 323
 324 extern void __buggy_use_of_MTHCA_GET(void);
 325 extern void __buggy_use_of_MTHCA_PUT(void);
 326
 327 #define MTHCA_GET(dest, source, offset)                               \
 328         do {                                                          \
 329                 void *__p = (char *) (source) + (offset);             \
 330                 switch (sizeof (dest)) {                              \
 331                         case 1: (dest) = *(u8 *) __p;       break;    \
 332                         case 2: (dest) = be16_to_cpup(__p); break;    \
 333                         case 4: (dest) = be32_to_cpup(__p); break;    \
 334                         case 8: (dest) = be64_to_cpup(__p); break;    \
 335                         default: __buggy_use_of_MTHCA_GET();          \
 336                 }                                                     \
 337         } while (0)
 338
 339 #define MTHCA_PUT(dest, source, offset)                               \
 340         do {                                                          \
 341                 void *__d = ((char *) (dest) + (offset));             \
 342                 switch (sizeof(source)) {                             \
 343                 case 1: *(u8 *) __d = (source);                break; \
 344                 case 2: *(__be16 *) __d = cpu_to_be16(source); break; \
 345                 case 4: *(__be32 *) __d = cpu_to_be32(source); break; \
 346                 case 8: *(__be64 *) __d = cpu_to_be64(source); break; \
 347                 default: __buggy_use_of_MTHCA_PUT();                  \
 348                 }                                                     \
 349         } while (0)
 350
 351 int mthca_reset(struct mthca_dev *mdev);
 352
 353 u32 mthca_alloc(struct mthca_alloc *alloc);
 354 void mthca_free(struct mthca_alloc *alloc, u32 obj);
 355 int mthca_alloc_init(struct mthca_alloc *alloc, u32 num, u32 mask,
 356                      u32 reserved);
 357 void mthca_alloc_cleanup(struct mthca_alloc *alloc);
 358 void *mthca_array_get(struct mthca_array *array, int index);
 359 int mthca_array_set(struct mthca_array *array, int index, void *value);
 360 void mthca_array_clear(struct mthca_array *array, int index);
 361 int mthca_array_init(struct mthca_array *array, int nent);
 362 void mthca_array_cleanup(struct mthca_array *array, int nent);
 363
 364 int mthca_init_uar_table(struct mthca_dev *dev);
 365 int mthca_init_pd_table(struct mthca_dev *dev);
 366 int mthca_init_mr_table(struct mthca_dev *dev);
 367 int mthca_init_eq_table(struct mthca_dev *dev);
 368 int mthca_init_cq_table(struct mthca_dev *dev);
 369 int mthca_init_qp_table(struct mthca_dev *dev);
 370 int mthca_init_av_table(struct mthca_dev *dev);
 371 int mthca_init_mcg_table(struct mthca_dev *dev);
 372
 373 void mthca_cleanup_uar_table(struct mthca_dev *dev);
 374 void mthca_cleanup_pd_table(struct mthca_dev *dev);
 375 void mthca_cleanup_mr_table(struct mthca_dev *dev);
 376 void mthca_cleanup_eq_table(struct mthca_dev *dev);
 377 void mthca_cleanup_cq_table(struct mthca_dev *dev);
 378 void mthca_cleanup_qp_table(struct mthca_dev *dev);
 379 void mthca_cleanup_av_table(struct mthca_dev *dev);
 380 void mthca_cleanup_mcg_table(struct mthca_dev *dev);
 381
 382 int mthca_register_device(struct mthca_dev *dev);
 383 void mthca_unregister_device(struct mthca_dev *dev);
 384
 385 int mthca_uar_alloc(struct mthca_dev *dev, struct mthca_uar *uar);
 386 void mthca_uar_free(struct mthca_dev *dev, struct mthca_uar *uar);
 387
 388 int mthca_pd_alloc(struct mthca_dev *dev, int privileged, struct mthca_pd *pd);
 389 void mthca_pd_free(struct mthca_dev *dev, struct mthca_pd *pd);
 390
 391 struct mthca_mtt *mthca_alloc_mtt(struct mthca_dev *dev, int size);
 392 void mthca_free_mtt(struct mthca_dev *dev, struct mthca_mtt *mtt);
 393 int mthca_write_mtt(struct mthca_dev *dev, struct mthca_mtt *mtt,
 394                     int start_index, u64 *buffer_list, int list_len);
 395 int mthca_mr_alloc(struct mthca_dev *dev, u32 pd, int buffer_size_shift,
 396                    u64 iova, u64 total_size, u32 access, struct mthca_mr *mr);
 397 int mthca_mr_alloc_notrans(struct mthca_dev *dev, u32 pd,
 398                            u32 access, struct mthca_mr *mr);
 399 int mthca_mr_alloc_phys(struct mthca_dev *dev, u32 pd,
 400                         u64 *buffer_list, int buffer_size_shift,
 401                         int list_len, u64 iova, u64 total_size,
 402                         u32 access, struct mthca_mr *mr);
 403 void mthca_free_mr(struct mthca_dev *dev,  struct mthca_mr *mr);
 404
 405 int mthca_fmr_alloc(struct mthca_dev *dev, u32 pd,
 406                     u32 access, struct mthca_fmr *fmr);
 407 int mthca_tavor_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list,
 408                              int list_len, u64 iova);
 409 void mthca_tavor_fmr_unmap(struct mthca_dev *dev, struct mthca_fmr *fmr);
 410 int mthca_arbel_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list,
 411                              int list_len, u64 iova);
 412 void mthca_arbel_fmr_unmap(struct mthca_dev *dev, struct mthca_fmr *fmr);
 413 int mthca_free_fmr(struct mthca_dev *dev,  struct mthca_fmr *fmr);
 414
 415 int mthca_map_eq_icm(struct mthca_dev *dev, u64 icm_virt);
 416 void mthca_unmap_eq_icm(struct mthca_dev *dev);
 417
 418 int mthca_poll_cq(struct ib_cq *ibcq, int num_entries,
 419                   struct ib_wc *entry);
 420 int mthca_tavor_arm_cq(struct ib_cq *cq, enum ib_cq_notify notify);
 421 int mthca_arbel_arm_cq(struct ib_cq *cq, enum ib_cq_notify notify);
 422 int mthca_init_cq(struct mthca_dev *dev, int nent,
 423                   struct mthca_ucontext *ctx, u32 pdn,
 424                   struct mthca_cq *cq);
 425 void mthca_free_cq(struct mthca_dev *dev,
 426                    struct mthca_cq *cq);
 427 void mthca_cq_event(struct mthca_dev *dev, u32 cqn);
 428 void mthca_cq_clean(struct mthca_dev *dev, u32 cqn, u32 qpn);
 429
 430 void mthca_qp_event(struct mthca_dev *dev, u32 qpn,
 431                     enum ib_event_type event_type);
 432 int mthca_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr, int attr_mask);
 433 int mthca_tavor_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
 434                           struct ib_send_wr **bad_wr);
 435 int mthca_tavor_post_receive(struct ib_qp *ibqp, struct ib_recv_wr *wr,
 436                              struct ib_recv_wr **bad_wr);
 437 int mthca_arbel_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
 438                           struct ib_send_wr **bad_wr);
 439 int mthca_arbel_post_receive(struct ib_qp *ibqp, struct ib_recv_wr *wr,
 440                              struct ib_recv_wr **bad_wr);
 441 int mthca_free_err_wqe(struct mthca_dev *dev, struct mthca_qp *qp, int is_send,
 442                        int index, int *dbd, __be32 *new_wqe);
 443 int mthca_alloc_qp(struct mthca_dev *dev,
 444                    struct mthca_pd *pd,
 445                    struct mthca_cq *send_cq,
 446                    struct mthca_cq *recv_cq,
 447                    enum ib_qp_type type,
 448                    enum ib_sig_type send_policy,
 449                    struct ib_qp_cap *cap,
 450                    struct mthca_qp *qp);
 451 int mthca_alloc_sqp(struct mthca_dev *dev,
 452                     struct mthca_pd *pd,
 453                     struct mthca_cq *send_cq,
 454                     struct mthca_cq *recv_cq,
 455                     enum ib_sig_type send_policy,
 456                     struct ib_qp_cap *cap,
 457                     int qpn,
 458                     int port,
 459                     struct mthca_sqp *sqp);
 460 void mthca_free_qp(struct mthca_dev *dev, struct mthca_qp *qp);
 461 int mthca_create_ah(struct mthca_dev *dev,
 462                     struct mthca_pd *pd,
 463                     struct ib_ah_attr *ah_attr,
 464                     struct mthca_ah *ah);
 465 int mthca_destroy_ah(struct mthca_dev *dev, struct mthca_ah *ah);
 466 int mthca_read_ah(struct mthca_dev *dev, struct mthca_ah *ah,
 467                   struct ib_ud_header *header);
 468
 469 int mthca_multicast_attach(struct ib_qp *ibqp, union ib_gid *gid, u16 lid);
 470 int mthca_multicast_detach(struct ib_qp *ibqp, union ib_gid *gid, u16 lid);
 471
 472 int mthca_process_mad(struct ib_device *ibdev,
 473                       int mad_flags,
 474                       u8 port_num,
 475                       struct ib_wc *in_wc,
 476                       struct ib_grh *in_grh,
 477                       struct ib_mad *in_mad,
 478                       struct ib_mad *out_mad);
 479 int mthca_create_agents(struct mthca_dev *dev);
 480 void mthca_free_agents(struct mthca_dev *dev);
 481
 482 static inline struct mthca_dev *to_mdev(struct ib_device *ibdev)
 483 {
 484         return container_of(ibdev, struct mthca_dev, ib_dev);
 485 }
 486
 487 static inline int mthca_is_memfree(struct mthca_dev *dev)
 488 {
 489         return dev->mthca_flags & MTHCA_FLAG_MEMFREE;
 490 }
 491
 492 #endif /* MTHCA_DEV_H */