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
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.
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.
57 * This file contains the isci port implementation.
63 #include <linux/workqueue.h>
65 #include "scic_io_request.h"
66 #include "scic_remote_device.h"
68 #include "scic_sds_phy.h"
69 #include "scic_port.h"
73 static void isci_port_change_state(
74 struct isci_port *isci_port,
75 enum isci_status status);
80 * isci_port_init() - This function initializes the given isci_port object.
81 * @isci_port: This parameter specifies the port object to be initialized.
82 * @isci_host: This parameter specifies parent controller object for the port.
83 * @index: This parameter specifies which SCU port the isci_port associates
84 * with. Generally, SCU port 0 relates to isci_port 0, etc.
88 struct isci_port *isci_port,
89 struct isci_host *isci_host,
92 struct scic_sds_port *scic_port;
93 struct scic_sds_controller *controller = isci_host->core_controller;
95 INIT_LIST_HEAD(&isci_port->remote_dev_list);
96 INIT_LIST_HEAD(&isci_port->domain_dev_list);
97 spin_lock_init(&isci_port->state_lock);
98 init_completion(&isci_port->start_complete);
99 isci_port->isci_host = isci_host;
100 isci_port_change_state(isci_port, isci_freed);
102 (void)scic_controller_get_port_handle(controller, index, &scic_port);
103 sci_object_set_association(scic_port, isci_port);
104 isci_port->sci_port_handle = scic_port;
109 * isci_port_get_state() - This function gets the status of the port object.
110 * @isci_port: This parameter points to the isci_port object
112 * status of the object as a isci_status enum.
114 enum isci_status isci_port_get_state(
115 struct isci_port *isci_port)
117 return isci_port->status;
120 static void isci_port_change_state(
121 struct isci_port *isci_port,
122 enum isci_status status)
126 dev_dbg(&isci_port->isci_host->pdev->dev,
127 "%s: isci_port = %p, state = 0x%x\n",
128 __func__, isci_port, status);
130 spin_lock_irqsave(&isci_port->state_lock, flags);
131 isci_port->status = status;
132 spin_unlock_irqrestore(&isci_port->state_lock, flags);
135 void isci_port_bc_change_received(
136 struct isci_host *isci_host,
137 struct scic_sds_port *port,
138 struct scic_sds_phy *phy)
140 struct isci_phy *isci_phy =
141 (struct isci_phy *)sci_object_get_association(phy);
143 dev_dbg(&isci_host->pdev->dev,
144 "%s: isci_phy = %p, sas_phy = %p\n",
149 isci_host->sas_ha.notify_port_event(
154 scic_port_enable_broadcast_change_notification(port);
158 * isci_port_link_up() - This function is called by the sci core when a link
159 * becomes active. the identify address frame is retrieved from the core and
160 * a notify port event is sent to libsas.
161 * @isci_host: This parameter specifies the isci host object.
162 * @port: This parameter specifies the sci port with the active link.
163 * @phy: This parameter specifies the sci phy with the active link.
166 void isci_port_link_up(
167 struct isci_host *isci_host,
168 struct scic_sds_port *port,
169 struct scic_sds_phy *phy)
172 struct scic_port_properties properties;
173 struct isci_phy *isci_phy
174 = (struct isci_phy *)sci_object_get_association(phy);
175 struct isci_port *isci_port
176 = (struct isci_port *)sci_object_get_association(port);
177 enum sci_status call_status;
178 unsigned long success = true;
180 BUG_ON(isci_phy->isci_port != NULL);
182 isci_phy->isci_port = isci_port;
184 dev_dbg(&isci_host->pdev->dev,
185 "%s: isci_port = %p\n",
186 __func__, isci_port);
188 spin_lock_irqsave(&isci_phy->sas_phy.frame_rcvd_lock, flags);
190 isci_port_change_state(isci_phy->isci_port, isci_starting);
192 scic_port_get_properties(port, &properties);
194 if (properties.remote.protocols.u.bits.stp_target) {
195 u64 attached_sas_address;
197 struct scic_sata_phy_properties sata_phy_properties;
199 isci_phy->sas_phy.oob_mode = SATA_OOB_MODE;
201 /* Get a copy of the signature fis for libsas */
202 call_status = scic_sata_phy_get_properties(phy,
203 &sata_phy_properties);
206 * XXX I am concerned about this "assert". shouldn't we
207 * handle the return appropriately?
209 BUG_ON(call_status != SCI_SUCCESS);
211 memcpy(isci_phy->frame_rcvd.fis,
212 &sata_phy_properties.signature_fis,
213 sizeof(struct sata_fis_reg_d2h));
215 isci_phy->sas_phy.frame_rcvd_size = sizeof(struct sata_fis_reg_d2h);
218 * For direct-attached SATA devices, the SCI core will
219 * automagically assign a SAS address to the end device
220 * for the purpose of creating a port. This SAS address
221 * will not be the same as assigned to the PHY and needs
222 * to be obtained from struct scic_port_properties properties.
224 attached_sas_address = properties.remote.sas_address.high;
225 attached_sas_address <<= 32;
226 attached_sas_address |= properties.remote.sas_address.low;
227 swab64s(&attached_sas_address);
229 memcpy(&isci_phy->sas_phy.attached_sas_addr,
230 &attached_sas_address, sizeof(attached_sas_address));
232 } else if (properties.remote.protocols.u.bits.ssp_target ||
233 properties.remote.protocols.u.bits.smp_target) {
235 struct scic_sas_phy_properties sas_phy_properties;
237 isci_phy->sas_phy.oob_mode = SAS_OOB_MODE;
239 /* Get a copy of the identify address frame for libsas */
240 call_status = scic_sas_phy_get_properties(phy,
241 &sas_phy_properties);
243 BUG_ON(call_status != SCI_SUCCESS);
245 memcpy(isci_phy->frame_rcvd.aif,
246 &(sas_phy_properties.received_iaf),
247 sizeof(struct sci_sas_identify_address_frame));
249 isci_phy->sas_phy.frame_rcvd_size
250 = sizeof(struct sci_sas_identify_address_frame);
252 /* Copy the attached SAS address from the IAF */
253 memcpy(isci_phy->sas_phy.attached_sas_addr,
254 ((struct sas_identify_frame *)
255 (&isci_phy->frame_rcvd.aif))->sas_addr,
259 dev_err(&isci_host->pdev->dev, "%s: unkown target\n", __func__);
263 isci_phy->sas_phy.phy->negotiated_linkrate = sci_phy_linkrate(phy);
265 spin_unlock_irqrestore(&isci_phy->sas_phy.frame_rcvd_lock, flags);
267 /* Notify libsas that we have an address frame, if indeed
268 * we've found an SSP, SMP, or STP target */
270 isci_host->sas_ha.notify_port_event(&isci_phy->sas_phy,
276 * isci_port_link_down() - This function is called by the sci core when a link
278 * @isci_host: This parameter specifies the isci host object.
279 * @phy: This parameter specifies the isci phy with the active link.
280 * @port: This parameter specifies the isci port with the active link.
283 void isci_port_link_down(struct isci_host *isci_host, struct isci_phy *isci_phy,
284 struct isci_port *isci_port)
286 struct isci_remote_device *isci_device;
288 dev_dbg(&isci_host->pdev->dev,
289 "%s: isci_port = %p\n", __func__, isci_port);
293 /* check to see if this is the last phy on this port. */
294 if (isci_phy->sas_phy.port
295 && isci_phy->sas_phy.port->num_phys == 1) {
297 /* change the state for all devices on this port.
298 * The next task sent to this device will be returned
299 * as SAS_TASK_UNDELIVERED, and the scsi mid layer
300 * will remove the target
302 list_for_each_entry(isci_device,
303 &isci_port->remote_dev_list,
305 dev_dbg(&isci_host->pdev->dev,
306 "%s: isci_device = %p\n",
307 __func__, isci_device);
308 isci_remote_device_change_state(isci_device,
312 isci_port_change_state(isci_port, isci_stopping);
315 /* Notify libsas of the borken link, this will trigger calls to our
316 * isci_port_deformed and isci_dev_gone functions.
318 sas_phy_disconnected(&isci_phy->sas_phy);
319 isci_host->sas_ha.notify_phy_event(&isci_phy->sas_phy,
320 PHYE_LOSS_OF_SIGNAL);
322 isci_phy->isci_port = NULL;
324 dev_dbg(&isci_host->pdev->dev,
325 "%s: isci_port = %p - Done\n", __func__, isci_port);
330 * isci_port_deformed() - This function is called by libsas when a port becomes
332 * @phy: This parameter specifies the libsas phy with the inactive port.
335 void isci_port_deformed(
336 struct asd_sas_phy *phy)
338 pr_debug("%s: sas_phy = %p\n", __func__, phy);
342 * isci_port_formed() - This function is called by libsas when a port becomes
344 * @phy: This parameter specifies the libsas phy with the active port.
347 void isci_port_formed(
348 struct asd_sas_phy *phy)
350 pr_debug("%s: sas_phy = %p, sas_port = %p\n", __func__, phy, phy->port);
354 * isci_port_ready() - This function is called by the sci core when a link
356 * @isci_host: This parameter specifies the isci host object.
357 * @port: This parameter specifies the sci port with the active link.
360 void isci_port_ready(struct isci_host *isci_host, struct isci_port *isci_port)
362 dev_dbg(&isci_host->pdev->dev,
363 "%s: isci_port = %p\n", __func__, isci_port);
365 complete_all(&isci_port->start_complete);
366 isci_port_change_state(isci_port, isci_ready);
371 * isci_port_not_ready() - This function is called by the sci core when a link
372 * is not ready. All remote devices on this link will be removed if they are
373 * in the stopping state.
374 * @isci_host: This parameter specifies the isci host object.
375 * @port: This parameter specifies the sci port with the active link.
378 void isci_port_not_ready(struct isci_host *isci_host, struct isci_port *isci_port)
380 dev_dbg(&isci_host->pdev->dev,
381 "%s: isci_port = %p\n", __func__, isci_port);
385 * isci_port_hard_reset_complete() - This function is called by the sci core
386 * when the hard reset complete notification has been received.
387 * @port: This parameter specifies the sci port with the active link.
388 * @completion_status: This parameter specifies the core status for the reset
392 void isci_port_hard_reset_complete(struct isci_port *isci_port,
393 enum sci_status completion_status)
395 dev_dbg(&isci_port->isci_host->pdev->dev,
396 "%s: isci_port = %p, completion_status=%x\n",
397 __func__, isci_port, completion_status);
399 /* Save the status of the hard reset from the port. */
400 isci_port->hard_reset_status = completion_status;
402 complete_all(&isci_port->hard_reset_complete);
405 int isci_port_perform_hard_reset(struct isci_host *ihost, struct isci_port *iport,
406 struct isci_phy *iphy)
409 enum sci_status status;
410 int ret = TMF_RESP_FUNC_COMPLETE;
412 dev_dbg(&ihost->pdev->dev, "%s: iport = %p\n",
415 init_completion(&iport->hard_reset_complete);
417 spin_lock_irqsave(&ihost->scic_lock, flags);
419 #define ISCI_PORT_RESET_TIMEOUT SCIC_SDS_SIGNATURE_FIS_TIMEOUT
420 status = scic_port_hard_reset(iport->sci_port_handle,
421 ISCI_PORT_RESET_TIMEOUT);
423 spin_unlock_irqrestore(&ihost->scic_lock, flags);
425 if (status == SCI_SUCCESS) {
426 wait_for_completion(&iport->hard_reset_complete);
428 dev_dbg(&ihost->pdev->dev,
429 "%s: iport = %p; hard reset completion\n",
432 if (iport->hard_reset_status != SCI_SUCCESS)
433 ret = TMF_RESP_FUNC_FAILED;
435 ret = TMF_RESP_FUNC_FAILED;
437 dev_err(&ihost->pdev->dev,
438 "%s: iport = %p; scic_port_hard_reset call"
440 __func__, iport, status);
444 /* If the hard reset for the port has failed, consider this
445 * the same as link failures on all phys in the port.
447 if (ret != TMF_RESP_FUNC_COMPLETE) {
448 dev_err(&ihost->pdev->dev,
449 "%s: iport = %p; hard reset failed "
450 "(0x%x) - sending link down to libsas for phy %p\n",
451 __func__, iport, iport->hard_reset_status, iphy);
453 isci_port_link_down(ihost, iphy, iport);
460 * isci_port_invalid_link_up() - This function informs the SCI Core user that
461 * a phy/link became ready, but the phy is not allowed in the port. In some
462 * situations the underlying hardware only allows for certain phy to port
463 * mappings. If these mappings are violated, then this API is invoked.
464 * @controller: This parameter represents the controller which contains the
466 * @port: This parameter specifies the SCI port object for which the callback
468 * @phy: This parameter specifies the phy that came ready, but the phy can't be
469 * a valid member of the port.
472 void isci_port_invalid_link_up(struct scic_sds_controller *scic,
473 struct scic_sds_port *sci_port,
474 struct scic_sds_phy *phy)
476 struct isci_host *ihost = sci_object_get_association(scic);
478 dev_warn(&ihost->pdev->dev, "Invalid link up!\n");
481 void isci_port_stop_complete(struct scic_sds_controller *scic,
482 struct scic_sds_port *sci_port,
483 enum sci_status completion_status)
485 struct isci_host *ihost = sci_object_get_association(scic);
487 dev_dbg(&ihost->pdev->dev, "Port stop complete\n");