1 /* $NetBSD: twevar.h,v 1.22 2004/09/13 12:55:48 drochner 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 #define TWE_MAX_QUEUECNT 129 43 44 /* Callbacks from controller to array. */ 45 struct twe_callbacks { 46 void (*tcb_openings)(struct device *, int); 47 }; 48 49 /* Per-array drive information. */ 50 struct twe_drive { 51 uint32_t td_size; 52 uint8_t td_type; 53 uint8_t td_stripe; 54 55 struct device *td_dev; 56 const struct twe_callbacks *td_callbacks; 57 }; 58 59 /* Per-controller state. */ 60 struct twe_softc { 61 struct device sc_dv; 62 bus_space_tag_t sc_iot; 63 bus_space_handle_t sc_ioh; 64 bus_dma_tag_t sc_dmat; 65 bus_dmamap_t sc_dmamap; 66 void *sc_ih; 67 caddr_t sc_cmds; 68 bus_addr_t sc_cmds_paddr; 69 int sc_nccbs; 70 struct twe_ccb *sc_ccbs; 71 SIMPLEQ_HEAD(, twe_ccb) sc_ccb_queue; 72 SLIST_HEAD(, twe_ccb) sc_ccb_freelist; 73 int sc_flags; 74 int sc_openings; 75 int sc_nunits; 76 struct twe_drive sc_units[TWE_MAX_UNITS]; 77 78 /* Asynchronous event notification queue for management tools. */ 79 #define TWE_AEN_Q_LENGTH 256 80 uint16_t sc_aen_queue[TWE_AEN_Q_LENGTH]; 81 int sc_aen_head; 82 int sc_aen_tail; 83 }; 84 #define TWEF_OPEN 0x01 /* control device is opened */ 85 #define TWEF_AENQ_WAIT 0x02 /* someone waiting for AENs */ 86 #define TWEF_AEN 0x04 /* AEN fetch in progress */ 87 #define TWEF_WAIT_CCB 0x08 /* someone waiting for a CCB */ 88 89 /* Optional per-command context. */ 90 struct twe_context { 91 void (*tx_handler)(struct twe_ccb *, int); 92 void *tx_context; 93 struct device *tx_dv; 94 }; 95 96 /* Command control block. */ 97 struct twe_ccb { 98 union { 99 SIMPLEQ_ENTRY(twe_ccb) simpleq; 100 SLIST_ENTRY(twe_ccb) slist; 101 } ccb_chain; 102 struct twe_cmd *ccb_cmd; 103 int ccb_cmdid; 104 int ccb_flags; 105 void *ccb_data; 106 int ccb_datasize; 107 vaddr_t ccb_abuf; 108 bus_dmamap_t ccb_dmamap_xfer; 109 struct twe_context ccb_tx; 110 }; 111 #define TWE_CCB_DATA_IN 0x01 /* Map describes inbound xfer */ 112 #define TWE_CCB_DATA_OUT 0x02 /* Map describes outbound xfer */ 113 #define TWE_CCB_COMPLETE 0x04 /* Command completed */ 114 #define TWE_CCB_ACTIVE 0x08 /* Command active */ 115 #define TWE_CCB_AEN 0x10 /* For AEN retrieval */ 116 #define TWE_CCB_ALLOCED 0x20 /* CCB allocated */ 117 118 struct twe_attach_args { 119 int twea_unit; 120 }; 121 122 struct twe_ccb *twe_ccb_alloc(struct twe_softc *, int); 123 struct twe_ccb *twe_ccb_alloc_wait(struct twe_softc *, int); 124 void twe_ccb_enqueue(struct twe_softc *sc, struct twe_ccb *ccb); 125 void twe_ccb_free(struct twe_softc *sc, struct twe_ccb *); 126 int twe_ccb_map(struct twe_softc *, struct twe_ccb *); 127 int twe_ccb_poll(struct twe_softc *, struct twe_ccb *, int); 128 int twe_ccb_submit(struct twe_softc *, struct twe_ccb *); 129 void twe_ccb_unmap(struct twe_softc *, struct twe_ccb *); 130 131 void twe_ccb_wait_handler(struct twe_ccb *, int); 132 133 int twe_param_get(struct twe_softc *, int, int, size_t, 134 void (*)(struct twe_ccb *, int), struct twe_param **); 135 int twe_param_get_1(struct twe_softc *, int, int, uint8_t *); 136 int twe_param_get_2(struct twe_softc *, int, int, uint16_t *); 137 int twe_param_get_4(struct twe_softc *, int, int, uint32_t *); 138 139 void twe_register_callbacks(struct twe_softc *, int, 140 const struct twe_callbacks *); 141 142 static __inline__ size_t twe_get_maxsegs(void) { 143 size_t max_segs = ((MAXPHYS + PAGE_SIZE - 1) / PAGE_SIZE) + 1; 144 #ifdef TWE_SG_SIZE 145 if (TWE_SG_SIZE < max_segs) 146 max_segs = TWE_SG_SIZE; 147 #endif 148 return max_segs; 149 } 150 151 static __inline__ size_t twe_get_maxxfer(size_t maxsegs) { 152 return (maxsegs - 1) * PAGE_SIZE; 153 } 154 155 /* 156 * Structures used to convert numeric codes to strings. 157 */ 158 struct twe_code_table { 159 uint32_t code; 160 const char *string; 161 }; 162 extern const struct twe_code_table twe_table_status[]; 163 extern const struct twe_code_table twe_table_unitstate[]; 164 extern const struct twe_code_table twe_table_unittype[]; 165 extern const struct twe_code_table twe_table_stripedepth[]; 166 extern const struct twe_code_table twe_table_aen[]; 167 168 const char *twe_describe_code(const struct twe_code_table *, uint32_t); 169 170 #endif /* !_PCI_TWEVAR_H_ */ 171