include/uapi/rdma/rdma_user_ioctl.h

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