xref: /freebsd/sys/dev/isci/scil/sati_abort_task_set.c (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
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  *
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.
51  */
52 
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55 
56 /**
57  * @file
58  *
59  * @brief This file contains the method implementations required to
60  *        translate the SCSI abort task set command.
61  */
62 
63 #if !defined(DISABLE_SATI_TASK_MANAGEMENT)
64 
65 #include <dev/isci/scil/sati_abort_task_set.h>
66 #include <dev/isci/scil/sati_callbacks.h>
67 #include <dev/isci/scil/sati_util.h>
68 #include <dev/isci/scil/sati.h>
69 #include <dev/isci/scil/intel_ata.h>
70 #include <dev/isci/scil/intel_scsi.h>
71 #include <dev/isci/scil/intel_sat.h>
72 
73 //******************************************************************************
74 //* P U B L I C   M E T H O D S
75 //******************************************************************************
76 
77 #if !defined(DISABLE_SATI_ABORT_TASK_SET)
78 
79 /**
80  * @brief This method will translate the abort task set SCSI task request into an
81  *        ATA READ LOG EXT command. For more information on the parameters
82  *        passed to this method, please reference sati_translate_command().
83  *
84  * @return Indicate if the command translation succeeded.
85  * @retval SCI_SUCCESS This is returned if the command translation was
86  *         successful.
87  */
88 SATI_STATUS sati_abort_task_set_translate_command(
89    SATI_TRANSLATOR_SEQUENCE_T * sequence,
90    void                       * scsi_io,
91    void                       * ata_io
92 )
93 {
94    U8 * register_fis;
95 
96    //ATA Read Log Ext with log address set to 0x10
97    sati_ata_read_log_ext_construct(
98       ata_io,
99       sequence,
100       ATA_LOG_PAGE_NCQ_ERROR,
101       sizeof(ATA_NCQ_COMMAND_ERROR_LOG_T)
102    );
103 
104    register_fis = sati_cb_get_h2d_register_fis_address(ata_io);
105    sati_set_sata_command_flag(register_fis);
106 
107    sequence->type                = SATI_SEQUENCE_ABORT_TASK_SET;
108    sequence->state               = SATI_SEQUENCE_STATE_AWAIT_RESPONSE;
109 
110    return SATI_SUCCESS;
111 }
112 
113 SATI_STATUS sati_abort_task_set_translate_data(
114    SATI_TRANSLATOR_SEQUENCE_T * sequence,
115    void                       * ata_input_data,
116    void                       * scsi_task
117 )
118 {
119    ATA_NCQ_COMMAND_ERROR_LOG_T * log =
120       (ATA_NCQ_COMMAND_ERROR_LOG_T *)ata_input_data;
121    U8 tag_index;
122 
123    sequence->state = SATI_SEQUENCE_STATE_TRANSLATE_DATA;
124 
125    for (tag_index = 0; tag_index < 32; tag_index++)
126    {
127       void *        matching_command;
128       SCI_IO_STATUS completion_status;
129       sati_cb_device_get_request_by_ncq_tag(
130          scsi_task,
131          tag_index,
132          matching_command
133       );
134 
135       if (matching_command != NULL)
136       {
137          if (
138               (log->ncq_tag == tag_index) &&
139               (log->nq == 0) // nq==1 means a non-queued command
140                              //  caused this failure
141             )
142          {
143             sati_translate_error(sequence, matching_command, log->error);
144             completion_status = SCI_IO_FAILURE_RESPONSE_VALID;
145 
146             if(sequence->state == SATI_SEQUENCE_STATE_READ_ERROR)
147             {
148                //Uncorrectable read error, return additional sense data
149                sati_scsi_read_ncq_error_sense_construct(
150                   sequence,
151                   matching_command,
152                   ata_input_data,
153                   SCSI_STATUS_CHECK_CONDITION,
154                   SCSI_SENSE_MEDIUM_ERROR,
155                   SCSI_ASC_UNRECOVERED_READ_ERROR,
156                   SCSI_ASCQ_UNRECOVERED_READ_ERROR
157                );
158             }
159          }
160          else
161          {
162             completion_status = SCI_IO_FAILURE_TERMINATED;
163          }
164 
165          sati_cb_io_request_complete(matching_command, completion_status);
166       }
167    }
168 
169    sequence->state = SATI_SEQUENCE_STATE_FINAL;
170 
171    return SATI_COMPLETE;
172 }
173 
174 #endif // !defined(DISABLE_SATI_ABORT_TASK_SET)
175 
176 #endif // !defined(DISABLE_SATI_TASK_MANAGEMENT)
177 
178