summaryrefslogtreecommitdiffstats
path: root/src/phHciNfc_LinkMgmt.c
blob: 3ff0acb1ff7bdfd3751628488470775267d11ea1 (plain)
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
/*
 * 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_LinkMgmt.c                                                  *
* \brief HCI Link Management Gate Routines.                                   *
*                                                                             *
*                                                                             *
* Project: NFC-FRI-1.1                                                        *
*                                                                             *
* $Date: Thu Feb 11 18:52:19 2010 $                                           *
* $Author: ing04880 $                                                         *
* $Revision: 1.11 $                                                            *
* $Aliases: 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 $                                                                *
*                                                                             *
* =========================================================================== *
*/

/*
***************************** Header File Inclusion ****************************
*/
#include <phNfcCompId.h>
#include <phHciNfc_Pipe.h>
#include <phHciNfc_LinkMgmt.h>
#include <phOsalNfc.h>

/*
****************************** Macro Definitions *******************************
*/

#define REC_ERROR_INDEX         0x01U

#define REC_RETRY_LEN           0x02U

/*
*************************** Structure and Enumeration ***************************
*/


/** \defgroup grp_hci_nfc HCI Link Management Component
 *
 *
 */

typedef enum phHciNfc_LinkMgmt_Seq{
    LINK_MGMT_PIPE_OPEN     = 0x00U,
    LINK_MGMT_GET_REC_ERROR,
    LINK_MGMT_SET_REC_ERROR,
    LINK_MGMT_PIPE_CLOSE
} phHciNfc_LinkMgmt_Seq_t;

typedef struct phHciNfc_LinkMgmt_Info{
    phHciNfc_LinkMgmt_Seq_t link_cur_seq;
    phHciNfc_LinkMgmt_Seq_t link_next_seq;
    phHciNfc_Pipe_Info_t    *p_pipe_info;
    /* Rec Error Count Number from the Host Controller */
    uint16_t                hc_rec_error;
    /* Rec Error Count Number of the Terminal Host */
    uint16_t                rec_error;
} phHciNfc_LinkMgmt_Info_t;


/*
*************************** Static Function Declaration **************************
*/

static
NFCSTATUS
phHciNfc_LinkMgmt_InfoUpdate(
                                phHciNfc_sContext_t     *psHciContext,
                                phHal_sHwReference_t    *pHwRef,
                                uint8_t                 index,
                                uint8_t                 *reg_value,
                                uint8_t                 reg_length
                         );
static
NFCSTATUS
phHciNfc_Recv_LinkMgmt_Response(
                        void                *psHciContext,
                        void                *pHwRef,
                        uint8_t             *pResponse,
#ifdef ONE_BYTE_LEN
                        uint8_t             length
#else
                        uint16_t            length
#endif
                       );


/*
*************************** Function Definitions ***************************
*/




/*!
 * \brief Initialisation of Link Managment Gate.
 *
 * This function initialses the Link Management gate and 
 * populates the Link Management Information Structure
 * 
 */

NFCSTATUS
phHciNfc_LinkMgmt_Initialise(
                                phHciNfc_sContext_t     *psHciContext,
                                void                    *pHwRef
                         )
{
    NFCSTATUS                           status = NFCSTATUS_SUCCESS;
    phHciNfc_Pipe_Info_t                *p_pipe_info = NULL;
    phHciNfc_LinkMgmt_Info_t            *p_link_mgmt_info=NULL;
    uint8_t                             link_pipe_id = (uint8_t)HCI_UNKNOWN_PIPE_ID;

    if( ( NULL == psHciContext )
        || (NULL == pHwRef )
        )
    {
        status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_PARAMETER);
    }
    else
    {
        if( ( NULL == psHciContext->p_link_mgmt_info )
            && (phHciNfc_Allocate_Resource((void **)(&p_link_mgmt_info),
                    sizeof(phHciNfc_LinkMgmt_Info_t))== NFCSTATUS_SUCCESS)
          )
        {
            psHciContext->p_link_mgmt_info = p_link_mgmt_info;
            p_link_mgmt_info->link_cur_seq = LINK_MGMT_PIPE_OPEN;
            p_link_mgmt_info->link_next_seq = LINK_MGMT_PIPE_OPEN;
            p_link_mgmt_info->p_pipe_info = NULL;
        }
        else
        {
            p_link_mgmt_info = (phHciNfc_LinkMgmt_Info_t *)
                                psHciContext->p_link_mgmt_info ;
        }

        if( NULL == p_link_mgmt_info )
        {
            status = PHNFCSTVAL(CID_NFC_HCI,
                        NFCSTATUS_INVALID_HCI_INFORMATION);
        }
#ifdef ESTABLISH_SESSION
        else if( hciMode_Session == psHciContext->hci_mode )
        {
            status = NFCSTATUS_SUCCESS;
        }
#endif
        else
        {
            switch(p_link_mgmt_info->link_cur_seq )
            {
                /* Link Mgmt pipe open sequence */
                case LINK_MGMT_PIPE_OPEN:
                {
                    if(phHciNfc_Allocate_Resource((void **)(&p_pipe_info),
                        sizeof(phHciNfc_Pipe_Info_t))!= NFCSTATUS_SUCCESS)
                    {
                        status = PHNFCSTVAL(CID_NFC_HCI,
                                NFCSTATUS_INSUFFICIENT_RESOURCES);
                    }
                    else
                    {
                        /* Populate the pipe information in the pipe handle */
                        ((phHciNfc_Pipe_Info_t *)p_pipe_info)->pipe.pipe_id = 
                                        PIPETYPE_STATIC_LINK;
                        ((phHciNfc_Pipe_Info_t *)p_pipe_info)->recv_resp = 
                                        &phHciNfc_Recv_LinkMgmt_Response;
                        psHciContext->p_pipe_list[PIPETYPE_STATIC_LINK] =
                                                                    p_pipe_info ;
                        status = phHciNfc_Open_Pipe( psHciContext,
                                                            pHwRef,p_pipe_info );
                        if(status == NFCSTATUS_SUCCESS)
                        {
                            p_link_mgmt_info->p_pipe_info = p_pipe_info ;
                            p_link_mgmt_info->link_next_seq = 
                                                    LINK_MGMT_GET_REC_ERROR;
                            status = NFCSTATUS_PENDING;
                        }
                    }
                    break;
                }
                case LINK_MGMT_GET_REC_ERROR:
                {
                    p_pipe_info = p_link_mgmt_info->p_pipe_info;
                    if(NULL == p_pipe_info )
                    {
                        status = PHNFCSTVAL(CID_NFC_HCI, 
                                        NFCSTATUS_INVALID_HCI_SEQUENCE);
                    }
                    else
                    {
                        p_pipe_info->reg_index = REC_ERROR_INDEX;
                        link_pipe_id = PIPETYPE_STATIC_LINK ;
                        status = 
                            phHciNfc_Send_Generic_Cmd( psHciContext, pHwRef, 
                                link_pipe_id,   (uint8_t)ANY_GET_PARAMETER );
                        if(NFCSTATUS_PENDING == status )
                        {
                            p_link_mgmt_info->link_next_seq =
                                                        LINK_MGMT_PIPE_CLOSE;
                            status = NFCSTATUS_SUCCESS;
                        }
                    }
                    break;
                }
                case LINK_MGMT_SET_REC_ERROR:
                {
                    p_pipe_info = p_link_mgmt_info->p_pipe_info;
                    if(NULL == p_pipe_info )
                    {
                        status = PHNFCSTVAL(CID_NFC_HCI, 
                                        NFCSTATUS_INVALID_HCI_SEQUENCE);
                    }
                    else
                    {
                        p_pipe_info->reg_index = REC_ERROR_INDEX;
                        link_pipe_id = PIPETYPE_STATIC_LINK ;
                        status = 
                            phHciNfc_Send_Generic_Cmd( psHciContext, pHwRef, 
                                link_pipe_id,   (uint8_t)ANY_GET_PARAMETER );
                        if(NFCSTATUS_PENDING == status )
                        {
                            p_link_mgmt_info->link_next_seq =
                                                        LINK_MGMT_PIPE_CLOSE;
                            status = NFCSTATUS_SUCCESS;
                        }
                    }
                    break;
                }
                default:
                {
                    status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_HCI_SEQUENCE);
                    break;
                }

            }/* End of the Sequence Switch */

        }/* End of the Link Info Memory Check */
    } /* End of Null Context Check */

    return status;
}

/*!
 * \brief Opens the Link Management Pipe of the Link Management Gate.
 *
 * This function Opens the Link Management Pipe of the Link Management
 * Gate and Confirms that the HCI Link is behaving as expected.
 */

NFCSTATUS
phHciNfc_LinkMgmt_Open(
                                phHciNfc_sContext_t     *psHciContext,
                                void                    *pHwRef
                             )
{
    NFCSTATUS                           status = NFCSTATUS_SUCCESS;

    if( (NULL == psHciContext) || (NULL == pHwRef) )
    {
      status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_PARAMETER);
    }
    else
    {
        phHciNfc_LinkMgmt_Info_t  *p_link_mgmt_info=
            (phHciNfc_LinkMgmt_Info_t *)psHciContext->p_link_mgmt_info ;
        if(( NULL != p_link_mgmt_info ) && 
                ( NULL != p_link_mgmt_info->p_pipe_info  ))
        {
            status = phHciNfc_Open_Pipe( psHciContext,
                            pHwRef, p_link_mgmt_info->p_pipe_info );
            if(status == NFCSTATUS_SUCCESS)
            {
                status = NFCSTATUS_PENDING;
            }
        }
        else
        {
            status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_NOT_ALLOWED);

        }/* End of the Identity Info Memory Check */

    } /* End of Null Context Check */

    return status;
}


NFCSTATUS
phHciNfc_LinkMgmt_Release(
                                phHciNfc_sContext_t     *psHciContext,
                                void                    *pHwRef
                             )
{
    NFCSTATUS                           status = NFCSTATUS_SUCCESS;
    phHciNfc_LinkMgmt_Info_t            *p_link_mgmt_info=NULL;

    if( (NULL == psHciContext) || (NULL == pHwRef) )
    {
      status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_PARAMETER);
    }
    else
    {
        if( NULL != psHciContext->p_link_mgmt_info )
        {
            p_link_mgmt_info = (phHciNfc_LinkMgmt_Info_t *)
                                psHciContext->p_link_mgmt_info ;
            status = phHciNfc_Close_Pipe( psHciContext,
                            pHwRef, p_link_mgmt_info->p_pipe_info );
        }
        else
        {
            status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_NOT_ALLOWED);

        }/* End of the Identity Info Memory Check */


    } /* End of Null Context Check */

    return status;
}


/*!
 * \brief Receives the HCI Response from the corresponding peripheral device.
 *
 * This function receives the HCI Command Response from the connected NFC
 * Pheripheral device.
 */
static
NFCSTATUS
phHciNfc_Recv_LinkMgmt_Response(
                        void                *psContext,
                        void                *pHwRef,
                        uint8_t             *pResponse,
#ifdef ONE_BYTE_LEN
                        uint8_t             length
#else
                        uint16_t            length
#endif
                    )
{
    phHciNfc_sContext_t         *psHciContext = 
                                    (phHciNfc_sContext_t *)psContext ;
    phHciNfc_LinkMgmt_Info_t    *p_link_mgmt_info=NULL;
    NFCSTATUS                   status = NFCSTATUS_SUCCESS;
    uint8_t                     prev_cmd = ANY_GET_PARAMETER;

    if( (NULL == psHciContext) || (NULL == pHwRef) )
    {
      status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_PARAMETER);
    }
    else if(  NULL == psHciContext->p_link_mgmt_info )
    {
        status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_FEATURE_NOT_SUPPORTED);
    }
    else
    {
        p_link_mgmt_info = (phHciNfc_LinkMgmt_Info_t *)
                            psHciContext->p_link_mgmt_info ;
        prev_cmd = p_link_mgmt_info->p_pipe_info->prev_msg ;
        switch(prev_cmd)
        {
            case ANY_GET_PARAMETER:
            {
                status = phHciNfc_LinkMgmt_InfoUpdate(psHciContext,
                            (phHal_sHwReference_t *)pHwRef,
                            p_link_mgmt_info->p_pipe_info->reg_index, 
                            &pResponse[HCP_HEADER_LEN],
                                (uint8_t)(length - HCP_HEADER_LEN));
                break;
            }
            case ANY_SET_PARAMETER:
            {
                status = PHNFCSTVAL(CID_NFC_HCI,
                                    NFCSTATUS_FEATURE_NOT_SUPPORTED);
                break;
            }
            case ANY_OPEN_PIPE:
            {
                break;
            }
            case ANY_CLOSE_PIPE:
            {
                phOsalNfc_FreeMemory(p_link_mgmt_info->p_pipe_info);
                p_link_mgmt_info->p_pipe_info = NULL;
                psHciContext->p_pipe_list[PIPETYPE_STATIC_LINK] = NULL;
                break;
            }
            default:
            {
                status = PHNFCSTVAL(CID_NFC_HCI,
                                        NFCSTATUS_INVALID_HCI_RESPONSE);
                break;
            }
        }
        if( NFCSTATUS_SUCCESS == status )
        {
            if( NULL != p_link_mgmt_info->p_pipe_info)
            {
                p_link_mgmt_info->p_pipe_info->prev_status = NFCSTATUS_SUCCESS;
            }
            p_link_mgmt_info->link_cur_seq = p_link_mgmt_info->link_next_seq;
        }

    }
    return status;
}


static
NFCSTATUS
phHciNfc_LinkMgmt_InfoUpdate(
                                phHciNfc_sContext_t     *psHciContext,
                                phHal_sHwReference_t    *pHwRef,
                                uint8_t                 index,
                                uint8_t                 *reg_value,
                                uint8_t                 reg_length
                          )
{
    phHciNfc_LinkMgmt_Info_t    *p_link_mgmt_info=NULL;
    NFCSTATUS                   status = NFCSTATUS_SUCCESS;
    uint8_t                     i=0;
    if( (NULL == psHciContext)
        || (NULL == pHwRef)
        || (NULL == reg_value)
        || (reg_length == 0)
      )
    {
        status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_PARAMETER);
    }
    else if ( NULL == psHciContext->p_link_mgmt_info )
    {
        status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_HCI_INFORMATION);
    }
    else
    {
        p_link_mgmt_info = (phHciNfc_LinkMgmt_Info_t *)
                                psHciContext->p_link_mgmt_info ;
        if (REC_ERROR_INDEX == index)
        {
            HCI_PRINT_BUFFER("\tHost Controller REC Error Count :",reg_value,reg_length);
            /* p_link_mgmt_info->hc_rec_error = reg_value[i] ; */
            for(i=0 ;(reg_length == REC_RETRY_LEN)&&(i < reg_length); i++)
            {
                p_link_mgmt_info->hc_rec_error |= 
                            (uint16_t)(reg_value[i] << (BYTE_SIZE * i));
            }
        }
        else
        {
            status = PHNFCSTVAL(CID_NFC_HCI, NFCSTATUS_INVALID_HCI_INFORMATION);
        } /* End of the Index Check */

    } /* End of Context and the Link information validity check */

    return status;
}