freebsd-skq/sys/i386/isa/wdreg.h

/*-
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. 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.
 *
 *	from: @(#)wdreg.h	7.1 (Berkeley) 5/9/91
 *	$Id: wdreg.h,v 1.17 1997/02/22 09:37:27 peter Exp $
 */

/*
 * modified for PC9801 by F.Ukai
 *			Kyoto University Microcomputer Club (KMC)
 */

/*
 * Disk Controller register definitions.
 */
#ifdef PC98
#define	wd_data		0x0		/* data register (R/W - 16 bits) */
#define wd_error	0x2		/* error register (R) */
#define	wd_precomp	wd_error	/* write precompensation (W) */
#define wd_features	wd_error	/* features register (W) */
#define	wd_seccnt	0x4		/* sector count (R/W) */
#define	wd_sector	0x6		/* first sector number (R/W) */
#define	wd_cyl_lo	0x8		/* cylinder address, low byte (R/W) */
#define	wd_cyl_hi	0xa		/* cylinder address, high byte (R/W)*/
#define	wd_sdh		0xc		/* sector size/drive/head (R/W)*/
#define	wd_command	0xe		/* command register (W)	 */
#define	wd_status wd_command		/* immediate status (R)	 */

#define	wd_altsts_nec	0x10c	 /*alternate fixed disk status(via 1015) (R)*/
#define	wd_ctlr_nec	0x10c	 /*fixed disk controller control(via 1015) (W)*/
#define	wd_altsts_epson	0x3	 /*alternate fixed disk status(via 1015) (R)*/
#define	wd_ctlr_epson	0x3	 /*fixed disk controller control(via 1015) (W)*/
#define wd_altsts		wd_alsts_nec

#define  WDCTL_4BIT	 0x8	/* use four head bits (wd1003) */
#define  WDCTL_RST	 0x4	/* reset the controller */
#define  WDCTL_IDS	 0x2	/* disable controller interrupts */
#define	wd_digin	0x10e	 /* disk controller input(via 1015) (R)*/
#else	/* IBM-PC */
#define	wd_data		0x0		/* data register (R/W - 16 bits) */
#define wd_error	0x1		/* error register (R) */
#define	wd_precomp	wd_error	/* write precompensation (W) */
#define wd_features	wd_error	/* features register (W) */
#define	wd_seccnt	0x2		/* sector count (R/W) */
#define	wd_sector	0x3		/* first sector number (R/W) */
#define	wd_cyl_lo	0x4		/* cylinder address, low byte (R/W) */
#define	wd_cyl_hi	0x5		/* cylinder address, high byte (R/W)*/
#define	wd_sdh		0x6		/* sector size/drive/head (R/W)*/
#define	wd_command	0x7		/* command register (W)	 */
#define	wd_status wd_command		/* immediate status (R)	 */

#define	wd_altsts	0x206	 /*alternate fixed disk status(via 1015) (R)*/
#define	wd_ctlr		0x206	 /*fixed disk controller control(via 1015) (W)*/
#define  WDCTL_4BIT	 0x8	/* use four head bits (wd1003) */
#define  WDCTL_RST	 0x4	/* reset the controller */
#define  WDCTL_IDS	 0x2	/* disable controller interrupts */
#define	wd_digin	0x207	 /* disk controller input(via 1015) (R)*/
#endif	/* PC98 */

/*
 * Status Bits.
 */
#define	WDCS_BUSY	0x80		/* Controller busy bit. */
#define	WDCS_READY	0x40		/* Selected drive is ready */
#define	WDCS_WRTFLT	0x20		/* Write fault */
#define	WDCS_SEEKCMPLT	0x10		/* Seek complete */
#define	WDCS_DRQ	0x08		/* Data request bit. */
#define	WDCS_ECCCOR	0x04		/* ECC correction made in data */
#define	WDCS_INDEX	0x02		/* Index pulse from selected drive */
#define	WDCS_ERR	0x01		/* Error detect bit. */

#define WDCS_BITS	"\020\010busy\007rdy\006wrtflt\005seekdone\004drq\003ecc_cor\002index\001err"
#define WDERR_ABORT	0x04

#define WDERR_BITS	"\020\010badblk\007uncorr\006id_crc\005no_id\003abort\002tr000\001no_dam"

/*
 * Commands for Disk Controller.
 */
#define	WDCC_RESTORE	0x10		/* disk restore code -- resets cntlr */

#define	WDCC_READ	0x20		/* disk read code */
#define	WDCC_WRITE	0x30		/* disk write code */
#define	 WDCC__LONG	 0x02		 /* modifier -- access ecc bytes */
#define	 WDCC__NORETRY	 0x01		 /* modifier -- no retrys */

#define	WDCC_FORMAT	0x50		/* disk format code */
#define	WDCC_DIAGNOSE	0x90		/* controller diagnostic */
#define	WDCC_IDC	0x91		/* initialize drive command */
#define WDCC_READ_MULTI	0xC4	/* read multiple */
#define WDCC_WRITE_MULTI	0xC5	/* write multiple */
#define WDCC_SET_MULTI 0xC6		/* set multiple count */
#define WDCC_READ_DMA	0xC8		/* read using DMA */
#define WDCC_WRITE_DMA	0xCA		/* write using DMA */


#define	WDCC_EXTDCMD	0xE0		/* send extended command */
#define	WDCC_READP	0xEC		/* read parameters from controller */
#define	WDCC_FEATURES	0xEF		/* features control */

#define	WDFEA_RCACHE	0xAA		/* read cache enable */
#define WDFEA_WCACHE	0x02		/* write cache enable */
#define WDFEA_SETXFER	0x03		/* set transfer mode */

#define	WD_STEP		0		/* winchester- default 35us step */

#define	WDSD_IBM	0xa0		/* forced to 512 byte sector, ecc */

#ifdef KERNEL
/*
 * read parameters command returns this:
 */
struct wdparams {
	/*
	 * XXX partly based on DRAFT X3T13/1153D rev 14.  
	 * by the time you read this it will have changed.
	 */
	/* drive info */
	short	wdp_config;		/* general configuration bits */
	u_short	wdp_cylinders;		/* number of cylinders */
	short	wdp_reserved2;
	u_short	wdp_heads;		/* number of heads */
	short	wdp_unfbytespertrk;	/* number of unformatted bytes/track */
	short	wdp_unfbytes;		/* number of unformatted bytes/sector */
	u_short	wdp_sectors;		/* number of sectors per track */
	short	wdp_vendorunique[3];
	/* controller info */
	char	wdp_serial[20];		/* serial number */
	short	wdp_buffertype;		/* buffer type */
#define	WDTYPE_SINGLEPORTSECTOR	1	 /* single port, single sector buffer */
#define	WDTYPE_DUALPORTMULTI	2	 /* dual port, multiple sector buffer */
#define	WDTYPE_DUALPORTMULTICACHE 3	 /* above plus track cache */
	short	wdp_buffersize;		/* buffer size, in 512-byte units */
	short	wdp_necc;		/* ecc bytes appended */
	char	wdp_rev[8];		/* firmware revision */
	char	wdp_model[40];		/* model name */
	char	wdp_nsecperint;		/* sectors per interrupt */
	char	wdp_vendorunique1;
	short	wdp_usedmovsd;		/* can use double word read/write? */
	char	wdp_vendorunique2;
	char	wdp_capability;		/* various capability bits */
	short	wdp_cap_validate;	/* validation for above */
	char	wdp_vendorunique3;
	char	wdp_opiomode;		/* PIO modes 0-2 */
	char	wdp_vendorunique4;
	char	wdp_odmamode;		/* old DMA modes, not in ATA-3 */
	short	wdp_atavalid;		/* validation for newer fields */
	short	wdp_currcyls;
	short	wdp_currheads;
	short	wdp_currsectors;
	short	wdp_currsize0;
	short	wdp_currsize1;
	char	wdp_currmultsect;
	char	wdp_multsectvalid;
	int	wdp_lbasize;
	short	wdp_dmasword;		/* obsolete in ATA-3 */
	short	wdp_dmamword;		/* multiword DMA modes */
	short	wdp_eidepiomodes;	/* advanced PIO modes */
	short	wdp_eidedmamin;		/* fastest possible DMA timing */
	short	wdp_eidedmanorm;	/* recommended DMA timing */
	short	wdp_eidepioblind;	/* fastest possible blind PIO */
	short	wdp_eidepioacked;	/* fastest possible IORDY PIO */
	short	wdp_reserved69;
	short	wdp_reserved70;
	short	wdp_reserved71;
	short	wdp_reserved72;
	short	wdp_reserved73;
	short	wdp_reserved74;
	short	wdp_queuelen;
	short	wdp_reserved76;
	short	wdp_reserved77;
	short	wdp_reserved78;
	short	wdp_reserved79;
	short	wdp_versmaj;
	short	wdp_versmin;
	short	wdp_featsupp1;
	short	wdp_featsupp2;
	short	wdp_featsupp3;
	short	wdp_featenab1;
	short	wdp_featenab2;
	short	wdp_featenab3;
	short	wdp_udmamode;		/* UltraDMA modes */
	short	wdp_erasetime;
	short	wdp_enherasetime;
	short	wdp_apmlevel;
	short	wdp_reserved92[34];
	short	wdp_rmvcap;
	short	wdp_securelevel;
};

/*
 * wd driver entry points
 */
#ifdef	B_FORMAT
int wdformat(struct buf *bp);
#endif

/*
 * IDE DMA support.
 * This is based on what is needed for the IDE DMA function of the Intel
 * Triton chipset; hopefully it's general enough to be used for other
 * chipsets as well.
 *
 * To use this:
 *	For each drive which you might want to do DMA on, call wdd_candma()
 *	to get a cookie.  If it returns a null pointer, then the drive
 *	can't do DMA.  Then call wdd_dmainit() to initialize the controller
 *	and drive.  wdd_dmainit should leave PIO modes operational, though
 *	perhaps with suboptimal performance.
 *
 *	Check the transfer by calling wdd_dmaverify().  The cookie is what
 *	you got before; vaddr is the virtual address of the buffer to be
 *	written; len is the length of the buffer; and direction is either
 *	B_READ or B_WRITE. This function verifies that the DMA hardware is
 *	capable of handling the request you've made.
 *
 *	Setup the transfer by calling wdd_dmaprep().  This takes the same
 *	paramaters as wdd_dmaverify().
 *
 *	Send a read/write DMA command to the drive.
 *
 *	Call wdd_dmastart().
 *
 *	Wait for an interrupt.  Multi-sector transfers will only interrupt
 *	at the end of the transfer.
 *
 *	Call wdd_dmadone().  It will return the status as defined by the
 *	WDDS_* constants below.
 */
struct wddma {
	void	*(*wdd_candma)		/* returns a cookie if can do DMA */
		__P((int ctlr, int drive));
	int	(*wdd_dmaverify)	/* verify that request is DMA-able */
		__P((void *cookie, char *vaddr, u_long len, int direction));
	int	(*wdd_dmaprep)		/* prepare DMA hardware */
		__P((void *cookie, char *vaddr, u_long len, int direction));
	void	(*wdd_dmastart)		/* begin DMA transfer */
		__P((void *cookie));
	int	(*wdd_dmadone)		/* DMA transfer completed */
		__P((void *cookie));
	int	(*wdd_dmastatus)	/* return status of DMA */
		__P((void *cookie));
	int	(*wdd_dmainit)		/* initialize controller and drive */
		__P((void *cookie, 
		     struct wdparams *wp, 
		     int(wdcmd)__P((int mode, void *wdinfo)),
		     void *wdinfo));
};

/* logical status bits returned by wdd_dmastatus */
#define	WDDS_ACTIVE	0x0001
#define	WDDS_ERROR	0x0002
#define	WDDS_INTERRUPT	0x0004

#if 0
/* XXX are these now useless? */
/* local defines for ATA timing modes */
#define WDDMA_GRPMASK	0xf0
/* flow-controlled PIO modes */
#define	WDDMA_PIO	0x10
#define WDDMA_PIO3	0x10
#define WDDMA_PIO4	0x11
/* multi-word DMA timing modes */
#define	WDDMA_MDMA	0x20
#define	WDDMA_MDMA0	0x20
#define	WDDMA_MDMA1	0x21
#define	WDDMA_MDMA2	0x22

/* Ultra DMA timing modes */
#define	WDDMA_UDMA	0x30
#define	WDDMA_UDMA0	0x30
#define	WDDMA_UDMA1	0x31
#define	WDDMA_UDMA2	0x32
#endif

extern struct wddma wddma;

#endif /* KERNEL */