X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fi2c.h;h=22add0b5282ff658b0a45acb463f5ebae2265d9b;hb=d2e5250be49fce4653689c41a5dc7e2d7e7ecf33;hp=07867059f68f2d3c195d7b5ad83a68b19ac963bf;hpb=55dabcc8f24598e2777f663de09ab55fbe1269da;p=platform%2Fkernel%2Fu-boot.git diff --git a/include/i2c.h b/include/i2c.h index 0786705..22add0b 100644 --- a/include/i2c.h +++ b/include/i2c.h @@ -184,7 +184,7 @@ struct i2c_msg_list { * @buffer: Place to put data * @len: Number of bytes to read * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); @@ -198,7 +198,7 @@ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); * @buffer: Buffer containing data to write * @len: Number of bytes to write * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, int len); @@ -214,7 +214,7 @@ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, * @chip_addr: 7-bit address to probe (10-bit and others are not supported) * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags) * @devp: Returns the device found, or NULL if none - * @return 0 if a chip was found at that address, -ve if not + * Return: 0 if a chip was found at that address, -ve if not */ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, struct udevice **devp); @@ -226,7 +226,7 @@ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, * * @dev: Device to use for transfer * @addr: Address to read from - * @return value read, or -ve on error + * Return: value read, or -ve on error */ int dm_i2c_reg_read(struct udevice *dev, uint offset); @@ -238,7 +238,7 @@ int dm_i2c_reg_read(struct udevice *dev, uint offset); * @dev: Device to use for transfer * @addr: Address to write to * @val: Value to write (normally a byte) - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); @@ -252,7 +252,7 @@ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); * @offset: Address for the R/W operation * @clr: Bitmask of bits that should be cleared * @set: Bitmask of bits that should be set - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); @@ -265,7 +265,7 @@ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); * @dev: Device to use for transfer * @msg: List of messages to transfer * @nmsgs: Number of messages to transfer - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); @@ -274,7 +274,7 @@ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); * * @bus: Bus to adjust * @speed: Requested speed in Hz - * @return 0 if OK, -EINVAL for invalid values + * Return: 0 if OK, -EINVAL for invalid values */ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); @@ -282,7 +282,7 @@ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); * dm_i2c_get_bus_speed() - get the speed of a bus * * @bus: Bus to check - * @return speed of selected I2C bus in Hz, -ve on error + * Return: speed of selected I2C bus in Hz, -ve on error */ int dm_i2c_get_bus_speed(struct udevice *bus); @@ -294,7 +294,7 @@ int dm_i2c_get_bus_speed(struct udevice *bus); * * @dev: Chip to adjust * @flags: New flags - * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error + * Return: 0 if OK, -EINVAL if value is unsupported, other -ve value on error */ int i2c_set_chip_flags(struct udevice *dev, uint flags); @@ -303,7 +303,7 @@ int i2c_set_chip_flags(struct udevice *dev, uint flags); * * @dev: Chip to check * @flagsp: Place to put flags - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_get_chip_flags(struct udevice *dev, uint *flagsp); @@ -334,14 +334,14 @@ int i2c_get_chip_offset_len(struct udevice *dev); * function to set the bits that are valid to be used for offset overflow. * * @mask: The mask to be used for high offset bits within address - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_set_chip_addr_offset_mask(struct udevice *dev, uint mask); /* * i2c_get_chip_addr_offset_mask() - get mask of address bits usable by offset * - * @return current chip addr offset mask + * Return: current chip addr offset mask */ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); @@ -351,7 +351,7 @@ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); * See the deblock() method in 'struct dm_i2c_ops' for full information * * @bus: Bus to recover - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int i2c_deblock(struct udevice *bus); @@ -366,7 +366,7 @@ int i2c_deblock(struct udevice *bus); * @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 + * 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, @@ -567,7 +567,7 @@ void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs); * * @dev: Device to find an emulator for * @emulp: Returns the associated emulator, if found * - * @return 0 if OK, -ENOENT or -ENODEV if not found + * Return: 0 if OK, -ENOENT or -ENODEV if not found */ int i2c_emul_find(struct udevice *dev, struct udevice **emulp); @@ -589,7 +589,7 @@ void i2c_emul_set_idx(struct udevice *dev, int emul_idx); * Given an emulator this returns the associated device * * @emul: Emulator for the device - * @return device that @emul is emulating + * Return: device that @emul is emulating */ struct udevice *i2c_emul_get_device(struct udevice *emul); @@ -606,10 +606,14 @@ extern struct acpi_ops i2c_acpi_ops; * properties. * * @dev: I2C device to process - * @return 0 if OK, -EINVAL if acpi,hid is not present + * Return: 0 if OK, -EINVAL if acpi,hid is not present */ int acpi_i2c_of_to_plat(struct udevice *dev); +#ifdef CONFIG_SYS_I2C_EARLY_INIT +void i2c_early_init_f(void); +#endif + #if !CONFIG_IS_ENABLED(DM_I2C) /* @@ -743,22 +747,9 @@ extern struct i2c_bus_hose i2c_bus[]; #endif /* - * Many boards/controllers/drivers don't support an I2C slave interface so - * provide a default slave address for them for use in common code. A real - * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does - * support a slave interface. - */ -#ifndef CONFIG_SYS_I2C_SLAVE -#define CONFIG_SYS_I2C_SLAVE 0xfe -#endif - -/* * Initialization, must be called once on start up, may be called * repeatedly to change the speed and slave addresses. */ -#ifdef CONFIG_SYS_I2C_EARLY_INIT -void i2c_early_init_f(void); -#endif void i2c_init(int speed, int slaveaddr); void i2c_init_board(void); @@ -976,7 +967,7 @@ enum { * Get FDT values for i2c bus. * * @param blob Device tree blbo - * @return the number of I2C bus + * Return: the number of I2C bus */ void board_i2c_init(const void *blob); @@ -985,7 +976,7 @@ void board_i2c_init(const void *blob); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return the number of I2C bus (zero based), or -1 on error + * Return: the number of I2C bus (zero based), or -1 on error */ int i2c_get_bus_num_fdt(int node); @@ -994,7 +985,7 @@ int i2c_get_bus_num_fdt(int node); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return 0 if port was reset, -1 if not found + * Return: 0 if port was reset, -1 if not found */ int i2c_reset_port_fdt(const void *blob, int node);