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