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