/*
*
* O.S : Solaris
* FILE NAME : arcmsr.h
* BY : Erich Chen
* Description: SCSI RAID Device Driver for
* ARECA RAID Host adapter
*
* Copyright (C) 2002,2007 Areca Technology Corporation All rights reserved.
* Copyright (C) 2002,2007 Erich Chen
* Web site: www.areca.com.tw
* E-mail: erich@areca.com.tw
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* 3. The party using or redistributing the source code and binary forms
* agrees to the disclaimer below and the terms and conditions set forth
* herein.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/*
* Copyright 2011 Nexenta Systems, Inc. All rights reserved.
*/
#ifndef _SYS_SCSI_ADAPTERS_ARCMSR_H
#define _SYS_SCSI_ADAPTERS_ARCMSR_H
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/sysmacros.h>
#ifndef TRUE
#define FALSE 0
#endif
/* NOTE: GETG4ADDRTL(cdbp) is int32_t */
/*
* IOCTL CONTROL CODE
*/
struct CMD_MESSAGE {
};
struct CMD_MESSAGE_FIELD {
/* areca gui program does not accept more than 1031 byte */
};
/* IOP message transfer */
/* error code for StorPortLogError,ScsiPortLogError */
/* DeviceType */
/* FunctionCode */
/* ARECA IO CONTROL CODE */
#define ARCMSR_MESSAGE_READ_RQBUFFER \
#define ARCMSR_MESSAGE_WRITE_WQBUFFER \
#define ARCMSR_MESSAGE_CLEAR_RQBUFFER \
#define ARCMSR_MESSAGE_CLEAR_WQBUFFER \
#define ARCMSR_MESSAGE_CLEAR_ALLQBUFFER \
#define ARCMSR_MESSAGE_REQUEST_RETURN_CODE_3F \
#define ARCMSR_MESSAGE_SAY_HELLO \
#define ARCMSR_MESSAGE_SAY_GOODBYE \
#define ARCMSR_MESSAGE_FLUSH_ADAPTER_CACHE \
/* ARECA IOCTL ReturnCode */
/*
* SPEC. for Areca HBB adapter
*/
/* ARECA HBB COMMAND for its FIRMWARE */
/* window of "instruction flags" from driver to iop */
/* window of "instruction flags" from iop to driver */
/* ARECA FLAG LANGUAGE */
/* (ARCMSR_INBOUND_MESG0_GET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* (ARCMSR_INBOUND_MESG0_SET_CONFIG<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* (ARCMSR_INBOUND_MESG0_ABORT_CMD<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* (ARCMSR_INBOUND_MESG0_STOP_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* (ARCMSR_INBOUND_MESG0_FLUSH_CACHE<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* (ARCMSR_INBOUND_MESG0_START_BGRB<<16)|ARCMSR_DRV2IOP_MESSAGE_CMD_POSTED) */
/* ARCMSR_OUTBOUND_MESG1_FIRMWARE_OK */
/* Host Interrupt Mask */
/* Host Interrupt Status */
/*
* Set when the Utility_A Interrupt bit is set in the Outbound
* Doorbell Register. It clears by writing a 1 to the
* Utility_A bit in the Outbound Doorbell Clear Register or
* through automatic clearing (if enabled).
*/
/*
* Set if Outbound Doorbell register bits 30:1 have a non-zero
* value. This bit clears only when Outbound Doorbell bits
* 30:1 are ALL clear. Only a write to the Outbound Doorbell
* Clear register clears bits in the Outbound Doorbell
* register.
*/
/*
* Register (FIFO) is not empty. It clears when the Outbound
* Post List FIFO is empty.
*/
/*
* This bit indicates a SAS interrupt from a source external to
* the PCIe core. This bit is not maskable.
*/
/* DoorBell */
/* data tunnel buffer between user space program and its firmware */
/* iop msgcode_rwbuffer for message command */
/* user space data to iop 128bytes */
/* iop data to user space 128bytes */
/*
* structure for holding DMA address data
*/
/* 32bit Scatter-Gather list */
struct SG32ENTRY {
/* bit 24 = 0, high 8 bit = flag, low 24 bit = length */
};
/* 64bit Scatter-Gather list */
struct SG64ENTRY {
/* bit 24 = 1, high 8 bit = flag, low 24 bit = length */
};
struct QBUFFER {
};
struct list_head {
};
/*
* FIRMWARE INFO
*/
struct FIRMWARE_INFO {
};
/*
* ARECA FIRMWARE SPEC
*
* Usage of IOP331 adapter
*
* 1. Message 0 --> InitThread message and retrun code
* 2. Doorbell is used for RS-232 emulation
* InDoorBell :
* bit0 -- data in ready (DRIVER DATA WRITE OK)
* bit1 -- data out has been read
* (DRIVER DATA READ OK)
* outDoorBell:
* bit0 -- data out ready (IOP331 DATA WRITE OK)
* bit1 -- data in has been read
* (IOP331 DATA READ OK)
* 3. Index Memory Usage
* offset 0xf00 : for RS232 out (request buffer)
* offset 0xe00 : for RS232 in (scratch buffer)
* offset 0xa00 : for inbound message code msgcode_rwbuffer
* (driver send to IOP331)
* offset 0xa00 : for outbound message code msgcode_rwbuffer
* (IOP331 send to driver)
* 4. RS-232 emulation
* Currently 128 byte buffer is used:
* 1st uint32_t : Data length (1--124)
* Byte 4--127 : Max 124 bytes of data
* 5. PostQ
* All SCSI Command must be sent through postQ:
* (inbound queue port) Request frame must be 32 bytes aligned
* # bits 31:27 => flag for post ccb
* # bits 26:00 => real address (bit 31:27) of post arcmsr_cdb
* bit31 : 0 : 256 bytes frame
* 1 : 512 bytes frame
* bit30 : 0 : normal request
* 1 : BIOS request
* bit29 : reserved
* bit28 : reserved
* bit27 : reserved
* -----------------------------------------------------------------------
* (outbount queue port) Request reply
* # bits 31:27 => flag for reply
* # bits 26:00 => real address (bits 31:27) of reply arcmsr_cdb
* # bit31 : must be 0 (for this type of reply)
* # bit30 : reserved for BIOS handshake
* # bit29 : reserved
* # bit28 : 0 : no error, ignore AdapStatus/DevStatus/SenseData
* 1 : Error, see in AdapStatus/DevStatus/SenseData
* # bit27 : reserved
* 6. BIOS request
* All BIOS request is the same with request from PostQ
* Except :
* Request frame is sent from configuration space
* offset: 0x78 : Request Frame (bit30 == 1)
* offset: 0x18 : writeonly to generate IRQ to IOP331
* Completion of request:
* (bit30 == 0, bit28==err flag)
* 7. Definition of SGL entry (structure)
* 8. Message1 Out - Diag Status Code (????)
* 9. Message0 message code :
* 0x00 : NOP
* 0x01 : Get Config ->offset 0xa00
* : for outbound message code msgcode_rwbuffer
* (IOP331 send to driver)
* Signature 0x87974060(4)
* Request len 0x00000200(4)
* numbers of queue 0x00000100(4)
* SDRAM Size 0x00000100(4)-->256 MB
* IDE Channels 0x00000008(4)
* vendor 40 bytes char
* model 8 bytes char
* FirmVer 16 bytes char
* Device Map 16 bytes char
*
* FirmwareVersion DWORD
* <== Added for checking of new firmware capability
* 0x02 : Set Config ->offset 0xa00
* :for inbound message code msgcode_rwbuffer
* (driver send to IOP331)
* Signature 0x87974063(4)
* UPPER32 of Request Frame (4)-->Driver Only
* 0x03 : Reset (Abort all queued Command)
* 0x04 : Stop Background Activity
* 0x05 : Flush Cache
* 0x06 : Start Background Activity
* (re-start if background is halted)
* 0x07 : Check If Host Command Pending
* (Novell May Need This Function)
* 0x08 : Set controller time ->offset 0xa00 (driver to IOP331)
* : for inbound message code msgcode_rwbuffer
* byte 0 : 0xaa <-- signature
* byte 1 : 0x55 <-- signature
* byte 2 : year (04)
* byte 3 : month (1..12)
* byte 4 : date (1..31)
* byte 5 : hour (0..23)
* byte 6 : minute (0..59)
* byte 7 : second (0..59)
*
*/
/* signature of set and get firmware config */
/* message code of inbound message register */
/* doorbell interrupt generator */
/* ccb areca ccb flag */
/* outbound firmware ok */
/* dma burst sizes */
#ifndef BURSTSIZE
#define BURSTSIZE
#endif /* BURSTSIZE */
/*
*
*/
struct ARCMSR_CDB {
/* bit 0: 0(256) / 1(512) bytes */
/* bit 1: 0(from driver) / 1(from BIOS) */
/* bit 2: 0(Data in) / 1(Data out) */
/* bit 4/3 ,00 : simple Q,01 : head of Q,10 : ordered Q */
/*
* Device Status : the same from SCSI bus if error occur
* SCSI bus status codes.
*/
/* Scatter gather address */
union {
} sgu;
};
struct HBA_msgUnit {
/* ......local_buffer */
};
struct HBB_DOORBELL {
/*
* offset 0x00020400:00,01,02,03: window of "instruction flags"
* from driver to iop
*/
/* 04,05,06,07: doorbell mask */
/* 08,09,10,11: window of "instruction flags" from iop to driver */
/* 12,13,14,15: doorbell mask */
};
struct HBB_RWBUFFER {
/* offset 0x0000fa00: 0..1023: message code read write 1024bytes */
/* offset 0x0000fe00:1024...1151: user space data to iop 128bytes */
/* 1152...1279: message reserved */
/* offset 0x0000ff00:1280...1407: iop data to user space 128bytes */
};
struct HBB_msgUnit {
};
struct HBC_msgUnit {
};
struct msgUnit {
union {
} muu;
};
/*
* Adapter Control Block
*/
struct ACB {
int intr_count;
int intr_cap;
/* Offset for arc cdb physical to virtual calculations */
/* message unit ATU inbound base address0 virtual */
/* stop RAID background rebuild */
/* stop RAID background rebuild */
/* iop ioctl data rqbuffer overflow */
/* ioctl clear wqbuffer */
/* ioctl clear rqbuffer */
/* ioctl iop wqbuffer data readed */
/* iop init */
/* need hardware reset bus */
/* serial ccb pointer array */
/* working ccb pointer array */
/* done ccb array index */
/* start ccb array index */
/* data collection buffer for read from 80331 */
/* first of read buffer */
/* last of read buffer */
/* data collection buffer for write to 80331 */
/* first of write buffer */
/* last of write buffer */
/* id0 ..... id15,lun0...lun7 */
};
/*
* Command Control Block (SrbExtension)
*
* CCB must be not cross page boundary,and the order from offset 0
* structure describing an ATA disk request this CCB length must be
* 32 bytes boundary
*
*/
struct CCB
{
#define ARCMSR_ABNORMAL_MASK \
};
/* SenseData[15] */
struct SENSE_DATA {
};
struct SCSIInqData {
};
/*
* These definitions are the register offsets as defined in the Intel
* IOP manuals. See (correct as of 18 January 2008)
* for more details
*/
#define ARCMSR_MU_OUTBOUND_HANDLE_INT ( \
#ifdef __cplusplus
}
#endif
#endif /* _SYS_SCSI_ADAPTERS_ARCMSR_H */