fdcvar.h revision 132048 
1/*
2 * Copyright (c) 2004 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 *    without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in
13 *    the documentation and/or other materials provided with the
14 *    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 FOR
20 * 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: head/sys/dev/fdc/fdcvar.h 132048 2004-07-12 20:49:26Z njl $
29 */
30
31/* XXX should audit this file to see if additional copyrights needed */
32
33enum fdc_type
34{
35	FDC_NE765, FDC_ENHANCED, FDC_UNKNOWN = -1
36};
37
38enum fdc_states {
39	DEVIDLE,
40	FINDWORK,
41	DOSEEK,
42	SEEKCOMPLETE ,
43	IOCOMPLETE,
44	RECALCOMPLETE,
45	STARTRECAL,
46	RESETCTLR,
47	SEEKWAIT,
48	RECALWAIT,
49	MOTORWAIT,
50	IOTIMEDOUT,
51	RESETCOMPLETE,
52	PIOREAD
53};
54
55#ifdef	FDC_DEBUG
56static char const * const fdstates[] = {
57	"DEVIDLE",
58	"FINDWORK",
59	"DOSEEK",
60	"SEEKCOMPLETE",
61	"IOCOMPLETE",
62	"RECALCOMPLETE",
63	"STARTRECAL",
64	"RESETCTLR",
65	"SEEKWAIT",
66	"RECALWAIT",
67	"MOTORWAIT",
68	"IOTIMEDOUT",
69	"RESETCOMPLETE",
70	"PIOREAD"
71};
72#endif
73
74/*
75 * Per controller structure (softc).
76 */
77struct fdc_data
78{
79	int	fdcu;		/* our unit number */
80	int	dmacnt;
81	int	dmachan;
82	int	flags;
83#define FDC_ATTACHED	0x01
84#define FDC_STAT_VALID	0x08
85#define FDC_HAS_FIFO	0x10
86#define FDC_NEEDS_RESET	0x20
87#define FDC_NODMA	0x40
88#define FDC_ISPNP	0x80
89#define FDC_ISPCMCIA	0x100
90	struct	fd_data *fd;
91	int	fdu;		/* the active drive	*/
92	enum	fdc_states state;
93	int	retry;
94	int	fdout;		/* mirror of the w/o digital output reg */
95	u_int	status[7];	/* copy of the registers */
96	enum	fdc_type fdct;	/* chip version of FDC */
97	int	fdc_errs;	/* number of logged errors */
98	int	dma_overruns;	/* number of DMA overruns */
99	struct	bio_queue_head head;
100	struct	bio *bp;	/* active buffer */
101	struct	resource *res_ioport, *res_ctl, *res_irq, *res_drq;
102	int	rid_ioport, rid_ctl, rid_irq, rid_drq;
103	int	port_off;
104	bus_space_tag_t portt;
105	bus_space_handle_t porth;
106	bus_space_tag_t ctlt;
107	bus_space_handle_t ctlh;
108	void	*fdc_intr;
109	struct	device *fdc_dev;
110	void	(*fdctl_wr)(struct fdc_data *fdc, u_int8_t v);
111};
112
113typedef int	fdu_t;
114typedef int	fdcu_t;
115typedef int	fdsu_t;
116typedef	struct fd_data *fd_p;
117typedef struct fdc_data *fdc_p;
118typedef enum fdc_type fdc_t;
119
120/* error returns for fd_cmd() */
121#define FD_FAILED -1
122#define FD_NOT_VALID -2
123#define FDC_ERRMAX	100	/* do not log more */
124
125extern devclass_t fdc_devclass;
126
127enum fdc_device_ivars {
128	FDC_IVAR_FDUNIT,
129	FDC_IVAR_FDTYPE,
130};
131
132__BUS_ACCESSOR(fdc, fdunit, FDC, FDUNIT, int);
133__BUS_ACCESSOR(fdc, fdtype, FDC, FDTYPE, int);
134
135int fdc_alloc_resources(struct fdc_data *);
136void fdout_wr(fdc_p, u_int8_t);
137int fd_cmd(struct fdc_data *, int, ...);
138void fdc_release_resources(struct fdc_data *);
139int fdc_attach(device_t);
140int fdc_detach(device_t dev);
141int fdc_initial_reset(struct fdc_data *);
142int fdc_print_child(device_t, device_t);
143int fdc_read_ivar(device_t, device_t, int, uintptr_t *);
144int fdc_write_ivar(device_t, device_t, int, uintptr_t);
145