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