Home | History | Annotate | Line # | Download | only in ic
wdcvar.h revision 1.87.24.1
      1  1.87.24.1      matt /*	wdcvar.h,v 1.87 2006/10/25 17:33:02 bouyer Exp	*/
      2        1.1       cgd 
      3        1.3   mycroft /*-
      4       1.82   mycroft  * Copyright (c) 1998, 2003, 2004 The NetBSD Foundation, Inc.
      5        1.3   mycroft  * All rights reserved.
      6        1.1       cgd  *
      7        1.3   mycroft  * This code is derived from software contributed to The NetBSD Foundation
      8        1.3   mycroft  * by Charles M. Hannum, by Onno van der Linden and by Manuel Bouyer.
      9        1.1       cgd  *
     10        1.1       cgd  * Redistribution and use in source and binary forms, with or without
     11        1.1       cgd  * modification, are permitted provided that the following conditions
     12        1.1       cgd  * are met:
     13        1.1       cgd  * 1. Redistributions of source code must retain the above copyright
     14        1.6    bouyer  *	notice, this list of conditions and the following disclaimer.
     15        1.1       cgd  * 2. Redistributions in binary form must reproduce the above copyright
     16        1.6    bouyer  *	notice, this list of conditions and the following disclaimer in the
     17        1.6    bouyer  *	documentation and/or other materials provided with the distribution.
     18        1.1       cgd  * 3. All advertising materials mentioning features or use of this software
     19        1.1       cgd  *    must display the following acknowledgement:
     20        1.3   mycroft  *        This product includes software developed by the NetBSD
     21        1.3   mycroft  *        Foundation, Inc. and its contributors.
     22        1.3   mycroft  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23        1.3   mycroft  *    contributors may be used to endorse or promote products derived
     24        1.3   mycroft  *    from this software without specific prior written permission.
     25        1.1       cgd  *
     26        1.3   mycroft  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27        1.3   mycroft  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28        1.3   mycroft  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29        1.3   mycroft  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30        1.3   mycroft  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31        1.3   mycroft  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32        1.3   mycroft  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33        1.3   mycroft  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34        1.3   mycroft  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35        1.3   mycroft  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36        1.3   mycroft  * POSSIBILITY OF SUCH DAMAGE.
     37        1.1       cgd  */
     38        1.1       cgd 
     39       1.50   thorpej #ifndef _DEV_IC_WDCVAR_H_
     40       1.50   thorpej #define	_DEV_IC_WDCVAR_H_
     41       1.50   thorpej 
     42       1.57   thorpej #include <sys/callout.h>
     43       1.57   thorpej 
     44       1.85     itohy #include <dev/ata/ataconf.h>
     45       1.57   thorpej #include <dev/ic/wdcreg.h>
     46       1.22   thorpej 
     47        1.6    bouyer #define	WAITTIME    (10 * hz)    /* time to wait for a completion */
     48        1.6    bouyer 	/* this is a lot for hard drives, but not for cdroms */
     49        1.5      mark 
     50       1.45    bouyer #define WDC_NREG	8 /* number of command registers */
     51       1.57   thorpej #define	WDC_NSHADOWREG	2 /* number of command "shadow" registers */
     52        1.6    bouyer 
     53       1.75   thorpej struct wdc_regs {
     54        1.6    bouyer 	/* Our registers */
     55        1.6    bouyer 	bus_space_tag_t       cmd_iot;
     56       1.44      fvdl 	bus_space_handle_t    cmd_baseioh;
     57       1.57   thorpej 	bus_space_handle_t    cmd_iohs[WDC_NREG+WDC_NSHADOWREG];
     58        1.6    bouyer 	bus_space_tag_t       ctl_iot;
     59        1.6    bouyer 	bus_space_handle_t    ctl_ioh;
     60       1.75   thorpej 
     61       1.75   thorpej 	/* data32{iot,ioh} are only used for 32-bit data xfers */
     62       1.63   mycroft 	bus_space_tag_t       data32iot;
     63       1.63   mycroft 	bus_space_handle_t    data32ioh;
     64       1.87    bouyer 
     65       1.87    bouyer 	/* SATA native registers */
     66       1.87    bouyer 	bus_space_tag_t       sata_iot;
     67       1.87    bouyer 	bus_space_handle_t    sata_baseioh;
     68       1.87    bouyer 	bus_space_handle_t    sata_control;
     69       1.87    bouyer 	bus_space_handle_t    sata_status;
     70       1.87    bouyer 	bus_space_handle_t    sata_error;
     71       1.87    bouyer 
     72       1.41    bouyer };
     73       1.41    bouyer 
     74       1.53   thorpej /*
     75       1.53   thorpej  * Per-controller data
     76       1.53   thorpej  */
     77       1.53   thorpej struct wdc_softc {
     78       1.77   thorpej 	struct atac_softc sc_atac;	/* generic ATA controller info */
     79       1.53   thorpej 
     80       1.75   thorpej 	struct wdc_regs *regs;		/* register array (per-channel) */
     81       1.75   thorpej 
     82       1.53   thorpej 	int           cap;		/* controller capabilities */
     83        1.6    bouyer #define WDC_CAPABILITY_NO_EXTRA_RESETS 0x0100 /* only reset once */
     84       1.63   mycroft #define WDC_CAPABILITY_PREATA	0x0200	/* ctrl can be a pre-ata one */
     85       1.80  rearnsha #define WDC_CAPABILITY_WIDEREGS 0x0400  /* Ctrl has wide (16bit) registers  */
     86       1.48   thorpej 
     87       1.86     itohy #if NATA_DMA || NATA_PIOBM
     88        1.1       cgd 	/* if WDC_CAPABILITY_DMA set in 'cap' */
     89        1.6    bouyer 	void            *dma_arg;
     90       1.50   thorpej 	int            (*dma_init)(void *, int, int, void *, size_t, int);
     91       1.50   thorpej 	void           (*dma_start)(void *, int, int);
     92       1.50   thorpej 	int            (*dma_finish)(void *, int, int, int);
     93       1.85     itohy #if NATA_PIOBM
     94       1.85     itohy 	void           (*piobm_start)(void *, int, int, int, int, int);
     95       1.85     itohy 	void           (*piobm_done)(void *, int, int);
     96       1.85     itohy #endif
     97       1.24    bouyer /* flags passed to dma_init */
     98       1.85     itohy #define WDC_DMA_READ		0x01
     99       1.85     itohy #define WDC_DMA_IRQW		0x02
    100       1.85     itohy #define WDC_DMA_LBA48		0x04
    101       1.85     itohy #define WDC_DMA_PIOBM_ATA	0x08
    102       1.85     itohy #define WDC_DMA_PIOBM_ATAPI	0x10
    103       1.85     itohy #if NATA_PIOBM
    104       1.85     itohy /* flags passed to piobm_start */
    105       1.85     itohy #define WDC_PIOBM_XFER_IRQ	0x01
    106       1.85     itohy #endif
    107       1.50   thorpej 
    108       1.60    bouyer /* values passed to dma_finish */
    109       1.60    bouyer #define WDC_DMAEND_END	0	/* check for proper end of a DMA xfer */
    110       1.60    bouyer #define WDC_DMAEND_ABRT 1	/* abort a DMA xfer, verbose */
    111       1.60    bouyer #define WDC_DMAEND_ABRT_QUIET 2	/* abort a DMA xfer, quiet */
    112       1.60    bouyer 
    113       1.24    bouyer 	int		dma_status; /* status returned from dma_finish() */
    114       1.24    bouyer #define WDC_DMAST_NOIRQ	0x01	/* missing IRQ */
    115       1.24    bouyer #define WDC_DMAST_ERR	0x02	/* DMA error */
    116       1.24    bouyer #define WDC_DMAST_UNDER	0x04	/* DMA underrun */
    117       1.86     itohy #endif	/* NATA_DMA || NATA_PIOBM */
    118        1.2       leo 
    119       1.74   thorpej 	/* Optional callback to select drive. */
    120       1.75   thorpej 	void		(*select)(struct ata_channel *,int);
    121       1.25    bouyer 
    122       1.74   thorpej 	/* Optional callback to ack IRQ. */
    123       1.75   thorpej 	void		(*irqack)(struct ata_channel *);
    124       1.64   mycroft 
    125       1.83    bouyer 	/* Optional callback to perform a bus reset */
    126       1.83    bouyer 	void		(*reset)(struct ata_channel *, int);
    127       1.83    bouyer 
    128       1.64   mycroft 	/* overridden if the backend has a different data transfer method */
    129       1.75   thorpej 	void	(*datain_pio)(struct ata_channel *, int, void *, size_t);
    130       1.75   thorpej 	void	(*dataout_pio)(struct ata_channel *, int, void *, size_t);
    131        1.1       cgd };
    132        1.1       cgd 
    133       1.76   thorpej /* Given an ata_channel, get the wdc_softc. */
    134       1.77   thorpej #define	CHAN_TO_WDC(chp)	((struct wdc_softc *)(chp)->ch_atac)
    135       1.76   thorpej 
    136       1.76   thorpej /* Given an ata_channel, get the wdc_regs. */
    137       1.76   thorpej #define	CHAN_TO_WDC_REGS(chp)	(&CHAN_TO_WDC(chp)->regs[(chp)->ch_channel])
    138       1.76   thorpej 
    139        1.6    bouyer /*
    140        1.6    bouyer  * Public functions which can be called by ATA or ATAPI specific parts,
    141        1.6    bouyer  * or bus-specific backends.
    142        1.6    bouyer  */
    143        1.1       cgd 
    144       1.75   thorpej void	wdc_allocate_regs(struct wdc_softc *);
    145       1.75   thorpej void	wdc_init_shadow_regs(struct ata_channel *);
    146       1.57   thorpej 
    147       1.75   thorpej int	wdcprobe(struct ata_channel *);
    148       1.75   thorpej void	wdcattach(struct ata_channel *);
    149  1.87.24.1      matt int	wdcdetach(device_t, int);
    150  1.87.24.1      matt void	wdc_childdetached(device_t, device_t);
    151  1.87.24.1      matt int	wdcactivate(device_t, enum devact);
    152       1.50   thorpej int	wdcintr(void *);
    153       1.50   thorpej 
    154       1.87    bouyer void	wdc_sataprobe(struct ata_channel *);
    155       1.87    bouyer void	wdc_drvprobe(struct ata_channel *);
    156       1.87    bouyer 
    157       1.50   thorpej void	wdcrestart(void*);
    158       1.50   thorpej 
    159       1.75   thorpej int	wdcwait(struct ata_channel *, int, int, int, int);
    160       1.41    bouyer #define WDCWAIT_OK	0  /* we have what we asked */
    161       1.41    bouyer #define WDCWAIT_TOUT	-1 /* timed out */
    162       1.41    bouyer #define WDCWAIT_THR	1  /* return, the kernel thread has been awakened */
    163       1.50   thorpej 
    164       1.75   thorpej void	wdcbit_bucket(struct ata_channel *, int);
    165       1.63   mycroft 
    166       1.75   thorpej int	wdc_dmawait(struct ata_channel *, struct ata_xfer *, int);
    167       1.75   thorpej void	wdccommand(struct ata_channel *, u_int8_t, u_int8_t, u_int16_t,
    168       1.50   thorpej 		   u_int8_t, u_int8_t, u_int8_t, u_int8_t);
    169       1.75   thorpej void	wdccommandext(struct ata_channel *, u_int8_t, u_int8_t, u_int64_t,
    170       1.50   thorpej 		      u_int16_t);
    171       1.75   thorpej void	wdccommandshort(struct ata_channel *, int, int);
    172       1.50   thorpej void	wdctimeout(void *arg);
    173       1.58    bouyer void	wdc_reset_drive(struct ata_drive_datas *, int);
    174       1.75   thorpej void	wdc_reset_channel(struct ata_channel *, int);
    175       1.83    bouyer void	wdc_do_reset(struct ata_channel *, int);
    176       1.50   thorpej 
    177       1.65   thorpej int	wdc_exec_command(struct ata_drive_datas *, struct ata_command*);
    178        1.9   thorpej 
    179       1.81     perry /*
    180        1.6    bouyer  * ST506 spec says that if READY or SEEKCMPLT go off, then the read or write
    181        1.6    bouyer  * command is aborted.
    182       1.81     perry  */
    183       1.51   thorpej #define wdc_wait_for_drq(chp, timeout, flags) \
    184       1.41    bouyer 		wdcwait((chp), WDCS_DRQ, WDCS_DRQ, (timeout), (flags))
    185       1.51   thorpej #define wdc_wait_for_unbusy(chp, timeout, flags) \
    186       1.41    bouyer 		wdcwait((chp), 0, 0, (timeout), (flags))
    187       1.51   thorpej #define wdc_wait_for_ready(chp, timeout, flags) \
    188       1.41    bouyer 		wdcwait((chp), WDCS_DRDY, WDCS_DRDY, (timeout), (flags))
    189       1.50   thorpej 
    190        1.6    bouyer /* ATA/ATAPI specs says a device can take 31s to reset */
    191        1.6    bouyer #define WDC_RESET_WAIT 31000
    192        1.1       cgd 
    193       1.50   thorpej void	wdc_atapibus_attach(struct atabus_softc *);
    194       1.47   thorpej 
    195       1.50   thorpej #endif /* _DEV_IC_WDCVAR_H_ */
    196