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