Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6b66a6f2 authored by Peter Rosin's avatar Peter Rosin Committed by Wolfram Sang
Browse files

i2c: i2c-mux-gpio: rename i2c-gpio-mux to i2c-mux-gpio 



The rename did the wrong thing for this documentation file all those
years ago. Fix that as well as the neglected rename of the platform
data structure.

Fixes: e7065e20 ("i2c: Rename last mux driver to standard pattern")
Signed-off-by: default avatarPeter Rosin <peda@axentia.se>
Signed-off-by: default avatarWolfram Sang <wsa@the-dreams.de>
parent 45345e9a

Documentation/i2c/muxes/i2c-mux-gpio

+10 −10
Original line number Diff line number Diff line 
Kernel driver i2c-gpio-mux

Kernel driver i2c-mux-gpio



Author: Peter Korsgaard <peter.korsgaard@barco.com>



Description

-----------



i2c-gpio-mux is an i2c mux driver providing access to I2C bus segments

i2c-mux-gpio is an i2c mux driver providing access to I2C bus segments

from a master I2C bus and a hardware MUX controlled through GPIO pins.



E.G.:
@@ -26,16 +26,16 @@ according to the settings of the GPIO pins 1..N. 
Usage

-----



i2c-gpio-mux uses the platform bus, so you need to provide a struct

i2c-mux-gpio uses the platform bus, so you need to provide a struct

platform_device with the platform_data pointing to a struct

gpio_i2cmux_platform_data with the I2C adapter number of the master

i2c_mux_gpio_platform_data with the I2C adapter number of the master

bus, the number of bus segments to create and the GPIO pins used

to control it. See include/linux/i2c-gpio-mux.h for details.

to control it. See include/linux/i2c-mux-gpio.h for details.



E.G. something like this for a MUX providing 4 bus segments

controlled through 3 GPIO pins:



#include <linux/i2c-gpio-mux.h>

#include <linux/i2c-mux-gpio.h>

#include <linux/platform_device.h>



static const unsigned myboard_gpiomux_gpios[] = {
@@ -46,7 +46,7 @@ static const unsigned myboard_gpiomux_values[] = { 
	0, 1, 2, 3

};



static struct gpio_i2cmux_platform_data myboard_i2cmux_data = {

static struct i2c_mux_gpio_platform_data myboard_i2cmux_data = {

	.parent		= 1,

	.base_nr	= 2, /* optional */

	.values		= myboard_gpiomux_values,
@@ -57,7 +57,7 @@ static struct gpio_i2cmux_platform_data myboard_i2cmux_data = { 
};



static struct platform_device myboard_i2cmux = {

	.name		= "i2c-gpio-mux",

	.name		= "i2c-mux-gpio",

	.id		= 0,

	.dev		= {

		.platform_data	= &myboard_i2cmux_data,
@@ -66,14 +66,14 @@ static struct platform_device myboard_i2cmux = { 


If you don't know the absolute GPIO pin numbers at registration time,

you can instead provide a chip name (.chip_name) and relative GPIO pin

numbers, and the i2c-gpio-mux driver will do the work for you,

numbers, and the i2c-mux-gpio driver will do the work for you,

including deferred probing if the GPIO chip isn't immediately

available.



Device Registration

-------------------



When registering your i2c-gpio-mux device, you should pass the number

When registering your i2c-mux-gpio device, you should pass the number

of any GPIO pin it uses as the device ID. This guarantees that every

instance has a different ID.