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#ifndef _SCI_BASE_STATE_MACHINE_LOGGER_H_
55#define _SCI_BASE_STATE_MACHINE_LOGGER_H_
56
57/**
58 * @file
59 *
60 * @brief This file provides the structures and function prototypes for the
61 *        state machine logger.  The functions provided are only implemented
62 *        if the SCI_LOGGING flag is enabled.
63 */
64
65#ifdef __cplusplus
66extern "C" {
67#endif // __cplusplus
68
69#include <dev/isci/scil/sci_types.h>
70#include <dev/isci/scil/sci_base_object.h>
71#include <dev/isci/scil/sci_base_state_machine.h>
72#include <dev/isci/scil/sci_base_state_machine_observer.h>
73
74/**
75 * This type is defined so we can pass either a core or framework logging
76 * function to the state machine logger since both have the same prototypes
77 * and this base state machine logger does not actually know which component
78 * will be doing the logging.
79 */
80typedef void (*SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T)(
81   SCI_LOGGER_HANDLE_T, U32, char *, ...
82);
83
84#if defined(SCI_LOGGING)
85
86typedef struct SCI_BASE_STATE_MACHINE_LOGGER
87{
88   SCI_BASE_STATE_MACHINE_OBSERVER_T parent;
89
90   SCI_BASE_OBJECT_T                           * log_object;
91   SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T   log_function;
92   char                                        * log_object_name;
93   char                                        * log_state_machine_name;
94   U32                                           log_mask;
95
96} SCI_BASE_STATE_MACHINE_LOGGER_T;
97
98
99void sci_base_state_machine_logger_construct(
100   SCI_BASE_STATE_MACHINE_LOGGER_T             * this_observer,
101   SCI_BASE_OBJECT_T                           * the_object,
102   SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T   the_log_function,
103   char                                        * log_object_name,
104   char                                        * log_state_machine_name,
105   U32                                           log_object_mask
106);
107
108void sci_base_state_machine_logger_initialize(
109   SCI_BASE_STATE_MACHINE_LOGGER_T             * this_observer,
110   SCI_BASE_STATE_MACHINE_T                    * the_state_machine,
111   SCI_BASE_OBJECT_T                           * the_object,
112   SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T   the_log_function,
113   char                                        * log_object_name,
114   char                                        * log_state_machine_name,
115   U32                                           log_object_mask
116);
117
118void sci_base_state_machine_logger_deinitialize(
119   SCI_BASE_STATE_MACHINE_LOGGER_T * this_observer,
120   SCI_BASE_STATE_MACHINE_T        * the_state_machine
121);
122
123#else // SCI_LOGGING
124
125typedef U8 SCI_BASE_STATE_MACHINE_LOGGER_T;
126
127#define sci_base_state_machine_logger_construct(this_observer,the_object,the_log_function,log_object_name,log_state_machine_name,log_object_mask)
128#define sci_base_state_machine_logger_initialize(this_observer,the_state_machine,the_object,the_log_function,log_object_name,log_state_machine_name,log_object_mask)
129#define sci_base_state_machine_logger_deinitialize(this_observer, the_state_machine)
130
131#endif // SCI_LOGGING
132
133#ifdef __cplusplus
134}
135#endif // __cplusplus
136
137#endif // _SCI_BASE_STATE_MACHINE_LOGGER_H_
138