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