kernel: Add some __printflike()'s to protect against format issues.
[dragonfly.git] / sys / dev / disk / mpt / mpt_raid.h
1 /* $FreeBSD: src/sys/dev/mpt/mpt_raid.h,v 1.7 2006/07/16 03:31:01 mjacob Exp $ */
2 /*-
3  * Definitions for the integrated RAID features LSI MPT Fusion adapters.
4  *
5  * Copyright (c) 2005, WHEEL Sp. z o.o.
6  * Copyright (c) 2004, 2005 Justin T. Gibbs
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are
11  * met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15  *    substantially similar to the "NO WARRANTY" disclaimer below
16  *    ("Disclaimer") and any redistribution must be conditioned upon including
17  *    a substantially similar Disclaimer requirement for further binary
18  *    redistribution.
19  * 3. Neither the names of the above listed copyright holders nor the names
20  *    of any contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
33  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 /*-
36  * Some Breakage and Bug Fixing added later.
37  * Copyright (c) 2006, by Matthew Jacob
38  * All Rights Reserved
39  *
40  * Support from LSI-Logic has also gone a great deal toward making this a
41  * workable subsystem and is gratefully acknowledged.
42  */
43 #ifndef  _MPT_RAID_H_
44 #define  _MPT_RAID_H_
45
46 #include <bus/cam/cam.h>
47 union ccb;
48
49 typedef enum {
50         MPT_RAID_MWCE_ON,
51         MPT_RAID_MWCE_OFF,
52         MPT_RAID_MWCE_REBUILD_ONLY,
53         MPT_RAID_MWCE_NC
54 } mpt_raid_mwce_t;
55
56 const char *mpt_vol_type(struct mpt_raid_volume *);
57 const char *mpt_vol_state(struct mpt_raid_volume *);
58 const char *mpt_disk_state(struct mpt_raid_disk *);
59 void mpt_vol_prt(struct mpt_softc *, struct mpt_raid_volume *,
60          const char *, ...) __printflike(3, 4);
61 void mpt_disk_prt(struct mpt_softc *, struct mpt_raid_disk *,
62          const char *, ...) __printflike(3, 4);
63
64 int
65 mpt_issue_raid_req(struct mpt_softc *, struct mpt_raid_volume *,
66     struct mpt_raid_disk *, request_t *, u_int, uint32_t, bus_addr_t,
67     bus_size_t, int, int);
68
69 cam_status
70 mpt_map_physdisk(struct mpt_softc *, union ccb *, target_id_t *);
71 int mpt_is_raid_volume(struct mpt_softc *, int);
72 #if     0
73 cam_status
74 mpt_raid_quiesce_disk(struct mpt_softc *, struct mpt_raid_disk *, request_t *);
75 #endif
76
77 int     mpt_refresh_raid_data(struct mpt_softc *);
78 void    mpt_schedule_raid_refresh(struct mpt_softc *);
79 void    mpt_raid_free_mem(struct mpt_softc *);
80
81 static __inline void
82 mpt_raid_wakeup(struct mpt_softc *mpt)
83 {
84         mpt->raid_wakeup++;
85         wakeup(&mpt->raid_volumes);
86 }
87
88 #define MPT_RAID_SYNC_REPORT_INTERVAL (15 * 60 * hz)
89 #define MPT_RAID_RESYNC_RATE_MAX (255)
90 #define MPT_RAID_RESYNC_RATE_MIN (1)
91 #define MPT_RAID_RESYNC_RATE_NC (0)
92 #define MPT_RAID_RESYNC_RATE_DEFAULT MPT_RAID_RESYNC_RATE_NC
93
94 #define MPT_RAID_QUEUE_DEPTH_DEFAULT (128)
95
96 #define MPT_RAID_MWCE_DEFAULT MPT_RAID_MWCE_NC
97
98 #define RAID_VOL_FOREACH(mpt, mpt_vol)                                  \
99         for (mpt_vol = (mpt)->raid_volumes;                             \
100              mpt_vol != (mpt)->raid_volumes + (mpt)->raid_max_volumes;  \
101              mpt_vol++)
102
103 #endif /*_MPT_RAID_H_ */