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 * @brief This file contains the method implementations for translating
59 *        the SCSI SYNCHRONIZE_CACHE (10, 16-byte) commands.
60 */
61
62#if !defined(DISABLE_SATI_SYNCHRONIZE_CACHE)
63
64#include <dev/isci/scil/sati_synchronize_cache.h>
65#include <dev/isci/scil/sati_callbacks.h>
66#include <dev/isci/scil/sati_util.h>
67#include <dev/isci/scil/sati_translator_sequence.h>
68
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 R I V A T E   M E T H O D S
75//******************************************************************************
76
77/**
78 * @brief This method performs the SCSI SYNCHRONIZE_CACHE 10 and 16 command translation
79 *        functionality common to all SYNCHRONIZE_CACHE command sizes.
80 *        This includes:
81 *        - setting the command register
82 *        - setting the device head register
83 *        - filling in fields in the SATI_TRANSLATOR_SEQUENCE object.
84 *        For more information on the parameters passed to this method,
85 *        please reference sati_translate_command().
86 *
87 * @return Indicate if the method was successfully completed.
88 * @retval SATI_SUCCESS This is returned in all other cases.
89 */
90SATI_STATUS sati_synchronize_cache_translate_command(
91   SATI_TRANSLATOR_SEQUENCE_T * sequence,
92   void                       * scsi_io,
93   void                       * ata_io
94)
95{
96   U8 * cdb          = sati_cb_get_cdb_address(scsi_io);
97   U8 * register_fis = sati_cb_get_h2d_register_fis_address(ata_io);
98
99   sequence->type           = SATI_SEQUENCE_SYNCHRONIZE_CACHE;
100   sequence->protocol       = SAT_PROTOCOL_NON_DATA;
101   sequence->data_direction = SATI_DATA_DIRECTION_NONE;
102
103   if (sati_get_cdb_byte(cdb, 1) & SCSI_SYNCHRONIZE_CACHE_IMMED_ENABLED)
104   {
105      //currently we ignore immed bit.
106      ;
107   }
108
109   // Ensure the device supports the 48 bit feature set.
110   if (sequence->device->capabilities & SATI_DEVICE_CAP_48BIT_ENABLE)
111      sati_set_ata_command(register_fis, ATA_FLUSH_CACHE_EXT);
112   else
113      sati_set_ata_command(register_fis, ATA_FLUSH_CACHE);
114
115   return SATI_SUCCESS;
116}
117
118#endif // !defined(DISABLE_SATI_SYNCHRONIZE_CACHE)
119
120