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 
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  ******************************************************************************
76  ** \brief I2C功能配置
77  *****************************************************************************/
78 typedef enum en_i2c_func
79 {
80     I2cModule_En = 6u,  ///<I2C模块使能
81     I2cStart_En  = 5u, ///<开始信号
82     I2cStop_En   = 4u, ///<结束信号
83     I2cAck_En    = 2u, ///<应答信号
84     I2cHlm_En    = 0u, ///<高速使能
85 }en_i2c_func_t;
86 
87  /**
88  ******************************************************************************
89  ** \brief I2C模式配置
90  *****************************************************************************/
91 typedef enum en_i2c_mode
92 {
93     I2cMasterMode = 0x40u,  ///<I2C主机模式
94     I2cSlaveMode  = 0x44u,  ///<I2C从机模式
95 }en_i2c_mode_t;
96 
97 /**
98  ******************************************************************************
99  ** \brief I2C初始化配置结构
100  *****************************************************************************/
101 typedef struct stc_i2c_cfg
102 {
103     uint32_t        u32Pclk;        ///<Pclk 设置(Hz)
104     uint32_t        u32Baud;        ///<I2C通信波特率(Hz)
105     en_i2c_mode_t   enMode;         ///<I2C主从模式配置
106     uint8_t         u8SlaveAddr;    ///<从机地址配置(如果需要)
107     boolean_t       bGc;            ///<广播地址使能(如果需要)
108 }stc_i2c_cfg_t;
109 
110 /******************************************************************************
111  * Global variable declarations ('extern', definition in C source)
112  *****************************************************************************/
113 
114 /******************************************************************************
115  * Global function prototypes (definition in C source)
116  *****************************************************************************/
117  //I2C初始化函数
118  en_result_t I2C_Init(M0P_I2C_TypeDef* I2Cx,stc_i2c_cfg_t *pstcI2CCfg);
119  //设置波特率配置寄存器
120  en_result_t I2C_SetBaud(M0P_I2C_TypeDef* I2Cx,uint8_t u8Tm);
121  //I2C功能设置函数
122  en_result_t I2C_SetFunc(M0P_I2C_TypeDef* I2Cx,en_i2c_func_t enFunc);
123   //I2C功能清除函数
124  en_result_t I2C_ClearFunc(M0P_I2C_TypeDef* I2Cx,en_i2c_func_t enFunc);
125  //获取中断标记SI
126  boolean_t I2C_GetIrq(M0P_I2C_TypeDef* I2Cx);
127   //清除中断标记SI
128  en_result_t I2C_ClearIrq(M0P_I2C_TypeDef* I2Cx);
129  //获取状态
130  uint8_t I2C_GetState(M0P_I2C_TypeDef* I2Cx);
131 
132  //字节写函数
133  en_result_t I2C_WriteByte(M0P_I2C_TypeDef* I2Cx,uint8_t u8Data);
134 
135 //字节读函数
136 uint8_t I2C_ReadByte(M0P_I2C_TypeDef* I2Cx);
137 
138 //@} // I2cGroup
139 
140 #ifdef __cplusplus
141 #endif
142 
143 #endif /* __I2C_H__ */
144 /******************************************************************************
145  * EOF (not truncated)
146  *****************************************************************************/
147 
148 
149