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