2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23 * The full GNU General Public License is included in this distribution
24 * in the file called LICENSE.GPL.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
35 * * Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * * Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in
39 * the documentation and/or other materials provided with the
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 #ifndef _SCIF_SAS_SMP_PHY_H_
57 #define _SCIF_SAS_SMP_PHY_H_
62 * @brief This file contains the protected interface structures, constants,
63 * and methods for the SCIF_SAS_SMP_PHY object.
70 #include <dev/isci/scil/scif_sas_remote_device.h>
71 #include <dev/isci/scil/sci_fast_list.h>
73 struct SCIF_SAS_CONTROLLER;
74 struct SCIF_SAS_SMP_PHY;
75 struct SCIF_SAS_REMOTE_DEVICE;
78 * @struct SCIF_SAS_SMP_PHY
80 * @brief This structure stores data for a smp phy of a smp device (expander).
82 typedef struct SCIF_SAS_SMP_PHY
85 * A smp phy can either connect to a end device or another smp phy,
86 * This two conditions are mutual exclusive.
90 * The attached smp phy. This field has valid meaning when
91 * attached_device_type is expander.
93 struct SCIF_SAS_SMP_PHY * attached_phy;
96 * The attached end device. This field has valid meaning when
97 * attached_device_type is end_device.
99 struct SCIF_SAS_REMOTE_DEVICE * end_device;
103 * This field records the owning expander device this smp phy belongs to.
105 struct SCIF_SAS_REMOTE_DEVICE * owning_device;
108 * The list element of this smp phy for the smp phy list of the ownig expander.
110 SCI_FAST_LIST_ELEMENT_T list_element;
113 * This field records the attached sas address, retrieved from a DISCOVER
114 * response. Zero value is valid.
116 SCI_SAS_ADDRESS_T attached_sas_address;
119 * This field records the attached device type, retrieved from a DISCOVER
122 U8 attached_device_type;
125 * This field records the routing attribute, retrieved from a DISCOVER
128 U8 routing_attribute;
131 * This field records the phy identifier of this smp phy, retrieved from a
137 * this field stores the last route index for previous round of config
138 * route table activity on a smp phy within one DISCOVER process.
140 U16 config_route_table_index_anchor;
145 void scif_sas_smp_phy_construct(
146 SCIF_SAS_SMP_PHY_T * this_smp_phy,
147 struct SCIF_SAS_REMOTE_DEVICE * owning_device,
151 void scif_sas_smp_phy_destruct(
152 SCIF_SAS_SMP_PHY_T * this_smp_phy
155 void scif_sas_smp_phy_save_information(
156 SCIF_SAS_SMP_PHY_T * this_smp_phy,
157 struct SCIF_SAS_REMOTE_DEVICE * attached_device,
158 SMP_RESPONSE_DISCOVER_T * discover_response
161 SCI_STATUS scif_sas_smp_phy_set_attached_phy(
162 SCIF_SAS_SMP_PHY_T * this_smp_phy,
163 U8 attached_phy_identifier,
164 struct SCIF_SAS_REMOTE_DEVICE * attached_remote_device
167 SCI_STATUS scif_sas_smp_phy_verify_routing_attribute(
168 SCIF_SAS_SMP_PHY_T * this_smp_phy,
169 SCIF_SAS_SMP_PHY_T * attached_smp_phy
172 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_next_phy_in_wide_port(
173 SCIF_SAS_SMP_PHY_T * this_smp_phy
176 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_middle_phy_in_wide_port(
177 SCIF_SAS_SMP_PHY_T * this_smp_phy
180 SCIF_SAS_SMP_PHY_T * scif_sas_smp_phy_find_highest_phy_in_wide_port(
181 SCIF_SAS_SMP_PHY_T * this_smp_phy
186 #endif // __cplusplus
188 #endif // _SCIF_SAS_SMP_PHY_H_