1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
/*
* Copyright (C) 2010 NXP Semiconductors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*!
* =========================================================================== *
* *
* *
* \file phHciNfc_Sequence.h *
* \brief State Machine Management for the HCI and the Function Sequence *
* for a particular State. *
* *
* *
* Project: NFC-FRI-1.1 *
* *
* $Date: Fri Aug 14 17:01:28 2009 $ *
* $Author: ing04880 $ *
* $Revision: 1.12 $ *
* $Aliases: NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $
* *
* =========================================================================== *
*/
/*@{*/
#ifndef PHHCINFC_SEQUENCE_H
#define PHHCINFC_SEQUENCE_H
/*@}*/
/**
* \name HCI
*
* File: \ref phHciNfc_Sequence.h
*
*/
/*@{*/
#define PHHCINFC_SEQUENCE_FILEREVISION "$Revision: 1.12 $" /**< \ingroup grp_file_attributes */
#define PHHCINFC_SEQUENCE_FILEALIASES "$Aliases: NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $" /**< \ingroup grp_file_attributes */
/*@}*/
/*
################################################################################
***************************** Header File Inclusion ****************************
################################################################################
*/
#include <phHciNfc_Generic.h>
/*
################################################################################
****************************** Macro Definitions *******************************
################################################################################
*/
/*
################################################################################
************************* Function Prototype Declaration ***********************
################################################################################
*/
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_FSM_Update function Validates the HCI State to
* the next operation ongoing.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] state state is the state to which the
* current HCI Layer state is validated.
* \param[in] validate_type validate the state by the type of the
* validation required.
*
* \retval NFCSTATUS_SUCCESS FSM Validated successfully .
* \retval NFCSTATUS_INVALID_STATE The supplied state parameter is invalid.
*
*/
extern
NFCSTATUS
phHciNfc_FSM_Validate(
phHciNfc_sContext_t *psHciContext,
phHciNfc_eState_t state,
uint8_t validate_type
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_FSM_Update function Checks and Updates the HCI State to
* the next valid State.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] next_state next_state is the state to which
* we the HCI Layer.
* \param[in] transition transiton of the state whether
* ongoing or complete .
*
* \retval NFCSTATUS_SUCCESS FSM Updated successfully .
* \retval NFCSTATUS_INVALID_STATE The supplied state parameter is invalid.
*
*/
extern
NFCSTATUS
phHciNfc_FSM_Update(
phHciNfc_sContext_t *psHciContext,
phHciNfc_eState_t next_state
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_FSM_Complete function completes the ongoing state transition
* from the current state to the next state.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
*
* \retval NFCSTATUS_SUCCESS FSM Updated successfully .
* \retval NFCSTATUS_INVALID_STATE The supplied state parameter is invalid.
*
*/
extern
NFCSTATUS
phHciNfc_FSM_Complete(
phHciNfc_sContext_t *psHciContext
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_FSM_Rollback function rolls back to previous valid state
* and abort the ongoing state transition.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
*
* \retval NONE.
*
*/
extern
void
phHciNfc_FSM_Rollback(
phHciNfc_sContext_t *psHciContext
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Initialise_Sequence function sequence initialises the
* HCI layer and the remote device by performing the operations required
* setup the reader and discovery functionality.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI current initialise sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_Initialise_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_PollLoop_Sequence function sequence starts the
* discovery sequence of device.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI Discovery Configuration sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_PollLoop_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_EmulationCfg_Sequence function sequence configures the
* device for different types of emulation supported.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI Emulation Configuration
* sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_EmulationCfg_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_SmartMx_Mode_Sequence function sequence configures the
* SmartMx device for different modes by enabling and disabling polling.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI SmartMX Mode Configuration
* sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_SmartMx_Mode_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Connect_Sequence function sequence selects the
* discovered target for performing the transaction.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI target selection sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_Connect_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Disconnect_Sequence function sequence de-selects the
* selected target .
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI target de-selection sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_Disconnect_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Error_Sequence function sequence notifies the
* error in the HCI sequence to the upper layer .
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] status Notify status information from the
* HCI layer to the Upper Layer.
*
*
* \retval NFCSTATUS_SUCCESS HCI Error sequence Notification successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
void
phHciNfc_Error_Sequence(
void *psContext,
void *pHwRef,
NFCSTATUS error_status,
void *pdata,
uint8_t length
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Resume_Sequence function sequence resumes the
* previous pending sequence of HCI .
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI sequence resume successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_Resume_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Release_Sequence function sequence releases the
* HCI layer and the remote device by performing the operations required
* release the reader and discovery functionality.
*
* \param[in] psHciContext psHciContext is the context of
* the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
*
* \retval NFCSTATUS_SUCCESS HCI current release sequence successful.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Other related errors
*
*/
extern
NFCSTATUS
phHciNfc_Release_Sequence(
phHciNfc_sContext_t *psHciContext,
void *pHwRef
);
/*
################################################################################
***************************** Function Definitions *****************************
################################################################################
*/
#endif
|
