cardinfo.h revision 65991 
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: head/sys/pccard/cardinfo.h 65991 2000-09-17 15:37:53Z sanpei $ */
32
33#ifndef	_PCCARD_CARDINFO_H_
34#define	_PCCARD_CARDINFO_H_
35
36#ifndef _KERNEL
37#include <sys/types.h>
38#endif
39#include <sys/ioccom.h>
40
41#define	PIOCGSTATE	_IOR('P', 1, struct slotstate)	/* Get slot state */
42#define	PIOCGMEM	_IOWR('P', 2, struct mem_desc)	/* Get memory map */
43#define	PIOCSMEM	_IOW('P', 3, struct mem_desc)	/* Set memory map */
44#define	PIOCGIO		_IOWR('P', 4, struct io_desc)	/* Get I/O map */
45#define	PIOCSIO		_IOW('P', 5, struct io_desc)	/* Set I/O map */
46#define PIOCSDRV	_IOWR('P', 6, struct dev_desc)	/* Set driver */
47#define PIOCRWFLAG	_IOW('P', 7, int)	/* Set flags for drv use */
48#define PIOCRWMEM	_IOWR('P', 8, unsigned long) /* Set mem for drv use */
49#define PIOCSPOW	_IOW('P', 9, struct power) /* Set power structure */
50#define PIOCSVIR	_IOW('P', 10, int)	/* Virtual insert/remove */
51#define PIOCSBEEP	_IOW('P', 11, int)		/* Select Beep */
52#define PIOCSRESOURCE	_IOWR('P', 12, struct pccard_resource)	/* get resource info */
53/*
54 *	Debug codes.
55 */
56#define PIOCGREG	_IOWR('P',100, struct pcic_reg)	/* get reg */
57#define PIOCSREG	_IOW('P', 101, struct pcic_reg)	/* Set reg */
58
59/*
60 *	Slot states for PIOCGSTATE
61 */
62enum cardstate { noslot, empty, suspend, filled, inactive };
63
64/*
65 *	Descriptor structure for memory map.
66 */
67struct mem_desc {
68	int	window;		/* Memory map window number (0-4) */
69	int	flags;		/* Flags - see below */
70	caddr_t	start;		/* System memory start */
71	int	size;		/* Size of memory area */
72	unsigned long card;	/* Card memory address */
73};
74
75#define	MDF_16BITS	0x01	/* Memory is 16 bits wide */
76#define	MDF_ZEROWS	0x02	/* Set no wait states for memory */
77#define	MDF_WS0		0x04	/* Wait state flags */
78#define	MDF_WS1		0x08
79#define	MDF_ATTR	0x10	/* Memory is attribute memory */
80#define	MDF_WP		0x20	/* Write protect memory */
81#define	MDF_ACTIVE	0x40	/* Context active (read-only) */
82
83/*
84 *	Descriptor structure for I/O map
85 */
86struct io_desc {
87	int	window;		/* I/O map number (0-1) */
88	int	flags;		/* Flags - see below */
89	int	start;		/* I/O port start */
90	int	size;		/* Number of port addresses */
91};
92
93#define	IODF_WS		0x01	/* Set wait states for 16 bit I/O access */
94#define	IODF_16BIT	0x02	/* I/O access are 16 bit */
95#define	IODF_CS16	0x04	/* Allow card selection of 16 bit access */
96#define	IODF_ZEROWS	0x08	/* No wait states for 8 bit I/O */
97#define	IODF_ACTIVE	0x10	/* Context active (read-only) */
98
99/*
100 *	Device descriptor for allocation of driver.
101 */
102struct dev_desc {
103	char	name[16];	/* Driver name */
104	int	unit;		/* Driver unit number */
105	unsigned long mem;	/* Memory address of driver */
106	int	memsize;	/* Memory size (if used) */
107	int	iobase;		/* base of I/O ports */
108	int	iosize;		/* Length of I/O ports */
109	int	irqmask;	/* Interrupt number(s) to allocate */
110	int	flags;		/* Device flags */
111	u_char	misc[128];	/* For any random info */
112};
113#define DEV_DESC_HAS_SIZE 1
114
115struct pcic_reg {
116	unsigned char reg;
117	unsigned char value;
118};
119
120/*
121 *	Slot information. Used to read current status of slot.
122 */
123struct slotstate {
124	enum cardstate state;		/* Current state of slot */
125	enum cardstate laststate;	/* Previous state of slot */
126	int	maxmem;			/* Max allowed memory windows */
127	int	maxio;			/* Max allowed I/O windows */
128	int	irqs;			/* Bitmap of IRQs allowed */
129	int	flags;			/* Capability flags */
130};
131
132/*
133 *	The power values are in volts * 10, e.g. 5V is 50, 3.3V is 33.
134 */
135struct power {
136	int	vcc;
137	int	vpp;
138};
139
140/*
141 *	Th PC-Card resource IOC_GET_RESOURCE_RANGE
142 */
143struct pccard_resource {
144	int		type;
145	u_long		size;
146	u_long		min;
147	u_long		max;
148	u_long		resource_addr;
149};
150
151
152/*
153 *	Other system limits
154 */
155#define MAXSLOT 16
156#define	NUM_MEM_WINDOWS	10
157#define	NUM_IO_WINDOWS	6
158#define	CARD_DEVICE	"/dev/card%d"		/* String for sprintf */
159
160#endif /* !_PCCARD_CARDINFO_H_ */
161