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