xref: /freebsd/sys/dev/isci/scil/sati_report_luns.c (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 
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
57 
58 /**
59  * @file
60  * @brief This file contains the method implementations required to
61  *        translate the SCSI REPORT LUNS command.
62  */
63 
64 #if !defined(DISABLE_SATI_REPORT_LUNS)
65 
66 #include <dev/isci/scil/sati_report_luns.h>
67 #include <dev/isci/scil/sati_callbacks.h>
68 #include <dev/isci/scil/sati_util.h>
69 #include <dev/isci/scil/intel_ata.h>
70 #include <dev/isci/scil/intel_scsi.h>
71 
72 /**
73  * @brief This method will translate the REPORT LUN SCSI command.  This
74  *        command is immediately completed, since there is no applicable
75  *        ATA/ATAPI command.  The data payload is written and SATI_COMPLETE
76  *        is always returned.
77  *        For more information on the parameters passed to this method,
78  *        please reference sati_translate_command().
79  *
80  * @return This method always indicates the translation is complete.
81  * @retval SATI_COMPLETE This value is always returned.
82  */
83 SATI_STATUS sati_report_luns_translate_command(
84    SATI_TRANSLATOR_SEQUENCE_T * sequence,
85    void                       * scsi_io,
86    void                       * ata_io
87 )
88 {
89    U8 * cdb = sati_cb_get_cdb_address(scsi_io);
90 
91    // Set the data length based on the allocation length field in the CDB.
92    sequence->allocation_length = (sati_get_cdb_byte(cdb, 6) << 24) |
93                                  (sati_get_cdb_byte(cdb, 7) << 16) |
94                                  (sati_get_cdb_byte(cdb, 8) << 8)  |
95                                  (sati_get_cdb_byte(cdb, 9));
96 
97    // The first 4 bytes indicate the length of the LUN list.  Each
98    // LUN entry is 8 bytes.  There is only ever LUN 0 for ATA/ATAPI
99    // devices.  The value reported is: n-7, where n is the last byte
100    // offset (i.e. 15) in the REPORT LUN data.
101    sati_set_data_byte(sequence, scsi_io, 0, 0);
102    sati_set_data_byte(sequence, scsi_io, 1, 0);
103    sati_set_data_byte(sequence, scsi_io, 2, 0);
104    sati_set_data_byte(sequence, scsi_io, 3, 8);
105 
106    // Bytes 4-7 are reserved.
107    sati_set_data_byte(sequence, scsi_io, 4, 0);
108    sati_set_data_byte(sequence, scsi_io, 5, 0);
109    sati_set_data_byte(sequence, scsi_io, 6, 0);
110    sati_set_data_byte(sequence, scsi_io, 7, 0);
111 
112    // Add in our single LUN of zero.
113    sati_set_data_byte(sequence, scsi_io, 8, 0);
114    sati_set_data_byte(sequence, scsi_io, 9, 0);
115    sati_set_data_byte(sequence, scsi_io, 10, 0);
116    sati_set_data_byte(sequence, scsi_io, 11, 0);
117    sati_set_data_byte(sequence, scsi_io, 12, 0);
118    sati_set_data_byte(sequence, scsi_io, 13, 0);
119    sati_set_data_byte(sequence, scsi_io, 14, 0);
120    sati_set_data_byte(sequence, scsi_io, 15, 0);
121 
122    return SATI_COMPLETE;
123 }
124 
125 #endif // !defined(DISABLE_SATI_REPORT_LUNS)
126 
127