include/uapi/rdma/rdma_user_ioctl_cmds.h

   1 /*
   2  * Copyright (c) 2018, Mellanox Technologies inc.  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_CMDS_H
  34 #define RDMA_USER_IOCTL_CMDS_H
  35
  36 #include <linux/types.h>
  37 #include <linux/ioctl.h>
  38
  39 /* Documentation/ioctl/ioctl-number.rst */
  40 #define RDMA_IOCTL_MAGIC        0x1b
  41 #define RDMA_VERBS_IOCTL \
  42         _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
  43
  44 enum {
  45         /* User input */
  46         UVERBS_ATTR_F_MANDATORY = 1U << 0,
  47         /*
  48          * Valid output bit should be ignored and considered set in
  49          * mandatory fields. This bit is kernel output.
  50          */
  51         UVERBS_ATTR_F_VALID_OUTPUT = 1U << 1,
  52 };
  53
  54 struct ib_uverbs_attr {
  55         __u16 attr_id;          /* command specific type attribute */
  56         __u16 len;              /* only for pointers and IDRs array */
  57         __u16 flags;            /* combination of UVERBS_ATTR_F_XXXX */
  58         union {
  59                 struct {
  60                         __u8 elem_id;
  61                         __u8 reserved;
  62                 } enum_data;
  63                 __u16 reserved;
  64         } attr_data;
  65         union {
  66                 /*
  67                  * ptr to command, inline data, idr/fd or
  68                  * ptr to __u32 array of IDRs
  69                  */
  70                 __aligned_u64 data;
  71                 /* Used by FD_IN and FD_OUT */
  72                 __s64 data_s64;
  73         };
  74 };
  75
  76 struct ib_uverbs_ioctl_hdr {
  77         __u16 length;
  78         __u16 object_id;
  79         __u16 method_id;
  80         __u16 num_attrs;
  81         __aligned_u64 reserved1;
  82         __u32 driver_id;
  83         __u32 reserved2;
  84         struct ib_uverbs_attr  attrs[0];
  85 };
  86
  87 #endif