1 /* $NetBSD: twevar.h,v 1.21 2004/05/27 23:47:23 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 2000, 2001, 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Andrew Doran. 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 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #ifndef _PCI_TWEVAR_H_ 40 #define _PCI_TWEVAR_H_ 41 42 #include "locators.h" 43 44 #define TWE_MAX_QUEUECNT 129 45 46 /* Callbacks from controller to array. */ 47 struct twe_callbacks { 48 void (*tcb_openings)(struct device *, int); 49 }; 50 51 /* Per-array drive information. */ 52 struct twe_drive { 53 uint32_t td_size; 54 uint8_t td_type; 55 uint8_t td_stripe; 56 57 struct device *td_dev; 58 const struct twe_callbacks *td_callbacks; 59 }; 60 61 /* Per-controller state. */ 62 struct twe_softc { 63 struct device sc_dv; 64 bus_space_tag_t sc_iot; 65 bus_space_handle_t sc_ioh; 66 bus_dma_tag_t sc_dmat; 67 bus_dmamap_t sc_dmamap; 68 void *sc_ih; 69 caddr_t sc_cmds; 70 bus_addr_t sc_cmds_paddr; 71 int sc_nccbs; 72 struct twe_ccb *sc_ccbs; 73 SIMPLEQ_HEAD(, twe_ccb) sc_ccb_queue; 74 SLIST_HEAD(, twe_ccb) sc_ccb_freelist; 75 int sc_flags; 76 int sc_openings; 77 int sc_nunits; 78 struct twe_drive sc_units[TWE_MAX_UNITS]; 79 80 /* Asynchronous event notification queue for management tools. */ 81 #define TWE_AEN_Q_LENGTH 256 82 uint16_t sc_aen_queue[TWE_AEN_Q_LENGTH]; 83 int sc_aen_head; 84 int sc_aen_tail; 85 }; 86 #define TWEF_OPEN 0x01 /* control device is opened */ 87 #define TWEF_AENQ_WAIT 0x02 /* someone waiting for AENs */ 88 #define TWEF_AEN 0x04 /* AEN fetch in progress */ 89 #define TWEF_WAIT_CCB 0x08 /* someone waiting for a CCB */ 90 91 /* Optional per-command context. */ 92 struct twe_context { 93 void (*tx_handler)(struct twe_ccb *, int); 94 void *tx_context; 95 struct device *tx_dv; 96 }; 97 98 /* Command control block. */ 99 struct twe_ccb { 100 union { 101 SIMPLEQ_ENTRY(twe_ccb) simpleq; 102 SLIST_ENTRY(twe_ccb) slist; 103 } ccb_chain; 104 struct twe_cmd *ccb_cmd; 105 int ccb_cmdid; 106 int ccb_flags; 107 void *ccb_data; 108 int ccb_datasize; 109 vaddr_t ccb_abuf; 110 bus_dmamap_t ccb_dmamap_xfer; 111 struct twe_context ccb_tx; 112 }; 113 #define TWE_CCB_DATA_IN 0x01 /* Map describes inbound xfer */ 114 #define TWE_CCB_DATA_OUT 0x02 /* Map describes outbound xfer */ 115 #define TWE_CCB_COMPLETE 0x04 /* Command completed */ 116 #define TWE_CCB_ACTIVE 0x08 /* Command active */ 117 #define TWE_CCB_AEN 0x10 /* For AEN retrieval */ 118 #define TWE_CCB_ALLOCED 0x20 /* CCB allocated */ 119 120 struct twe_attach_args { 121 int twea_unit; 122 }; 123 124 #define tweacf_unit cf_loc[TWECF_UNIT] 125 126 struct twe_ccb *twe_ccb_alloc(struct twe_softc *, int); 127 struct twe_ccb *twe_ccb_alloc_wait(struct twe_softc *, int); 128 void twe_ccb_enqueue(struct twe_softc *sc, struct twe_ccb *ccb); 129 void twe_ccb_free(struct twe_softc *sc, struct twe_ccb *); 130 int twe_ccb_map(struct twe_softc *, struct twe_ccb *); 131 int twe_ccb_poll(struct twe_softc *, struct twe_ccb *, int); 132 int twe_ccb_submit(struct twe_softc *, struct twe_ccb *); 133 void twe_ccb_unmap(struct twe_softc *, struct twe_ccb *); 134 135 void twe_ccb_wait_handler(struct twe_ccb *, int); 136 137 int twe_param_get(struct twe_softc *, int, int, size_t, 138 void (*)(struct twe_ccb *, int), struct twe_param **); 139 int twe_param_get_1(struct twe_softc *, int, int, uint8_t *); 140 int twe_param_get_2(struct twe_softc *, int, int, uint16_t *); 141 int twe_param_get_4(struct twe_softc *, int, int, uint32_t *); 142 143 void twe_register_callbacks(struct twe_softc *, int, 144 const struct twe_callbacks *); 145 146 static __inline__ size_t twe_get_maxsegs(void) { 147 size_t max_segs = ((MAXPHYS + PAGE_SIZE - 1) / PAGE_SIZE) + 1; 148 #ifdef TWE_SG_SIZE 149 if (TWE_SG_SIZE < max_segs) 150 max_segs = TWE_SG_SIZE; 151 #endif 152 return max_segs; 153 } 154 155 static __inline__ size_t twe_get_maxxfer(size_t maxsegs) { 156 return (maxsegs - 1) * PAGE_SIZE; 157 } 158 159 /* 160 * Structures used to convert numeric codes to strings. 161 */ 162 struct twe_code_table { 163 uint32_t code; 164 const char *string; 165 }; 166 extern const struct twe_code_table twe_table_status[]; 167 extern const struct twe_code_table twe_table_unitstate[]; 168 extern const struct twe_code_table twe_table_unittype[]; 169 extern const struct twe_code_table twe_table_stripedepth[]; 170 extern const struct twe_code_table twe_table_aen[]; 171 172 const char *twe_describe_code(const struct twe_code_table *, uint32_t); 173 174 #endif /* !_PCI_TWEVAR_H_ */ 175