sys/dev/iscsi/icl_conn_if.m

   1 #-
   2 # SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 #
   4 # Copyright (c) 2014 The FreeBSD Foundation
   5 #
   6 # This software was developed by Edward Tomasz Napierala under sponsorship
   7 # from the FreeBSD Foundation.
   8 #
   9 # Redistribution and use in source and binary forms, with or without
  10 # modification, are permitted provided that the following conditions
  11 # are met:
  12 # 1. Redistributions of source code must retain the above copyright
  13 #    notice, this list of conditions and the following disclaimer.
  14 # 2. Redistributions in binary form must reproduce the above copyright
  15 #    notice, this list of conditions and the following disclaimer in the
  16 #    documentation and/or other materials provided with the distribution.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 # SUCH DAMAGE.
  29 #
  30 # $FreeBSD$
  31 #
  32
  33 #include <sys/socket.h>
  34 #include <dev/iscsi/icl.h>
  35
  36 INTERFACE icl_conn;
  37
  38 CODE {
  39         static void null_pdu_queue_cb(struct icl_conn *ic,
  40             struct icl_pdu *ip, icl_pdu_cb cb)
  41         {
  42                 ICL_CONN_PDU_QUEUE(ic, ip);
  43                 if (cb)
  44                         cb(ip, 0);
  45         }
  46 };
  47
  48 METHOD size_t pdu_data_segment_length {
  49         struct icl_conn *_ic;
  50         const struct icl_pdu *_ip;
  51 };
  52
  53 METHOD int pdu_append_data {
  54         struct icl_conn *_ic;
  55         struct icl_pdu *_ip;
  56         const void *_addr;
  57         size_t _len;
  58         int _flags;
  59 };
  60
  61 METHOD void pdu_get_data {
  62         struct icl_conn *_ic;
  63         struct icl_pdu *_ip;
  64         size_t _off;
  65         void *_addr;
  66         size_t _len;
  67 };
  68
  69 METHOD void pdu_queue {
  70         struct icl_conn *_ic;
  71         struct icl_pdu *_ip;
  72 };
  73
  74 METHOD void pdu_queue_cb {
  75         struct icl_conn *_ic;
  76         struct icl_pdu *_ip;
  77         icl_pdu_cb cb;
  78 } DEFAULT null_pdu_queue_cb;
  79
  80 METHOD void pdu_free {
  81         struct icl_conn *_ic;
  82         struct icl_pdu *_ip;
  83 };
  84
  85 METHOD struct icl_pdu * new_pdu {
  86         struct icl_conn *_ic;
  87         int _flags;
  88 };
  89
  90 METHOD void free {
  91         struct icl_conn *_ic;
  92 };
  93
  94 METHOD int handoff {
  95         struct icl_conn *_ic;
  96         int _fd;
  97 };
  98
  99 METHOD void close {
 100         struct icl_conn *_ic;
 101 };
 102
 103 METHOD int task_setup {
 104         struct icl_conn *_ic;
 105         struct icl_pdu *_ip;
 106         struct ccb_scsiio *_csio;
 107         uint32_t *_task_tag;
 108         void **_prvp;
 109 };
 110
 111 METHOD void task_done {
 112         struct icl_conn *_ic;
 113         void *_prv;
 114 };
 115
 116 METHOD int transfer_setup {
 117         struct icl_conn *_ic;
 118         union ctl_io *_io;
 119         uint32_t *_transfer_tag;
 120         void **_prvp;
 121 };
 122
 123 METHOD void transfer_done {
 124         struct icl_conn *_ic;
 125         void *_prv;
 126 };
 127
 128 #
 129 # The function below is only used with ICL_KERNEL_PROXY.
 130 #
 131 METHOD int connect {
 132         struct icl_conn *_ic;
 133         int _domain;
 134         int _socktype;
 135         int _protocol;
 136         struct sockaddr *_from_sa;
 137         struct sockaddr *_to_sa;
 138 };