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