Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / ic / dptvar.h
blob4a52e96fc88b09ee4509730aa91604f8e264718a
1 /* $NetBSD: dptvar.h,v 1.13 2005/12/11 12:21:26 christos Exp $ */
3 /*
4 * Copyright (c) 1999, 2000, 2001 Andrew Doran <ad@NetBSD.org>
5 * All rights reserved.
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.
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.
30 #ifndef _IC_DPTVAR_H_
31 #define _IC_DPTVAR_H_ 1
33 /* Software parameters */
34 #define DPT_SG_SIZE 17
35 #define DPT_MAX_XFER 65536
36 #define DPT_MAX_CCBS 256
37 #define DPT_ABORT_TIMEOUT 2000 /* milliseconds */
38 #define DPT_SCRATCH_SIZE 256 /* bytes */
40 #define CCB_OFF(sc,m) ((u_long)(m) - (u_long)((sc)->sc_ccbs))
42 #define CCB_ABORT 0x01 /* abort has been issued on this CCB */
43 #define CCB_INTR 0x02 /* HBA interrupted for this CCB */
44 #define CCB_PRIVATE 0x04 /* ours; don't talk to scsipi when done */
45 #define CCB_WAIT 0x08 /* sleeping on completion */
47 struct dpt_ccb {
48 /* Data that will be touched by the HBA */
49 struct eata_cp ccb_eata_cp; /* EATA command packet */
50 struct eata_sg ccb_sg[DPT_SG_SIZE]; /* SG element list */
51 struct scsi_sense_data ccb_sense; /* SCSI sense data on error */
53 /* Data that will not be touched by the HBA */
54 volatile int ccb_flg; /* CCB flags */
55 int ccb_timeout; /* timeout in ms */
56 u_int32_t ccb_ccbpa; /* physical addr of this CCB */
57 bus_dmamap_t ccb_dmamap_xfer; /* dmamap for data xfers */
58 int ccb_hba_status; /* from status packet */
59 int ccb_scsi_status; /* from status packet */
60 int ccb_id; /* unique ID of this CCB */
61 SLIST_ENTRY(dpt_ccb) ccb_chain; /* link to next CCB */
62 struct scsipi_xfer *ccb_xs; /* initiating SCSI command */
63 struct eata_sp *ccb_savesp; /* saved status packet */
66 struct dpt_softc {
67 struct device sc_dv; /* generic device data */
68 struct scsipi_adapter sc_adapt; /* scsipi adapter */
69 struct scsipi_channel sc_chans[3]; /* each channel */
70 bus_space_handle_t sc_ioh; /* bus space handle */
71 bus_space_tag_t sc_iot; /* bus space tag */
72 bus_dma_tag_t sc_dmat; /* bus DMA tag */
73 bus_dmamap_t sc_dmamap; /* maps the CCBs */
74 void *sc_ih; /* interrupt handler cookie */
75 struct dpt_ccb *sc_ccbs; /* all our CCBs */
76 struct eata_sp *sc_stp; /* EATA status packet */
77 int sc_stpoff; /* status packet offset in dmamap */
78 u_int32_t sc_stppa; /* status packet physical address */
79 void * sc_scr; /* scratch area */
80 int sc_scroff; /* scratch area offset in dmamap */
81 u_int32_t sc_scrpa; /* scratch area physical address */
82 int sc_hbaid[3]; /* ID of HBA on each channel */
83 int sc_nccbs; /* number of CCBs available */
84 SLIST_HEAD(, dpt_ccb) sc_ccb_free;/* free ccb list */
85 struct eata_cfg sc_ec; /* EATA configuration data */
86 int sc_uactive; /* user command active */
87 int sc_bustype; /* SysInfo bus type */
88 int sc_isadrq; /* ISA DRQ */
89 int sc_isairq; /* ISA IRQ */
90 int sc_isaport; /* ISA port */
93 void dpt_init(struct dpt_softc *, const char *);
94 int dpt_intr(void *);
95 int dpt_readcfg(struct dpt_softc *);
97 #endif /* !defined _IC_DPTVAR_H_ */