xref: /freebsd/sys/dev/isci/scil/scif_logger.h (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
1 /*-
2  * This file is provided under a dual BSD/GPLv2 license.  When using or
3  * redistributing this file, you may do so under either license.
4  *
5  * GPL LICENSE SUMMARY
6  *
7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21  * The full GNU General Public License is included in this distribution
22  * in the file called LICENSE.GPL.
23  *
24  * BSD LICENSE
25  *
26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27  * All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  *
33  *   * Redistributions of source code must retain the above copyright
34  *     notice, this list of conditions and the following disclaimer.
35  *   * Redistributions in binary form must reproduce the above copyright
36  *     notice, this list of conditions and the following disclaimer in
37  *     the documentation and/or other materials provided with the
38  *     distribution.
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51  *
52  * $FreeBSD$
53  */
54 #ifndef _SCIF_LOGGER_H_
55 #define _SCIF_LOGGER_H_
56 
57 /**
58  * @file
59  *
60  * @brief This file contains all of the SCI Framework specific logger object
61  *        constant definitions.
62  */
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif // __cplusplus
67 
68 #include <dev/isci/scil/sci_logger.h>
69 
70 
71 /* The following is a list of log objects for which log information can */
72 /* be enabled or disabled.                                              */
73 
74 /** Enables/disables logging specific to the library. */
75 #define SCIF_LOG_OBJECT_LIBRARY                 0x00000001
76 
77 /** Enables/disables logging specific to the controller. */
78 #define SCIF_LOG_OBJECT_CONTROLLER              0x00000002
79 
80 /** Enables/disables logging specific to the sas port. */
81 #define SCIF_LOG_OBJECT_DOMAIN                  0x00000004
82 
83 /** Enables/disables logging specific to the domain discovery process. */
84 #define SCIF_LOG_OBJECT_DOMAIN_DISCOVERY        0x00000008
85 
86 /** Enables/disables logging specific to the remote devices. */
87 #define SCIF_LOG_OBJECT_REMOTE_DEVICE           0x00000010
88 
89 /** Enables/disables logging specific to remote device configuration. */
90 #define SCIF_LOG_OBJECT_REMOTE_DEVICE_CONFIG    0x00000020
91 
92 /** Enables/disables logging specific to performing task management. */
93 #define SCIF_LOG_OBJECT_TASK_MANAGEMENT         0x00000040
94 
95 /** Enables/disables logging specific to SCSI to SATA command translation. */
96 #define SCIF_LOG_OBJECT_COMMAND_TRANSLATION     0x00000080
97 
98 /** Enables/disables logging specific to SCSI to SATA response translation. */
99 #define SCIF_LOG_OBJECT_RESPONSE_TRANSLATION    0x00000100
100 
101 /** Enables/disables logging specific to framework initialization. */
102 #define SCIF_LOG_OBJECT_INITIALIZATION          0x00000200
103 
104 /** Enables/disables logging specific to framework shutdown. */
105 #define SCIF_LOG_OBJECT_SHUTDOWN                0x00000400
106 
107 /** Enables/disables logging specific to all IO requests. */
108 #define SCIF_LOG_OBJECT_IO_REQUEST              0x00000800
109 
110 /** Enables/disables logging specific to all IO requests. */
111 #define SCIF_LOG_OBJECT_CONTROLLER_RESET        0x00001000
112 
113 #ifdef __cplusplus
114 }
115 #endif // __cplusplus
116 
117 #endif // _SCIF_LOGGER_H_
118 
119