global.h revision 190809
1130803Smarcel/* 2130803Smarcel * Copyright (c) 2004-2005 HighPoint Technologies, Inc. 3130803Smarcel * All rights reserved. 4130803Smarcel * 5130803Smarcel * Redistribution and use in source and binary forms, with or without 6130803Smarcel * modification, are permitted provided that the following conditions 7130803Smarcel * are met: 8130803Smarcel * 1. Redistributions of source code must retain the above copyright 9130803Smarcel * notice, this list of conditions and the following disclaimer. 10130803Smarcel * 2. Redistributions in binary form must reproduce the above copyright 11130803Smarcel * notice, this list of conditions and the following disclaimer in the 12130803Smarcel * documentation and/or other materials provided with the distribution. 13130803Smarcel * 14130803Smarcel * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15130803Smarcel * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16130803Smarcel * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17130803Smarcel * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18130803Smarcel * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19130803Smarcel * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20130803Smarcel * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21130803Smarcel * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22130803Smarcel * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23130803Smarcel * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24130803Smarcel * SUCH DAMAGE. 25130803Smarcel * 26130803Smarcel * $FreeBSD: head/sys/dev/hptmv/global.h 190809 2009-04-07 16:38:25Z delphij $ 27130803Smarcel */ 28130803Smarcel#ifndef _GLOBAL_H_ 29130803Smarcel#define _GLOBAL_H_ 30130803Smarcel 31130803Smarcel#include <dev/hptmv/mvOs.h> 32130803Smarcel#include <dev/hptmv/mvSata.h> 33130803Smarcel#include <dev/hptmv/mvStorageDev.h> 34130803Smarcel 35130803Smarcel#define COMPANY "HighPoint Technologies, Inc." 36130803Smarcel#define COPYRIGHT "(c) 2000-2007. HighPoint Technologies, Inc." 37130803Smarcel#define DRIVER_NAME "RocketRAID 18xx SATA Controller driver" 38130803Smarcel#define CONTROLLER_NAME "RocketRAID 18xx SATA Controller" 39130803Smarcel#define PROC_DIR_NAME hptmv 40130803Smarcel 41130803Smarcel#define HPT_INTERFACE_VERSION 0x01010000 42130803Smarcel#define SUPPORT_48BIT_LBA 43130803Smarcel#define SUPPORT_ARRAY 44130803Smarcel#define SUPPORT_RAID5 1 45130803Smarcel#define _RAID5N_ 46130803Smarcel#define MAX_QUEUE_COMM 32 47130803Smarcel#define MAX_SG_DESCRIPTORS 17 48130803Smarcel#define MAX_VBUS 2 /*one vbus per adapter in mv linux driver, 49130803Smarcel MAX_VBUS is defined for share code and can not be 1*/ 50130803Smarcel 51130803Smarcel#define SET_VBUS_FOR_EACH_CONTROLLER 52130803Smarcel#define MAX_MEMBERS 8 53130803Smarcel#define MAX_ARRAY_NAME 16 54130803Smarcel#define MAX_VDEVICE_PER_VBUS 8 55130803Smarcel#define MAX_ARRAY_DEVICE MAX_ARRAY_PER_VBUS 56130803Smarcel#define MAX_CHIP_IN_VBUS 1 57130803Smarcel 58130803Smarcel#define SUPPORT_IOCTL 59130803Smarcel#define SUPPORT_FAIL_LED 60130803Smarcel 61130803Smarceltypedef void * PChipInstance; 62130803Smarceltypedef void * PChannel; 63130803Smarceltypedef struct _VDevice *PVDevice; 64130803Smarceltypedef struct _VBus *PVBus; 65130803Smarceltypedef struct _ArrayDescript *PArrayDescript; 66130803Smarceltypedef struct _ArrayDescriptV2 *PArrayDescriptV2; 67130803Smarceltypedef struct _Command *PCommand; 68130803Smarcel 69130803Smarceltypedef struct _Device { 70130803Smarcel UCHAR df_on_line; 71130803Smarcel UCHAR df_atapi; 72130803Smarcel UCHAR df_removable_drive; 73130803Smarcel UCHAR busyCount; 74130803Smarcel 75130803Smarcel UCHAR df_tcq_set: 1; 76130803Smarcel UCHAR df_tcq: 1; /* enable TCQ */ 77130803Smarcel UCHAR df_ncq_set: 1; 78130803Smarcel UCHAR df_ncq: 1; /* enable NCQ */ 79130803Smarcel UCHAR df_write_cache_set: 1; 80130803Smarcel UCHAR df_write_cache: 1; /* enable write cache */ 81130803Smarcel UCHAR df_read_ahead_set: 1; 82130803Smarcel UCHAR df_read_ahead: 1; /* enable read ahead */ 83130803Smarcel 84130803Smarcel UCHAR retryCount; 85130803Smarcel UCHAR resetCount; 86130803Smarcel UCHAR pad1; 87130803Smarcel 88130803Smarcel UCHAR df_user_mode_set; 89130803Smarcel UCHAR bDeModeSetting; /* Current Data Transfer mode: 0-4 PIO 0-4 */ 90130803Smarcel UCHAR bDeUsable_Mode; /* actual maximum data transfer mode */ 91130803Smarcel UCHAR bDeUserSelectMode; 92130803Smarcel 93130803Smarcel PVBus pVBus; 94130803Smarcel ULONG dDeRealCapacity; 95130803Smarcel ULONG dDeHiddenLba; 96130803Smarcel ULONG HeadPosition; 97130803Smarcel ULONG QueueLength; 98130803Smarcel MV_SATA_CHANNEL *mv; 99130803Smarcel} 100130803SmarcelDevice, *PDevice; 101130803Smarcel 102130803Smarceltypedef struct _SCAT_GATH 103130803Smarcel{ 104130803Smarcel ULONG_PTR dSgAddress; 105130803Smarcel USHORT wSgSize; 106130803Smarcel USHORT wSgFlag; 107130803Smarcel} SCAT_GATH, FAR *FPSCAT_GATH; 108130803Smarcel 109130803Smarcel#define OS_VDEV_EXT 110130803Smarceltypedef struct _VDevice_Ext 111130803Smarcel{ 112130803Smarcel UCHAR gui_locked; /* the device is locked by GUI */ 113130803Smarcel UCHAR reserve[3]; 114130803Smarcel} VDevice_Ext, *PVDevice_Ext; 115130803Smarcel 116130803Smarcel 117130803Smarcel#define SG_FLAG_SKIP 0x4000 118130803Smarcel#define SG_FLAG_EOT 0x8000 119130803Smarcel 120130803Smarcel#define _VBUS_ARG0 PVBus _vbus_p 121130803Smarcel#define _VBUS_ARG PVBus _vbus_p, 122130803Smarcel#define _VBUS_P _vbus_p, 123130803Smarcel#define _VBUS_P0 _vbus_p 124130803Smarcel#define _VBUS_INST(x) PVBus _vbus_p = x; 125130803Smarcel#define _vbus_(x) (_vbus_p->x) 126130803Smarcel 127130803Smarcel/************************************************************************* 128130803Smarcel * arithmetic functions 129130803Smarcel *************************************************************************/ 130130803Smarcel#define LongRShift(x, y) (x >> y) 131130803Smarcel#define LongLShift(x, y) (x << y) 132130803Smarcel#define LongDiv(x, y) (x / (UINT)(y)) 133130803Smarcel#define LongRem(x, y) (x % (UINT)(y)) 134130803Smarcel#define LongMul(x, y) (x * y) 135130803Smarcel/* Minimum and maximum macros */ 136130803Smarcel#if (__FreeBSD_version < 501000) 137130803Smarcel#define MAX(a, b) (((a) > (b)) ? (a) : (b)) 138130803Smarcel#define MIN(a, b) (((a) < (b)) ? (a) : (b)) 139130803Smarcel#endif 140130803Smarcel 141130803Smarcel/************************************************************************* 142130803Smarcel * C library 143130803Smarcel *************************************************************************/ 144130803Smarcelint HPTLIBAPI os_memcmp(const void *cs, const void *ct, unsigned len); 145130803Smarcelvoid HPTLIBAPI os_memcpy(void *to, const void *from, unsigned len); 146130803Smarcelvoid HPTLIBAPI os_memset(void *s, char c, unsigned len); 147130803Smarcelunsigned HPTLIBAPI os_strlen(const char *s); 148130803Smarcel 149130803Smarcel#ifdef NO_LIBC 150130803Smarcel#define memcmp os_memcmp 151130803Smarcel#define memcpy os_memcpy 152130803Smarcel#define memset os_memset 153130803Smarcel#define strlen os_strlen 154130803Smarcel#elif (__FreeBSD_version <= 410000) 155130803Smarcel#define memcpy(d, s, len) bcopy((s),(d),(len)) 156130803Smarcel#define memset(d, s, len) bzero((d),(len)) 157130803Smarcel#endif 158130803Smarcel#define ZeroMemory(a, b) memset((char *)a, 0, b) 159130803Smarcel#define MemoryCopy(a,b,c) memcpy((char *)(a), (char *)(b), (UINT)(c)) 160130803Smarcel#define farMemoryCopy(a,b,c) memcpy((char *)(a), (char *)(b), (UINT)c) 161130803Smarcel#define StrLen strlen 162130803Smarcel 163130803Smarcel/* 164130803Smarcel * we don't want whole hptintf.h in shared code... 165130803Smarcel * some constants must match that in hptintf.h! 166130803Smarcel */ 167130803Smarcelenum _driver_events_t 168130803Smarcel{ 169130803Smarcel ET_DEVICE=0, 170130803Smarcel ET_DEVICE_REMOVED, 171130803Smarcel ET_DEVICE_PLUGGED, 172130803Smarcel ET_DEVICE_ERROR, 173130803Smarcel ET_REBUILD_STARTED, 174130803Smarcel ET_REBUILD_ABORTED, 175130803Smarcel ET_REBUILD_FINISHED, 176130803Smarcel ET_SPARE_TOOK_OVER, 177130803Smarcel ET_REBUILD_FAILED, 178130803Smarcel ET_VERIFY_STARTED, 179130803Smarcel ET_VERIFY_ABORTED, 180130803Smarcel ET_VERIFY_FAILED, 181130803Smarcel ET_VERIFY_FINISHED, 182130803Smarcel ET_INITIALIZE_STARTED, 183130803Smarcel ET_INITIALIZE_ABORTED, 184130803Smarcel ET_INITIALIZE_FAILED, 185130803Smarcel ET_INITIALIZE_FINISHED, 186130803Smarcel ET_VERIFY_DATA_ERROR, 187130803Smarcel}; 188130803Smarcel 189130803Smarcel#define StallExec(x) mvMicroSecondsDelay(x) 190130803Smarcelextern void HPTLIBAPI ioctl_ReportEvent(UCHAR event, PVOID param); 191130803Smarcel#define fNotifyGUI(WhatHappen, pVDevice) ioctl_ReportEvent(WhatHappen, pVDevice) 192130803Smarcel#define DECLARE_BUFFER(type, ptr) UCHAR ptr##__buf[512]; type ptr=(type)ptr##__buf 193130803Smarcel 194130803Smarcelint HPTLIBAPI fDeReadWrite(PDevice pDev, ULONG Lba, UCHAR Cmd, void *tmpBuffer); 195130803Smarcelvoid HPTLIBAPI fDeSelectMode(PDevice pDev, UCHAR NewMode); 196130803Smarcelint HPTLIBAPI fDeSetTCQ(PDevice pDev, int enable, int depth); 197130803Smarcelint HPTLIBAPI fDeSetNCQ(PDevice pDev, int enable, int depth); 198130803Smarcelint HPTLIBAPI fDeSetWriteCache(PDevice pDev, int enable); 199130803Smarcelint HPTLIBAPI fDeSetReadAhead(PDevice pDev, int enable); 200130803Smarcel 201130803Smarcel#include <dev/hptmv/atapi.h> 202130803Smarcel#include <dev/hptmv/command.h> 203130803Smarcel#include <dev/hptmv/array.h> 204130803Smarcel#include <dev/hptmv/raid5n.h> 205130803Smarcel#include <dev/hptmv/vdevice.h> 206130803Smarcel 207130803Smarcel#if defined(__FreeBSD__) && defined(HPTLIBAPI) 208130803Smarcel#undef HPTLIBAPI 209130803Smarcel#define HPTLIBAPI 210130803Smarcel#endif 211130803Smarcel 212130803Smarcel#ifdef SUPPORT_ARRAY 213130803Smarcel#define ArrayTables(i) ((PVDevice)&_vbus_(_ArrayTables)[i*ARRAY_VDEV_SIZE]) 214130803Smarcel#endif 215130803Smarcel 216130803Smarcel#endif 217130803Smarcel