tw_cl_externs.h revision 169400 
1/*
2 * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
3 * Copyright (c) 2004-05 Vinod Kashyap
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 *	$FreeBSD: head/sys/dev/twa/tw_cl_externs.h 169400 2007-05-09 04:16:32Z scottl $
28 */
29
30/*
31 * AMCC'S 3ware driver for 9000 series storage controllers.
32 *
33 * Author: Vinod Kashyap
34 * Modifications by: Adam Radford
35 */
36
37
38
39#ifndef TW_CL_EXTERNS_H
40
41#define TW_CL_EXTERNS_H
42
43
44/*
45 * Data structures and functions global to the Common Layer.
46 */
47
48
49extern TW_INT8			tw_cli_fw_img[];
50extern TW_INT32			tw_cli_fw_img_size;
51extern TW_INT8			*tw_cli_severity_string_table[];
52
53
54/* Do controller initialization. */
55extern TW_INT32	tw_cli_start_ctlr(struct tw_cli_ctlr_context *ctlr);
56
57/* Establish a logical connection with the firmware on the controller. */
58extern TW_INT32	tw_cli_init_connection(struct tw_cli_ctlr_context *ctlr,
59	TW_UINT16 message_credits, TW_UINT32 set_features,
60	TW_UINT16 current_fw_srl, TW_UINT16 current_fw_arch_id,
61	TW_UINT16 current_fw_branch, TW_UINT16 current_fw_build,
62	TW_UINT16 *fw_on_ctlr_srl, TW_UINT16 *fw_on_ctlr_arch_id,
63	TW_UINT16 *fw_on_ctlr_branch, TW_UINT16 *fw_on_ctlr_build,
64	TW_UINT32 *init_connect_result);
65
66
67
68/* Functions in tw_cl_io.c */
69
70/* Submit a command packet to the firmware on the controller. */
71extern TW_INT32	tw_cli_submit_cmd(struct tw_cli_req_context *req);
72
73/* Get a firmware parameter. */
74extern TW_INT32	tw_cli_get_param(struct tw_cli_ctlr_context *ctlr,
75	TW_INT32 table_id, TW_INT32 parameter_id, TW_VOID *param_data,
76	TW_INT32 size, TW_VOID (* callback)(struct tw_cli_req_context *req));
77
78/* Set a firmware parameter. */
79extern TW_INT32	tw_cli_set_param(struct tw_cli_ctlr_context *ctlr,
80	TW_INT32 table_id, TW_INT32 param_id, TW_INT32 param_size,
81	TW_VOID *data, TW_VOID (* callback)(struct tw_cli_req_context *req));
82
83/* Submit a command to the firmware and poll for completion. */
84extern TW_INT32	tw_cli_submit_and_poll_request(struct tw_cli_req_context *req,
85	TW_UINT32 timeout);
86
87/* Soft reset the controller. */
88extern TW_INT32	tw_cli_soft_reset(struct tw_cli_ctlr_context *ctlr);
89
90/* Send down a SCSI command to the firmware (usually, an internal Req Sense. */
91extern TW_INT32	tw_cli_send_scsi_cmd(struct tw_cli_req_context *req,
92	TW_INT32 cmd);
93
94/* Get an AEN from the firmware (by sending down a Req Sense). */
95extern TW_INT32	tw_cli_get_aen(struct tw_cli_ctlr_context *ctlr);
96
97/* Fill in the scatter/gather list. */
98extern TW_VOID tw_cli_fill_sg_list(struct tw_cli_ctlr_context *ctlr,
99	TW_VOID *sgl_src, TW_VOID *sgl_dest, TW_INT32 num_sgl_entries);
100
101
102
103/* Functions in tw_cl_intr.c */
104
105/* Process a host interrupt. */
106extern TW_VOID	tw_cli_process_host_intr(struct tw_cli_ctlr_context *ctlr);
107
108/* Process an attention interrupt. */
109extern TW_VOID	tw_cli_process_attn_intr(struct tw_cli_ctlr_context *ctlr);
110
111/* Process a command interrupt. */
112extern TW_VOID	tw_cli_process_cmd_intr(struct tw_cli_ctlr_context *ctlr);
113
114/* Process a response interrupt from the controller. */
115extern TW_INT32	tw_cli_process_resp_intr(struct tw_cli_ctlr_context *ctlr);
116
117/* Submit any requests in the pending queue to the firmware. */
118extern TW_INT32	tw_cli_submit_pending_queue(struct tw_cli_ctlr_context *ctlr);
119
120/* Process all requests in the complete queue. */
121extern TW_VOID	tw_cli_process_complete_queue(struct tw_cli_ctlr_context *ctlr);
122
123/* CL internal callback for SCSI/fw passthru requests. */
124extern TW_VOID	tw_cli_complete_io(struct tw_cli_req_context *req);
125
126/* Completion routine for SCSI requests. */
127extern TW_VOID	tw_cli_scsi_complete(struct tw_cli_req_context *req);
128
129/* Callback for get/set param requests. */
130extern TW_VOID	tw_cli_param_callback(struct tw_cli_req_context *req);
131
132/* Callback for Req Sense commands to get AEN's. */
133extern TW_VOID	tw_cli_aen_callback(struct tw_cli_req_context *req);
134
135/* Decide what to do with a retrieved AEN. */
136extern TW_UINT16	tw_cli_manage_aen(struct tw_cli_ctlr_context *ctlr,
137	struct tw_cli_req_context *req);
138
139/* Enable controller interrupts. */
140extern TW_VOID
141	tw_cli_enable_interrupts(struct tw_cli_ctlr_context *ctlr_handle);
142
143/* Disable controller interrupts. */
144extern TW_VOID
145	tw_cli_disable_interrupts(struct tw_cli_ctlr_context *ctlr_handle);
146
147
148
149/* Functions in tw_cl_misc.c */
150
151/* Print if dbg_level is appropriate (by calling OS Layer). */
152extern TW_VOID	tw_cli_dbg_printf(TW_UINT8 dbg_level,
153	struct tw_cl_ctlr_handle *ctlr_handle, const TW_INT8 *cur_func,
154	TW_INT8 *fmt, ...);
155
156/* Describe meaning of each set bit in the given register. */
157extern TW_INT8	*tw_cli_describe_bits(TW_UINT32 reg, TW_INT8 *str);
158
159/* Complete all requests in the complete queue with a RESET status. */
160extern TW_VOID	tw_cli_drain_complete_queue(struct tw_cli_ctlr_context *ctlr);
161
162/* Complete all requests in the busy queue with a RESET status. */
163extern TW_VOID	tw_cli_drain_busy_queue(struct tw_cli_ctlr_context *ctlr);
164
165/* Complete all requests in the pending queue with a RESET status. */
166extern TW_VOID	tw_cli_drain_pending_queue(struct tw_cli_ctlr_context *ctlr);
167
168/* Drain the controller response queue. */
169extern TW_INT32	tw_cli_drain_response_queue(struct tw_cli_ctlr_context *ctlr);
170
171/* Find a particular response in the controller response queue. */
172extern TW_INT32	tw_cli_find_response(struct tw_cli_ctlr_context *ctlr,
173	TW_INT32 req_id);
174
175/* Drain the controller AEN queue. */
176extern TW_INT32	tw_cli_drain_aen_queue(struct tw_cli_ctlr_context *ctlr);
177
178/* Determine if a given AEN has been posted by the firmware. */
179extern TW_INT32	tw_cli_find_aen(struct tw_cli_ctlr_context *ctlr,
180	TW_UINT16 aen_code);
181
182/* Poll for a given status to show up in the firmware status register. */
183extern TW_INT32	tw_cli_poll_status(struct tw_cli_ctlr_context *ctlr,
184	TW_UINT32 status, TW_UINT32 timeout);
185
186/* Get a free CL internal request context packet. */
187extern struct tw_cli_req_context *
188	tw_cli_get_request(struct tw_cli_ctlr_context *ctlr
189	);
190
191/* Notify OSL of controller info (fw/BIOS versions, etc.). */
192extern TW_VOID	tw_cli_notify_ctlr_info(struct tw_cli_ctlr_context *ctlr);
193
194/* Make sure that the firmware status register reports a proper status. */
195extern TW_INT32	tw_cli_check_ctlr_state(struct tw_cli_ctlr_context *ctlr,
196	TW_UINT32 status_reg);
197
198
199
200#endif /* TW_CL_EXTERNS_H */
201