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

Commit 1ed81114 authored by Nicolas Boichat's avatar Nicolas Boichat Committed by Mark Brown
Browse files

regmap: Move documentation to regmap.h 



Init functions defined in regmap*.c files are now prefixed with
__, take lockdep key and class parameters, and should not be
called directly: move the documentation to regmap.h, where the
macros are defined.

Signed-off-by: default avatarNicolas Boichat <drinkcat@chromium.org>
Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 3cfe7a74

drivers/base/regmap/regmap-ac97.c

+0 −19
Original line number Diff line number Diff line
@@ -78,15 +78,6 @@ static const struct regmap_bus ac97_regmap_bus = { 
	.reg_read = regmap_ac97_reg_read,

};



/**

 * regmap_init_ac97(): Initialise AC'97 register map

 *

 * @ac97: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,

				  const struct regmap_config *config,

				  struct lock_class_key *lock_key,
@@ -97,16 +88,6 @@ struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97, 
}

EXPORT_SYMBOL_GPL(__regmap_init_ac97);



/**

 * devm_regmap_init_ac97(): Initialise AC'97 register map

 *

 * @ac97: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The regmap will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,

				       const struct regmap_config *config,

				       struct lock_class_key *lock_key,

drivers/base/regmap/regmap-i2c.c

+0 −19
Original line number Diff line number Diff line
@@ -233,15 +233,6 @@ static const struct regmap_bus *regmap_get_i2c_bus(struct i2c_client *i2c, 
	return ERR_PTR(-ENOTSUPP);

}



/**

 * regmap_init_i2c(): Initialise register map

 *

 * @i2c: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_i2c(struct i2c_client *i2c,

				 const struct regmap_config *config,

				 struct lock_class_key *lock_key,
@@ -257,16 +248,6 @@ struct regmap *__regmap_init_i2c(struct i2c_client *i2c, 
}

EXPORT_SYMBOL_GPL(__regmap_init_i2c);



/**

 * devm_regmap_init_i2c(): Initialise managed register map

 *

 * @i2c: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The regmap will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,

				      const struct regmap_config *config,

				      struct lock_class_key *lock_key,

drivers/base/regmap/regmap-mmio.c

+0 −23
Original line number Diff line number Diff line
@@ -296,17 +296,6 @@ static struct regmap_mmio_context *regmap_mmio_gen_context(struct device *dev, 
	return ERR_PTR(ret);

}



/**

 * regmap_init_mmio_clk(): Initialise register map with register clock

 *

 * @dev: Device that will be interacted with

 * @clk_id: register clock consumer ID

 * @regs: Pointer to memory-mapped IO region

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,

				      void __iomem *regs,

				      const struct regmap_config *config,
@@ -324,18 +313,6 @@ struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id, 
}

EXPORT_SYMBOL_GPL(__regmap_init_mmio_clk);



/**

 * devm_regmap_init_mmio_clk(): Initialise managed register map with clock

 *

 * @dev: Device that will be interacted with

 * @clk_id: register clock consumer ID

 * @regs: Pointer to memory-mapped IO region

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The regmap will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,

					   const char *clk_id,

					   void __iomem *regs,

drivers/base/regmap/regmap-spi.c

+0 −19
Original line number Diff line number Diff line
@@ -113,15 +113,6 @@ static struct regmap_bus regmap_spi = { 
	.val_format_endian_default = REGMAP_ENDIAN_BIG,

};



/**

 * regmap_init_spi(): Initialise register map

 *

 * @spi: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_spi(struct spi_device *spi,

				 const struct regmap_config *config,

				 struct lock_class_key *lock_key,
@@ -132,16 +123,6 @@ struct regmap *__regmap_init_spi(struct spi_device *spi, 
}

EXPORT_SYMBOL_GPL(__regmap_init_spi);



/**

 * devm_regmap_init_spi(): Initialise register map

 *

 * @spi: Device that will be interacted with

 * @config: Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The map will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_spi(struct spi_device *spi,

				      const struct regmap_config *config,

				      struct lock_class_key *lock_key,

drivers/base/regmap/regmap-spmi.c

+0 −34
Original line number Diff line number Diff line
@@ -91,14 +91,6 @@ static struct regmap_bus regmap_spmi_base = { 
	.val_format_endian_default	= REGMAP_ENDIAN_NATIVE,

};



/**

 * regmap_init_spmi_base(): Create regmap for the Base register space

 * @sdev:	SPMI device that will be interacted with

 * @config:	Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_spmi_base(struct spmi_device *sdev,

				       const struct regmap_config *config,

				       struct lock_class_key *lock_key,
@@ -109,15 +101,6 @@ struct regmap *__regmap_init_spmi_base(struct spmi_device *sdev, 
}

EXPORT_SYMBOL_GPL(__regmap_init_spmi_base);



/**

 * devm_regmap_init_spmi_base(): Create managed regmap for Base register space

 * @sdev:	SPMI device that will be interacted with

 * @config:	Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The regmap will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *sdev,

					    const struct regmap_config *config,

					    struct lock_class_key *lock_key,
@@ -228,14 +211,6 @@ static struct regmap_bus regmap_spmi_ext = { 
	.val_format_endian_default	= REGMAP_ENDIAN_NATIVE,

};



/**

 * regmap_init_spmi_ext(): Create regmap for Ext register space

 * @sdev:	Device that will be interacted with

 * @config:	Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer to

 * a struct regmap.

 */

struct regmap *__regmap_init_spmi_ext(struct spmi_device *sdev,

				      const struct regmap_config *config,

				      struct lock_class_key *lock_key,
@@ -246,15 +221,6 @@ struct regmap *__regmap_init_spmi_ext(struct spmi_device *sdev, 
}

EXPORT_SYMBOL_GPL(__regmap_init_spmi_ext);



/**

 * devm_regmap_init_spmi_ext(): Create managed regmap for Ext register space

 * @sdev:	SPMI device that will be interacted with

 * @config:	Configuration for register map

 *

 * The return value will be an ERR_PTR() on error or a valid pointer

 * to a struct regmap.  The regmap will be automatically freed by the

 * device management code.

 */

struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *sdev,

					   const struct regmap_config *config,

					   struct lock_class_key *lock_key,