share/man/man4/ahci.4

   1 .\"     $OpenBSD: ahci.4,v 1.7 2008/04/19 01:18:39 djm Exp $
   2 .\"
   3 .\" Copyright (c) 2006 David Gwynne <dlg@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" TORTIOUS ACTION, ARISING OUT OF
  15 .\" PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd June 15, 2009
  18 .Dt AHCI 4
  19 .Os
  20 .Sh NAME
  21 .Nm ahci
  22 .Nd Advanced Host Controller Interface for Serial ATA
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel,
  25 place the following line in your
  26 kernel configuration file:
  27 .Bd -ragged -offset indent
  28 .Cd "device ahci"
  29 .Ed
  30 .Pp
  31 Alternatively, to load the driver as a
  32 module at boot time, place the following line in
  33 .Xr loader.conf 5 :
  34 .Bd -literal -offset indent
  35 ahci_load="YES"
  36 .Ed
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver provides support for Serial ATA controllers conforming to the
  41 Advanced Host Controller Interface specification.
  42 .Pp
  43 Several AHCI capable controllers also provide a compatibility mode that
  44 causes them to appear as a traditional ATA controller supported by
  45 .Xr nata 4 .
  46 .Pp
  47 Although
  48 .Nm
  49 controllers are actual ATA controllers, the driver emulates SCSI via a
  50 translation layer.
  51 .Pp
  52 Setting the lowest bit (0x1) of the driver flags forces
  53 .Nm
  54 to negotiate SATA 1 (1.5 Gb/s) transfer speeds only.
  55 It may be useful where higher speeds are unstable.
  56 .Sh SEE ALSO
  57 .Xr intro 4 ,
  58 .Xr nata 4 ,
  59 .Xr pci 4 ,
  60 .Xr scsi 4 ,
  61 .Xr sili 4 ,
  62 .Xr loader.conf 5
  63 .Sh HISTORY
  64 The
  65 .Nm
  66 driver first appeared in
  67 .Dx 2.3 .
  68 .Sh AUTHORS
  69 .An -nosplit
  70 The
  71 .Nm
  72 driver was originally written by
  73 .An David Gwynne Aq dlg@openbsd.org
  74 and
  75 .An Christopher Pascoe Aq pascoe@openbsd.org
  76 for
  77 .Ox .
  78 .Pp
  79 It was ported to
  80 .Dx
  81 by
  82 .An Matt Dillon Aq dillon@apollo.backplane.com
  83 who added new features such as port multiplier support.