atavar.h revision 1.9
1 1.9 bouyer /* $NetBSD: atavar.h,v 1.9 1998/12/16 13:02:03 bouyer Exp $ */ 2 1.2 bouyer 3 1.2 bouyer /* 4 1.2 bouyer * Copyright (c) 1998 Manuel Bouyer. 5 1.2 bouyer * 6 1.2 bouyer * Redistribution and use in source and binary forms, with or without 7 1.2 bouyer * modification, are permitted provided that the following conditions 8 1.2 bouyer * are met: 9 1.2 bouyer * 1. Redistributions of source code must retain the above copyright 10 1.2 bouyer * notice, this list of conditions and the following disclaimer. 11 1.2 bouyer * 2. Redistributions in binary form must reproduce the above copyright 12 1.2 bouyer * notice, this list of conditions and the following disclaimer in the 13 1.2 bouyer * documentation and/or other materials provided with the distribution. 14 1.2 bouyer * 3. All advertising materials mentioning features or use of this software 15 1.2 bouyer * must display the following acknowledgement: 16 1.2 bouyer * This product includes software developed by the University of 17 1.2 bouyer * California, Berkeley and its contributors. 18 1.2 bouyer * 4. Neither the name of the University nor the names of its contributors 19 1.2 bouyer * may be used to endorse or promote products derived from this software 20 1.2 bouyer * without specific prior written permission. 21 1.2 bouyer * 22 1.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 1.2 bouyer * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 1.2 bouyer * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 1.2 bouyer * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 1.2 bouyer * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 1.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 1.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 1.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 1.2 bouyer * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 1.2 bouyer * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 1.2 bouyer * SUCH DAMAGE. 33 1.2 bouyer * 34 1.2 bouyer */ 35 1.2 bouyer 36 1.2 bouyer /* Hight-level functions and structures used by both ATA and ATAPI devices */ 37 1.2 bouyer 38 1.2 bouyer /* Datas common to drives and controller drivers */ 39 1.2 bouyer struct ata_drive_datas { 40 1.2 bouyer u_int8_t drive; /* drive number */ 41 1.7 bouyer u_int16_t drive_flags; /* bitmask for drives present/absent and cap */ 42 1.2 bouyer #define DRIVE_ATA 0x01 43 1.2 bouyer #define DRIVE_ATAPI 0x02 44 1.2 bouyer #define DRIVE (DRIVE_ATA|DRIVE_ATAPI) 45 1.2 bouyer #define DRIVE_CAP32 0x04 46 1.7 bouyer #define DRIVE_DMA 0x08 47 1.2 bouyer #define DRIVE_UDMA 0x10 48 1.3 bouyer #define DRIVE_MODE 0x20 /* the drive reported its mode */ 49 1.4 bouyer #define DRIVE_RESET 0x40 /* reset the drive state at next xfer */ 50 1.2 bouyer /* 51 1.2 bouyer * Current setting of drive's PIO, DMA and UDMA modes. 52 1.2 bouyer * Is initialised by the disks drivers at attach time, and may be 53 1.2 bouyer * changed later by the controller's code if needed 54 1.2 bouyer */ 55 1.2 bouyer u_int8_t PIO_mode; /* Current setting of drive's PIO mode */ 56 1.2 bouyer u_int8_t DMA_mode; /* Current setting of drive's DMA mode */ 57 1.2 bouyer u_int8_t UDMA_mode; /* Current setting of drive's UDMA mode */ 58 1.7 bouyer /* Supported modes for this drive */ 59 1.7 bouyer u_int8_t PIO_cap; /* supported drive's PIO mode */ 60 1.7 bouyer u_int8_t DMA_cap; /* supported drive's DMA mode */ 61 1.7 bouyer u_int8_t UDMA_cap; /* supported drive's UDMA mode */ 62 1.2 bouyer /* 63 1.2 bouyer * Drive state. This is drive-type (ATA or ATAPI) dependant 64 1.2 bouyer * This is reset to 0 after a channel reset. 65 1.2 bouyer */ 66 1.2 bouyer u_int8_t state; 67 1.2 bouyer 68 1.9 bouyer /* Number of DMA errors. reset to 0 after every successfull transferts */ 69 1.9 bouyer u_int8_t n_dmaerrs; 70 1.9 bouyer /* downgrade mode after this many successive errors */ 71 1.9 bouyer #define NERRS_MAX 2 72 1.9 bouyer 73 1.2 bouyer struct device *drv_softc; /* ATA drives softc, if any */ 74 1.2 bouyer void* chnl_softc; /* channel softc */ 75 1.2 bouyer }; 76 1.2 bouyer 77 1.2 bouyer /* ATA/ATAPI common attachement datas */ 78 1.2 bouyer struct ata_atapi_attach { 79 1.2 bouyer u_int8_t aa_type; /* Type of device */ 80 1.2 bouyer #define T_ATA 0 81 1.2 bouyer #define T_ATAPI 1 82 1.2 bouyer u_int8_t aa_channel; /* controller's channel */ 83 1.2 bouyer u_int8_t aa_openings; /* Number of simultaneous commands possible */ 84 1.2 bouyer struct ata_drive_datas *aa_drv_data; 85 1.2 bouyer void *aa_bus_private; /* infos specifics to this bus */ 86 1.2 bouyer }; 87 1.2 bouyer 88 1.7 bouyer /* User config flags that force (or disable) the use of a mode */ 89 1.7 bouyer #define ATA_CONFIG_PIO_MODES 0x0007 90 1.7 bouyer #define ATA_CONFIG_PIO_SET 0x0008 91 1.7 bouyer #define ATA_CONFIG_PIO_OFF 0 92 1.7 bouyer #define ATA_CONFIG_DMA_MODES 0x0070 93 1.7 bouyer #define ATA_CONFIG_DMA_SET 0x0080 94 1.7 bouyer #define ATA_CONFIG_DMA_DISABLE 0x0070 95 1.7 bouyer #define ATA_CONFIG_DMA_OFF 4 96 1.7 bouyer #define ATA_CONFIG_UDMA_MODES 0x0700 97 1.7 bouyer #define ATA_CONFIG_UDMA_SET 0x0800 98 1.7 bouyer #define ATA_CONFIG_UDMA_DISABLE 0x0700 99 1.7 bouyer #define ATA_CONFIG_UDMA_OFF 8 100 1.2 bouyer 101 1.2 bouyer /* 102 1.2 bouyer * ATA/ATAPI commands description 103 1.2 bouyer * 104 1.2 bouyer * This structure defines the interface between the ATA/ATAPI device driver 105 1.2 bouyer * and the controller for short commands. It contains the command's parameter, 106 1.2 bouyer * the len of data's to read/write (if any), and a function to call upon 107 1.2 bouyer * completion. 108 1.2 bouyer * If no sleep is allowed, the driver can poll for command completion. 109 1.2 bouyer * Once the command completed, if the error registed is valid, the flag 110 1.2 bouyer * AT_ERROR is set and the error register value is copied to r_error . 111 1.2 bouyer * A separate interface is needed for read/write or ATAPI packet commands 112 1.2 bouyer * (which need multiple interrupts per commands). 113 1.2 bouyer */ 114 1.2 bouyer struct wdc_command { 115 1.2 bouyer u_int8_t r_command; /* Parameters to upload to registers */ 116 1.2 bouyer u_int8_t r_head; 117 1.2 bouyer u_int16_t r_cyl; 118 1.2 bouyer u_int8_t r_sector; 119 1.2 bouyer u_int8_t r_count; 120 1.2 bouyer u_int8_t r_precomp; 121 1.2 bouyer u_int8_t r_st_bmask; /* status register mask to wait for before command */ 122 1.2 bouyer u_int8_t r_st_pmask; /* status register mask to wait for after command */ 123 1.2 bouyer u_int8_t r_error; /* error register after command done */ 124 1.2 bouyer volatile u_int16_t flags; 125 1.2 bouyer #define AT_READ 0x0001 /* There is data to read */ 126 1.2 bouyer #define AT_WRITE 0x0002 /* There is data to write (excl. with AT_READ) */ 127 1.2 bouyer #define AT_WAIT 0x0008 /* wait in controller code for command completion */ 128 1.2 bouyer #define AT_POLL 0x0010 /* poll for command completion (no interrupts) */ 129 1.2 bouyer #define AT_DONE 0x0020 /* command is done */ 130 1.2 bouyer #define AT_ERROR 0x0040 /* command is done with error */ 131 1.8 bouyer #define AT_TIMEOU 0x0080 /* command timed out */ 132 1.8 bouyer #define AT_DF 0x0100 /* Drive fault */ 133 1.8 bouyer #define AT_READREG 0x0200 /* Read registers on completion */ 134 1.2 bouyer int timeout; /* timeout (in ms) */ 135 1.2 bouyer void *data; /* Data buffer address */ 136 1.2 bouyer int bcount; /* number of bytes to transfer */ 137 1.2 bouyer void (*callback) __P((void*)); /* command to call once command completed */ 138 1.2 bouyer void *callback_arg; /* argument passed to *callback() */ 139 1.2 bouyer }; 140 1.2 bouyer 141 1.2 bouyer int wdc_exec_command __P((struct ata_drive_datas *, struct wdc_command*)); 142 1.2 bouyer #define WDC_COMPLETE 0x01 143 1.2 bouyer #define WDC_QUEUED 0x02 144 1.2 bouyer #define WDC_TRY_AGAIN 0x03 145 1.2 bouyer 146 1.2 bouyer void wdc_probe_caps __P((struct ata_drive_datas*)); 147 1.9 bouyer int wdc_downgrade_mode __P((struct ata_drive_datas*)); 148 1.2 bouyer 149 1.2 bouyer void wdc_reset_channel __P((struct ata_drive_datas *)); 150 1.5 thorpej 151 1.5 thorpej int wdc_ata_addref __P((struct ata_drive_datas *)); 152 1.5 thorpej void wdc_ata_delref __P((struct ata_drive_datas *)); 153 1.2 bouyer 154 1.2 bouyer struct ataparams; 155 1.2 bouyer int ata_get_params __P((struct ata_drive_datas*, u_int8_t, 156 1.2 bouyer struct ataparams *)); 157 1.2 bouyer int ata_set_mode __P((struct ata_drive_datas*, u_int8_t, u_int8_t)); 158 1.2 bouyer /* return code for these cmds */ 159 1.2 bouyer #define CMD_OK 0 160 1.2 bouyer #define CMD_ERR 1 161 1.2 bouyer #define CMD_AGAIN 2 162
Indexes created Sun Sep 28 12:09:53 GMT 2025