sys/dev/isp/isp_library.h

   1 /* $FreeBSD$ */
   2 /*-
   3  *  Copyright (c) 1997-2007 by Matthew Jacob
   4  *  All rights reserved.
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions
   8  *  are met:
   9  *
  10  *  1. Redistributions of source code must retain the above copyright
  11  *     notice, this list of conditions and the following disclaimer.
  12  *  2. Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in the
  14  *     documentation and/or other materials provided with the distribution.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  20  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  *  SUCH DAMAGE.
  27  */
  28 #ifndef _ISP_LIBRARY_H
  29 #define _ISP_LIBRARY_H
  30
  31 extern int isp_save_xs(ispsoftc_t *, XS_T *, uint32_t *);
  32 extern XS_T *isp_find_xs(ispsoftc_t *, uint32_t);
  33 extern uint32_t isp_find_handle(ispsoftc_t *, XS_T *);
  34 extern uint32_t isp_handle_index(uint32_t);
  35 extern void isp_destroy_handle(ispsoftc_t *, uint32_t);
  36 extern int isp_getrqentry(ispsoftc_t *, uint32_t *, uint32_t *, void **);
  37 extern void isp_print_qentry (ispsoftc_t *, char *, int, void *);
  38 extern void isp_print_bytes(ispsoftc_t *, const char *, int, void *);
  39 extern int isp_fc_runstate(ispsoftc_t *, int);
  40 extern void isp_dump_portdb(ispsoftc_t *);
  41 extern void isp_shutdown(ispsoftc_t *);
  42 extern void isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *);
  43 extern void isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *);
  44 extern int isp_get_response_type(ispsoftc_t *, isphdr_t *);
  45 extern void
  46 isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *);
  47 extern void
  48 isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *);
  49 extern void
  50 isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *);
  51 extern void
  52 isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *);
  53 extern void
  54 isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *);
  55 extern void
  56 isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *);
  57 extern void
  58 isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *);
  59 extern void
  60 isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *);
  61 extern void
  62 isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *);
  63 extern void
  64 isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *);
  65 extern void
  66 isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *);
  67 extern void
  68 isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *);
  69 extern void
  70 isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *);
  71 extern void isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *,
  72     isp24xx_statusreq_t *);
  73 void
  74 isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *);
  75 extern void
  76 isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *);
  77 extern void
  78 isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *);
  79 extern void
  80 isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *);
  81 extern void
  82 isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *);
  83 extern void
  84 isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *);
  85 extern void
  86 isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *);
  87 extern void
  88 isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *);
  89 extern void
  90 isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *);
  91 extern void
  92 isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *);
  93 extern void
  94 isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *);
  95 extern void
  96 isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *);
  97 extern void
  98 isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *);
  99 extern void
 100 isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *,
 101     sns_gid_ft_req_t *);
 102 extern void
 103 isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *,
 104     sns_gxn_id_req_t *);
 105 extern void
 106 isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int);
 107 extern void
 108 isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *,
 109     sns_gid_ft_rsp_t *, int);
 110 extern void
 111 isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *,
 112     sns_gxn_id_rsp_t *);
 113 extern void
 114 isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *,
 115     sns_gff_id_rsp_t *);
 116 extern void
 117 isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *,
 118     sns_ga_nxt_rsp_t *);
 119 extern void
 120 isp_get_els(ispsoftc_t *, els_t *, els_t *);
 121 extern void
 122 isp_put_els(ispsoftc_t *, els_t *, els_t *);
 123 extern void
 124 isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *);
 125 extern void
 126 isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *);
 127 extern void isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *);
 128 extern void isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *);
 129 extern void isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *);
 130
 131 #define ISP_HANDLE_MASK         0x7fff
 132
 133 #ifdef  ISP_TARGET_MODE
 134 #if     defined(__NetBSD__) || defined(__OpenBSD__)
 135 #include <dev/ic/isp_target.h>
 136 #elif   defined(__FreeBSD__)
 137 #include <dev/isp/isp_target.h>
 138 #else
 139 #include "isp_target.h"
 140 #endif
 141
 142 #define IS_TARGET_HANDLE(x)     ((x) & 0x8000)
 143
 144 extern int isp_save_xs_tgt(ispsoftc_t *, void *, uint32_t *);
 145 extern void *isp_find_xs_tgt(ispsoftc_t *, uint32_t);
 146 extern uint32_t isp_find_tgt_handle(ispsoftc_t *, void *);
 147 extern void isp_destroy_tgt_handle(ispsoftc_t *, uint32_t);
 148
 149 extern void
 150 isp_put_atio(ispsoftc_t *, at_entry_t *, at_entry_t *);
 151 extern void
 152 isp_get_atio(ispsoftc_t *, at_entry_t *, at_entry_t *);
 153 extern void
 154 isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *);
 155 extern void
 156 isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *);
 157 extern void
 158 isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *);
 159 extern void
 160 isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *);
 161 extern void
 162 isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *);
 163 extern void
 164 isp_put_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *);
 165 extern void
 166 isp_get_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *);
 167 extern void
 168 isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *);
 169 extern void
 170 isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *);
 171 extern void
 172 isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *);
 173 extern void
 174 isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *);
 175 extern void
 176 isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *);
 177 extern void
 178 isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *);
 179 extern void
 180 isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *);
 181 extern void
 182 isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *);
 183 extern void
 184 isp_put_notify(ispsoftc_t *, in_entry_t *, in_entry_t *);
 185 extern void
 186 isp_get_notify(ispsoftc_t *, in_entry_t *, in_entry_t *);
 187 extern void
 188 isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *);
 189 extern void
 190 isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *);
 191 extern void
 192 isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *);
 193 extern void
 194 isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *);
 195 extern void
 196 isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *);
 197 extern void
 198 isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *);
 199 extern void
 200 isp_put_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *);
 201 extern void
 202 isp_get_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *);
 203 extern void
 204 isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *);
 205 extern void
 206 isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *);
 207 extern void
 208 isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *);
 209 extern void isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *,
 210     na_fcentry_24xx_t *);
 211 extern void
 212 isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *);
 213 extern void
 214 isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *);
 215 extern void isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *,
 216     na_fcentry_24xx_t *);
 217 extern void
 218 isp_get_abts(ispsoftc_t *, abts_t *, abts_t *);
 219 extern void
 220 isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *);
 221 extern void
 222 isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *);
 223 #endif  /* ISP_TARGET_MODE */
 224 #endif  /* _ISP_LIBRARY_H */