include/linux/regulator/driver.h

   1 /*
   2  * driver.h -- SoC Regulator driver support.
   3  *
   4  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
   5  *
   6  * Author: Liam Girdwood <lg@opensource.wolfsonmicro.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Regulator Driver Interface.
  13  */
  14
  15 #ifndef __LINUX_REGULATOR_DRIVER_H_
  16 #define __LINUX_REGULATOR_DRIVER_H_
  17
  18 #include <linux/device.h>
  19 #include <linux/regulator/consumer.h>
  20
  21 struct regulator_dev;
  22 struct regulator_init_data;
  23
  24 enum regulator_status {
  25         REGULATOR_STATUS_OFF,
  26         REGULATOR_STATUS_ON,
  27         REGULATOR_STATUS_ERROR,
  28         /* fast/normal/idle/standby are flavors of "on" */
  29         REGULATOR_STATUS_FAST,
  30         REGULATOR_STATUS_NORMAL,
  31         REGULATOR_STATUS_IDLE,
  32         REGULATOR_STATUS_STANDBY,
  33 };
  34
  35 /**
  36  * struct regulator_ops - regulator operations.
  37  *
  38  * This struct describes regulator operations which can be implemented by
  39  * regulator chip drivers.
  40  *
  41  * @enable: Enable the regulator.
  42  * @disable: Disable the regulator.
  43  * @is_enabled: Return 1 if the regulator is enabled, 0 otherwise.
  44  *
  45  * @set_voltage: Set the voltage for the regulator within the range specified.
  46  *               The driver should select the voltage closest to min_uV.
  47  * @get_voltage: Return the currently configured voltage for the regulator.
  48  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  49  *      if the selector indicates a voltage that is unusable on this system;
  50  *      or negative errno.  Selectors range from zero to one less than
  51  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  52  *
  53  * @set_current_limit: Configure a limit for a current-limited regulator.
  54  * @get_current_limit: Get the limit for a current-limited regulator.
  55  *
  56  * @set_mode: Set the operating mode for the regulator.
  57  * @get_mode: Get the current operating mode for the regulator.
  58  * @get_optimum_mode: Get the most efficient operating mode for the regulator
  59  *                    when running with the specified parameters.
  60  *
  61  * @set_suspend_voltage: Set the voltage for the regulator when the system
  62  *                       is suspended.
  63  * @set_suspend_enable: Mark the regulator as enabled when the system is
  64  *                      suspended.
  65  * @set_suspend_disable: Mark the regulator as disabled when the system is
  66  *                       suspended.
  67  * @set_suspend_mode: Set the operating mode for the regulator when the
  68  *                    system is suspended.
  69  */
  70 struct regulator_ops {
  71
  72         /* enumerate supported voltages */
  73         int (*list_voltage) (struct regulator_dev *, unsigned selector);
  74
  75         /* get/set regulator voltage */
  76         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV);
  77         int (*get_voltage) (struct regulator_dev *);
  78
  79         /* get/set regulator current  */
  80         int (*set_current_limit) (struct regulator_dev *,
  81                                  int min_uA, int max_uA);
  82         int (*get_current_limit) (struct regulator_dev *);
  83
  84         /* enable/disable regulator */
  85         int (*enable) (struct regulator_dev *);
  86         int (*disable) (struct regulator_dev *);
  87         int (*is_enabled) (struct regulator_dev *);
  88
  89         /* get/set regulator operating mode (defined in regulator.h) */
  90         int (*set_mode) (struct regulator_dev *, unsigned int mode);
  91         unsigned int (*get_mode) (struct regulator_dev *);
  92
  93         /* report regulator status ... most other accessors report
  94          * control inputs, this reports results of combining inputs
  95          * from Linux (and other sources) with the actual load.
  96          */
  97         int (*get_status)(struct regulator_dev *);
  98
  99         /* get most efficient regulator operating mode for load */
 100         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 101                                           int output_uV, int load_uA);
 102
 103         /* the operations below are for configuration of regulator state when
 104          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 105
 106         /* set regulator suspend voltage */
 107         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 108
 109         /* enable/disable regulator in suspend state */
 110         int (*set_suspend_enable) (struct regulator_dev *);
 111         int (*set_suspend_disable) (struct regulator_dev *);
 112
 113         /* set regulator suspend operating mode (defined in regulator.h) */
 114         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 115 };
 116
 117 /*
 118  * Regulators can either control voltage or current.
 119  */
 120 enum regulator_type {
 121         REGULATOR_VOLTAGE,
 122         REGULATOR_CURRENT,
 123 };
 124
 125 /**
 126  * struct regulator_desc - Regulator descriptor
 127  *
 128  * Each regulator registered with the core is described with a structure of
 129  * this type.
 130  *
 131  * @name: Identifying name for the regulator.
 132  * @id: Numerical identifier for the regulator.
 133  * @n_voltages: Number of selectors available for ops.list_voltage().
 134  * @ops: Regulator operations table.
 135  * @irq: Interrupt number for the regulator.
 136  * @type: Indicates if the regulator is a voltage or current regulator.
 137  * @owner: Module providing the regulator, used for refcounting.
 138  */
 139 struct regulator_desc {
 140         const char *name;
 141         int id;
 142         unsigned n_voltages;
 143         struct regulator_ops *ops;
 144         int irq;
 145         enum regulator_type type;
 146         struct module *owner;
 147 };
 148
 149 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
 150         struct device *dev, void *driver_data);
 151 void regulator_unregister(struct regulator_dev *rdev);
 152
 153 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 154                                   unsigned long event, void *data);
 155
 156 void *rdev_get_drvdata(struct regulator_dev *rdev);
 157 struct device *rdev_get_dev(struct regulator_dev *rdev);
 158 int rdev_get_id(struct regulator_dev *rdev);
 159
 160 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 161
 162 #endif