1 /** 2 * 3 * \file 4 * 5 * \brief This module contains NMC1000 SPI protocol bus APIs implementation. 6 * 7 * Copyright (c) 2016-2017 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 _NMSPI_H_ 43 #define _NMSPI_H_ 44 45 #include "common/include/nm_common.h" 46 47 #ifdef __cplusplus 48 extern "C" { 49 #endif 50 51 /** 52 * @fn nm_spi_init 53 * @brief Initialize the SPI 54 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 55 */ 56 sint8 nm_spi_init(void); 57 /** 58 * @fn nm_spi_reset 59 * @brief reset the SPI 60 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 61 */ 62 sint8 nm_spi_reset(void); 63 64 /** 65 * @fn nm_spi_deinit 66 * @brief DeInitialize the SPI 67 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 68 */ 69 sint8 nm_spi_deinit(void); 70 71 /** 72 * @fn nm_spi_read_reg 73 * @brief Read register 74 * @param [in] u32Addr 75 * Register address 76 * @return Register value 77 */ 78 uint32 nm_spi_read_reg(uint32 u32Addr); 79 80 /** 81 * @fn nm_spi_read_reg_with_ret 82 * @brief Read register with error code return 83 * @param [in] u32Addr 84 * Register address 85 * @param [out] pu32RetVal 86 * Pointer to u32 variable used to return the read value 87 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 88 */ 89 sint8 nm_spi_read_reg_with_ret(uint32 u32Addr, uint32* pu32RetVal); 90 91 /** 92 * @fn nm_spi_write_reg 93 * @brief write register 94 * @param [in] u32Addr 95 * Register address 96 * @param [in] u32Val 97 * Value to be written to the register 98 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 99 */ 100 sint8 nm_spi_write_reg(uint32 u32Addr, uint32 u32Val); 101 102 /** 103 * @fn nm_spi_read_block 104 * @brief Read block of data 105 * @param [in] u32Addr 106 * Start address 107 * @param [out] puBuf 108 * Pointer to a buffer used to return the read data 109 * @param [in] u16Sz 110 * Number of bytes to read. The buffer size must be >= u16Sz 111 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 112 */ 113 sint8 nm_spi_read_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 114 115 /** 116 * @fn nm_spi_write_block 117 * @brief Write block of data 118 * @param [in] u32Addr 119 * Start address 120 * @param [in] puBuf 121 * Pointer to the buffer holding the data to be written 122 * @param [in] u16Sz 123 * Number of bytes to write. The buffer size must be >= u16Sz 124 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 125 */ 126 sint8 nm_spi_write_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 127 128 #ifdef __cplusplus 129 } 130 #endif 131 132 #endif /* _NMSPI_H_ */ 133
