xref: /freebsd/sys/dev/cardbus/cardbusreg.h (revision 2a4a1db342263067035ce69a4017c645da63455d)
1 /*
2  * Copyright (c) 2000,2001 Jonathan Chen.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions, and the following disclaimer,
10  *    without modification, immediately at the beginning of the file.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
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 FOR
20  * 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.
27  *
28  * $FreeBSD$
29  */
30 
31 /*
32  * Register definitions for the Cardbus Bus
33  */
34 
35 
36 /* Cardbus bus constants */
37 #define	CARDBUS_SLOTMAX		0
38 #define	CARDBUS_FUNCMAX		7
39 
40 /* Cardbus configuration header registers */
41 #define	CARDBUS_BASE0_REG	0x10
42 #define	CARDBUS_BASE1_REG	0x14
43 #define	CARDBUS_BASE2_REG	0x18
44 #define	CARDBUS_BASE3_REG	0x1C
45 #define	CARDBUS_BASE4_REG	0x20
46 #define	CARDBUS_BASE5_REG	0x24
47 #define	CARDBUS_CIS_REG		0x28
48 # define	CARDBUS_CIS_ASIMASK		0x07
49 # define	CARDBUS_CIS_ADDRMASK		0x0ffffff8
50 # define	CARDBUS_CIS_ASI_TUPLE		0x00
51 # define	CARDBUS_CIS_ASI_BAR0		0x01
52 # define	CARDBUS_CIS_ASI_BAR1		0x02
53 # define	CARDBUS_CIS_ASI_BAR2		0x03
54 # define	CARDBUS_CIS_ASI_BAR3		0x04
55 # define	CARDBUS_CIS_ASI_BAR4		0x05
56 # define	CARDBUS_CIS_ASI_BAR5		0x06
57 # define	CARDBUS_CIS_ASI_ROM		0x07
58 #define	CARDBUS_ROM_REG		0x30
59 # define	CARDBUS_ROM_ENABLE		0x00000001
60 # define	CARDBUS_ROM_ADDRMASK		0xfffff800
61 
62 /* EXROM offsets for reading CIS */
63 #define	CARDBUS_EXROM_SIGNATURE	0x00
64 #define	CARDBUS_EXROM_DATA_PTR	0x18
65 
66 #define	CARDBUS_EXROM_DATA_SIGNATURE	0x00 /* Signature ("PCIR") */
67 #define	CARDBUS_EXROM_DATA_VENDOR_ID	0x04 /* Vendor Identification */
68 #define	CARDBUS_EXROM_DATA_DEVICE_ID	0x06 /* Device Identification */
69 #define	CARDBUS_EXROM_DATA_LENGTH	0x0a /* PCI Data Structure Length */
70 #define	CARDBUS_EXROM_DATA_REV		0x0c /* PCI Data Structure Revision */
71 #define	CARDBUS_EXROM_DATA_CLASS_CODE	0x0d /* Class Code */
72 #define	CARDBUS_EXROM_DATA_IMAGE_LENGTH	0x10 /* Image Length */
73 #define	CARDBUS_EXROM_DATA_DATA_REV	0x12 /* Revision Level of Code/Data */
74 #define	CARDBUS_EXROM_DATA_CODE_TYPE	0x14 /* Code Type */
75 #define	CARDBUS_EXROM_DATA_INDICATOR	0x15 /* Indicator */
76 
77 /* useful macros */
78 #define	CARDBUS_CIS_ADDR(x)						\
79 	(CARDBUS_CIS_ADDRMASK & (x))
80 #define	CARDBUS_CIS_SPACE(x)						\
81 	(CARDBUS_CIS_ASIMASK & (x))
82 #define	CARDBUS_CIS_ASI_BAR(x)						\
83 	(((CARDBUS_CIS_ASIMASK & (x))-1)*4+0x10)
84 #define	CARDBUS_CIS_ASI_ROM_IMAGE(x)					\
85 	(((x) >> 28) & 0xf)
86 
87 #define	CARDBUS_MAPREG_MEM_ADDR_MASK	0x0ffffff0
88 #define	CARDBUS_MAPREG_MEM_ADDR(mr)					\
89 	((mr) & CARDBUS_MAPREG_MEM_ADDR_MASK)
90 #define	CARDBUS_MAPREG_MEM_SIZE(mr)					\
91 	(CARDBUS_MAPREG_MEM_ADDR(mr) & -CARDBUS_MAPREG_MEM_ADDR(mr))
92