1/*
2 * Copyright (C) 2010-2014 NXP Semiconductors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/*
18 * Firmware Download Interface File
19 */
20#ifndef PHDNLDNFC_H
21#define PHDNLDNFC_H
22
23#include <phNfcStatus.h>
24
25/*
26 *
27 * Callback for handling the received data/response from PN54X.
28 * Parameters to be passed/registered to download context during respective download function call:
29 *      pContext - Upper layer context
30 *      wStatus  - Status of the transaction
31 *      pInfo    - Contains the Transaction Info
32 */
33typedef void (*pphDnldNfc_RspCb_t)(void* pContext, NFCSTATUS wStatus,void* pInfo);
34
35#define PHLIBNFC_FWDNLD_SESSNOPEN    (0x01U)   /* download session is Open */
36#define PHLIBNFC_FWDNLD_SESSNCLOSED  (0x00U)   /* download session is Closed */
37
38#define PHDNLDNFC_HWVER_MRA1_0       (0x01U)   /* ChipVersion MRA1.0 */
39#define PHDNLDNFC_HWVER_MRA1_1       (0x02U)   /* ChipVersion MRA1.1 */
40#define PHDNLDNFC_HWVER_MRA2_0       (0x03U)   /* ChipVersion MRA2.0 */
41#define PHDNLDNFC_HWVER_MRA2_1       (0x04U)   /* ChipVersion MRA2.1 */
42#define PHDNLDNFC_HWVER_MRA2_2       (0x05U)   /* ChipVersion MRA2.2 */
43
44#define PHDNLDNFC_HWVER_PN548AD_MRA1_0       (0x08U)   /* PN548AD ChipVersion MRA1.0 */
45
46#define PHDNLDNFC_HWVER_PN551_MRA1_0         (0x08U)   /* PN551 ChipVersion MRA1.0 */
47/*
48 * Enum definition contains Download Life Cycle States
49 */
50typedef enum phDnldNfc_LC{
51    phDnldNfc_LCCreat = 11,     /* Life Cycle Creation*/
52    phDnldNfc_LCInit = 13,      /* Life Cycle Initializing */
53    phDnldNfc_LCOper = 17,      /* Life Cycle Operational */
54    phDnldNfc_LCTerm = 19       /* Life Cycle Termination */
55}phDnldNfc_LC_t;
56
57/*
58 * Enum definition contains Clk Source Options for Force command request
59 */
60typedef enum phDnldNfc_ClkSrc{
61    phDnldNfc_ClkSrcXtal = 1U,     /* Crystal */
62    phDnldNfc_ClkSrcPLL = 2U,      /* PLL output */
63    phDnldNfc_ClkSrcPad = 3U      /* Directly use clk on CLK_IN Pad */
64}phDnldNfc_ClkSrc_t;
65
66/*
67 * Enum definition contains Clk Frequency value for Force command request
68 */
69typedef enum phDnldNfc_ClkFreq{
70    phDnldNfc_ClkFreq_13Mhz = 0U,    /* 13Mhz Clk Frequency */
71    phDnldNfc_ClkFreq_19_2Mhz = 1U,  /* 19.2Mhz Clk Frequency */
72    phDnldNfc_ClkFreq_24Mhz = 2U,    /* 24Mhz Clk Frequency */
73    phDnldNfc_ClkFreq_26Mhz = 3U,    /* 26Mhz Clk Frequency */
74    phDnldNfc_ClkFreq_38_4Mhz = 4U,  /* 38.4Mhz Clk Frequency */
75    phDnldNfc_ClkFreq_52Mhz = 5U     /* 52Mhz Clk Frequency */
76}phDnldNfc_ClkFreq_t;
77
78/*
79 * Struct contains buffer where user payload shall be stored
80 */
81typedef struct phDnldNfc_Buff
82{
83    uint8_t *pBuff;                  /*pointer to the buffer where user payload shall be stored*/
84    uint16_t wLen;                   /*Buffer length*/
85}phDnldNfc_Buff_t, *pphDnldNfc_Buff_t; /* pointer to #phDnldNfc_Buff_t */
86
87/*
88*********************** Function Prototype Declaration *************************
89*/
90
91extern NFCSTATUS phDnldNfc_Reset(pphDnldNfc_RspCb_t pNotify, void *pContext);
92extern NFCSTATUS phDnldNfc_GetVersion(pphDnldNfc_Buff_t pVersionInfo, pphDnldNfc_RspCb_t pNotify, void *pContext);
93extern NFCSTATUS phDnldNfc_CheckIntegrity(uint8_t bChipVer, pphDnldNfc_Buff_t pCRCData, pphDnldNfc_RspCb_t pNotify, void *pContext);
94extern NFCSTATUS phDnldNfc_GetSessionState(pphDnldNfc_Buff_t pSession, pphDnldNfc_RspCb_t pNotify, void *pContext);
95extern NFCSTATUS phDnldNfc_Force(pphDnldNfc_Buff_t pInputs, pphDnldNfc_RspCb_t pNotify,void *pContext);
96extern NFCSTATUS phDnldNfc_Read(pphDnldNfc_Buff_t pData, uint32_t dwRdAddr, pphDnldNfc_RspCb_t pNotify, void *pContext);
97extern NFCSTATUS phDnldNfc_ReadLog(pphDnldNfc_Buff_t pData, pphDnldNfc_RspCb_t pNotify, void *pContext);
98extern NFCSTATUS phDnldNfc_Write(bool_t  bRecoverSeq, pphDnldNfc_Buff_t pData, pphDnldNfc_RspCb_t pNotify, void *pContext);
99extern NFCSTATUS phDnldNfc_Log(pphDnldNfc_Buff_t pData, pphDnldNfc_RspCb_t pNotify, void *pContext);
100extern void phDnldNfc_SetHwDevHandle(void);
101void phDnldNfc_ReSetHwDevHandle(void);
102extern NFCSTATUS phDnldNfc_ReadMem(void *pHwRef, pphDnldNfc_RspCb_t pNotify, void *pContext);
103extern NFCSTATUS phDnldNfc_RawReq(pphDnldNfc_Buff_t pFrameData, pphDnldNfc_Buff_t pRspData, pphDnldNfc_RspCb_t pNotify, void *pContext);
104extern NFCSTATUS phDnldNfc_InitImgInfo(void);
105extern NFCSTATUS phDnldNfc_LoadRecInfo(void);
106extern NFCSTATUS phDnldNfc_LoadPKInfo(void);
107extern void phDnldNfc_CloseFwLibHandle(void);
108extern NFCSTATUS phDnldNfc_LoadFW(const char* pathName, uint8_t **pImgInfo, uint16_t* pImgInfoLen);
109#if(NFC_NXP_CHIP_TYPE != PN547C2)
110extern NFCSTATUS phDnldNfc_LoadRecoveryFW (const char* pathName, uint8_t **pImgInfo, uint16_t* pImgInfoLen);
111#endif
112extern NFCSTATUS phDnldNfc_UnloadFW(void);
113#endif /* PHDNLDNFC_H */
114