/*
* Copyright (c) 1998, 2001 Manuel Bouyer.
*
* 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
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
*/
/*-
* Copyright (c) 1991 The Regents of the University of California.
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* William Jolitz.
*
* 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
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
*
* @(#)wdreg.h 7.1 (Berkeley) 5/9/91
*/
/* Bytes used by ATAPI_PACKET_COMMAND (feature register) */
#define ATAPI_PKT_CMD_FTRE_DMA 0x01
#define ATAPI_PKT_CMD_FTRE_OVL 0x02
/* ireason */
#define WDCI_CMD 0x01 /* command(1) or data(0) */
#define WDCI_IN 0x02 /* transfer to(1) or from(0) the host */
#define WDCI_RELEASE 0x04 /* bus released until completion */
/*
* Drive parameter structure for ATA/ATAPI.
* Bit fields: WDC_* : common to ATA/ATAPI
* ATA_* : ATA only
* ATAPI_* : ATAPI only.
*/
struct ataparams {
/* drive info */
uint16_t atap_config; /* 0: general configuration */
#define WDC_CFG_CFA_MAGIC 0x848a
#define WDC_CFG_ATAPI 0x8000
#define ATA_CFG_REMOVABLE 0x0080
#define ATA_CFG_FIXED 0x0040
#define ATAPI_CFG_TYPE_MASK 0x1f00
#define ATAPI_CFG_TYPE(x) (((x) & ATAPI_CFG_TYPE_MASK) >> 8)
#define ATAPI_CFG_REMOV 0x0080
#define ATAPI_CFG_DRQ_MASK 0x0060
#define ATAPI_CFG_STD_DRQ 0x0000
#define ATAPI_CFG_IRQ_DRQ 0x0020
#define ATAPI_CFG_ACCEL_DRQ 0x0040
#define ATAPI_CFG_CMD_MASK 0x0003
#define ATAPI_CFG_CMD_12 0x0000
#define ATAPI_CFG_CMD_16 0x0001
/* words 1-9 are ATA only */
uint16_t atap_cylinders; /* 1: # of non-removable cylinders */
uint16_t __reserved1;
uint16_t atap_heads; /* 3: # of heads */
uint16_t __retired1[2]; /* 4-5: # of unform. bytes/track */
uint16_t atap_sectors; /* 6: # of sectors */
uint16_t __retired2[3];
uint8_t atap_serial[20]; /* 10-19: serial number */
uint16_t __retired3[2];
uint16_t __obsolete1;
uint8_t atap_revision[8]; /* 23-26: firmware revision */
uint8_t atap_model[40]; /* 27-46: model number */
uint16_t atap_multi; /* 47: maximum sectors per irq (ATA) */
uint16_t __reserved2;
uint16_t atap_capabilities1; /* 49: capability flags */
#define WDC_CAP_IORDY 0x0800
#define WDC_CAP_IORDY_DSBL 0x0400
#define WDC_CAP_LBA 0x0200
#define WDC_CAP_DMA 0x0100
#define ATA_CAP_STBY 0x2000
#define ATAPI_CAP_INTERL_DMA 0x8000
#define ATAPI_CAP_CMD_QUEUE 0x4000
#define ATAPI_CAP_OVERLP 0X2000
#define ATAPI_CAP_ATA_RST 0x1000
uint16_t atap_capabilities2; /* 50: capability flags (ATA) */
#if BYTE_ORDER == LITTLE_ENDIAN
uint8_t __junk2;
uint8_t atap_oldpiotiming; /* 51: old PIO timing mode */
uint8_t __junk3;
uint8_t atap_olddmatiming; /* 52: old DMA timing mode (ATA) */
#else
uint8_t atap_oldpiotiming; /* 51: old PIO timing mode */
uint8_t __junk2;
uint8_t atap_olddmatiming; /* 52: old DMA timing mode (ATA) */
uint8_t __junk3;
#endif
uint16_t atap_extensions; /* 53: extensions supported */
#define WDC_EXT_UDMA_MODES 0x0004
#define WDC_EXT_MODES 0x0002
#define WDC_EXT_GEOM 0x0001
/* words 54-62 are ATA only */
uint16_t atap_curcylinders; /* 54: current logical cylinders */
uint16_t atap_curheads; /* 55: current logical heads */
uint16_t atap_cursectors; /* 56: current logical sectors/tracks */
uint16_t atap_curcapacity[2]; /* 57-58: current capacity */
uint16_t atap_curmulti; /* 59: current multi-sector setting */
#define WDC_MULTI_VALID 0x0100
#define WDC_MULTI_MASK 0x00ff
uint16_t atap_capacity[2]; /* 60-61: total capacity (LBA only) */
uint16_t __retired4;
#if BYTE_ORDER == LITTLE_ENDIAN
uint8_t atap_dmamode_supp; /* 63: multiword DMA mode supported */
uint8_t atap_dmamode_act; /* multiword DMA mode active */
uint8_t atap_piomode_supp; /* 64: PIO mode supported */
uint8_t __junk4;
#else
uint8_t atap_dmamode_act; /* multiword DMA mode active */
uint8_t atap_dmamode_supp; /* 63: multiword DMA mode supported */
uint8_t __junk4;
uint8_t atap_piomode_supp; /* 64: PIO mode supported */
#endif
uint16_t atap_dmatiming_mimi; /* 65: minimum DMA cycle time */
uint16_t atap_dmatiming_recom; /* 66: recommended DMA cycle time */
uint16_t atap_piotiming; /* 67: mini PIO cycle time without FC */
uint16_t atap_piotiming_iordy; /* 68: mini PIO cycle time with IORDY FC */
uint16_t __reserved3[2];
/* words 71-72 are ATAPI only */
uint16_t atap_pkt_br; /* 71: time (ns) to bus release */
uint16_t atap_pkt_bsyclr; /* 72: tme to clear BSY after service */
uint16_t __reserved4[2];
uint16_t atap_queuedepth; /* 75: */
#define WDC_QUEUE_DEPTH_MASK 0x1F
uint16_t atap_sata_caps; /* 76: */
#define SATA_SIGNAL_GEN1 0x02
#define SATA_SIGNAL_GEN2 0x04
#define SATA_SIGNAL_GEN3 0x08
#define SATA_NATIVE_CMDQ 0x0100 /* supp. NCQ feature set */
#define SATA_HOST_PWR_MGMT 0x0200 /* supp. host-init. pwr mngmt reqs */
#define SATA_PHY_EVNT_CNT 0x0400 /* supp. SATA Phy Event Counters log */
#define SATA_UNLOAD_W_NCQ 0x0800 /* supp. unload w/ NCQ commands act */
#define SATA_NCQ_PRIO 0x1000 /* supp. NCQ priority information */
uint16_t atap_sata_reserved; /* 77: */
uint16_t atap_sata_features_supp; /* 78: */
#define SATA_NONZERO_OFFSETS 0x02
#define SATA_DMA_SETUP_AUTO 0x04
#define SATA_DRIVE_PWR_MGMT 0x08
#define SATA_IN_ORDER_DATA 0x10
#define SATA_SW_STTNGS_PRS 0x40
uint16_t atap_sata_features_en; /* 79: */
uint16_t atap_ata_major; /* 80: Major version number */
#define WDC_VER_ATA1 0x0002
#define WDC_VER_ATA2 0x0004
#define WDC_VER_ATA3 0x0008
#define WDC_VER_ATA4 0x0010
#define WDC_VER_ATA5 0x0020
#define WDC_VER_ATA6 0x0040
#define WDC_VER_ATA7 0x0080
#define WDC_VER_ATA8 0x0100
uint16_t atap_ata_minor; /* 81: Minor version number */
uint16_t atap_cmd_set1; /* 82: command set supported */
#define WDC_CMD1_NOP 0x4000 /* NOP */
#define WDC_CMD1_RB 0x2000 /* READ BUFFER */
#define WDC_CMD1_WB 0x1000 /* WRITE BUFFER */
/* 0x0800 Obsolete */
#define WDC_CMD1_HPA 0x0400 /* Host Protected Area */
#define WDC_CMD1_DVRST 0x0200 /* DEVICE RESET */
#define WDC_CMD1_SRV 0x0100 /* SERVICE */
#define WDC_CMD1_RLSE 0x0080 /* release interrupt */
#define WDC_CMD1_AHEAD 0x0040 /* look-ahead */
#define WDC_CMD1_CACHE 0x0020 /* write cache */
#define WDC_CMD1_PKT 0x0010 /* PACKET */
#define WDC_CMD1_PM 0x0008 /* Power Management */
#define WDC_CMD1_REMOV 0x0004 /* Removable Media */
#define WDC_CMD1_SEC 0x0002 /* Security Mode */
#define WDC_CMD1_SMART 0x0001 /* SMART */
uint16_t atap_cmd_set2; /* 83: command set supported */
#define ATA_CMD2_FCE 0x2000 /* FLUSH CACHE EXT */
#define WDC_CMD2_FC 0x1000 /* FLUSH CACHE */
#define WDC_CMD2_DCO 0x0800 /* Device Configuration Overlay */
#define ATA_CMD2_LBA48 0x0400 /* 48-bit Address */
#define WDC_CMD2_AAM 0x0200 /* Automatic Acoustic Management */
#define WDC_CMD2_SM 0x0100 /* SET MAX security extension */
#define WDC_CMD2_SFREQ 0x0040 /* SET FEATURE is required
to spin-up after power-up */
#define WDC_CMD2_PUIS 0x0020 /* Power-Up In Standby */
#define WDC_CMD2_RMSN 0x0010 /* Removable Media Status Notify */
#define ATA_CMD2_APM 0x0008 /* Advanced Power Management */
#define ATA_CMD2_CFA 0x0004 /* CFA */
#define ATA_CMD2_RWQ 0x0002 /* READ/WRITE DMA QUEUED */
#define WDC_CMD2_DM 0x0001 /* DOWNLOAD MICROCODE */
uint16_t atap_cmd_ext; /* 84: command/features supp. ext. */
#define ATA_CMDE_TLCONT 0x1000 /* Time-limited R/W Continuous */
#define ATA_CMDE_TL 0x0800 /* Time-limited R/W */
#define ATA_CMDE_URGW 0x0400 /* URG for WRITE STREAM DMA/PIO */
#define ATA_CMDE_URGR 0x0200 /* URG for READ STREAM DMA/PIO */
#define ATA_CMDE_WWN 0x0100 /* World Wide name */
#define ATA_CMDE_WQFE 0x0080 /* WRITE DMA QUEUED FUA EXT */
#define ATA_CMDE_WFE 0x0040 /* WRITE DMA/MULTIPLE FUA EXT */
#define ATA_CMDE_GPL 0x0020 /* General Purpose Logging */
#define ATA_CMDE_STREAM 0x0010 /* Streaming */
#define ATA_CMDE_MCPTC 0x0008 /* Media Card Pass Through Cmd */
#define ATA_CMDE_MS 0x0004 /* Media serial number */
#define ATA_CMDE_SST 0x0002 /* SMART self-test */
#define ATA_CMDE_SEL 0x0001 /* SMART error logging */
uint16_t atap_cmd1_en; /* 85: cmd/features enabled */
/* bits are the same as atap_cmd_set1 */
uint16_t atap_cmd2_en; /* 86: cmd/features enabled */
/* bits are the same as atap_cmd_set2 */
uint16_t atap_cmd_def; /* 87: cmd/features default */
#if BYTE_ORDER == LITTLE_ENDIAN
uint8_t atap_udmamode_supp; /* 88: Ultra-DMA mode supported */
uint8_t atap_udmamode_act; /* Ultra-DMA mode active */
#else
uint8_t atap_udmamode_act; /* Ultra-DMA mode active */
uint8_t atap_udmamode_supp; /* 88: Ultra-DMA mode supported */
#endif
/* 89-92 are ATA-only */
uint16_t atap_seu_time; /* 89: Sec. Erase Unit compl. time */
uint16_t atap_eseu_time; /* 90: Enhanced SEU compl. time */
uint16_t atap_apm_val; /* 91: current APM value */
uint16_t __reserved5[8]; /* 92-99: reserved */
uint16_t atap_max_lba[4]; /* 100-103: Max. user LBA addr */
uint16_t __reserved6; /* 104: reserved */
uint16_t max_dsm_blocks; /* 105: DSM (ATA-8/ACS-2) */
uint16_t atap_secsz; /* 106: physical/logical sector size */
#define ATA_SECSZ_VALID_MASK 0xc000
#define ATA_SECSZ_VALID 0x4000
#define ATA_SECSZ_LPS 0x2000 /* long physical sectors */
#define ATA_SECSZ_LLS 0x1000 /* long logical sectors */
#define ATA_SECSZ_LPS_SZMSK 0x000f /* 2**N logical per physical */
uint16_t atap_iso7779_isd; /* 107: ISO 7779 inter-seek delay */
uint16_t atap_wwn[4]; /* 108-111: World Wide Name */
uint16_t __reserved7[5]; /* 112-116 */
uint16_t atap_lls_secsz[2]; /* 117-118: long logical sector size */
uint16_t __reserved8[8]; /* 119-126 */
uint16_t atap_rmsn_supp; /* 127: remov. media status notif. */
#define WDC_RMSN_SUPP_MASK 0x0003
#define WDC_RMSN_SUPP 0x0001
uint16_t atap_sec_st; /* 128: security status */
#define WDC_SEC_LEV_MAX 0x0100
#define WDC_SEC_ESE_SUPP 0x0020
#define WDC_SEC_EXP 0x0010
#define WDC_SEC_FROZEN 0x0008
#define WDC_SEC_LOCKED 0x0004
#define WDC_SEC_EN 0x0002
#define WDC_SEC_SUPP 0x0001
uint16_t __reserved9[31]; /* 129-159: vendor specific */
uint16_t atap_cfa_power; /* 160: CFA powermode */
#define ATA_CFA_MAX_MASK 0x0fff
#define ATA_CFA_MODE1_DIS 0x1000 /* CFA Mode 1 Disabled */
#define ATA_CFA_MODE1_REQ 0x2000 /* CFA Mode 1 Required */
#define ATA_CFA_WORD160 0x8000 /* Word 160 supported */
uint16_t __reserved10[8]; /* 161-168: reserved for CFA */
uint16_t support_dsm; /* 169: DSM (ATA-8/ACS-2) */
#define ATA_SUPPORT_DSM_TRIM 0x0001
uint16_t __reserved10a[6]; /* 170-175: reserved for CFA */
uint8_t atap_media_serial[60]; /* 176-205: media serial number */
uint16_t __reserved11[3]; /* 206-208: */
uint16_t atap_logical_align; /* 209: logical/physical alignment */
#define ATA_LA_VALID_MASK 0xc000
#define ATA_LA_VALID 0x4000
#define ATA_LA_MASK 0x3fff /* offset of sector LBA 0 in PBA 0 */
uint16_t __reserved12[45]; /* 210-254: */
uint16_t atap_integrity; /* 255: Integrity word */
#define WDC_INTEGRITY_MAGIC_MASK 0x00ff
#define WDC_INTEGRITY_MAGIC 0x00a5
};
/*
* If WDSM_ATTR_ADVISORY, device exceeded intended design life period.
* If not WDSM_ATTR_ADVISORY, imminent data loss predicted.
*/
#define WDSM_ATTR_ADVISORY 1
/*
* If WDSM_ATTR_COLLECTIVE, attribute only updated in off-line testing.
* If not WDSM_ATTR_COLLECTIVE, attribute updated also in on-line testing.
*/
#define WDSM_ATTR_COLLECTIVE 2
/*
* ATA SMART attributes
*/
struct ata_smart_attr {
uint8_t id; /* attribute id number */
uint16_t flags;
uint8_t value; /* attribute value */
uint8_t worst;
uint8_t raw[6];
uint8_t reserved;
} __packed;