Quelle  aacraid.h   Sprache: unbekannt

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Adaptec AAC series RAID controller driver
 * (c) Copyright 2001 Red Hat Inc. <alan@redhat.com>
 *
 * based on the old aacraid driver that is..
 * Adaptec aacraid device driver for Linux.
 *
 * Copyright (c) 2000-2010 Adaptec, Inc.
 *               2010-2015 PMC-Sierra, Inc. (aacraid@pmc-sierra.com)
 *  2016-2017 Microsemi Corp. (aacraid@microsemi.com)
 *
 * Module Name:
 *  aacraid.h
 *
 * Abstract: Contains all routines for control of the aacraid driver
 */

#ifndef _AACRAID_H_
#define _AACRAID_H_
#ifndef dprintk
# define dprintk(x)
#endif
/* eg: if (nblank(dprintk(x))) */
#define _nblank(x) #x
#define nblank(x) _nblank(x)[0]

#include <linux/interrupt.h>
#include <linux/completion.h>
#include <linux/pci.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_cmnd.h>

/*------------------------------------------------------------------------------
 *              D E F I N E S
 *----------------------------------------------------------------------------*/

#define AAC_MAX_MSIX  32 /* vectors */
#define AAC_PCI_MSI_ENABLE 0x8000

enum {
 AAC_ENABLE_INTERRUPT = 0x0,
 AAC_DISABLE_INTERRUPT,
 AAC_ENABLE_MSIX,
 AAC_DISABLE_MSIX,
 AAC_CLEAR_AIF_BIT,
 AAC_CLEAR_SYNC_BIT,
 AAC_ENABLE_INTX
};

#define AAC_INT_MODE_INTX  (1<<0)
#define AAC_INT_MODE_MSI  (1<<1)
#define AAC_INT_MODE_AIF  (1<<2)
#define AAC_INT_MODE_SYNC  (1<<3)
#define AAC_INT_MODE_MSIX  (1<<16)

#define AAC_INT_ENABLE_TYPE1_INTX 0xfffffffb
#define AAC_INT_ENABLE_TYPE1_MSIX 0xfffffffa
#define AAC_INT_DISABLE_ALL  0xffffffff

/* Bit definitions in IOA->Host Interrupt Register */
#define PMC_TRANSITION_TO_OPERATIONAL (1<<31)
#define PMC_IOARCB_TRANSFER_FAILED (1<<28)
#define PMC_IOA_UNIT_CHECK  (1<<27)
#define PMC_NO_HOST_RRQ_FOR_CMD_RESPONSE (1<<26)
#define PMC_CRITICAL_IOA_OP_IN_PROGRESS (1<<25)
#define PMC_IOARRIN_LOST  (1<<4)
#define PMC_SYSTEM_BUS_MMIO_ERROR (1<<3)
#define PMC_IOA_PROCESSOR_IN_ERROR_STATE (1<<2)
#define PMC_HOST_RRQ_VALID  (1<<1)
#define PMC_OPERATIONAL_STATUS  (1<<31)
#define PMC_ALLOW_MSIX_VECTOR0  (1<<0)

#define PMC_IOA_ERROR_INTERRUPTS (PMC_IOARCB_TRANSFER_FAILED | \
      PMC_IOA_UNIT_CHECK | \
      PMC_NO_HOST_RRQ_FOR_CMD_RESPONSE | \
      PMC_IOARRIN_LOST | \
      PMC_SYSTEM_BUS_MMIO_ERROR | \
      PMC_IOA_PROCESSOR_IN_ERROR_STATE)

#define PMC_ALL_INTERRUPT_BITS  (PMC_IOA_ERROR_INTERRUPTS | \
      PMC_HOST_RRQ_VALID | \
      PMC_TRANSITION_TO_OPERATIONAL | \
      PMC_ALLOW_MSIX_VECTOR0)
#define PMC_GLOBAL_INT_BIT2  0x00000004
#define PMC_GLOBAL_INT_BIT0  0x00000001

#ifndef AAC_DRIVER_BUILD
# define AAC_DRIVER_BUILD 50983
# define AAC_DRIVER_BRANCH "-custom"
#endif
#define MAXIMUM_NUM_CONTAINERS 32

#define AAC_NUM_MGT_FIB         8
#define AAC_NUM_IO_FIB  (1024 - AAC_NUM_MGT_FIB)

#define AAC_MAX_LUN  256

#define AAC_MAX_HOSTPHYSMEMPAGES (0xfffff)
#define AAC_MAX_32BIT_SGBCOUNT ((unsigned short)256)

#define AAC_DEBUG_INSTRUMENT_AIF_DELETE

#define AAC_MAX_NATIVE_TARGETS  1024
/* Thor: 5 phys. buses: #0: empty, 1-4: 256 targets each */
#define AAC_MAX_BUSES   5
#define AAC_MAX_TARGETS  256
#define AAC_BUS_TARGET_LOOP  (AAC_MAX_BUSES * AAC_MAX_TARGETS)
#define AAC_MAX_NATIVE_SIZE  2048
#define FW_ERROR_BUFFER_SIZE  512
#define AAC_SA_TIMEOUT   180
#define AAC_ARC_TIMEOUT   60

#define get_bus_number(x) (x/AAC_MAX_TARGETS)
#define get_target_number(x) (x%AAC_MAX_TARGETS)

/* Thor AIF events */
#define SA_AIF_HOTPLUG   (1<<1)
#define SA_AIF_HARDWARE  (1<<2)
#define SA_AIF_PDEV_CHANGE  (1<<4)
#define SA_AIF_LDEV_CHANGE  (1<<5)
#define SA_AIF_BPSTAT_CHANGE  (1<<30)
#define SA_AIF_BPCFG_CHANGE  (1U<<31)

#define HBA_MAX_SG_EMBEDDED  28
#define HBA_MAX_SG_SEPARATE  90
#define HBA_SENSE_DATA_LEN_MAX  32
#define HBA_REQUEST_TAG_ERROR_FLAG 0x00000002
#define HBA_SGL_FLAGS_EXT  0x80000000UL

struct aac_hba_sgl {
 u32  addr_lo; /* Lower 32-bits of SGL element address */
 u32  addr_hi; /* Upper 32-bits of SGL element address */
 u32  len; /* Length of SGL element in bytes */
 u32  flags; /* SGL element flags */
};

enum {
 HBA_IU_TYPE_SCSI_CMD_REQ  = 0x40,
 HBA_IU_TYPE_SCSI_TM_REQ   = 0x41,
 HBA_IU_TYPE_SATA_REQ   = 0x42,
 HBA_IU_TYPE_RESP   = 0x60,
 HBA_IU_TYPE_COALESCED_RESP  = 0x61,
 HBA_IU_TYPE_INT_COALESCING_CFG_REQ = 0x70
};

enum {
 HBA_CMD_BYTE1_DATA_DIR_IN  = 0x1,
 HBA_CMD_BYTE1_DATA_DIR_OUT  = 0x2,
 HBA_CMD_BYTE1_DATA_TYPE_DDR  = 0x4,
 HBA_CMD_BYTE1_CRYPTO_ENABLE  = 0x8
};

enum {
 HBA_CMD_BYTE1_BITOFF_DATA_DIR_IN = 0x0,
 HBA_CMD_BYTE1_BITOFF_DATA_DIR_OUT,
 HBA_CMD_BYTE1_BITOFF_DATA_TYPE_DDR,
 HBA_CMD_BYTE1_BITOFF_CRYPTO_ENABLE
};

enum {
 HBA_RESP_DATAPRES_NO_DATA  = 0x0,
 HBA_RESP_DATAPRES_RESPONSE_DATA,
 HBA_RESP_DATAPRES_SENSE_DATA
};

enum {
 HBA_RESP_SVCRES_TASK_COMPLETE  = 0x0,
 HBA_RESP_SVCRES_FAILURE,
 HBA_RESP_SVCRES_TMF_COMPLETE,
 HBA_RESP_SVCRES_TMF_SUCCEEDED,
 HBA_RESP_SVCRES_TMF_REJECTED,
 HBA_RESP_SVCRES_TMF_LUN_INVALID
};

enum {
 HBA_RESP_STAT_IO_ERROR   = 0x1,
 HBA_RESP_STAT_IO_ABORTED,
 HBA_RESP_STAT_NO_PATH_TO_DEVICE,
 HBA_RESP_STAT_INVALID_DEVICE,
 HBA_RESP_STAT_HBAMODE_DISABLED  = 0xE,
 HBA_RESP_STAT_UNDERRUN   = 0x51,
 HBA_RESP_STAT_OVERRUN   = 0x75
};

struct aac_hba_cmd_req {
 u8 iu_type; /* HBA information unit type */
 /*
 * byte1:
 * [1:0] DIR - 0=No data, 0x1 = IN, 0x2 = OUT
 * [2]   TYPE - 0=PCI, 1=DDR
 * [3]   CRYPTO_ENABLE - 0=Crypto disabled, 1=Crypto enabled
 */
 u8 byte1;
 u8 reply_qid; /* Host reply queue to post response to */
 u8 reserved1;
 __le32 it_nexus; /* Device handle for the request */
 __le32 request_id; /* Sender context */
 /* Lower 32-bits of tweak value for crypto enabled IOs */
 __le32 tweak_value_lo;
 u8 cdb[16]; /* SCSI CDB of the command */
 u8 lun[8];  /* SCSI LUN of the command */

 /* Total data length in bytes to be read/written (if any) */
 __le32 data_length;

 /* [2:0] Task Attribute, [6:3] Command Priority */
 u8 attr_prio;

 /* Number of SGL elements embedded in the HBA req */
 u8 emb_data_desc_count;

 __le16 dek_index; /* DEK index for crypto enabled IOs */

 /* Lower 32-bits of reserved error data target location on the host */
 __le32 error_ptr_lo;

 /* Upper 32-bits of reserved error data target location on the host */
 __le32 error_ptr_hi;

 /* Length of reserved error data area on the host in bytes */
 __le32 error_length;

 /* Upper 32-bits of tweak value for crypto enabled IOs */
 __le32 tweak_value_hi;

 struct aac_hba_sgl sge[HBA_MAX_SG_SEPARATE+2]; /* SG list space */

 /*
 * structure must not exceed
 * AAC_MAX_NATIVE_SIZE-FW_ERROR_BUFFER_SIZE
 */
};

/* Task Management Functions (TMF) */
#define HBA_TMF_ABORT_TASK 0x01
#define HBA_TMF_LUN_RESET 0x08

struct aac_hba_tm_req {
 u8 iu_type; /* HBA information unit type */
 u8 reply_qid; /* Host reply queue to post response to */
 u8 tmf;  /* Task management function */
 u8 reserved1;

 __le32 it_nexus; /* Device handle for the command */

 u8 lun[8];  /* SCSI LUN */

 /* Used to hold sender context. */
 __le32 request_id; /* Sender context */
 __le32 reserved2;

 /* Request identifier of managed task */
 __le32 managed_request_id; /* Sender context being managed */
 __le32 reserved3;

 /* Lower 32-bits of reserved error data target location on the host */
 __le32 error_ptr_lo;
 /* Upper 32-bits of reserved error data target location on the host */
 __le32 error_ptr_hi;
 /* Length of reserved error data area on the host in bytes */
 __le32 error_length;
};

struct aac_hba_reset_req {
 u8 iu_type; /* HBA information unit type */
 /* 0 - reset specified device, 1 - reset all devices */
 u8 reset_type;
 u8 reply_qid; /* Host reply queue to post response to */
 u8 reserved1;

 __le32 it_nexus; /* Device handle for the command */
 __le32 request_id; /* Sender context */
 /* Lower 32-bits of reserved error data target location on the host */
 __le32 error_ptr_lo;
 /* Upper 32-bits of reserved error data target location on the host */
 __le32 error_ptr_hi;
 /* Length of reserved error data area on the host in bytes */
 __le32 error_length;
};

struct aac_hba_resp {
 u8 iu_type;  /* HBA information unit type */
 u8 reserved1[3];
 __le32 request_identifier; /* sender context */
 __le32 reserved2;
 u8 service_response; /* SCSI service response */
 u8 status;   /* SCSI status */
 u8 datapres; /* [1:0] - data present, [7:2] - reserved */
 u8 sense_response_data_len; /* Sense/response data length */
 __le32 residual_count;  /* Residual data length in bytes */
 /* Sense/response data */
 u8 sense_response_buf[HBA_SENSE_DATA_LEN_MAX];
};

struct aac_native_hba {
 union {
  struct aac_hba_cmd_req cmd;
  struct aac_hba_tm_req tmr;
  u8 cmd_bytes[AAC_MAX_NATIVE_SIZE-FW_ERROR_BUFFER_SIZE];
 } cmd;
 union {
  struct aac_hba_resp err;
  u8 resp_bytes[FW_ERROR_BUFFER_SIZE];
 } resp;
};

#define CISS_REPORT_PHYSICAL_LUNS 0xc3
#define WRITE_HOST_WELLNESS  0xa5
#define CISS_IDENTIFY_PHYSICAL_DEVICE 0x15
#define BMIC_IN   0x26
#define BMIC_OUT   0x27

struct aac_ciss_phys_luns_resp {
 u8 list_length[4];  /* LUN list length (N-7, big endian) */
 u8 resp_flag;  /* extended response_flag */
 u8 reserved[3];
 struct _ciss_lun {
  u8 tid[3];  /* Target ID */
  u8 bus;  /* Bus, flag (bits 6,7) */
  u8 level3[2];
  u8 level2[2];
  u8 node_ident[16]; /* phys. node identifier */
 } lun[];   /* List of phys. devices */
};

/*
 * Interrupts
 */
#define AAC_MAX_HRRQ  64

struct aac_ciss_identify_pd {
 u8 scsi_bus;   /* SCSI Bus number on controller */
 u8 scsi_id;   /* SCSI ID on this bus */
 u16 block_size;   /* sector size in bytes */
 u32 total_blocks;  /* number for sectors on drive */
 u32 reserved_blocks;  /* controller reserved (RIS) */
 u8 model[40];   /* Physical Drive Model */
 u8 serial_number[40];  /* Drive Serial Number */
 u8 firmware_revision[8]; /* drive firmware revision */
 u8 scsi_inquiry_bits;  /* inquiry byte 7 bits */
 u8 compaq_drive_stamp;  /* 0 means drive not stamped */
 u8 last_failure_reason;

 u8  flags;
 u8  more_flags;
 u8  scsi_lun;   /* SCSI LUN for phys drive */
 u8  yet_more_flags;
 u8  even_more_flags;
 u32 spi_speed_rules;  /* SPI Speed :Ultra disable diagnose */
 u8  phys_connector[2];  /* connector number on controller */
 u8  phys_box_on_bus;  /* phys enclosure this drive resides */
 u8  phys_bay_in_box;  /* phys drv bay this drive resides */
 u32 rpm;   /* Drive rotational speed in rpm */
 u8  device_type;  /* type of drive */
 u8  sata_version;  /* only valid when drive_type is SATA */
 u64 big_total_block_count;
 u64 ris_starting_lba;
 u32 ris_size;
 u8  wwid[20];
 u8  controller_phy_map[32];
 u16 phy_count;
 u8  phy_connected_dev_type[256];
 u8  phy_to_drive_bay_num[256];
 u16 phy_to_attached_dev_index[256];
 u8  box_index;
 u8  spitfire_support;
 u16 extra_physical_drive_flags;
 u8  negotiated_link_rate[256];
 u8  phy_to_phy_map[256];
 u8  redundant_path_present_map;
 u8  redundant_path_failure_map;
 u8  active_path_number;
 u16 alternate_paths_phys_connector[8];
 u8  alternate_paths_phys_box_on_port[8];
 u8  multi_lun_device_lun_count;
 u8  minimum_good_fw_revision[8];
 u8  unique_inquiry_bytes[20];
 u8  current_temperature_degreesC;
 u8  temperature_threshold_degreesC;
 u8  max_temperature_degreesC;
 u8  logical_blocks_per_phys_block_exp; /* phyblocksize = 512 * 2^exp */
 u16 current_queue_depth_limit;
 u8  switch_name[10];
 u16 switch_port;
 u8  alternate_paths_switch_name[40];
 u8  alternate_paths_switch_port[8];
 u16 power_on_hours;  /* valid only if gas gauge supported */
 u16 percent_endurance_used; /* valid only if gas gauge supported. */
 u8  drive_authentication;
 u8  smart_carrier_authentication;
 u8  smart_carrier_app_fw_version;
 u8  smart_carrier_bootloader_fw_version;
 u8  SanitizeSecureEraseSupport;
 u8  DriveKeyFlags;
 u8  encryption_key_name[64];
 u32 misc_drive_flags;
 u16 dek_index;
 u16 drive_encryption_flags;
 u8  sanitize_maximum_time[6];
 u8  connector_info_mode;
 u8  connector_info_number[4];
 u8  long_connector_name[64];
 u8  device_unique_identifier[16];
 u8  padto_2K[17];
} __packed;

/*
 * These macros convert from physical channels to virtual channels
 */
#define CONTAINER_CHANNEL  (0)
#define NATIVE_CHANNEL   (1)
#define CONTAINER_TO_CHANNEL(cont) (CONTAINER_CHANNEL)
#define CONTAINER_TO_ID(cont)  (cont)
#define CONTAINER_TO_LUN(cont)  (0)
#define ENCLOSURE_CHANNEL  (3)

#define PMC_DEVICE_S6 0x28b
#define PMC_DEVICE_S7 0x28c
#define PMC_DEVICE_S8 0x28d

#define aac_phys_to_logical(x)  ((x)+1)
#define aac_logical_to_phys(x)  ((x)?(x)-1:0)

/*
 * These macros are for keeping track of
 * character device state.
 */
#define AAC_CHARDEV_UNREGISTERED (-1)
#define AAC_CHARDEV_NEEDS_REINIT (-2)

/* #define AAC_DETAILED_STATUS_INFO */

struct diskparm
{
 int heads;
 int sectors;
 int cylinders;
};


/*
 * Firmware constants
 */

#define  CT_NONE   0
#define  CT_OK   218
#define  FT_FILESYS 8 /* ADAPTEC's "FSA"(tm) filesystem */
#define  FT_DRIVE 9 /* physical disk - addressable in scsi by bus/id/lun */

/*
 * Host side memory scatter gather list
 * Used by the adapter for read, write, and readdirplus operations
 * We have separate 32 and 64 bit version because even
 * on 64 bit systems not all cards support the 64 bit version
 */
struct sgentry {
 __le32 addr; /* 32-bit address. */
 __le32 count; /* Length. */
};

struct user_sgentry {
 u32 addr; /* 32-bit address. */
 u32 count; /* Length. */
};

struct sgentry64 {
 __le32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
 __le32 count; /* Length. */
};

struct user_sgentry64 {
 u32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
 u32 count; /* Length. */
};

struct sgentryraw {
 __le32  next; /* reserved for F/W use */
 __le32  prev; /* reserved for F/W use */
 __le32  addr[2];
 __le32  count;
 __le32  flags; /* reserved for F/W use */
};

struct user_sgentryraw {
 u32  next; /* reserved for F/W use */
 u32  prev; /* reserved for F/W use */
 u32  addr[2];
 u32  count;
 u32  flags; /* reserved for F/W use */
};

struct sge_ieee1212 {
 u32 addrLow;
 u32 addrHigh;
 u32 length;
 u32 flags;
};

/*
 * SGMAP
 *
 * This is the SGMAP structure for all commands that use
 * 32-bit addressing.
 */

struct sgmap {
 __le32  count;
 struct sgentry sg[];
};

struct user_sgmap {
 u32  count;
 struct user_sgentry sg[];
};

struct sgmap64 {
 __le32  count;
 struct sgentry64 sg[];
};

struct user_sgmap64 {
 u32  count;
 struct user_sgentry64 sg[];
};

struct sgmapraw {
 __le32    count;
 struct sgentryraw sg[];
};

struct creation_info
{
 u8  buildnum;  /* e.g., 588 */
 u8  usec;   /* e.g., 588 */
 u8  via;   /* e.g., 1 = FSU,
 *  2 = API
 */
 u8  year;   /* e.g., 1997 = 97 */
 __le32  date;   /*
 * unsigned Month :4; // 1 - 12
 * unsigned Day :6; // 1 - 32
 * unsigned Hour :6; // 0 - 23
 * unsigned Minute :6; // 0 - 60
 * unsigned Second :6; // 0 - 60
 */
 __le32  serial[2];   /* e.g., 0x1DEADB0BFAFAF001 */
};


/*
 * Define all the constants needed for the communication interface
 */

/*
 * Define how many queue entries each queue will have and the total
 * number of entries for the entire communication interface. Also define
 * how many queues we support.
 *
 * This has to match the controller
 */

#define NUMBER_OF_COMM_QUEUES  8   // 4 command; 4 response
#define HOST_HIGH_CMD_ENTRIES  4
#define HOST_NORM_CMD_ENTRIES  8
#define ADAP_HIGH_CMD_ENTRIES  4
#define ADAP_NORM_CMD_ENTRIES  512
#define HOST_HIGH_RESP_ENTRIES 4
#define HOST_NORM_RESP_ENTRIES 512
#define ADAP_HIGH_RESP_ENTRIES 4
#define ADAP_NORM_RESP_ENTRIES 8

#define TOTAL_QUEUE_ENTRIES  \
    (HOST_NORM_CMD_ENTRIES + HOST_HIGH_CMD_ENTRIES + ADAP_NORM_CMD_ENTRIES + ADAP_HIGH_CMD_ENTRIES + \
     HOST_NORM_RESP_ENTRIES + HOST_HIGH_RESP_ENTRIES + ADAP_NORM_RESP_ENTRIES + ADAP_HIGH_RESP_ENTRIES)


/*
 * Set the queues on a 16 byte alignment
 */

#define QUEUE_ALIGNMENT  16

/*
 * The queue headers define the Communication Region queues. These
 * are physically contiguous and accessible by both the adapter and the
 * host. Even though all queue headers are in the same contiguous block
 * they will be represented as individual units in the data structures.
 */

struct aac_entry {
 __le32 size; /* Size in bytes of Fib which this QE points to */
 __le32 addr; /* Receiver address of the FIB */
};

/*
 * The adapter assumes the ProducerIndex and ConsumerIndex are grouped
 * adjacently and in that order.
 */

struct aac_qhdr {
 __le64 header_addr;/* Address to hand the adapter to access
      to this queue head */
 __le32 *producer; /* The producer index for this queue (host address) */
 __le32 *consumer; /* The consumer index for this queue (host address) */
};

/*
 * Define all the events which the adapter would like to notify
 * the host of.
 */

#define  HostNormCmdQue  1 /* Change in host normal priority command queue */
#define  HostHighCmdQue  2 /* Change in host high priority command queue */
#define  HostNormRespQue  3 /* Change in host normal priority response queue */
#define  HostHighRespQue  4 /* Change in host high priority response queue */
#define  AdapNormRespNotFull 5
#define  AdapHighRespNotFull 6
#define  AdapNormCmdNotFull 7
#define  AdapHighCmdNotFull 8
#define  SynchCommandComplete 9
#define  AdapInternalError 0xfe    /* The adapter detected an internal error shutting down */

/*
 * Define all the events the host wishes to notify the
 * adapter of. The first four values much match the Qid the
 * corresponding queue.
 */

#define  AdapNormCmdQue  2
#define  AdapHighCmdQue  3
#define  AdapNormRespQue  6
#define  AdapHighRespQue  7
#define  HostShutdown  8
#define  HostPowerFail  9
#define  FatalCommError  10
#define  HostNormRespNotFull 11
#define  HostHighRespNotFull 12
#define  HostNormCmdNotFull 13
#define  HostHighCmdNotFull 14
#define  FastIo   15
#define  AdapPrintfDone  16

/*
 * Define all the queues that the adapter and host use to communicate
 * Number them to match the physical queue layout.
 */

enum aac_queue_types {
        HostNormCmdQueue = 0, /* Adapter to host normal priority command traffic */
        HostHighCmdQueue, /* Adapter to host high priority command traffic */
        AdapNormCmdQueue, /* Host to adapter normal priority command traffic */
        AdapHighCmdQueue, /* Host to adapter high priority command traffic */
        HostNormRespQueue, /* Adapter to host normal priority response traffic */
        HostHighRespQueue, /* Adapter to host high priority response traffic */
        AdapNormRespQueue, /* Host to adapter normal priority response traffic */
        AdapHighRespQueue /* Host to adapter high priority response traffic */
};

/*
 * Assign type values to the FSA communication data structures
 */

#define  FIB_MAGIC 0x0001
#define  FIB_MAGIC2 0x0004
#define  FIB_MAGIC2_64 0x0005

/*
 * Define the priority levels the FSA communication routines support.
 */

#define  FsaNormal 1

/* transport FIB header (PMC) */
struct aac_fib_xporthdr {
 __le64 HostAddress; /* FIB host address w/o xport header */
 __le32 Size;  /* FIB size excluding xport header */
 __le32 Handle;  /* driver handle to reference the FIB */
 __le64 Reserved[2];
};

#define  ALIGN32  32

/*
 * Define the FIB. The FIB is the where all the requested data and
 * command information are put to the application on the FSA adapter.
 */

struct aac_fibhdr {
 __le32 XferState; /* Current transfer state for this CCB */
 __le16 Command;  /* Routing information for the destination */
 u8 StructType;  /* Type FIB */
 u8 Unused;  /* Unused */
 __le16 Size;  /* Size of this FIB in bytes */
 __le16 SenderSize; /* Size of the FIB in the sender
   (for response sizing) */
 __le32 SenderFibAddress;  /* Host defined data in the FIB */
 union {
  __le32 ReceiverFibAddress;/* Logical address of this FIB for
     the adapter (old) */
  __le32 SenderFibAddressHigh;/* upper 32bit of phys. FIB address */
  __le32 TimeStamp; /* otherwise timestamp for FW internal use */
 } u;
 __le32 Handle;  /* FIB handle used for MSGU commnunication */
 u32 Previous;  /* FW internal use */
 u32 Next;  /* FW internal use */
};

struct hw_fib {
 struct aac_fibhdr header;
 u8 data[512-sizeof(struct aac_fibhdr)]; // Command specific data
};

/*
 * FIB commands
 */

#define  TestCommandResponse  1
#define  TestAdapterCommand  2
/*
 * Lowlevel and comm commands
 */
#define  LastTestCommand   100
#define  ReinitHostNormCommandQueue 101
#define  ReinitHostHighCommandQueue 102
#define  ReinitHostHighRespQueue  103
#define  ReinitHostNormRespQueue  104
#define  ReinitAdapNormCommandQueue 105
#define  ReinitAdapHighCommandQueue 107
#define  ReinitAdapHighRespQueue  108
#define  ReinitAdapNormRespQueue  109
#define  InterfaceShutdown  110
#define  DmaCommandFib   120
#define  StartProfile   121
#define  TermProfile   122
#define  SpeedTest   123
#define  TakeABreakPt   124
#define  RequestPerfData   125
#define  SetInterruptDefTimer  126
#define  SetInterruptDefCount  127
#define  GetInterruptDefStatus  128
#define  LastCommCommand   129
/*
 * Filesystem commands
 */
#define  NuFileSystem   300
#define  UFS    301
#define  HostFileSystem   302
#define  LastFileSystemCommand  303
/*
 * Container Commands
 */
#define  ContainerCommand  500
#define  ContainerCommand64  501
#define  ContainerRawIo   502
#define  ContainerRawIo2   503
/*
 * Scsi Port commands (scsi passthrough)
 */
#define  ScsiPortCommand   600
#define  ScsiPortCommand64  601
/*
 * Misc house keeping and generic adapter initiated commands
 */
#define  AifRequest   700
#define  CheckRevision   701
#define  FsaHostShutdown   702
#define  RequestAdapterInfo  703
#define  IsAdapterPaused   704
#define  SendHostTime   705
#define  RequestSupplementAdapterInfo 706
#define  LastMiscCommand   707

/*
 * Commands that will target the failover level on the FSA adapter
 */

enum fib_xfer_state {
 HostOwned   = (1<<0),
 AdapterOwned   = (1<<1),
 FibInitialized   = (1<<2),
 FibEmpty   = (1<<3),
 AllocatedFromPool  = (1<<4),
 SentFromHost   = (1<<5),
 SentFromAdapter   = (1<<6),
 ResponseExpected  = (1<<7),
 NoResponseExpected  = (1<<8),
 AdapterProcessed  = (1<<9),
 HostProcessed   = (1<<10),
 HighPriority   = (1<<11),
 NormalPriority   = (1<<12),
 Async    = (1<<13),
 AsyncIo    = (1<<13), // rpbfix: remove with new regime
 PageFileIo   = (1<<14), // rpbfix: remove with new regime
 ShutdownRequest   = (1<<15),
 LazyWrite   = (1<<16), // rpbfix: remove with new regime
 AdapterMicroFib   = (1<<17),
 BIOSFibPath   = (1<<18),
 FastResponseCapable  = (1<<19),
 ApiFib    = (1<<20), /* Its an API Fib */
 /* PMC NEW COMM: There is no more AIF data pending */
 NoMoreAifDataAvailable  = (1<<21)
};

/*
 * The following defines needs to be updated any time there is an
 * incompatible change made to the aac_init structure.
 */

#define ADAPTER_INIT_STRUCT_REVISION  3
#define ADAPTER_INIT_STRUCT_REVISION_4  4 // rocket science
#define ADAPTER_INIT_STRUCT_REVISION_6  6 /* PMC src */
#define ADAPTER_INIT_STRUCT_REVISION_7  7 /* Denali */
#define ADAPTER_INIT_STRUCT_REVISION_8  8 // Thor

union aac_init
{
 struct _r7 {
  __le32 init_struct_revision;
  __le32 no_of_msix_vectors;
  __le32 fsrev;
  __le32 comm_header_address;
  __le32 fast_io_comm_area_address;
  __le32 adapter_fibs_physical_address;
  __le32 adapter_fibs_virtual_address;
  __le32 adapter_fibs_size;
  __le32 adapter_fib_align;
  __le32 printfbuf;
  __le32 printfbufsiz;
  /* number of 4k pages of host phys. mem. */
  __le32 host_phys_mem_pages;
  /* number of seconds since 1970. */
  __le32 host_elapsed_seconds;
  /* ADAPTER_INIT_STRUCT_REVISION_4 begins here */
  __le32 init_flags; /* flags for supported features */
#define INITFLAGS_NEW_COMM_SUPPORTED 0x00000001
#define INITFLAGS_DRIVER_USES_UTC_TIME 0x00000010
#define INITFLAGS_DRIVER_SUPPORTS_PM 0x00000020
#define INITFLAGS_NEW_COMM_TYPE1_SUPPORTED 0x00000040
#define INITFLAGS_FAST_JBOD_SUPPORTED 0x00000080
#define INITFLAGS_NEW_COMM_TYPE2_SUPPORTED 0x00000100
#define INITFLAGS_DRIVER_SUPPORTS_HBA_MODE  0x00000400
  __le32 max_io_commands; /* max outstanding commands */
  __le32 max_io_size; /* largest I/O command */
  __le32 max_fib_size; /* largest FIB to adapter */
  /* ADAPTER_INIT_STRUCT_REVISION_5 begins here */
  __le32 max_num_aif; /* max number of aif */
  /* ADAPTER_INIT_STRUCT_REVISION_6 begins here */
  /* Host RRQ (response queue) for SRC */
  __le32 host_rrq_addr_low;
  __le32 host_rrq_addr_high;
 } r7;
 struct _r8 {
  /* ADAPTER_INIT_STRUCT_REVISION_8 */
  __le32 init_struct_revision;
  __le32 rr_queue_count;
  __le32 host_elapsed_seconds; /* number of secs since 1970. */
  __le32 init_flags;
  __le32 max_io_size; /* largest I/O command */
  __le32 max_num_aif; /* max number of aif */
  __le32 reserved1;
  __le32 reserved2;
  struct _rrq {
   __le32 host_addr_low;
   __le32 host_addr_high;
   __le16 msix_id;
   __le16 element_count;
   __le16 comp_thresh;
   __le16 unused;
  } rrq[] __counted_by_le(rr_queue_count); /* up to 64 RRQ addresses */
 } r8;
};

enum aac_log_level {
 LOG_AAC_INIT   = 10,
 LOG_AAC_INFORMATIONAL  = 20,
 LOG_AAC_WARNING   = 30,
 LOG_AAC_LOW_ERROR  = 40,
 LOG_AAC_MEDIUM_ERROR  = 50,
 LOG_AAC_HIGH_ERROR  = 60,
 LOG_AAC_PANIC   = 70,
 LOG_AAC_DEBUG   = 80,
 LOG_AAC_WINDBG_PRINT  = 90
};

#define FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT 0x030b
#define FSAFS_NTC_FIB_CONTEXT   0x030c

struct aac_dev;
struct fib;
struct scsi_cmnd;

struct adapter_ops
{
 /* Low level operations */
 void (*adapter_interrupt)(struct aac_dev *dev);
 void (*adapter_notify)(struct aac_dev *dev, u32 event);
 void (*adapter_disable_int)(struct aac_dev *dev);
 void (*adapter_enable_int)(struct aac_dev *dev);
 int  (*adapter_sync_cmd)(struct aac_dev *dev, u32 command, u32 p1, u32 p2, u32 p3, u32 p4, u32 p5, u32 p6, u32 *status, u32 *r1, u32 *r2, u32 *r3, u32 *r4);
 int  (*adapter_check_health)(struct aac_dev *dev);
 int  (*adapter_restart)(struct aac_dev *dev, int bled, u8 reset_type);
 void (*adapter_start)(struct aac_dev *dev);
 /* Transport operations */
 int  (*adapter_ioremap)(struct aac_dev * dev, u32 size);
 irq_handler_t adapter_intr;
 /* Packet operations */
 int  (*adapter_deliver)(struct fib * fib);
 int  (*adapter_bounds)(struct aac_dev * dev, struct scsi_cmnd * cmd, u64 lba);
 int  (*adapter_read)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count);
 int  (*adapter_write)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count, int fua);
 int  (*adapter_scsi)(struct fib * fib, struct scsi_cmnd * cmd);
 /* Administrative operations */
 int  (*adapter_comm)(struct aac_dev * dev, int comm);
};

/*
 * Define which interrupt handler needs to be installed
 */

struct aac_driver_ident
{
 int (*init)(struct aac_dev *dev);
 char * name;
 char * vname;
 char * model;
 u16 channels;
 int quirks;
};
/*
 * Some adapter firmware needs communication memory
 * below 2gig. This tells the init function to set the
 * dma mask such that fib memory will be allocated where the
 * adapter firmware can get to it.
 */
#define AAC_QUIRK_31BIT 0x0001

/*
 * Some adapter firmware, when the raid card's cache is turned off, can not
 * split up scatter gathers in order to deal with the limits of the
 * underlying CHIM. This limit is 34 scatter gather elements.
 */
#define AAC_QUIRK_34SG 0x0002

/*
 * This adapter is a slave (no Firmware)
 */
#define AAC_QUIRK_SLAVE 0x0004

/*
 * This adapter is a master.
 */
#define AAC_QUIRK_MASTER 0x0008

/*
 * Some adapter firmware perform poorly when it must split up scatter gathers
 * in order to deal with the limits of the underlying CHIM. This limit in this
 * class of adapters is 17 scatter gather elements.
 */
#define AAC_QUIRK_17SG 0x0010

/*
 * Some adapter firmware does not support 64 bit scsi passthrough
 * commands.
 */
#define AAC_QUIRK_SCSI_32 0x0020

/*
 * SRC based adapters support the AifReqEvent functions
 */
#define AAC_QUIRK_SRC 0x0040

/*
 * The adapter interface specs all queues to be located in the same
 * physically contiguous block. The host structure that defines the
 * commuication queues will assume they are each a separate physically
 * contiguous memory region that will support them all being one big
 * contiguous block.
 * There is a command and response queue for each level and direction of
 * commuication. These regions are accessed by both the host and adapter.
 */

struct aac_queue {
 u64   logical; /*address we give the adapter */
 struct aac_entry *base;  /*system virtual address */
 struct aac_qhdr  headers; /*producer,consumer q headers*/
 u32   entries; /*Number of queue entries */
 wait_queue_head_t qfull;  /*Event to wait on if q full */
 wait_queue_head_t cmdready; /*Cmd ready from the adapter */
  /* This is only valid for adapter to host command queues. */
 spinlock_t  *lock;  /* Spinlock for this queue must take this lock before accessing the lock */
 spinlock_t  lockdata; /* Actual lock (used only on one side of the lock) */
 struct list_head cmdq;  /* A queue of FIBs which need to be prcessed by the FS thread. This is */
      /* only valid for command queues which receive entries from the adapter. */
 /* Number of entries on outstanding queue. */
 atomic_t  numpending;
 struct aac_dev * dev;  /* Back pointer to adapter structure */
};

/*
 * Message queues. The order here is important, see also the
 * queue type ordering
 */

struct aac_queue_block
{
 struct aac_queue queue[8];
};

/*
 * SaP1 Message Unit Registers
 */

struct sa_drawbridge_CSR {
    /* Offset |  Name */
 __le32 reserved[10]; /* 00h-27h |  Reserved */
 u8 LUT_Offset; /* 28h |  Lookup Table Offset */
 u8 reserved1[3]; /* 29h-2bh |  Reserved */
 __le32 LUT_Data; /* 2ch |  Looup Table Data */
 __le32 reserved2[26]; /* 30h-97h |  Reserved */
 __le16 PRICLEARIRQ; /* 98h |  Primary Clear Irq */
 __le16 SECCLEARIRQ; /* 9ah |  Secondary Clear Irq */
 __le16 PRISETIRQ; /* 9ch |  Primary Set Irq */
 __le16 SECSETIRQ; /* 9eh |  Secondary Set Irq */
 __le16 PRICLEARIRQMASK;/* a0h |  Primary Clear Irq Mask */
 __le16 SECCLEARIRQMASK;/* a2h |  Secondary Clear Irq Mask */
 __le16 PRISETIRQMASK; /* a4h |  Primary Set Irq Mask */
 __le16 SECSETIRQMASK; /* a6h |  Secondary Set Irq Mask */
 __le32 MAILBOX0; /* a8h |  Scratchpad 0 */
 __le32 MAILBOX1; /* ach |  Scratchpad 1 */
 __le32 MAILBOX2; /* b0h |  Scratchpad 2 */
 __le32 MAILBOX3; /* b4h |  Scratchpad 3 */
 __le32 MAILBOX4; /* b8h |  Scratchpad 4 */
 __le32 MAILBOX5; /* bch |  Scratchpad 5 */
 __le32 MAILBOX6; /* c0h |  Scratchpad 6 */
 __le32 MAILBOX7; /* c4h |  Scratchpad 7 */
 __le32 ROM_Setup_Data; /* c8h |  Rom Setup and Data */
 __le32 ROM_Control_Addr;/* cch |  Rom Control and Address */
 __le32 reserved3[12]; /* d0h-ffh |  reserved */
 __le32 LUT[64]; /*    100h-1ffh |  Lookup Table Entries */
};

#define Mailbox0 SaDbCSR.MAILBOX0
#define Mailbox1 SaDbCSR.MAILBOX1
#define Mailbox2 SaDbCSR.MAILBOX2
#define Mailbox3 SaDbCSR.MAILBOX3
#define Mailbox4 SaDbCSR.MAILBOX4
#define Mailbox5 SaDbCSR.MAILBOX5
#define Mailbox6 SaDbCSR.MAILBOX6
#define Mailbox7 SaDbCSR.MAILBOX7

#define DoorbellReg_p SaDbCSR.PRISETIRQ
#define DoorbellReg_s SaDbCSR.SECSETIRQ
#define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ


#define DOORBELL_0 0x0001
#define DOORBELL_1 0x0002
#define DOORBELL_2 0x0004
#define DOORBELL_3 0x0008
#define DOORBELL_4 0x0010
#define DOORBELL_5 0x0020
#define DOORBELL_6 0x0040


#define PrintfReady DOORBELL_5
#define PrintfDone DOORBELL_5

struct sa_registers {
 struct sa_drawbridge_CSR SaDbCSR;   /* 98h - c4h */
};


#define SA_INIT_NUM_MSIXVECTORS  1
#define SA_MINIPORT_REVISION  SA_INIT_NUM_MSIXVECTORS

#define sa_readw(AEP, CSR)  readl(&((AEP)->regs.sa->CSR))
#define sa_readl(AEP, CSR)  readl(&((AEP)->regs.sa->CSR))
#define sa_writew(AEP, CSR, value) writew(value, &((AEP)->regs.sa->CSR))
#define sa_writel(AEP, CSR, value) writel(value, &((AEP)->regs.sa->CSR))

/*
 * Rx Message Unit Registers
 */

struct rx_mu_registers {
       /* Local  | PCI*| Name */
 __le32 ARSR;     /* 1300h  | 00h | APIC Register Select Register */
 __le32 reserved0;  /* 1304h  | 04h | Reserved */
 __le32 AWR;     /* 1308h  | 08h | APIC Window Register */
 __le32 reserved1;  /* 130Ch  | 0Ch | Reserved */
 __le32 IMRx[2];    /* 1310h  | 10h | Inbound Message Registers */
 __le32 OMRx[2];    /* 1318h  | 18h | Outbound Message Registers */
 __le32 IDR;     /* 1320h  | 20h | Inbound Doorbell Register */
 __le32 IISR;     /* 1324h  | 24h | Inbound Interrupt
Status Register */
 __le32 IIMR;     /* 1328h  | 28h | Inbound Interrupt
Mask Register */
 __le32 ODR;     /* 132Ch  | 2Ch | Outbound Doorbell Register */
 __le32 OISR;     /* 1330h  | 30h | Outbound Interrupt
Status Register */
 __le32 OIMR;     /* 1334h  | 34h | Outbound Interrupt
Mask Register */
 __le32 reserved2;  /* 1338h  | 38h | Reserved */
 __le32 reserved3;  /* 133Ch  | 3Ch | Reserved */
 __le32 InboundQueue;/* 1340h  | 40h | Inbound Queue Port relative to firmware */
 __le32 OutboundQueue;/*1344h  | 44h | Outbound Queue Port relative to firmware */
       /* * Must access through ATU Inbound
 Translation Window */
};

struct rx_inbound {
 __le32 Mailbox[8];
};

#define INBOUNDDOORBELL_0 0x00000001
#define INBOUNDDOORBELL_1 0x00000002
#define INBOUNDDOORBELL_2 0x00000004
#define INBOUNDDOORBELL_3 0x00000008
#define INBOUNDDOORBELL_4 0x00000010
#define INBOUNDDOORBELL_5 0x00000020
#define INBOUNDDOORBELL_6 0x00000040

#define OUTBOUNDDOORBELL_0 0x00000001
#define OUTBOUNDDOORBELL_1 0x00000002
#define OUTBOUNDDOORBELL_2 0x00000004
#define OUTBOUNDDOORBELL_3 0x00000008
#define OUTBOUNDDOORBELL_4 0x00000010

#define InboundDoorbellReg MUnit.IDR
#define OutboundDoorbellReg MUnit.ODR

struct rx_registers {
 struct rx_mu_registers  MUnit;  /* 1300h - 1347h */
 __le32    reserved1[2]; /* 1348h - 134ch */
 struct rx_inbound  IndexRegs;
};

#define rx_readb(AEP, CSR)  readb(&((AEP)->regs.rx->CSR))
#define rx_readl(AEP, CSR)  readl(&((AEP)->regs.rx->CSR))
#define rx_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rx->CSR))
#define rx_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rx->CSR))

/*
 * Rkt Message Unit Registers (same as Rx, except a larger reserve region)
 */

#define rkt_mu_registers rx_mu_registers
#define rkt_inbound rx_inbound

struct rkt_registers {
 struct rkt_mu_registers  MUnit;   /* 1300h - 1347h */
 __le32    reserved1[1006]; /* 1348h - 22fch */
 struct rkt_inbound  IndexRegs;  /* 2300h - */
};

#define rkt_readb(AEP, CSR)  readb(&((AEP)->regs.rkt->CSR))
#define rkt_readl(AEP, CSR)  readl(&((AEP)->regs.rkt->CSR))
#define rkt_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rkt->CSR))
#define rkt_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rkt->CSR))

/*
 * PMC SRC message unit registers
 */

#define src_inbound rx_inbound

struct src_mu_registers {
    /*  PCI*| Name */
 __le32 reserved0[6]; /*  00h | Reserved */
 __le32 IOAR[2]; /*  18h | IOA->host interrupt register */
 __le32 IDR;  /*  20h | Inbound Doorbell Register */
 __le32 IISR;  /*  24h | Inbound Int. Status Register */
 __le32 reserved1[3]; /*  28h | Reserved */
 __le32 OIMR;  /*  34h | Outbound Int. Mask Register */
 __le32 reserved2[25];  /*  38h | Reserved */
 __le32 ODR_R;  /*  9ch | Outbound Doorbell Read */
 __le32 ODR_C;  /*  a0h | Outbound Doorbell Clear */
 __le32 reserved3[3]; /*  a4h | Reserved */
 __le32 SCR0;  /*  b0h | Scratchpad 0 */
 __le32 reserved4[2]; /*  b4h | Reserved */
 __le32 OMR;  /*  bch | Outbound Message Register */
 __le32 IQ_L;  /*  c0h | Inbound Queue (Low address) */
 __le32 IQ_H;  /*  c4h | Inbound Queue (High address) */
 __le32 ODR_MSI; /*  c8h | MSI register for sync./AIF */
 __le32  reserved5; /*  cch | Reserved */
 __le32 IQN_L;  /*  d0h | Inbound (native cmd) low  */
 __le32 IQN_H;  /*  d4h | Inbound (native cmd) high */
};

struct src_registers {
 struct src_mu_registers MUnit; /* 00h - cbh */
 union {
  struct {
   __le32 reserved1[130786]; /* d8h - 7fc5fh */
   struct src_inbound IndexRegs; /* 7fc60h */
  } tupelo;
  struct {
   __le32 reserved1[970];  /* d8h - fffh */
   struct src_inbound IndexRegs; /* 1000h */
  } denali;
 } u;
};

#define src_readb(AEP, CSR)  readb(&((AEP)->regs.src.bar0->CSR))
#define src_readl(AEP, CSR)  readl(&((AEP)->regs.src.bar0->CSR))
#define src_writeb(AEP, CSR, value) writeb(value, \
      &((AEP)->regs.src.bar0->CSR))
#define src_writel(AEP, CSR, value) writel(value, \
      &((AEP)->regs.src.bar0->CSR))
#if defined(writeq)
#define src_writeq(AEP, CSR, value) writeq(value, \
      &((AEP)->regs.src.bar0->CSR))
#endif

#define SRC_ODR_SHIFT  12
#define SRC_IDR_SHIFT  9
#define SRC_MSI_READ_MASK 0x1000

typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);

struct aac_fib_context {
 s16   type;  // used for verification of structure
 s16   size;
 u32   unique;  // unique value representing this context
 ulong   jiffies; // used for cleanup - dmb changed to ulong
 struct list_head next;  // used to link context's into a linked list
 struct completion completion; // this is used to wait for the next fib to arrive.
 int   wait;  // Set to true when thread is in WaitForSingleObject
 unsigned long  count;  // total number of FIBs on FibList
 struct list_head fib_list; // this holds fibs and their attachd hw_fibs
};

struct sense_data {
 u8 error_code;  /* 70h (current errors), 71h(deferred errors) */
 u8 valid:1;  /* A valid bit of one indicates that the information  */
    /* field contains valid information as defined in the
 * SCSI-2 Standard.
 */
 u8 segment_number; /* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
 u8 sense_key:4;  /* Sense Key */
 u8 reserved:1;
 u8 ILI:1;  /* Incorrect Length Indicator */
 u8 EOM:1;  /* End Of Medium - reserved for random access devices */
 u8 filemark:1;  /* Filemark - reserved for random access devices */

 u8 information[4]; /* for direct-access devices, contains the unsigned
 * logical block address or residue associated with
 * the sense key
 */
 u8 add_sense_len; /* number of additional sense bytes to follow this field */
 u8 cmnd_info[4]; /* not used */
 u8 ASC;   /* Additional Sense Code */
 u8 ASCQ;  /* Additional Sense Code Qualifier */
 u8 FRUC;  /* Field Replaceable Unit Code - not used */
 u8 bit_ptr:3;  /* indicates which byte of the CDB or parameter data
 * was in error
 */
 u8 BPV:1;  /* bit pointer valid (BPV): 1- indicates that
 * the bit_ptr field has valid value
 */
 u8 reserved2:2;
 u8 CD:1;  /* command data bit: 1- illegal parameter in CDB.
 * 0- illegal parameter in data.
 */
 u8 SKSV:1;
 u8 field_ptr[2]; /* byte of the CDB or parameter data in error */
};

struct fsa_dev_info {
 u64  last;
 u64  size;
 u32  type;
 u32  config_waiting_on;
 unsigned long config_waiting_stamp;
 u16  queue_depth;
 u8  config_needed;
 u8  valid;
 u8  ro;
 u8  locked;
 u8  deleted;
 char  devname[8];
 struct sense_data sense_data;
 u32  block_size;
 u8  identifier[16];
};

struct fib {
 void   *next; /* this is used by the allocator */
 s16   type;
 s16   size;
 /*
 * The Adapter that this I/O is destined for.
 */
 struct aac_dev  *dev;
 /*
 * This is the event the sendfib routine will wait on if the
 * caller did not pass one and this is synch io.
 */
 struct completion event_wait;
 spinlock_t  event_lock;

 u32   done; /* gets set to 1 when fib is complete */
 fib_callback  callback;
 void   *callback_data;
 u32   flags; // u32 dmb was ulong
 /*
 * And for the internal issue/reply queues (we may be able
 * to merge these two)
 */
 struct list_head fiblink;
 void   *data;
 u32   vector_no;
 struct hw_fib  *hw_fib_va; /* also used for native */
 dma_addr_t  hw_fib_pa; /* physical address of hw_fib*/
 dma_addr_t  hw_sgl_pa; /* extra sgl for native */
 dma_addr_t  hw_error_pa; /* error buffer for native */
 u32   hbacmd_size; /* cmd size for native */
};

#define AAC_INIT   0
#define AAC_RESCAN   1

#define AAC_DEVTYPE_RAID_MEMBER 1
#define AAC_DEVTYPE_ARC_RAW  2
#define AAC_DEVTYPE_NATIVE_RAW  3

#define AAC_RESCAN_DELAY  (10 * HZ)

struct aac_hba_map_info {
 __le32 rmw_nexus;  /* nexus for native HBA devices */
 u8  devtype; /* device type */
 s8  reset_state; /* 0 - no reset, 1..x - */
     /* after xth TM LUN reset */
 u16  qd_limit;
 u32  scan_counter;
 struct aac_ciss_identify_pd  *safw_identify_resp;
};

/*
 * Adapter Information Block
 *
 * This is returned by the RequestAdapterInfo block
 */

struct aac_adapter_info
{
 __le32 platform;
 __le32 cpu;
 __le32 subcpu;
 __le32 clock;
 __le32 execmem;
 __le32 buffermem;
 __le32 totalmem;
 __le32 kernelrev;
 __le32 kernelbuild;
 __le32 monitorrev;
 __le32 monitorbuild;
 __le32 hwrev;
 __le32 hwbuild;
 __le32 biosrev;
 __le32 biosbuild;
 __le32 cluster;
 __le32 clusterchannelmask;
 __le32 serial[2];
 __le32 battery;
 __le32 options;
 __le32 OEM;
};

struct aac_supplement_adapter_info
{
 u8 adapter_type_text[17+1];
 u8 pad[2];
 __le32 flash_memory_byte_size;
 __le32 flash_image_id;
 __le32 max_number_ports;
 __le32 version;
 __le32 feature_bits;
 u8 slot_number;
 u8 reserved_pad0[3];
 u8 build_date[12];
 __le32 current_number_ports;
 struct {
  u8 assembly_pn[8];
  u8 fru_pn[8];
  u8 battery_fru_pn[8];
  u8 ec_version_string[8];
  u8 tsid[12];
 } vpd_info;
 __le32 flash_firmware_revision;
 __le32 flash_firmware_build;
 __le32 raid_type_morph_options;
 __le32 flash_firmware_boot_revision;
 __le32 flash_firmware_boot_build;
 u8 mfg_pcba_serial_no[12];
 u8 mfg_wwn_name[8];
 __le32 supported_options2;
 __le32 struct_expansion;
 /* StructExpansion == 1 */
 __le32 feature_bits3;
 __le32 supported_performance_modes;
 u8 host_bus_type;  /* uses HOST_BUS_TYPE_xxx defines */
 u8 host_bus_width;  /* actual width in bits or links */
 u16 host_bus_speed;  /* actual bus speed/link rate in MHz */
 u8 max_rrc_drives;  /* max. number of ITP-RRC drives/pool */
 u8 max_disk_xtasks; /* max. possible num of DiskX Tasks */

 u8 cpld_ver_loaded;
 u8 cpld_ver_in_flash;

 __le64 max_rrc_capacity;
 __le32 compiled_max_hist_log_level;
 u8 custom_board_name[12];
 u16 supported_cntlr_mode; /* identify supported controller mode */
 u16 reserved_for_future16;
 __le32 supported_options3; /* reserved for future options */

 __le16 virt_device_bus;  /* virt. SCSI device for Thor */
 __le16 virt_device_target;
 __le16 virt_device_lun;
 __le16 unused;
 __le32 reserved_for_future_growth[68];

};
#define AAC_FEATURE_FALCON cpu_to_le32(0x00000010)
#define AAC_FEATURE_JBOD cpu_to_le32(0x08000000)
/* SupportedOptions2 */
#define AAC_OPTION_MU_RESET  cpu_to_le32(0x00000001)
#define AAC_OPTION_IGNORE_RESET  cpu_to_le32(0x00000002)
#define AAC_OPTION_POWER_MANAGEMENT cpu_to_le32(0x00000004)
#define AAC_OPTION_DOORBELL_RESET cpu_to_le32(0x00004000)
/* 4KB sector size */
#define AAC_OPTION_VARIABLE_BLOCK_SIZE cpu_to_le32(0x00040000)
/* 240 simple volume support */
#define AAC_OPTION_SUPPORTED_240_VOLUMES cpu_to_le32(0x10000000)
/*
 * Supports FIB dump sync command send prior to IOP_RESET
 */
#define AAC_OPTION_SUPPORTED3_IOP_RESET_FIB_DUMP cpu_to_le32(0x00004000)
#define AAC_SIS_VERSION_V3 3
#define AAC_SIS_SLOT_UNKNOWN 0xFF

#define GetBusInfo 0x00000009
struct aac_bus_info {
 __le32 Command; /* VM_Ioctl */
 __le32 ObjType; /* FT_DRIVE */
 __le32 MethodId; /* 1 = SCSI Layer */
 __le32 ObjectId; /* Handle */
 __le32 CtlCmd;  /* GetBusInfo */
};

struct aac_bus_info_response {
 __le32 Status;  /* ST_OK */
 __le32 ObjType;
 __le32 MethodId; /* unused */
 __le32 ObjectId; /* unused */
 __le32 CtlCmd;  /* unused */
 __le32 ProbeComplete;
 __le32 BusCount;
 __le32 TargetsPerBus;
 u8 InitiatorBusId[10];
 u8 BusValid[10];
};

/*
 * Battery platforms
 */
#define AAC_BAT_REQ_PRESENT (1)
#define AAC_BAT_REQ_NOTPRESENT (2)
#define AAC_BAT_OPT_PRESENT (3)
#define AAC_BAT_OPT_NOTPRESENT (4)
#define AAC_BAT_NOT_SUPPORTED (5)
/*
 * cpu types
 */
#define AAC_CPU_SIMULATOR (1)
#define AAC_CPU_I960  (2)
#define AAC_CPU_STRONGARM (3)

/*
 * Supported Options
 */
#define AAC_OPT_SNAPSHOT  cpu_to_le32(1)
#define AAC_OPT_CLUSTERS  cpu_to_le32(1<<1)
#define AAC_OPT_WRITE_CACHE  cpu_to_le32(1<<2)
#define AAC_OPT_64BIT_DATA  cpu_to_le32(1<<3)
#define AAC_OPT_HOST_TIME_FIB  cpu_to_le32(1<<4)
#define AAC_OPT_RAID50   cpu_to_le32(1<<5)
#define AAC_OPT_4GB_WINDOW  cpu_to_le32(1<<6)
#define AAC_OPT_SCSI_UPGRADEABLE cpu_to_le32(1<<7)
#define AAC_OPT_SOFT_ERR_REPORT  cpu_to_le32(1<<8)
#define AAC_OPT_SUPPORTED_RECONDITION cpu_to_le32(1<<9)
#define AAC_OPT_SGMAP_HOST64  cpu_to_le32(1<<10)
#define AAC_OPT_ALARM   cpu_to_le32(1<<11)
#define AAC_OPT_NONDASD   cpu_to_le32(1<<12)
#define AAC_OPT_SCSI_MANAGED  cpu_to_le32(1<<13)
#define AAC_OPT_RAID_SCSI_MODE  cpu_to_le32(1<<14)
#define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
#define AAC_OPT_NEW_COMM  cpu_to_le32(1<<17)
#define AAC_OPT_NEW_COMM_64  cpu_to_le32(1<<18)
#define AAC_OPT_EXTENDED  cpu_to_le32(1<<23)
#define AAC_OPT_NATIVE_HBA  cpu_to_le32(1<<25)
#define AAC_OPT_NEW_COMM_TYPE1  cpu_to_le32(1<<28)
#define AAC_OPT_NEW_COMM_TYPE2  cpu_to_le32(1<<29)
#define AAC_OPT_NEW_COMM_TYPE3  cpu_to_le32(1<<30)
#define AAC_OPT_NEW_COMM_TYPE4  cpu_to_le32(1<<31)

#define AAC_COMM_PRODUCER  0
#define AAC_COMM_MESSAGE  1
#define AAC_COMM_MESSAGE_TYPE1  3
#define AAC_COMM_MESSAGE_TYPE2  4
#define AAC_COMM_MESSAGE_TYPE3  5

#define AAC_EXTOPT_SA_FIRMWARE  cpu_to_le32(1<<1)
#define AAC_EXTOPT_SOFT_RESET  cpu_to_le32(1<<16)

/* MSIX context */
struct aac_msix_ctx {
 int  vector_no;
 struct aac_dev *dev;
};

struct aac_dev
{
 struct list_head entry;
 const char  *name;
 int   id;

 /*
 * negotiated FIB settings
 */
 unsigned int  max_fib_size;
 unsigned int  sg_tablesize;
 unsigned int  max_num_aif;

 unsigned int  max_cmd_size; /* max_fib_size or MAX_NATIVE */

 /*
 * Map for 128 fib objects (64k)
 */
 dma_addr_t  hw_fib_pa; /* also used for native cmd */
 struct hw_fib  *hw_fib_va; /* also used for native cmd */
 struct hw_fib  *aif_base_va;
 /*
 * Fib Headers
 */
 struct fib              *fibs;

 struct fib  *free_fib;
 spinlock_t  fib_lock;

 struct mutex  ioctl_mutex;
 struct mutex  scan_mutex;
 struct aac_queue_block *queues;
 /*
 * The user API will use an IOCTL to register itself to receive
 * FIBs from the adapter.  The following list is used to keep
 * track of all the threads that have requested these FIBs.  The
 * mutex is used to synchronize access to all data associated
 * with the adapter fibs.
 */
 struct list_head fib_list;

 struct adapter_ops a_ops;
 unsigned long  fsrev;  /* Main driver's revision number */

 resource_size_t  base_start; /* main IO base */
 resource_size_t  dbg_base; /* address of UART
 * debug buffer */

 resource_size_t  base_size, dbg_size; /* Size of
 *  mapped in region */
 /*
 * Holds initialization info
 * to communicate with adapter
 */
 union aac_init  *init;
 dma_addr_t  init_pa; /* Holds physical address of the init struct */
 /* response queue (if AAC_COMM_MESSAGE_TYPE1) */
 __le32   *host_rrq;
 dma_addr_t  host_rrq_pa; /* phys. address */
 /* index into rrq buffer */
 u32   host_rrq_idx[AAC_MAX_MSIX];
 atomic_t  rrq_outstanding[AAC_MAX_MSIX];
 u32   fibs_pushed_no;
 struct pci_dev  *pdev;  /* Our PCI interface */
 /* pointer to buffer used for printf's from the adapter */
 void   *printfbuf;
 void   *comm_addr; /* Base address of Comm area */
 dma_addr_t  comm_phys; /* Physical Address of Comm area */
 size_t   comm_size;

 struct Scsi_Host *scsi_host_ptr;
 int   maximum_num_containers;
 int   maximum_num_physicals;
 int   maximum_num_channels;
 struct fsa_dev_info *fsa_dev;
 struct task_struct *thread;
 struct delayed_work safw_rescan_work;
 struct delayed_work src_reinit_aif_worker;
 int   cardtype;
 /*
 *This lock will protect the two 32-bit
 *writes to the Inbound Queue
 */
 spinlock_t  iq_lock;

 /*
 * The following is the device specific extension.
 */
#ifndef AAC_MIN_FOOTPRINT_SIZE
# define AAC_MIN_FOOTPRINT_SIZE 8192
# define AAC_MIN_SRC_BAR0_SIZE 0x400000
# define AAC_MIN_SRC_BAR1_SIZE 0x800
# define AAC_MIN_SRCV_BAR0_SIZE 0x100000
# define AAC_MIN_SRCV_BAR1_SIZE 0x400
#endif
 union
 {
  struct sa_registers __iomem *sa;
  struct rx_registers __iomem *rx;
  struct rkt_registers __iomem *rkt;
  struct {
   struct src_registers __iomem *bar0;
   char __iomem *bar1;
  } src;
 } regs;
 volatile void __iomem *base, *dbg_base_mapped;
 volatile struct rx_inbound __iomem *IndexRegs;
 u32   OIMR; /* Mask Register Cache */
 /*
 * AIF thread states
 */
 u32   aif_thread;
 struct aac_adapter_info adapter_info;
 struct aac_supplement_adapter_info supplement_adapter_info;
 /* These are in adapter info but they are in the io flow so
 * lets break them out so we don't have to do an AND to check them
 */
 u8   nondasd_support;
 u8   jbod;
 u8   cache_protected;
 u8   dac_support;
 u8   needs_dac;
 u8   raid_scsi_mode;
 u8   comm_interface;
 u8   raw_io_interface;
 u8   raw_io_64;
 u8   printf_enabled;
 u8   in_reset;
 u8   in_soft_reset;
 u8   msi;
 u8   sa_firmware;
 int   management_fib_count;
 spinlock_t  manage_lock;
 spinlock_t  sync_lock;
 int   sync_mode;
 struct fib  *sync_fib;
 struct list_head sync_fib_list;
 u32   doorbell_mask;
 u32   max_msix; /* max. MSI-X vectors */
 u32   vector_cap; /* MSI-X vector capab.*/
 int   msi_enabled; /* MSI/MSI-X enabled */
 atomic_t  msix_counter;
 u32   scan_counter;
 struct msix_entry msixentry[AAC_MAX_MSIX];
 struct aac_msix_ctx aac_msix[AAC_MAX_MSIX]; /* context */
 struct aac_hba_map_info hba_map[AAC_MAX_BUSES][AAC_MAX_TARGETS];
 struct aac_ciss_phys_luns_resp *safw_phys_luns;
 u8   adapter_shutdown;
 u32   handle_pci_error;
 bool   init_reset;
 u8   soft_reset_support;
};

#define aac_adapter_interrupt(dev) \
 (dev)->a_ops.adapter_interrupt(dev)

#define aac_adapter_notify(dev, event) \
 (dev)->a_ops.adapter_notify(dev, event)

#define aac_adapter_disable_int(dev) \
 (dev)->a_ops.adapter_disable_int(dev)

#define aac_adapter_enable_int(dev) \
 (dev)->a_ops.adapter_enable_int(dev)

#define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)

#define aac_adapter_restart(dev, bled, reset_type) \
 ((dev)->a_ops.adapter_restart(dev, bled, reset_type))

#define aac_adapter_start(dev) \
 ((dev)->a_ops.adapter_start(dev))

#define aac_adapter_ioremap(dev, size) \
 (dev)->a_ops.adapter_ioremap(dev, size)

#define aac_adapter_deliver(fib) \
 ((fib)->dev)->a_ops.adapter_deliver(fib)

#define aac_adapter_bounds(dev,cmd,lba) \
 dev->a_ops.adapter_bounds(dev,cmd,lba)

#define aac_adapter_read(fib,cmd,lba,count) \
 ((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)

#define aac_adapter_write(fib,cmd,lba,count,fua) \
 ((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count,fua)

#define aac_adapter_scsi(fib,cmd) \
 ((fib)->dev)->a_ops.adapter_scsi(fib,cmd)

#define aac_adapter_comm(dev,comm) \
 (dev)->a_ops.adapter_comm(dev, comm)

#define FIB_CONTEXT_FLAG_TIMED_OUT  (0x00000001)
#define FIB_CONTEXT_FLAG   (0x00000002)
#define FIB_CONTEXT_FLAG_WAIT   (0x00000004)
#define FIB_CONTEXT_FLAG_FASTRESP  (0x00000008)
#define FIB_CONTEXT_FLAG_NATIVE_HBA  (0x00000010)
#define FIB_CONTEXT_FLAG_NATIVE_HBA_TMF (0x00000020)
#define FIB_CONTEXT_FLAG_SCSI_CMD (0x00000040)
#define FIB_CONTEXT_FLAG_EH_RESET (0x00000080)

/*
 * Define the command values
 */

#define  Null   0
#define  GetAttributes  1
#define  SetAttributes  2
#define  Lookup   3
#define  ReadLink  4
#define  Read   5
#define  Write   6
#define  Create   7
#define  MakeDirectory  8
#define  SymbolicLink  9
#define  MakeNode  10
#define  Removex   11
#define  RemoveDirectoryx 12
#define  Rename   13
#define  Link   14
#define  ReadDirectory  15
#define  ReadDirectoryPlus 16
#define  FileSystemStatus 17
#define  FileSystemInfo  18
#define  PathConfigure  19
#define  Commit   20
#define  Mount   21
#define  UnMount   22
#define  Newfs   23
#define  FsCheck   24
#define  FsSync   25
#define  SimReadWrite  26
#define  SetFileSystemStatus 27
#define  BlockRead  28
#define  BlockWrite  29
#define  NvramIoctl  30
#define  FsSyncWait  31
#define  ClearArchiveBit  32
#define  SetAcl   33
#define  GetAcl   34
#define  AssignAcl  35
#define  FaultInsertion  36 /* Fault Insertion Command */
#define  CrazyCache  37 /* Crazycache */

#define  MAX_FSACOMMAND_NUM 38


/*
 * Define the status returns. These are very unixlike although
 * most are not in fact used
 */

#define  ST_OK  0
#define  ST_PERM  1
#define  ST_NOENT 2
#define  ST_IO  5
#define  ST_NXIO  6
#define  ST_E2BIG 7
#define  ST_MEDERR 8
#define  ST_ACCES 13
#define  ST_EXIST 17
#define  ST_XDEV  18
#define  ST_NODEV 19
#define  ST_NOTDIR 20
#define  ST_ISDIR 21
#define  ST_INVAL 22
#define  ST_FBIG  27
#define  ST_NOSPC 28
#define  ST_ROFS  30
#define  ST_MLINK 31
#define  ST_WOULDBLOCK 35
#define  ST_NAMETOOLONG 63
#define  ST_NOTEMPTY 66
#define  ST_DQUOT 69
#define  ST_STALE 70
#define  ST_REMOTE 71
#define  ST_NOT_READY 72
#define  ST_BADHANDLE 10001
#define  ST_NOT_SYNC 10002
#define  ST_BAD_COOKIE 10003
#define  ST_NOTSUPP 10004
#define  ST_TOOSMALL 10005
#define  ST_SERVERFAULT 10006
#define  ST_BADTYPE 10007
#define  ST_JUKEBOX 10008
#define  ST_NOTMOUNTED 10009
#define  ST_MAINTMODE 10010
#define  ST_STALEACL 10011

/*
 * On writes how does the client want the data written.
 */

#define CACHE_CSTABLE  1
#define CACHE_UNSTABLE  2

/*
 * Lets the client know at which level the data was committed on
 * a write request
 */

#define CMFILE_SYNCH_NVRAM 1
#define CMDATA_SYNCH_NVRAM 2
#define CMFILE_SYNCH  3
#define CMDATA_SYNCH  4
#define CMUNSTABLE  5

#define RIO_TYPE_WRITE    0x0000
#define RIO_TYPE_READ   0x0001
#define RIO_SUREWRITE   0x0008

#define RIO2_IO_TYPE   0x0003
#define RIO2_IO_TYPE_WRITE  0x0000
#define RIO2_IO_TYPE_READ  0x0001
#define RIO2_IO_TYPE_VERIFY  0x0002
#define RIO2_IO_ERROR   0x0004
#define RIO2_IO_SUREWRITE  0x0008
#define RIO2_SGL_CONFORMANT  0x0010
#define RIO2_SG_FORMAT   0xF000
#define RIO2_SG_FORMAT_ARC  0x0000
#define RIO2_SG_FORMAT_SRL  0x1000
#define RIO2_SG_FORMAT_IEEE1212  0x2000

struct aac_read
{
 __le32  command;
 __le32  cid;
 __le32  block;
 __le32  count;
 struct sgmap sg; // Must be last in struct because it is variable
};

struct aac_read64
{
 __le32  command;
 __le16  cid;
 __le16  sector_count;
 __le32  block;
 __le16  pad;
 __le16  flags;
 struct sgmap64 sg; // Must be last in struct because it is variable
};

struct aac_read_reply
{
 __le32  status;
 __le32  count;
};

struct aac_write
{
 __le32  command;
 __le32  cid;
 __le32  block;
 __le32  count;
 __le32  stable; // Not used
 struct sgmap sg; // Must be last in struct because it is variable
};

struct aac_write64
{
 __le32  command;
 __le16  cid;
 __le16  sector_count;
 __le32  block;
 __le16  pad;
 __le16  flags;
 struct sgmap64 sg; // Must be last in struct because it is variable
};
struct aac_write_reply
{
 __le32  status;
 __le32  count;
 __le32  committed;
};

struct aac_raw_io
{
 __le32  block[2];
 __le32  count;
 __le16  cid;
 __le16  flags;  /* 00 W, 01 R */
 __le16  bpTotal; /* reserved for F/W use */
 __le16  bpComplete; /* reserved for F/W use */
 struct sgmapraw sg;
};

struct aac_raw_io2 {
 __le32  blockLow;
 __le32  blockHigh;
 __le32  byteCount;
 __le16  cid;
 __le16  flags;  /* RIO2 flags */
 __le32  sgeFirstSize; /* size of first sge el. */
 __le32  sgeNominalSize; /* size of 2nd sge el. (if conformant) */
 u8  sgeCnt;  /* only 8 bits required */
 u8  bpTotal; /* reserved for F/W use */
 u8  bpComplete; /* reserved for F/W use */
 u8  sgeFirstIndex; /* reserved for F/W use */
 u8  unused[4];
 struct sge_ieee1212 sge[];
};

#define CT_FLUSH_CACHE 129
struct aac_synchronize {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_FLUSH_CACHE */
 __le32  cid;
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
};

struct aac_synchronize_reply {
 __le32  dummy0;
 __le32  dummy1;
 __le32  status; /* CT_OK */
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  parm5;
 u8  data[16];
};

#define CT_POWER_MANAGEMENT 245
#define CT_PM_START_UNIT 2
#define CT_PM_STOP_UNIT  3
#define CT_PM_UNIT_IMMEDIATE 1
struct aac_power_management {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_POWER_MANAGEMENT */
 __le32  sub;  /* CT_PM_* */
 __le32  cid;
 __le32  parm;  /* CT_PM_sub_* */
};

#define CT_PAUSE_IO    65
#define CT_RELEASE_IO  66
struct aac_pause {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_PAUSE_IO */
 __le32  timeout; /* 10ms ticks */
 __le32  min;
 __le32  noRescan;
 __le32  parm3;
 __le32  parm4;
 __le32  count; /* sizeof(((struct aac_pause_reply *)NULL)->data) */
};

struct aac_srb
{
 __le32  function;
 __le32  channel;
 __le32  id;
 __le32  lun;
 __le32  timeout;
 __le32  flags;
 __le32  count;  // Data xfer size
 __le32  retry_limit;
 __le32  cdb_size;
 u8  cdb[16];
 struct sgmap sg;
};

/*
 * This and associated data structs are used by the
 * ioctl caller and are in cpu order.
 */
struct user_aac_srb
{
 u32  function;
 u32  channel;
 u32  id;
 u32  lun;
 u32  timeout;
 u32  flags;
 u32  count;  // Data xfer size
 u32  retry_limit;
 u32  cdb_size;
 u8  cdb[16];
 struct user_sgmap sg;
};

#define  AAC_SENSE_BUFFERSIZE  30

struct aac_srb_reply
{
 __le32  status;
 __le32  srb_status;
 __le32  scsi_status;
 __le32  data_xfer_length;
 __le32  sense_data_size;
 u8  sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
};

struct aac_srb_unit {
 struct aac_srb_reply srb_reply;
 struct aac_srb  srb;
};

/*
 * SRB Flags
 */
#define  SRB_NoDataXfer   0x0000
#define  SRB_DisableDisconnect  0x0004
#define  SRB_DisableSynchTransfer 0x0008
#define  SRB_BypassFrozenQueue  0x0010
#define  SRB_DisableAutosense  0x0020
#define  SRB_DataIn   0x0040
#define  SRB_DataOut   0x0080

/*
 * SRB Functions - set in aac_srb->function
 */
#define SRBF_ExecuteScsi 0x0000
#define SRBF_ClaimDevice 0x0001
#define SRBF_IO_Control  0x0002
#define SRBF_ReceiveEvent 0x0003
#define SRBF_ReleaseQueue 0x0004
#define SRBF_AttachDevice 0x0005
#define SRBF_ReleaseDevice 0x0006
#define SRBF_Shutdown  0x0007
#define SRBF_Flush  0x0008
#define SRBF_AbortCommand 0x0010
#define SRBF_ReleaseRecovery 0x0011
#define SRBF_ResetBus  0x0012
#define SRBF_ResetDevice 0x0013
#define SRBF_TerminateIO 0x0014
#define SRBF_FlushQueue  0x0015
#define SRBF_RemoveDevice 0x0016
#define SRBF_DomainValidation 0x0017

/*
 * SRB SCSI Status - set in aac_srb->scsi_status
 */
#define SRB_STATUS_PENDING                  0x00
#define SRB_STATUS_SUCCESS                  0x01
#define SRB_STATUS_ABORTED                  0x02
#define SRB_STATUS_ABORT_FAILED             0x03
#define SRB_STATUS_ERROR                    0x04
#define SRB_STATUS_BUSY                     0x05
#define SRB_STATUS_INVALID_REQUEST          0x06
#define SRB_STATUS_INVALID_PATH_ID          0x07
#define SRB_STATUS_NO_DEVICE                0x08
#define SRB_STATUS_TIMEOUT                  0x09
#define SRB_STATUS_SELECTION_TIMEOUT        0x0A
#define SRB_STATUS_COMMAND_TIMEOUT          0x0B
#define SRB_STATUS_MESSAGE_REJECTED         0x0D
#define SRB_STATUS_BUS_RESET                0x0E
#define SRB_STATUS_PARITY_ERROR             0x0F
#define SRB_STATUS_REQUEST_SENSE_FAILED     0x10
#define SRB_STATUS_NO_HBA                   0x11
#define SRB_STATUS_DATA_OVERRUN             0x12
#define SRB_STATUS_UNEXPECTED_BUS_FREE      0x13
#define SRB_STATUS_PHASE_SEQUENCE_FAILURE   0x14
#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH     0x15
#define SRB_STATUS_REQUEST_FLUSHED          0x16
#define SRB_STATUS_DELAYED_RETRY     0x17
#define SRB_STATUS_INVALID_LUN              0x20
#define SRB_STATUS_INVALID_TARGET_ID        0x21
#define SRB_STATUS_BAD_FUNCTION             0x22
#define SRB_STATUS_ERROR_RECOVERY           0x23
#define SRB_STATUS_NOT_STARTED      0x24
#define SRB_STATUS_NOT_IN_USE      0x30
#define SRB_STATUS_FORCE_ABORT      0x31
#define SRB_STATUS_DOMAIN_VALIDATION_FAIL   0x32

/*
 * Object-Server / Volume-Manager Dispatch Classes
 */

#define  VM_Null   0
#define  VM_NameServe  1
#define  VM_ContainerConfig 2
#define  VM_Ioctl  3
#define  VM_FilesystemIoctl 4
#define  VM_CloseAll  5
#define  VM_CtBlockRead  6
#define  VM_CtBlockWrite  7
#define  VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
#define  VM_SliceBlockWrite 9
#define  VM_DriveBlockRead 10 /* raw access to physical devices */
#define  VM_DriveBlockWrite 11
#define  VM_EnclosureMgt  12 /* enclosure management */
#define  VM_Unused  13 /* used to be diskset management */
#define  VM_CtBlockVerify 14
#define  VM_CtPerf  15 /* performance test */
#define  VM_CtBlockRead64 16
#define  VM_CtBlockWrite64 17
#define  VM_CtBlockVerify64 18
#define  VM_CtHostRead64  19
#define  VM_CtHostWrite64 20
#define  VM_DrvErrTblLog  21
#define  VM_NameServe64  22
#define  VM_NameServeAllBlk 30

#define  MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */

/*
 * Descriptive information (eg, vital stats)
 * that a content manager might report.  The
 * FileArray filesystem component is one example
 * of a content manager.  Raw mode might be
 * another.
 */

struct aac_fsinfo {
 __le32  fsTotalSize; /* Consumed by fs, incl. metadata */
 __le32  fsBlockSize;
 __le32  fsFragSize;
 __le32  fsMaxExtendSize;
 __le32  fsSpaceUnits;
 __le32  fsMaxNumFiles;
 __le32  fsNumFreeFiles;
 __le32  fsInodeDensity;
}; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */

struct  aac_blockdevinfo {
 __le32 block_size;
 __le32  logical_phys_map;
 u8 identifier[16];
};

union aac_contentinfo {
 struct aac_fsinfo  filesys;
 struct aac_blockdevinfo bdevinfo;
};

/*
 * Query for Container Configuration Status
 */

#define CT_GET_CONFIG_STATUS 147
struct aac_get_config_status {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_GET_CONFIG_STATUS */
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  parm5;
 __le32  count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
};

#define CFACT_CONTINUE 0
#define CFACT_PAUSE    1
#define CFACT_ABORT    2
struct aac_get_config_status_resp {
 __le32  response; /* ST_OK */
 __le32  dummy0;
 __le32  status; /* CT_OK */
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  parm5;
 struct {
  __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
  __le16 flags;
  __le16 count;
 }  data;
};

/*
 * Accept the configuration as-is
 */

#define CT_COMMIT_CONFIG 152

struct aac_commit_config {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_COMMIT_CONFIG */
};

/*
 * Query for Container Configuration Status
 */

#define CT_GET_CONTAINER_COUNT 4
struct aac_get_container_count {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_GET_CONTAINER_COUNT */
};

struct aac_get_container_count_resp {
 __le32  response; /* ST_OK */
 __le32  dummy0;
 __le32  MaxContainers;
 __le32  ContainerSwitchEntries;
 __le32  MaxPartitions;
 __le32  MaxSimpleVolumes;
};


/*
 * Query for "mountable" objects, ie, objects that are typically
 * associated with a drive letter on the client (host) side.
 */

struct aac_mntent {
 __le32   oid;
 u8   name[16]; /* if applicable */
 struct creation_info create_info; /* if applicable */
 __le32   capacity;
 __le32   vol;  /* substrate structure */
 __le32   obj;  /* FT_FILESYS, etc. */
 __le32   state;  /* unready for mounting,
   readonly, etc. */
 union aac_contentinfo fileinfo; /* Info specific to content
   manager (eg, filesystem) */
 __le32   altoid;  /* != oid <==> snapshot or
   broken mirror exists */
 __le32   capacityhigh;
};

#define FSCS_NOTCLEAN 0x0001  /* fsck is necessary before mounting */
#define FSCS_READONLY 0x0002 /* possible result of broken mirror */
#define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
#define FSCS_NOT_READY 0x0008 /* Array spinning up to fulfil request */

struct aac_query_mount {
 __le32  command;
 __le32  type;
 __le32  count;
};

struct aac_mount {
 __le32  status;
 __le32  type;           /* should be same as that requested */
 __le32  count;
 struct aac_mntent mnt[1];
};

#define CT_READ_NAME 130
struct aac_get_name {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_READ_NAME */
 __le32  cid;
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
};

struct aac_get_name_resp {
 __le32  dummy0;
 __le32  dummy1;
 __le32  status; /* CT_OK */
 __le32  parm1;
 __le32  parm2;
 __le32  parm3;
 __le32  parm4;
 __le32  parm5;
 u8  data[17];
};

#define CT_CID_TO_32BITS_UID 165
struct aac_get_serial {
 __le32  command; /* VM_ContainerConfig */
 __le32  type;  /* CT_CID_TO_32BITS_UID */
 __le32  cid;
};

struct aac_get_serial_resp {
 __le32  dummy0;
 __le32  dummy1;
 __le32  status; /* CT_OK */
 __le32  uid;
};

/*
 * The following command is sent to shut down each container.
 */

struct aac_close {
 __le32 command;
 __le32 cid;
};

struct aac_query_disk
{
 s32 cnum;
 s32 bus;
 s32 id;
 s32 lun;
 u32 valid;
 u32 locked;
 u32 deleted;
 s32 instance;
 s8 name[10];
 u32 unmapped;
};

struct aac_delete_disk {
 u32 disknum;
 u32 cnum;
};

struct fib_ioctl
{
 u32 fibctx;
 s32 wait;
 char __user *fib;
};

struct revision
{
 u32 compat;
 __le32 version;
 __le32 build;
};


/*
 * Ugly - non Linux like ioctl coding for back compat.
 */

#define CTL_CODE(function, method) (                 \
    (4<< 16) | ((function) << 2) | (method) \
)

/*
 * Define the method codes for how buffers are passed for I/O and FS
 * controls
 */

#define METHOD_BUFFERED                 0
#define METHOD_NEITHER                  3

/*
 * Filesystem ioctls
 */

--> --------------------

--> maximum size reached

--> --------------------