| 1 | /* $Id: isp_library.h,v 1.4 2010/03/26 20:52:00 mjacob Exp $ */ |
| 2 | /*- |
| 3 | * Copyright (c) 1997-2008 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 | * |
| 29 | * Matthew Jacob |
| 30 | * Feral Software |
| 31 | * 421 Laurel Avenue |
| 32 | * Menlo Park, CA 94025 |
| 33 | * USA |
| 34 | * |
| 35 | * gplbsd at feral com |
| 36 | */ |
| 37 | #ifndef _ISP_LIBRARY_H |
| 38 | #define _ISP_LIBRARY_H |
| 39 | |
| 40 | /* |
| 41 | * Common command shipping routine. |
| 42 | * |
| 43 | * This used to be platform specific, but basically once you get the segment |
| 44 | * stuff figured out, you can make all the code in one spot. |
| 45 | */ |
| 46 | typedef enum { ISP_TO_DEVICE, ISP_FROM_DEVICE, ISP_NOXFR} isp_ddir_t; |
| 47 | int isp_send_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t); |
| 48 | |
| 49 | /* |
| 50 | * Handle management functions. |
| 51 | * |
| 52 | * These handles are associate with a command. |
| 53 | */ |
| 54 | int isp_allocate_xs(ispsoftc_t *, XS_T *, uint32_t *); |
| 55 | XS_T * isp_find_xs(ispsoftc_t *, uint32_t); |
| 56 | uint32_t isp_find_handle(ispsoftc_t *, XS_T *); |
| 57 | uint32_t isp_handle_index(ispsoftc_t *, uint32_t); |
| 58 | void isp_destroy_handle(ispsoftc_t *, uint32_t); |
| 59 | |
| 60 | /* |
| 61 | * Request Queue allocation |
| 62 | */ |
| 63 | void *isp_getrqentry(ispsoftc_t *); |
| 64 | |
| 65 | /* |
| 66 | * Queue Entry debug functions |
| 67 | */ |
| 68 | void isp_print_qentry (ispsoftc_t *, const char *, int, void *); |
| 69 | void isp_print_bytes(ispsoftc_t *, const char *, int, void *); |
| 70 | |
| 71 | /* |
| 72 | * Fibre Channel specific routines and data. |
| 73 | */ |
| 74 | extern const char *isp_class3_roles[4]; |
| 75 | int isp_fc_runstate(ispsoftc_t *, int, int); |
| 76 | void isp_dump_portdb(ispsoftc_t *, int); |
| 77 | |
| 78 | const char *isp_fc_fw_statename(int); |
| 79 | const char *isp_fc_loop_statename(int); |
| 80 | const char *isp_fc_toponame(fcparam *); |
| 81 | |
| 82 | int isp_fc_change_role(ispsoftc_t *, int, int); |
| 83 | |
| 84 | |
| 85 | /* |
| 86 | * Cleanup |
| 87 | */ |
| 88 | void isp_clear_commands(ispsoftc_t *); |
| 89 | |
| 90 | /* |
| 91 | * Common chip shutdown function |
| 92 | */ |
| 93 | void isp_shutdown(ispsoftc_t *); |
| 94 | |
| 95 | /* |
| 96 | * Put/Get routines to push from CPU view to device view |
| 97 | * or to pull from device view to CPU view for various |
| 98 | * data structures (IOCB) |
| 99 | */ |
| 100 | void isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); |
| 101 | void isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); |
| 102 | int isp_get_response_type(ispsoftc_t *, isphdr_t *); |
| 103 | void isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *); |
| 104 | void isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *); |
| 105 | void isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *); |
| 106 | void isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *); |
| 107 | void isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *); |
| 108 | void isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *); |
| 109 | void isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *); |
| 110 | void isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *); |
| 111 | void isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *); |
| 112 | void isp_put_24xx_tmf(ispsoftc_t *, isp24xx_tmf_t *, isp24xx_tmf_t *); |
| 113 | void isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); |
| 114 | void isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *); |
| 115 | void isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *); |
| 116 | void isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *); |
| 117 | void isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *, isp24xx_statusreq_t *); |
| 118 | void isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); |
| 119 | void isp_get_rio1(ispsoftc_t *, isp_rio1_t *, isp_rio1_t *); |
| 120 | void isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *); |
| 121 | void isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *); |
| 122 | void isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *); |
| 123 | void isp_put_icb_2400_vpinfo(ispsoftc_t *, isp_icb_2400_vpinfo_t *, isp_icb_2400_vpinfo_t *); |
| 124 | void isp_put_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); |
| 125 | void isp_get_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); |
| 126 | void isp_put_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); |
| 127 | void isp_get_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); |
| 128 | void isp_put_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); |
| 129 | void isp_get_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); |
| 130 | void isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *); |
| 131 | void isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *); |
| 132 | void isp_get_ridacq(ispsoftc_t *, isp_ridacq_t *, isp_ridacq_t *); |
| 133 | void isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); |
| 134 | void isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); |
| 135 | void isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); |
| 136 | void isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); |
| 137 | void isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); |
| 138 | void isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); |
| 139 | void isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *); |
| 140 | void isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *, sns_gid_ft_req_t *); |
| 141 | void isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *, sns_gxn_id_req_t *); |
| 142 | void isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int); |
| 143 | void isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *, sns_gid_ft_rsp_t *, int); |
| 144 | void isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *, sns_gxn_id_rsp_t *); |
| 145 | void isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *, sns_gff_id_rsp_t *); |
| 146 | void isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *, sns_ga_nxt_rsp_t *); |
| 147 | void isp_get_els(ispsoftc_t *, els_t *, els_t *); |
| 148 | void isp_put_els(ispsoftc_t *, els_t *, els_t *); |
| 149 | void isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); |
| 150 | void isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *); |
| 151 | void isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *); |
| 152 | void isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); |
| 153 | void isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); |
| 154 | |
| 155 | #define ISP_HANDLE_MASK 0x7fff |
| 156 | |
| 157 | #ifdef ISP_TARGET_MODE |
| 158 | #if defined(__NetBSD__) || defined(__OpenBSD__) |
| 159 | #include <dev/ic/isp_target.h> |
| 160 | #elif defined(__FreeBSD__) |
| 161 | #include <dev/isp/isp_target.h> |
| 162 | #else |
| 163 | #include "isp_target.h" |
| 164 | #endif |
| 165 | |
| 166 | int isp_send_tgt_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, void *, uint32_t); |
| 167 | |
| 168 | int isp_allocate_xs_tgt(ispsoftc_t *, void *, uint32_t *); |
| 169 | void *isp_find_xs_tgt(ispsoftc_t *, uint32_t); |
| 170 | uint32_t isp_find_tgt_handle(ispsoftc_t *, void *); |
| 171 | void isp_destroy_tgt_handle(ispsoftc_t *, uint32_t); |
| 172 | |
| 173 | int isp_find_pdb_by_wwn(ispsoftc_t *, int, uint64_t, fcportdb_t **); |
| 174 | int isp_find_pdb_by_loopid(ispsoftc_t *, int, uint32_t, fcportdb_t **); |
| 175 | int isp_find_pdb_by_sid(ispsoftc_t *, int, uint32_t, fcportdb_t **); |
| 176 | void isp_find_chan_by_did(ispsoftc_t *, uint32_t, uint16_t *); |
| 177 | void isp_add_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); |
| 178 | void isp_del_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); |
| 179 | void isp_del_all_wwn_entries(ispsoftc_t *, int); |
| 180 | void isp_del_wwn_entries(ispsoftc_t *, isp_notify_t *); |
| 181 | |
| 182 | void isp_put_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); |
| 183 | void isp_get_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); |
| 184 | void isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); |
| 185 | void isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); |
| 186 | void isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); |
| 187 | void isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); |
| 188 | void isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *); |
| 189 | void isp_put_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); |
| 190 | void isp_get_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); |
| 191 | void isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); |
| 192 | void isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); |
| 193 | void isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); |
| 194 | void isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); |
| 195 | void isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); |
| 196 | void isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); |
| 197 | void isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); |
| 198 | void isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); |
| 199 | void isp_put_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); |
| 200 | void isp_get_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); |
| 201 | void isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); |
| 202 | void isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); |
| 203 | void isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); |
| 204 | void isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); |
| 205 | void isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); |
| 206 | void isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); |
| 207 | void isp_put_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); |
| 208 | void isp_get_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); |
| 209 | void isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); |
| 210 | void isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); |
| 211 | void isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); |
| 212 | void isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); |
| 213 | void isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); |
| 214 | void isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); |
| 215 | void isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); |
| 216 | void isp_get_abts(ispsoftc_t *, abts_t *, abts_t *); |
| 217 | void isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); |
| 218 | void isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); |
| 219 | #endif /* ISP_TARGET_MODE */ |
| 220 | #endif /* _ISP_LIBRARY_H */ |
| 221 | |