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
|
/*
* Copyright 2010-2023 NXP
*
* 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.
*/
/*
* Transport Mapping Layer header files containing APIs related to initializing,
* reading
* and writing data into files provided by the driver interface.
*
* API listed here encompasses Transport Mapping Layer interfaces required to be
* mapped
* to different Interfaces and Platforms.
*
*/
#ifndef PHTMLNFC_H
#define PHTMLNFC_H
#include <phNfcCommon.h>
/*
* Message posted by Reader thread upon
* completion of requested operation
*/
#define PH_TMLNFC_READ_MESSAGE (0xAA)
/*
* Message posted by Writer thread upon
* completion of requested operation
*/
#define PH_TMLNFC_WRITE_MESSAGE (0x55)
/*
* Value indicates to reset device
*/
#define PH_TMLNFC_RESETDEVICE (0x00008001)
/*
* The 4096 bytes fragment len is supported during SN300 FW DNLD.
* If this macro is not defined, then the fragment len will fallback to 554.
*/
// #define PH_TMLNFC_HDLL_4K_WRITE_SUPPORTED
/*
* Fragment Length for SNXXX and PN547
*/
#define PH_TMLNFC_FRGMENT_SIZE_PN557 (0x102)
#define PH_TMLNFC_FRGMENT_SIZE_SNXXX (0x22A)
#ifdef PH_TMLNFC_HDLL_4K_WRITE_SUPPORTED
#define PH_TMLNFC_FRGMENT_SIZE_SN300 (0x1000)
#else
#define PH_TMLNFC_FRGMENT_SIZE_SN300 (0x22A)
#endif
/*
***************************Globals,Structure and Enumeration ******************
*/
/*
* Transaction (Tx/Rx) completion information structure of TML
*
* This structure holds the completion callback information of the
* transaction passed from the TML layer to the Upper layer
* along with the completion callback.
*
* The value of field wStatus can be interpreted as:
*
* - NFCSTATUS_SUCCESS Transaction performed
* successfully.
* - NFCSTATUS_FAILED Failed to wait on Read/Write
* operation.
* - NFCSTATUS_INSUFFICIENT_STORAGE Not enough memory to store data in
* case of read.
* - NFCSTATUS_BOARD_COMMUNICATION_ERROR Failure to Read/Write from the
* file or timeout.
*/
typedef struct phTmlNfc_TransactInfo {
NFCSTATUS wStatus; /* Status of the Transaction Completion*/
uint8_t* pBuff; /* Response Data of the Transaction*/
uint16_t wLength; /* Data size of the Transaction*/
} phTmlNfc_TransactInfo_t; /* Instance of Transaction structure */
/*
* TML transreceive completion callback to Upper Layer
*
* pContext - Context provided by upper layer
* pInfo - Transaction info. See phTmlNfc_TransactInfo
*/
typedef void (*pphTmlNfc_TransactCompletionCb_t)(
void* pContext, phTmlNfc_TransactInfo_t* pInfo);
/*
* TML Deferred callback interface structure invoked by upper layer
*
* This could be used for read/write operations
*
* dwMsgPostedThread Message source identifier
* pParams Parameters for the deferred call processing
*/
typedef void (*pphTmlNfc_DeferFuncPointer_t)(uint32_t dwMsgPostedThread,
void* pParams);
/*
* Enum definition contains supported ioctl control codes.
*
* phTmlNfc_IoCtl
*/
typedef enum {
phTmlNfc_e_Invalid = 0,
phTmlNfc_e_ResetDevice = PH_TMLNFC_RESETDEVICE, /* Reset the device */
phTmlNfc_e_EnableDownloadMode, /* Do the hardware setting to enter into
download mode */
phTmlNfc_e_EnableNormalMode, /* Hardware setting for normal mode of operation
*/
phTmlNfc_e_EnableDownloadModeWithVenRst,
phTmlNfc_e_EnableVen, /* Enable Ven for PN557 chip*/
phTmlNfc_e_PowerReset = 5,
phTmlNfc_e_setFragmentSize,
phTmlNfc_e_SetNfcState,
phTmlNfc_e_ResetNfcState,
phTmlNfc_e_PullVenLow,
phTmlNfc_e_PullVenHigh,
} phTmlNfc_ControlCode_t; /* Control code for IOCTL call */
/*
* Enable / Disable Re-Transmission of Packets
*
* phTmlNfc_ConfigNciPktReTx
*/
typedef enum {
phTmlNfc_e_EnableRetrans = 0x00, /*Enable retransmission of Nci packet */
phTmlNfc_e_DisableRetrans = 0x01 /*Disable retransmission of Nci packet */
} phTmlNfc_ConfigRetrans_t; /* Configuration for Retransmission */
/*
* Structure containing details related to read and write operations
*
*/
typedef struct phTmlNfc_ReadWriteInfo {
volatile uint8_t bEnable; /*This flag shall decide whether to perform
Write/Read operation */
uint8_t
bThreadBusy; /*Flag to indicate thread is busy on respective operation */
/* Transaction completion Callback function */
pphTmlNfc_TransactCompletionCb_t pThread_Callback;
void* pContext; /*Context passed while invocation of operation */
uint8_t* pBuffer; /*Buffer passed while invocation of operation */
uint16_t wLength; /*Length of data read/written */
NFCSTATUS wWorkStatus; /*Status of the transaction performed */
} phTmlNfc_ReadWriteInfo_t;
/*
*Base Context Structure containing members required for entire session
*/
typedef struct phTmlNfc_Context {
pthread_t readerThread; /*Handle to the thread which handles write and read
operations */
pthread_t writerThread;
volatile uint8_t
bThreadDone; /*Flag to decide whether to run or abort the thread */
phTmlNfc_ConfigRetrans_t
eConfig; /*Retransmission of Nci Packet during timeout */
uint8_t bRetryCount; /*Number of times retransmission shall happen */
uint8_t bWriteCbInvoked; /* Indicates whether write callback is invoked during
retransmission */
uint32_t dwTimerId; /* Timer used to retransmit nci packet */
phTmlNfc_ReadWriteInfo_t tReadInfo; /*Pointer to Reader Thread Structure */
phTmlNfc_ReadWriteInfo_t tWriteInfo; /*Pointer to Writer Thread Structure */
void* pDevHandle; /* Pointer to Device Handle */
uintptr_t dwCallbackThreadId; /* Thread ID to which message to be posted */
uint8_t bEnableCrc; /*Flag to validate/not CRC for input buffer */
sem_t rxSemaphore;
sem_t txSemaphore; /* Lock/Acquire txRx Semaphore */
sem_t postMsgSemaphore; /* Semaphore to post message atomically by Reader &
writer thread */
pthread_cond_t wait_busy_condition; /*Condition to wait reader thread*/
pthread_mutex_t wait_busy_lock; /*Condition lock to wait reader thread*/
volatile uint8_t wait_busy_flag; /*Condition flag to wait reader thread*/
volatile uint8_t gWriterCbflag; /* flag to indicate write callback message is
pushed to queue*/
long nfc_service_pid; /*NFC Service PID to be used by driver to signal*/
uint16_t fragment_len;
} phTmlNfc_Context_t;
/*
* TML Configuration exposed to upper layer.
*/
typedef struct phTmlNfc_Config {
/* Port name connected to PN54X
*
* Platform specific canonical device name to which PN54X is connected.
*
* e.g. On Linux based systems this would be /dev/PN54X
*/
int8_t* pDevName;
/* Callback Thread ID
*
* This is the thread ID on which the Reader & Writer thread posts message. */
uintptr_t dwGetMsgThreadId;
uint16_t fragment_len;
} phTmlNfc_Config_t, *pphTmlNfc_Config_t; /* pointer to phTmlNfc_Config_t */
/*
* TML Deferred Callback structure used to invoke Upper layer Callback function.
*/
typedef struct {
/* Deferred callback function to be invoked */
pphTmlNfc_DeferFuncPointer_t pDef_call;
/* Source identifier
*
* Identifier of the source which posted the message
*/
uint32_t dwMsgPostedThread;
/** Actual Message
*
* This is passed as a parameter passed to the deferred callback function
* pDef_call. */
void* pParams;
} phTmlNfc_DeferMsg_t; /* DeferMsg structure passed to User Thread */
typedef enum {
I2C_FRAGMENATATION_DISABLED, /*i2c fragmentation_disabled */
I2C_FRAGMENTATION_ENABLED /*i2c_fragmentation_enabled */
} phTmlNfc_i2cfragmentation_t;
/* Function declarations */
NFCSTATUS phTmlNfc_Init(pphTmlNfc_Config_t pConfig);
NFCSTATUS phTmlNfc_Shutdown(void);
NFCSTATUS phTmlNfc_Shutdown_CleanUp();
void phTmlNfc_CleanUp(void);
NFCSTATUS phTmlNfc_Write(uint8_t* pBuffer, uint16_t wLength,
pphTmlNfc_TransactCompletionCb_t pTmlWriteComplete,
void* pContext);
NFCSTATUS phTmlNfc_Read(uint8_t* pBuffer, uint16_t wLength,
pphTmlNfc_TransactCompletionCb_t pTmlReadComplete,
void* pContext);
NFCSTATUS phTmlNfc_WriteAbort(void);
NFCSTATUS phTmlNfc_ReadAbort(void);
NFCSTATUS phTmlNfc_IoCtl(phTmlNfc_ControlCode_t eControlCode);
void phTmlNfc_DeferredCall(uintptr_t dwThreadId,
phLibNfc_Message_t* ptWorkerMsg);
void phTmlNfc_ConfigNciPktReTx(phTmlNfc_ConfigRetrans_t eConfig,
uint8_t bRetryCount);
void phTmlNfc_set_fragmentation_enabled(phTmlNfc_i2cfragmentation_t enable);
NFCSTATUS phTmlNfc_ConfigTransport();
void phTmlNfc_EnableFwDnldMode(bool mode);
bool phTmlNfc_IsFwDnldModeEnabled(void);
#endif /* PHTMLNFC_H */
|
