sys/dev/hptmv/readme.txt

   1 RocketRAID 182x Driver for FreeBSD
   2 Copyright (C) 2004-2005 HighPoint Technologies, Inc. All rights reserved.
   3 $FreeBSD$
   4
   5 #############################################################################
   6 Revision History:
   7
   8    v1.12 2005-6-10
   9          Fix over 4G memory support on amd64.
  10          Fix disk flush problem.
  11
  12    v1.1  2004-9-23
  13          Fix activity LED problem.
  14          Cleanup diagnostic code.
  15
  16    v1.01 2004-5-24
  17          First source code release
  18
  19 #############################################################################
  20
  21 1. Overview
  22 ---------------------
  23   This package contains FreeBSD driver source code for HighPoint RocketRAID
  24   182x SATA controller.
  25
  26   NO WARRANTY
  27
  28   THE DRIVER SOURCE CODE HIGHPOINT PROVIDED IS FREE OF CHARGE, AND THERE IS
  29   NO WARRANTY FOR THE PROGRAM. THERE ARE NO RESTRICTIONS ON THE USE OF THIS
  30   FREE SOURCE CODE. HIGHPOINT DOES NOT PROVIDE ANY TECHNICAL SUPPORT IF THE
  31   CODE HAS BEEN CHANGED FROM ORIGINAL SOURCE CODE.
  32
  33   LIMITATION OF LIABILITY
  34
  35   IN NO EVENT WILL HIGHPOINT BE LIABLE FOR DIRECT, INDIRECT, SPECIAL,
  36   INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF OR
  37   INABILITY TO USE THIS PRODUCT OR DOCUMENTATION, EVEN IF ADVISED OF THE
  38   POSSIBILITY OF SUCH DAMAGES. IN PARTICULAR, HIGHPOINT SHALL NOT HAVE
  39   LIABILITY FOR ANY HARDWARE, SOFTWARE, OR DATA STORED USED WITH THE
  40   PRODUCT, INCLUDING THE COSTS OF REPAIRING, REPLACING, OR RECOVERING
  41   SUCH HARDWARE, OR DATA.
  42
  43
  44 2. Rebuild the kernel with RR182x support
  45 --------------------------------------------
  46
  47   1) Install kernel source package and building tools.
  48
  49   2) Extract the driver files under the kernel source tree:
  50
  51      # cd /usr/src/sys/
  52      # tar xvzf /your/path/to/rr182x-opensource-v1.12-bsd.tgz
  53
  54   3) Update the kernel configuration file to include the HighPoint source.
  55      Assume the configure file is GENERIC, and new kernel configure file is
  56      MYKERNEL:
  57
  58      # cd i386/conf          (or amd64/conf for AMD64)
  59      # cp GENERIC MYKERNEL
  60
  61   4) Edit MYKERNEL, and add the following line under "RAID controllers
  62      interfaced to the SCSI subsystem":
  63
  64           device  hptmv   #HighPoint RocketRAID 182x
  65
  66   5) For i386 system, edit /usr/src/sys/conf/files.i386 and append the lines
  67      shown below:
  68
  69           hptmvraid.o optional    hptmv  \
  70               dependency  "$S/dev/hptmv/i386-elf.raid.o.uu" \
  71               compile-with    "uudecode < $S/dev/hptmv/i386-elf.raid.o.uu" \
  72               no-implicit-rule
  73
  74           dev/hptmv/gui_lib.c     optional        hptmv
  75           dev/hptmv/hptproc.c     optional        hptmv
  76           dev/hptmv/ioctl.c       optional        hptmv
  77           dev/hptmv/entry.c       optional        hptmv
  78           dev/hptmv/mv.c          optional        hptmv
  79
  80      For amd64 system, edit /usr/src/sys/conf/files.amd64 and append the lines
  81      shown below:
  82
  83           hptmvraid.o optional    hptmv  \
  84               dependency  "$S/dev/hptmv/amd64-elf.raid.o.uu" \
  85               compile-with    "uudecode < $S/dev/hptmv/amd64-elf.raid.o.uu" \
  86               no-implicit-rule
  87
  88           dev/hptmv/gui_lib.c     optional        hptmv
  89           dev/hptmv/hptproc.c     optional        hptmv
  90           dev/hptmv/ioctl.c       optional        hptmv
  91           dev/hptmv/entry.c       optional        hptmv
  92           dev/hptmv/mv.c          optional        hptmv
  93
  94      Note FreeBSD 5.3/5.4 i386 already have a built-in RR182x driver, you should
  95      replace the old configuration lines with the lines listed above.
  96
  97
  98   6) Rebuild and install the kernel:
  99
 100      a) for FreeBSD 5.x-i386:
 101
 102         # cd /usr/src/sys/i386/conf/
 103         # /usr/sbin/config MYKERNEL
 104         # cd ../compile/MYKERNEL/
 105         # make depend
 106         # make
 107         # make install
 108
 109      b) for FreeBSD 5.x-amd64:
 110
 111         # cd /usr/src/sys/amd64/conf/
 112         # /usr/sbin/config MYKERNEL
 113         # cd ../compile/MYKERNEL/
 114         # make depend
 115         # make
 116         # make install
 117
 118      c) for FreeBSD 4.x:
 119
 120         # cd /usr/src/sys/i386/conf/
 121         # /usr/sbin/config MYKERNEL
 122         # cd ../../compile/MYKERNEL/
 123         # make depend
 124         # make
 125         # make install
 126
 127     If the driver was previously configured as an auto-loaded module by
 128     /boot/defaults/loader.conf, please remove the entry hptmv_load="YES"
 129     from loader.conf to prevent the driver from being loaded twice.
 130
 131   7) Reboot from the new kernel.
 132
 133
 134 3. Build/Load the driver as a kernel module
 135 ------------------------------------------------
 136
 137   1) Install kernel source package and building tools.
 138
 139   2) Extract the driver files under the kernel source tree:
 140
 141      # cd /usr/src/sys/
 142      # tar xvzf /your/path/to/rr182x-opensource-v1.12-bsd.tgz
 143
 144
 145   4) Build the driver module:
 146
 147      # cd modules/hptmv
 148      # make
 149
 150   5) Copy the driver module to the kernel module directory
 151
 152      For FreeBSD 4.x:
 153
 154      # cp hptmv.ko /modules/
 155
 156      For FreeBSD 5.x:
 157
 158      # cp hptmv.ko /boot/kernel/
 159
 160   6) Reboot and load the driver under loader prompt. e.g:
 161
 162         BTX loader 1.00  BTX version is 1.01
 163         Console: internal video/keyboard
 164         BIOS driver A: is disk0
 165         BIOS driver C: is disk2
 166         BIOS 636kB/74512kB available memory
 167
 168         FreeBSD/i386 bootstrap loader, Revision 0.8
 169         (mailto:jkh@narf.osd.bsdi.com, Sat Apr 21 08:46:19 GMT 2001)
 170         Loading /boot/defaults/loader.conf
 171         /kernel text=0x24f1db data=0x3007ec+0x2062c -
 172
 173         Hit [Enter] to boot immediagely, or any other key for command prompt.
 174         Booting [kernel] in 9 seconds¡
 175
 176          <-- press SPACE key here
 177         Type '?' for a list of commands, 'help' for more detailed help.
 178         ok load hptmv
 179         /modules/hptmv.ko text=0xf571 data=0x2c8+0x254
 180         ok boot
 181
 182      For FreeBSD 5.x, you can select 6 on the boot menu to get a loader prompt.
 183
 184   7) You can add a below line into /boot/defaults/loader.conf to load the
 185      driver automatically:
 186
 187            hptmv_load="YES"
 188
 189      Please refer to the installation guide in HighPoint FreeBSD driver release
 190      package for more information.
 191
 192
 193 #############################################################################
 194 Technical support and service
 195
 196   If you have questions about installing or using your HighPoint product,
 197   check the user's guide or readme file first, and you will find answers to
 198   most of your questions here. If you need further assistance, please
 199   contact us. We offer the following support and information services:
 200
 201   1)  The HighPoint Web Site provides information on software upgrades,
 202       answers to common questions, and other topics. The Web Site is
 203       available from Internet 24 hours a day, 7 days a week, at
 204       http://www.highpoint-tech.com.
 205
 206   2)  For technical support, send e-mail to support@highpoint-tech.com
 207
 208   NOTE: Before you send an e-mail, please visit our Web Site
 209         (http://www.highpoint-tech.com) to check if there is a new or
 210         updated device driver for your system.