Nfc.h

00001 /**
00002  ******************************************************************************
00003  * @file    Nfc.h
00004  * @author  ST Central Labs
00005  * @version V1.0.0
00006  * @date    13-April-2015
00007  * @brief   This file contains the abstract class describing the interface of a
00008  *          nfc component.
00009  ******************************************************************************
00010  * @attention
00011  *
00012  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013  *
00014  * Redistribution and use in source and binary forms, with or without modification,
00015  * are permitted provided that the following conditions are met:
00016  *   1. Redistributions of source code must retain the above copyright notice,
00017  *      this list of conditions and the following disclaimer.
00018  *   2. Redistributions in binary form must reproduce the above copyright notice,
00019  *      this list of conditions and the following disclaimer in the documentation
00020  *      and/or other materials provided with the distribution.
00021  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022  *      may be used to endorse or promote products derived from this software
00023  *      without specific prior written permission.
00024  *
00025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035  *
00036  ******************************************************************************
00037  */
00038 
00039 
00040 /* Generated with Stm32CubeTOO -----------------------------------------------*/
00041 
00042 /* Define to prevent from recursive inclusion --------------------------------*/
00043 
00044 #ifndef __NFC_CLASS_H
00045 #define __NFC_CLASS_H
00046 
00047 
00048 /* Includes ------------------------------------------------------------------*/
00049 
00050 #include <Component.h>
00051 
00052 typedef enum {
00053     NFC_SUCCESS = 0,
00054 } NFC_t;
00055 /* Error codes are in component driver */
00056 
00057 
00058 /* Classes  ------------------------------------------------------------------*/
00059 
00060 /**
00061  * An abstract class for Nfc components. 
00062  */
00063 class Nfc : public Component {
00064 public:
00065 
00066     /**
00067      * Read data from the tag.
00068      * @param offset Read offset.
00069      * @param nb_bytes_to_read Number of bytes to read.
00070      * @param[out] p_buffer_read Buffer to store the read data into.
00071      * @return NFC_SUCCESS if no errors 
00072      */
00073     virtual int read_binary(uint16_t offset, uint8_t nb_bytes_to_read, uint8_t *p_buffer_read) = 0;
00074 
00075     /**
00076      * Write data to the tag.
00077      * @param offset Write offset.
00078      * @param nb_bytes_to_write Number of bytes to write.
00079      * @param p_buffer_write Buffer to write.
00080      * @return NFC_SUCCESS if no errors
00081      */
00082     virtual int update_binary(uint16_t offset, uint8_t nb_bytes_to_write, uint8_t *p_buffer_write) = 0;
00083 
00084     /**
00085      * @brief Destructor.
00086      */
00087     virtual ~Nfc() {};
00088 };
00089 
00090 #endif /* __NFC_CLASS_H */
00091 
00092 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/