/*

 * 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

 * or http://www.opensolaris.org/os/licensing.

 * 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 2006 Sun Microsystems, Inc.  All rights reserved.

 * Use is subject to license terms.

 */

#ifndef _SATA_H

#define	_SATA_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#ifdef	__cplusplus

extern "C" {

#endif

/*

 * Generic SATA Host Adapter Implementation

 */

#include <sys/types.h>

#include <sys/scsi/scsi.h>

#include <sys/scsi/impl/services.h>

#include <sys/sata/sata_defs.h>

#include <sys/sata/sata_hba.h>

/* Statistics counters */

struct sata_port_stats {

	uint64_t	link_lost;		/* event counter */

	uint64_t	link_established;	/* event counter */

	uint64_t	device_attached;	/* event counter */

	uint64_t	device_detached;	/* event counter */

	uint64_t	port_reset;		/* event counter */

	uint64_t	port_pwr_changed;	/* event counter */

};

typedef struct sata_port_stats sata_port_stats_t;

struct sata_drive_stats {

	uint64_t	media_error;		/* available ??? */

	uint64_t	drive_reset;		/* event counter */

} sata_drv_stats_t;

typedef struct sata_drive_stats sata_drive_stats_t;

struct sata_ctrl_stats {

	uint64_t	ctrl_reset;		/* event counter */

	uint64_t	ctrl_pwr_change;	/* event counter */

};

typedef struct sata_ctrl_stats sata_ctrl_stats_t;

/*

 * SATA HBA instance info structure

 */

struct sata_hba_inst {

	dev_info_t		*satahba_dip;	/* this HBA instance devinfo */

	struct sata_hba_inst	*satahba_next;	/* ptr to next sata_hba_inst */

	struct sata_hba_inst	*satahba_prev;	/* ptr to prev sata_hba_inst */

	struct scsi_hba_tran	*satahba_scsi_tran; /* scsi_hba_tran */

	struct sata_hba_tran	*satahba_tran;	/* sata_hba_tran */

	kmutex_t		satahba_mutex;	/* sata hba cntrl mutex */

	struct taskq		*satahba_taskq;	/* cmd completion task queue */

						/*

						 * HBA event flags:

						 * SATA_EVNT_MAIN

						 * SATA_EVNT_PWR_LEVEL_CHANGED

						 * SATA_EVNT_SKIP

						 */

	uint_t			satahba_event_flags;

	struct sata_cport_info	*satahba_dev_port[SATA_MAX_CPORTS];

						/*

						 * DEVCTL open flag:

						 * SATA_DEVCTL_SOPENED

						 * SATA_DEVCTL_EXOPENED

						 */

	uint_t			satahba_open_flag; /* shared open flag */

	struct sata_ctrl_stats	satahba_stats;	/* HBA cntrl statistics */

	uint_t			satahba_attached; /* HBA attaching: */

						/* 0 - not completed */

						/* 1 - completed */

};

typedef struct sata_hba_inst	sata_hba_inst_t;

/*

 * SATA controller's device port info and state.

 * This structure is pointed to by the sata_hba_inst.satahba_dev_port[x]

 * where x is a device port number.

 * cport_state holds port state flags, defined in sata_hba.h file.

 * cport_event_flags holds SATA_EVNT_* flags defined in this file and in

 * sata_hba.h file.

 * cport_dev_type holds SATA_DTYPE_* types defined in sata_hba.h file.

 */

struct sata_cport_info {

	sata_address_t		cport_addr;	/* this port SATA address */

	kmutex_t		cport_mutex;	/* port mutex */

						/*

						 * Port state flags

						 * SATA_STATE_UNKNOWN

						 * SATA_STATE_PROBING

						 * SATA_STATE_PROBED

						 * SATA_STATE_READY

						 * SATA_PSTATE_PWRON

						 * SATA_PSTATE_PWROFF

						 * SATA_PSTATE_SHUTDOWN

						 * SATA_PSTATE_FAILED

						 */

	uint32_t		cport_state;

						/*

						 * Port event flags:

						 * SATA_EVNT_DEVICE_ATTACHED

						 * SATA_EVNT_DEVICE_DETACHED

						 * SATA_EVNT_LINK_LOST

						 * SATA_EVNT_LINK_ESTABLISHED

						 * SATA_EVNT_PORT_FAILED

						 * SATA_EVNT_PWR_LEVEL_CHANGED

						 */

	uint32_t		cport_event_flags;

	struct sata_port_scr	cport_scr;	/* Port status and ctrl regs */

						/*

						 * Attached device type:

						 * SATA_DTYPE_NONE

						 * SATA_DTYPE_ATADISK

						 * SATA_DTYPE_ATAPICD

						 * SATA_DTYPE_ATAPINONCD

						 * SATA_DTYPE_PMULT

						 * SATA_DTYPE_UNKNOWN

						 */

	uint32_t		cport_dev_type;

	union {

	    struct sata_drive_info *cport_sata_drive; /* Attached drive info */

	    struct sata_pmult_info *cport_sata_pmult; /* Attached Port Mult */

	} 			cport_devp;

						/* lbolt value at link lost */

	clock_t			cport_link_lost_time;

	struct sata_port_stats	cport_stats;	/* Port statistics */

};

typedef struct sata_cport_info sata_cport_info_t;

/*

 * Attached SATA drive info and state.

 * This structure is pointed to by sata_cport_info's cport_sata_drive field

 * when a drive is attached directly to a controller device port.

 */

struct sata_drive_info {

	sata_address_t	satadrv_addr;		/* this drive SATA address */

						/*

						 * Drive state flags

						 * SATA_STATE_UNKNOWN

						 * SATA_STATE_PROBING

						 * SATA_STATE_PROBED

						 * SATA_STATE_READY

						 * SATA_DSTATE_PWR_ACTIVE

						 * SATA_DSTATE_PWR_IDLE

						 * SATA_DSTATE_RESET

						 * SATA_DSTATE_FAILED

						 */

	uint32_t	satadrv_state;

						/*

						 * drive event flags:

						 * SATA_EVNT_DRIVE_RESET

						 */

	uint32_t	satadrv_event_flags;

						/*

						 * Attached device type:

						 * SATA_DTYPE_ATADISK

						 * SATA_DTYPE_ATAPICD

						 * SATA_DTYPE_ATAPINONCD

						 */

	uint32_t	satadrv_type;

	uint32_t	satadrv_status_reg;	/* drive status reg */

	uint32_t	satadrv_error_reg;	/* drive error reg */

	uint16_t	satadrv_features_support; /* drive features support */

	uint16_t	satadrv_queue_depth;    /* drive queue depth */

	uint16_t	satadrv_settings;	/* drive settings flags */

	uint16_t	satadrv_pad2;		/* struct alignment pad */

	uint64_t	satadrv_capacity;	/* drive capacity */

	sata_id_t	satadrv_id;		/* Device Identify Data */

	struct sata_drive_stats satadrv_stats;	/* drive statistics */

};

typedef struct sata_drive_info sata_drive_info_t;

_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_drive_info))

/* Port Multiplier & host port info and state */

struct sata_pmult_info {

	sata_address_t	pmult_addr;		/* this PMult SATA Address */

	kmutex_t	pmult_mutex;		/* pmult (host port) mutex */

						/*

						 * PMult state flags

						 * SATA_STATE_UNKNOWN

						 * SATA_STATE_PROBING

						 * SATA_STATE_PROBED

						 * SATA_STATE_READY

						 * SATA_PSTATE_FAILED

						 */

	uint32_t	pmult_state;

	uint32_t	pmult_event_flags;	/* Undefined for now */

	struct sata_port_scr pmult_scr;		/* Host port SCR block */

	uint32_t	pmult_num_dev_ports; 	/* Number of data ports */

	struct sata_pmport_info	*pmult_dev_port[SATA_MAX_PMPORTS - 1];

};

typedef	struct sata_pmult_info sata_pmult_info_t;

/* Port Multiplier's device port info & state */

struct sata_pmport_info {

	sata_address_t	pmport_addr;		/* this SATA port address */

	kmutex_t	pmport_mutex;		/* pmult device port mutex */

						/*

						 * Port state flags

						 * SATA_STATE_UNKNOWN

						 * SATA_STATE_PROBING

						 * SATA_STATE_PROBED

						 * SATA_STATE_READY

						 * SATA_PSTATE_PWRON

						 * SATA_PSTATE_PWROFF

						 * SATA_PSTATE_SHUTDOWN

						 * SATA_PSTATE_FAILED

						 */

	uint32_t	pmport_state;

						/*

						 * Port event flags:

						 * SATA_EVNT_DEVICE_ATTACHED

						 * SATA_EVNT_DEVICE_DETACHED

						 * SATA_EVNT_LINK_LOST

						 * SATA_EVNT_LINK_ESTABLISHED

						 * SATA_EVNT_PORT_FAILED

						 * SATA_EVNT_PWR_LEVEL_CHANGED

						 */

	uint32_t	pmport_event_flags;

	struct sata_port_scr pmport_scr;	/* PMult device port scr */

						/*

						 * Attached device type:

						 * SATA_DTYPE_NONE

						 * SATA_DTYPE_ATADISK

						 * SATA_DTYPE_ATAPICD

						 * SATA_DTYPE_ATAPINONCD

						 * SATA_DTYPE_UNKNOWN

						 */

	uint32_t	pmport_dev_type;

	struct sata_drive_info	*pmport_sata_drive; /* Attached drive info */

						/* lbolt value at link lost */

	clock_t		pmport_link_lost_time;

	struct sata_port_stats	pmport_stats;	/* Port statistics */

};

typedef	struct sata_pmport_info sata_pmport_info_t;

/*

 * Port SSTATUS register (sata_port_scr sport_sstatus field).

 * Link bits are valid only in port active state.

 */

#define	SATA_PORT_DEVLINK_UP	0x00000103	/* Link with dev established */

#define	SATA_PORT_DEVLINK_UP_MASK 0x0000010F	/* Mask for link bits */

/*

 * Port state clear mask (cport_state and pmport_state fields).

 * SATA_PSTATE_SHUTDOWN and power state are preserved.

 */

#define	SATA_PORT_STATE_CLEAR_MASK	(~(SATA_PSTATE_SHUTDOWN))

/*

 * Valid i.e.supported device types mask (cport_dev_type, satadrv_type,

 * pmult_dev_type fields).

 */

#define	SATA_VALID_DEV_TYPE	(SATA_DTYPE_ATADISK)	/* only disks now */

/*

 * Device feature_support (satadrv_features_support)

 */

#define	SATA_DEV_F_DMA			0x01

#define	SATA_DEV_F_LBA28		0x02

#define	SATA_DEV_F_LBA48		0x04

#define	SATA_DEV_F_NCQ			0x08

#define	SATA_DEV_F_SATA1		0x10

#define	SATA_DEV_F_SATA2		0x20

#define	SATA_DEV_F_TCQ			0x40	/* Non NCQ tagged queuing */

/*

 * Drive settings flags (satdrv_settings)

 */

#define	SATA_DEV_READ_AHEAD		0x0001	/* Read Ahead enabled */

#define	SATA_DEV_WRITE_CACHE		0x0002	/* Write cache ON */

#define	SATA_DEV_SERIAL_FEATURES 	0x8000	/* Serial ATA feat. enabled */

#define	SATA_DEV_ASYNCH_NOTIFY		0x2000	/* Asynch-event enabled */

/*

 * Internal event and flags.

 * These flags are set in the *_event_flags fields of various structures.

 * Events and lock flags defined below are used internally by the

 * SATA framework (they are not reported by SATA HBA drivers).

 */

#define	SATA_EVNT_MAIN			0x80000000

#define	SATA_EVNT_SKIP			0x40000000

#define	SATA_EVNT_INPROC_DEVICE_RESET	0x08000000

#define	SATA_EVNT_CLEAR_DEVICE_RESET	0x04000000

/*

 * Lock flags - used to serialize configuration operations

 * on ports and devices.

 * SATA_EVNT_LOCK_PORT_BUSY is set by event daemon to prevent

 * simultaneous cfgadm operations.

 * SATA_APCTL_LOCK_PORT_BUSY is set by cfgadm ioctls to prevent

 * simultaneous event processing.

 */

#define	SATA_EVNT_LOCK_PORT_BUSY	0x00800000

#define	SATA_APCTL_LOCK_PORT_BUSY	0x00400000

/* Mask for port events */

#define	SATA_EVNT_PORT_EVENTS		(SATA_EVNT_DEVICE_ATTACHED | \

					SATA_EVNT_DEVICE_DETACHED | \

					SATA_EVNT_LINK_LOST | \

					SATA_EVNT_LINK_ESTABLISHED | \

					SATA_EVNT_PORT_FAILED)

/* Mask for drive events */

#define	SATA_EVNT_DRIVE_EVENTS		SATA_EVNT_DEVICE_RESET

#define	SATA_EVNT_CONTROLLER_EVENTS	SATA_EVNT_PWR_LEVEL_CHANGED

/* Delays and timeounts definitions */

#define	SATA_EVNT_DAEMON_SLEEP_TIME	50000	/* 50 ms */

#define	SATA_EVNT_DAEMON_TERM_TIMEOUT	100000	/* 100 ms */

#define	SATA_EVNT_DAEMON_TERM_WAIT	60000000 /* 60 s */

#define	SATA_EVNT_LINK_LOST_TIMEOUT	1000000	/* 1 s */

#define	SATA_DEVICE_IDENTIFY_RETRY	2

/*

 * sata_scsi's hba_open_flag: field indicating open devctl instance.

 *	0 = closed, 1 = shared open, 2 = exclusive open.

 */

#define	SATA_DEVCTL_CLOSED	0

#define	SATA_DEVCTL_SOPENED	1

#define	SATA_DEVCTL_EXOPENED	2

/*

 * sata_pkt_txlate structure contains info about resources allocated

 * for the packet

 * Address of this structure is stored in scsi_pkt.pkt_ha_private and

 * in sata_pkt.sata_hba_private fields, so all three strucures are

 * cross-linked, with sata_pkt_txlate as a centerpiece.

 */

typedef struct sata_pkt_txlate {

	struct sata_hba_inst	*txlt_sata_hba_inst;

	struct scsi_pkt		*txlt_scsi_pkt;

	struct sata_pkt		*txlt_sata_pkt;

	ddi_dma_handle_t	txlt_buf_dma_handle;

	uint_t			txlt_flags;	/* data-in / data-out */

	uint_t			txlt_num_dma_win; /* number of DMA windows */

	uint_t			txlt_cur_dma_win; /* current DMA window */

				/* cookies in the current DMA window */

	uint_t			txlt_curwin_num_dma_cookies;

				/* procesed dma cookies in current DMA win */

	uint_t			txlt_curwin_processed_dma_cookies;

	size_t			txlt_total_residue;

	int			txlt_dma_cookie_list_len; /* alloc list len */

	ddi_dma_cookie_t 	*txlt_dma_cookie_list; /* dma cookie list */

	int			txlt_num_dma_cookies; /* dma cookies in list */

				/* temporary buffer access handle */

	ddi_acc_handle_t	txlt_tmp_buf_handle;

	caddr_t			txlt_tmp_buf;	/* temp buffer address */

} sata_pkt_txlate_t;

_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_pkt_txlate))

_NOTE(SCHEME_PROTECTS_DATA("unshared data", scsi_pkt))

/*

 * Additional scsi sense code definitions.

 * These definition should eventually be moved to scsi header files.

 */

#define	SD_SCSI_NO_ADD_SENSE			0x00

#define	SD_SCSI_LU_NOT_READY			0x04

#define	SD_SCSI_WRITE_ERROR			0x0c

#define	SD_SCSI_UNREC_READ_ERROR		0x11

#define	SD_SCSI_INVALID_COMMAND_CODE		0x20

#define	SD_SCSI_LBA_OUT_OF_RANGE		0x21

#define	SD_SCSI_INVALID_FIELD_IN_CDB		0x24

#define	SD_SCSI_INVALID_FIELD_IN_PARAMETER_LIST 0x26

#define	SD_SCSI_SAVING_PARAMS_NOT_SUP		0x39

/* SCSI defs missing from scsi headers */

/* Missing from sys/scsi/generic/commands.h */

#define	SCMD_SYNCHRONIZE_CACHE_G1		0x91

/*

 * Missing from sys/scsi/impl/mode.h, although defined

 * in sys/scsi/targets/sddefs.h as MODEPAGE_ERR_RECOV

 */

#define	MODEPAGE_RW_ERRRECOV			0x01 /* read/write recovery */

/*

 * Macros for accessing various structure fields

 *

 */

#define	SATA_TRAN(sata_hba_inst) \

	sata_hba_inst->satahba_tran

#define	SATA_DIP(sata_hba_inst) \

	sata_hba_inst->satahba_dip

#define	SATA_NUM_CPORTS(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_hba_num_cports

#define	SATA_QDEPTH(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_hba_qdepth

#define	SATA_FEATURES(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_hba_features_support

#define	SATA_DMA_ATTR(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_hba_dma_attr

#define	SATA_START_FUNC(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_start

#define	SATA_ABORT_FUNC(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_abort

#define	SATA_RESET_DPORT_FUNC(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_reset_dport

#define	SATA_PORT_DEACTIVATE_FUNC(sata_hba_inst) \

	(sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \

	NULL : \

	sata_hba_inst->satahba_tran->sata_tran_hotplug_ops->\

	sata_tran_port_deactivate)

#define	SATA_PORT_ACTIVATE_FUNC(sata_hba_inst) \

	(sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \

	NULL : \

	sata_hba_inst->satahba_tran->sata_tran_hotplug_ops->\

	sata_tran_port_activate)

#define	SATA_PROBE_PORT_FUNC(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_probe_port

#define	SATA_SELFTEST_FUNC(sata_hba_inst) \

	sata_hba_inst->satahba_tran->sata_tran_selftest

#define	SATA_CPORT_MUTEX(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_mutex

#define	SATA_CPORT_INFO(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]

#define	SATA_CPORT_STATE(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_state

#define	SATA_CPORT_SCR(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_scr

#define	SATA_CPORT_DEV_TYPE(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_dev_type

#define	SATA_CPORT_DRV_INFO(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_drive

#define	SATA_CPORTINFO_DRV_TYPE(cportinfo) \

	cportinfo->cport_dev_type

#define	SATA_CPORTINFO_DRV_INFO(cportinfo) \

	cportinfo->cport_devp.cport_sata_drive

#define	SATA_CPORTINFO_PMULT_INFO(cportinfo) \

	cportinfo->cport_devp.cport_sata_pmult

#define	SATA_PMULT_INFO(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_pmult

#define	SATA_NUM_PMPORTS(sata_hba_inst, cport) \

	sata_hba_inst->satahba_dev_port[cport]->\

	cport_devp.cport_sata_pmult->pmult_num_dev_ports

#define	SATA_PMPORT_INFO(sata_hba_inst, cport, pmport) \

	sata_hba_inst->satahba_dev_port[cport]->\