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