global.h revision 5758952badba891b949bd0a1bb5257023b91845c
1/*
2 * Copyright (c) 2004-2005 HighPoint Technologies, Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28#ifndef _GLOBAL_H_
29#define _GLOBAL_H_
30
31#include <dev/hptmv/mvOs.h>
32#include <dev/hptmv/mvSata.h>
33#include <dev/hptmv/mvStorageDev.h>
34
35#define COMPANY      "HighPoint Technologies, Inc."
36#define COPYRIGHT    "(c) 2000-2007. HighPoint Technologies, Inc."
37#define DRIVER_NAME		"RocketRAID 18xx SATA Controller driver"
38#define CONTROLLER_NAME	"RocketRAID 18xx SATA Controller"
39#define PROC_DIR_NAME hptmv
40
41#define HPT_INTERFACE_VERSION 0x01010000
42#define SUPPORT_48BIT_LBA
43#define SUPPORT_ARRAY
44#define SUPPORT_RAID5 1
45#define _RAID5N_
46#define MAX_QUEUE_COMM 32
47#define MAX_SG_DESCRIPTORS 17
48#define MAX_VBUS 2    /*one vbus per adapter in mv linux driver,
49                        MAX_VBUS is defined for share code and can not be 1*/
50
51#define SET_VBUS_FOR_EACH_CONTROLLER
52#define MAX_MEMBERS 8
53#define MAX_ARRAY_NAME 16
54#define MAX_VDEVICE_PER_VBUS 8
55#define MAX_ARRAY_DEVICE MAX_ARRAY_PER_VBUS
56#define MAX_CHIP_IN_VBUS 1
57
58#define SUPPORT_IOCTL
59#define SUPPORT_FAIL_LED
60
61typedef void * PChipInstance;
62typedef void * PChannel;
63typedef struct _VDevice *PVDevice;
64typedef struct _VBus *PVBus;
65typedef struct _ArrayDescript *PArrayDescript;
66typedef struct _ArrayDescriptV2 *PArrayDescriptV2;
67typedef struct _Command *PCommand;
68
69typedef struct _Device {
70	UCHAR df_on_line;
71	UCHAR df_atapi;
72	UCHAR df_removable_drive;
73	UCHAR busyCount;
74
75	UCHAR df_tcq_set: 1;
76    UCHAR df_tcq: 1;          /* enable TCQ */
77	UCHAR df_ncq_set: 1;
78    UCHAR df_ncq: 1;          /* enable NCQ */
79	UCHAR df_write_cache_set: 1;
80    UCHAR df_write_cache: 1;  /* enable write cache */
81	UCHAR df_read_ahead_set: 1;
82    UCHAR df_read_ahead: 1;   /* enable read ahead */
83
84	UCHAR retryCount;
85	UCHAR resetCount;
86	UCHAR pad1;
87
88	UCHAR df_user_mode_set;
89    UCHAR bDeModeSetting;    /* Current Data Transfer mode: 0-4 PIO 0-4 */
90    UCHAR bDeUsable_Mode;       /* actual maximum data transfer mode */
91	UCHAR bDeUserSelectMode;
92
93	PVBus pVBus;
94	ULONG dDeRealCapacity;
95	ULONG dDeHiddenLba;
96	ULONG HeadPosition;
97	ULONG QueueLength;
98	MV_SATA_CHANNEL *mv;
99}
100Device, *PDevice;
101
102typedef struct _SCAT_GATH
103{
104    ULONG_PTR     dSgAddress;
105    USHORT        wSgSize;
106    USHORT        wSgFlag;
107} SCAT_GATH, FAR *FPSCAT_GATH;
108
109#define OS_VDEV_EXT
110typedef struct _VDevice_Ext
111{
112	UCHAR gui_locked; /* the device is locked by GUI */
113	UCHAR reserve[3];
114} VDevice_Ext, *PVDevice_Ext;
115
116
117#define SG_FLAG_SKIP        0x4000
118#define SG_FLAG_EOT         0x8000
119
120#define _VBUS_ARG0 PVBus _vbus_p
121#define _VBUS_ARG PVBus _vbus_p,
122#define _VBUS_P _vbus_p,
123#define _VBUS_P0 _vbus_p
124#define _VBUS_INST(x) PVBus _vbus_p = x;
125#define _vbus_(x) (_vbus_p->x)
126
127/*************************************************************************
128 * arithmetic functions
129 *************************************************************************/
130#define LongRShift(x, y) 	(x >> y)
131#define LongLShift(x, y)   	(x << y)
132#define LongDiv(x, y)      	(x / (UINT)(y))
133#define LongRem(x, y)		(x % (UINT)(y))
134#define LongMul(x, y)      	(x * y)
135/* Minimum and maximum macros */
136#if (__FreeBSD_version < 501000)
137#define MAX(a, b)	(((a) > (b)) ? (a) : (b))
138#define MIN(a, b)	(((a) < (b)) ? (a) : (b))
139#endif
140
141/*************************************************************************
142 * C library
143 *************************************************************************/
144int HPTLIBAPI os_memcmp(const void *cs, const void *ct, unsigned len);
145void HPTLIBAPI os_memcpy(void *to, const void *from, unsigned len);
146void HPTLIBAPI os_memset(void *s, char c, unsigned len);
147unsigned HPTLIBAPI os_strlen(const char *s);
148
149#ifdef NO_LIBC
150#define memcmp os_memcmp
151#define memcpy os_memcpy
152#define memset os_memset
153#define strlen os_strlen
154#elif (__FreeBSD_version <= 410000)
155#define	memcpy(d, s, len)     bcopy((s),(d),(len))
156#define	memset(d, s, len)     bzero((d),(len))
157#endif
158#define ZeroMemory(a, b)  	memset((char *)a, 0, b)
159#define MemoryCopy(a,b,c) 	memcpy((char *)(a), (char *)(b), (UINT)(c))
160#define farMemoryCopy(a,b,c) memcpy((char *)(a), (char *)(b), (UINT)c)
161#define StrLen            	strlen
162
163/*
164 * we don't want whole hptintf.h in shared code...
165 * some constants must match that in hptintf.h!
166 */
167enum _driver_events_t
168{
169	ET_DEVICE=0,
170    ET_DEVICE_REMOVED,
171    ET_DEVICE_PLUGGED,
172    ET_DEVICE_ERROR,
173    ET_REBUILD_STARTED,
174    ET_REBUILD_ABORTED,
175    ET_REBUILD_FINISHED,
176    ET_SPARE_TOOK_OVER,
177    ET_REBUILD_FAILED,
178	ET_VERIFY_STARTED,
179	ET_VERIFY_ABORTED,
180	ET_VERIFY_FAILED,
181	ET_VERIFY_FINISHED,
182	ET_INITIALIZE_STARTED,
183	ET_INITIALIZE_ABORTED,
184	ET_INITIALIZE_FAILED,
185	ET_INITIALIZE_FINISHED,
186	ET_VERIFY_DATA_ERROR,
187};
188
189#define StallExec(x) mvMicroSecondsDelay(x)
190extern void HPTLIBAPI ioctl_ReportEvent(UCHAR event, PVOID param);
191#define fNotifyGUI(WhatHappen, pVDevice) ioctl_ReportEvent(WhatHappen, pVDevice)
192#define DECLARE_BUFFER(type, ptr) UCHAR ptr##__buf[512]; type ptr=(type)ptr##__buf
193
194int HPTLIBAPI fDeReadWrite(PDevice pDev, ULONG Lba, UCHAR Cmd, void *tmpBuffer);
195void HPTLIBAPI fDeSelectMode(PDevice pDev, UCHAR NewMode);
196int HPTLIBAPI fDeSetTCQ(PDevice pDev, int enable, int depth);
197int HPTLIBAPI fDeSetNCQ(PDevice pDev, int enable, int depth);
198int HPTLIBAPI fDeSetWriteCache(PDevice pDev, int enable);
199int HPTLIBAPI fDeSetReadAhead(PDevice pDev, int enable);
200
201#include <dev/hptmv/atapi.h>
202#include <dev/hptmv/command.h>
203#include <dev/hptmv/array.h>
204#include <dev/hptmv/raid5n.h>
205#include <dev/hptmv/vdevice.h>
206
207#if defined(__FreeBSD__) && defined(HPTLIBAPI)
208#undef HPTLIBAPI
209#define HPTLIBAPI
210#endif
211
212#ifdef SUPPORT_ARRAY
213#define ArrayTables(i) ((PVDevice)&_vbus_(_ArrayTables)[i*ARRAY_VDEV_SIZE])
214#endif
215
216#endif
217