1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2004-07 Applied Micro Circuits Corporation. 5 * Copyright (c) 2004-05 Vinod Kashyap 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, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 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 21 * FOR 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 /* 31 * AMCC'S 3ware driver for 9000 series storage controllers. 32 * 33 * Author: Vinod Kashyap 34 * Modifications by: Adam Radford 35 */ 36 37 #ifndef TW_CL_EXTERNS_H 38 39 #define TW_CL_EXTERNS_H 40 41 /* 42 * Data structures and functions global to the Common Layer. 43 */ 44 45 extern TW_INT8 tw_cli_fw_img[]; 46 extern TW_INT32 tw_cli_fw_img_size; 47 extern TW_INT8 *tw_cli_severity_string_table[]; 48 49 /* Do controller initialization. */ 50 extern TW_INT32 tw_cli_start_ctlr(struct tw_cli_ctlr_context *ctlr); 51 52 /* Establish a logical connection with the firmware on the controller. */ 53 extern TW_INT32 tw_cli_init_connection(struct tw_cli_ctlr_context *ctlr, 54 TW_UINT16 message_credits, TW_UINT32 set_features, 55 TW_UINT16 current_fw_srl, TW_UINT16 current_fw_arch_id, 56 TW_UINT16 current_fw_branch, TW_UINT16 current_fw_build, 57 TW_UINT16 *fw_on_ctlr_srl, TW_UINT16 *fw_on_ctlr_arch_id, 58 TW_UINT16 *fw_on_ctlr_branch, TW_UINT16 *fw_on_ctlr_build, 59 TW_UINT32 *init_connect_result); 60 61 /* Functions in tw_cl_io.c */ 62 63 /* Submit a command packet to the firmware on the controller. */ 64 extern TW_INT32 tw_cli_submit_cmd(struct tw_cli_req_context *req); 65 66 /* Get a firmware parameter. */ 67 extern TW_INT32 tw_cli_get_param(struct tw_cli_ctlr_context *ctlr, 68 TW_INT32 table_id, TW_INT32 parameter_id, TW_VOID *param_data, 69 TW_INT32 size, TW_VOID (* callback)(struct tw_cli_req_context *req)); 70 71 /* Set a firmware parameter. */ 72 extern TW_INT32 tw_cli_set_param(struct tw_cli_ctlr_context *ctlr, 73 TW_INT32 table_id, TW_INT32 param_id, TW_INT32 param_size, 74 TW_VOID *data, TW_VOID (* callback)(struct tw_cli_req_context *req)); 75 76 /* Submit a command to the firmware and poll for completion. */ 77 extern TW_INT32 tw_cli_submit_and_poll_request(struct tw_cli_req_context *req, 78 TW_UINT32 timeout); 79 80 /* Soft reset the controller. */ 81 extern TW_INT32 tw_cli_soft_reset(struct tw_cli_ctlr_context *ctlr); 82 extern int twa_setup_intr(struct twa_softc *sc); 83 extern int twa_teardown_intr(struct twa_softc *sc); 84 85 /* Send down a SCSI command to the firmware (usually, an internal Req Sense. */ 86 extern TW_INT32 tw_cli_send_scsi_cmd(struct tw_cli_req_context *req, 87 TW_INT32 cmd); 88 89 /* Get an AEN from the firmware (by sending down a Req Sense). */ 90 extern TW_INT32 tw_cli_get_aen(struct tw_cli_ctlr_context *ctlr); 91 92 /* Fill in the scatter/gather list. */ 93 extern TW_VOID tw_cli_fill_sg_list(struct tw_cli_ctlr_context *ctlr, 94 TW_VOID *sgl_src, TW_VOID *sgl_dest, TW_INT32 num_sgl_entries); 95 96 /* Functions in tw_cl_intr.c */ 97 98 /* Process a host interrupt. */ 99 extern TW_VOID tw_cli_process_host_intr(struct tw_cli_ctlr_context *ctlr); 100 101 /* Process an attention interrupt. */ 102 extern TW_VOID tw_cli_process_attn_intr(struct tw_cli_ctlr_context *ctlr); 103 104 /* Process a command interrupt. */ 105 extern TW_VOID tw_cli_process_cmd_intr(struct tw_cli_ctlr_context *ctlr); 106 107 /* Process a response interrupt from the controller. */ 108 extern TW_INT32 tw_cli_process_resp_intr(struct tw_cli_ctlr_context *ctlr); 109 110 /* Submit any requests in the pending queue to the firmware. */ 111 extern TW_INT32 tw_cli_submit_pending_queue(struct tw_cli_ctlr_context *ctlr); 112 113 /* Process all requests in the complete queue. */ 114 extern TW_VOID tw_cli_process_complete_queue(struct tw_cli_ctlr_context *ctlr); 115 116 /* CL internal callback for SCSI/fw passthru requests. */ 117 extern TW_VOID tw_cli_complete_io(struct tw_cli_req_context *req); 118 119 /* Completion routine for SCSI requests. */ 120 extern TW_VOID tw_cli_scsi_complete(struct tw_cli_req_context *req); 121 122 /* Callback for get/set param requests. */ 123 extern TW_VOID tw_cli_param_callback(struct tw_cli_req_context *req); 124 125 /* Callback for Req Sense commands to get AEN's. */ 126 extern TW_VOID tw_cli_aen_callback(struct tw_cli_req_context *req); 127 128 /* Decide what to do with a retrieved AEN. */ 129 extern TW_UINT16 tw_cli_manage_aen(struct tw_cli_ctlr_context *ctlr, 130 struct tw_cli_req_context *req); 131 132 /* Enable controller interrupts. */ 133 extern TW_VOID 134 tw_cli_enable_interrupts(struct tw_cli_ctlr_context *ctlr_handle); 135 136 /* Disable controller interrupts. */ 137 extern TW_VOID 138 tw_cli_disable_interrupts(struct tw_cli_ctlr_context *ctlr_handle); 139 140 /* Functions in tw_cl_misc.c */ 141 142 /* Print if dbg_level is appropriate (by calling OS Layer). */ 143 extern TW_VOID tw_cli_dbg_printf(TW_UINT8 dbg_level, 144 struct tw_cl_ctlr_handle *ctlr_handle, const TW_INT8 *cur_func, 145 TW_INT8 *fmt, ...); 146 147 /* Describe meaning of each set bit in the given register. */ 148 extern TW_INT8 *tw_cli_describe_bits(TW_UINT32 reg, TW_INT8 *str); 149 150 /* Complete all requests in the complete queue with a RESET status. */ 151 extern TW_VOID tw_cli_drain_complete_queue(struct tw_cli_ctlr_context *ctlr); 152 153 /* Complete all requests in the busy queue with a RESET status. */ 154 extern TW_VOID tw_cli_drain_busy_queue(struct tw_cli_ctlr_context *ctlr); 155 156 /* Complete all requests in the pending queue with a RESET status. */ 157 extern TW_VOID tw_cli_drain_pending_queue(struct tw_cli_ctlr_context *ctlr); 158 159 /* Drain the controller response queue. */ 160 extern TW_INT32 tw_cli_drain_response_queue(struct tw_cli_ctlr_context *ctlr); 161 162 /* Find a particular response in the controller response queue. */ 163 extern TW_INT32 tw_cli_find_response(struct tw_cli_ctlr_context *ctlr, 164 TW_INT32 req_id); 165 166 /* Drain the controller AEN queue. */ 167 extern TW_INT32 tw_cli_drain_aen_queue(struct tw_cli_ctlr_context *ctlr); 168 169 /* Determine if a given AEN has been posted by the firmware. */ 170 extern TW_INT32 tw_cli_find_aen(struct tw_cli_ctlr_context *ctlr, 171 TW_UINT16 aen_code); 172 173 /* Poll for a given status to show up in the firmware status register. */ 174 extern TW_INT32 tw_cli_poll_status(struct tw_cli_ctlr_context *ctlr, 175 TW_UINT32 status, TW_UINT32 timeout); 176 177 /* Get a free CL internal request context packet. */ 178 extern struct tw_cli_req_context * 179 tw_cli_get_request(struct tw_cli_ctlr_context *ctlr 180 ); 181 182 /* Notify OSL of controller info (fw/BIOS versions, etc.). */ 183 extern TW_VOID tw_cli_notify_ctlr_info(struct tw_cli_ctlr_context *ctlr); 184 185 /* Make sure that the firmware status register reports a proper status. */ 186 extern TW_INT32 tw_cli_check_ctlr_state(struct tw_cli_ctlr_context *ctlr, 187 TW_UINT32 status_reg); 188 189 #endif /* TW_CL_EXTERNS_H */ 190