1155228Smjacob/* $FreeBSD: releng/10.3/sys/dev/isp/isp_library.h 292921 2015-12-30 11:49:48Z mav $ */ 2155228Smjacob/*- 3196008Smjacob * Copyright (c) 1997-2009 by Matthew Jacob 4167403Smjacob * All rights reserved. 5167403Smjacob * 6167403Smjacob * Redistribution and use in source and binary forms, with or without 7167403Smjacob * modification, are permitted provided that the following conditions 8167403Smjacob * are met: 9167403Smjacob * 10167403Smjacob * 1. Redistributions of source code must retain the above copyright 11167403Smjacob * notice, this list of conditions and the following disclaimer. 12167403Smjacob * 2. Redistributions in binary form must reproduce the above copyright 13167403Smjacob * notice, this list of conditions and the following disclaimer in the 14167403Smjacob * documentation and/or other materials provided with the distribution. 15167403Smjacob * 16167403Smjacob * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17167403Smjacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18167403Smjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19167403Smjacob * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20167403Smjacob * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21167403Smjacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22167403Smjacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23167403Smjacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24167403Smjacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25167403Smjacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26167403Smjacob * SUCH DAMAGE. 27196008Smjacob * 28155228Smjacob */ 29196008Smjacob#ifndef _ISP_LIBRARY_H 30196008Smjacob#define _ISP_LIBRARY_H 31155228Smjacob 32196008Smjacob/* 33196008Smjacob * Common command shipping routine. 34196008Smjacob * 35196008Smjacob * This used to be platform specific, but basically once you get the segment 36196008Smjacob * stuff figured out, you can make all the code in one spot. 37196008Smjacob */ 38196008Smjacobtypedef enum { ISP_TO_DEVICE, ISP_FROM_DEVICE, ISP_NOXFR} isp_ddir_t; 39238869Smjacobint isp_send_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, ispds64_t *); 40155228Smjacob 41196008Smjacob/* 42196008Smjacob * Handle management functions. 43196008Smjacob * 44196008Smjacob * These handles are associate with a command. 45196008Smjacob */ 46292921Smavuint32_t isp_allocate_handle(ispsoftc_t *, void *, int); 47292921Smavvoid *isp_find_xs(ispsoftc_t *, uint32_t); 48292921Smavuint32_t isp_find_handle(ispsoftc_t *, void *); 49196008Smjacobvoid isp_destroy_handle(ispsoftc_t *, uint32_t); 50168240Smjacob 51196008Smjacob/* 52196008Smjacob * Request Queue allocation 53196008Smjacob */ 54196008Smjacobvoid *isp_getrqentry(ispsoftc_t *); 55196008Smjacob 56196008Smjacob/* 57196008Smjacob * Queue Entry debug functions 58196008Smjacob */ 59196008Smjacobvoid isp_print_qentry (ispsoftc_t *, const char *, int, void *); 60196008Smjacobvoid isp_print_bytes(ispsoftc_t *, const char *, int, void *); 61196008Smjacob 62196008Smjacob/* 63196008Smjacob * Fibre Channel specific routines and data. 64196008Smjacob */ 65196008Smjacobextern const char *isp_class3_roles[4]; 66196008Smjacobint isp_fc_runstate(ispsoftc_t *, int, int); 67196008Smjacobvoid isp_dump_portdb(ispsoftc_t *, int); 68238869Smjacobvoid isp_gen_role_str(char *, size_t, uint16_t); 69196008Smjacob 70196008Smjacobconst char *isp_fc_fw_statename(int); 71196008Smjacobconst char *isp_fc_loop_statename(int); 72196008Smjacobconst char *isp_fc_toponame(fcparam *); 73196008Smjacob 74196008Smjacob/* 75196008Smjacob * Cleanup 76196008Smjacob */ 77196008Smjacobvoid isp_clear_commands(ispsoftc_t *); 78196008Smjacob 79196008Smjacob/* 80196008Smjacob * Common chip shutdown function 81196008Smjacob */ 82196008Smjacobvoid isp_shutdown(ispsoftc_t *); 83196008Smjacob 84196008Smjacob/* 85196008Smjacob * Put/Get routines to push from CPU view to device view 86196008Smjacob * or to pull from device view to CPU view for various 87196008Smjacob * data structures (IOCB) 88196008Smjacob */ 89196008Smjacobvoid isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 90196008Smjacobvoid isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *); 91196008Smjacobint isp_get_response_type(ispsoftc_t *, isphdr_t *); 92196008Smjacobvoid isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *); 93196008Smjacobvoid isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *); 94196008Smjacobvoid isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *); 95196008Smjacobvoid isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *); 96196008Smjacobvoid isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *); 97196008Smjacobvoid isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *); 98196008Smjacobvoid isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *); 99196008Smjacobvoid isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *); 100196008Smjacobvoid isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *); 101196008Smjacobvoid isp_put_24xx_tmf(ispsoftc_t *, isp24xx_tmf_t *, isp24xx_tmf_t *); 102196008Smjacobvoid isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 103196008Smjacobvoid isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *); 104196008Smjacobvoid isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *); 105196008Smjacobvoid isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *); 106238869Smjacobvoid isp_get_cont_response(ispsoftc_t *, ispstatus_cont_t *, ispstatus_cont_t *); 107196008Smjacobvoid isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *, isp24xx_statusreq_t *); 108196008Smjacobvoid isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *); 109204397Smjacobvoid isp_get_rio1(ispsoftc_t *, isp_rio1_t *, isp_rio1_t *); 110196008Smjacobvoid isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *); 111196008Smjacobvoid isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *); 112196008Smjacobvoid isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *); 113196008Smjacobvoid isp_put_icb_2400_vpinfo(ispsoftc_t *, isp_icb_2400_vpinfo_t *, isp_icb_2400_vpinfo_t *); 114196008Smjacobvoid isp_put_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 115196008Smjacobvoid isp_get_vp_port_info(ispsoftc_t *, vp_port_info_t *, vp_port_info_t *); 116196008Smjacobvoid isp_put_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 117196008Smjacobvoid isp_get_vp_ctrl_info(ispsoftc_t *, vp_ctrl_info_t *, vp_ctrl_info_t *); 118196008Smjacobvoid isp_put_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 119196008Smjacobvoid isp_get_vp_modify(ispsoftc_t *, vp_modify_t *, vp_modify_t *); 120196008Smjacobvoid isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *); 121196008Smjacobvoid isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *); 122291498Smavvoid isp_get_pnhle_21xx(ispsoftc_t *, isp_pnhle_21xx_t *, isp_pnhle_21xx_t *); 123291498Smavvoid isp_get_pnhle_23xx(ispsoftc_t *, isp_pnhle_23xx_t *, isp_pnhle_23xx_t *); 124291498Smavvoid isp_get_pnhle_24xx(ispsoftc_t *, isp_pnhle_24xx_t *, isp_pnhle_24xx_t *); 125291498Smavvoid isp_get_pnnle(ispsoftc_t *, isp_pnnle_t *, isp_pnnle_t *); 126196008Smjacobvoid isp_get_ridacq(ispsoftc_t *, isp_ridacq_t *, isp_ridacq_t *); 127196008Smjacobvoid isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 128196008Smjacobvoid isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *); 129196008Smjacobvoid isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 130196008Smjacobvoid isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 131196008Smjacobvoid isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *); 132196008Smjacobvoid isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *); 133196008Smjacobvoid isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *); 134196008Smjacobvoid isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *, sns_gid_ft_req_t *); 135196008Smjacobvoid isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *, sns_gxn_id_req_t *); 136196008Smjacobvoid isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int); 137196008Smjacobvoid isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *, sns_gid_ft_rsp_t *, int); 138196008Smjacobvoid isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *, sns_gxn_id_rsp_t *); 139196008Smjacobvoid isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *, sns_gff_id_rsp_t *); 140196008Smjacobvoid isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *, sns_ga_nxt_rsp_t *); 141196008Smjacobvoid isp_get_els(ispsoftc_t *, els_t *, els_t *); 142196008Smjacobvoid isp_put_els(ispsoftc_t *, els_t *, els_t *); 143196008Smjacobvoid isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 144238869Smjacobvoid isp_put_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *); 145196008Smjacobvoid isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *); 146196008Smjacobvoid isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *); 147291511Smavvoid isp_put_rff_id(ispsoftc_t *, rff_id_t *, rff_id_t *); 148196008Smjacobvoid isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 149196008Smjacobvoid isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *); 150238869Smjacobvoid isp_put_fcp_rsp_iu(ispsoftc_t *isp, fcp_rsp_iu_t *, fcp_rsp_iu_t *); 151196008Smjacob 152196008Smjacob#define ISP_HANDLE_MASK 0x7fff 153196008Smjacob 154196008Smjacob#ifdef ISP_TARGET_MODE 155196008Smjacob#if defined(__NetBSD__) || defined(__OpenBSD__) 156155704Smjacob#include <dev/ic/isp_target.h> 157196008Smjacob#elif defined(__FreeBSD__) 158155228Smjacob#include <dev/isp/isp_target.h> 159155704Smjacob#else 160155704Smjacob#include "isp_target.h" 161155704Smjacob#endif 162155228Smjacob 163196008Smjacobint isp_send_tgt_cmd(ispsoftc_t *, void *, void *, uint32_t, uint32_t, isp_ddir_t, void *, uint32_t); 164288714Smav#endif 165291514Smavint isp_find_pdb_empty(ispsoftc_t *, int, fcportdb_t **); 166291514Smavint isp_find_pdb_by_wwpn(ispsoftc_t *, int, uint64_t, fcportdb_t **); 167291514Smavint isp_find_pdb_by_handle(ispsoftc_t *, int, uint16_t, fcportdb_t **); 168291514Smavint isp_find_pdb_by_portid(ispsoftc_t *, int, uint32_t, fcportdb_t **); 169288714Smav#ifdef ISP_TARGET_MODE 170196008Smjacobvoid isp_find_chan_by_did(ispsoftc_t *, uint32_t, uint16_t *); 171290787Smavvoid isp_add_wwn_entry(ispsoftc_t *, int, uint64_t, uint64_t, uint16_t, uint32_t, uint16_t); 172196008Smjacobvoid isp_del_wwn_entry(ispsoftc_t *, int, uint64_t, uint16_t, uint32_t); 173196008Smjacobvoid isp_del_all_wwn_entries(ispsoftc_t *, int); 174196008Smjacobvoid isp_del_wwn_entries(ispsoftc_t *, isp_notify_t *); 175196008Smjacob 176196008Smjacobvoid isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 177196008Smjacobvoid isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 178196008Smjacobvoid isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *); 179196008Smjacobvoid isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *); 180196008Smjacobvoid isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *); 181196008Smjacobvoid isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 182196008Smjacobvoid isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 183196008Smjacobvoid isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 184196008Smjacobvoid isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *); 185196008Smjacobvoid isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *); 186196008Smjacobvoid isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *); 187196008Smjacobvoid isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 188196008Smjacobvoid isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *); 189196008Smjacobvoid isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 190196008Smjacobvoid isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 191196008Smjacobvoid isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 192196008Smjacobvoid isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *); 193196008Smjacobvoid isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *); 194196008Smjacobvoid isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *); 195196008Smjacobvoid isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 196196008Smjacobvoid isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 197196008Smjacobvoid isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 198196008Smjacobvoid isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 199196008Smjacobvoid isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *); 200196008Smjacobvoid isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *); 201196008Smjacobvoid isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *); 202196008Smjacobvoid isp_get_abts(ispsoftc_t *, abts_t *, abts_t *); 203196008Smjacobvoid isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 204196008Smjacobvoid isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *); 205196008Smjacob#endif /* ISP_TARGET_MODE */ 206196008Smjacob#endif /* _ISP_LIBRARY_H */ 207