Commit | Line | Data |
---|---|---|
26780d9e BG |
1 | /* |
2 | * linux/drivers/scsi/esas2r/esas2r_log.h | |
3 | * For use with ATTO ExpressSAS R6xx SAS/SATA RAID controllers | |
4 | * | |
5 | * Copyright (c) 2001-2013 ATTO Technology, Inc. | |
6 | * (mailto:linuxdrivers@attotech.com) | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or | |
9 | * modify it under the terms of the GNU General Public License | |
10 | * as published by the Free Software Foundation; either version 2 | |
11 | * of the License, or (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * NO WARRANTY | |
19 | * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR | |
20 | * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT | |
21 | * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, | |
22 | * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is | |
23 | * solely responsible for determining the appropriateness of using and | |
24 | * distributing the Program and assumes all risks associated with its | |
25 | * exercise of rights under this Agreement, including but not limited to | |
26 | * the risks and costs of program errors, damage to or loss of data, | |
27 | * programs or equipment, and unavailability or interruption of operations. | |
28 | * | |
29 | * DISCLAIMER OF LIABILITY | |
30 | * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY | |
31 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
32 | * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND | |
33 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR | |
34 | * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE | |
35 | * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED | |
36 | * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES | |
37 | * | |
38 | * You should have received a copy of the GNU General Public License | |
39 | * along with this program; if not, write to the Free Software | |
40 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, | |
41 | * USA. | |
42 | */ | |
43 | ||
44 | #ifndef __esas2r_log_h__ | |
45 | #define __esas2r_log_h__ | |
46 | ||
47 | struct device; | |
48 | ||
49 | enum { | |
50 | ESAS2R_LOG_NONE = 0, /* no events logged */ | |
51 | ESAS2R_LOG_CRIT = 1, /* critical events */ | |
52 | ESAS2R_LOG_WARN = 2, /* warning events */ | |
53 | ESAS2R_LOG_INFO = 3, /* info events */ | |
54 | ESAS2R_LOG_DEBG = 4, /* debugging events */ | |
55 | ESAS2R_LOG_TRCE = 5, /* tracing events */ | |
56 | ||
57 | #ifdef ESAS2R_TRACE | |
58 | ESAS2R_LOG_DFLT = ESAS2R_LOG_TRCE | |
59 | #else | |
60 | ESAS2R_LOG_DFLT = ESAS2R_LOG_WARN | |
61 | #endif | |
62 | }; | |
63 | ||
64 | int esas2r_log(const long level, const char *format, ...); | |
65 | int esas2r_log_dev(const long level, | |
66 | const struct device *dev, | |
67 | const char *format, | |
68 | ...); | |
69 | int esas2r_log_hexdump(const long level, | |
70 | const void *buf, | |
71 | size_t len); | |
72 | ||
73 | /* | |
74 | * the following macros are provided specifically for debugging and tracing | |
75 | * messages. esas2r_debug() is provided for generic non-hardware layer | |
76 | * debugging and tracing events. esas2r_hdebug is provided specifically for | |
77 | * hardware layer debugging and tracing events. | |
78 | */ | |
79 | ||
80 | #ifdef ESAS2R_DEBUG | |
81 | #define esas2r_debug(f, args ...) esas2r_log(ESAS2R_LOG_DEBG, f, ## args) | |
82 | #define esas2r_hdebug(f, args ...) esas2r_log(ESAS2R_LOG_DEBG, f, ## args) | |
83 | #else | |
84 | #define esas2r_debug(f, args ...) | |
85 | #define esas2r_hdebug(f, args ...) | |
86 | #endif /* ESAS2R_DEBUG */ | |
87 | ||
88 | /* | |
89 | * the following macros are provided in order to trace the driver and catch | |
90 | * some more serious bugs. be warned, enabling these macros may *severely* | |
91 | * impact performance. | |
92 | */ | |
93 | ||
94 | #ifdef ESAS2R_TRACE | |
95 | #define esas2r_bugon() \ | |
96 | do { \ | |
97 | esas2r_log(ESAS2R_LOG_TRCE, "esas2r_bugon() called in %s:%d" \ | |
98 | " - dumping stack and stopping kernel", __func__, \ | |
99 | __LINE__); \ | |
100 | dump_stack(); \ | |
101 | BUG(); \ | |
102 | } while (0) | |
103 | ||
104 | #define esas2r_trace_enter() esas2r_log(ESAS2R_LOG_TRCE, "entered %s (%s:%d)", \ | |
105 | __func__, __FILE__, __LINE__) | |
106 | #define esas2r_trace_exit() esas2r_log(ESAS2R_LOG_TRCE, "exited %s (%s:%d)", \ | |
107 | __func__, __FILE__, __LINE__) | |
108 | #define esas2r_trace(f, args ...) esas2r_log(ESAS2R_LOG_TRCE, "(%s:%s:%d): " \ | |
109 | f, __func__, __FILE__, __LINE__, \ | |
110 | ## args) | |
111 | #else | |
112 | #define esas2r_bugon() | |
113 | #define esas2r_trace_enter() | |
114 | #define esas2r_trace_exit() | |
115 | #define esas2r_trace(f, args ...) | |
116 | #endif /* ESAS2R_TRACE */ | |
117 | ||
118 | #endif /* __esas2r_log_h__ */ |