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 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 */
88SATI_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