atavar.h revision 1.2 1 /* $NetBSD: atavar.h,v 1.2 1998/10/12 16:09:15 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 u_int8_t drive_flags; /* bitmask for drives present/absent and cap */
42 #define DRIVE_ATA 0x01
43 #define DRIVE_ATAPI 0x02
44 #define DRIVE (DRIVE_ATA|DRIVE_ATAPI)
45 #define DRIVE_CAP32 0x04
46 #define DRIVE_DMA 0x08
47 #define DRIVE_UDMA 0x10
48 /*
49 * Current setting of drive's PIO, DMA and UDMA modes.
50 * Is initialised by the disks drivers at attach time, and may be
51 * changed later by the controller's code if needed
52 */
53 u_int8_t PIO_mode; /* Current setting of drive's PIO mode */
54 u_int8_t DMA_mode; /* Current setting of drive's DMA mode */
55 u_int8_t UDMA_mode; /* Current setting of drive's UDMA mode */
56 /*
57 * Drive state. This is drive-type (ATA or ATAPI) dependant
58 * This is reset to 0 after a channel reset.
59 */
60 u_int8_t state;
61
62 struct device *drv_softc; /* ATA drives softc, if any */
63 void* chnl_softc; /* channel softc */
64 };
65
66 /* ATA/ATAPI common attachement datas */
67 struct ata_atapi_attach {
68 u_int8_t aa_type; /* Type of device */
69 #define T_ATA 0
70 #define T_ATAPI 1
71 u_int8_t aa_channel; /* controller's channel */
72 u_int8_t aa_openings; /* Number of simultaneous commands possible */
73 struct ata_drive_datas *aa_drv_data;
74 void *aa_bus_private; /* infos specifics to this bus */
75 };
76
77
78
79
80 /*
81 * ATA/ATAPI commands description
82 *
83 * This structure defines the interface between the ATA/ATAPI device driver
84 * and the controller for short commands. It contains the command's parameter,
85 * the len of data's to read/write (if any), and a function to call upon
86 * completion.
87 * If no sleep is allowed, the driver can poll for command completion.
88 * Once the command completed, if the error registed is valid, the flag
89 * AT_ERROR is set and the error register value is copied to r_error .
90 * A separate interface is needed for read/write or ATAPI packet commands
91 * (which need multiple interrupts per commands).
92 */
93 struct wdc_command {
94 u_int8_t r_command; /* Parameters to upload to registers */
95 u_int8_t r_head;
96 u_int16_t r_cyl;
97 u_int8_t r_sector;
98 u_int8_t r_count;
99 u_int8_t r_precomp;
100 u_int8_t r_st_bmask; /* status register mask to wait for before command */
101 u_int8_t r_st_pmask; /* status register mask to wait for after command */
102 u_int8_t r_error; /* error register after command done */
103 volatile u_int16_t flags;
104 #define AT_READ 0x0001 /* There is data to read */
105 #define AT_WRITE 0x0002 /* There is data to write (excl. with AT_READ) */
106 #define AT_WAIT 0x0008 /* wait in controller code for command completion */
107 #define AT_POLL 0x0010 /* poll for command completion (no interrupts) */
108 #define AT_DONE 0x0020 /* command is done */
109 #define AT_ERROR 0x0040 /* command is done with error */
110 #define AT_TIMEOU 0x0040 /* command timed out */
111 #define AT_DF 0x0080 /* Drive fault */
112 int timeout; /* timeout (in ms) */
113 void *data; /* Data buffer address */
114 int bcount; /* number of bytes to transfer */
115 void (*callback) __P((void*)); /* command to call once command completed */
116 void *callback_arg; /* argument passed to *callback() */
117 };
118
119 int wdc_exec_command __P((struct ata_drive_datas *, struct wdc_command*));
120 #define WDC_COMPLETE 0x01
121 #define WDC_QUEUED 0x02
122 #define WDC_TRY_AGAIN 0x03
123
124 void wdc_probe_caps __P((struct ata_drive_datas*));
125
126 void wdc_reset_channel __P((struct ata_drive_datas *));
127
128 struct ataparams;
129 int ata_get_params __P((struct ata_drive_datas*, u_int8_t,
130 struct ataparams *));
131 int ata_set_mode __P((struct ata_drive_datas*, u_int8_t, u_int8_t));
132 /* return code for these cmds */
133 #define CMD_OK 0
134 #define CMD_ERR 1
135 #define CMD_AGAIN 2
136