WARNS6 cleanups
[dragonfly.git] / sys / bus / pccard / cardinfo.h
1 /*
2  *      Include file for PCMCIA user process interface
3  *
4  *-------------------------------------------------------------------------
5  *
6  * Copyright (c) 1995 Andrew McRae.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 /* $FreeBSD: src/sys/pccard/cardinfo.h,v 1.16.2.6 2002/09/22 20:26:58 imp Exp $ */
32 /* $DragonFly: src/sys/bus/pccard/Attic/cardinfo.h,v 1.2 2003/06/17 04:28:55 dillon Exp $ */
33
34 #ifndef _PCCARD_CARDINFO_H_
35 #define _PCCARD_CARDINFO_H_
36
37 #ifndef _KERNEL
38 #include <sys/types.h>
39 #endif
40 #include <sys/ioccom.h>
41
42 #define PIOCGSTATE      _IOR('P', 1, struct slotstate)  /* Get slot state */
43 #define PIOCGMEM        _IOWR('P', 2, struct mem_desc)  /* Get memory map */
44 #define PIOCSMEM        _IOW('P', 3, struct mem_desc)   /* Set memory map */
45 #define PIOCGIO         _IOWR('P', 4, struct io_desc)   /* Get I/O map */
46 #define PIOCSIO         _IOW('P', 5, struct io_desc)    /* Set I/O map */
47 #define PIOCSDRV        _IOWR('P', 6, struct dev_desc)  /* Set driver */
48 #define PIOCRWFLAG      _IOW('P', 7, int)       /* Set flags for drv use */
49 #define PIOCRWMEM       _IOWR('P', 8, unsigned long) /* Set mem for drv use */
50 #define PIOCSPOW        _IOW('P', 9, struct power) /* Set power structure */
51 #define PIOCSVIR        _IOW('P', 10, int)      /* Virtual insert/remove */
52 #define PIOCSBEEP       _IOW('P', 11, int)              /* Select Beep */
53 #define PIOCSRESOURCE   _IOWR('P', 12, struct pccard_resource)  /* get resource info */
54 /*
55  *      Debug codes.
56  */
57 #define PIOCGREG        _IOWR('P',100, struct pcic_reg) /* get reg */
58 #define PIOCSREG        _IOW('P', 101, struct pcic_reg) /* Set reg */
59
60 /*
61  *      Slot states for PIOCGSTATE
62  *
63  *      Here's a state diagram of all the possible states:
64  *
65  *                             power x 1
66  *                       -------------------
67  *                      /                   \
68  *                     /                     v
69  *    resume    +----------+   power x 0   +----------+
70  *      ------->| inactive |<--------------| filled   |
71  *     /        +----------+               +----------+
72  *    /           /     \                   ^   |
73  *  nil <---------       \        insert or |   | suspend or
74  *        suspend         \       power x 1 |   | eject
75  *                         \                |   v
76  *                          \            +----------+
77  *                           ----------->|  empty   |
78  *                             eject     +----------+
79  *
80  *      Note, the above diagram is for the state.  On suspend, the laststate
81  * gets set to suspend to tell pccardd what happened.  Also the nil state
82  * means that when the no state change has happened.  Note: if you eject
83  * while suspended in the inactive state, you will return to the
84  * empty state if you do not insert a new card and to the inactive state
85  * if you do insert a new card.
86  *
87  * Some might argue that inactive should be sticky forever and
88  * eject/insert shouldn't take it out of that state.  They might be
89  * right.  On the other hand, some would argue that eject resets all
90  * state.  They might be right.  They both can't be right.  The above
91  * represents a reasonable compromise between the two.
92  *
93  * Some bridges allow one to query to see if the card was changed while
94  * we were suspended.  Others do not.  We make no use of this functionality
95  * at this time.
96  */
97 enum cardstate { noslot, empty, suspend, filled, inactive };
98
99 /*
100  *      Descriptor structure for memory map.
101  */
102 struct mem_desc {
103         int     window;         /* Memory map window number (0-4) */
104         int     flags;          /* Flags - see below */
105         caddr_t start;          /* System memory start */
106         int     size;           /* Size of memory area */
107         unsigned long card;     /* Card memory address */
108 };
109
110 #define MDF_16BITS      0x01    /* Memory is 16 bits wide */
111 #define MDF_ZEROWS      0x02    /* Set no wait states for memory */
112 #define MDF_WS0         0x04    /* Wait state flags */
113 #define MDF_WS1         0x08
114 #define MDF_ATTR        0x10    /* Memory is attribute memory */
115 #define MDF_WP          0x20    /* Write protect memory */
116 #define MDF_ACTIVE      0x40    /* Context active (read-only) */
117
118 /*
119  *      Descriptor structure for I/O map
120  */
121 struct io_desc {
122         int     window;         /* I/O map number (0-1) */
123         int     flags;          /* Flags - see below */
124         int     start;          /* I/O port start */
125         int     size;           /* Number of port addresses */
126 };
127
128 #define IODF_WS         0x01    /* Set wait states for 16 bit I/O access */
129 #define IODF_16BIT      0x02    /* I/O access are 16 bit */
130 #define IODF_CS16       0x04    /* Allow card selection of 16 bit access */
131 #define IODF_ZEROWS     0x08    /* No wait states for 8 bit I/O */
132 #define IODF_ACTIVE     0x10    /* Context active (read-only) */
133
134 /*
135  *      Device descriptor for allocation of driver.
136  */
137 #define DEV_MISC_LEN    36
138 #define DEV_MAX_CIS_LEN 40
139 struct dev_desc {
140         char            name[16];       /* Driver name */
141         int             unit;           /* Driver unit number */
142         unsigned long   mem;            /* Memory address of driver */
143         int             memsize;        /* Memory size (if used) */
144         int             iobase;         /* base of I/O ports */
145         int             iosize;         /* Length of I/O ports */
146         int             irqmask;        /* Interrupt number(s) to allocate */
147         int             flags;          /* Device flags */
148         uint8_t         misc[DEV_MISC_LEN]; /* For any random info */
149         uint8_t         manufstr[DEV_MAX_CIS_LEN];
150         uint8_t         versstr[DEV_MAX_CIS_LEN];
151         uint32_t        manufacturer;   /* Manufacturer ID */
152         uint32_t        product;        /* Product ID */
153         uint32_t        prodext;        /* Product ID (extended) */
154 };
155 #define DEV_DESC_HAS_SIZE 1
156
157 struct pcic_reg {
158         unsigned char reg;
159         unsigned char value;
160 };
161
162 /*
163  *      Slot information. Used to read current status of slot.
164  */
165 struct slotstate {
166         enum cardstate  state;          /* Current state of slot */
167         enum cardstate  laststate;      /* Previous state of slot */
168         int             maxmem;         /* Max allowed memory windows */
169         int             maxio;          /* Max allowed I/O windows */
170         int             irqs;           /* Bitmap of IRQs allowed */
171         int             flags;          /* Capability flags */
172 };
173
174 /*
175  *      The power values are in volts * 10, e.g. 5V is 50, 3.3V is 33.
176  */
177 struct power {
178         int             vcc;
179         int             vpp;
180 };
181
182 /*
183  *      The PC-Card resource IOC_GET_RESOURCE_RANGE
184  */
185 struct pccard_resource {
186         int             type;
187         u_long          size;
188         u_long          min;
189         u_long          max;
190         u_long          resource_addr;
191 };
192
193
194 /*
195  *      Other system limits
196  */
197 #define MAXSLOT 16
198 #define NUM_MEM_WINDOWS 10
199 #define NUM_IO_WINDOWS  6
200 #define CARD_DEVICE     "/dev/card%d"           /* String for snprintf */
201 #define PCCARD_MEMSIZE  (4*1024)
202
203 #endif /* !_PCCARD_CARDINFO_H_ */