freebsd-skq/sys/dev/isci/scil/sci_base_state_machine_observer.h
Jim Harris f11c7f6305 Add isci(4) driver for amd64 and i386 targets.
The isci driver is for the integrated SAS controller in the Intel C600
(Patsburg) chipset.  Source files in sys/dev/isci directory are
FreeBSD-specific, and sys/dev/isci/scil subdirectory contains
an OS-agnostic library (SCIL) published by Intel to control the SAS
controller.  This library is used primarily as-is in this driver, with
some post-processing to better integrate into the kernel build
environment.

isci.4 and a README in the sys/dev/isci directory contain a few
additional details.

This driver is only built for amd64 and i386 targets.

Sponsored by: Intel
Reviewed by: scottl
Approved by: scottl
2012-01-31 19:38:18 +00:00

139 lines
4.6 KiB
C

/*-
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* GPL LICENSE SUMMARY
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
* The full GNU General Public License is included in this distribution
* in the file called LICENSE.GPL.
*
* BSD LICENSE
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _SCI_BASE_STATE_MACHINE_OBSERVER_H_
#define _SCI_BASE_STATE_MACHINE_OBSERVER_H_
/**
* @file
*
* @brief This file contains all of the structures, constants, and methods
* common to all state machine observer object definitions.
*/
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
#include <dev/isci/scil/sci_base_observer.h>
#include <dev/isci/scil/sci_base_subject.h>
#if defined(SCI_LOGGING)
/**
* @struct SCI_BASE_STATE_MACHINE_OBSERVER
*
* @brief The base state machine observer structure defines the fields
* necessary for a user that wishes to observe the behavior (i.e.
* state changes) of a state machine.
*/
typedef struct SCI_BASE_STATE_MACHINE_OBSERVER
{
/**
* The field specifies that the parent object for the base state
* machine observer is the base observer itself.
*/
SCI_BASE_OBSERVER_T parent;
/**
* This field contains the state recorded during the last state machine
* update.
*/
U32 subject_state;
} SCI_BASE_STATE_MACHINE_OBSERVER_T;
/**
* @brief This method provides default behavior for a state machine observer.
* This method records the state of the subject (i.e. the state
* machine) and returns.
*
* @param[in] this_observer This parameter specifes the state machine
* observer in which to record the state change from the subject.
* @param[in] the_subject This parameter evaluates to the state machine
* object under observation.
*
* @return none
*/
void sci_base_state_machine_observer_default_update(
SCI_BASE_OBSERVER_T *this_observer,
SCI_BASE_SUBJECT_T *the_subject
);
/**
* @brief This method constructs the supplied state machine observer.
*
* @param[in] this_observer This parameter specifes the state machine
* observer to be constructed.
*
* @return none
*/
void sci_base_state_machine_observer_construct(
SCI_BASE_STATE_MACHINE_OBSERVER_T *this_observer
);
#else // defined(SCI_LOGGING)
typedef U8 SCI_BASE_STATE_MACHINE_OBSERVER_T;
#define sci_base_state_machine_observer_default_update
#define sci_base_state_machine_observer_construct
#endif // defined(SCI_LOGGING)
#ifdef __cplusplus
}
#endif // __cplusplus
#endif // _SCI_BASE_STATE_MACHINE_OBSERVER_H_