Ignore:
Timestamp:
Nov 29, 2016, 5:30:22 AM (9 years ago)
Author:
David Azarewicz
Message:

Major reorganization

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/os2ahci/README

    r177 r178  
    1 AHCI Driver for OS/2 v1.32
     1AHCI Driver for OS/2 v2.01
     2
     3WARNING: This is a alpha level build of this driver. Use
     4in a production environment is not recommended.
    25
    36
     
    1720Copyright (c) 2011 thi.guten Software Development
    1821Copyright (c) 2011 Mensys B.V.
    19 Copyright (c) 2013-2015 David Azarewicz
     22Copyright (c) 2013-2016 David Azarewicz
    2023
    2124Authors: Christian Mueller, Markus Thielen
     
    7073Option                 Description
    7174------------------------------------------------------------------------------
    72 /b:<baud>              Initialize the COM port to the specified baud rate. Allowable
     75/B:<baud>              Initialize the COM port to the specified baud rate. Allowable
    7376                       baud values are: 300, 600, 1200, 2400, 4800, 9600, 19200,
    74                        38400, 57600, and 115200. /b has no effect if /c is not also
    75                        specified. If /b is not specified, the COM port is not
     77                       38400, 57600, and 115200. /B has no effect if /C is not also
     78                       specified. If /B is not specified, the COM port is not
    7679                       initialized. For example, if you are using the kernel debugger,
    7780                       the kernel debugger initializes the COM port so you should not
    7881                       use this switch.
    7982
    80 /c:<n>                 Set debug COM port base address. Values for n can be:
     83/C:<n>                 Set debug COM port base address. Values for n can be:
    8184                         1 = COM1
    8285                         2 = COM2
     
    8487                       The default is 0. If set to 0 then no output goes to the COM port.
    8588
    86 /d[:n]                 Debug output to COM port/trace buffer. Values for n can be:
     89/D[:n]                 Debug output to COM port/debug buffer. Values for n can be:
    8790                         1 = requests
    8891                         2 = detailed
    89                          3 = verbose, including MMIO operations
     92                         3 = verbose
    9093                       If :n is not specified the debug level is incremented for
    91                        each /d specified.
    92 
    93 /w                     Allows the trace buffer to wrap when full.
    94 
    95 /v[:n]                 Display informational messages during boot. Values for n can be:
     94                       each /D specified.
     95
     96/W                     Allows the debug buffer to wrap when full.
     97
     98/V[:n]                 Display informational messages during boot. Values for n can be:
    9699                         1 = Display sign on banner
    97100                         2 = Display adapter information
    98101                       If :n is not specified the verbosity level is incremented for
    99                        each /v specified.
    100 
    101 /g:<vendor>:<device>   Add generic PCI ID to list of supported AHCI adapters
    102                        (e.g. /g:8086:2829)
    103 
    104 /t                     Perform thorough PCI ID scan; default = on, can be
    105                        turned off with /!t to perform only a PCI class scan
    106 
    107 /f                     Force the use of the HW write cache when using NCQ
     102                       each /V specified.
     103
     104/G:<vendor>:<device>   Add generic PCI ID to list of supported AHCI adapters
     105                       (e.g. /G:8086:2829)
     106
     107/T                     Perform thorough PCI ID scan; default = on, can be
     108                       turned off with /!T to perform only a PCI class scan
     109
     110/F                     Force the use of the HW write cache when using NCQ
    108111                       commands; see "Native Command Queuing" below for
    109112                       further explanation (default = off)
    110113
    111 /r                     Reset ports during initialization (default = on)
    112                        Can be turned off with /!r, however, when the
     114/R                     Reset ports during initialization (default = on)
     115                       Can be turned off with /!R, however, when the
    113116                       [Intel] AHCI controller was found to be
    114117                       initialized by the BIOS in SATA mode, ports will
    115                        always be reset even when /!r was specified
    116 
    117 /a:n                   Set adapter to n for adapter-specific options
     118                       always be reset even when /!R was specified
     119
     120/A:n                   Set adapter to n for adapter-specific options
    118121                       (default = -1, all adapters)
    119122
    120 /p:n                   Set port to n for port-specific options
     123/P:n                   Set port to n for port-specific options
    121124                       (default = -1, all ports)
    122125
    123 /i                     Ignore current adapter if no port has been specified.
     126/I                     Ignore current adapter if no port has been specified.
    124127                       Otherwise, ignore the current port on the current adapter.
    125128
     
    128131Option                 Description
    129132------------------------------------------------------------------------------
    130 /s                     Enable SCSI emulation for ATAPI units (default = on)
     133/S                     Enable SCSI emulation for ATAPI units (default = on)
    131134                       SCSI emulation is required for tools like cdrecord.
    132135
    133 /n                     Enable NCQ (Native Command Queuing) for hard disks
     136/N                     Enable NCQ (Native Command Queuing) for hard disks
    134137                       (default = off)
    135138
    136 /ls                    Set link speed (default = 0):
     139/LS                    Set link speed (default = 0):
    137140                         0 = maximum,
    138141                         1 = limit to generation 1
     
    140143                         3 = limit to generation 3
    141144
    142 /lp                    Set link power management (default = 0):
     145/LP                    Set link power management (default = 0):
    143146                         0 = full power management,
    144147                         1 = transitions to "partial slumber state" disabled,
     
    151154
    152155Port-specific options depend on the currently active adapter
    153 and port selector (/a and /p). Those selectors are -1 per default
     156and port selector (/A and /P). Those selectors are -1 per default
    154157which means "all" adapters/ports. The scope can be reduced by limiting
    155 it to an adapter (/a) or an adapter and a port (/a and /p). The scope
     158it to an adapter (/A) or an adapter and a port (/A and /P). The scope
    156159can be reset by setting the corresponding option back to -1.
    157160
    158161For example:
    159162
    160   BASEDEV=OS2AHCI.ADD /n /a:0 /p:5 /!n /a:1 /p:-1 /!n
     163  BASEDEV=OS2AHCI.ADD /N /A:0 /P:5 /!N /A:1 /P:-1 /!N
    161164
    162165This has the following effect:
     
    183186disks, it's currently turned off by default until we have more feedback
    184187from OS/2 users. In order to turn on NCQ, just add the command line
    185 option "/n" to OS2AHCI.ADD.
     188option "/N" to OS2AHCI.ADD.
    186189
    187190NCQ and HW Caches
     
    195198performance loss. In order to prevent OS2AHCI from disabling the HW
    196199cache when so requested by upstream code, please use the command line
    197 option "/f".
     200option "/F".
    198201
    199202This may, of course, result in data loss in case of power failures but
     
    210213
    211214 - When suspending, rebooting or shutting down, OS2AHCI always flushes
    212    the HW disk cache regardless of the "/f" or "/n" command line options.
     215   the HW disk cache regardless of the "/F" or "/N" command line options.
    213216
    214217
     
    218221There are three kinds of IDE/ATA/SATA controllers:
    219222
    220  1. Legacy controllers (IDE or SATA) without AHCI support
     223 1. Older controllers (IDE or SATA) without AHCI support
    221224    This kind of controller will only be recognized by IDE drivers
    222225    (IBM1S506.ADD or DANIS506.ADD).
    223226
    224  2. AHCI-capable controllers which supports IDE/SATA legacy interfaces
     227 2. AHCI-capable controllers which supports IDE/SATA interfaces
    225228    This kind of controller will work with IDE or AHCI drivers and it's
    226229    up to the user to decide which driver to use.
     
    252255Assume a DELL D630 or a Thinkpad T60. The hard disk is attached to the
    253256SATA/AHCI controller of the ICH-7 hub while the CDROM is attached to the
    254 legacy PATA IDE controller. This allows two different configurations:
     257PATA IDE controller. This allows two different configurations:
    255258
    256259 1. Drive HDD and CDROM via DANIS506.ADD
    257260 2. Drive HDD via OS2AHCI.ADD and CDROM via DANIS506.ADD
    258261
    259 OS2AHCI.ADD can't drive the CDROM because it's attached to a legacy PATA
     262OS2AHCI.ADD can't drive the CDROM because it's attached to a PATA
    260263IDE controller which doesn't support AHCI.
    261264
     
    384387==========
    385388
     389v.2.01 01-Oct-2016 - David Azarewicz
     390  Major reorganization of the entire driver.
     391  Enhanced debugging support.
     392
    386393v.1.32 09-Nov-2013 - David Azarewicz
    387394  Fix for some hardware that reports incorrect status
     
    416423  Added LVM aware disk geometry reporting.
    417424  Begin to add disk information report - not finished yet.
    418   Removed undocumented /q switch and made the driver quiet by default.
     425  Removed undocumented /Q switch and made the driver quiet by default.
    419426  Debug output improvements.
    420   Added /b switch for setting debug baud rate.
     427  Added /B switch for setting debug baud rate.
    421428  Fixed up time delay functions
    422429
Note: See TracChangeset for help on using the changeset viewer.