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