drivers/misc/mic/scif/scif_epd.h

   1 /*
   2  * Intel MIC Platform Software Stack (MPSS)
   3  *
   4  * Copyright(c) 2014 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 2, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * Intel SCIF driver.
  16  *
  17  */
  18 #ifndef SCIF_EPD_H
  19 #define SCIF_EPD_H
  20
  21 #include <linux/delay.h>
  22 #include <linux/scif.h>
  23 #include <linux/scif_ioctl.h>
  24
  25 #define SCIF_EPLOCK_HELD true
  26
  27 enum scif_epd_state {
  28         SCIFEP_UNBOUND,
  29         SCIFEP_BOUND,
  30         SCIFEP_LISTENING,
  31         SCIFEP_CONNECTED,
  32         SCIFEP_CONNECTING,
  33         SCIFEP_MAPPING,
  34         SCIFEP_CLOSING,
  35         SCIFEP_CLLISTEN,
  36         SCIFEP_DISCONNECTED,
  37         SCIFEP_ZOMBIE
  38 };
  39
  40 /*
  41  * struct scif_conreq - Data structure added to the connection list.
  42  *
  43  * @msg: connection request message received
  44  * @list: link to list of connection requests
  45  */
  46 struct scif_conreq {
  47         struct scifmsg msg;
  48         struct list_head list;
  49 };
  50
  51 /* Size of the RB for the Endpoint QP */
  52 #define SCIF_ENDPT_QP_SIZE 0x1000
  53
  54 /*
  55  * scif_endpt_qp_info - SCIF endpoint queue pair
  56  *
  57  * @qp - Qpair for this endpoint
  58  * @qp_offset - DMA address of the QP
  59  * @gnt_pld - Payload in a SCIF_CNCT_GNT message containing the
  60  * physical address of the remote_qp.
  61  */
  62 struct scif_endpt_qp_info {
  63         struct scif_qp *qp;
  64         dma_addr_t qp_offset;
  65         dma_addr_t gnt_pld;
  66 };
  67
  68 /*
  69  * struct scif_endpt - The SCIF endpoint data structure
  70  *
  71  * @state: end point state
  72  * @lock: lock synchronizing access to endpoint fields like state etc
  73  * @port: self port information
  74  * @peer: peer port information
  75  * @backlog: maximum pending connection requests
  76  * @qp_info: Endpoint QP information for SCIF messaging
  77  * @remote_dev: scifdev used by this endpt to communicate with remote node.
  78  * @remote_ep: remote endpoint
  79  * @conreqcnt: Keep track of number of connection requests.
  80  * @files: Open file information used to match the id passed in with
  81  *         the flush routine.
  82  * @conlist: list of connection requests
  83  * @conwq: waitqueue for connection processing
  84  * @discon: completion used during disconnection
  85  * @sendwq: waitqueue used during sending messages
  86  * @recvwq: waitqueue used during message receipt
  87  * @sendlock: Synchronize ordering of messages sent
  88  * @recvlock: Synchronize ordering of messages received
  89  * @list: link to list of various endpoints like connected, listening etc
  90  * @li_accept: pending ACCEPTREG
  91  * @acceptcnt: pending ACCEPTREG cnt
  92  * @liacceptlist: link to listen accept
  93  * @miacceptlist: link to uaccept
  94  * @listenep: associated listen ep
  95  * @conn_work: Non blocking connect work
  96  * @conn_port: Connection port
  97  * @conn_err: Errors during connection
  98  * @conn_async_state: Async connection
  99  * @conn_list: List of async connection requests
 100  */
 101 struct scif_endpt {
 102         enum scif_epd_state state;
 103         spinlock_t lock;
 104         struct scif_port_id port;
 105         struct scif_port_id peer;
 106         int backlog;
 107         struct scif_endpt_qp_info qp_info;
 108         struct scif_dev *remote_dev;
 109         u64 remote_ep;
 110         int conreqcnt;
 111         struct files_struct *files;
 112         struct list_head conlist;
 113         wait_queue_head_t conwq;
 114         struct completion discon;
 115         wait_queue_head_t sendwq;
 116         wait_queue_head_t recvwq;
 117         struct mutex sendlock;
 118         struct mutex recvlock;
 119         struct list_head list;
 120         struct list_head li_accept;
 121         int acceptcnt;
 122         struct list_head liacceptlist;
 123         struct list_head miacceptlist;
 124         struct scif_endpt *listenep;
 125         struct scif_port_id conn_port;
 126         int conn_err;
 127         int conn_async_state;
 128         struct list_head conn_list;
 129 };
 130
 131 static inline int scifdev_alive(struct scif_endpt *ep)
 132 {
 133         return _scifdev_alive(ep->remote_dev);
 134 }
 135
 136 void scif_cleanup_zombie_epd(void);
 137 void scif_teardown_ep(void *endpt);
 138 void scif_cleanup_ep_qp(struct scif_endpt *ep);
 139 void scif_add_epd_to_zombie_list(struct scif_endpt *ep, bool eplock_held);
 140 void scif_get_node_info(void);
 141 void scif_send_acks(struct scif_dev *dev);
 142 void scif_conn_handler(struct work_struct *work);
 143 int scif_rsrv_port(u16 port);
 144 void scif_get_port(u16 port);
 145 int scif_get_new_port(void);
 146 void scif_put_port(u16 port);
 147 int scif_user_send(scif_epd_t epd, void __user *msg, int len, int flags);
 148 int scif_user_recv(scif_epd_t epd, void __user *msg, int len, int flags);
 149 void scif_cnctreq(struct scif_dev *scifdev, struct scifmsg *msg);
 150 void scif_cnctgnt(struct scif_dev *scifdev, struct scifmsg *msg);
 151 void scif_cnctgnt_ack(struct scif_dev *scifdev, struct scifmsg *msg);
 152 void scif_cnctgnt_nack(struct scif_dev *scifdev, struct scifmsg *msg);
 153 void scif_cnctrej(struct scif_dev *scifdev, struct scifmsg *msg);
 154 void scif_discnct(struct scif_dev *scifdev, struct scifmsg *msg);
 155 void scif_discnt_ack(struct scif_dev *scifdev, struct scifmsg *msg);
 156 void scif_clientsend(struct scif_dev *scifdev, struct scifmsg *msg);
 157 void scif_clientrcvd(struct scif_dev *scifdev, struct scifmsg *msg);
 158 int __scif_connect(scif_epd_t epd, struct scif_port_id *dst, bool non_block);
 159 int __scif_flush(scif_epd_t epd);
 160 #endif /* SCIF_EPD_H */