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