Sync with trunk (r48545)
[reactos.git] / include / psdk / winsmcrd.h
1 /*
2 * WinSmCrd.h
3 *
4 * SmartCard IOCTLs
5 *
6 * THIS SOFTWARE IS NOT COPYRIGHTED
7 *
8 * This source code is offered for use in the public domain. You may
9 * use, modify or distribute it freely.
10 *
11 * This code is distributed in the hope that it will be useful but
12 * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
13 * DISCLAIMED. This includes but is not limited to warranties of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 *
16 */
17
18 #ifndef __WINSMCRD_H
19 #define __WINSMCRD_H
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 #ifdef _MSC_VER
26 #pragma warning(push)
27 #pragma warning(disable:4820)
28 #endif
29
30 typedef struct _SCARD_IO_REQUEST
31 {
32 DWORD dwProtocol;
33 DWORD cbPciLength;
34 } SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
35 typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
36
37 typedef struct _SCARD_T0_COMMAND
38 {
39 BYTE bCla;
40 BYTE bIns;
41 BYTE P1;
42 BYTE P2;
43 BYTE P3;
44 } SCARD_T0_COMMAND, *PSCARD_T0_COMMAND, *LPSCARD_T0_COMMAND;
45
46 typedef struct _SCARD_T0_REQUEST
47 {
48 SCARD_IO_REQUEST ioRequest;
49 BYTE bSw1;
50 BYTE bSw2;
51 union
52 {
53 SCARD_T0_COMMAND CmdBytes;
54 BYTE rgbHeader[5];
55 } u;
56 } SCARD_T0_REQUEST, *PSCARD_T0_REQUEST, *LPSCARD_T0_REQUEST;
57
58 typedef struct _SCARD_T1_REQUEST
59 {
60 SCARD_IO_REQUEST ioRequest;
61 } SCARD_T1_REQUEST, *PSCARD_T1_REQUEST, *LPSCARD_T1_REQUEST;
62
63 #define FILE_DEVICE_SMARTCARD 49
64
65 #define SCARD_ATR_LENGTH (0x21)
66
67 #define SCARD_PROTOCOL_UNDEFINED (0x00000)
68 #define SCARD_PROTOCOL_T0 (0x00001)
69 #define SCARD_PROTOCOL_T1 (0x00002)
70 #define SCARD_PROTOCOL_RAW (0x10000)
71
72 #define SCARD_PROTOCOL_Tx (SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1)
73
74 #define SCARD_PROTOCOL_DEFAULT (0x80000000)
75 #define SCARD_PROTOCOL_OPTIMAL (0x00000000)
76
77 #define SCARD_T0_HEADER_LENGTH (0x7)
78 #define SCARD_T0_CMD_LENGTH (0x5)
79
80 #define SCARD_T1_PROLOGUE_LENGTH (0x03)
81 #define SCARD_T1_EPILOGUE_LENGTH (0x02)
82 #define SCARD_T1_MAX_IFS (0xFE)
83
84 #define SCARD_POWER_DOWN (0x0)
85 #define SCARD_COLD_RESET (0x1)
86 #define SCARD_WARM_RESET (0x2)
87
88 #define SCARD_UNKNOWN (0x0)
89 #define SCARD_ABSENT (0x1)
90 #define SCARD_PRESENT (0x2)
91 #define SCARD_SWALLOWED (0x3)
92 #define SCARD_POWERED (0x4)
93 #define SCARD_NEGOTIABLE (0x5)
94 #define SCARD_SPECIFIC (0x6)
95
96 #define IOCTL_SMARTCARD_POWER CTL_CODE(FILE_DEVICE_SMARTCARD, 1, METHOD_BUFFERED, FILE_ANY_ACCESS)
97 #define IOCTL_SMARTCARD_GET_ATTRIBUTE CTL_CODE(FILE_DEVICE_SMARTCARD, 2, METHOD_BUFFERED, FILE_ANY_ACCESS)
98 #define IOCTL_SMARTCARD_SET_ATTRIBUTE CTL_CODE(FILE_DEVICE_SMARTCARD, 3, METHOD_BUFFERED, FILE_ANY_ACCESS)
99 #define IOCTL_SMARTCARD_CONFISCATE CTL_CODE(FILE_DEVICE_SMARTCARD, 4, METHOD_BUFFERED, FILE_ANY_ACCESS)
100 #define IOCTL_SMARTCARD_TRANSMIT CTL_CODE(FILE_DEVICE_SMARTCARD, 5, METHOD_BUFFERED, FILE_ANY_ACCESS)
101 #define IOCTL_SMARTCARD_EJECT CTL_CODE(FILE_DEVICE_SMARTCARD, 6, METHOD_BUFFERED, FILE_ANY_ACCESS)
102 #define IOCTL_SMARTCARD_SWALLOW CTL_CODE(FILE_DEVICE_SMARTCARD, 7, METHOD_BUFFERED, FILE_ANY_ACCESS)
103 #define IOCTL_SMARTCARD_READ CTL_CODE(FILE_DEVICE_SMARTCARD, 8, METHOD_BUFFERED, FILE_ANY_ACCESS)
104 #define IOCTL_SMARTCARD_WRITE CTL_CODE(FILE_DEVICE_SMARTCARD, 9, METHOD_BUFFERED, FILE_ANY_ACCESS)
105 #define IOCTL_SMARTCARD_IS_PRESENT CTL_CODE(FILE_DEVICE_SMARTCARD, 10, METHOD_BUFFERED, FILE_ANY_ACCESS)
106 #define IOCTL_SMARTCARD_IS_ABSENT CTL_CODE(FILE_DEVICE_SMARTCARD, 11, METHOD_BUFFERED, FILE_ANY_ACCESS)
107 #define IOCTL_SMARTCARD_SET_PROTOCOL CTL_CODE(FILE_DEVICE_SMARTCARD, 12, METHOD_BUFFERED, FILE_ANY_ACCESS)
108 #define IOCTL_SMARTCARD_GET_STATE CTL_CODE(FILE_DEVICE_SMARTCARD, 14, METHOD_BUFFERED, FILE_ANY_ACCESS)
109 #define IOCTL_SMARTCARD_GET_LAST_ERROR CTL_CODE(FILE_DEVICE_SMARTCARD, 15, METHOD_BUFFERED, FILE_ANY_ACCESS)
110 #define IOCTL_SMARTCARD_GET_PERF_CNTR CTL_CODE(FILE_DEVICE_SMARTCARD, 16, METHOD_BUFFERED, FILE_ANY_ACCESS)
111
112 #define MAXIMUM_ATTR_STRING_LENGTH (0x10)
113 #define MAXIMUM_SMARTCARD_READERS (0x0A)
114
115 #define SCARD_CLASS_VENDOR_INFO (0x0001)
116 #define SCARD_CLASS_COMMUNICATIONS (0x0002)
117 #define SCARD_CLASS_PROTOCOL (0x0003)
118 #define SCARD_CLASS_POWER_MGMT (0x0004)
119 #define SCARD_CLASS_SECURITY (0x0005)
120 #define SCARD_CLASS_MECHANICAL (0x0006)
121 #define SCARD_CLASS_VENDOR_DEFINED (0x0007)
122 #define SCARD_CLASS_IFD_PROTOCOL (0x0008)
123 #define SCARD_CLASS_ICC_STATE (0x0009)
124 #define SCARD_CLASS_PERF (0x7FFE)
125 #define SCARD_CLASS_SYSTEM (0x7FFF)
126
127 #define SCARD_READER_TYPE_VENDOR (0xF0)
128
129 #define SCARD_READER_TYPE_SERIAL (0x01)
130 #define SCARD_READER_TYPE_PARALELL (0x02)
131 #define SCARD_READER_TYPE_KEYBOARD (0x04)
132 #define SCARD_READER_TYPE_SCSI (0x08)
133 #define SCARD_READER_TYPE_IDE (0x10)
134 #define SCARD_READER_TYPE_USB (0x20)
135 #define SCARD_READER_TYPE_PCMCIA (0x40)
136
137 #define SCARD_READER_SWALLOWS (0x1)
138 #define SCARD_READER_EJECTS (0x2)
139 #define SCARD_READER_CONFISCATES (0x4)
140
141 #define SCARD_ATTR_VALUE(Class, Tag) \
142 (((ULONG)(Class) << 16) | (ULONG)(Tag))
143
144 #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
145 #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
146 #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
147 #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
148
149 #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
150
151 #define SCARD_ATTR_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
152 #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
153 #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
154 #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
155 #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
156 #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
157 #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
158 #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
159
160 #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
161
162 #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
163 #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
164
165 #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
166
167 #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
168 #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
169 #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
170 #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
171 #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
172 #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
173 #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
174 #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
175 #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
176 #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020A)
177 #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020B)
178 #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020C)
179
180 #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
181 #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
182 #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
183 #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
184 #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
185
186 #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
187 #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
188 #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
189 #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
190
191 #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
192 #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
193 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
194 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
195 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
196 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
197 #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
198
199 #define SCARD_PERF_NUM_TRANSMISSIONS SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0001)
200 #define SCARD_PERF_BYTES_TRANSMITTED SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0002)
201 #define SCARD_PERF_TRANSMISSION_TIME SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0003)
202
203 #ifdef UNICODE
204 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
205 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
206 #else /* !UNICODE */
207 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
208 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
209 #endif /* UNICODE */
210
211 #ifdef _MSC_VER
212 #pragma warning(pop)
213 #endif
214
215 #ifdef __cplusplus
216 }
217 #endif
218 #endif /* __WINSMCRD_H */
219
220 /* EOF */