scif_nodeqp.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  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. #ifndef SCIF_NODEQP
  54. #define SCIF_NODEQP
  55. #include "scif_rb.h"
  56. #include "scif_peer_bus.h"
  57. #define SCIF_INIT 1 /* First message sent to the peer node for discovery */
  58. #define SCIF_EXIT 2 /* Last message from the peer informing intent to exit */
  59. #define SCIF_EXIT_ACK 3 /* Response to SCIF_EXIT message */
  60. #define SCIF_NODE_ADD 4 /* Tell Online nodes a new node exits */
  61. #define SCIF_NODE_ADD_ACK 5 /* Confirm to mgmt node sequence is finished */
  62. #define SCIF_NODE_ADD_NACK 6 /* SCIF_NODE_ADD failed */
  63. #define SCIF_NODE_REMOVE 7 /* Request to deactivate a SCIF node */
  64. #define SCIF_NODE_REMOVE_ACK 8 /* Response to a SCIF_NODE_REMOVE message */
  65. #define SCIF_CNCT_REQ 9 /* Phys addr of Request connection to a port */
  66. #define SCIF_CNCT_GNT 10 /* Phys addr of new Grant connection request */
  67. #define SCIF_CNCT_GNTACK 11 /* Error type Reject a connection request */
  68. #define SCIF_CNCT_GNTNACK 12 /* Error type Reject a connection request */
  69. #define SCIF_CNCT_REJ 13 /* Error type Reject a connection request */
  70. #define SCIF_DISCNCT 14 /* Notify peer that connection is being terminated */
  71. #define SCIF_DISCNT_ACK 15 /* Notify peer that connection is being terminated */
  72. #define SCIF_CLIENT_SENT 16 /* Notify the peer that data has been written */
  73. #define SCIF_CLIENT_RCVD 17 /* Notify the peer that data has been read */
  74. #define SCIF_GET_NODE_INFO 18 /* Get current node mask from the mgmt node*/
  75. #define SCIF_MAX_MSG SCIF_GET_NODE_INFO
  76. /*
  77. * struct scifmsg - Node QP message format
  78. *
  79. * @src: Source information
  80. * @dst: Destination information
  81. * @uop: The message opcode
  82. * @payload: Unique payload format for each message
  83. */
  84. struct scifmsg {
  85. struct scif_port_id src;
  86. struct scif_port_id dst;
  87. u32 uop;
  88. u64 payload[4];
  89. } __packed;
  90. /*
  91. * struct scif_qp - Node Queue Pair
  92. *
  93. * Interesting structure -- a little difficult because we can only
  94. * write across the PCIe, so any r/w pointer we need to read is
  95. * local. We only need to read the read pointer on the inbound_q
  96. * and read the write pointer in the outbound_q
  97. *
  98. * @magic: Magic value to ensure the peer sees the QP correctly
  99. * @outbound_q: The outbound ring buffer for sending messages
  100. * @inbound_q: The inbound ring buffer for receiving messages
  101. * @local_write: Local write index
  102. * @local_read: Local read index
  103. * @remote_qp: The remote queue pair
  104. * @local_buf: DMA address of local ring buffer
  105. * @local_qp: DMA address of the local queue pair data structure
  106. * @remote_buf: DMA address of remote ring buffer
  107. * @qp_state: QP state i.e. online or offline used for P2P
  108. * @send_lock: synchronize access to outbound queue
  109. * @recv_lock: Synchronize access to inbound queue
  110. */
  111. struct scif_qp {
  112. u64 magic;
  113. #define SCIFEP_MAGIC 0x5c1f000000005c1fULL
  114. struct scif_rb outbound_q;
  115. struct scif_rb inbound_q;
  116. u32 local_write __aligned(64);
  117. u32 local_read __aligned(64);
  118. struct scif_qp *remote_qp;
  119. dma_addr_t local_buf;
  120. dma_addr_t local_qp;
  121. dma_addr_t remote_buf;
  122. u32 qp_state;
  123. #define SCIF_QP_OFFLINE 0xdead
  124. #define SCIF_QP_ONLINE 0xc0de
  125. spinlock_t send_lock;
  126. spinlock_t recv_lock;
  127. };
  128. /*
  129. * struct scif_loopb_msg - An element in the loopback Node QP message list.
  130. *
  131. * @msg - The SCIF node QP message
  132. * @list - link in the list of messages
  133. */
  134. struct scif_loopb_msg {
  135. struct scifmsg msg;
  136. struct list_head list;
  137. };
  138. int scif_nodeqp_send(struct scif_dev *scifdev, struct scifmsg *msg);
  139. int _scif_nodeqp_send(struct scif_dev *scifdev, struct scifmsg *msg);
  140. void scif_nodeqp_intrhandler(struct scif_dev *scifdev, struct scif_qp *qp);
  141. int scif_loopb_msg_handler(struct scif_dev *scifdev, struct scif_qp *qp);
  142. int scif_setup_qp(struct scif_dev *scifdev);
  143. int scif_qp_response(phys_addr_t phys, struct scif_dev *dev);
  144. int scif_setup_qp_connect(struct scif_qp *qp, dma_addr_t *qp_offset,
  145. int local_size, struct scif_dev *scifdev);
  146. int scif_setup_qp_accept(struct scif_qp *qp, dma_addr_t *qp_offset,
  147. dma_addr_t phys, int local_size,
  148. struct scif_dev *scifdev);
  149. int scif_setup_qp_connect_response(struct scif_dev *scifdev,
  150. struct scif_qp *qp, u64 payload);
  151. int scif_setup_loopback_qp(struct scif_dev *scifdev);
  152. int scif_destroy_loopback_qp(struct scif_dev *scifdev);
  153. void scif_poll_qp_state(struct work_struct *work);
  154. void scif_qp_response_ack(struct work_struct *work);
  155. void scif_destroy_p2p(struct scif_dev *scifdev);
  156. void scif_send_exit(struct scif_dev *scifdev);
  157. static inline struct device *scif_get_peer_dev(struct scif_dev *scifdev)
  158. {
  159. struct scif_peer_dev *spdev;
  160. struct device *spdev_ret;
  161. rcu_read_lock();
  162. spdev = rcu_dereference(scifdev->spdev);
  163. if (spdev)
  164. spdev_ret = get_device(&spdev->dev);
  165. else
  166. spdev_ret = ERR_PTR(-ENODEV);
  167. rcu_read_unlock();
  168. return spdev_ret;
  169. }
  170. static inline void scif_put_peer_dev(struct device *dev)
  171. {
  172. put_device(dev);
  173. }
  174. #endif /* SCIF_NODEQP */