sys/dev/isci/scil/sci_base_state_machine_logger.h

   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_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
  66 extern "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  */
  80 typedef void (*SCI_BASE_STATE_MACHINE_LOGGER_LOG_HANDLER_T)(
  81    SCI_LOGGER_HANDLE_T, U32, char *, ...
  82 );
  83
  84 #if defined(SCI_LOGGING)
  85
  86 typedef 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
  99 void 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
 108 void 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
 118 void 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
 125 typedef 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_