include/uapi/rdma/rdma_user_ioctl.h

   1 /*
   2  * Copyright (c) 2016 Mellanox Technologies, LTD. 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 RDMA_USER_IOCTL_H
  34 #define RDMA_USER_IOCTL_H
  35
  36 #include <linux/types.h>
  37 #include <linux/ioctl.h>
  38 #include <rdma/ib_user_mad.h>
  39 #include <rdma/hfi/hfi1_ioctl.h>
  40
  41 /* Documentation/ioctl/ioctl-number.txt */
  42 #define RDMA_IOCTL_MAGIC        0x1b
  43 /* Legacy name, for user space application which already use it */
  44 #define IB_IOCTL_MAGIC          RDMA_IOCTL_MAGIC
  45
  46 #define RDMA_VERBS_IOCTL \
  47         _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
  48
  49 #define UVERBS_ID_NS_MASK 0xF000
  50 #define UVERBS_ID_NS_SHIFT 12
  51
  52 enum {
  53         /* User input */
  54         UVERBS_ATTR_F_MANDATORY = 1U << 0,
  55         /*
  56          * Valid output bit should be ignored and considered set in
  57          * mandatory fields. This bit is kernel output.
  58          */
  59         UVERBS_ATTR_F_VALID_OUTPUT = 1U << 1,
  60 };
  61
  62 struct ib_uverbs_attr {
  63         __u16 attr_id;          /* command specific type attribute */
  64         __u16 len;              /* only for pointers */
  65         __u16 flags;            /* combination of UVERBS_ATTR_F_XXXX */
  66         __u16 reserved;
  67         __u64 data;             /* ptr to command, inline data or idr/fd */
  68 };
  69
  70 struct ib_uverbs_ioctl_hdr {
  71         __u16 length;
  72         __u16 object_id;
  73         __u16 method_id;
  74         __u16 num_attrs;
  75         __u64 reserved;
  76         struct ib_uverbs_attr  attrs[0];
  77 };
  78
  79 /*
  80  * General blocks assignments
  81  * It is closed on purpose do not expose it it user space
  82  * #define MAD_CMD_BASE         0x00
  83  * #define HFI1_CMD_BAS         0xE0
  84  */
  85
  86 /* MAD specific section */
  87 #define IB_USER_MAD_REGISTER_AGENT      _IOWR(RDMA_IOCTL_MAGIC, 0x01, struct ib_user_mad_reg_req)
  88 #define IB_USER_MAD_UNREGISTER_AGENT    _IOW(RDMA_IOCTL_MAGIC,  0x02, __u32)
  89 #define IB_USER_MAD_ENABLE_PKEY         _IO(RDMA_IOCTL_MAGIC,   0x03)
  90 #define IB_USER_MAD_REGISTER_AGENT2     _IOWR(RDMA_IOCTL_MAGIC, 0x04, struct ib_user_mad_reg_req2)
  91
  92 /* HFI specific section */
  93 /* allocate HFI and context */
  94 #define HFI1_IOCTL_ASSIGN_CTXT          _IOWR(RDMA_IOCTL_MAGIC, 0xE1, struct hfi1_user_info)
  95 /* find out what resources we got */
  96 #define HFI1_IOCTL_CTXT_INFO            _IOW(RDMA_IOCTL_MAGIC,  0xE2, struct hfi1_ctxt_info)
  97 /* set up userspace */
  98 #define HFI1_IOCTL_USER_INFO            _IOW(RDMA_IOCTL_MAGIC,  0xE3, struct hfi1_base_info)
  99 /* update expected TID entries */
 100 #define HFI1_IOCTL_TID_UPDATE           _IOWR(RDMA_IOCTL_MAGIC, 0xE4, struct hfi1_tid_info)
 101 /* free expected TID entries */
 102 #define HFI1_IOCTL_TID_FREE             _IOWR(RDMA_IOCTL_MAGIC, 0xE5, struct hfi1_tid_info)
 103 /* force an update of PIO credit */
 104 #define HFI1_IOCTL_CREDIT_UPD           _IO(RDMA_IOCTL_MAGIC,   0xE6)
 105 /* control receipt of packets */
 106 #define HFI1_IOCTL_RECV_CTRL            _IOW(RDMA_IOCTL_MAGIC,  0xE8, int)
 107 /* set the kind of polling we want */
 108 #define HFI1_IOCTL_POLL_TYPE            _IOW(RDMA_IOCTL_MAGIC,  0xE9, int)
 109 /* ack & clear user status bits */
 110 #define HFI1_IOCTL_ACK_EVENT            _IOW(RDMA_IOCTL_MAGIC,  0xEA, unsigned long)
 111 /* set context's pkey */
 112 #define HFI1_IOCTL_SET_PKEY             _IOW(RDMA_IOCTL_MAGIC,  0xEB, __u16)
 113 /* reset context's HW send context */
 114 #define HFI1_IOCTL_CTXT_RESET           _IO(RDMA_IOCTL_MAGIC,   0xEC)
 115 /* read TID cache invalidations */
 116 #define HFI1_IOCTL_TID_INVAL_READ       _IOWR(RDMA_IOCTL_MAGIC, 0xED, struct hfi1_tid_info)
 117 /* get the version of the user cdev */
 118 #define HFI1_IOCTL_GET_VERS             _IOR(RDMA_IOCTL_MAGIC,  0xEE, int)
 119
 120 #endif /* RDMA_USER_IOCTL_H */