1 /****************************************************************************** 2 * Copyright (C) 2017, Huada Semiconductor Co.,Ltd All rights reserved. 3 * 4 * This software is owned and published by: 5 * Huada Semiconductor Co.,Ltd ("HDSC"). 6 * 7 * BY DOWNLOADING, INSTALLING OR USING THIS SOFTWARE, YOU AGREE TO BE BOUND 8 * BY ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT. 9 * 10 * This software contains source code for use with HDSC 11 * components. This software is licensed by HDSC to be adapted only 12 * for use in systems utilizing HDSC components. HDSC shall not be 13 * responsible for misuse or illegal use of this software for devices not 14 * supported herein. HDSC is providing this software "AS IS" and will 15 * not be responsible for issues arising from incorrect user implementation 16 * of the software. 17 * 18 * Disclaimer: 19 * HDSC MAKES NO WARRANTY, EXPRESS OR IMPLIED, ARISING BY LAW OR OTHERWISE, 20 * REGARDING THE SOFTWARE (INCLUDING ANY ACOOMPANYING WRITTEN MATERIALS), 21 * ITS PERFORMANCE OR SUITABILITY FOR YOUR INTENDED USE, INCLUDING, 22 * WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, THE IMPLIED 23 * WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE, AND THE IMPLIED 24 * WARRANTY OF NONINFRINGEMENT. 25 * HDSC SHALL HAVE NO LIABILITY (WHETHER IN CONTRACT, WARRANTY, TORT, 26 * NEGLIGENCE OR OTHERWISE) FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT 27 * LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, 28 * LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING FROM USE OR 29 * INABILITY TO USE THE SOFTWARE, INCLUDING, WITHOUT LIMITATION, ANY DIRECT, 30 * INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOSS OF DATA, 31 * SAVINGS OR PROFITS, 32 * EVEN IF Disclaimer HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 33 * YOU ASSUME ALL RESPONSIBILITIES FOR SELECTION OF THE SOFTWARE TO ACHIEVE YOUR 34 * INTENDED RESULTS, AND FOR THE INSTALLATION OF, USE OF, AND RESULTS OBTAINED 35 * FROM, THE SOFTWARE. 36 * 37 * This software may be replicated in part or whole for the licensed use, 38 * with the restriction that this Disclaimer and Copyright notice must be 39 * included with each copy of this software, whether used in part or whole, 40 * at all times. 41 */ 42 /*****************************************************************************/ 43 /** \file i2c.h 44 ** 45 ** Headerfile for I2C functions 46 ** 47 ** 48 ** History: 49 ** - 2018-03-1 CJ First Version 50 ** 51 *****************************************************************************/ 52 53 #ifndef __I2C_H__ 54 #define __I2C_H__ 55 56 #include "ddl.h" 57 #include "interrupts_hc32l136.h" 58 59 /** 60 ******************************************************************************* 61 ** \defgroup I2cGroup Inter-Integrated Circuit (I2C) 62 ** 63 ** 64 ******************************************************************************/ 65 //@{ 66 67 /******************************************************************************/ 68 /* Global pre-processor symbols/macros ('#define') */ 69 /******************************************************************************/ 70 /****************************************************************************** 71 * Global type definitions 72 ******************************************************************************/ 73 /** 74 ****************************************************************************** 75 ** \brief I2C通道选择 76 *****************************************************************************/ 77 typedef enum en_i2c_channel 78 { 79 I2C0 = 0,///<通道0 80 I2C1 = 1,///<通道1 81 }en_i2c_channel_t; 82 /** 83 ****************************************************************************** 84 ** \brief I2C功能配置 85 *****************************************************************************/ 86 typedef enum en_i2c_func 87 { 88 I2cMode_En = 0, ///<I2C模块使能 89 I2cStart_En = 1, ///<开始信号 90 I2cStop_En = 2, ///<结束信号 91 I2cAck_En = 3, ///<应答信号 92 I2cHlm_En = 4, ///<高速使能 93 I2cBaud_En = 5, ///<波特率使能 94 }en_i2c_func_t; 95 /** 96 ****************************************************************************** 97 ** \brief I2C从机地址配置 98 *****************************************************************************/ 99 typedef struct stc_i2c_addr 100 { 101 uint8_t Addr; ///<从机模式地址 102 uint8_t Gc; ///<广播地址使能 103 104 }stc_i2c_addr_t; 105 /** 106 ****************************************************************************** 107 ** \brief I2C初始化配置结构 108 *****************************************************************************/ 109 typedef struct stc_i2c_config 110 { 111 en_i2c_func_t enFunc; ///<功能使能 112 uint8_t u8Tm; ///<波特率计数器配置 113 stc_i2c_addr_t stcSlaveAddr;///<从机地址 114 func_ptr_t pfnI2c0Cb; ///<中断服务函数指针 115 func_ptr_t pfnI2c1Cb; 116 boolean_t bTouchNvic; ///<是否使能NVIC 117 }stc_i2c_config_t; 118 119 /****************************************************************************** 120 * Global variable declarations ('extern', definition in C source) 121 *****************************************************************************/ 122 123 /****************************************************************************** 124 * Global function prototypes (definition in C source) 125 *****************************************************************************/ 126 //I2C初始化函数 127 en_result_t I2C_Init(en_i2c_channel_t enCh,stc_i2c_config_t *pstcI2CCfg); 128 //I2C模块关闭函数 129 en_result_t I2C_DeInit(en_i2c_channel_t enCh); 130 //设置波特率配置寄存器 131 en_result_t I2C_SetBaud(en_i2c_channel_t enCh,uint8_t u8Tm); 132 //I2C功能设置函数 133 en_result_t I2C_SetFunc(en_i2c_channel_t enCh,en_i2c_func_t enFunc); 134 //I2C功能清除函数 135 en_result_t I2C_ClearFunc(en_i2c_channel_t enCh,en_i2c_func_t enFunc); 136 //获取中断标记SI 137 boolean_t I2C_GetIrq(en_i2c_channel_t enCh); 138 //清除中断标记SI 139 en_result_t I2C_ClearIrq(en_i2c_channel_t enCh); 140 //获取状态 141 uint8_t I2C_GetState(en_i2c_channel_t enCh); 142 //写从机地址函数 143 en_result_t I2C_WriteSlaveAddr(en_i2c_channel_t enCh,stc_i2c_addr_t *pstcSlaveAddr); 144 //主发送函数 145 en_result_t I2C_MasterWriteData(en_i2c_channel_t enCh,uint8_t u8DevAddr,uint8_t u8Addr,uint8_t *pu8Data,uint32_t u32Len); 146 //从发送函数 147 en_result_t I2C_SlaveWriteData(en_i2c_channel_t enCh,uint8_t *pu8Data,uint32_t *u32Len); 148 //字节写函数 149 en_result_t I2C_WriteByte(en_i2c_channel_t enCh,uint8_t u8Data); 150 //主接收函数 151 en_result_t I2C_MasterReadData(en_i2c_channel_t enCh,uint8_t u8DevAddr,uint8_t *pu8Data,uint8_t u8Addr,uint32_t u32Len); 152 //主接收函数 153 en_result_t I2C_SlaveReadData(en_i2c_channel_t enCh,uint8_t *pu8Data,uint32_t *pu32Len); 154 //字节读函数 155 uint8_t I2C_ReadByte(en_i2c_channel_t enCh); 156 157 //@} // I2cGroup 158 159 #ifdef __cplusplus 160 #endif 161 162 #endif /* __I2C_H__ */ 163 /****************************************************************************** 164 * EOF (not truncated) 165 *****************************************************************************/ 166 167 168