isp_library.h revision 238869
1212795Sdim/* $FreeBSD: head/sys/dev/isp/isp_library.h 238869 2012-07-28 20:06:29Z mjacob $ */ 2212795Sdim/*- 3212795Sdim * Copyright (c) 1997-2009 by Matthew Jacob 4212795Sdim * All rights reserved. 5212795Sdim * 6212795Sdim * Redistribution and use in source and binary forms, with or without 7212795Sdim * modification, are permitted provided that the following conditions 8212795Sdim * are met: 9212795Sdim * 10212795Sdim * 1. Redistributions of source code must retain the above copyright 11212795Sdim * notice, this list of conditions and the following disclaimer. 12212795Sdim * 2. Redistributions in binary form must reproduce the above copyright 13212795Sdim * notice, this list of conditions and the following disclaimer in the 14212795Sdim * documentation and/or other materials provided with the distribution. 15212795Sdim * 16249423Sdim * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17218893Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18218893Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19212795Sdim * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20212795Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21212795Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22212795Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23263508Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24212795Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25212795Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26234353Sdim * SUCH DAMAGE. 27212795Sdim * 28212795Sdim */ 29212795Sdim#ifndef _ISP_LIBRARY_H 30212795Sdim#define _ISP_LIBRARY_H 31212795Sdim 32212795Sdim/* 33212795Sdim * Common command shipping routine. 34212795Sdim * 35212795Sdim * This used to be platform specific, but basically once you get the segment 36212795Sdim * stuff figured out, you can make all the code in one spot. 37212795Sdim */ 38212795Sdimtypedef enum { ISP_TO_DEVICE, ISP_FROM_DEVICE, ISP_NOXFR} isp_ddir_t; 39239462Sdimint isp_send_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, ispds64_t *); 40239462Sdim 41239462Sdim/* 42234353Sdim * Handle management functions. 43218893Sdim * 44226633Sdim * These handles are associate with a command. 45234353Sdim */ 46243830Sdimint isp_allocate_xs(ispsoftc_t *, XS_T *, uint32_t *); 47243830SdimXS_T * isp_find_xs(ispsoftc_t *, uint32_t); 48212795Sdimuint32_t isp_find_handle(ispsoftc_t *, XS_T *); 49212795Sdimuint32_t isp_handle_index(ispsoftc_t *, uint32_t); 50243830Sdimvoid isp_destroy_handle(ispsoftc_t *, uint32_t); 51249423Sdim 52212795Sdim/* 53212795Sdim * Request Queue allocation 54221345Sdim */ 55212795Sdimvoid *isp_getrqentry(ispsoftc_t *); 56212795Sdim 57212795Sdim/* 58212795Sdim * Queue Entry debug functions 59212795Sdim */ 60212795Sdimvoid isp_print_qentry (ispsoftc_t *, const char *, int, void *); 61212795Sdimvoid isp_print_bytes(ispsoftc_t *, const char *, int, void *); 62212795Sdim 63212795Sdim/* 64212795Sdim * Fibre Channel specific routines and data. 65212795Sdim */ 66239462Sdimextern const char *isp_class3_roles[4]; 67239462Sdimint isp_fc_runstate(ispsoftc_t *, int, int); 68239462Sdimvoid isp_dump_portdb(ispsoftc_t *, int); 69239462Sdimvoid isp_gen_role_str(char *, size_t, uint16_t); 70239462Sdim 71239462Sdimconst char *isp_fc_fw_statename(int); 72239462Sdimconst char *isp_fc_loop_statename(int); 73239462Sdimconst char *isp_fc_toponame(fcparam *); 74239462Sdim 75212795Sdimint isp_fc_change_role(ispsoftc_t *, int, int); 76212795Sdim 77212795Sdim 78212795Sdim/* 79212795Sdim * Cleanup 80212795Sdim */ 81239462Sdimvoid isp_clear_commands(ispsoftc_t *); 82239462Sdim 83239462Sdim/* 84239462Sdim * Common chip shutdown function 85239462Sdim */ 86239462Sdimvoid isp_shutdown(ispsoftc_t *); 87239462Sdim 88239462Sdim/* 89239462Sdim * Put/Get routines to push from CPU view to device view 90239462Sdim * or to pull from device view to CPU view for various 91239462Sdim * data structures (IOCB) 92239462Sdim */ 93239462Sdimvoid isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 94239462Sdimvoid isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 95239462Sdimint isp_get_response_type(ispsoftc_t *, isphdr_t *); 96239462Sdimvoid isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *); 97239462Sdimvoid isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *); 98234353Sdimvoid isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *); 99234353Sdimvoid isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *); 100239462Sdimvoid isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *); 101239462Sdimvoid isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *); 102239462Sdimvoid isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *); 103239462Sdimvoid isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *); 104239462Sdimvoid isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *); 105239462Sdimvoid isp_put_24xx_tmf(ispsoftc_t *, isp24xx_tmf_t *, isp24xx_tmf_t *); 106218893Sdimvoid isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 107234353Sdimvoid isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *); 108218893Sdimvoid isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *); 109234353Sdimvoid isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *); 110218893Sdimvoid isp_get_cont_response(ispsoftc_t *, ispstatus_cont_t *, ispstatus_cont_t *); 111234353Sdimvoid isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *, isp24xx_statusreq_t *); 112218893Sdimvoid isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 113218893Sdimvoid isp_get_rio1(ispsoftc_t *, isp_rio1_t *, isp_rio1_t *); 114218893Sdimvoid isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *); 115234353Sdimvoid isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *); 116218893Sdimvoid isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *); 117218893Sdimvoid isp_put_icb_2400_vpinfo(ispsoftc_t *, isp_icb_2400_vpinfo_t *, isp_icb_2400_vpinfo_t *); 118218893Sdimvoid isp_put_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 119234353Sdimvoid isp_get_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 120212795Sdimvoid isp_put_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 121212795Sdimvoid isp_get_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 122212795Sdimvoid isp_put_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 123212795Sdimvoid isp_get_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 124212795Sdimvoid isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *); 125212795Sdimvoid isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *); 126212795Sdimvoid isp_get_ridacq(ispsoftc_t *, isp_ridacq_t *, isp_ridacq_t *); 127212795Sdimvoid isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 128212795Sdimvoid isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 129212795Sdimvoid isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 130212795Sdimvoid isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 131212795Sdimvoid isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 132212795Sdimvoid isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 133212795Sdimvoid isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *); 134212795Sdimvoid isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *, sns_gid_ft_req_t *); 135212795Sdimvoid isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *, sns_gxn_id_req_t *); 136212795Sdimvoid isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int); 137212795Sdimvoid isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *, sns_gid_ft_rsp_t *, int); 138212795Sdimvoid isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *, sns_gxn_id_rsp_t *); 139212795Sdimvoid isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *, sns_gff_id_rsp_t *); 140212795Sdimvoid isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *, sns_ga_nxt_rsp_t *); 141212795Sdimvoid isp_get_els(ispsoftc_t *, els_t *, els_t *); 142212795Sdimvoid isp_put_els(ispsoftc_t *, els_t *, els_t *); 143212795Sdimvoid isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 144212795Sdimvoid isp_put_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 145249423Sdimvoid isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *); 146249423Sdimvoid isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *); 147212795Sdimvoid isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 148212795Sdimvoid isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 149212795Sdimvoid isp_put_fcp_rsp_iu(ispsoftc_t *isp, fcp_rsp_iu_t *, fcp_rsp_iu_t *); 150212795Sdim 151212795Sdim#define ISP_HANDLE_MASK 0x7fff 152249423Sdim 153249423Sdim#ifdef ISP_TARGET_MODE 154249423Sdim#if defined(__NetBSD__) || defined(__OpenBSD__) 155212795Sdim#include <dev/ic/isp_target.h> 156212795Sdim#elif defined(__FreeBSD__) 157249423Sdim#include <dev/isp/isp_target.h> 158249423Sdim#else 159249423Sdim#include "isp_target.h" 160249423Sdim#endif 161251662Sdim 162251662Sdimint isp_send_tgt_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, void *, uint32_t); 163249423Sdim 164212795Sdimint isp_allocate_xs_tgt(ispsoftc_t *, void *, uint32_t *); 165212795Sdimvoid *isp_find_xs_tgt(ispsoftc_t *, uint32_t); 166263508Sdimuint32_t isp_find_tgt_handle(ispsoftc_t *, void *); 167212795Sdimvoid isp_destroy_tgt_handle(ispsoftc_t *, uint32_t); 168263508Sdim 169263508Sdimint isp_find_pdb_by_wwn(ispsoftc_t *, int, uint64_t, fcportdb_t **); 170263508Sdimint isp_find_pdb_by_loopid(ispsoftc_t *, int, uint32_t, fcportdb_t **); 171263508Sdimint isp_find_pdb_by_sid(ispsoftc_t *, int, uint32_t, fcportdb_t **); 172263508Sdimvoid isp_find_chan_by_did(ispsoftc_t *, uint32_t, uint16_t *); 173263508Sdimvoid isp_add_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t, uint16_t); 174263508Sdimvoid isp_del_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); 175263508Sdimvoid isp_del_all_wwn_entries(ispsoftc_t *, int); 176263508Sdimvoid isp_del_wwn_entries(ispsoftc_t *, isp_notify_t *); 177263508Sdim 178263508Sdimvoid isp_put_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); 179263508Sdimvoid isp_get_atio(ispsoftc_t *, at_entry_t *, at_entry_t *); 180263508Sdimvoid isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 181263508Sdimvoid isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 182263508Sdimvoid isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 183263508Sdimvoid isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 184263508Sdimvoid isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *); 185263508Sdimvoid isp_put_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); 186263508Sdimvoid isp_get_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *); 187263508Sdimvoid isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 188263508Sdimvoid isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 189263508Sdimvoid isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 190263508Sdimvoid isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 191263508Sdimvoid isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 192263508Sdimvoid isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 193263508Sdimvoid isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 194263508Sdimvoid isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 195263508Sdimvoid isp_put_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); 196263508Sdimvoid isp_get_notify(ispsoftc_t *, in_entry_t *, in_entry_t *); 197263508Sdimvoid isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 198263508Sdimvoid isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 199263508Sdimvoid isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 200263508Sdimvoid isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 201263508Sdimvoid isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 202263508Sdimvoid isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 203263508Sdimvoid isp_put_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); 204263508Sdimvoid isp_get_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *); 205263508Sdimvoid isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 206263508Sdimvoid isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 207263508Sdimvoid isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 208263508Sdimvoid isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 209263508Sdimvoid isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 210263508Sdimvoid isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 211263508Sdimvoid isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 212263508Sdimvoid isp_get_abts(ispsoftc_t *, abts_t *, abts_t *); 213263508Sdimvoid isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 214263508Sdimvoid isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 215263508Sdim#endif /* ISP_TARGET_MODE */ 216263508Sdim#endif /* _ISP_LIBRARY_H */ 217263508Sdim