xref: /freebsd/sys/dev/isci/scil/sati_mode_pages.h (revision ca987d4641cdcd7f27e153db17c5bf064934faf5)
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 /**
55  * @file
56  * @brief This file contains the mode page constants and members that are
57  *        supported by this translation implementation.
58  */
59 
60 #include <dev/isci/scil/sati_types.h>
61 
62 // These values represent the mode page (not including header and block
63 // descriptor).  The page length fields in the mode sense data are equivalent
64 // to the constant values below less 2.  The minus 2 is due to not including
65 // the page code byte (byte 0) and the page length byte (byte 1).
66 #define SCSI_MODE_PAGE_01_LENGTH   0x0C
67 #define SCSI_MODE_PAGE_02_LENGTH   0x10
68 #define SCSI_MODE_PAGE_08_LENGTH   0x14
69 #define SCSI_MODE_PAGE_0A_LENGTH   0x0C
70 #define SCSI_MODE_PAGE_19_LENGTH   0x8
71 #define SCSI_MODE_PAGE_1A_LENGTH   0x0C
72 #define SCSI_MODE_PAGE_1C_LENGTH   0x0C
73 #define SCSI_MODE_PAGE_3F_LENGTH   SCSI_MODE_PAGE_08_LENGTH    \
74                                    + SCSI_MODE_PAGE_1C_LENGTH  \
75 
76 #define SATI_MODE_PAGE_UNSUPPORTED_INDEX 0xFFFF
77 
78 #define SAT_SUPPORTED_MODE_PAGES_LENGTH sizeof(sat_supported_mode_pages)/sizeof(U8)
79 
80 typedef enum _RETURN_PAGE{
81    CHANGEABLE_PAGE,
82    DEFAULT_PAGE
83 }RETURN_PAGE;
84 
85 
86 /**
87  * @struct SCSI_MODE_SELECT_MODE_PARAMETER_HEADER_6
88  *
89  * @brief This structure contains mode parameter header fields for 6 byte
90  *        mode select command.
91  */
92 typedef  struct SCSI_MODE_SELECT_MODE_PARAMETER_HEADER_6
93 {
94    U8 mode_data_length;
95    U8 medium_type; //Should be 0
96    U8 device_specific_parameter;
97    U8 block_descriptor_length;
98 
99 }SCSI_MODE_SELECT_MODE_PARAMETER_HEADER_6_T;
100 
101 /**
102  * @struct MODE_PARAMETER_HEADER_10
103  *
104  * @brief This structure contains mode parameter header fields for 10 byte
105  *        mode select command.
106  */
107 typedef struct SCSI_MODE_SELECT_MODE_PARAMETER_HEADER_10
108 {
109    U8 mode_data_length[2];
110    U8 medium_type; //Should be 0
111    U8 device_specific_parameter;
112    U8 long_lba;
113    U8 reserve;
114    U8 block_descriptor_length[2];
115 
116 }SCSI_MODE_SELECT_MODE_PARAMETER_HEADER_10_T;
117 
118 /**
119  * @struct MODE_PARAMETER_BLOCK_DESCRIPTOR
120  *
121  * @brief This structure contains mode parameter block descriptor fields.
122  */
123 typedef struct SCSI_MODE_SELECT_MODE_PARAMETER_BLOCK_DESCRIPTOR
124 {
125    U8 density_code;
126    U8 number_of_blocks[3];
127    U8 reserved;
128    U8 block_length[3];
129 
130 }SCSI_MODE_SELECT_MODE_PARAMETER_BLOCK_DESCRIPTOR_T;
131 
132 U16 sati_mode_page_get_page_index(
133    U8  page_code
134 );
135 
136 U8 * sati_mode_page_get_mode_page(
137    U8 page_code,
138    RETURN_PAGE page
139 );
140 
141 extern U8 * sat_changeable_mode_pages[];
142 extern U8 * sat_default_mode_pages[];
143 extern U16  sat_mode_page_sizes[];
144 
145