sci_base_state.h revision 331722 
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: stable/11/sys/dev/isci/scil/sci_base_state.h 331722 2018-03-29 02:50:57Z eadler $
53 */
54#ifndef _SCI_BASE_STATE_H_
55#define _SCI_BASE_STATE_H_
56
57/**
58 * @file
59 *
60 * @brief This file contains all of the structures, constants, and methods
61 *        common to all base object definitions.
62 */
63
64#ifdef __cplusplus
65extern "C" {
66#endif // __cplusplus
67
68#include <dev/isci/scil/sci_base_object.h>
69
70typedef void (*SCI_BASE_STATE_HANDLER_T)(
71   void
72);
73
74typedef void (*SCI_STATE_TRANSITION_T)(
75   SCI_BASE_OBJECT_T *base_object
76);
77
78/**
79 * @struct SCI_BASE_STATE
80 *
81 * @brief The base state object abstracts the fields common to all state
82 *        objects defined in SCI.
83 */
84typedef struct SCI_BASE_STATE
85{
86   /**
87    * This field indicates the defined value for this state.  After
88    * initialization this field should not change.
89    */
90   U32  value;
91
92   /**
93    * This field is a function pointer that defines the method to be
94    * invoked when the state is entered.
95    */
96   SCI_STATE_TRANSITION_T  enter_state;
97
98   /**
99    * This field is a function pointer that defines the method to be
100    * invoked when the state is exited.
101    */
102   SCI_STATE_TRANSITION_T  exit_state;
103
104} SCI_BASE_STATE_T;
105
106#ifdef __cplusplus
107}
108#endif // __cplusplus
109
110#endif // _SCI_BASE_STATE_H_
111