8212 manpages contain obsolete references
[unleashed.git] / usr / src / man / man7d / sata.7d
blob558d273d6e704d4fc2c6739cff1796cc2efe34ee
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SATA 7D "May 13, 2017"
7 .SH NAME
8 sata \- Solaris SATA framework
9 .SH DESCRIPTION
10 .LP
11 Serial ATA is an interconnect technology designed to replace parallel ATA
12 technology. It is used to connect hard drives, optical drives, removable
13 magnetic media devices and other peripherals to the host system. For complete
14 information on Serial ATA technology, visit the Serial ATA web site at
15 http://\fIwww.serialata.org\fR.
16 .sp
17 .LP
18 Up to 32 SATA devices may be plugged directly to each SATA HBA and up to 15
19 SATA devices may be plugged directly to each SATA port multiplier supported by
20 the Solaris SATA framework. The actual number of pluggable devices may be lower,
21 and is limited by the number of device ports on the SATA HBA or the SATA port
22 multiplier. The maximum data rate is either 1.5Gb/sec. or 3.0Gb/sec., depending
23 on the capability of a SATA device, port multiplier and SATA HBA controller.
24 .sp
25 .LP
26 The Solaris SATA framework adheres to the \fISerial ATA 1.0a\fR specification
27 and supports SATA-2 signaling speed 3.0Gb/sec. SATA devices that are connected
28 to SATA HBAs controlled by a SATA framework-compliant HBA driver are treated by
29 the system as SCSI devices. The Solaris SCSI disk driver (\fBsd\fR(7D)) is
30 attached as a target driver for each device node created by the SATA framework.
31 You can use the \fBcfgadm\fR(1M) utility to manage hot plugged and unplugged
32 SATA devices.
33 .SH FILES
34 .ne 2
35 .na
36 \fB\fB/kernel/misc/sata\fR\fR
37 .ad
38 .RS 27n
39 32-bit \fBELF\fR kernel module (x86).
40 .RE
42 .sp
43 .ne 2
44 .na
45 \fB\fB/kernel/misc/amd64/sata\fR\fR
46 .ad
47 .RS 27n
48 64-bit \fBELF\fR kernel module (x86).
49 .RE
51 .SH ATTRIBUTES
52 .LP
53 See \fBattributes\fR(5) for descriptions of the following attribute:
54 .sp
56 .sp
57 .TS
58 box;
59 c | c
60 l | l .
61 ATTRIBUTE TYPE  ATTRIBUTE VALUE
63 Architecture    x86
64 .TE
66 .SH SEE ALSO
67 .LP
68 \fBcfgadm\fR(1M), \fBprtconf\fR(1M), \fBcfgadm_sata\fR(1M),
69 \fBattributes\fR(5), \fBahci\fR(7D), \fBnv_sata\fR(7D),
70 \fBsd\fR(7D), \fBsi3124\fR(7D)
71 .sp
72 .LP
73 \fISerial ATA 1.0a Specification\fR \(em Serial ATA International Organization.
74 .sp
75 .LP
76 \fISerial ATA II (Extension to Serial ATA 1.0.a.)\fR \(em Serial ATA
77 International Organization.
78 .SH DIAGNOSTICS
79 .LP
80 The messages described below may appear on the system console as well as being
81 logged. All messages are presented in one of the following formats and are
82 followed by the diagnostic message:
83 .sp
84 .in +2
85 .nf
86 sata: WARNING: <\fBcontroller/devices/.. path\fR>:
87 .fi
88 .in -2
89 .sp
91 .sp
92 .LP
93 or:
94 .sp
95 .in +2
96 .nf
97 sata: NOTICE: <\fBcontroller/devices/.. path\fR>:
98 .fi
99 .in -2
104 \&...where <\fBcontroller/devices/.. path\fR> identifies a specific SATA HBA
105 issuing a diagnostic message shown below.
107 .ne 2
109 \fBSATA port X: link lost.\fR
111 .sp .6
112 .RS 4n
113 Communication (via serial link) between the HBA and the device plugged to the
114 specified SATA device port has been lost.
118 .ne 2
120 \fBSATA port X: link established.\fR
122 .sp .6
123 .RS 4n
124 Communication (via serial link) between the HBA and the device plugged to the
125 specified SATA device port has been established.
129 .ne 2
131 \fBSATA port X: device reset.\fR
133 .sp .6
134 .RS 4n
135 The device plugged to the specified SATA device port has been reset. The reset
136 may be due to a communication or command error, command timeout, or an explicit
137 request from the host.
141 .ne 2
143 \fBSATA port X failed.\fR
145 .sp .6
146 .RS 4n
147 The specified SATA device port failed and is in an unusable state. You can
148 change the port state by deactivating the port and activating it again using
149 cfgadm SATA hardware-specific commands (see \fBcfgadm_sata\fR(1M)).
153 .ne 2
155 \fBSATA port X error.\fR
157 .sp .6
158 .RS 4n
159 An error was detected in specified SATA device port operations.
163 .ne 2
165 \fBSATA device detached at port X.\fR
167 .sp .6
168 .RS 4n
169 Communication (via serial link) between the HBA and the device plugged to the
170 specified SATA device port has been lost and could not be re-established. The
171 SATA framework assumes that the device is unplugged from the specified SATA
172 device port.
176 .ne 2
178 \fBSATA device detected at port X.\fR
180 .sp .6
181 .RS 4n
182 Communication( via serial link) between the HBA and the device plugged to the
183 specified empty SATA device port has been established. The SATA framework
184 assumes that the new device is plugged to the specified SATA device port.
188 .ne 2
190 \fBSATA disk device at port X.\fR
192 .sp .6
193 .RS 4n
194 This message is followed by a disk description specifying the disk vendor,
195 serial number, firmware revision number and the disk capabilities.
199 .ne 2
201 \fBSATA CD/DVD (ATAPI) device at port X.\fR
203 .sp .6
204 .RS 4n
205 This message is followed by a SATA CD/DVD description specifying the DVD
206 vendor, serial number, firmware revision number and the DVD capabilities.
210 .ne 2
212 \fBSATA device at port X cannot be configured. Application(s) accessing
213 previously attached device have to release it before newly inserted device can
214 be made accessible.\fR
216 .sp .6
217 .RS 4n
218 The port cannot be configured because there is application using the previous
219 attached device, so the application must release it, then the newly inserted
220 device can be configured.
224 .ne 2
226 \fBApplication(s) accessing previously attached SATA device have to release it
227 before newly inserted device can be made accessible.\fR
229 .sp .6
230 .RS 4n
231 The target node remained and it belongs to a previously attached device. This
232 happens when the file was open or the node was waiting for resources at the
233 time the associated device was removed. Instruct event daemon to retry the
234 cleanup later.
238 .ne 2
240 \fBsata: error recovery request for non-attached device at cport X.\fR
242 .sp .6
243 .RS 4n
244 When error recovery is requested, the device is not yet attached.
248 .ne 2
250 \fBSATA device at port X is not power-managed.\fR
252 .sp .6
253 .RS 4n
254 When property \fBpm-capable\fR on the target device node setting fails, the
255 SATA device won't be power-managed.
259 .ne 2
261 \fBSATA disk device at port X does not support LBA.\fR
263 .sp .6
264 .RS 4n
265 The disk device plugged into specified SATA device port does not support LBA
266 addressing and cannot be used.
270 .ne 2
272 \fBCannot identify SATA device at port X - device is attached.\fR
274 .sp .6
275 .RS 4n
276 IDENTIFY (PACKET) DEVICE data cannot be retrieved successfully after the device
277 is attached to the SATA port.
281 .ne 2
283 \fBsata: <HBA driver name><instance number>:hba attached failed.\fR
285 .sp .6
286 .RS 4n
287 The SATA HBA instance attach operation failed. This HBA instance cannot be
288 configured and is not available.
292 .ne 2
294 \fBsata: invalid ATAPI cdb length<command cdb length>.\fR
296 .sp .6
297 .RS 4n
298 The length of the command cdb is greater than that the device can support.
302 .ne 2
304 \fBsata: invalid sata_hba_tran version X for driver <HBA driver name>.\fR
306 .sp .6
307 .RS 4n
308 The specified SATA HBA driver and the SATA framework are incompatible. The
309 driver cannot attach and SATA HBAs controlled by this driver (and devices
310 plugged to this SATA HBA ports) are not available.
314 .ne 2
316 \fBsata_hba_attach: cannot create SATA attachment point for port X.\fR
318 .sp .6
319 .RS 4n
320 The specified SATA device port cannot be configured in the system and a device
321 plugged to this port could not be not be configured and used.
325 .ne 2
327 \fBsata_create_target_node: cannot create target node for device at port X.\fR
329 .sp .6
330 .RS 4n
331 The device target node for the device plugged to the specified SATA device port
332 could not be created. As a result, the device cannot be configured and used.