Messages in this thread Patch in this message | | | From | Octavian Purdila <> | Subject | [PATH v3 2/4] i2c: document struct i2c_adapter | Date | Wed, 15 Oct 2014 23:03:29 +0300 |
| |
Document the i2c_adapter fields that must be initialized before calling i2c_add_adapter().
Signed-off-by: Octavian Purdila <octavian.purdila@intel.com> --- include/linux/i2c.h | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/include/linux/i2c.h b/include/linux/i2c.h index a95efeb..36041e2 100644 --- a/include/linux/i2c.h +++ b/include/linux/i2c.h @@ -418,9 +418,19 @@ int i2c_recover_bus(struct i2c_adapter *adap); int i2c_generic_gpio_recovery(struct i2c_adapter *adap); int i2c_generic_scl_recovery(struct i2c_adapter *adap); -/* - * i2c_adapter is the structure used to identify a physical i2c bus along - * with the access algorithms necessary to access it. +/** + * struct i2c_adapter - represents an I2C physical bus + * + * The following members must be set by the adapter driver before + * calling i2c_add_adapter(): + * + * @owner: the module owner, usually THIS_MODULE + * @class: bitmask of I2C_CLASS_* + * @algo: see struct i2c_algorithm + * @dev.parent: set this to the struct device of the driver (e.g. pci_dev->dev, + * usb->interface->dev, platform_device->dev etc.) + * @name: name of this i2c bus + * @bus_recovery_info: see struct i2c_bus_recovery_info. Optional. */ struct i2c_adapter { struct module *owner; -- 1.9.1
| |