• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /******************************************************************************
2  *
3  *  Copyright (C) 2003-2012 Broadcom Corporation
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at:
8  *
9  *  http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  ******************************************************************************/
18 
19 /******************************************************************************
20  *
21  *  This is the interface file for storing nv data
22  *
23  ******************************************************************************/
24 #ifndef NFC_HAL_NV_CO_H
25 #define NFC_HAL_NV_CO_H
26 
27 #include <time.h>
28 
29 
30 /*****************************************************************************
31 **  Constants and Data Types
32 *****************************************************************************/
33 
34 
35 /**************************
36 **  Common Definitions
37 ***************************/
38 
39 /* Status codes returned by call-out functions, or in call-in functions as status */
40 #define NFC_HAL_NV_CO_OK            0x00
41 #define NFC_HAL_NV_CO_FAIL          0x01 /* Used to pass all other errors */
42 #define NFC_HAL_NV_CO_EACCES        0x02
43 #define NFC_HAL_NV_CO_ENOTEMPTY     0x03
44 #define NFC_HAL_NV_CO_EOF           0x04
45 #define NFC_HAL_NV_CO_EODIR         0x05
46 #define NFC_HAL_NV_CO_ENOSPACE      0x06 /* Returned in nfa_nv_ci_open if no room */
47 #define NFC_HAL_NV_CO_EIS_DIR       0x07
48 #define NFC_HAL_NV_CO_RESUME        0x08 /* used in nfa_nv_ci_open, on resume */
49 #define NFC_HAL_NV_CO_NONE          0x09 /* used in nfa_nv_ci_open, on resume (no file to resume) */
50 
51 typedef UINT8 tNFC_HAL_NV_CO_STATUS;
52 
53 #define  DH_NV_BLOCK            0x01
54 #define  HC_F3_NV_BLOCK         0x02
55 #define  HC_F4_NV_BLOCK         0x03
56 #define  HC_DH_NV_BLOCK         0x04
57 
58 /*****************************************************************************
59 **  Function Declarations
60 *****************************************************************************/
61 /**************************
62 **  Common Functions
63 ***************************/
64 
65 /*******************************************************************************
66 **
67 ** Function         nfc_hal_nv_co_read
68 **
69 ** Description      This function is called by NFA to read in data from the
70 **                  previously opened file.
71 **
72 ** Parameters       p_buf   - buffer to read the data into.
73 **                  nbytes  - number of bytes to read into the buffer.
74 **
75 ** Returns          void
76 **
77 **                  Note: Upon completion of the request, nfa_nv_ci_read () is
78 **                        called with the buffer of data, along with the number
79 **                        of bytes read into the buffer, and a status.  The
80 **                        call-in function should only be called when ALL requested
81 **                        bytes have been read, the end of file has been detected,
82 **                        or an error has occurred.
83 **
84 *******************************************************************************/
85 void nfc_hal_nv_co_read (UINT8 *p_buf, UINT16 nbytes, UINT8 block);
86 
87 /*******************************************************************************
88 **
89 ** Function         nfc_hal_nv_co_write
90 **
91 ** Description      This function is called by io to send file data to the
92 **                  phone.
93 **
94 ** Parameters       p_buf   - buffer to read the data from.
95 **                  nbytes  - number of bytes to write out to the file.
96 **
97 ** Returns          void
98 **
99 **                  Note: Upon completion of the request, nfa_nv_ci_write () is
100 **                        called with the file descriptor and the status.  The
101 **                        call-in function should only be called when ALL requested
102 **                        bytes have been written, or an error has been detected,
103 **
104 *******************************************************************************/
105 void nfc_hal_nv_co_write (const UINT8 *p_buf, UINT16 nbytes, UINT8 block);
106 
107 
108 #endif /* NFC_HAL_NV_CO_H */
109