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