struct_i2c_driver(9) [centos man page]

STRUCT 
I2C_DRIVER(9)					      I2C and SMBus Subsystem					      STRUCT I2C_DRIVER(9)

NAME

       struct_i2c_driver - represent an I2C device driver

SYNOPSIS

       struct i2c_driver {
	 unsigned int class;
	 int (* attach_adapter) (struct i2c_adapter *);
	 int (* probe) (struct i2c_client *, const struct i2c_device_id *);
	 int (* remove) (struct i2c_client *);
	 void (* shutdown) (struct i2c_client *);
	 int (* suspend) (struct i2c_client *, pm_message_t mesg);
	 int (* resume) (struct i2c_client *);
	 void (* alert) (struct i2c_client *, unsigned int data);
	 int (* command) (struct i2c_client *client, unsigned int cmd, void *arg);
	 struct device_driver driver;
	 const struct i2c_device_id * id_table;
	 int (* detect) (struct i2c_client *, struct i2c_board_info *);
	 const unsigned short * address_list;
	 struct list_head clients;
       };

MEMBERS

       class
	   What kind of i2c device we instantiate (for detect)

       attach_adapter
	   Callback for bus addition (deprecated)

       probe
	   Callback for device binding

       remove
	   Callback for device unbinding

       shutdown
	   Callback for device shutdown

       suspend
	   Callback for device suspend

       resume
	   Callback for device resume

       alert
	   Alert callback, for example for the SMBus alert protocol

       command
	   Callback for bus-wide signaling (optional)

       driver
	   Device driver model driver

       id_table
	   List of I2C devices supported by this driver

       detect
	   Callback for device detection

       address_list
	   The I2C addresses to probe (for detect)

       clients
	   List of detected clients we created (for i2c-core use only)

DESCRIPTION

       The driver.owner field should be set to the module owner of this driver. The driver.name field should be set to the name of this driver.

       For automatic device detection, both detect and address_list must be defined.  class should also be set, otherwise only devices forced with
       module parameters will be created. The detect function must fill at least the name field of the i2c_board_info structure it is handed upon
       successful detection, and possibly also the flags field.

       If detect is missing, the driver will still work fine for enumerated devices. Detected devices simply won't be supported. This is expected
       for the many I2C/SMBus devices which can't be detected reliably, and the ones which can always be enumerated in practice.

       The i2c_client structure which is handed to the detect callback is not a real i2c_client. It is initialized just enough so that you can
       call i2c_smbus_read_byte_data and friends on it. Don't do anything else with it. In particular, calling dev_dbg and friends on it is not
       allowed.

COPYRIGHT

Kernel Hackers Manual 3.10					     June 2014						      STRUCT I2C_DRIVER(9)

Check Out this Related Man Page

STRUCT 
DEVICE_DRIVER(9) 				   Device drivers infrastructure				   STRUCT DEVICE_DRIVER(9)

NAME

       struct_device_driver - The basic device driver structure

SYNOPSIS

       struct device_driver {
	 const char * name;
	 struct bus_type * bus;
	 struct module * owner;
	 const char * mod_name;
	 bool suppress_bind_attrs;
	 const struct of_device_id * of_match_table;
	 const struct acpi_device_id * acpi_match_table;
	 int (* probe) (struct device *dev);
	 int (* remove) (struct device *dev);
	 void (* shutdown) (struct device *dev);
	 int (* suspend) (struct device *dev, pm_message_t state);
	 int (* resume) (struct device *dev);
	 const struct attribute_group ** groups;
	 const struct dev_pm_ops * pm;
	 struct driver_private * p;
       };

MEMBERS

       name
	   Name of the device driver.

       bus
	   The bus which the device of this driver belongs to.

       owner
	   The module owner.

       mod_name
	   Used for built-in modules.

       suppress_bind_attrs
	   Disables bind/unbind via sysfs.

       of_match_table
	   The open firmware table.

       acpi_match_table
	   The ACPI match table.

       probe
	   Called to query the existence of a specific device, whether this driver can work with it, and bind the driver to a specific device.

       remove
	   Called when the device is removed from the system to unbind a device from this driver.

       shutdown
	   Called at shut-down time to quiesce the device.

       suspend
	   Called to put the device to sleep mode. Usually to a low power state.

       resume
	   Called to bring a device from sleep mode.

       groups
	   Default attributes that get created by the driver core automatically.

       pm
	   Power management operations of the device which matched this driver.

       p
	   Driver core's private data, no one other than the driver core can touch this.

DESCRIPTION

       The device driver-model tracks all of the drivers known to the system. The main reason for this tracking is to enable the driver core to
       match up drivers with new devices. Once drivers are known objects within the system, however, a number of other things become possible.
       Device drivers can export information and configuration variables that are independent of any specific device.

COPYRIGHT

Kernel Hackers Manual 3.10					     June 2014						   STRUCT DEVICE_DRIVER(9)

Linux and UNIX Man Pages

struct_i2c_driver(9) [centos man page]

Check Out this Related Man Page