xref: /netbsd/sys/dev/ldvar.h (revision 88181ca0)
1 /*	$NetBSD: ldvar.h,v 1.35 2021/05/30 11:24:02 riastradh Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef	_DEV_LDVAR_H_
33 #define	_DEV_LDVAR_H_
34 
35 #include <sys/mutex.h>
36 #include <sys/rndsource.h>
37 
38 #include <dev/dkvar.h> /* for dk_softc */
39 
40 struct ld_softc {
41 	struct dk_softc	sc_dksc;
42 	kmutex_t	sc_mutex;
43 	kcondvar_t	sc_drain;
44 
45 	int		sc_queuecnt;	/* current h/w queue depth */
46 	int		sc_ncylinders;	/* # cylinders */
47 	int		sc_nheads;	/* # heads */
48 	int		sc_nsectors;	/* # sectors per track */
49 	uint64_t	sc_disksize512;
50 
51 	/*
52 	 * The following are filled by hardware specific attachment code.
53 	 */
54 	device_t	sc_dv;
55 	int		sc_flags;	/* control flags */
56 	uint64_t	sc_secperunit;	/* # sectors in total */
57 	int		sc_secsize;	/* sector size in bytes */
58 	int		sc_maxxfer;	/* max xfer size in bytes */
59 	int		sc_maxqueuecnt;	/* maximum h/w queue depth */
60 	char		*sc_typename;	/* inquiry data */
61 
62 	int		(*sc_dump)(struct ld_softc *, void *, int, int);
63 	int		(*sc_ioctl)(struct ld_softc *, u_long, void *, int32_t, bool);
64 	int		(*sc_start)(struct ld_softc *, struct buf *);
65 	int		(*sc_discard)(struct ld_softc *, struct buf *);
66 };
67 
68 /* sc_flags */
69 #define	LDF_ENABLED	0x001		/* device enabled */
70 #define	LDF_UNUSED0	0x020		/* was LDF_DRAIN */
71 #define	LDF_NO_RND	0x040		/* do not attach rnd source */
72 #define	LDF_MPSAFE	0x080		/* backend is MPSAFE */
73 #define	LDF_SUSPEND	0x100		/* disk is suspended until resume */
74 
75 int	ldadjqparam(struct ld_softc *, int);
76 void	ldattach(struct ld_softc *, const char *);
77 int	ldbegindetach(struct ld_softc *, int);
78 void	ldenddetach(struct ld_softc *);
79 void	lddone(struct ld_softc *, struct buf *);
80 void	lddiscardend(struct ld_softc *, struct buf *);
81 
82 #endif	/* !_DEV_LDVAR_H_ */
83