xref: /freebsd/sys/dev/isci/scil/sati_inquiry.h (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
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 #ifndef _SATI_INQUIRY_H_
55 #define _SATI_INQUIRY_H_
56 
57 /**
58  * @file
59  *
60  * @brief This file contains the method prototypes required to
61  *        translate the SCSI inquiry command.
62  *        The following (VPD) pages are currently supported:
63  *        - Standard
64  *        - Supported Pages
65  *        - Unit Serial Number
66  *        - Device Identification
67  */
68 
69 #include <dev/isci/scil/sati_types.h>
70 #include <dev/isci/scil/sati_translator_sequence.h>
71 
72 void sati_inquiry_standard_translate_data(
73    SATI_TRANSLATOR_SEQUENCE_T * sequence,
74    void                       * ata_input_data,
75    void                       * scsi_io
76 );
77 
78 void sati_inquiry_serial_number_translate_data(
79    SATI_TRANSLATOR_SEQUENCE_T * sequence,
80    void                       * ata_input_data,
81    void                       * scsi_io
82 );
83 
84 void sati_inquiry_device_id_translate_data(
85    SATI_TRANSLATOR_SEQUENCE_T * sequence,
86    void                       * ata_input_data,
87    void                       * scsi_io
88 );
89 
90 void sati_inquiry_block_device_translate_data(
91    SATI_TRANSLATOR_SEQUENCE_T * sequence,
92    void                       * ata_input_data,
93    void                       * scsi_io
94 );
95 
96 SATI_STATUS sati_inquiry_ata_information_translate_data(
97    SATI_TRANSLATOR_SEQUENCE_T * sequence,
98    void                       * ata_input_data,
99    void                       * scsi_io
100 );
101 
102 SATI_STATUS sati_inquiry_translate_command(
103    SATI_TRANSLATOR_SEQUENCE_T * translator_sequence,
104    void                       * scsi_io,
105    void                       * ata_io
106 );
107 
108 void sati_inquiry_ata_information_finish_translation(
109    SATI_TRANSLATOR_SEQUENCE_T * sequence,
110    void                       * scsi_io,
111    void                       * ata_io
112 );
113 
114 #endif // _SATI_INQUIRY_H_
115