1 /** 2 * 3 * \file 4 * 5 * \brief This module contains NMC1000 I2C protocol bus APIs implementation. 6 * 7 * Copyright (c) 2016 Atmel Corporation. All rights reserved. 8 * 9 * \asf_license_start 10 * 11 * \page License 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions are met: 15 * 16 * 1. Redistributions of source code must retain the above copyright notice, 17 * this list of conditions and the following disclaimer. 18 * 19 * 2. Redistributions in binary form must reproduce the above copyright notice, 20 * this list of conditions and the following disclaimer in the documentation 21 * and/or other materials provided with the distribution. 22 * 23 * 3. The name of Atmel may not be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED 27 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 29 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 34 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 35 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 * 38 * \asf_license_stop 39 * 40 */ 41 42 #ifndef _NMI2C_H_ 43 #define _NMI2C_H_ 44 45 #include "common/include/nm_common.h" 46 47 /** 48 * @fn nm_i2c_read_reg 49 * @brief Read register 50 * @param [in] u32Addr 51 * Register address 52 * @return Register value 53 */ 54 uint32 nm_i2c_read_reg(uint32 u32Addr); 55 56 /** 57 * @fn nm_i2c_read_reg_with_ret 58 * @brief Read register with error code return 59 * @param [in] u32Addr 60 * Register address 61 * @param [out] pu32RetVal 62 * Pointer to u32 variable used to return the read value 63 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 64 */ 65 sint8 nm_i2c_read_reg_with_ret(uint32 u32Addr, uint32* pu32RetVal); 66 67 /** 68 * @fn nm_i2c_write_reg 69 * @brief write register 70 * @param [in] u32Addr 71 * Register address 72 * @param [in] u32Val 73 * Value to be written to the register 74 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 75 */ 76 sint8 nm_i2c_write_reg(uint32 u32Addr, uint32 u32Val); 77 78 /** 79 * @fn nm_i2c_read_block 80 * @brief Read block of data 81 * @param [in] u32Addr 82 * Start address 83 * @param [out] puBuf 84 * Pointer to a buffer used to return the read data 85 * @param [in] u16Sz 86 * Number of bytes to read. The buffer size must be >= u16Sz 87 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 88 */ 89 sint8 nm_i2c_read_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 90 91 /** 92 * @fn nm_i2c_write_block 93 * @brief Write block of data 94 * @param [in] u32Addr 95 * Start address 96 * @param [in] puBuf 97 * Pointer to the buffer holding the data to be written 98 * @param [in] u16Sz 99 * Number of bytes to write. The buffer size must be >= u16Sz 100 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 101 */ 102 sint8 nm_i2c_write_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 103 104 #endif /* _NMI2C_H_ */ 105
