/*-
 * Copyright (c) 1990 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      from:   @(#)fd.c        7.4 (Berkeley) 5/25/91
 * $FreeBSD: src/sys/isa/fdc.h,v 1.20.2.3 2002/02/03 14:08:46 nyan Exp $
 *
 */

enum fdc_type
{
        FDC_NE765, FDC_I82077, FDC_NE72065, FDC_UNKNOWN = -1
};


/***********************************************************************\
* Per controller structure.                                             *
\***********************************************************************/
struct fdc_data
{
        int     fdcu;           /* our unit number */
        int     dmachan;
        int     flags;
#define FDC_ATTACHED    0x01
#define FDC_STAT_VALID  0x08
#define FDC_HAS_FIFO    0x10
#define FDC_NEEDS_RESET 0x20
#define FDC_NODMA       0x40
#define FDC_ISPNP       0x80
#define FDC_ISPCMCIA    0x100
        struct  fd_data *fd;
        int     fdu;            /* the active drive     */
        int     state;
        int     retry;
        int     fdout;          /* mirror of the w/o digital output reg */
        u_int   status[7];      /* copy of the registers */
        enum    fdc_type fdct;  /* chip version of FDC */
        int     fdc_errs;       /* number of logged errors */
        struct  bio_queue_head bio_queue;
        struct  bio *bio;       /* active buffer */
        int     dma_overruns;   /* number of DMA overruns */
        struct  resource *res_ioport, *res_ctl, *res_irq, *res_drq;
        int     rid_ioport, rid_ctl, rid_irq, rid_drq;
        int     port_off;
        bus_space_tag_t portt;
        bus_space_handle_t porth;
        bus_space_tag_t ctlt;
        bus_space_handle_t ctlh;
        void    *fdc_intr;
        device_t fdc_dev;
        struct  callout pseudointr_ch;
        void    (*fdctl_wr)(struct fdc_data *fdc, u_int8_t v);
};

/***********************************************************************\
* Throughout this file the following conventions will be used:          *
* fd is a pointer to the fd_data struct for the drive in question       *
* fdc is a pointer to the fdc_data struct for the controller            *
* fdu is the floppy drive unit number                                   *
* fdcu is the floppy controller unit number                             *
* fdsu is the floppy drive unit number on that controller. (sub-unit)   *
\***********************************************************************/
typedef int     fdu_t;
typedef int     fdcu_t;
typedef int     fdsu_t;
typedef struct fd_data *fd_p;
typedef struct fdc_data *fdc_p;
typedef enum fdc_type fdc_t;

/*
 * fdc maintains a set (1!) of ivars per child of each controller.
 */
enum fdc_device_ivars {
        FDC_IVAR_FDUNIT,
};

/*
 * Simple access macros for the ivars.
 */
#define FDC_ACCESSOR(A, B, T)                                           \
static __inline T fdc_get_ ## A(device_t dev)                           \
{                                                                       \
        uintptr_t v;                                                    \
        BUS_READ_IVAR(device_get_parent(dev), dev, FDC_IVAR_ ## B, &v); \
        return (T) v;                                                   \
}
FDC_ACCESSOR(fdunit, FDUNIT, int)

int     fdc_alloc_resources(struct fdc_data *fdc);
void    fdc_release_resources(struct fdc_data *fdc);
int     fdc_attach(device_t dev);
int     fdc_print_child(device_t me, device_t child);
int     fdc_read_ivar(device_t dev, device_t child, int which, u_long *result);
void    fdout_wr(fdc_p fdc, u_int8_t v);
int     fd_cmd(struct fdc_data *fdc, int n_out, ...);

extern  devclass_t fdc_devclass;