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