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