1 /* $NetBSD: twavar.h,v 1.3 2006/05/25 01:37:08 wrstuden Exp $ */ 2 /* $wasabi: twavar.h,v 1.12 2006/05/01 15:16:59 simonb Exp $ */ 3 /* 4 * Copyright (c) 2005-2006 Wasabi Systems, Inc. 5 * All rights reserved. 6 * 7 * Your Wasabi Systems License Agreement specifies the terms and 8 * conditions for use and redistribution. 9 */ 10 11 /*- 12 * Copyright (c) 2003-04 3ware, Inc. 13 * Copyright (c) 2000 Michael Smith 14 * Copyright (c) 2000 BSDi 15 * All rights reserved. 16 * 17 * Redistribution and use in source and binary forms, with or without 18 * modification, are permitted provided that the following conditions 19 * are met: 20 * 1. Redistributions of source code must retain the above copyright 21 * notice, this list of conditions and the following disclaimer. 22 * 2. Redistributions in binary form must reproduce the above copyright 23 * notice, this list of conditions and the following disclaimer in the 24 * documentation and/or other materials provided with the distribution. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * $FreeBSD: src/sys/dev/twa/twa.h,v 1.4 2004/06/16 09:47:00 phk Exp $ 39 */ 40 41 /* 42 * 3ware driver for 9000 series storage controllers. 43 * 44 * Author: Vinod Kashyap 45 */ 46 #ifndef _PCI_TWAVAR_H_ 47 #define _PCI_TWAVAR_H_ 48 49 #include "locators.h" 50 51 struct twa_callbacks { 52 void (*tcb_openings)(struct device *, int); 53 }; 54 55 struct twa_drive { 56 uint32_t td_id; 57 uint64_t td_size; 58 struct device *td_dev; 59 const struct twa_callbacks *td_callbacks; 60 }; 61 62 /* Per-controller structure. */ 63 struct twa_softc { 64 struct device twa_dv; 65 bus_space_tag_t twa_bus_iot; /* bus space tag */ 66 bus_space_handle_t twa_bus_ioh; /* bus space handle */ 67 bus_dma_tag_t twa_dma_tag; /* data buffer DMA tag */ 68 bus_dmamap_t twa_cmd_map; /* DMA map for the array of cmd pkts */ 69 void *twa_ih; /* interrupt handle cookie */ 70 caddr_t twa_cmds; 71 bus_addr_t twa_cmd_pkt_phys;/* phys addr of first of array of cmd pkts */ 72 73 pci_chipset_tag_t pc; 74 pcitag_t tag; 75 /* Request queues and arrays. */ 76 TAILQ_HEAD(, twa_request) twa_free; /* free request packets */ 77 TAILQ_HEAD(, twa_request) twa_busy; /* requests busy in the controller */ 78 TAILQ_HEAD(, twa_request) twa_pending; /* internal requests pending */ 79 80 struct twa_request *twa_lookup[TWA_Q_LENGTH];/* requests indexed by request_id */ 81 82 struct twa_request *twa_req_buf; 83 struct twa_command_packet *twa_cmd_pkt_buf; 84 85 struct twa_drive sc_units[TWA_MAX_UNITS]; 86 /* AEN handler fields. */ 87 struct tw_cl_event_packet *twa_aen_queue[TWA_Q_LENGTH];/* circular queue of AENs from firmware */ 88 uint16_t working_srl; /* driver & firmware negotiated srl */ 89 uint16_t working_branch; /* branch # of the firmware that the driver is compatible with */ 90 uint16_t working_build; /* build # of the firmware that the driver is compatible with */ 91 u_int32_t twa_operating_mode; /* base mode/current mode */ 92 u_int32_t twa_aen_head; /* AEN queue head */ 93 u_int32_t twa_aen_tail; /* AEN queue tail */ 94 u_int32_t twa_current_sequence_id;/* index of the last event + 1 */ 95 u_int32_t twa_aen_queue_overflow; /* indicates if unretrieved events were overwritten */ 96 u_int32_t twa_aen_queue_wrapped; /* indicates if AEN queue ever wrapped */ 97 /* Controller state. */ 98 u_int32_t twa_state; 99 u_int32_t twa_sc_flags; 100 #ifdef TWA_DEBUG 101 struct twa_q_statistics twa_qstats[TWAQ_COUNT]; /* queue statistics */ 102 #endif /* TWA_DEBUG */ 103 104 struct _twa_ioctl_lock{ 105 u_int32_t lock; /* lock state */ 106 u_int32_t timeout; /* time at which the lock 107 * will become available, 108 * even if not released 109 */ 110 } twa_ioctl_lock; /* lock for use by user 111 * applications, 112 * for synchronization between 113 * ioctl calls 114 */ 115 int sc_openings; 116 int sc_nunits; 117 118 struct twa_request *sc_twa_request; 119 }; 120 121 122 123 /* Possible values of tr->tr_status. */ 124 #define TWA_CMD_SETUP 0x0 /* being assembled */ 125 #define TWA_CMD_BUSY 0x1 /* submitted to controller */ 126 #define TWA_CMD_PENDING 0x2 /* in pending queue */ 127 #define TWA_CMD_COMPLETE 0x3 /* completed by controller */ 128 129 /* Possible values of tr->tr_flags. */ 130 #define TWA_CMD_DATA_IN (1 << 0) 131 #define TWA_CMD_DATA_OUT (1 << 1) 132 #define TWA_CMD_DATA_COPY_NEEDED (1 << 2) 133 #define TWA_CMD_SLEEP_ON_REQUEST (1 << 3) 134 #define TWA_CMD_IN_PROGRESS (1 << 4) 135 #define TWA_CMD_AEN (1 << 5) 136 #define TWA_CMD_AEN_BUSY (1 << 6) 137 138 /* Possible values of tr->tr_cmd_pkt_type. */ 139 #define TWA_CMD_PKT_TYPE_7K (1<<0) 140 #define TWA_CMD_PKT_TYPE_9K (1<<1) 141 #define TWA_CMD_PKT_TYPE_INTERNAL (1<<2) 142 #define TWA_CMD_PKT_TYPE_IOCTL (1<<3) 143 #define TWA_CMD_PKT_TYPE_EXTERNAL (1<<4) 144 145 /* Possible values of sc->twa_state. */ 146 #define TWA_STATE_INTR_ENABLED (1<<0) /* interrupts have been enabled */ 147 #define TWA_STATE_SHUTDOWN (1<<1) /* controller is shut down */ 148 #define TWA_STATE_OPEN (1<<2) /* control device is open */ 149 #define TWA_STATE_SIMQ_FROZEN (1<<3) /* simq frozen */ 150 #define TWA_STATE_REQUEST_WAIT (1<<4) 151 152 /* Possible values of sc->twa_ioctl_lock.lock. */ 153 #define TWA_LOCK_FREE 0x0 /* lock is free */ 154 #define TWA_LOCK_HELD 0x1 /* lock is held */ 155 156 /* Driver's request packet. */ 157 struct twa_request { 158 struct twa_command_packet *tr_command; 159 /* ptr to cmd pkt submitted to controller */ 160 u_int32_t tr_request_id; 161 /* request id for tracking with firmware */ 162 void *tr_data; 163 /* ptr to data being passed to firmware */ 164 size_t tr_length; 165 /* length of buffer being passed to firmware */ 166 void *tr_real_data; 167 /* ptr to, and length of data passed */ 168 size_t tr_real_length; 169 /* to us from above, in case a buffer copy 170 * was done due to non-compliance to 171 * alignment requirements 172 */ 173 TAILQ_ENTRY(twa_request) tr_link; 174 /* to link this request in a list */ 175 struct twa_softc *tr_sc; 176 /* controller that owns us */ 177 u_int32_t tr_status; 178 /* command status */ 179 u_int32_t tr_flags; 180 /* request flags */ 181 u_int32_t tr_error; 182 /* error encountered before request submission */ 183 u_int32_t tr_cmd_pkt_type; 184 /* request specific data to use during callback */ 185 void (*tr_callback)(struct twa_request *tr); 186 /* callback handler */ 187 bus_addr_t tr_cmd_phys; 188 /* physical address of command in controller space */ 189 bus_dmamap_t tr_dma_map; 190 /* DMA map for data */ 191 struct buf *bp; 192 193 struct ld_twa_softc *tr_ld_sc; 194 }; 195 196 static __inline size_t twa_get_maxsegs(void) { 197 size_t max_segs = ((MAXPHYS + PAGE_SIZE - 1) / PAGE_SIZE) + 1; 198 #ifdef TWA_SG_SIZE 199 if (TWA_MAX_SG_ELEMENTS < max_segs) 200 max_segs = TWA_MAX_SG_ELEMENTS; 201 #endif 202 return max_segs; 203 } 204 205 static __inline size_t twa_get_maxxfer(size_t maxsegs) { 206 return (maxsegs - 1) * PAGE_SIZE; 207 } 208 209 struct twa_attach_args { 210 int twaa_unit; 211 }; 212 213 #define twaacf_unit cf_loc[TWACF_UNIT] 214 215 struct twa_request *twa_get_request(struct twa_softc *, int); 216 struct twa_request *twa_get_request_wait(struct twa_softc *, int); 217 int twa_map_request(struct twa_request *); 218 void twa_register_callbacks(struct twa_softc *sc, int unit, 219 const struct twa_callbacks *); 220 void twa_request_wait_handler(struct twa_request *); 221 void twa_release_request(struct twa_request *); 222 223 /* Error/AEN message structure. */ 224 struct twa_message { 225 u_int32_t code; 226 const char *message; 227 }; 228 229 #endif /* !_PCI_TWAVAR_H_ */ 230