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