Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / ldvar.h
blob030553fc71b613197ed2f623bd81876ab8dada38
1 /* $NetBSD: ldvar.h,v 1.16 2009/05/07 08:03:23 cegger Exp $ */
3 /*-
4 * Copyright (c) 2000 The NetBSD Foundation, Inc.
5 * All rights reserved.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Andrew Doran.
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.
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.
32 #ifndef _DEV_LDVAR_H_
33 #define _DEV_LDVAR_H_
35 #include "rnd.h"
37 #include <sys/mutex.h>
38 #include <sys/device.h> /* for device_t */
39 #if NRND > 0
40 #include <sys/rnd.h>
41 #endif
43 struct ld_softc {
44 device_t sc_dv;
45 struct disk sc_dk;
46 struct bufq_state *sc_bufq;
47 kmutex_t sc_mutex;
48 #if NRND > 0
49 rndsource_element_t sc_rnd_source;
50 #endif
51 int sc_queuecnt; /* current h/w queue depth */
52 int sc_ncylinders; /* # cylinders */
53 int sc_nheads; /* # heads */
54 int sc_nsectors; /* # sectors per track */
57 * The following are filled by hardware specific attachment code.
59 int sc_flags; /* control flags */
60 uint64_t sc_secperunit; /* # sectors in total */
61 int sc_secsize; /* sector size in bytes */
62 int sc_maxxfer; /* max xfer size in bytes */
63 int sc_maxqueuecnt; /* maximum h/w queue depth */
65 int (*sc_dump)(struct ld_softc *, void *, int, int);
66 int (*sc_flush)(struct ld_softc *, int);
67 int (*sc_start)(struct ld_softc *, struct buf *);
70 /* sc_flags */
71 #define LDF_ENABLED 0x001 /* device enabled */
72 #define LDF_WLABEL 0x008 /* label is writable */
73 #define LDF_LABELLING 0x010 /* writing label */
74 #define LDF_DRAIN 0x020 /* maxqueuecnt has changed; drain */
75 #define LDF_DETACH 0x040 /* detach pending */
76 #define LDF_KLABEL 0x080 /* keep label on close */
77 #define LDF_VLABEL 0x100 /* label is valid */
79 /* sc_flush() flags */
80 #define LDFL_POLL 0x001 /* poll for completion */
82 int ldadjqparam(struct ld_softc *, int);
83 void ldattach(struct ld_softc *);
84 int ldbegindetach(struct ld_softc *, int);
85 void ldenddetach(struct ld_softc *);
86 void lddone(struct ld_softc *, struct buf *);
88 #endif /* !_DEV_LDVAR_H_ */