drivers/scsi/isci/core/scic_sds_port_configuration_agent.h

   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  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #ifndef _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_
  57 #define _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_
  58
  59 /**
  60  * This file contains the structures, constants and prototypes used for the
  61  *    core controller automatic port configuration engine.
  62  *
  63  *
  64  */
  65
  66 #include "scic_sds_port.h"
  67 #include "scic_sds_phy.h"
  68
  69 struct scic_sds_controller;
  70 struct scic_sds_port_configuration_agent;
  71 struct scic_sds_port;
  72 struct scic_sds_phy;
  73
  74 typedef void (*SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T)(
  75         struct scic_sds_controller *,
  76         struct scic_sds_port_configuration_agent *,
  77         struct scic_sds_port *,
  78         struct scic_sds_phy *
  79         );
  80
  81 struct SCIC_SDS_PORT_RANGE {
  82         u8 min_index;
  83         u8 max_index;
  84 };
  85
  86 struct scic_sds_port_configuration_agent {
  87         u16 phy_configured_mask;
  88         u16 phy_ready_mask;
  89
  90         struct SCIC_SDS_PORT_RANGE phy_valid_port_range[SCI_MAX_PHYS];
  91
  92         bool timer_pending;
  93
  94         SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_up_handler;
  95         SCIC_SDS_PORT_CONFIGURATION_AGENT_PHY_HANDLER_T link_down_handler;
  96
  97         void *timer;
  98
  99 };
 100
 101 void scic_sds_port_configuration_agent_construct(
 102         struct scic_sds_port_configuration_agent *port_agent);
 103
 104 enum sci_status scic_sds_port_configuration_agent_initialize(
 105         struct scic_sds_controller *controller,
 106         struct scic_sds_port_configuration_agent *port_agent);
 107
 108 #endif /* _SCIC_SDS_PORT_CONFIGURATION_AGENT_H_ */