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$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_PHY_H_ 55230557Sjimharris#define _SCI_BASE_PHY_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the structures, constants, and methods 61230557Sjimharris * common to all phy object definitions. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_base_logger.h> 69230557Sjimharris#include <dev/isci/scil/sci_base_state_machine.h> 70230557Sjimharris#include <dev/isci/scil/sci_base_state_machine_logger.h> 71230557Sjimharris 72230557Sjimharris/** 73230557Sjimharris * @enum SCI_BASE_PHY_STATES 74230557Sjimharris * 75230557Sjimharris * @brief This enumeration depicts the standard states common to all phy 76230557Sjimharris * state machine implementations. 77230557Sjimharris */ 78230557Sjimharristypedef enum _SCI_BASE_PHY_STATES 79230557Sjimharris{ 80230557Sjimharris /** 81230557Sjimharris * Simply the initial state for the base domain state machine. 82230557Sjimharris */ 83230557Sjimharris SCI_BASE_PHY_STATE_INITIAL, 84230557Sjimharris 85230557Sjimharris /** 86230557Sjimharris * This state indicates that the phy has successfully been stopped. 87230557Sjimharris * In this state no new IO operations are permitted on this phy. 88230557Sjimharris * This state is entered from the INITIAL state. 89230557Sjimharris * This state is entered from the STARTING state. 90230557Sjimharris * This state is entered from the READY state. 91230557Sjimharris * This state is entered from the RESETTING state. 92230557Sjimharris */ 93230557Sjimharris SCI_BASE_PHY_STATE_STOPPED, 94230557Sjimharris 95230557Sjimharris /** 96230557Sjimharris * This state indicates that the phy is in the process of becomming 97230557Sjimharris * ready. In this state no new IO operations are permitted on this phy. 98230557Sjimharris * This state is entered from the STOPPED state. 99230557Sjimharris * This state is entered from the READY state. 100230557Sjimharris * This state is entered from the RESETTING state. 101230557Sjimharris */ 102230557Sjimharris SCI_BASE_PHY_STATE_STARTING, 103230557Sjimharris 104230557Sjimharris /** 105240518Seadler * This state indicates the phy is now ready. Thus, the user 106230557Sjimharris * is able to perform IO operations utilizing this phy as long as it 107230557Sjimharris * is currently part of a valid port. 108230557Sjimharris * This state is entered from the STARTING state. 109230557Sjimharris */ 110230557Sjimharris SCI_BASE_PHY_STATE_READY, 111230557Sjimharris 112230557Sjimharris /** 113230557Sjimharris * This state indicates that the phy is in the process of being reset. 114230557Sjimharris * In this state no new IO operations are permitted on this phy. 115230557Sjimharris * This state is entered from the READY state. 116230557Sjimharris */ 117230557Sjimharris SCI_BASE_PHY_STATE_RESETTING, 118230557Sjimharris 119230557Sjimharris /** 120230557Sjimharris * Simply the final state for the base phy state machine. 121230557Sjimharris */ 122230557Sjimharris SCI_BASE_PHY_STATE_FINAL, 123230557Sjimharris 124230557Sjimharris SCI_BASE_PHY_MAX_STATES 125230557Sjimharris 126230557Sjimharris} SCI_BASE_PHY_STATES; 127230557Sjimharris 128230557Sjimharris/** 129230557Sjimharris * @struct SCI_BASE_PHY 130230557Sjimharris * 131230557Sjimharris * @brief This structure defines all of the fields common to PHY objects. 132230557Sjimharris */ 133230557Sjimharristypedef struct SCI_BASE_PHY 134230557Sjimharris{ 135230557Sjimharris /** 136230557Sjimharris * This field depicts the parent object (SCI_BASE_OBJECT) for the phy. 137230557Sjimharris */ 138230557Sjimharris SCI_BASE_OBJECT_T parent; 139230557Sjimharris 140230557Sjimharris /** 141230557Sjimharris * This field contains the information for the base phy state machine. 142230557Sjimharris */ 143230557Sjimharris SCI_BASE_STATE_MACHINE_T state_machine; 144230557Sjimharris 145230557Sjimharris #ifdef SCI_LOGGING 146230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_T state_machine_logger; 147230557Sjimharris #endif // SCI_LOGGING 148230557Sjimharris 149230557Sjimharris} SCI_BASE_PHY_T; 150230557Sjimharris 151230557Sjimharristypedef SCI_STATUS (*SCI_BASE_PHY_HANDLER_T)( 152230557Sjimharris SCI_BASE_PHY_T * 153230557Sjimharris); 154230557Sjimharris 155230557Sjimharris/** 156230557Sjimharris * @struct SCI_BASE_PHY_STATE_HANDLER 157230557Sjimharris * 158230557Sjimharris * @brief This structure contains all of the state handler methods common to 159230557Sjimharris * base phy state machines. Handler methods provide the ability 160230557Sjimharris * to change the behavior for user requests or transitions depending 161230557Sjimharris * on the state the machine is in. 162230557Sjimharris */ 163230557Sjimharristypedef struct SCI_BASE_PHY_STATE_HANDLER 164230557Sjimharris{ 165230557Sjimharris /** 166230557Sjimharris * The start_handler specifies the method invoked when there is an 167230557Sjimharris * attempt to start a phy. 168230557Sjimharris */ 169230557Sjimharris SCI_BASE_PHY_HANDLER_T start_handler; 170230557Sjimharris 171230557Sjimharris /** 172230557Sjimharris * The stop_handler specifies the method invoked when there is an 173230557Sjimharris * attempt to stop a phy. 174230557Sjimharris */ 175230557Sjimharris SCI_BASE_PHY_HANDLER_T stop_handler; 176230557Sjimharris 177230557Sjimharris /** 178230557Sjimharris * The reset_handler specifies the method invoked when there is an 179230557Sjimharris * attempt to reset a phy. 180230557Sjimharris */ 181230557Sjimharris SCI_BASE_PHY_HANDLER_T reset_handler; 182230557Sjimharris 183230557Sjimharris /** 184230557Sjimharris * The destruct_handler specifies the method invoked when attempting to 185230557Sjimharris * destruct a phy. 186230557Sjimharris */ 187230557Sjimharris SCI_BASE_PHY_HANDLER_T destruct_handler; 188230557Sjimharris 189230557Sjimharris} SCI_BASE_PHY_STATE_HANDLER_T; 190230557Sjimharris 191230557Sjimharris/** 192230557Sjimharris * @brief Construct the base phy 193230557Sjimharris * 194230557Sjimharris * @param[in] this_phy This parameter specifies the base phy to be 195230557Sjimharris * constructed. 196230557Sjimharris * @param[in] logger This parameter specifies the logger associated with 197230557Sjimharris * this base phy object. 198230557Sjimharris * @param[in] state_table This parameter specifies the table of state 199230557Sjimharris * definitions to be utilized for the phy state machine. 200230557Sjimharris * 201230557Sjimharris * @return none 202230557Sjimharris */ 203230557Sjimharrisvoid sci_base_phy_construct( 204230557Sjimharris SCI_BASE_PHY_T * this_phy, 205230557Sjimharris SCI_BASE_LOGGER_T * logger, 206230557Sjimharris SCI_BASE_STATE_T * state_table 207230557Sjimharris); 208230557Sjimharris 209230557Sjimharris#ifdef __cplusplus 210230557Sjimharris} 211230557Sjimharris#endif // __cplusplus 212230557Sjimharris 213230557Sjimharris#endif // _SCI_BASE_PHY_H_ 214