drivers/infiniband/hw/ipath/ipath_layer.h

   1 /*
   2  * Copyright (c) 2006 QLogic, Inc. All rights reserved.
   3  * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 #ifndef _IPATH_LAYER_H
  35 #define _IPATH_LAYER_H
  36
  37 /*
  38  * This header file is for symbols shared between the infinipath driver
  39  * and drivers layered upon it (such as ipath).
  40  */
  41
  42 struct sk_buff;
  43 struct ipath_sge_state;
  44 struct ipath_devdata;
  45 struct ether_header;
  46
  47 struct ipath_layer_counters {
  48         u64 symbol_error_counter;
  49         u64 link_error_recovery_counter;
  50         u64 link_downed_counter;
  51         u64 port_rcv_errors;
  52         u64 port_rcv_remphys_errors;
  53         u64 port_xmit_discards;
  54         u64 port_xmit_data;
  55         u64 port_rcv_data;
  56         u64 port_xmit_packets;
  57         u64 port_rcv_packets;
  58         u32 local_link_integrity_errors;
  59         u32 excessive_buffer_overrun_errors;
  60 };
  61
  62 /*
  63  * A segment is a linear region of low physical memory.
  64  * XXX Maybe we should use phys addr here and kmap()/kunmap().
  65  * Used by the verbs layer.
  66  */
  67 struct ipath_seg {
  68         void *vaddr;
  69         size_t length;
  70 };
  71
  72 /* The number of ipath_segs that fit in a page. */
  73 #define IPATH_SEGSZ     (PAGE_SIZE / sizeof (struct ipath_seg))
  74
  75 struct ipath_segarray {
  76         struct ipath_seg segs[IPATH_SEGSZ];
  77 };
  78
  79 struct ipath_mregion {
  80         u64 user_base;          /* User's address for this region */
  81         u64 iova;               /* IB start address of this region */
  82         size_t length;
  83         u32 lkey;
  84         u32 offset;             /* offset (bytes) to start of region */
  85         int access_flags;
  86         u32 max_segs;           /* number of ipath_segs in all the arrays */
  87         u32 mapsz;              /* size of the map array */
  88         struct ipath_segarray *map[0];  /* the segments */
  89 };
  90
  91 /*
  92  * These keep track of the copy progress within a memory region.
  93  * Used by the verbs layer.
  94  */
  95 struct ipath_sge {
  96         struct ipath_mregion *mr;
  97         void *vaddr;            /* current pointer into the segment */
  98         u32 sge_length;         /* length of the SGE */
  99         u32 length;             /* remaining length of the segment */
 100         u16 m;                  /* current index: mr->map[m] */
 101         u16 n;                  /* current index: mr->map[m]->segs[n] */
 102 };
 103
 104 struct ipath_sge_state {
 105         struct ipath_sge *sg_list;      /* next SGE to be used if any */
 106         struct ipath_sge sge;   /* progress state for the current SGE */
 107         u8 num_sge;
 108 };
 109
 110 int ipath_layer_register(void *(*l_add)(int, struct ipath_devdata *),
 111                          void (*l_remove)(void *),
 112                          int (*l_intr)(void *, u32),
 113                          int (*l_rcv)(void *, void *,
 114                                       struct sk_buff *),
 115                          u16 rcv_opcode,
 116                          int (*l_rcv_lid)(void *, void *));
 117 int ipath_verbs_register(void *(*l_add)(int, struct ipath_devdata *),
 118                          void (*l_remove)(void *arg),
 119                          int (*l_piobufavail)(void *arg),
 120                          void (*l_rcv)(void *arg, void *rhdr,
 121                                        void *data, u32 tlen),
 122                          void (*l_timer_cb)(void *arg));
 123 void ipath_layer_unregister(void);
 124 void ipath_verbs_unregister(void);
 125 int ipath_layer_open(struct ipath_devdata *, u32 * pktmax);
 126 u16 ipath_layer_get_lid(struct ipath_devdata *dd);
 127 int ipath_layer_get_mac(struct ipath_devdata *dd, u8 *);
 128 u16 ipath_layer_get_bcast(struct ipath_devdata *dd);
 129 u32 ipath_layer_get_cr_errpkey(struct ipath_devdata *dd);
 130 int ipath_layer_set_linkstate(struct ipath_devdata *dd, u8 state);
 131 int ipath_layer_set_mtu(struct ipath_devdata *, u16);
 132 int ipath_set_lid(struct ipath_devdata *, u32, u8);
 133 int ipath_layer_send_hdr(struct ipath_devdata *dd,
 134                          struct ether_header *hdr);
 135 int ipath_verbs_send(struct ipath_devdata *dd, u32 hdrwords,
 136                      u32 * hdr, u32 len, struct ipath_sge_state *ss);
 137 int ipath_layer_set_piointbufavail_int(struct ipath_devdata *dd);
 138 int ipath_layer_get_boardname(struct ipath_devdata *dd, char *name,
 139                               size_t namelen);
 140 int ipath_layer_snapshot_counters(struct ipath_devdata *dd, u64 *swords,
 141                                   u64 *rwords, u64 *spkts, u64 *rpkts,
 142                                   u64 *xmit_wait);
 143 int ipath_layer_get_counters(struct ipath_devdata *dd,
 144                              struct ipath_layer_counters *cntrs);
 145 int ipath_layer_want_buffer(struct ipath_devdata *dd);
 146 int ipath_layer_set_guid(struct ipath_devdata *, __be64 guid);
 147 __be64 ipath_layer_get_guid(struct ipath_devdata *);
 148 u32 ipath_layer_get_nguid(struct ipath_devdata *);
 149 u32 ipath_layer_get_majrev(struct ipath_devdata *);
 150 u32 ipath_layer_get_minrev(struct ipath_devdata *);
 151 u32 ipath_layer_get_pcirev(struct ipath_devdata *);
 152 u32 ipath_layer_get_flags(struct ipath_devdata *dd);
 153 struct device *ipath_layer_get_device(struct ipath_devdata *dd);
 154 u16 ipath_layer_get_deviceid(struct ipath_devdata *dd);
 155 u32 ipath_layer_get_vendorid(struct ipath_devdata *);
 156 u64 ipath_layer_get_lastibcstat(struct ipath_devdata *dd);
 157 u32 ipath_layer_get_ibmtu(struct ipath_devdata *dd);
 158 int ipath_layer_enable_timer(struct ipath_devdata *dd);
 159 int ipath_layer_disable_timer(struct ipath_devdata *dd);
 160 int ipath_layer_set_verbs_flags(struct ipath_devdata *dd, unsigned flags);
 161 unsigned ipath_layer_get_npkeys(struct ipath_devdata *dd);
 162 unsigned ipath_layer_get_pkey(struct ipath_devdata *dd, unsigned index);
 163 int ipath_layer_get_pkeys(struct ipath_devdata *dd, u16 *pkeys);
 164 int ipath_layer_set_pkeys(struct ipath_devdata *dd, u16 *pkeys);
 165 int ipath_layer_get_linkdowndefaultstate(struct ipath_devdata *dd);
 166 int ipath_layer_set_linkdowndefaultstate(struct ipath_devdata *dd,
 167                                          int sleep);
 168 int ipath_layer_get_phyerrthreshold(struct ipath_devdata *dd);
 169 int ipath_layer_set_phyerrthreshold(struct ipath_devdata *dd, unsigned n);
 170 int ipath_layer_get_overrunthreshold(struct ipath_devdata *dd);
 171 int ipath_layer_set_overrunthreshold(struct ipath_devdata *dd, unsigned n);
 172 u32 ipath_layer_get_rcvhdrentsize(struct ipath_devdata *dd);
 173
 174 /* ipath_ether interrupt values */
 175 #define IPATH_LAYER_INT_IF_UP 0x2
 176 #define IPATH_LAYER_INT_IF_DOWN 0x4
 177 #define IPATH_LAYER_INT_LID 0x8
 178 #define IPATH_LAYER_INT_SEND_CONTINUE 0x10
 179 #define IPATH_LAYER_INT_BCAST 0x40
 180
 181 /* _verbs_layer.l_flags */
 182 #define IPATH_VERBS_KERNEL_SMA 0x1
 183
 184 extern unsigned ipath_debug; /* debugging bit mask */
 185
 186 #endif                          /* _IPATH_LAYER_H */