xref: /freebsd/sys/dev/fdc/fdcvar.h (revision ea825d02749f382c3f7e17f28247f20a48733eab)
1 /*-
2  * Copyright (c) 2004-2005 M. Warner Losh.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /* XXX should audit this file to see if additional copyrights needed */
30 
31 enum fdc_type {
32 	FDC_NE765, FDC_ENHANCED, FDC_UNKNOWN = -1
33 };
34 
35 /*
36  * Per controller structure (softc).
37  */
38 struct fdc_data {
39 	int	fdcu;		/* our unit number */
40 	int	dmachan;
41 	int	flags;
42 #define FDC_HASDMA	0x01
43 #define FDC_STAT_VALID	0x08
44 #define FDC_HAS_FIFO	0x10
45 #define FDC_NEEDS_RESET	0x20
46 #define FDC_NODMA	0x40	/* Don't do DMA */
47 #define FDC_NOFAST	0x80	/* Don't register isr as a fast one */
48 #define FDC_KTHREAD_EXIT	0x1000 /* request worker thread to stop */
49 #define FDC_KTHREAD_ALIVE	0x2000 /* worker thread is alive */
50 	struct	fd_data *fd;	/* The active drive */
51 	int	retry;
52 	int	fdout;		/* mirror of the w/o digital output reg */
53 	u_int	status[7];	/* copy of the registers */
54 	enum	fdc_type fdct;	/* chip version of FDC */
55 	int	fdc_errs;	/* number of logged errors */
56 	struct	bio_queue_head head;
57 	struct	bio *bp;	/* active buffer */
58 	struct	resource *res_irq, *res_drq;
59 	int	rid_irq, rid_drq;
60 #define FDC_MAXREG	8
61 	int	ridio[FDC_MAXREG];
62 	struct	resource *resio[FDC_MAXREG];
63 	bus_space_tag_t iot;
64 	bus_space_handle_t ioh[FDC_MAXREG];
65 	int	ioff[FDC_MAXREG];
66 	void	*fdc_intr;
67 	device_t fdc_dev;
68 	struct mtx fdc_mtx;
69 	struct proc *fdc_thread;
70 };
71 
72 extern devclass_t fdc_devclass;
73 
74 enum fdc_device_ivars {
75 	FDC_IVAR_FDUNIT,
76 	FDC_IVAR_FDTYPE,
77 };
78 
79 __BUS_ACCESSOR(fdc, fdunit, FDC, FDUNIT, int);
80 __BUS_ACCESSOR(fdc, fdtype, FDC, FDTYPE, int);
81 
82 void fdc_release_resources(struct fdc_data *);
83 int fdc_attach(device_t);
84 void fdc_start_worker(device_t);
85 int fdc_hints_probe(device_t);
86 int fdc_detach(device_t dev);
87 device_t fdc_add_child(device_t, const char *, int);
88 int fdc_initial_reset(device_t, struct fdc_data *);
89 int fdc_print_child(device_t, device_t);
90 int fdc_read_ivar(device_t, device_t, int, uintptr_t *);
91 int fdc_write_ivar(device_t, device_t, int, uintptr_t);
92 int fdc_isa_alloc_resources(device_t, struct fdc_data *);
93