nfa_nv_co.h revision e9df6ba5a8fcccf306a80b1670b423be8fe7746a
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 the synchronization server call-out
22 *  functions.
23 *
24 ******************************************************************************/
25#ifndef NFA_NV_CO_H
26#define NFA_NV_CO_H
27
28#include <time.h>
29
30#include "nfa_api.h"
31
32/*****************************************************************************
33**  Constants and Data Types
34*****************************************************************************/
35
36
37/**************************
38**  Common Definitions
39***************************/
40
41/* Status codes returned by call-out functions, or in call-in functions as status */
42#define NFA_NV_CO_OK            0x00
43#define NFA_NV_CO_FAIL          0x01 /* Used to pass all other errors */
44#define NFA_NV_CO_EACCES        0x02
45#define NFA_NV_CO_ENOTEMPTY     0x03
46#define NFA_NV_CO_EOF           0x04
47#define NFA_NV_CO_EODIR         0x05
48#define NFA_NV_CO_ENOSPACE      0x06 /* Returned in nfa_nv_ci_open if no room */
49#define NFA_NV_CO_EIS_DIR       0x07
50#define NFA_NV_CO_RESUME        0x08 /* used in nfa_nv_ci_open, on resume */
51#define NFA_NV_CO_NONE          0x09 /* used in nfa_nv_ci_open, on resume (no file to resume) */
52
53typedef UINT8 tNFA_NV_CO_STATUS;
54
55
56#define  DH_NV_BLOCK            0x01
57#define  HC_F3_NV_BLOCK         0x02
58#define  HC_F4_NV_BLOCK         0x03
59#define  HC_DH_NV_BLOCK         0x04
60
61/*****************************************************************************
62**  Function Declarations
63*****************************************************************************/
64/**************************
65**  Common Functions
66***************************/
67
68/*******************************************************************************
69**
70** Function         nfa_nv_co_read
71**
72** Description      This function is called by NFA to read in data from the
73**                  previously opened file.
74**
75** Parameters       p_buf   - buffer to read the data into.
76**                  nbytes  - number of bytes to read into the buffer.
77**
78** Returns          void
79**
80**                  Note: Upon completion of the request, nfa_nv_ci_read () is
81**                        called with the buffer of data, along with the number
82**                        of bytes read into the buffer, and a status.  The
83**                        call-in function should only be called when ALL requested
84**                        bytes have been read, the end of file has been detected,
85**                        or an error has occurred.
86**
87*******************************************************************************/
88NFC_API extern void nfa_nv_co_read (UINT8 *p_buf, UINT16 nbytes, UINT8 block);
89
90/*******************************************************************************
91**
92** Function         nfa_nv_co_write
93**
94** Description      This function is called by io to send file data to the
95**                  phone.
96**
97** Parameters       p_buf   - buffer to read the data from.
98**                  nbytes  - number of bytes to write out to the file.
99**
100** Returns          void
101**
102**                  Note: Upon completion of the request, nfa_nv_ci_write () is
103**                        called with the file descriptor and the status.  The
104**                        call-in function should only be called when ALL requested
105**                        bytes have been written, or an error has been detected,
106**
107*******************************************************************************/
108NFC_API extern void nfa_nv_co_write (const UINT8 *p_buf, UINT16 nbytes, UINT8 block);
109
110
111#endif /* NFA_NV_CO_H */
112