1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD: releng/10.2/sys/dev/isci/scil/sci_base_state_machine_logger.h 231136 2012-02-07 17:43:58Z jimharris $ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_STATE_MACHINE_LOGGER_H_ 55230557Sjimharris#define _SCI_BASE_STATE_MACHINE_LOGGER_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file provides the structures and function prototypes for the 61230557Sjimharris * state machine logger. The functions provided are only implemented 62230557Sjimharris * if the SCI_LOGGING flag is enabled. 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/sci_types.h> 70230557Sjimharris#include <dev/isci/scil/sci_base_object.h> 71230557Sjimharris#include <dev/isci/scil/sci_base_state_machine.h> 72230557Sjimharris#include <dev/isci/scil/sci_base_state_machine_observer.h> 73230557Sjimharris 74230557Sjimharris/** 75230557Sjimharris * This type is defined so we can pass either a core or framework logging 76230557Sjimharris * function to the state machine logger since both have the same prototypes 77230557Sjimharris * and this base state machine logger does not actually know which component 78230557Sjimharris * will be doing the logging. 79230557Sjimharris */ 80230557Sjimharristypedef void (*SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T)( 81230557Sjimharris SCI_LOGGER_HANDLE_T, U32, char *, ... 82230557Sjimharris); 83230557Sjimharris 84230557Sjimharris#if defined(SCI_LOGGING) 85230557Sjimharris 86230557Sjimharristypedef struct SCI_BASE_STATE_MACHINE_LOGGER 87230557Sjimharris{ 88230557Sjimharris SCI_BASE_STATE_MACHINE_OBSERVER_T parent; 89230557Sjimharris 90230557Sjimharris SCI_BASE_OBJECT_T * log_object; 91230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T log_function; 92230557Sjimharris char * log_object_name; 93230557Sjimharris char * log_state_machine_name; 94230557Sjimharris U32 log_mask; 95230557Sjimharris 96230557Sjimharris} SCI_BASE_STATE_MACHINE_LOGGER_T; 97230557Sjimharris 98230557Sjimharris 99230557Sjimharrisvoid sci_base_state_machine_logger_construct( 100230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_T * this_observer, 101230557Sjimharris SCI_BASE_OBJECT_T * the_object, 102230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T the_log_function, 103230557Sjimharris char * log_object_name, 104230557Sjimharris char * log_state_machine_name, 105230557Sjimharris U32 log_object_mask 106230557Sjimharris); 107230557Sjimharris 108230557Sjimharrisvoid sci_base_state_machine_logger_initialize( 109230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_T * this_observer, 110230557Sjimharris SCI_BASE_STATE_MACHINE_T * the_state_machine, 111230557Sjimharris SCI_BASE_OBJECT_T * the_object, 112230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T the_log_function, 113230557Sjimharris char * log_object_name, 114230557Sjimharris char * log_state_machine_name, 115230557Sjimharris U32 log_object_mask 116230557Sjimharris); 117230557Sjimharris 118230557Sjimharrisvoid sci_base_state_machine_logger_deinitialize( 119230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_T * this_observer, 120230557Sjimharris SCI_BASE_STATE_MACHINE_T * the_state_machine 121230557Sjimharris); 122230557Sjimharris 123230557Sjimharris#else // SCI_LOGGING 124230557Sjimharris 125230557Sjimharristypedef U8 SCI_BASE_STATE_MACHINE_LOGGER_T; 126230557Sjimharris 127230557Sjimharris#define sci_base_state_machine_logger_construct(this_observer,the_object,the_log_function,log_object_name,log_state_machine_name,log_object_mask) 128230557Sjimharris#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) 129230557Sjimharris#define sci_base_state_machine_logger_deinitialize(this_observer, the_state_machine) 130230557Sjimharris 131230557Sjimharris#endif // SCI_LOGGING 132230557Sjimharris 133230557Sjimharris#ifdef __cplusplus 134230557Sjimharris} 135230557Sjimharris#endif // __cplusplus 136230557Sjimharris 137230557Sjimharris#endif // _SCI_BASE_STATE_MACHINE_LOGGER_H_ 138