1 /*! 2 \file gd32f3x0_i2c.h 3 \brief definitions for the I2C 4 5 \version 2017-06-06, V1.0.0, firmware for GD32F3x0 6 \version 2019-06-01, V2.0.0, firmware for GD32F3x0 7 \version 2020-09-30, V2.1.0, firmware for GD32F3x0 8 */ 9 10 /* 11 Copyright (c) 2020, GigaDevice Semiconductor Inc. 12 13 Redistribution and use in source and binary forms, with or without modification, 14 are permitted provided that the following conditions are met: 15 16 1. Redistributions of source code must retain the above copyright notice, this 17 list of conditions and the following disclaimer. 18 2. Redistributions in binary form must reproduce the above copyright notice, 19 this list of conditions and the following disclaimer in the documentation 20 and/or other materials provided with the distribution. 21 3. Neither the name of the copyright holder nor the names of its contributors 22 may be used to endorse or promote products derived from this software without 23 specific prior written permission. 24 25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 27 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 28 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 29 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 30 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 31 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 32 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 34 OF SUCH DAMAGE. 35 */ 36 37 #ifndef GD32F3X0_I2C_H 38 #define GD32F3X0_I2C_H 39 40 #include "gd32f3x0.h" 41 42 /* I2Cx(x=0,1) definitions */ 43 #define I2C0 I2C_BASE /*!< I2C0 base address */ 44 #define I2C1 (I2C_BASE+0x00000400U) /*!< I2C1 base address */ 45 46 /* registers definitions */ 47 #define I2C_CTL0(i2cx) REG32((i2cx) + 0x00000000U) /*!< I2C control register 0 */ 48 #define I2C_CTL1(i2cx) REG32((i2cx) + 0x00000004U) /*!< I2C control register 1 */ 49 #define I2C_SADDR0(i2cx) REG32((i2cx) + 0x00000008U) /*!< I2C slave address register 0*/ 50 #define I2C_SADDR1(i2cx) REG32((i2cx) + 0x0000000CU) /*!< I2C slave address register */ 51 #define I2C_DATA(i2cx) REG32((i2cx) + 0x00000010U) /*!< I2C transfer buffer register */ 52 #define I2C_STAT0(i2cx) REG32((i2cx) + 0x00000014U) /*!< I2C transfer status register 0 */ 53 #define I2C_STAT1(i2cx) REG32((i2cx) + 0x00000018U) /*!< I2C transfer status register */ 54 #define I2C_CKCFG(i2cx) REG32((i2cx) + 0x0000001CU) /*!< I2C clock configure register */ 55 #define I2C_RT(i2cx) REG32((i2cx) + 0x00000020U) /*!< I2C rise time register */ 56 #define I2C_FMPCFG(i2cx) REG32((i2cx) + 0x00000090U) /*!< I2C fast-mode-plus configure register */ 57 58 /* bits definitions */ 59 /* I2Cx_CTL0 */ 60 #define I2C_CTL0_I2CEN BIT(0) /*!< peripheral enable */ 61 #define I2C_CTL0_SMBEN BIT(1) /*!< SMBus mode */ 62 #define I2C_CTL0_SMBSEL BIT(3) /*!< SMBus type */ 63 #define I2C_CTL0_ARPEN BIT(4) /*!< ARP enable */ 64 #define I2C_CTL0_PECEN BIT(5) /*!< PEC enable */ 65 #define I2C_CTL0_GCEN BIT(6) /*!< general call enable */ 66 #define I2C_CTL0_SS BIT(7) /*!< clock stretching disable (slave mode) */ 67 #define I2C_CTL0_START BIT(8) /*!< start generation */ 68 #define I2C_CTL0_STOP BIT(9) /*!< stop generation */ 69 #define I2C_CTL0_ACKEN BIT(10) /*!< acknowledge enable */ 70 #define I2C_CTL0_POAP BIT(11) /*!< acknowledge/PEC position (for data reception) */ 71 #define I2C_CTL0_PECTRANS BIT(12) /*!< packet error checking */ 72 #define I2C_CTL0_SALT BIT(13) /*!< SMBus alert */ 73 #define I2C_CTL0_SRESET BIT(15) /*!< software reset */ 74 75 /* I2Cx_CTL1 */ 76 #define I2C_CTL1_I2CCLK BITS(0,6) /*!< I2CCLK[6:0] bits (peripheral clock frequency) */ 77 #define I2C_CTL1_ERRIE BIT(8) /*!< error interrupt inable */ 78 #define I2C_CTL1_EVIE BIT(9) /*!< event interrupt enable */ 79 #define I2C_CTL1_BUFIE BIT(10) /*!< buffer interrupt enable */ 80 #define I2C_CTL1_DMAON BIT(11) /*!< DMA requests enable */ 81 #define I2C_CTL1_DMALST BIT(12) /*!< DMA last transfer */ 82 83 /* I2Cx_SADDR0 */ 84 #define I2C_SADDR0_ADDRESS0 BIT(0) /*!< bit 0 of a 10-bit address */ 85 #define I2C_SADDR0_ADDRESS BITS(1,7) /*!< 7-bit address or bits 7:1 of a 10-bit address */ 86 #define I2C_SADDR0_ADDRESS_H BITS(8,9) /*!< highest two bits of a 10-bit address */ 87 #define I2C_SADDR0_ADDFORMAT BIT(15) /*!< address mode for the I2C slave */ 88 89 /* I2Cx_SADDR1 */ 90 #define I2C_SADDR1_DUADEN BIT(0) /*!< aual-address mode switch */ 91 #define I2C_SADDR1_ADDRESS2 BITS(1,7) /*!< second I2C address for the slave in dual-address mode */ 92 93 /* I2Cx_DATA */ 94 #define I2C_DATA_TRB BITS(0,7) /*!< 8-bit data register */ 95 96 /* I2Cx_STAT0 */ 97 #define I2C_STAT0_SBSEND BIT(0) /*!< start bit (master mode) */ 98 #define I2C_STAT0_ADDSEND BIT(1) /*!< address sent (master mode)/matched (slave mode) */ 99 #define I2C_STAT0_BTC BIT(2) /*!< byte transfer finished */ 100 #define I2C_STAT0_ADD10SEND BIT(3) /*!< 10-bit header sent (master mode) */ 101 #define I2C_STAT0_STPDET BIT(4) /*!< stop detection (slave mode) */ 102 #define I2C_STAT0_RBNE BIT(6) /*!< data register not empty (receivers) */ 103 #define I2C_STAT0_TBE BIT(7) /*!< data register empty (transmitters) */ 104 #define I2C_STAT0_BERR BIT(8) /*!< bus error */ 105 #define I2C_STAT0_LOSTARB BIT(9) /*!< arbitration lost (master mode) */ 106 #define I2C_STAT0_AERR BIT(10) /*!< acknowledge failure */ 107 #define I2C_STAT0_OUERR BIT(11) /*!< overrun/underrun */ 108 #define I2C_STAT0_PECERR BIT(12) /*!< PEC error in reception */ 109 #define I2C_STAT0_SMBTO BIT(14) /*!< timeout signal in SMBus mode */ 110 #define I2C_STAT0_SMBALT BIT(15) /*!< SMBus alert status */ 111 112 /* I2Cx_STAT1 */ 113 #define I2C_STAT1_MASTER BIT(0) /*!< master/slave */ 114 #define I2C_STAT1_I2CBSY BIT(1) /*!< bus busy */ 115 #define I2C_STAT1_TR BIT(2) /*!< transmitter/receiver */ 116 #define I2C_STAT1_RXGC BIT(4) /*!< general call address (slave mode) */ 117 #define I2C_STAT1_DEFSMB BIT(5) /*!< SMBus device default address (slave mode) */ 118 #define I2C_STAT1_HSTSMB BIT(6) /*!< SMBus host header (slave mode) */ 119 #define I2C_STAT1_DUMODF BIT(7) /*!< dual flag (slave mode) */ 120 #define I2C_STAT1_PECV BITS(8,15) /*!< packet error checking value */ 121 122 /* I2Cx_CKCFG */ 123 #define I2C_CKCFG_CLKC BITS(0,11) /*!< clock control register in fast/standard mode or fast mode plus(master mode) */ 124 #define I2C_CKCFG_DTCY BIT(14) /*!< duty cycle of fast mode or fast mode plus */ 125 #define I2C_CKCFG_FAST BIT(15) /*!< I2C speed selection in master mode */ 126 127 /* I2Cx_RT */ 128 #define I2C_RT_RISETIME BITS(0,6) /*!< maximum rise time in fast/standard mode or fast mode plus(master mode) */ 129 130 /* I2Cx_FMPCFG */ 131 #define I2C_FMPCFG_FMPEN BIT(0) /*!< fast mode plus enable bit */ 132 133 /* constants definitions */ 134 /* define the I2C bit position and its register index offset */ 135 #define I2C_REGIDX_BIT(regidx, bitpos) (((uint32_t)(regidx) << 6) | (uint32_t)(bitpos)) 136 #define I2C_REG_VAL(i2cx, offset) (REG32((i2cx) + (((uint32_t)(offset) & 0x0000FFFFU) >> 6))) 137 #define I2C_BIT_POS(val) ((uint32_t)(val) & 0x0000001FU) 138 #define I2C_REGIDX_BIT2(regidx, bitpos, regidx2, bitpos2) (((uint32_t)(regidx2) << 22) | (uint32_t)((bitpos2) << 16)\ 139 | (((uint32_t)(regidx) << 6) | (uint32_t)(bitpos))) 140 #define I2C_REG_VAL2(i2cx, offset) (REG32((i2cx) + ((uint32_t)(offset) >> 22))) 141 #define I2C_BIT_POS2(val) (((uint32_t)(val) & 0x001F0000U) >> 16) 142 143 /* register offset */ 144 #define I2C_CTL1_REG_OFFSET (0x00000004U) /*!< CTL1 register offset */ 145 #define I2C_STAT0_REG_OFFSET (0x00000014U) /*!< STAT0 register offset */ 146 #define I2C_STAT1_REG_OFFSET (0x00000018U) /*!< STAT1 register offset */ 147 148 /* I2C flags */ 149 typedef enum 150 { 151 /* flags in STAT0 register */ 152 I2C_FLAG_SBSEND = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 0U), /*!< start condition sent out in master mode */ 153 I2C_FLAG_ADDSEND = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 1U), /*!< address is sent in master mode or received and matches in slave mode */ 154 I2C_FLAG_BTC = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 2U), /*!< byte transmission finishes */ 155 I2C_FLAG_ADD10SEND = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 3U), /*!< header of 10-bit address is sent in master mode */ 156 I2C_FLAG_STPDET = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 4U), /*!< stop condition detected in slave mode */ 157 I2C_FLAG_RBNE = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 6U), /*!< I2C_DATA is not empty during receiving */ 158 I2C_FLAG_TBE = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 7U), /*!< I2C_DATA is empty during transmitting */ 159 I2C_FLAG_BERR = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 8U), /*!< a bus error occurs indication a unexpected start or stop condition on I2C bus */ 160 I2C_FLAG_LOSTARB = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 9U), /*!< arbitration lost in master mode */ 161 I2C_FLAG_AERR = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 10U), /*!< acknowledge error */ 162 I2C_FLAG_OUERR = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 11U), /*!< over-run or under-run situation occurs in slave mode */ 163 I2C_FLAG_PECERR = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 12U), /*!< PEC error when receiving data */ 164 I2C_FLAG_SMBTO = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 14U), /*!< timeout signal in SMBus mode */ 165 I2C_FLAG_SMBALT = I2C_REGIDX_BIT(I2C_STAT0_REG_OFFSET, 15U), /*!< SMBus alert status */ 166 /* flags in STAT1 register */ 167 I2C_FLAG_MASTER = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 0U), /*!< a flag indicating whether I2C block is in master or slave mode */ 168 I2C_FLAG_I2CBSY = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 1U), /*!< busy flag */ 169 I2C_FLAG_TR = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 2U), /*!< whether the I2C is a transmitter or a receiver */ 170 I2C_FLAG_RXGC = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 4U), /*!< general call address (00h) received */ 171 I2C_FLAG_DEFSMB = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 5U), /*!< default address of SMBus device */ 172 I2C_FLAG_HSTSMB = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 6U), /*!< SMBus host header detected in slave mode */ 173 I2C_FLAG_DUMOD = I2C_REGIDX_BIT(I2C_STAT1_REG_OFFSET, 7U) /*!< dual flag in slave mode indicating which address is matched in dual-address mode */ 174 }i2c_flag_enum; 175 176 /* I2C interrupt flags */ 177 typedef enum 178 { 179 /* interrupt flags in CTL1 register */ 180 I2C_INT_FLAG_SBSEND = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 0U), /*!< start condition sent out in master mode interrupt flag */ 181 I2C_INT_FLAG_ADDSEND = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 1U), /*!< address is sent in master mode or received and matches in slave mode interrupt flag */ 182 I2C_INT_FLAG_BTC = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 2U), /*!< byte transmission finishes */ 183 I2C_INT_FLAG_ADD10SEND = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 3U), /*!< header of 10-bit address is sent in master mode interrupt flag */ 184 I2C_INT_FLAG_STPDET = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 4U), /*!< stop condition detected in slave mode interrupt flag */ 185 I2C_INT_FLAG_RBNE = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 6U), /*!< I2C_DATA is not empty during receiving interrupt flag */ 186 I2C_INT_FLAG_TBE = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 9U, I2C_STAT0_REG_OFFSET, 7U), /*!< I2C_DATA is empty during transmitting interrupt flag */ 187 I2C_INT_FLAG_BERR = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 8U), /*!< a bus error occurs indication a unexpected start or stop condition on I2C bus interrupt flag */ 188 I2C_INT_FLAG_LOSTARB = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 9U), /*!< arbitration lost in master mode interrupt flag */ 189 I2C_INT_FLAG_AERR = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 10U), /*!< acknowledge error interrupt flag */ 190 I2C_INT_FLAG_OUERR = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 11U), /*!< over-run or under-run situation occurs in slave mode interrupt flag */ 191 I2C_INT_FLAG_PECERR = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 12U), /*!< PEC error when receiving data interrupt flag */ 192 I2C_INT_FLAG_SMBTO = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 14U), /*!< timeout signal in SMBus mode interrupt flag */ 193 I2C_INT_FLAG_SMBALT = I2C_REGIDX_BIT2(I2C_CTL1_REG_OFFSET, 8U, I2C_STAT0_REG_OFFSET, 15U), /*!< SMBus Alert status interrupt flag */ 194 }i2c_interrupt_flag_enum; 195 196 /* I2C interrupt enable or disable */ 197 typedef enum 198 { 199 /* interrupt in CTL1 register */ 200 I2C_INT_ERR = I2C_REGIDX_BIT(I2C_CTL1_REG_OFFSET, 8U), /*!< error interrupt enable */ 201 I2C_INT_EV = I2C_REGIDX_BIT(I2C_CTL1_REG_OFFSET, 9U), /*!< event interrupt enable */ 202 I2C_INT_BUF = I2C_REGIDX_BIT(I2C_CTL1_REG_OFFSET, 10U), /*!< buffer interrupt enable */ 203 }i2c_interrupt_enum; 204 205 /* SMBus/I2C mode switch and SMBus type selection */ 206 #define I2C_I2CMODE_ENABLE ((uint32_t)0x00000000U) /*!< I2C mode */ 207 #define I2C_SMBUSMODE_ENABLE I2C_CTL0_SMBEN /*!< SMBus mode */ 208 209 /* SMBus/I2C mode switch and SMBus type selection */ 210 #define I2C_SMBUS_DEVICE ((uint32_t)0x00000000U) /*!< SMBus mode device type */ 211 #define I2C_SMBUS_HOST I2C_CTL0_SMBSEL /*!< SMBus mode host type */ 212 213 /* I2C transfer direction */ 214 #define I2C_RECEIVER ((uint32_t)0x00000001U) /*!< receiver */ 215 #define I2C_TRANSMITTER ((uint32_t)0xFFFFFFFEU) /*!< transmitter */ 216 217 /* whether or not to send an ACK */ 218 #define I2C_ACK_DISABLE ((uint32_t)0x00000000U) /*!< ACK will be not sent */ 219 #define I2C_ACK_ENABLE ((uint32_t)0x00000001U) /*!< ACK will be sent */ 220 221 /* I2C POAP position*/ 222 #define I2C_ACKPOS_NEXT ((uint32_t)0x00000000U) /*!< ACKEN bit decides whether or not to send ACK for the next byte */ 223 #define I2C_ACKPOS_CURRENT ((uint32_t)0x00000001U) /*!< ACKEN bit decides whether or not to send ACK or not for the current byte */ 224 225 /* whether or not to stretch SCL low */ 226 #define I2C_SCLSTRETCH_DISABLE I2C_CTL0_SS /*!< SCL stretching is enabled */ 227 #define I2C_SCLSTRETCH_ENABLE ((uint32_t)0x00000000U) /*!< SCL stretching is disabled */ 228 229 /* whether or not to response to a general call */ 230 #define I2C_GCEN_ENABLE I2C_CTL0_GCEN /*!< slave will response to a general call */ 231 #define I2C_GCEN_DISABLE ((uint32_t)0x00000000U) /*!< slave will not response to a general call */ 232 233 /* software reset I2C */ 234 #define I2C_SRESET_SET I2C_CTL0_SRESET /*!< I2C is under reset */ 235 #define I2C_SRESET_RESET ((uint32_t)0x00000000U) /*!< I2C is not under reset */ 236 237 /* I2C DMA mode configure */ 238 /* DMA mode switch */ 239 #define I2C_DMA_ON I2C_CTL1_DMAON /*!< DMA mode enabled */ 240 #define I2C_DMA_OFF ((uint32_t)0x00000000U) /*!< DMA mode disabled */ 241 242 /* flag indicating DMA last transfer */ 243 #define I2C_DMALST_ON I2C_CTL1_DMALST /*!< next DMA EOT is the last transfer */ 244 #define I2C_DMALST_OFF ((uint32_t)0x00000000U) /*!< next DMA EOT is not the last transfer */ 245 246 /* I2C PEC configure */ 247 /* PEC enable */ 248 #define I2C_PEC_ENABLE I2C_CTL0_PECEN /*!< PEC calculation on */ 249 #define I2C_PEC_DISABLE ((uint32_t)0x00000000U) /*!< PEC calculation off */ 250 251 /* PEC transfer */ 252 #define I2C_PECTRANS_ENABLE I2C_CTL0_PECTRANS /*!< transfer PEC */ 253 #define I2C_PECTRANS_DISABLE ((uint32_t)0x00000000U) /*!< not transfer PEC value */ 254 255 /* I2C SMBus configure */ 256 /* issue or not alert through SMBA pin */ 257 #define I2C_SALTSEND_ENABLE I2C_CTL0_SALT /*!< issue alert through SMBA pin */ 258 #define I2C_SALTSEND_DISABLE ((uint32_t)0x00000000U) /*!< not issue alert through SMBA */ 259 260 /* ARP protocol in SMBus switch */ 261 #define I2C_ARP_ENABLE I2C_CTL0_ARPEN /*!< ARP enable */ 262 #define I2C_ARP_DISABLE ((uint32_t)0x00000000U) /*!< ARP disable */ 263 264 /* fast mode plus enable */ 265 #define I2C_FAST_MODE_PLUS_ENABLE I2C_FMPCFG_FMPEN /*!< fast mode plus enable */ 266 #define I2C_FAST_MODE_PLUS_DISABLE ((uint32_t)0x00000000U) /*!< fast mode plus disable */ 267 268 /* transmit I2C data */ 269 #define DATA_TRANS(regval) (BITS(0,7) & ((uint32_t)(regval) << 0)) 270 271 /* receive I2C data */ 272 #define DATA_RECV(regval) GET_BITS((uint32_t)(regval), 0, 7) 273 274 /* I2C duty cycle in fast mode or fast mode plus */ 275 #define I2C_DTCY_2 ((uint32_t)0x00000000U) /*!< in I2C fast mode or fast mode plus Tlow/Thigh = 2 */ 276 #define I2C_DTCY_16_9 I2C_CKCFG_DTCY /*!< in I2C fast mode or fast mode plus Tlow/Thigh = 16/9 */ 277 278 /* address mode for the I2C slave */ 279 #define I2C_ADDFORMAT_7BITS ((uint32_t)0x00000000U) /*!< address:7 bits */ 280 #define I2C_ADDFORMAT_10BITS I2C_SADDR0_ADDFORMAT /*!< address:10 bits */ 281 282 /* I2C clock frequency, MHz */ 283 #define I2CCLK_MAX ((uint32_t)0x0000003FU) /*!< i2cclk maximum value */ 284 #define I2CCLK_MIN ((uint32_t)0x00000002U) /*!< i2cclk minimum value for standard mode */ 285 #define I2CCLK_FM_MIN ((uint32_t)0x00000008U) /*!< i2cclk minimum value for fast mode */ 286 #define I2CCLK_FM_PLUS_MIN ((uint32_t)0x00000018U) /*!< i2cclk minimum value for fast mode plus */ 287 288 /* function declarations */ 289 /* reset I2C */ 290 void i2c_deinit(uint32_t i2c_periph); 291 /* configure I2C clock */ 292 void i2c_clock_config(uint32_t i2c_periph, uint32_t clkspeed, uint32_t dutycyc); 293 /* configure I2C address */ 294 void i2c_mode_addr_config(uint32_t i2c_periph, uint32_t mode, uint32_t addformat, uint32_t addr); 295 /* SMBus type selection */ 296 void i2c_smbus_type_config(uint32_t i2c_periph, uint32_t type); 297 /* whether or not to send an ACK */ 298 void i2c_ack_config(uint32_t i2c_periph, uint32_t ack); 299 /* configure I2C position of ACK and PEC when receiving */ 300 void i2c_ackpos_config(uint32_t i2c_periph, uint32_t pos); 301 /* master sends slave address */ 302 void i2c_master_addressing(uint32_t i2c_periph, uint32_t addr, uint32_t trandirection); 303 /* enable dual-address mode */ 304 void i2c_dualaddr_enable(uint32_t i2c_periph, uint32_t addr); 305 /* disable dual-address mode */ 306 void i2c_dualaddr_disable(uint32_t i2c_periph); 307 /* enable I2C */ 308 void i2c_enable(uint32_t i2c_periph); 309 /* disable I2C */ 310 void i2c_disable(uint32_t i2c_periph); 311 312 /* generate a START condition on I2C bus */ 313 void i2c_start_on_bus(uint32_t i2c_periph); 314 /* generate a STOP condition on I2C bus */ 315 void i2c_stop_on_bus(uint32_t i2c_periph); 316 /* I2C transmit data function */ 317 void i2c_data_transmit(uint32_t i2c_periph, uint8_t data); 318 /* I2C receive data function */ 319 uint8_t i2c_data_receive(uint32_t i2c_periph); 320 /* enable I2C DMA mode */ 321 void i2c_dma_enable(uint32_t i2c_periph, uint32_t dmastate); 322 /* configure whether next DMA EOT is DMA last transfer or not */ 323 void i2c_dma_last_transfer_config(uint32_t i2c_periph, uint32_t dmalast); 324 /* whether to stretch SCL low when data is not ready in slave mode */ 325 void i2c_stretch_scl_low_config(uint32_t i2c_periph, uint32_t stretchpara); 326 /* whether or not to response to a general call */ 327 void i2c_slave_response_to_gcall_config(uint32_t i2c_periph, uint32_t gcallpara); 328 /* software reset I2C */ 329 void i2c_software_reset_config(uint32_t i2c_periph, uint32_t sreset); 330 331 /* whether to enable I2C PEC calculation or not */ 332 void i2c_pec_enable(uint32_t i2c_periph, uint32_t pecstate); 333 /* I2C whether to transfer PEC value */ 334 void i2c_pec_transfer_enable(uint32_t i2c_periph, uint32_t pecpara); 335 /* packet error checking value */ 336 uint8_t i2c_pec_value_get(uint32_t i2c_periph); 337 /* I2C issue alert through SMBA pin */ 338 void i2c_smbus_issue_alert(uint32_t i2c_periph, uint32_t smbuspara); 339 /* whether ARP is enabled under SMBus */ 340 void i2c_smbus_arp_enable(uint32_t i2c_periph, uint32_t arpstate); 341 342 /* check I2C flag is set or not */ 343 FlagStatus i2c_flag_get(uint32_t i2c_periph, i2c_flag_enum flag); 344 /* clear I2C flag */ 345 void i2c_flag_clear(uint32_t i2c_periph, i2c_flag_enum flag); 346 /* enable I2C interrupt */ 347 void i2c_interrupt_enable(uint32_t i2c_periph, i2c_interrupt_enum interrupt); 348 /* disable I2C interrupt */ 349 void i2c_interrupt_disable(uint32_t i2c_periph, i2c_interrupt_enum interrupt); 350 /* check I2C interrupt flag */ 351 FlagStatus i2c_interrupt_flag_get(uint32_t i2c_periph, i2c_interrupt_flag_enum int_flag); 352 /* clear I2C interrupt flag */ 353 void i2c_interrupt_flag_clear(uint32_t i2c_periph, i2c_interrupt_flag_enum int_flag); 354 355 #endif /* GD32F3X0_I2C_H */ 356
