nfc_hal_nv_ci.h revision e9629bad30a9f478b336ab46b8e6e02f7f87af46 
1/******************************************************************************
2 *
3 *  Copyright (C) 2003-2014 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 *
22 *  This is the interface file for non valtile memory call-in functions.
23 *
24 ******************************************************************************/
25#ifndef NFC_HAL_NV_CI_H
26#define NFC_HAL_NV_CI_H
27
28#include "nfc_hal_nv_co.h"
29
30
31/*****************************************************************************
32**  Function Declarations
33*****************************************************************************/
34#ifdef __cplusplus
35extern "C"
36{
37#endif
38
39/*******************************************************************************
40**
41** Function         nfc_hal_nv_ci_write
42**
43** Description      This function sends an event to NFAA indicating the phone
44**                  has written the number of bytes specified in the call-out
45**                  function, nfa_nv_co_write (), and is ready for more data.
46**                  This function is used to control the TX data flow.
47**                  Note: The data buffer is released by the stack aioer
48**                        calling this function.
49**
50** Parameters       status - NFA_NV_CO_OK, NFA_NV_CO_NOSPACE, or NFA_NV_CO_FAIL
51**                  evt - Used Internally by NFA -> MUST be same value passed
52**                       in call-out function.
53**
54** Returns          void
55**
56*******************************************************************************/
57void nfc_hal_nv_ci_write (tNFC_HAL_NV_CO_STATUS status);
58
59/*******************************************************************************
60**
61** Function         nfc_hal_nv_ci_read
62**
63** Description      This function sends an event to NCIT indicating the phone has
64**                  read in the requested amount of data specified in the
65**                  nfa_nv_co_read () call-out function.  It should only be called
66**                  when the requested number of bytes has been read.
67**
68** Parameters       num_bytes_read - number of bytes read into the buffer
69**                      specified in the read callout-function.
70**                  status - NFC_HAL_NV_CO_OK if full buffer of data,
71**                           NFC_HAL_NV_CO_EOF if the end of file has been reached,
72**                           NFC_HAL_NV_CO_FAIL if an error has occurred.
73**                  evt - Used Internally by NFA -> MUST be same value passed
74**                       in call-out function.
75**
76** Returns          void
77**
78*******************************************************************************/
79void nfc_hal_nv_ci_read (UINT16                  num_bytes_read,
80                         tNFC_HAL_NV_CO_STATUS   status,
81                         UINT8                   block);
82
83
84#ifdef __cplusplus
85}
86#endif
87
88#endif /* NFC_HAL_NV_CI_H */
89
90