153af7d22SMatt Jacob /* $FreeBSD$ */ 253af7d22SMatt Jacob /*- 32df76c16SMatt Jacob * Copyright (c) 1997-2009 by Matthew Jacob 453af7d22SMatt Jacob * All rights reserved. 553af7d22SMatt Jacob * 653af7d22SMatt Jacob * Redistribution and use in source and binary forms, with or without 753af7d22SMatt Jacob * modification, are permitted provided that the following conditions 853af7d22SMatt Jacob * are met: 953af7d22SMatt Jacob * 10e48b2487SMatt Jacob * 1. Redistributions of source code must retain the above copyright 11e48b2487SMatt Jacob * notice, this list of conditions and the following disclaimer. 12e48b2487SMatt Jacob * 2. Redistributions in binary form must reproduce the above copyright 13e48b2487SMatt Jacob * notice, this list of conditions and the following disclaimer in the 14e48b2487SMatt Jacob * documentation and/or other materials provided with the distribution. 15e48b2487SMatt Jacob * 16e48b2487SMatt Jacob * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1753af7d22SMatt Jacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1853af7d22SMatt Jacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19e48b2487SMatt Jacob * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20e48b2487SMatt Jacob * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2153af7d22SMatt Jacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2253af7d22SMatt Jacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2353af7d22SMatt Jacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2453af7d22SMatt Jacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2553af7d22SMatt Jacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2653af7d22SMatt Jacob * SUCH DAMAGE. 272df76c16SMatt Jacob * 2853af7d22SMatt Jacob */ 2953af7d22SMatt Jacob #ifndef _ISP_LIBRARY_H 3053af7d22SMatt Jacob #define _ISP_LIBRARY_H 3153af7d22SMatt Jacob 322df76c16SMatt Jacob /* 332df76c16SMatt Jacob * Common command shipping routine. 342df76c16SMatt Jacob * 352df76c16SMatt Jacob * This used to be platform specific, but basically once you get the segment 362df76c16SMatt Jacob * stuff figured out, you can make all the code in one spot. 372df76c16SMatt Jacob */ 382df76c16SMatt Jacob typedef enum { ISP_TO_DEVICE, ISP_FROM_DEVICE, ISP_NOXFR} isp_ddir_t; 39387d8239SMatt Jacob int isp_send_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, ispds64_t *); 402df76c16SMatt Jacob 412df76c16SMatt Jacob /* 422df76c16SMatt Jacob * Handle management functions. 432df76c16SMatt Jacob * 442df76c16SMatt Jacob * These handles are associate with a command. 452df76c16SMatt Jacob */ 46c8b8a2c4SMatt Jacob int isp_allocate_xs(ispsoftc_t *, XS_T *, uint32_t *); 472df76c16SMatt Jacob XS_T * isp_find_xs(ispsoftc_t *, uint32_t); 482df76c16SMatt Jacob uint32_t isp_find_handle(ispsoftc_t *, XS_T *); 49c8b8a2c4SMatt Jacob uint32_t isp_handle_index(ispsoftc_t *, uint32_t); 502df76c16SMatt Jacob void isp_destroy_handle(ispsoftc_t *, uint32_t); 512df76c16SMatt Jacob 522df76c16SMatt Jacob /* 532df76c16SMatt Jacob * Request Queue allocation 542df76c16SMatt Jacob */ 552df76c16SMatt Jacob void *isp_getrqentry(ispsoftc_t *); 562df76c16SMatt Jacob 572df76c16SMatt Jacob /* 582df76c16SMatt Jacob * Queue Entry debug functions 592df76c16SMatt Jacob */ 602df76c16SMatt Jacob void isp_print_qentry (ispsoftc_t *, const char *, int, void *); 612df76c16SMatt Jacob void isp_print_bytes(ispsoftc_t *, const char *, int, void *); 622df76c16SMatt Jacob 632df76c16SMatt Jacob /* 642df76c16SMatt Jacob * Fibre Channel specific routines and data. 652df76c16SMatt Jacob */ 662df76c16SMatt Jacob extern const char *isp_class3_roles[4]; 672df76c16SMatt Jacob int isp_fc_runstate(ispsoftc_t *, int, int); 682df76c16SMatt Jacob void isp_dump_portdb(ispsoftc_t *, int); 69387d8239SMatt Jacob void isp_gen_role_str(char *, size_t, uint16_t); 702df76c16SMatt Jacob 712df76c16SMatt Jacob const char *isp_fc_fw_statename(int); 722df76c16SMatt Jacob const char *isp_fc_loop_statename(int); 732df76c16SMatt Jacob const char *isp_fc_toponame(fcparam *); 742df76c16SMatt Jacob 752df76c16SMatt Jacob int isp_fc_change_role(ispsoftc_t *, int, int); 762df76c16SMatt Jacob 772df76c16SMatt Jacob 782df76c16SMatt Jacob /* 792df76c16SMatt Jacob * Cleanup 802df76c16SMatt Jacob */ 812df76c16SMatt Jacob void isp_clear_commands(ispsoftc_t *); 822df76c16SMatt Jacob 832df76c16SMatt Jacob /* 842df76c16SMatt Jacob * Common chip shutdown function 852df76c16SMatt Jacob */ 862df76c16SMatt Jacob void isp_shutdown(ispsoftc_t *); 872df76c16SMatt Jacob 882df76c16SMatt Jacob /* 892df76c16SMatt Jacob * Put/Get routines to push from CPU view to device view 902df76c16SMatt Jacob * or to pull from device view to CPU view for various 912df76c16SMatt Jacob * data structures (IOCB) 922df76c16SMatt Jacob */ 932df76c16SMatt Jacob void isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 942df76c16SMatt Jacob void isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 952df76c16SMatt Jacob int isp_get_response_type(ispsoftc_t *, isphdr_t *); 962df76c16SMatt Jacob void isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *); 972df76c16SMatt Jacob void isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *); 982df76c16SMatt Jacob void isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *); 992df76c16SMatt Jacob void isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *); 1002df76c16SMatt Jacob void isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *); 1012df76c16SMatt Jacob void isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *); 1022df76c16SMatt Jacob void isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *); 1032df76c16SMatt Jacob void isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *); 1042df76c16SMatt Jacob void isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *); 1052df76c16SMatt Jacob void isp_put_24xx_tmf(ispsoftc_t *, isp24xx_tmf_t *, isp24xx_tmf_t *); 1062df76c16SMatt Jacob void isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 1072df76c16SMatt Jacob void isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *); 1082df76c16SMatt Jacob void isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *); 1092df76c16SMatt Jacob void isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *); 110387d8239SMatt Jacob void isp_get_cont_response(ispsoftc_t *, ispstatus_cont_t *, ispstatus_cont_t *); 1112df76c16SMatt Jacob void isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *, isp24xx_statusreq_t *); 1122df76c16SMatt Jacob void isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 113443e752dSMatt Jacob void isp_get_rio1(ispsoftc_t *, isp_rio1_t *, isp_rio1_t *); 1142df76c16SMatt Jacob void isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *); 1152df76c16SMatt Jacob void isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *); 1162df76c16SMatt Jacob void isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *); 1172df76c16SMatt Jacob void isp_put_icb_2400_vpinfo(ispsoftc_t *, isp_icb_2400_vpinfo_t *, isp_icb_2400_vpinfo_t *); 1182df76c16SMatt Jacob void isp_put_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 1192df76c16SMatt Jacob void isp_get_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 1202df76c16SMatt Jacob void isp_put_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 1212df76c16SMatt Jacob void isp_get_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 1222df76c16SMatt Jacob void isp_put_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 1232df76c16SMatt Jacob void isp_get_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 1242df76c16SMatt Jacob void isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *); 1252df76c16SMatt Jacob void isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *); 1262df76c16SMatt Jacob void isp_get_ridacq(ispsoftc_t *, isp_ridacq_t *, isp_ridacq_t *); 1272df76c16SMatt Jacob void isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 1282df76c16SMatt Jacob void isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 1292df76c16SMatt Jacob void isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 1302df76c16SMatt Jacob void isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 1312df76c16SMatt Jacob void isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 1322df76c16SMatt Jacob void isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 1332df76c16SMatt Jacob void isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *); 1342df76c16SMatt Jacob void isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *, sns_gid_ft_req_t *); 1352df76c16SMatt Jacob void isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *, sns_gxn_id_req_t *); 1362df76c16SMatt Jacob void isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int); 1372df76c16SMatt Jacob void isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *, sns_gid_ft_rsp_t *, int); 1382df76c16SMatt Jacob void isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *, sns_gxn_id_rsp_t *); 1392df76c16SMatt Jacob void isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *, sns_gff_id_rsp_t *); 1402df76c16SMatt Jacob void isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *, sns_ga_nxt_rsp_t *); 1412df76c16SMatt Jacob void isp_get_els(ispsoftc_t *, els_t *, els_t *); 1422df76c16SMatt Jacob void isp_put_els(ispsoftc_t *, els_t *, els_t *); 1432df76c16SMatt Jacob void isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 144387d8239SMatt Jacob void isp_put_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 1452df76c16SMatt Jacob void isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *); 1462df76c16SMatt Jacob void isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *); 1472df76c16SMatt Jacob void isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 1482df76c16SMatt Jacob void isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 149387d8239SMatt Jacob void isp_put_fcp_rsp_iu(ispsoftc_t *isp, fcp_rsp_iu_t *, fcp_rsp_iu_t *); 15053af7d22SMatt Jacob 1519a1b0d43SMatt Jacob #define ISP_HANDLE_MASK 0x7fff 1529a1b0d43SMatt Jacob 15353af7d22SMatt Jacob #ifdef ISP_TARGET_MODE 1541dae40ebSMatt Jacob #if defined(__NetBSD__) || defined(__OpenBSD__) 1551dae40ebSMatt Jacob #include <dev/ic/isp_target.h> 1561dae40ebSMatt Jacob #elif defined(__FreeBSD__) 15753af7d22SMatt Jacob #include <dev/isp/isp_target.h> 1581dae40ebSMatt Jacob #else 1591dae40ebSMatt Jacob #include "isp_target.h" 1601dae40ebSMatt Jacob #endif 16153af7d22SMatt Jacob 1622df76c16SMatt Jacob int isp_send_tgt_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, void *, uint32_t); 1632df76c16SMatt Jacob 164c8b8a2c4SMatt Jacob int isp_allocate_xs_tgt(ispsoftc_t *, void *, uint32_t *); 1652df76c16SMatt Jacob void *isp_find_xs_tgt(ispsoftc_t *, uint32_t); 1662df76c16SMatt Jacob uint32_t isp_find_tgt_handle(ispsoftc_t *, void *); 1672df76c16SMatt Jacob void isp_destroy_tgt_handle(ispsoftc_t *, uint32_t); 168*e68eef14SAlexander Motin #endif 1692df76c16SMatt Jacob int isp_find_pdb_by_wwn(ispsoftc_t *, int, uint64_t, fcportdb_t **); 170*e68eef14SAlexander Motin #ifdef ISP_TARGET_MODE 171*e68eef14SAlexander Motin int isp_find_pdb_by_handle(ispsoftc_t *, int, uint32_t, fcportdb_t **); 1722df76c16SMatt Jacob int isp_find_pdb_by_sid(ispsoftc_t *, int, uint32_t, fcportdb_t **); 1732df76c16SMatt Jacob void isp_find_chan_by_did(ispsoftc_t *, uint32_t, uint16_t *); 174387d8239SMatt Jacob void isp_add_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t, uint16_t); 1752df76c16SMatt Jacob void isp_del_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); 1762df76c16SMatt Jacob void isp_del_all_wwn_entries(ispsoftc_t *, int); 1772df76c16SMatt Jacob void isp_del_wwn_entries(ispsoftc_t *, isp_notify_t *); 1782df76c16SMatt Jacob 1792df76c16SMatt Jacob void isp_put_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); 1802df76c16SMatt Jacob void isp_get_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); 1812df76c16SMatt Jacob void isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 1822df76c16SMatt Jacob void isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 1832df76c16SMatt Jacob void isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 1842df76c16SMatt Jacob void isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 1852df76c16SMatt Jacob void isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *); 1862df76c16SMatt Jacob void isp_put_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); 1872df76c16SMatt Jacob void isp_get_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); 1882df76c16SMatt Jacob void isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 1892df76c16SMatt Jacob void isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 1902df76c16SMatt Jacob void isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 1912df76c16SMatt Jacob void isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 1922df76c16SMatt Jacob void isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 1932df76c16SMatt Jacob void isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 1942df76c16SMatt Jacob void isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 1952df76c16SMatt Jacob void isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 1962df76c16SMatt Jacob void isp_put_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); 1972df76c16SMatt Jacob void isp_get_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); 1982df76c16SMatt Jacob void isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 1992df76c16SMatt Jacob void isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 2002df76c16SMatt Jacob void isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 2012df76c16SMatt Jacob void isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 2022df76c16SMatt Jacob void isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 2032df76c16SMatt Jacob void isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 2042df76c16SMatt Jacob void isp_put_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); 2052df76c16SMatt Jacob void isp_get_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); 2062df76c16SMatt Jacob void isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 2072df76c16SMatt Jacob void isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 2082df76c16SMatt Jacob void isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 2092df76c16SMatt Jacob void isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 2102df76c16SMatt Jacob void isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 2112df76c16SMatt Jacob void isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 2122df76c16SMatt Jacob void isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 2132df76c16SMatt Jacob void isp_get_abts(ispsoftc_t *, abts_t *, abts_t *); 2142df76c16SMatt Jacob void isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 2152df76c16SMatt Jacob void isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 21653af7d22SMatt Jacob #endif /* ISP_TARGET_MODE */ 21753af7d22SMatt Jacob #endif /* _ISP_LIBRARY_H */ 218