/*
 * PMC-Sierra 8001/8081/8088/8089 SAS/SATA based host adapters driver
 *
 * Copyright (c) 2008-2009 USI Co., Ltd.
 * All rights reserved.
 *
 * 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,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
 *
 */

#ifndef _PM8001_DEFS_H_
#define _PM8001_DEFS_H_

enum chip_flavors {
 chip_8001,
 chip_8008,
 chip_8009,
 chip_8018,
 chip_8019,
 chip_8074,
 chip_8076,
 chip_8077,
 chip_8006,
 chip_8070,
 chip_8072
};

enum phy_speed {
 PHY_SPEED_15 = 0x01,
 PHY_SPEED_30 = 0x02,
 PHY_SPEED_60 = 0x04,
 PHY_SPEED_120 = 0x08,
};

enum data_direction {
 DATA_DIR_NONE = 0x0, /* NO TRANSFER */
 DATA_DIR_IN = 0x01, /* INBOUND */
 DATA_DIR_OUT = 0x02, /* OUTBOUND */
 DATA_DIR_BYRECIPIENT = 0x04, /* UNSPECIFIED */
};

enum port_type {
 PORT_TYPE_SAS = (1L << 1),
 PORT_TYPE_SATA = (1L << 0),
};

/* driver compile-time configuration */
#define PM8001_MAX_CCB   1024 /* max ccbs supported */
#define PM8001_MPI_QUEUE         1024   /* maximum mpi queue entries */
#define PM8001_MAX_INB_NUM  64
#define PM8001_MAX_OUTB_NUM  64
#define PM8001_CAN_QUEUE  508 /* SCSI Queue depth */

/* Inbound/Outbound queue size */
#define IOMB_SIZE_SPC  64
#define IOMB_SIZE_SPCV  128

/* unchangeable hardware details */
#define PM8001_MAX_PHYS   16 /* max. possible phys */
#define PM8001_MAX_PORTS  16 /* max. possible ports */
#define PM8001_MAX_DEVICES  2048 /* max supported device */
#define PM8001_MAX_MSIX_VEC  64 /* max msi-x int for spcv/ve */
#define PM8001_RESERVE_SLOT  128

#define PM8001_SECTOR_SIZE 512
#define PM8001_PAGE_SIZE_4K 4096
#define PM8001_MAX_IO_SIZE (4 * 1024 * 1024)
#define PM8001_MAX_DMA_SG (PM8001_MAX_IO_SIZE / PM8001_PAGE_SIZE_4K)
#define PM8001_MAX_SECTORS (PM8001_MAX_IO_SIZE / PM8001_SECTOR_SIZE)

enum memory_region_num {
 AAP1 = 0x0, /* application acceleration processor */
 IOP,     /* IO processor */
 NVMD,     /* NVM device */
 FW_FLASH,    /* memory for fw flash update */
 FORENSIC_MEM,  /* memory for fw forensic data */
 USI_MAX_MEMCNT_BASE
};
#define PM8001_EVENT_LOG_SIZE  (128 * 1024)

/**
 * maximum DMA memory regions(number of IBQ + number of IBQ CI
 * + number of  OBQ + number of OBQ PI)
 */
#define USI_MAX_MEMCNT (USI_MAX_MEMCNT_BASE + ((2 * PM8001_MAX_INB_NUM) \
   + (2 * PM8001_MAX_OUTB_NUM)))
/*error code*/
enum mpi_err {
 MPI_IO_STATUS_SUCCESS = 0x0,
 MPI_IO_STATUS_BUSY = 0x01,
 MPI_IO_STATUS_FAIL = 0x02,
};

/**
 * Phy Control constants
 */
enum phy_control_type {
 PHY_LINK_RESET = 0x01,
 PHY_HARD_RESET = 0x02,
 PHY_NOTIFY_ENABLE_SPINUP = 0x10,
};

enum pm8001_hba_info_flags {
 PM8001F_INIT_TIME = (1U << 0),
 PM8001F_RUN_TIME = (1U << 1),
};

/**
 * Phy Status
 */
#define PHY_LINK_DISABLE 0x00
#define PHY_LINK_DOWN  0x01
#define PHY_STATE_LINK_UP_SPCV 0x2
#define PHY_STATE_LINK_UP_SPC 0x1

#endif