xref: /freebsd/sys/dev/isci/scil/sati_log_sense.h (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
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 method declarations to translate
57  *        SCSI Log Sense command based of the SATv2 spec.
58  */
59 
60 #ifndef _SATI_LOG_SENSE_H_
61 #define _SATI_LOG_SENSE_H_
62 
63 #include <dev/isci/scil/intel_scsi.h>
64 #include <dev/isci/scil/sati_types.h>
65 #include <dev/isci/scil/sati_translator_sequence.h>
66 
67 #define SATI_LOG_SENSE_GET_PC_FIELD(cdb) \
68    (( sati_get_cdb_byte((cdb), 2) & SCSI_LOG_SENSE_PC_FIELD_MASK ) \
69    >> SCSI_LOG_SENSE_PC_FIELD_SHIFT )
70 
71 #define SATI_LOG_SENSE_GET_PAGE_CODE(cdb) \
72    (( sati_get_cdb_byte((cdb), 2) & SCSI_LOG_SENSE_PAGE_CODE_FIELD_MASK ) \
73    >> SCSI_LOG_SENSE_PAGE_CODE_FIELD_SHIFT )
74 
75 SATI_STATUS sati_log_sense_translate_command(
76    SATI_TRANSLATOR_SEQUENCE_T * sequence,
77    void                       * scsi_io,
78    void                       * ata_io
79 );
80 
81 SATI_STATUS sati_log_sense_translate_response(
82    SATI_TRANSLATOR_SEQUENCE_T * sequence,
83    void                       * scsi_io,
84    void                       * ata_io
85 );
86 #endif // _SATI_LOG_SENSE_H_
87 
88