1 /** 2 * 3 * \file 4 * 5 * \brief This module contains NMC1000 UART 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 _NMUART_H_ 43 #define _NMUART_H_ 44 45 #include "common/include/nm_common.h" 46 47 /* 48 * @fn nm_uart_sync_cmd 49 * @brief Check COM Port 50 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 51 */ 52 sint8 nm_uart_sync_cmd(void); 53 /** 54 * @fn nm_uart_read_reg 55 * @brief Read register 56 * @param [in] u32Addr 57 * Register address 58 * @return Register value 59 */ 60 uint32 nm_uart_read_reg(uint32 u32Addr); 61 62 /** 63 * @fn nm_uart_read_reg_with_ret 64 * @brief Read register with error code return 65 * @param [in] u32Addr 66 * Register address 67 * @param [out] pu32RetVal 68 * Pointer to u32 variable used to return the read value 69 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 70 */ 71 sint8 nm_uart_read_reg_with_ret(uint32 u32Addr, uint32* pu32RetVal); 72 73 /** 74 * @fn nm_uart_write_reg 75 * @brief write register 76 * @param [in] u32Addr 77 * Register address 78 * @param [in] u32Val 79 * Value to be written to the register 80 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 81 */ 82 sint8 nm_uart_write_reg(uint32 u32Addr, uint32 u32Val); 83 84 /** 85 * @fn nm_uart_read_block 86 * @brief Read block of data 87 * @param [in] u32Addr 88 * Start address 89 * @param [out] puBuf 90 * Pointer to a buffer used to return the read data 91 * @param [in] u16Sz 92 * Number of bytes to read. The buffer size must be >= u16Sz 93 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 94 */ 95 sint8 nm_uart_read_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 96 97 /** 98 * @fn nm_uart_write_block 99 * @brief Write block of data 100 * @param [in] u32Addr 101 * Start address 102 * @param [in] puBuf 103 * Pointer to the buffer holding the data to be written 104 * @param [in] u16Sz 105 * Number of bytes to write. The buffer size must be >= u16Sz 106 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 107 */ 108 sint8 nm_uart_write_block(uint32 u32Addr, uint8 *puBuf, uint16 u16Sz); 109 110 /** 111 * @fn nm_uart_reconfigure 112 * @brief Reconfigures the UART interface 113 * @param [in] ptr 114 * Pointer to a DWORD containing baudrate at this moment. 115 * @return ZERO in case of success and M2M_ERR_BUS_FAIL in case of failure 116 */ 117 sint8 nm_uart_reconfigure(void *ptr); 118 #endif /* _NMI2C_H_ */ 119