comparison cdg3/sap/8010_136_SIMDRV_SAP.pdf @ 16:c15047b3d00d

cdg3: import from freecalypso-citrine/cdg
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 27 Sep 2016 16:27:34 +0000
parents
children
comparison
equal deleted inserted replaced
15:c8bdae60fcb1 16:c15047b3d00d
1 ;********************************************************************************
2 ;*** File : 8010_136_simdrv_sap.pdf
3 ;*** Creation : Wed Mar 11 09:57:50 CST 2009
4 ;*** XSLT Processor : Apache Software Foundation / http://xml.apache.org/xalan-j / supports XSLT-Ver: 1
5 ;*** Copyright : (c) Texas Instruments AG, Berlin Germany 2002
6 ;********************************************************************************
7 ;*** Document Type : Service Access Point Specification
8 ;*** Document Name : 8010_136_simdrv_sap
9 ;*** Document No. : 8010.136.03.009
10 ;*** Document Date : 2004-06-10
11 ;*** Document Status: BEING_PROCESSED
12 ;*** Document Author: FDU
13 ;********************************************************************************
14
15
16
17 PRAGMA SRC_FILE_TIME "Thu Nov 29 09:27:56 2007"
18 PRAGMA LAST_MODIFIED "2004-06-10"
19 PRAGMA ID_AND_VERSION "8010.136.03.009"
20 PRAGMA PREFIX SIMDRV ; Prefix for this document
21 PRAGMA ALLWAYS_ENUM_IN_VAL_FILE YES ; Adds enumerations in the .val file.
22 PRAGMA ENABLE_GROUP YES ; Enable h-file grouping
23 PRAGMA COMPATIBILITY_DEFINES NO ; Compatible to the old #defines
24
25
26
27 CONST SIZE_ATR_INFO 0x21 ; The maximum length of the data returned from the ATR procedure
28 GROUP uicc
29 CONST MIN_RESULT 0x01 ; Minimum size of the response of any given command
30 GROUP uicc
31 CONST MAX_RESULT 0x100 ; Maximum size of the response of any given command
32 GROUP uicc
33 CONST MIN_DATA_SIZE 0x01 ; Minimum length of a data element
34 GROUP uicc
35 CONST MAX_DATA_SIZE 0xFF ; Maximum length of a data element
36 GROUP uicc
37 CONST MAX_READERS 0x02 ; Maximum number of card readers supported.
38 GROUP uicc
39
40
41
42 VALTAB VAL_reset_return_val
43 GROUP uicc
44 VAL 0 SIM_INSERTED "A SIM is inserted and ATR/PPS was successful"
45 VAL 1 SIM_NOT_INSERTED "No SIM inserted (hardware detected)"
46 VAL 2 INVALID_CARD "Card is not responding or gives unintelligible answers, communications time out."
47 VAL 3 ME_FAILURE "Power management related problems, e.g. voltage selection"
48 VAL 4 IMPROPER_CALL_BACK "simdrv_register function called with pointer improperly set, e.g. NULL."
49 VAL 5 ME_READER_NOT_AVAILABLE "The reader requested is not available"
50
51 VALTAB VAL_len
52 GROUP uicc
53 VAL 0x00 - 0x100 "Range of Length of Data"
54 VAL 0xFFFF LENGTH_UNKNOWN "Indicating that the length expected is unknown."
55
56 VALTAB VAL_sw1_2
57 GROUP uicc
58 VAL 0x0001 ERR_NOCARD "No SIM inserted (hardware detected)"
59 VAL 0x0002 ERR_NOT_RESET "A reset has not been performed on the driver with the requested Id."
60 VAL 0x0003 ERR_ME_FAIL "Unrecoverable ME failure (for instance interrupt fails to occur)"
61 VAL 0x0004 ERR_RETRY_FAIL "ME/SIM communication failed after certain retries, SIM reset required"
62 VAL 0x0005 ERR_PARAM_WRONG "A driver function is called with invalid parameters"
63
64 VALTAB VAL_cla
65 GROUP uicc
66 VAL 0xA0 GSM_CLASS_BYTE "GSM Class byte according to [GSM 11.11 / 3GPP 51.011]"
67 VAL 0x80 UMTS_CLASS_BYTE "UMTS Class byte according to [ETSI 102 221 10.1.2]"
68 VAL 0x00 UICC_CLASS_BYTE "UICC Class byte according to [ISO 7816-4]"
69
70 VALTAB VAL_ins
71 GROUP uicc
72 VAL 0xA4 INS_SELECT "Select Instruction"
73 VAL 0xF2 INS_STATUS "Status Instruction"
74 VAL 0xB0 INS_READ_BINARY "Read Binary Instruction"
75 VAL 0xD6 INS_UPDATE_BINARY "Update Binary Instruction"
76 VAL 0xB2 INS_READ_RECORD "Read Record Instruction"
77 VAL 0xDC INS_UPDATE_RECORD "Update Record Instruction"
78 VAL 0xA2 INS_SEEK "Seek Instruction"
79 VAL 0x32 INS_INCREASE "Increase Instruction"
80 VAL 0x20 INS_VERIFY_CHV "Verify Chv Instruction"
81 VAL 0x24 INS_CHANGE_CHV "Change Chv Instruction"
82 VAL 0x26 INS_DISABLE_CHV "Disable Chv Instruction"
83 VAL 0x28 INS_ENABLE_CHV "Ensable Chv Instruction"
84 VAL 0x2C INS_UNBLOCK_CHV "Unblock Chv Instruction"
85 VAL 0x04 INS_INVALIDATE "Invalidate Instruction"
86 VAL 0x44 INS_REHABILITATE "Rehabilitate Instruction"
87 VAL 0x88 INS_AUTHENTICATE "Run GSM Algorithm (2/2.5G) / Authenticate (3G) Instruction"
88 VAL 0x10 INS_TERMINAL_PROFILE "Terminal Profile Instruction"
89 VAL 0xC2 INS_ENVELOPE "Envelope Instruction"
90 VAL 0x12 INS_FETCH "Fetch Instruction"
91 VAL 0x14 INS_TERMINAL_RESPONSE "Terminal Response Instruction"
92 VAL 0xC0 INS_GET_RESPONSE "Get Response Instruction"
93
94 VALTAB VAL_voltage_select
95 GROUP uicc
96 VAL 0 REQ_VOLTAGE_SEL "The SIM reader driver shall perform voltage selection"
97 VAL 1 OMIT_VOLTAGE_SEL "The SIM reader driver shall restart with the current voltage"
98
99 VALTAB VAL_config_requested
100 GROUP uicc
101 VAL 0x00 OMIT_CONFIG_CHARACTERISTICS "PS Shall not retrieve Configuration Characteristics"
102 VAL 0x01 REQUEST_CONFIG_CHARACTERISTICS "PS Shall retrieve Configuration Characteristics"
103
104 VALTAB VAL_reader_id
105 GROUP uicc
106 VAL 01 - MAX_READERS "Range of Id's of readers"
107
108
109
110
111 VAR insert_ptr "insert pointer" L
112 GROUP uicc
113
114
115 VAR remove_ptr "remove pointer" L
116 GROUP uicc
117
118
119 VAR atr_string "SIM Card Answer to reset string" B
120 GROUP uicc
121
122
123 VAR reset_return_val "Reset return value" B
124 GROUP uicc
125
126 VAL @p_8010_136_simdrv_sap - VAL_reset_return_val@
127
128 VAR result "Result byte" B
129 GROUP uicc
130
131
132 VAR len "Maximum length of expected data" S
133 GROUP uicc
134
135 VAL @p_8010_136_simdrv_sap - VAL_len@
136
137 VAR data "Data element" B
138 GROUP uicc
139
140
141 VAR sw1_2 "Status Words" S
142 GROUP uicc
143
144 VAL @p_8010_136_simdrv_sap - VAL_sw1_2@
145
146 VAR cla "Class Byte" B
147 GROUP uicc
148
149 VAL @p_8010_136_simdrv_sap - VAL_cla@
150
151 VAR ins "instruction code" B
152 GROUP uicc
153
154 VAL @p_8010_136_simdrv_sap - VAL_ins@
155
156 VAR voltage_select "Perform Voltage Selection" B
157 GROUP uicc
158
159 VAL @p_8010_136_simdrv_sap - VAL_voltage_select@
160
161 VAR p1 "Parameter 1 of the SIM APDU" B
162 GROUP uicc
163
164
165 VAR p2 "Parameter 2 of the SIM APDU" B
166 GROUP uicc
167
168
169 VAR config_requested "Configuration Characteristics requested" B
170 GROUP uicc
171
172 VAL @p_8010_136_simdrv_sap - VAL_config_requested@
173
174 VAR reader_id "Reader Id" B
175 GROUP uicc
176
177 VAL @p_8010_136_simdrv_sap - VAL_reader_id@
178
179 VAR uicc_characteristics "UICC Characteristics" B
180 GROUP uicc
181
182
183
184
185
186 COMP atr_string_info "SIM Card Info"
187 GROUP uicc
188 {
189 atr_string [2..SIZE_ATR_INFO] ; SIM Card Answer to reset string
190 }
191
192
193
194 COMP result_info "Result Buffer"
195 GROUP uicc
196 {
197 len ; Length of expected data
198 result DYN[MIN_RESULT..MAX_RESULT] ; Result byte
199 }
200
201
202
203 COMP data_info "Data element info"
204 GROUP uicc
205 {
206 data DYN[MIN_DATA_SIZE..MAX_DATA_SIZE] ; Data element
207 }
208
209
210
211 COMP cmd_header "Transparent command header"
212 GROUP uicc
213 {
214 cla ; Class Byte value
215 ins ; Instruction Code
216 p1 ; Parameter P1
217 p2 ; Parameter P2
218 }
219
220
221
222 COMP config_characteristics "Configuration Characteristics"
223 GROUP uicc
224 {
225 uicc_characteristics ; UICC Characteristics
226 }
227
228
229
230
231
232
233 ; SIMDRV_DUMMY 0x80FF009A
234
235
236
237 PRIM SIMDRV_DUMMY 0x80FF009A
238 GROUP uicc
239 {
240 atr_string_info PTR ; SIM Card Info
241 reset_return_val ; Return Value
242 result_info PTR ; Result Buffer
243 len ; Length of expected data
244 data_info PTR ; Update Data Element
245 sw1_2 ; Status Words
246 cla ; Class Byte
247 ins ; Instruction Code
248 cmd_header ; Transparent command header
249 voltage_select ; Perform Voltage Selection
250 p1 ; SIM Command Parameters
251 p2 ; SIM Command Parameters
252 config_requested ; Configuration Characteristics requested
253 config_characteristics PTR ; Configuration Characteristics
254 reader_id ; Reader Id
255 uicc_characteristics ; UICC Characteristics
256 }
257
258
259
260
261
262
263
264
265