sys/dev/isci/scil/sci_base_state_machine_observer.c

   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
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /**
  57  * @file
  58  *
  59  * @brief This file provides the implementation for the observer role
  60  *        for a state machine.  A state machine observer is notified when
  61  *        the state machine changes states.
  62  */
  63
  64 #include <dev/isci/scil/sci_base_state_machine.h>
  65 #include <dev/isci/scil/sci_base_state_machine_observer.h>
  66
  67 #if defined(SCI_LOGGING)
  68
  69 #define SCI_BASE_INVALID_SUBJECT_STATE 0xFFFF
  70
  71 //******************************************************************************
  72 //* P R O T E C T E D    M E T H O D S
  73 //******************************************************************************
  74
  75 void sci_base_state_machine_observer_default_update(
  76    SCI_BASE_OBSERVER_T *this_observer,
  77    SCI_BASE_SUBJECT_T  *the_subject
  78 )
  79 {
  80    SCI_BASE_STATE_MACHINE_OBSERVER_T *state_machine_observer;
  81
  82    state_machine_observer = (SCI_BASE_STATE_MACHINE_OBSERVER_T *)this_observer;
  83
  84    state_machine_observer->subject_state =
  85       sci_base_state_machine_get_state((SCI_BASE_STATE_MACHINE_T *)the_subject);
  86 }
  87
  88 // ---------------------------------------------------------------------------
  89
  90 void sci_base_state_machine_observer_construct(
  91    SCI_BASE_STATE_MACHINE_OBSERVER_T *this_observer
  92 )
  93 {
  94    this_observer->parent.update = sci_base_state_machine_observer_default_update;
  95
  96    this_observer->subject_state = SCI_BASE_INVALID_SUBJECT_STATE;
  97 }
  98
  99 #endif // defined(SCI_LOGGING)