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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
54 #ifndef _SCIF_SAS_SMP_PHY_H_
55 #define _SCIF_SAS_SMP_PHY_H_
60 * @brief This file contains the protected interface structures, constants,
61 * and methods for the SCIF_SAS_SMP_PHY object.
68 #include <dev/isci/scil/scif_sas_remote_device.h>
69 #include <dev/isci/scil/sci_fast_list.h>
71 struct SCIF_SAS_CONTROLLER;
72 struct SCIF_SAS_SMP_PHY;
73 struct SCIF_SAS_REMOTE_DEVICE;
76 * @struct SCIF_SAS_SMP_PHY
78 * @brief This structure stores data for a smp phy of a smp device (expander).
80 typedef struct SCIF_SAS_SMP_PHY
83 * A smp phy can either connect to a end device or another smp phy,
84 * This two conditions are mutual exclusive.
88 * The attached smp phy. This field has valid meaning when
89 * attached_device_type is expander.
91 struct SCIF_SAS_SMP_PHY * attached_phy;
94 * The attached end device. This field has valid meaning when
95 * attached_device_type is end_device.
97 struct SCIF_SAS_REMOTE_DEVICE * end_device;
101 * This field records the owning expander device this smp phy belongs to.
103 struct SCIF_SAS_REMOTE_DEVICE * owning_device;
106 * The list element of this smp phy for the smp phy list of the ownig expander.
108 SCI_FAST_LIST_ELEMENT_T list_element;
111 * This field records the attached sas address, retrieved from a DISCOVER
112 * response. Zero value is valid.
114 SCI_SAS_ADDRESS_T attached_sas_address;
117 * This field records the attached device type, retrieved from a DISCOVER
120 U8 attached_device_type;
123 * This field records the routing attribute, retrieved from a DISCOVER
126 U8 routing_attribute;
129 * This field records the phy identifier of this smp phy, retrieved from a
135 * this field stores the last route index for previous round of config
136 * route table activity on a smp phy within one DISCOVER process.
138 U16 config_route_table_index_anchor;
143 void scif_sas_smp_phy_construct(
144 SCIF_SAS_SMP_PHY_T * this_smp_phy,
145 struct SCIF_SAS_REMOTE_DEVICE * owning_device,
149 void scif_sas_smp_phy_destruct(
150 SCIF_SAS_SMP_PHY_T * this_smp_phy
153 void scif_sas_smp_phy_save_information(
154 SCIF_SAS_SMP_PHY_T * this_smp_phy,
155 struct SCIF_SAS_REMOTE_DEVICE * attached_device,
156 SMP_RESPONSE_DISCOVER_T * discover_response
159 SCI_STATUS scif_sas_smp_phy_set_attached_phy(
160 SCIF_SAS_SMP_PHY_T * this_smp_phy,
161 U8 attached_phy_identifier,
162 struct SCIF_SAS_REMOTE_DEVICE * attached_remote_device
165 SCI_STATUS scif_sas_smp_phy_verify_routing_attribute(
166 SCIF_SAS_SMP_PHY_T * this_smp_phy,
167 SCIF_SAS_SMP_PHY_T * attached_smp_phy
170 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_next_phy_in_wide_port(
171 SCIF_SAS_SMP_PHY_T * this_smp_phy
174 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_middle_phy_in_wide_port(
175 SCIF_SAS_SMP_PHY_T * this_smp_phy
178 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_highest_phy_in_wide_port(
179 SCIF_SAS_SMP_PHY_T * this_smp_phy
184 #endif // __cplusplus
186 #endif // _SCIF_SAS_SMP_PHY_H_