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