xref: /freebsd/sys/dev/isci/scil/sati_mode_sense.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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_MODE_SENSE_H_
55 #define _SATI_MODE_SENSE_H_
56 
57 /**
58  * @file
59  * @brief This file contains the method declarations and type defintions
60  *        common to translations of the SCSI mode sense (6 and 10-byte)
61  *        commands.
62  */
63 
64 #include <dev/isci/scil/sati_types.h>
65 #include <dev/isci/scil/sati_translator_sequence.h>
66 #include <dev/isci/scil/intel_ata.h>
67 
68 U16 sati_mode_sense_calculate_page_header(
69    void * scsi_io,
70    U8     cdb_size
71 );
72 
73 SATI_STATUS sati_mode_sense_translate_command(
74    SATI_TRANSLATOR_SEQUENCE_T * sequence,
75    void                       * scsi_io,
76    void                       * ata_io,
77    U8                           cdb_length
78 );
79 
80 U32 sati_mode_sense_build_std_block_descriptor(
81    SATI_TRANSLATOR_SEQUENCE_T * sequence,
82    void                       * scsi_io,
83    ATA_IDENTIFY_DEVICE_DATA_T * identify,
84    U32                          offset
85 );
86 
87 U32 sati_mode_sense_copy_initial_data(
88    SATI_TRANSLATOR_SEQUENCE_T * sequence,
89    void                       * scsi_io,
90    U32                          page_start,
91    U8                           page_control,
92    U8                           page_code
93 );
94 
95 U32 sati_mode_sense_caching_translate_data(
96    SATI_TRANSLATOR_SEQUENCE_T * sequence,
97    void                       * scsi_io,
98    ATA_IDENTIFY_DEVICE_DATA_T * identify,
99    U32                          offset
100 );
101 
102 U32 sati_mode_sense_informational_excp_control_translate_data(
103    SATI_TRANSLATOR_SEQUENCE_T * sequence,
104    void                       * scsi_io,
105    ATA_IDENTIFY_DEVICE_DATA_T * identify,
106    U32                          offset
107 );
108 
109 U32 sati_mode_sense_all_pages_translate_data(
110    SATI_TRANSLATOR_SEQUENCE_T * sequence,
111    void                       * scsi_io,
112    ATA_IDENTIFY_DEVICE_DATA_T * identify,
113    U32                          offset
114 );
115 
116 U32 sati_mode_sense_read_write_error_translate_data(
117    SATI_TRANSLATOR_SEQUENCE_T * sequence,
118    void                       * scsi_io,
119    ATA_IDENTIFY_DEVICE_DATA_T * identify,
120    U32                          offset
121 );
122 
123 U32 sati_mode_sense_control_translate_data(
124    SATI_TRANSLATOR_SEQUENCE_T * sequence,
125    void                       * scsi_io,
126    ATA_IDENTIFY_DEVICE_DATA_T * identify,
127    U32                          offset
128 );
129 
130 U32 sati_mode_sense_disconnect_reconnect_translate_data(
131    SATI_TRANSLATOR_SEQUENCE_T * sequence,
132    void                       * scsi_io,
133    ATA_IDENTIFY_DEVICE_DATA_T * identify,
134    U32                          offset
135 );
136 
137 U32 sati_mode_sense_power_condition_translate_data(
138    SATI_TRANSLATOR_SEQUENCE_T * sequence,
139    void                       * scsi_io,
140    ATA_IDENTIFY_DEVICE_DATA_T * identify,
141    U32                          offset
142 );
143 
144 
145 #endif // _SATI_MODE_SENSE_H_
146 
147