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