This interface allows regulator drivers to register their voltage and current
regulators with the core. It also has a notifier call chain for propagating
regulator events to clients.
Signed-off-by: Liam Girdwood <[email protected]>
---
include/linux/regulator/regulator-drv.h | 119 +++++++++++++++++++++++++++++++
1 files changed, 119 insertions(+), 0 deletions(-)
create mode 100644 include/linux/regulator/regulator-drv.h
diff --git a/include/linux/regulator/regulator-drv.h b/include/linux/regulator/regulator-drv.h
new file mode 100644
index 0000000..3c9b398
--- /dev/null
+++ b/include/linux/regulator/regulator-drv.h
@@ -0,0 +1,119 @@
+/*
+ * regulator-drv.h -- SoC Regulator support.
+ *
+ * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
+ *
+ * Author: Liam Girdwood <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * Regulator Driver Interface.
+ */
+
+
+#ifndef __LINUX_REGULATOR_DRV_H_
+#define __LINUX_REGULATOR_DRV_H_
+
+#include <linux/device.h>
+#include <linux/regulator/regulator.h>
+
+struct regulator_constraints;
+struct regulator_cdev;
+
+/**
+ * struct regulator_ops - regulator operations.
+ *
+ * This struct describes regulator operations.
+ */
+struct regulator_ops {
+
+ /* get/set regulator voltage */
+ int (*set_voltage)(struct regulator_cdev *, int uV);
+ int (*get_voltage)(struct regulator_cdev *);
+
+ /* get/set regulator current */
+ int (*set_current)(struct regulator_cdev *, int uA);
+ int (*get_current)(struct regulator_cdev *);
+
+ /* enable/disable regulator */
+ int (*enable)(struct regulator_cdev *);
+ int (*disable)(struct regulator_cdev *);
+ int (*is_enabled)(struct regulator_cdev *);
+
+ /* get/set regulator operating mode (defined in regulator.h) */
+ int (*set_mode)(struct regulator_cdev *, unsigned int mode);
+ unsigned int (*get_mode)(struct regulator_cdev *);
+
+ /* get most efficient regulator operating mode for load */
+ unsigned int (*get_optimum_mode)(struct regulator_cdev *, int input_uV,
+ int output_uV, int load_uA);
+};
+
+/*
+ * Regulators can either control voltage or current.
+ */
+enum regulator_type {
+ REGULATOR_VOLTAGE,
+ REGULATOR_CURRENT,
+};
+
+/**
+ * struct regulator_desc - Regulator descriptor
+ *
+ */
+struct regulator_desc {
+ const char *name;
+ int id;
+ struct regulator_ops *ops;
+ int irq;
+ enum regulator_type type;
+ struct module *owner;
+};
+
+/**
+ * regulator_register - register regulator
+ * @regulator: regulator source
+ * @reg_data: private regulator data
+ *
+ * Called by regulator drivers to register a regulator.
+ * Returns 0 on success.
+ */
+struct regulator_cdev *regulator_register(
+ struct regulator_desc *regulator_desc, void *reg_data);
+
+/**
+ * regulator_unregister - unregister regulator
+ * @regulator: regulator source
+ *
+ * Called by regulator drivers to unregister a regulator.
+ */
+void regulator_unregister(struct regulator_cdev *rcdev);
+
+/**
+ * regulator_notifier_call_chain - call regulator event notifier
+ * @regulator: regulator source
+ * @event: notifier block
+ * @data:
+ *
+ * Called by regulator drivers to notify clients a regulator event has
+ * occurred.
+ */
+int regulator_notifier_call_chain(struct regulator_cdev *rcdev,
+ unsigned long event, void *data);
+
+/**
+ * regulator_get_drvdata - get regulator driver data
+ * @regulator: regulator
+ */
+void *rcdev_get_drvdata (struct regulator_cdev *rcdev);
+
+/**
+ * regulator_get_id - get regulator ID
+ * @regulator: regulator
+ */
+int rcdev_get_id (struct regulator_cdev *rcdev);
+
+
+#endif
--
1.5.4.2
On Wed, 20 Feb 2008 17:09:00 +0000 Liam Girdwood <[email protected]> wrote:
> This interface allows regulator drivers to register their voltage and current
> regulators with the core. It also has a notifier call chain for propagating
> regulator events to clients.
>
> +
> +/**
> + * struct regulator_ops - regulator operations.
> + *
> + * This struct describes regulator operations.
> + */
You can actually document the struct's fields in the kerneldoc comment
here, although I tend to think that it's better to document them as you
have done - ther eis more room, and people are more likely to remember to
update the comments when adding/removing/modifying fields.
> +struct regulator_ops {
> +
> + /* get/set regulator voltage */
> + int (*set_voltage)(struct regulator_cdev *, int uV);
> + int (*get_voltage)(struct regulator_cdev *);
> +
> + /* get/set regulator current */
> + int (*set_current)(struct regulator_cdev *, int uA);
> + int (*get_current)(struct regulator_cdev *);
> +
> + /* enable/disable regulator */
> + int (*enable)(struct regulator_cdev *);
> + int (*disable)(struct regulator_cdev *);
> + int (*is_enabled)(struct regulator_cdev *);
> +
> + /* get/set regulator operating mode (defined in regulator.h) */
> + int (*set_mode)(struct regulator_cdev *, unsigned int mode);
> + unsigned int (*get_mode)(struct regulator_cdev *);
> +
> + /* get most efficient regulator operating mode for load */
> + unsigned int (*get_optimum_mode)(struct regulator_cdev *, int input_uV,
> + int output_uV, int load_uA);
> +};
>
> ...
>
> +/**
> + * regulator_get_drvdata - get regulator driver data
> + * @regulator: regulator
> + */
> +void *rcdev_get_drvdata (struct regulator_cdev *rcdev);
> +
> +/**
> + * regulator_get_id - get regulator ID
> + * @regulator: regulator
> + */
> +int rcdev_get_id (struct regulator_cdev *rcdev);
Please use scripts/checkpatch.pl...