Style(9) cleanup to src/sys/vfs, stage 20/21: umapfs.
[dragonfly.git] / sys / dev / raid / mlx / mlxvar.h
1 /*-
2  * Copyright (c) 1999 Michael Smith
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *      $FreeBSD: src/sys/dev/mlx/mlxvar.h,v 1.5.2.3 2001/06/25 04:37:51 msmith Exp $
27  *      $DragonFly: src/sys/dev/raid/mlx/mlxvar.h,v 1.3 2003/06/23 17:55:32 dillon Exp $
28  */
29
30 /*
31  * Debugging levels:
32  *  0 - quiet, only emit warnings
33  *  1 - noisy, emit major function points and things done
34  *  2 - extremely noisy, emit trace items in loops, etc.
35  */
36 #ifdef MLX_DEBUG
37 #define debug(level, fmt, args...)      do { if (level <= MLX_DEBUG) printf("%s: " fmt "\n", __FUNCTION__ , ##args); } while(0)
38 #define debug_called(level)             do { if (level <= MLX_DEBUG) printf(__FUNCTION__ ": called\n"); } while(0)
39 #else
40 #define debug(level, fmt, args...)
41 #define debug_called(level)
42 #endif
43
44 /*
45  * Regardless of the actual capacity of the controller, we will allocate space
46  * for 64 s/g entries.  Typically controllers support 17 or 33 entries (64k or
47  * 128k maximum transfer assuming 4k page size and non-optimal alignment), but
48  * making that fit cleanly without crossing page boundaries requires rounding up
49  * to the next power of two.
50  */
51 #define MLX_NSEG        64
52
53 #define MLX_NSLOTS      256             /* max number of command slots */
54
55 #define MLX_MAXDRIVES   32              /* max number of system drives */
56
57 /*
58  * Structure describing a System Drive as attached to the controller.
59  */
60 struct mlx_sysdrive 
61 {
62     /* from MLX_CMD_ENQSYSDRIVE */
63     u_int32_t           ms_size;
64     int                 ms_state;
65     int                 ms_raidlevel;
66
67     /* synthetic geometry */
68     int                 ms_cylinders;
69     int                 ms_heads;
70     int                 ms_sectors;
71
72     /* handle for attached driver */
73     device_t            ms_disk;
74 };
75
76 /*
77  * Per-command control structure.
78  */
79 struct mlx_command 
80 {
81     TAILQ_ENTRY(mlx_command)    mc_link;        /* list linkage */
82
83     struct mlx_softc            *mc_sc;         /* controller that owns us */
84     u_int8_t                    mc_slot;        /* command slot we occupy */
85     u_int16_t                   mc_status;      /* command completion status */
86     time_t                      mc_timeout;     /* when this command expires */
87     u_int8_t                    mc_mailbox[16]; /* command mailbox */
88     u_int32_t                   mc_sgphys;      /* physical address of s/g array in controller space */
89     int                         mc_nsgent;      /* number of entries in s/g map */
90     int                         mc_flags;
91 #define MLX_CMD_DATAIN          (1<<0)
92 #define MLX_CMD_DATAOUT         (1<<1)
93 #define MLX_CMD_PRIORITY        (1<<2)          /* high-priority command */
94
95     void                        *mc_data;       /* data buffer */
96     size_t                      mc_length;
97     bus_dmamap_t                mc_dmamap;      /* DMA map for data */
98     u_int32_t                   mc_dataphys;    /* data buffer base address controller space */
99
100     void                        (* mc_complete)(struct mlx_command *mc);        /* completion handler */
101     void                        *mc_private;    /* submitter-private data or wait channel */
102 };
103
104 /*
105  * Per-controller structure.
106  */
107 struct mlx_softc 
108 {
109     /* bus connections */
110     device_t            mlx_dev;
111     dev_t               mlx_dev_t;
112     struct resource     *mlx_mem;       /* mailbox interface window */
113     int                 mlx_mem_rid;
114     int                 mlx_mem_type;
115     bus_space_handle_t  mlx_bhandle;    /* bus space handle */
116     bus_space_tag_t     mlx_btag;       /* bus space tag */
117     bus_dma_tag_t       mlx_parent_dmat;/* parent DMA tag */
118     bus_dma_tag_t       mlx_buffer_dmat;/* data buffer DMA tag */
119     struct resource     *mlx_irq;       /* interrupt */
120     void                *mlx_intr;      /* interrupt handle */
121
122     /* scatter/gather lists and their controller-visible mappings */
123     struct mlx_sgentry  *mlx_sgtable;   /* s/g lists */
124     u_int32_t           mlx_sgbusaddr;  /* s/g table base address in bus space */
125     bus_dma_tag_t       mlx_sg_dmat;    /* s/g buffer DMA tag */
126     bus_dmamap_t        mlx_sg_dmamap;  /* map for s/g buffers */
127     
128     /* controller limits and features */
129     struct mlx_enquiry2 *mlx_enq2;
130     int                 mlx_feature;    /* controller features/quirks */
131 #define MLX_FEAT_PAUSEWORKS     (1<<0)  /* channel pause works as expected */
132
133     /* controller queues and arrays */
134     TAILQ_HEAD(, mlx_command)   mlx_freecmds;           /* command structures available for reuse */
135     TAILQ_HEAD(, mlx_command)   mlx_work;               /* active commands */
136     struct mlx_command  *mlx_busycmd[MLX_NSLOTS];       /* busy commands */
137     int                 mlx_busycmds;                   /* count of busy commands */
138     struct mlx_sysdrive mlx_sysdrive[MLX_MAXDRIVES];    /* system drives */
139     mlx_bioq            mlx_bioq;                       /* outstanding I/O operations */
140     int                 mlx_waitbufs;                   /* number of bufs awaiting commands */
141
142     /* controller status */
143     int                 mlx_geom;
144 #define MLX_GEOM_128_32         0       /* geoemetry translation modes */
145 #define MLX_GEOM_256_63         1
146     int                 mlx_state;
147 #define MLX_STATE_INTEN         (1<<0)  /* interrupts have been enabled */
148 #define MLX_STATE_SHUTDOWN      (1<<1)  /* controller is shut down */
149 #define MLX_STATE_OPEN          (1<<2)  /* control device is open */
150 #define MLX_STATE_SUSPEND       (1<<3)  /* controller is suspended */
151     struct callout_handle mlx_timeout;  /* periodic status monitor */
152     time_t              mlx_lastpoll;   /* last time_second we polled for status */
153     u_int16_t           mlx_lastevent;  /* sequence number of the last event we recorded */
154     int                 mlx_currevent;  /* sequence number last time we looked */
155     int                 mlx_background; /* if != 0 rebuild or check is in progress */
156 #define MLX_BACKGROUND_CHECK            1       /* we started a check */
157 #define MLX_BACKGROUND_REBUILD          2       /* we started a rebuild */
158 #define MLX_BACKGROUND_SPONTANEOUS      3       /* it just happened somehow */
159     struct mlx_rebuild_status mlx_rebuildstat;  /* last rebuild status */
160     struct mlx_pause    mlx_pause;      /* pending pause operation details */
161
162     int                 mlx_locks;      /* reentrancy avoidance */
163     int                 mlx_flags;
164 #define MLX_SPINUP_REPORTED     (1<<0)  /* "spinning up drives" message displayed */
165 #define MLX_EVENTLOG_BUSY       (1<<1)  /* currently reading event log */
166
167     /* interface-specific accessor functions */
168     int                 mlx_iftype;     /* interface protocol */
169 #define MLX_IFTYPE_2    2
170 #define MLX_IFTYPE_3    3
171 #define MLX_IFTYPE_4    4
172 #define MLX_IFTYPE_5    5
173     int                 (* mlx_tryqueue)(struct mlx_softc *sc, struct mlx_command *mc);
174     int                 (* mlx_findcomplete)(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status);
175     void                (* mlx_intaction)(struct mlx_softc *sc, int action);
176     int                 (* mlx_fw_handshake)(struct mlx_softc *sc, int *error, int *param1, int *param2);
177 #define MLX_INTACTION_DISABLE           0
178 #define MLX_INTACTION_ENABLE            1
179 };
180
181 /*
182  * Simple (stupid) locks.
183  *
184  * Note that these are designed to avoid reentrancy, not concurrency, and will
185  * need to be replaced with something better.
186  */
187 #define MLX_LOCK_COMPLETING     (1<<0)
188 #define MLX_LOCK_STARTING       (1<<1)
189
190 static __inline int
191 mlx_lock_tas(struct mlx_softc *sc, int lock)
192 {
193     if ((sc)->mlx_locks & (lock))
194         return(1);
195     atomic_set_int(&sc->mlx_locks, lock);
196     return(0);
197 }
198
199 static __inline void
200 mlx_lock_clr(struct mlx_softc *sc, int lock)
201 {
202     atomic_clear_int(&sc->mlx_locks, lock);
203 }
204
205 /*
206  * Interface between bus connections and driver core.
207  */
208 extern void             mlx_free(struct mlx_softc *sc);
209 extern int              mlx_attach(struct mlx_softc *sc);
210 extern void             mlx_startup(struct mlx_softc *sc);
211 extern void             mlx_intr(void *data);
212 extern int              mlx_detach(device_t dev);
213 extern int              mlx_shutdown(device_t dev);
214 extern int              mlx_suspend(device_t dev); 
215 extern int              mlx_resume(device_t dev);
216 extern d_open_t         mlx_open;
217 extern d_close_t        mlx_close;
218 extern d_ioctl_t        mlx_ioctl;
219
220 extern devclass_t       mlx_devclass;
221 extern devclass_t       mlxd_devclass;
222
223 /*
224  * Mylex System Disk driver
225  */
226 struct mlxd_softc 
227 {
228     device_t            mlxd_dev;
229     dev_t               mlxd_dev_t;
230     struct mlx_softc    *mlxd_controller;
231     struct mlx_sysdrive *mlxd_drive;
232     struct disk         mlxd_disk;
233     struct devstat      mlxd_stats;
234     struct disklabel    mlxd_label;
235     int                 mlxd_unit;
236     int                 mlxd_flags;
237 #define MLXD_OPEN       (1<<0)          /* drive is open (can't shut down) */
238 };
239
240 /*
241  * Interface between driver core and disk driver (should be using a bus?)
242  */
243 extern int      mlx_submit_buf(struct mlx_softc *sc, mlx_bio *bp);
244 extern int      mlx_submit_ioctl(struct mlx_softc *sc, struct mlx_sysdrive *drive, u_long cmd, 
245                                  caddr_t addr, int32_t flag, d_thread_t *td);
246 extern void     mlxd_intr(void *data);
247
248