1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2009-2017 Alexander Motin <mav@FreeBSD.org> 4 * Copyright (c) 1997-2009 by Matthew Jacob 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 */ 30 #ifndef _ISP_LIBRARY_H 31 #define _ISP_LIBRARY_H 32 33 /* 34 * Common command shipping routine. 35 * 36 * This used to be platform specific, but basically once you get the segment 37 * stuff figured out, you can make all the code in one spot. 38 */ 39 typedef enum { ISP_TO_DEVICE, ISP_FROM_DEVICE, ISP_NOXFR} isp_ddir_t; 40 int isp_send_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, ispds64_t *); 41 42 /* 43 * Handle management functions. 44 * 45 * These handles are associate with a command. 46 */ 47 uint32_t isp_allocate_handle(ispsoftc_t *, void *, int); 48 void *isp_find_xs(ispsoftc_t *, uint32_t); 49 uint32_t isp_find_handle(ispsoftc_t *, void *); 50 void isp_destroy_handle(ispsoftc_t *, uint32_t); 51 52 /* 53 * Request Queue allocation 54 */ 55 void *isp_getrqentry(ispsoftc_t *); 56 57 /* 58 * Queue Entry debug functions 59 */ 60 void isp_print_qentry (ispsoftc_t *, const char *, int, void *); 61 void isp_print_bytes(ispsoftc_t *, const char *, int, void *); 62 63 /* 64 * Fibre Channel specific routines and data. 65 */ 66 extern const char *isp_class3_roles[4]; 67 int isp_fc_runstate(ispsoftc_t *, int, int); 68 void isp_dump_portdb(ispsoftc_t *, int); 69 void isp_gen_role_str(char *, size_t, uint16_t); 70 71 const char *isp_fc_fw_statename(int); 72 const char *isp_fc_loop_statename(int); 73 const char *isp_fc_toponame(fcparam *); 74 75 /* 76 * Cleanup 77 */ 78 void isp_clear_commands(ispsoftc_t *); 79 80 /* 81 * Put/Get routines to push from CPU view to device view 82 * or to pull from device view to CPU view for various 83 * data structures (IOCB) 84 */ 85 void isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 86 void isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 87 int isp_get_response_type(ispsoftc_t *, isphdr_t *); 88 void isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *); 89 void isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *); 90 void isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *); 91 void isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *); 92 void isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *); 93 void isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *); 94 void isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *); 95 void isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *); 96 void isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *); 97 void isp_put_24xx_tmf(ispsoftc_t *, isp24xx_tmf_t *, isp24xx_tmf_t *); 98 void isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 99 void isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *); 100 void isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *); 101 void isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *); 102 void isp_get_cont_response(ispsoftc_t *, ispstatus_cont_t *, ispstatus_cont_t *); 103 void isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *, isp24xx_statusreq_t *); 104 void isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 105 void isp_get_rio1(ispsoftc_t *, isp_rio1_t *, isp_rio1_t *); 106 void isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *); 107 void isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *); 108 void isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *); 109 void isp_put_icb_2400_vpinfo(ispsoftc_t *, isp_icb_2400_vpinfo_t *, isp_icb_2400_vpinfo_t *); 110 void isp_put_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 111 void isp_get_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 112 void isp_put_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 113 void isp_get_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 114 void isp_put_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 115 void isp_get_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 116 void isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *); 117 void isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *); 118 void isp_get_pnhle_21xx(ispsoftc_t *, isp_pnhle_21xx_t *, isp_pnhle_21xx_t *); 119 void isp_get_pnhle_23xx(ispsoftc_t *, isp_pnhle_23xx_t *, isp_pnhle_23xx_t *); 120 void isp_get_pnhle_24xx(ispsoftc_t *, isp_pnhle_24xx_t *, isp_pnhle_24xx_t *); 121 void isp_get_pnnle(ispsoftc_t *, isp_pnnle_t *, isp_pnnle_t *); 122 void isp_get_ridacq(ispsoftc_t *, isp_ridacq_t *, isp_ridacq_t *); 123 void isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 124 void isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 125 void isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 126 void isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 127 void isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 128 void isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 129 void isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *); 130 void isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *, sns_gid_ft_req_t *); 131 void isp_put_gid_pt_request(ispsoftc_t *, sns_gid_pt_req_t *, sns_gid_pt_req_t *); 132 void isp_put_gxx_id_request(ispsoftc_t *, sns_gxx_id_req_t *, sns_gxx_id_req_t *); 133 void isp_get_gid_xx_response(ispsoftc_t *, sns_gid_xx_rsp_t *, sns_gid_xx_rsp_t *, int); 134 void isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *, sns_gxn_id_rsp_t *); 135 void isp_get_gft_id_response(ispsoftc_t *, sns_gft_id_rsp_t *, sns_gft_id_rsp_t *); 136 void isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *, sns_gff_id_rsp_t *); 137 void isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *, sns_ga_nxt_rsp_t *); 138 void isp_get_els(ispsoftc_t *, els_t *, els_t *); 139 void isp_put_els(ispsoftc_t *, els_t *, els_t *); 140 void isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 141 void isp_put_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 142 void isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *); 143 void isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *); 144 void isp_put_rspn_id(ispsoftc_t *, rspn_id_t *, rspn_id_t *); 145 void isp_put_rff_id(ispsoftc_t *, rff_id_t *, rff_id_t *); 146 void isp_put_rsnn_nn(ispsoftc_t *, rsnn_nn_t *, rsnn_nn_t *); 147 void isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 148 void isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 149 void isp_put_fcp_rsp_iu(ispsoftc_t *isp, fcp_rsp_iu_t *, fcp_rsp_iu_t *); 150 151 #define ISP_HANDLE_MASK 0x7fff 152 153 #ifdef ISP_TARGET_MODE 154 #if defined(__NetBSD__) || defined(__OpenBSD__) 155 #include <dev/ic/isp_target.h> 156 #elif defined(__FreeBSD__) 157 #include <dev/isp/isp_target.h> 158 #else 159 #include "isp_target.h" 160 #endif 161 #endif 162 163 int isp_find_pdb_empty(ispsoftc_t *, int, fcportdb_t **); 164 int isp_find_pdb_by_wwpn(ispsoftc_t *, int, uint64_t, fcportdb_t **); 165 int isp_find_pdb_by_handle(ispsoftc_t *, int, uint16_t, fcportdb_t **); 166 int isp_find_pdb_by_portid(ispsoftc_t *, int, uint32_t, fcportdb_t **); 167 #ifdef ISP_TARGET_MODE 168 void isp_find_chan_by_did(ispsoftc_t *, uint32_t, uint16_t *); 169 void isp_add_wwn_entry(ispsoftc_t *, int, uint64_t, uint64_t, uint16_t, uint32_t, uint16_t); 170 void isp_del_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); 171 void isp_del_all_wwn_entries(ispsoftc_t *, int); 172 void isp_del_wwn_entries(ispsoftc_t *, isp_notify_t *); 173 174 void isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 175 void isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 176 void isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 177 void isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 178 void isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *); 179 void isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 180 void isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 181 void isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 182 void isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 183 void isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 184 void isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 185 void isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 186 void isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 187 void isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 188 void isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 189 void isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 190 void isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 191 void isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 192 void isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 193 void isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 194 void isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 195 void isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 196 void isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 197 void isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 198 void isp_get_abts(ispsoftc_t *, abts_t *, abts_t *); 199 void isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 200 void isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 201 #endif /* ISP_TARGET_MODE */ 202 #endif /* _ISP_LIBRARY_H */ 203