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 _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_ 55#define _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_ 56 57/** 58 * @file 59 * 60 * @brief This file contains the structures, constants and prototypes used for 61 * the core controller automatic port configuration engine. 62 */ 63 64#ifdef __cplusplus 65extern "C" { 66#endif // __cplusplus 67 68#include <dev/isci/scil/scic_sds_port.h> 69#include <dev/isci/scil/scic_sds_phy.h> 70 71struct SCIC_SDS_CONTROLLER; 72struct SCIC_SDS_PORT_CONFIGURATION_AGENT; 73struct SCIC_SDS_PORT; 74struct SCIC_SDS_PHY; 75 76typedef void (*SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T)( 77 struct SCIC_SDS_CONTROLLER *, 78 struct SCIC_SDS_PORT_CONFIGURATION_AGENT *, 79 struct SCIC_SDS_PORT *, 80 struct SCIC_SDS_PHY * 81); 82 83struct SCIC_SDS_PORT_RANGE 84{ 85 U8 min_index; 86 U8 max_index; 87}; 88 89typedef struct SCIC_SDS_PORT_CONFIGURATION_AGENT 90{ 91 U16 phy_configured_mask; 92 U16 phy_ready_mask; 93 94 struct SCIC_SDS_PORT_RANGE phy_valid_port_range[SCI_MAX_PHYS]; 95 96 BOOL timer_pending; 97 98 SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_up_handler; 99 SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_down_handler; 100 101 void *timer; 102 103} SCIC_SDS_PORT_CONFIGURATION_AGENT_T; 104 105void scic_sds_port_configuration_agent_construct( 106 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent 107); 108 109SCI_STATUS scic_sds_port_configuration_agent_initialize( 110 struct SCIC_SDS_CONTROLLER * controller, 111 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent 112); 113 114void scic_sds_port_configuration_agent_destroy( 115 struct SCIC_SDS_CONTROLLER * controller, 116 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent 117); 118 119void scic_sds_port_configuration_agent_release_resource( 120 struct SCIC_SDS_CONTROLLER * controller, 121 SCIC_SDS_PORT_CONFIGURATION_AGENT_T * port_agent 122); 123 124#ifdef __cplusplus 125} 126#endif // __cplusplus 127 128#endif // _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_ 129