isp_library.h revision 164370 
1/* $FreeBSD: head/sys/dev/isp/isp_library.h 164370 2006-11-18 03:53:16Z mjacob $ */
2/*-
3 * Qlogic Host Adapter Library Functions
4 *
5 * Copyright (c) 1999-2006 by Matthew Jacob
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice immediately at the beginning of the file, without modification,
13 *    this list of conditions, and the following disclaimer.
14 * 2. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 */
30#ifndef	_ISP_LIBRARY_H
31#define	_ISP_LIBRARY_H
32
33extern int isp_save_xs(ispsoftc_t *, XS_T *, uint32_t *);
34extern XS_T *isp_find_xs(ispsoftc_t *, uint32_t);
35extern uint32_t isp_find_handle(ispsoftc_t *, XS_T *);
36extern uint32_t isp_handle_index(uint32_t);
37extern void isp_destroy_handle(ispsoftc_t *, uint32_t);
38extern int isp_getrqentry(ispsoftc_t *, uint32_t *, uint32_t *, void **);
39extern void isp_print_qentry (ispsoftc_t *, char *, int, void *);
40extern void isp_print_bytes(ispsoftc_t *, char *, int, void *);
41extern int isp_fc_runstate(ispsoftc_t *, int);
42extern void isp_dump_portdb(ispsoftc_t *);
43extern void isp_shutdown(ispsoftc_t *);
44extern void isp_put_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *);
45extern void isp_get_hdr(ispsoftc_t *, isphdr_t *, isphdr_t *);
46extern int isp_get_response_type(ispsoftc_t *, isphdr_t *);
47extern void
48isp_put_request(ispsoftc_t *, ispreq_t *, ispreq_t *);
49extern void
50isp_put_marker(ispsoftc_t *, isp_marker_t *, isp_marker_t *);
51extern void
52isp_put_marker_24xx(ispsoftc_t *, isp_marker_24xx_t *, isp_marker_24xx_t *);
53extern void
54isp_put_request_t2(ispsoftc_t *, ispreqt2_t *, ispreqt2_t *);
55extern void
56isp_put_request_t2e(ispsoftc_t *, ispreqt2e_t *, ispreqt2e_t *);
57extern void
58isp_put_request_t3(ispsoftc_t *, ispreqt3_t *, ispreqt3_t *);
59extern void
60isp_put_request_t3e(ispsoftc_t *, ispreqt3e_t *, ispreqt3e_t *);
61extern void
62isp_put_extended_request(ispsoftc_t *, ispextreq_t *, ispextreq_t *);
63extern void
64isp_put_request_t7(ispsoftc_t *, ispreqt7_t *, ispreqt7_t *);
65extern void
66isp_put_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *);
67extern void
68isp_put_cont_req(ispsoftc_t *, ispcontreq_t *, ispcontreq_t *);
69extern void
70isp_put_cont64_req(ispsoftc_t *, ispcontreq64_t *, ispcontreq64_t *);
71extern void
72isp_get_response(ispsoftc_t *, ispstatusreq_t *, ispstatusreq_t *);
73extern void isp_get_24xx_response(ispsoftc_t *, isp24xx_statusreq_t *,
74    isp24xx_statusreq_t *);
75void
76isp_get_24xx_abrt(ispsoftc_t *, isp24xx_abrt_t *, isp24xx_abrt_t *);
77extern void
78isp_get_rio2(ispsoftc_t *, isp_rio2_t *, isp_rio2_t *);
79extern void
80isp_put_icb(ispsoftc_t *, isp_icb_t *, isp_icb_t *);
81extern void
82isp_put_icb_2400(ispsoftc_t *, isp_icb_2400_t *, isp_icb_2400_t *);
83extern void
84isp_get_pdb_21xx(ispsoftc_t *, isp_pdb_21xx_t *, isp_pdb_21xx_t *);
85extern void
86isp_get_pdb_24xx(ispsoftc_t *, isp_pdb_24xx_t *, isp_pdb_24xx_t *);
87extern void
88isp_get_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *);
89extern void
90isp_put_plogx(ispsoftc_t *, isp_plogx_t *, isp_plogx_t *);
91extern void
92isp_get_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *);
93extern void
94isp_get_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *);
95extern void
96isp_put_ct_pt(ispsoftc_t *isp, isp_ct_pt_t *, isp_ct_pt_t *);
97extern void
98isp_put_ms(ispsoftc_t *isp, isp_ms_t *, isp_ms_t *);
99extern void
100isp_put_sns_request(ispsoftc_t *, sns_screq_t *, sns_screq_t *);
101extern void
102isp_put_gid_ft_request(ispsoftc_t *, sns_gid_ft_req_t *,
103    sns_gid_ft_req_t *);
104extern void
105isp_put_gxn_id_request(ispsoftc_t *, sns_gxn_id_req_t *,
106    sns_gxn_id_req_t *);
107extern void
108isp_get_sns_response(ispsoftc_t *, sns_scrsp_t *, sns_scrsp_t *, int);
109extern void
110isp_get_gid_ft_response(ispsoftc_t *, sns_gid_ft_rsp_t *,
111    sns_gid_ft_rsp_t *, int);
112extern void
113isp_get_gxn_id_response(ispsoftc_t *, sns_gxn_id_rsp_t *,
114    sns_gxn_id_rsp_t *);
115extern void
116isp_get_gff_id_response(ispsoftc_t *, sns_gff_id_rsp_t *,
117    sns_gff_id_rsp_t *);
118extern void
119isp_get_ga_nxt_response(ispsoftc_t *, sns_ga_nxt_rsp_t *,
120    sns_ga_nxt_rsp_t *);
121extern void
122isp_get_els(ispsoftc_t *, els_t *, els_t *);
123extern void
124isp_put_els(ispsoftc_t *, els_t *, els_t *);
125extern void
126isp_get_fc_hdr(ispsoftc_t *, fc_hdr_t *, fc_hdr_t *);
127extern void
128isp_get_fcp_cmnd_iu(ispsoftc_t *, fcp_cmnd_iu_t *, fcp_cmnd_iu_t *);
129extern void isp_put_rft_id(ispsoftc_t *, rft_id_t *, rft_id_t *);
130extern void isp_get_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *);
131extern void isp_put_ct_hdr(ispsoftc_t *isp, ct_hdr_t *, ct_hdr_t *);
132
133#ifdef	ISP_TARGET_MODE
134#if	defined(__NetBSD__) || defined(__OpenBSD__)
135#include <dev/ic/isp_target.h>
136#elif 	defined(__FreeBSD__)
137#include <dev/isp/isp_target.h>
138#else
139#include "isp_target.h"
140#endif
141
142#define	IS_TARGET_HANDLE(x)     ((x) & 0x8000)
143
144extern int isp_save_xs_tgt(ispsoftc_t *, void *, uint32_t *);
145extern void *isp_find_xs_tgt(ispsoftc_t *, uint32_t);
146extern uint32_t isp_find_tgt_handle(ispsoftc_t *, void *);
147extern void isp_destroy_tgt_handle(ispsoftc_t *, uint32_t);
148
149extern void
150isp_put_atio(ispsoftc_t *, at_entry_t *, at_entry_t *);
151extern void
152isp_get_atio(ispsoftc_t *, at_entry_t *, at_entry_t *);
153extern void
154isp_put_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *);
155extern void
156isp_put_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *);
157extern void
158isp_get_atio2(ispsoftc_t *, at2_entry_t *, at2_entry_t *);
159extern void
160isp_get_atio2e(ispsoftc_t *, at2e_entry_t *, at2e_entry_t *);
161extern void
162isp_get_atio7(ispsoftc_t *isp, at7_entry_t *, at7_entry_t *);
163extern void
164isp_put_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *);
165extern void
166isp_get_ctio(ispsoftc_t *, ct_entry_t *, ct_entry_t *);
167extern void
168isp_put_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *);
169extern void
170isp_put_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *);
171extern void
172isp_put_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *);
173extern void
174isp_get_ctio2(ispsoftc_t *, ct2_entry_t *, ct2_entry_t *);
175extern void
176isp_get_ctio2e(ispsoftc_t *, ct2e_entry_t *, ct2e_entry_t *);
177extern void
178isp_get_ctio7(ispsoftc_t *, ct7_entry_t *, ct7_entry_t *);
179extern void
180isp_put_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *);
181extern void
182isp_get_enable_lun(ispsoftc_t *, lun_entry_t *, lun_entry_t *);
183extern void
184isp_put_notify(ispsoftc_t *, in_entry_t *, in_entry_t *);
185extern void
186isp_get_notify(ispsoftc_t *, in_entry_t *, in_entry_t *);
187extern void
188isp_put_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *);
189extern void
190isp_put_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *);
191extern void
192isp_put_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *);
193extern void
194isp_get_notify_fc(ispsoftc_t *, in_fcentry_t *, in_fcentry_t *);
195extern void
196isp_get_notify_fc_e(ispsoftc_t *, in_fcentry_e_t *, in_fcentry_e_t *);
197extern void
198isp_get_notify_24xx(ispsoftc_t *, in_fcentry_24xx_t *, in_fcentry_24xx_t *);
199extern void
200isp_put_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *);
201extern void
202isp_get_notify_ack(ispsoftc_t *, na_entry_t *, na_entry_t *);
203extern void
204isp_put_notify_24xx_ack(ispsoftc_t *, na_fcentry_24xx_t *, na_fcentry_24xx_t *);
205extern void
206isp_put_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *);
207extern void
208isp_put_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *);
209extern void isp_put_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *,
210    na_fcentry_24xx_t *);
211extern void
212isp_get_notify_ack_fc(ispsoftc_t *, na_fcentry_t *, na_fcentry_t *);
213extern void
214isp_get_notify_ack_fc_e(ispsoftc_t *, na_fcentry_e_t *, na_fcentry_e_t *);
215extern void isp_get_notify_ack_24xx(ispsoftc_t *, na_fcentry_24xx_t *,
216    na_fcentry_24xx_t *);
217extern void
218isp_get_abts(ispsoftc_t *, abts_t *, abts_t *);
219extern void
220isp_put_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *);
221extern void
222isp_get_abts_rsp(ispsoftc_t *, abts_rsp_t *, abts_rsp_t *);
223#endif	/* ISP_TARGET_MODE */
224#endif	/* _ISP_LIBRARY_H */
225