lib: charset: correct function descriptions

[oweals/u-boot.git] / include / i2c.h

diff --git a/include/i2c.h b/include/i2c.h
index 72e2e8e4260e7f2f270c6c6ce07a4c0f0007c04c..059200115a8e030958350e439c3dc0f37e38c0dd 100644 (file)
--- a/include/i2c.h
+++ b/include/i2c.h
@@ -30,6 +30,32 @@ enum dm_i2c_chip_flags {
        DM_I2C_CHIP_WR_ADDRESS  = 1 << 2, /* Send address for each write byte */
 };
 
+/** enum i2c_speed_mode - standard I2C speed modes */
+enum i2c_speed_mode {
+       IC_SPEED_MODE_STANDARD,
+       IC_SPEED_MODE_FAST,
+       IC_SPEED_MODE_FAST_PLUS,
+       IC_SPEED_MODE_HIGH,
+       IC_SPEED_MODE_FAST_ULTRA,
+
+       IC_SPEED_MODE_COUNT,
+};
+
+/** enum i2c_speed_rate - standard I2C speeds in Hz */
+enum i2c_speed_rate {
+       I2C_SPEED_STANDARD_RATE         = 100000,
+       I2C_SPEED_FAST_RATE             = 400000,
+       I2C_SPEED_FAST_PLUS_RATE        = 1000000,
+       I2C_SPEED_HIGH_RATE             = 3400000,
+       I2C_SPEED_FAST_ULTRA_RATE       = 5000000,
+};
+
+/** enum i2c_address_mode - available address modes */
+enum i2c_address_mode {
+       I2C_MODE_7_BIT,
+       I2C_MODE_10_BIT
+};
+
 struct udevice;
 /**
  * struct dm_i2c_chip - information about an i2c chip
@@ -304,6 +330,24 @@ uint i2c_get_chip_addr_offset_mask(struct udevice *dev);
  */
 int i2c_deblock(struct udevice *bus);
 
+/**
+ * i2c_deblock_gpio_loop() - recover a bus from an unknown state by toggling SDA/SCL
+ *
+ * This is the inner logic used for toggling I2C SDA/SCL lines as GPIOs
+ * for deblocking the I2C bus.
+ *
+ * @sda_pin:   SDA GPIO
+ * @scl_pin:   SCL GPIO
+ * @scl_count: Number of SCL clock cycles generated to deblock SDA
+ * @start_count:Number of I2C start conditions sent after deblocking SDA
+ * @delay:     Delay between SCL clock line changes
+ * @return 0 if OK, -ve on error
+ */
+struct gpio_desc;
+int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin, struct gpio_desc *scl_pin,
+                         unsigned int scl_count, unsigned int start_count,
+                         unsigned int delay);
+
 /**
  * struct dm_i2c_ops - driver operations for I2C uclass
  *