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 _SCI_BASE_LOGGER_H_
57#define _SCI_BASE_LOGGER_H_
58
59/**
60 * @file
61 *
62 * @brief This file contains all of the constants, structures, and methods
63 *        common to all base logger objects.
64 */
65
66#ifdef __cplusplus
67extern "C" {
68#endif // __cplusplus
69
70#include <dev/isci/scil/sci_logger.h>
71#include <dev/isci/scil/sci_base_object.h>
72
73
74#define SCI_BASE_LOGGER_MAX_VERBOSITY_LEVELS 5
75
76/**
77 * @struct SCI_BASE_LOGGER
78 *
79 * @brief This structure contains the set of log objects and verbosities that
80 *        are enabled for logging.  It's parent is the SCI_BASE_OBJECT_T.
81 */
82typedef struct SCI_BASE_LOGGER
83{
84#if defined(SCI_LOGGING)
85   /**
86    * The field specifies that the parent object for the base logger
87    * is the base object itself.
88    */
89   SCI_BASE_OBJECT_T parent;
90
91   /**
92    * This filed specifies an array of objects mask.  There is one object
93    * mask for each verbosity level (e.g. ERROR, WARNING, etc.).  This
94    * allows for more flexible logging.
95    */
96   U32  object_mask[SCI_BASE_LOGGER_MAX_VERBOSITY_LEVELS];
97
98   /**
99    * This filed specifies which verbosity levels are currently enabled
100    * for logging
101    */
102   U32  verbosity_mask;
103#else // defined(SCI_LOGGING)
104   U8  dummy;
105#endif // defined(SCI_LOGGING)
106
107} SCI_BASE_LOGGER_T;
108
109#if defined(SCI_LOGGING)
110
111/**
112 * @brief This method simply performs initialization of the base logger object.
113 *
114 * @param[in] this_logger This parameter specifies the logger that we are
115 *            going to construct
116 *
117 * @return none
118 */
119void sci_base_logger_construct(
120   SCI_BASE_LOGGER_T *this_logger
121);
122
123#else // SCI_LOGGING
124
125#define sci_base_logger_construct
126
127#endif
128
129#ifdef __cplusplus
130}
131#endif // __cplusplus
132
133#endif // _SCI_BASE_LOGGER_H_
134