contrib/ofed/libibverbs/src/kern_abi.h

   1 /*
   2  * Copyright (c) 2005 Topspin Communications.  All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef KERN_ABI_H
  34 #define KERN_ABI_H
  35
  36 #include <linux/types.h>
  37
  38 /*
  39  * Increment this value if any changes that break userspace ABI
  40  * compatibility are made.
  41  */
  42 #define IB_USER_VERBS_ABI_VERSION       1
  43
  44 enum {
  45         IB_USER_VERBS_CMD_GET_CONTEXT,
  46         IB_USER_VERBS_CMD_GET_EVENT_FDS,
  47         IB_USER_VERBS_CMD_ALLOC_PD,
  48         IB_USER_VERBS_CMD_DEALLOC_PD,
  49         IB_USER_VERBS_CMD_REG_MR,
  50         IB_USER_VERBS_CMD_DEREG_MR
  51 };
  52
  53 /*
  54  * Make sure that all structs defined in this file remain laid out so
  55  * that they pack the same way on 32-bit and 64-bit architectures (to
  56  * avoid incompatibility between 32-bit userspace and 64-bit kernels).
  57  * In particular do not use pointer types -- pass pointers in __u64
  58  * instead.
  59  */
  60
  61 struct ibv_kern_async_event {
  62         __u32 event_type;
  63         __u32 element;
  64 };
  65
  66 struct ibv_comp_event {
  67         __u32 cq_handle;
  68 };
  69
  70 /*
  71  * All commands from userspace should start with a __u32 command field
  72  * followed by __u16 in_words and out_words fields (which give the
  73  * length of the command block and response buffer if any in 32-bit
  74  * words).  The kernel driver will read these fields first and read
  75  * the rest of the command struct based on these value.
  76  */
  77
  78 struct ibv_get_context {
  79         __u32 command;
  80         __u16 in_words;
  81         __u16 out_words;
  82         __u64 response;
  83 };
  84
  85 struct ibv_get_context_resp {
  86         __u32 num_cq_events;
  87 };
  88
  89 struct ibv_get_event_fds {
  90         __u32 command;
  91         __u16 in_words;
  92         __u16 out_words;
  93         __u64 response;
  94 };
  95
  96 struct ibv_get_event_fds_resp {
  97         __u32 async_fd;
  98         __u32 cq_fd[1];
  99 };
 100
 101 #endif /* KERN_ABI_H */