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 * $FreeBSD$
53 */
54#ifndef _SATI_START_STOP_UNIT_H_
55#define _SATI_START_STOP_UNIT_H_
56
57/**
58 * @file
59 * @brief This file contains the method declarations and type definitions
60 *        required to translate the SCSI start_stop_unit commands.
61 */
62
63#include <dev/isci/scil/intel_scsi.h>
64#include <dev/isci/scil/sati_types.h>
65#include <dev/isci/scil/sati_translator_sequence.h>
66
67#define SATI_START_STOP_UNIT_POWER_CONDITION(cdb) \
68   (( sati_get_cdb_byte(cdb, 4) & SCSI_START_STOP_UNIT_POWER_CONDITION_MASK ) \
69    >> SCSI_START_STOP_UNIT_POWER_CONDITION_SHIFT)
70
71#define SATI_START_STOP_UNIT_START_BIT(cdb) \
72   (( sati_get_cdb_byte(cdb, 4) & SCSI_START_STOP_UNIT_START_BIT_MASK ) \
73    >> SCSI_START_STOP_UNIT_START_BIT_SHIFT)
74
75#define SATI_START_STOP_UNIT_LOEJ_BIT(cdb) \
76   (( sati_get_cdb_byte(cdb, 4) & SCSI_START_STOP_UNIT_LOEJ_BIT_MASK ) \
77    >> SCSI_START_STOP_UNIT_LOEJ_BIT_SHIFT)
78
79#define SATI_START_STOP_UNIT_NO_FLUSH_BIT(cdb) \
80   (( sati_get_cdb_byte(cdb, 4) & SCSI_START_STOP_UNIT_NO_FLUSH_MASK ) \
81    >> SCSI_START_STOP_UNIT_NO_FLUSH_SHIFT)
82
83#define SATI_START_STOP_UNIT_IMMED_BIT(cdb) \
84   (( sati_get_cdb_byte(cdb, 1) & SCSI_START_STOP_UNIT_IMMED_MASK ) \
85    >> SCSI_START_STOP_UNIT_IMMED_SHIFT)
86
87#define SATI_START_STOP_UNIT_POWER_CONDITION_MODIFIER(cdb) \
88   (( sati_get_cdb_byte(cdb, 3) & SCSI_START_STOP_UNIT_POWER_CONDITION_MODIFIER_MASK) \
89   >> SCSI_START_STOP_UNIT_POWER_CONDITION_MODIFIER_SHIFT)
90
91SATI_STATUS sati_start_stop_unit_translate_command(
92   SATI_TRANSLATOR_SEQUENCE_T * sequence,
93   void                       * scsi_io,
94   void                       * ata_io
95);
96
97SATI_STATUS sati_start_stop_unit_translate_response(
98   SATI_TRANSLATOR_SEQUENCE_T * sequence,
99   void                       * scsi_io,
100   void                       * ata_io
101);
102#endif // _SATI_START_STOP_UNIT_H_
103