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