scif_ioctl.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. /*
  2. * Intel MIC Platform Software Stack (MPSS)
  3. *
  4. * This file is provided under a dual BSD/GPLv2 license. When using or
  5. * redistributing this file, you may do so under either license.
  6. *
  7. * GPL LICENSE SUMMARY
  8. *
  9. * Copyright(c) 2014 Intel Corporation.
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of version 2 of the GNU General Public License as
  13. * published by the Free Software Foundation.
  14. *
  15. * This program is distributed in the hope that it will be useful, but
  16. * WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18. * General Public License for more details.
  19. *
  20. * BSD LICENSE
  21. *
  22. * Copyright(c) 2014 Intel Corporation.
  23. *
  24. * Redistribution and use in source and binary forms, with or without
  25. * modification, are permitted provided that the following conditions
  26. * are met:
  27. *
  28. * * Redistributions of source code must retain the above copyright
  29. * notice, this list of conditions and the following disclaimer.
  30. * * Redistributions in binary form must reproduce the above copyright
  31. * notice, this list of conditions and the following disclaimer in
  32. * the documentation and/or other materials provided with the
  33. * distribution.
  34. * * Neither the name of Intel Corporation nor the names of its
  35. * contributors may be used to endorse or promote products derived
  36. * from this software without specific prior written permission.
  37. *
  38. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  39. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  40. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  41. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  42. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  44. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  45. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  46. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  47. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  48. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  49. *
  50. * Intel SCIF driver.
  51. *
  52. */
  53. /*
  54. * -----------------------------------------
  55. * SCIF IOCTL interface information
  56. * -----------------------------------------
  57. */
  58. #ifndef SCIF_IOCTL_H
  59. #define SCIF_IOCTL_H
  60. #include <linux/types.h>
  61. /**
  62. * struct scif_port_id - SCIF port information
  63. * @node: node on which port resides
  64. * @port: local port number
  65. */
  66. struct scif_port_id {
  67. __u16 node;
  68. __u16 port;
  69. };
  70. /**
  71. * struct scifioctl_connect - used for SCIF_CONNECT IOCTL
  72. * @self: used to read back the assigned port_id
  73. * @peer: destination node and port to connect to
  74. */
  75. struct scifioctl_connect {
  76. struct scif_port_id self;
  77. struct scif_port_id peer;
  78. };
  79. /**
  80. * struct scifioctl_accept - used for SCIF_ACCEPTREQ IOCTL
  81. * @flags: flags
  82. * @peer: global id of peer endpoint
  83. * @endpt: new connected endpoint descriptor
  84. */
  85. struct scifioctl_accept {
  86. __s32 flags;
  87. struct scif_port_id peer;
  88. __u64 endpt;
  89. };
  90. /**
  91. * struct scifioctl_msg - used for SCIF_SEND/SCIF_RECV IOCTL
  92. * @msg: message buffer address
  93. * @len: message length
  94. * @flags: flags
  95. * @out_len: number of bytes sent/received
  96. */
  97. struct scifioctl_msg {
  98. __u64 msg;
  99. __s32 len;
  100. __s32 flags;
  101. __s32 out_len;
  102. };
  103. /**
  104. * struct scifioctl_node_ids - used for SCIF_GET_NODEIDS IOCTL
  105. * @nodes: pointer to an array of node_ids
  106. * @self: ID of the current node
  107. * @len: length of array
  108. */
  109. struct scifioctl_node_ids {
  110. __u64 nodes;
  111. __u64 self;
  112. __s32 len;
  113. };
  114. #define SCIF_BIND _IOWR('s', 1, __u64)
  115. #define SCIF_LISTEN _IOW('s', 2, __s32)
  116. #define SCIF_CONNECT _IOWR('s', 3, struct scifioctl_connect)
  117. #define SCIF_ACCEPTREQ _IOWR('s', 4, struct scifioctl_accept)
  118. #define SCIF_ACCEPTREG _IOWR('s', 5, __u64)
  119. #define SCIF_SEND _IOWR('s', 6, struct scifioctl_msg)
  120. #define SCIF_RECV _IOWR('s', 7, struct scifioctl_msg)
  121. #define SCIF_GET_NODEIDS _IOWR('s', 14, struct scifioctl_node_ids)
  122. #endif /* SCIF_IOCTL_H */