1/* 2 * PCMCIA card structures and defines. 3 * These defines relate to the user level 4 * structures and card information, not 5 * driver/process communication. 6 *------------------------------------------------------------------------- 7 */ 8/*- 9 * Copyright (c) 1995 Andrew McRae. All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 * 35 */ 36 37/* 38 * Card Information Structure tuples definitions 39 * The structure of a tuple is basically: 40 * 41 * Tuple_code 42 * Tuple_data_length 43 * Tuple_data ... 44 * 45 * Tuples are contiguous in attribute memory, and 46 * are terminated with a 0xFF for the tuple code or 47 * the tuple length. 48 */ 49#ifndef _PCCARD_CIS_H 50#define _PCCARD_CIS_H 51 52#define CIS_NULL 0 /* Empty tuple */ 53#define CIS_MEM_COMMON 0x01 /* Device descriptor, common memory */ 54#define CIS_LONGLINK_CB 0x02 /* Long link to next chain for CardBus */ 55#define CIS_INDIRECT 0x03 /* Indirect access */ 56#define CIS_CONF_MAP_CB 0x04 /* Card Configuration map for CardBus */ 57#define CIS_CONFIG_CB 0x05 /* Card Configuration entry for CardBus */ 58#define CIS_LONGLINK_MFC 0x06 /* Long link to next chain for Multi function card */ 59#define CIS_BAR 0x07 /* Base address register for CardBus */ 60#define CIS_CHECKSUM 0x10 /* Checksum */ 61#define CIS_LONGLINK_A 0x11 /* Link to Attribute memory */ 62#define CIS_LONGLINK_C 0x12 /* Link to Common memory */ 63#define CIS_LINKTARGET 0x13 /* Linked tuple must start with this. */ 64#define CIS_NOLINK 0x14 /* Assume no common memory link tuple. */ 65#define CIS_INFO_V1 0x15 /* Card info data, version 1 */ 66#define CIS_ALTSTR 0x16 /* Alternate language string tuple. */ 67#define CIS_MEM_ATTR 0x17 /* Device descriptor, Attribute memory */ 68#define CIS_JEDEC_C 0x18 /* JEDEC descr for common memory */ 69#define CIS_JEDEC_A 0x19 /* JEDEC descr for Attribute memory */ 70#define CIS_CONF_MAP 0x1A /* Card Configuration map */ 71#define CIS_CONFIG 0x1B /* Card Configuration entry */ 72#define CIS_DEVICE_OC 0x1C /* Other conditions info - common memory */ 73#define CIS_DEVICE_OA 0x1D /* Other conditions info - attribute memory */ 74#define CIS_DEVICEGEO 0x1E /* Geometry info for common memory */ 75#define CIS_DEVICEGEO_A 0x1F /* Geometry info for attribute memory */ 76#define CIS_MANUF_ID 0x20 /* Card manufacturer's ID */ 77#define CIS_FUNC_ID 0x21 /* Function of card */ 78#define CIS_FUNC_EXT 0x22 /* Functional extension */ 79/* 80 * Data recording format tuples. 81 */ 82#define CIS_SW_INTERLV 0x23 /* Software interleave */ 83#define CIS_VERS_2 0x40 /* Card info data, version 2 */ 84#define CIS_FORMAT 0x41 /* Memory card format */ 85#define CIS_GEOMETRY 0x42 /* Disk sector layout */ 86#define CIS_BYTEORDER 0x43 /* Byte order of memory data */ 87#define CIS_DATE 0x44 /* Format data/time */ 88#define CIS_BATTERY 0x45 /* Battery replacement date */ 89#define CIS_ORG 0x46 /* Organization of data on card */ 90#define CIS_END 0xFF /* Termination code */ 91 92/* 93 * Internal tuple definitions. 94 * 95 * Device descriptor for memory (CIS_MEM_ATTR, CIS_MEM_COMMON) 96 * 97 * Byte 1: 98 * 0xF0 - Device type 99 * 0x08 - Write protect switch 100 * 0x07 - Speed index (7 = extended speed) 101 * Byte 2: Extended speed (bit 7 = another follows) 102 * Byte 3: (ignored if 0xFF) 103 * 0xF8 - Addressable units (0's numbered) 104 * 0x07 - Unit size 105 * The three byte sequence is repeated until byte 1 == 0xFF 106 */ 107 108/* 109 * CIS_INFO_V1 - Version one card information. 110 * 111 * Byte 1: Major version number (should be 4) 112 * Byte 2: Minor version number (should be 1) 113 * Byte 3-x: Null terminated Manufacturer name 114 * Byte x-x: Null terminated product name 115 * Byte x-x: Null terminated additional info 1 116 * Byte x-x: Null terminated additional info 2 117 * Byte x: final byte must be 0xFF 118 */ 119#define CIS_MAJOR_VERSION 4 120#define CIS_MINOR_VERSION 1 121 122/* 123 * CIS_CONF_MAP - Provides an address map for the card 124 * configuration register(s), and a max value 125 * identifying the last configuration tuple. 126 * 127 * Byte 1: 128 * 0x3C - Register mask size (0's numbered) 129 * 0x03 - Register address size (0's numbered) 130 * Byte 2: 131 * 0x3F - ID of last configuration. 132 * Byte 3-n: Card register address (size is determined by 133 * the value in byte 1). 134 * Byte x-x: Card register masks (size determined by the 135 * value in byte 1) 136 */ 137 138/* 139 * CIS_CONFIG - Card configuration entry. Multiple tuples may 140 * exist of this type, each one describing a different 141 * memory/I-O map that can be used to address this card. 142 * The first one usually has extra config data about the 143 * card features. The final configuration tuple number 144 * is stored in the CIS_CONF_MAP tuple so that the complete 145 * list can be scanned. 146 * 147 * Byte 1: 148 * 0x3F - Configuration ID number. 149 * 0x40 - Indicates this is the default configuration 150 * 0x80 - Interface byte exists 151 * Byte 2: (exists only if bit 0x80 set in byte 1) 152 * 0x0F - Interface type value 153 * 0x10 - Battery voltage detect 154 * 0x20 - Write protect active 155 * 0x40 - RdyBsy active bit 156 * 0x80 - Wait signal required 157 * Byte 3: (features byte) 158 * 0x03 - Power sub-tuple(s) exists 159 * 0x04 - Timing sub-tuple exists 160 * 0x08 - I/O space sub-tuple exists 161 * 0x10 - IRQ sub-tuple exists 162 * 0x60 - Memory space sub-tuple(s) exists 163 * 0x80 - Miscellaneous sub-tuple exists 164 */ 165#define CIS_FEAT_POWER(x) ((x) & 0x3) 166#define CIS_FEAT_TIMING 0x4 167#define CIS_FEAT_I_O 0x8 168#define CIS_FEAT_IRQ 0x10 169#define CIS_FEAT_MEMORY(x) (((x) >> 5) & 0x3) 170#define CIS_FEAT_MISC 0x80 171/* 172 * Depending on whether the "features" byte has the corresponding 173 * bit set, a number of sub-tuples follow. Some features have 174 * more than one sub-tuple, depending on the count within the 175 * features byte (e.g power feature bits allows up to 3 sub-tuples). 176 * 177 * Power structure sub-tuple: 178 * Byte 1: parameter exists - Each bit (starting from 0x01) indicates 179 * that a parameter block exists - up to 8 parameter blocks 180 * are therefore allowed). 181 * Byte 2: 182 * 0x7F - Parameter data 183 * 0x80 - More bytes follow (0 = last byte) 184 * 185 * Timing sub-tuple 186 * Byte 1: 187 * 0x03 - Wait scale 188 * 0x1C - Ready scale 189 * 0xE0 - Reserved scale 190 * Byte 2: extended wait scale if wait scale != 3 191 * Byte 3: extended ready scale if ready scale != 7 192 * Byte 4: extended reserved scale if reserved scale != 7 193 */ 194#define CIS_WAIT_SCALE(x) ((x) & 0x3) 195#define CIS_READY_SCALE(x) (((x)>>2) & 0x7) 196#define CIS_RESERVED_SCALE(x) (((x)>>5) & 0x7) 197/* 198 * I/O mapping sub-tuple: 199 * Byte 1: 200 * 0x1F - I/O address lines 201 * 0x20 - 8 bit I/O 202 * 0x40 - 16 bit I/O 203 * 0x80 - I/O range?? 204 * Byte 2: 205 * 0x0F - 0's numbered count of I/O block subtuples following. 206 * 0x30 - Size of I/O address value within subtuple. Values 207 * can be 1 (8 bits), 2 (16 bits) or 3 (32 bits). 208 * 0xC0 - Size of I/O port block size value within subtuple. 209 * I/O block sub-tuples, count from previous block: 210 * Byte 1-n: I/O start address 211 * Byte x-x: Size of I/O port block. 212 */ 213#define CIS_IO_ADDR(x) ((x) & 0x1F) 214#define CIS_IO_8BIT 0x20 215#define CIS_IO_16BIT 0x40 216#define CIS_IO_RANGE 0x80 217#define CIS_IO_BLKS(x) ((x) & 0xF) 218#define CIS_IO_ADSZ(x) (((x)>>4) & 3) 219#define CIS_IO_BLKSZ(x) (((x)>>6) & 3) 220/* 221 * IRQ sub-tuple. 222 * Byte 1: 223 * 0x0F - Irq number or mask bits 224 * 0x10 - IRQ mask values exist 225 * 0x20 - Level triggered interrupts 226 * 0x40 - Pulse triggered requests 227 * 0x80 - Interrupt sharing. 228 * Byte 2-3: Interrupt req mask (if 0x10 of byte 1 set). 229 */ 230#define CIS_IRQ_IRQN(x) ((x) & 0xF) 231#define CIS_IRQ_MASK 0x10 232#define CIS_IRQ_LEVEL 0x20 233#define CIS_IRQ_PULSE 0x40 234#define CIS_IRQ_SHARING 0x80 235/* 236 * Memory block subtuple. Depending on the features bits, the 237 * following subtuples are used: 238 * mem features == 1 239 * Byte 1-2: upper 16 bits of 24 bit memory length. 240 * mem features == 2 241 * Byte 1-2: upper 16 bits of 24 bit memory length. 242 * Byte 3-4: upper 16 bits of 24 bit memory address. 243 * mem_features == 3 244 * Byte 1: 245 * 0x07 - 0's numbered count of memory sub-tuples 246 * 0x18 - Memory length size (1's numbered) 247 * 0x60 - Memory address size (1's numbered) 248 * 0x80 - Host address value exists 249 * Memory sub-tuples follow: 250 * Byte 1-n: Memory length value (<< 8) 251 * Byte n-n: Memory card address value (<< 8) 252 * Byte n-n: Memory host address value (<< 8) 253 */ 254#define CIS_FEAT_MEM_NONE 0 /* No memory config */ 255#define CIS_FEAT_MEM_LEN 1 /* Just length */ 256#define CIS_FEAT_MEM_ADDR 2 /* Card address & length */ 257#define CIS_FEAT_MEM_WIN 3 /* Multiple windows */ 258 259#define CIS_MEM_WINS(x) (((x) & 0x7)+1) 260#define CIS_MEM_LENSZ(x) (((x) >> 3) & 0x3) 261#define CIS_MEM_ADDRSZ(x) (((x) >> 5) & 0x3) 262#define CIS_MEM_HOST 0x80 263/* 264 * Misc sub-tuple. 265 * Byte 1: 266 * Byte 2: 267 * 0x0c - DMA Request Signal 268 * 00 - not support DMA 269 * 01 - use SPKR# line 270 * 10 - use IOIS16# line 271 * 11 - use INPACK# line 272 * 0x10 - DMA Width 273 * 0 - 8 bit DMA 274 * 1 - 16 bit DMA 275 */ 276#define CIS_MISC_DMA_WIDTH(x) (((x) & 0x10) >> 4) 277#define CIS_MISC_DMA_REQ(x) (((x) >> 2) & 0x3) 278 279#endif /* _PCCARD_CIS_H */ 280