1# INfcInterface
2
3
4## 概述
5
6声明操作nfc芯片的API,包括关闭、打开nfc,初始化nfc,读写数据、配置RF参数、发送nci指令。
7
8**起始版本:** 3.2
9
10**相关模块:**[HdiNfc](_hdi_nfc_v10.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [Open](#open) ([in] [INfcCallback](interface_i_nfc_callback_v10.md) callbackObj, [out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 打开NFC,对NFC初始化。 |
21| [CoreInitialized](#coreinitialized) ([in] List< unsigned char > data, [out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | NFC初始化。 |
22| [Prediscover](#prediscover) ([out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 启动RF discover之前对芯片进行预配置。 |
23| [Write](#write) ([in] List< unsigned char > data, [out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 发送数据给NFC控制器。 |
24| [ControlGranted](#controlgranted) ([out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 允许HDF层发送NCI指令。 |
25| [PowerCycle](#powercycle) ([out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 周期性重启NFC。 |
26| [Close](#close) ([out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | 关闭NFC。 |
27| [Ioctl](#ioctl) ([in] enum [NfcCommand](_hdi_nfc_v10.md#nfccommand) cmd, [in] List< unsigned char > data, [out] enum [NfcStatus](_hdi_nfc_v10.md#nfcstatus) status) | NFC协议栈通过IO控制指令和数据发送给HDI。 |
28
29
30## 成员函数说明
31
32
33### Close()
34
35```
36INfcInterface::Close ([out] enum NfcStatus status)
37```
38
39**描述**
40
41
42关闭NFC。
43
44**起始版本:** 3.2
45
46**返回:**
47
48配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
49
50
51### ControlGranted()
52
53```
54INfcInterface::ControlGranted ([out] enum NfcStatus status)
55```
56
57**描述**
58
59
60允许HDF层发送NCI指令。
61
62**起始版本:** 3.2
63
64**返回:**
65
66配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
67
68
69### CoreInitialized()
70
71```
72INfcInterface::CoreInitialized ([in] List< unsigned char > data, [out] enum NfcStatus status )
73```
74
75**描述**
76
77
78NFC初始化。
79
80**起始版本:** 3.2
81
82**参数:**
83
84| 名称 | 描述 |
85| -------- | -------- |
86| callbackObj | NFC芯片发送给NFC协议栈的数据和事件的回调对象。 |
87
88**返回:**
89
90操作成功返回0,否则返回失败。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
91
92
93### Ioctl()
94
95```
96INfcInterface::Ioctl ([in] enum NfcCommand cmd, [in] List< unsigned char > data, [out] enum NfcStatus status )
97```
98
99**描述**
100
101
102NFC协议栈通过IO控制指令和数据发送给HDI。
103
104**起始版本:** 3.2
105
106**参数:**
107
108| 名称 | 描述 |
109| -------- | -------- |
110| cmd | NfcCommand中定义在控制指令,详见[NfcTypes](_nfc_types_8idl_v10.md)。 |
111| data | 发送给HDI的数据。 |
112
113**返回:**
114
115配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
116
117
118### Open()
119
120```
121INfcInterface::Open ([in] INfcCallback callbackObj, [out] enum NfcStatus status )
122```
123
124**描述**
125
126
127打开NFC,对NFC初始化。
128
129**起始版本:** 3.2
130
131**参数:**
132
133| 名称 | 描述 |
134| -------- | -------- |
135| callbackObj | NFC芯片发送给NFC协议栈的数据和事件的回调对象 |
136
137**返回:**
138
139操作成功返回0,否则返回失败。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
140
141
142### PowerCycle()
143
144```
145INfcInterface::PowerCycle ([out] enum NfcStatus status)
146```
147
148**描述**
149
150
151周期性重启NFC。
152
153**起始版本:** 3.2
154
155**返回:**
156
157配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
158
159
160### Prediscover()
161
162```
163INfcInterface::Prediscover ([out] enum NfcStatus status)
164```
165
166**描述**
167
168
169启动RF discover之前对芯片进行预配置。
170
171**起始版本:** 3.2
172
173**返回:**
174
175配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
176
177
178### Write()
179
180```
181INfcInterface::Write ([in] List< unsigned char > data, [out] enum NfcStatus status )
182```
183
184**描述**
185
186
187发送数据给NFC控制器。
188
189**起始版本:** 3.2
190
191**参数:**
192
193| 名称 | 描述 |
194| -------- | -------- |
195| data | 待写入NFC控制器的数据。 |
196
197**返回:**
198
199配置成功返回0,否则返回失败原因。 具体类型详见[NfcTypes](_nfc_types_8idl_v10.md)。
200