xref: /freebsd/sys/dev/isci/scil/sati_lun_reset.c (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
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 /**
57  * @file
58  *
59  * @brief This file contains the method implementations required to
60  *        translate the SCSI lun reset command.
61  */
62 
63 #if !defined(DISABLE_SATI_TASK_MANAGEMENT)
64 
65 #include <dev/isci/scil/sati_lun_reset.h>
66 #include <dev/isci/scil/sati_callbacks.h>
67 #include <dev/isci/scil/sati_util.h>
68 #include <dev/isci/scil/intel_ata.h>
69 #include <dev/isci/scil/intel_scsi.h>
70 #include <dev/isci/scil/intel_sat.h>
71 
72 //******************************************************************************
73 //* P U B L I C   M E T H O D S
74 //******************************************************************************
75 
76 /**
77  * @brief This method will translate the lun reset SCSI task request into an
78  *        ATA SOFT RESET command. For more information on the parameters
79  *        passed to this method, please reference sati_translate_command().
80  *
81  * @return Indicate if the command translation succeeded.
82  * @retval SCI_SUCCESS This is returned if the command translation was
83  *         successful.
84  *
85  * @note It is up to the user of the sata translator to set the command bit
86  *       and clear the control softreset bit and send the second register fis.
87  */
88 SATI_STATUS sati_lun_reset_translate_command(
89    SATI_TRANSLATOR_SEQUENCE_T * sequence,
90    void                       * scsi_io,
91    void                       * ata_io
92 )
93 {
94    U8* register_fis = sati_cb_get_h2d_register_fis_address(ata_io);
95 
96    sati_set_ata_command(register_fis, ATA_NOP);
97    sati_set_ata_control(register_fis, ATA_CONTROL_REG_SOFT_RESET_BIT);
98 
99    //set all other fields to zero.
100    sati_clear_sata_command_flag(register_fis);
101    sati_set_ata_features(register_fis, 0);
102    sati_set_ata_features_exp(register_fis, 0);
103    sati_set_ata_sector_count(register_fis, 0);
104    sati_set_ata_sector_count_exp(register_fis, 0);
105    sati_set_ata_lba_low(register_fis, 0);
106    sati_set_ata_lba_mid(register_fis, 0);
107    sati_set_ata_lba_high(register_fis, 0);
108    sati_set_ata_lba_low_exp(register_fis, 0);
109    sati_set_ata_lba_mid_exp(register_fis, 0);
110    sati_set_ata_lba_high_exp(register_fis, 0);
111    sati_set_ata_device_head(register_fis, 0);
112 
113    sequence->type                = SATI_SEQUENCE_LUN_RESET;
114    sequence->data_direction      = SATI_DATA_DIRECTION_NONE;
115    sequence->protocol            = SAT_PROTOCOL_SOFT_RESET;
116    sequence->ata_transfer_length = 0;
117 
118    return SATI_SUCCESS;
119 }
120 
121 #endif // !defined(DISABLE_SATI_TASK_MANAGEMENT)
122 
123