isci: uplevel register hardware data structures and unsolicited frame handling
[linux-2.6.git] / drivers / scsi / isci / sata.c
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 #include <scsi/sas.h>
57 #include "isci.h"
58 #include "remote_device.h"
59 #include "scic_io_request.h"
60 #include "scic_task_request.h"
61 #include "task.h"
62 #include "request.h"
63 #include "sata.h"
64
65 /**
66  * isci_sata_task_to_fis_copy() - This function gets the host_to_dev_fis from
67  *    the core and copies the fis from the task into it.
68  * @task: This parameter is a pointer to the task struct from libsas.
69  *
70  * pointer to the host_to_dev_fis from the core request object.
71  */
72 struct host_to_dev_fis *isci_sata_task_to_fis_copy(struct sas_task *task)
73 {
74         struct isci_request *ireq = task->lldd_task;
75         struct host_to_dev_fis *fis = &ireq->sci.stp.cmd;
76
77         memcpy(fis, &task->ata_task.fis, sizeof(struct host_to_dev_fis));
78
79         if (!task->ata_task.device_control_reg_update)
80                 fis->flags |= 0x80;
81
82         fis->flags &= 0xF0;
83
84         return fis;
85 }
86
87 /**
88  * isci_sata_is_task_ncq() - This function determines if the given stp task is
89  *    a ncq request.
90  * @task: This parameter is a pointer to the task struct from libsas.
91  *
92  * true if the task is ncq
93  */
94 bool isci_sata_is_task_ncq(struct sas_task *task)
95 {
96         struct ata_queued_cmd *qc = task->uldd_task;
97
98         bool ret = (qc &&
99                     (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
100                      qc->tf.command == ATA_CMD_FPDMA_READ));
101
102         return ret;
103 }
104
105 /**
106  * isci_sata_set_ncq_tag() - This function sets the ncq tag field in the
107  *    host_to_dev_fis equal to the tag in the queue command in the task.
108  * @task: This parameter is a pointer to the task struct from libsas.
109  * @register_fis: This parameter is a pointer to the host_to_dev_fis from the
110  *    core request object.
111  *
112  */
113 void isci_sata_set_ncq_tag(
114         struct host_to_dev_fis *register_fis,
115         struct sas_task *task)
116 {
117         struct ata_queued_cmd *qc = task->uldd_task;
118         struct isci_request *request = task->lldd_task;
119
120         register_fis->sector_count = qc->tag << 3;
121         scic_stp_io_request_set_ncq_tag(&request->sci, qc->tag);
122 }
123
124 /**
125  * isci_request_process_stp_response() - This function sets the status and
126  *    response, in the task struct, from the request object for the upper layer
127  *    driver.
128  * @sas_task: This parameter is the task struct from the upper layer driver.
129  * @response_buffer: This parameter points to the response of the completed
130  *    request.
131  *
132  * none.
133  */
134 void isci_request_process_stp_response(struct sas_task *task,
135                                        void *response_buffer)
136 {
137         struct dev_to_host_fis *d2h_reg_fis = response_buffer;
138         struct task_status_struct *ts = &task->task_status;
139         struct ata_task_resp *resp = (void *)&ts->buf[0];
140
141         resp->frame_len = le16_to_cpu(*(__le16 *)(response_buffer + 6));
142         memcpy(&resp->ending_fis[0], response_buffer + 16, 24);
143         ts->buf_valid_size = sizeof(*resp);
144
145         /**
146          * If the device fault bit is set in the status register, then
147          * set the sense data and return.
148          */
149         if (d2h_reg_fis->status & ATA_DF)
150                 ts->stat = SAS_PROTO_RESPONSE;
151         else
152                 ts->stat = SAM_STAT_GOOD;
153
154         ts->resp = SAS_TASK_COMPLETE;
155 }
156
157 enum sci_status isci_sata_management_task_request_build(struct isci_request *ireq)
158 {
159         struct scic_sds_request *sci_req = &ireq->sci;
160         struct isci_tmf *isci_tmf;
161         enum sci_status status;
162
163         if (tmf_task != ireq->ttype)
164                 return SCI_FAILURE;
165
166         isci_tmf = isci_request_access_tmf(ireq);
167
168         switch (isci_tmf->tmf_code) {
169
170         case isci_tmf_sata_srst_high:
171         case isci_tmf_sata_srst_low: {
172                 struct host_to_dev_fis *fis = &sci_req->stp.cmd;
173
174                 memset(fis, 0, sizeof(*fis));
175
176                 fis->fis_type  =  0x27;
177                 fis->flags     &= ~0x80;
178                 fis->flags     &= 0xF0;
179                 if (isci_tmf->tmf_code == isci_tmf_sata_srst_high)
180                         fis->control |= ATA_SRST;
181                 else
182                         fis->control &= ~ATA_SRST;
183                 break;
184         }
185         /* other management commnd go here... */
186         default:
187                 return SCI_FAILURE;
188         }
189
190         /* core builds the protocol specific request
191          *  based on the h2d fis.
192          */
193         status = scic_task_request_construct_sata(&ireq->sci);
194
195         return status;
196 }
197
198 /**
199  * isci_task_send_lu_reset_sata() - This function is called by of the SAS
200  *    Domain Template functions. This is one of the Task Management functoins
201  *    called by libsas, to reset the given SAS lun. Note the assumption that
202  *    while this call is executing, no I/O will be sent by the host to the
203  *    device.
204  * @lun: This parameter specifies the lun to be reset.
205  *
206  * status, zero indicates success.
207  */
208 int isci_task_send_lu_reset_sata(
209         struct isci_host *isci_host,
210         struct isci_remote_device *isci_device,
211         u8 *lun)
212 {
213         struct isci_tmf tmf;
214         int ret = TMF_RESP_FUNC_FAILED;
215
216         /* Send the soft reset to the target */
217         #define ISCI_SRST_TIMEOUT_MS 25000 /* 25 second timeout. */
218         isci_task_build_tmf(&tmf, isci_device, isci_tmf_sata_srst_high,
219                             NULL, NULL
220                             );
221
222         ret = isci_task_execute_tmf(isci_host, &tmf, ISCI_SRST_TIMEOUT_MS);
223
224         if (ret != TMF_RESP_FUNC_COMPLETE) {
225                 dev_warn(&isci_host->pdev->dev,
226                          "%s: Assert SRST failed (%p) = %x",
227                          __func__,
228                          isci_device,
229                          ret);
230
231                 /* Return the failure so that the LUN reset is escalated
232                  * to a target reset.
233                  */
234         }
235         return ret;
236 }