xref: /freebsd/sys/dev/isci/scil/intel_sat.h (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
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 - 2010 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 #ifndef _SAT_H_
55 #define _SAT_H_
56 
57 /**
58  * @file
59  * @brief This file contains constants and constructs defined in the SCSI
60  *        to ATA Translation (SAT) T10 standard.  For more information please
61  *        refer to www.t10.org.
62  */
63 
64 /**
65  * @name SAT_PROTOCOLS
66  *
67  * These constants indicate the various protocol values that can be supported
68  * in a SAT translator.
69  */
70 /*@{*/
71 #define SAT_PROTOCOL_ATA_HARD_RESET       0
72 #define SAT_PROTOCOL_SOFT_RESET           1
73 #define SAT_PROTOCOL_NON_DATA             3
74 #define SAT_PROTOCOL_PIO_DATA_IN          4
75 #define SAT_PROTOCOL_PIO_DATA_OUT         5
76 #define SAT_PROTOCOL_DMA                  6
77 #define SAT_PROTOCOL_DMA_QUEUED           7
78 #define SAT_PROTOCOL_DEVICE_DIAGNOSTIC    8
79 #define SAT_PROTOCOL_DEVICE_RESET         9
80 #define SAT_PROTOCOL_UDMA_DATA_IN         10
81 #define SAT_PROTOCOL_UDMA_DATA_OUT        11
82 #define SAT_PROTOCOL_FPDMA                12
83 #define SAT_PROTOCOL_RETURN_RESPONSE_INFO 15
84 
85 #define SAT_PROTOCOL_PACKET               0x10
86 #define SAT_PROTOCOL_PACKET_NON_DATA      (SAT_PROTOCOL_PACKET | 0x0)
87 #define SAT_PROTOCOL_PACKET_DMA_DATA_IN   (SAT_PROTOCOL_PACKET | 0x1)
88 #define SAT_PROTOCOL_PACKET_DMA_DATA_OUT  (SAT_PROTOCOL_PACKET | 0x2)
89 #define SAT_PROTOCOL_PACKET_PIO_DATA_IN   (SAT_PROTOCOL_PACKET | 0x3)
90 #define SAT_PROTOCOL_PACKET_PIO_DATA_OUT  (SAT_PROTOCOL_PACKET | 0x4)
91 /*@}*/
92 
93 #endif // _SAT_H_
94 
95