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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
|
/*
* 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.h *
* \brief HCI Header for the Generic HCI Management. *
* *
* *
* Project: NFC-FRI-1.1 *
* *
* $Date: Mon Apr 5 14:37:06 2010 $ *
* $Author: ing04880 $ *
* $Revision: 1.39 $ *
* $Aliases: 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_H
#define PHHCINFC_H
/*@}*/
/**
* \name HCI
*
* File: \ref phHciNfc.h
*
*/
/*@{*/
#define PH_HCINFC_FILEREVISION "$Revision: 1.39 $" /**< \ingroup grp_file_attributes */
#define PH_HCINFC_FILEALIASES "$Aliases: 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 <phNfcStatus.h>
#include <phNfcInterface.h>
#ifdef ANDROID
#include <string.h>
#endif
/*
################################################################################
****************************** Macro Definitions *******************************
################################################################################
*/
/*
################################################################################
******************** Enumeration and Structure Definition **********************
################################################################################
*/
typedef enum phHciNfc_Init
{
HCI_SESSION = 0x00,
HCI_SELF_TEST,
HCI_CUSTOM_INIT
}phHciNfc_Init_t;
/** \ingroup grp_hal_hci
*
* \if hal
* \brief HCI Tag Exchange Information
* \else
* \brief HCI-Specific
* \endif
*
* The <em> Tag Exchange Info Structure </em> holds the exchange information to
* the connected tag .
*
* \note All members of this structure are in parameters [in].
*
*/
typedef struct phHciNfc_Tag_XchgInfo
{
/** \internal RF Reader Command Type */
uint8_t cmd_type;
/** \internal Address Field required for only Mifare
* Family Proprietary Cards.
* The Address Size is Valid only upto 255 Blocks limit
* i:e for Mifare 4K
*/
uint8_t addr;
}phHciNfc_Tag_XchgInfo_t;
/** \ingroup grp_hal_hci
*
* \if hal
* \brief HCI NFC-IP Exchange Information
* \else
* \brief HCI-Specific
* \endif
*
* The <em> NFC-IP Exchange Info Structure </em> holds the exchange information to
* the connected NFC-IP target .
*
* \note All members of this structure are in parameters [in].
*
*/
typedef struct phHciNfc_NfcIP_XchgInfo
{
/** \internal NFC-IP DEP Meta Chining Information */
uint8_t more_info;
}phHciNfc_NfcIP_XchgInfo_t;
/** \ingroup grp_hal_hci
*
* \if hal
* \brief HCI Target Exchange Information
* \else
* \brief HCI-Specific
* \endif
*
* The <em> Target Exchange Info Structure </em> holds all the exchange information to
* the connected target .
*
* \note All members of this structure are in parameters [in].
*
*/
typedef struct phHciNfc_XchgInfo
{
/** \internal Exchange Data/NFC-IP DEP
* Exchange Buffer */
uint8_t *tx_buffer;
/** \internal Exchange Data/NFC-IP DEP
* Exchange Buffer Length*/
uint16_t tx_length;
union
{
phHciNfc_Tag_XchgInfo_t tag_info;
phHciNfc_NfcIP_XchgInfo_t nfc_info;
}params;
}phHciNfc_XchgInfo_t;
/*
################################################################################
*********************** Function Prototype Declaration *************************
################################################################################
*/
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Initialise function initialises the HCI context and all other
* resources used in the HCI Layer for the corresponding interface link.
*
* \param[in,out] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] init_mode init_mode specifies the kind of the
* Initialisation for the HCI layer .
* \param[in] pHwConfig pHwConfig is the Information required
* to configure the parameters of the
* NFC Device .
* \param[in] pHalNotify Upper layer Notification function
* pointer.
* \param[in] psContext psContext is the context of
* the Upper Layer.
* \param[in] psHciLayerCfg Pointer to the HCI Layer configuration
* Structure.
*
* \retval NFCSTATUS_PENDING Initialisation of HCI Layer is in Progress.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Initialise (
void *psHciHandle,
void *pHwRef,
phHciNfc_Init_t init_mode,
phHal_sHwConfig_t *pHwConfig,
pphNfcIF_Notification_CB_t pHalNotify,
void *psContext,
phNfcLayer_sCfg_t *psHciLayerCfg
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Release function releases all the resources used in the HCI
* Layer for the corresponding interface link, described by the HCI handle.
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] pHalReleaseCB Upper layer release callback function
* pointer .
* \param[in] psContext psContext is the context of
* the Upper Layer.
*
* \retval NFCSTATUS_PENDING Releasing of HCI Resources are in Progress.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Release (
void *psHciHandle,
void *pHwRef,
pphNfcIF_Notification_CB_t pHalReleaseCB,
void *psContext
);
extern
NFCSTATUS
phHciNfc_Config_Discovery (
void *psHciHandle,
void *pHwRef,
phHal_sADD_Cfg_t *pPollConfig
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Restart_Discovery function restarts the Polling Wheel.
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] re_poll If True: Start re-polling of the target
* after the Target Device is de-activated
* or else - continue discovery with next
* technology.
* \retval NFCSTATUS_PENDING The Discovery Wheel retarted.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Restart_Discovery (
void *psHciHandle,
void *pHwRef,
uint8_t repoll
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Start_Discovery function Starts the Polling Wheel.
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \retval NFCSTATUS_PENDING The Discovery Wheel Started.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Start_Discovery (
void *psHciHandle,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Stop_Discovery function Stops the Polling Wheel.
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \retval NFCSTATUS_PENDING The Discovery Wheel Stopped.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Stop_Discovery (
void *psHciHandle,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Configure function Configures Configures the Polling Wheel to
* select the kind of Tags to be polled. This also allows to enable/disable
* the Tag Emulation. This also configures the Secure elements the UICC, WI and
* Target to Emulate the Tag or Target.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] config_type config_type specifies the type of the
* Parameter configuration.
* \param[in] pConfig pConfig is the Information for
* Configuring the Device.
* \retval NFCSTATUS_PENDING The Emulation configuration pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Configure (
void *psHciHandle,
void *pHwRef,
phHal_eConfigType_t config_type,
phHal_uConfig_t *pConfig
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Switch_SmxMode function Switches the WI(S2C) interface
* from Wired/Virtual to vice versa.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] smx_mode smx_mode specifies the type of the switch
* configuration.
* \param[in] pPollConfig pPollConfig is the Information for
* polling the SmartMX Device.
* \retval NFCSTATUS_PENDING The SmartMX Mode Switch pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
NFCSTATUS
phHciNfc_Switch_SmxMode (
void *psHciHandle,
void *pHwRef,
phHal_eSmartMX_Mode_t smx_mode,
phHal_sADD_Cfg_t *pPollConfig
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Switch_SwpMode function Switches the SWP Link
* from On/Off to vice versa.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] swp_mode swp_mode specifies to switch on/off the
* SWP Link.
* \retval NFCSTATUS_PENDING The SWP Mode Switch pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
NFCSTATUS
phHciNfc_Switch_SwpMode (
void *psHciHandle,
void *pHwRef,
phHal_eSWP_Mode_t swp_mode /* ,
void *pSwpCfg */
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Connect function selects the discovered target to
* perform the transactions on it.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] p_remote_dev_info p_remote_dev_info is the information
* of the Target Device to be connected .
* \retval NFCSTATUS_PENDING To select the remote target pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Connect (
void *psHciHandle,
void *pHwRef,
phHal_sRemoteDevInformation_t *p_remote_dev_info
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Reactiavte function reactivates the discovered target to
* and selects that target perform the transactions on it.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] p_remote_dev_info p_remote_dev_info is the information
* of the Target Device to be reactivated .
* \retval NFCSTATUS_PENDING To reactivate the remote target pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Reactivate (
void *psHciHandle,
void *pHwRef,
phHal_sRemoteDevInformation_t *p_target_info
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Disconnect function de-selects the selected target and
* any ongoing transactions .
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] re_poll If True: Start re-polling of the target
* after the Target Device is de-activated
* or else - continue discovery with next
* technology.
*
* \retval NFCSTATUS_PENDING To De-select the remote target pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Disconnect (
void *psHciHandle,
void *pHwRef,
uint8_t re_poll
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Presence_Check function checks for the presence of the target
* selected in the vicinity of the Reader's RF Field .
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \retval NFCSTATUS_PENDING Presence Check of the remote target
* pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Presence_Check (
void *psHciHandle,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Select_Next_Target function selects and activates the
* next target present in the the Reader's RF Field .
*
*
* \param[in] psHciHandle psHciHandle is the handle or the
* context of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \retval NFCSTATUS_PENDING selection and activation of the next
* remote target pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Select_Next_Target (
void *psHciHandle,
void *pHwRef
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Exchange_Data function exchanges the data
* to/from the selected remote target device.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] p_remote_dev_info p_remote_dev_info is the information of the
* selected target to which data
* should be sent.
* \param[in] p_xchg_info The exchange info contains the command type,
* addr and data to be sent to the connected
* remote target device.
* \retval NFCSTATUS_PENDING Data to remote target pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Exchange_Data (
void *psHciHandle,
void *pHwRef,
phHal_sRemoteDevInformation_t *p_remote_dev_info,
phHciNfc_XchgInfo_t *p_xchg_info
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_Send_Data function Sends the data provided
* to the appropriate remote target device.
*
*
* \param[in] psHciHandle psHciHandle is the handle or the context
* of the HCI Layer.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] p_remote_dev_info p_remote_dev_info is the information
* of the selected target to which data
* should be sent.
* \param[in] p_send_param The send param contains the
* data to be sent to the
* remote device.
* \retval NFCSTATUS_PENDING Data to remote device pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_Send_Data (
void *psHciHandle,
void *pHwRef,
phHal_sRemoteDevInformation_t *p_remote_dev_info,
phHciNfc_XchgInfo_t *p_send_param
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_System_Test function performs the System Management Tests
* provided by the NFC Peripheral device.
*
* \param[in] psContext psContext is the pointer to HCI Layer
* context Structure.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] test_type test_type is the type of the Self Test
* that needs to be performed on the device.
* \param[in] test_param test_param is the parameter for the Self Test
* that needs to be performed on the device.
*
*
* \retval NFCSTATUS_PENDING System Test on the System Management
* is pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_System_Test(
void *psContext,
void *pHwRef,
uint32_t test_type,
phNfc_sData_t *test_param
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_System_Configure function performs the System Management
* Configuration with the value provided.
*
* \param[in] psContext psContext is the pointer to HCI Layer
* context Structure.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] config_type config_type is the type of the configuration
* that needs to be performed on the device.
* \param[in] config_value config_value is the value for the configuring
* that needs to be performed on the device.
*
*
* \retval NFCSTATUS_PENDING Configuration of the provided information to
* the is pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_System_Configure (
void *psHciHandle,
void *pHwRef,
uint32_t config_type,
uint8_t config_value
);
/**
* \ingroup grp_hci_nfc
*
* The phHciNfc_System_Get_Info function obtains the System Management
* information from the address provided.
*
* \param[in] psContext psContext is the pointer to HCI Layer
* context Structure.
* \param[in] pHwRef pHwRef is the Information of
* the Device Interface Link .
* \param[in] info_type info_type is the type of the Information
* that needs to be obtained from the device.
* \param[in,out] p_val p_val is the pointer to which the
* information need to be updated.
*
*
* \retval NFCSTATUS_PENDING Get information from the NFC Device
* is pending.
* \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
* could not be interpreted properly.
* \retval Other errors Errors related to the other layers
*
*/
extern
NFCSTATUS
phHciNfc_System_Get_Info(
void *psHciHandle,
void *pHwRef,
uint32_t info_type,
uint8_t *p_val
);
extern
NFCSTATUS
phHciNfc_PRBS_Test (
void *psHciHandle,
void *pHwRef,
uint32_t test_type,
phNfc_sData_t *test_param
);
#if 0
extern
NFCSTATUS
phHciNfc_Receive_Data (
void *psHciHandle,
void *pHwRef,
uint8_t *p_data,
uint8_t length
);
#endif
#endif
|
