/**

   \file

   \brief This module contains NMC1000 I2C protocol bus APIs implementation.

   Copyright (c) 2016 Atmel Corporation. All rights reserved.

   \asf_license_start

   \page License

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are met:

   1. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.

   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.

   3. The name of Atmel may not be used to endorse or promote products derived
      from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
   EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
   ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   POSSIBILITY OF SUCH DAMAGE.

   \asf_license_stop

*/

#ifndef _NMI2C_H_
#define _NMI2C_H_

#include "common/include/nm_common.h"

/**
  @fn   nm_i2c_read_reg
  @brief  Read register
  @param [in] u32Addr
        Register address
  @return Register value
*/
uint32 nm_i2c_read_reg(uint32 u32Addr);

/**
  @fn   nm_i2c_read_reg_with_ret
  @brief  Read register with error code return
  @param [in] u32Addr
        Register address
  @param [out]  pu32RetVal
        Pointer to u32 variable used to return the read value
  @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
sint8 nm_i2c_read_reg_with_ret(uint32 u32Addr, uint32* pu32RetVal);

/**
  @fn   nm_i2c_write_reg
  @brief  write register
  @param [in] u32Addr
        Register address
  @param [in] u32Val
        Value to be written to the register
  @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
sint8 nm_i2c_write_reg(uint32 u32Addr, uint32 u32Val);

/**
  @fn   nm_i2c_read_block
  @brief  Read block of data
  @param [in] u32Addr
        Start address
  @param [out]  puBuf
        Pointer to a buffer used to return the read data
  @param [in] u16Sz
        Number of bytes to read. The buffer size must be >= u16Sz
  @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
sint8 nm_i2c_read_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz);

/**
  @fn   nm_i2c_write_block
  @brief  Write block of data
  @param [in] u32Addr
        Start address
  @param [in] puBuf
        Pointer to the buffer holding the data to be written
  @param [in] u16Sz
        Number of bytes to write. The buffer size must be >= u16Sz
  @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure
*/
sint8 nm_i2c_write_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz);

#endif /* _NMI2C_H_ */