sys/dev/hpt27xx/README

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