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