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