2008-04-30 10:46:09 -04:00
|
|
|
/*
|
|
|
|
* machine.h -- SoC Regulator support, machine/board driver API.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
|
|
|
|
*
|
|
|
|
* Author: Liam Girdwood <lg@opensource.wolfsonmicro.com>
|
|
|
|
*
|
|
|
|
* 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 Machine/Board Interface.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __LINUX_REGULATOR_MACHINE_H_
|
|
|
|
#define __LINUX_REGULATOR_MACHINE_H_
|
|
|
|
|
|
|
|
#include <linux/regulator/consumer.h>
|
|
|
|
#include <linux/suspend.h>
|
|
|
|
|
|
|
|
struct regulator;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Regulator operation constraint flags. These flags are used to enable
|
|
|
|
* certain regulator operations and can be OR'ed together.
|
|
|
|
*
|
|
|
|
* VOLTAGE: Regulator output voltage can be changed by software on this
|
|
|
|
* board/machine.
|
|
|
|
* CURRENT: Regulator output current can be changed by software on this
|
|
|
|
* board/machine.
|
|
|
|
* MODE: Regulator operating mode can be changed by software on this
|
|
|
|
* board/machine.
|
|
|
|
* STATUS: Regulator can be enabled and disabled.
|
|
|
|
* DRMS: Dynamic Regulator Mode Switching is enabled for this regulator.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define REGULATOR_CHANGE_VOLTAGE 0x1
|
|
|
|
#define REGULATOR_CHANGE_CURRENT 0x2
|
|
|
|
#define REGULATOR_CHANGE_MODE 0x4
|
|
|
|
#define REGULATOR_CHANGE_STATUS 0x8
|
|
|
|
#define REGULATOR_CHANGE_DRMS 0x10
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct regulator_state - regulator state during low power syatem states
|
|
|
|
*
|
|
|
|
* This describes a regulators state during a system wide low power state.
|
|
|
|
*/
|
|
|
|
struct regulator_state {
|
|
|
|
int uV; /* suspend voltage */
|
|
|
|
unsigned int mode; /* suspend regulator operating mode */
|
|
|
|
int enabled; /* is regulator enabled in this suspend state */
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct regulation_constraints - regulator operating constraints.
|
|
|
|
*
|
|
|
|
* This struct describes regulator and board/machine specific constraints.
|
|
|
|
*/
|
|
|
|
struct regulation_constraints {
|
|
|
|
|
|
|
|
char *name;
|
|
|
|
|
|
|
|
/* voltage output range (inclusive) - for voltage control */
|
|
|
|
int min_uV;
|
|
|
|
int max_uV;
|
|
|
|
|
|
|
|
/* current output range (inclusive) - for current control */
|
|
|
|
int min_uA;
|
|
|
|
int max_uA;
|
|
|
|
|
|
|
|
/* valid regulator operating modes for this machine */
|
|
|
|
unsigned int valid_modes_mask;
|
|
|
|
|
|
|
|
/* valid operations for regulator on this machine */
|
|
|
|
unsigned int valid_ops_mask;
|
|
|
|
|
|
|
|
/* regulator input voltage - only if supply is another regulator */
|
|
|
|
int input_uV;
|
|
|
|
|
|
|
|
/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
|
|
|
|
struct regulator_state state_disk;
|
|
|
|
struct regulator_state state_mem;
|
|
|
|
struct regulator_state state_standby;
|
|
|
|
suspend_state_t initial_state; /* suspend state to set at init */
|
|
|
|
|
|
|
|
/* constriant flags */
|
|
|
|
unsigned always_on:1; /* regulator never off when system is on */
|
|
|
|
unsigned boot_on:1; /* bootloader/firmware enabled regulator */
|
|
|
|
unsigned apply_uV:1; /* apply uV constraint iff min == max */
|
|
|
|
};
|
|
|
|
|
regulator: core - Rework machine API to remove string based functions.
This improves the machine level API in order to configure
regulator constraints and consumers as platform data and removes the
old string based API that required several calls to set up each regulator.
The intention is to create a struct regulator_init_data, populate
it's fields with constraints, consumers devices, etc and then register
the regulator device from board.c in the standard Linux way.
e.g. regulator LDO2 (supplying codec and sim) platform data.
/* regulator LDO2 consumer devices */
static struct regulator_consumer_supply ldo2_consumers[] = {
{
.dev = &platform_audio_device.dev,
.supply = "codec_avdd",
},
{
.dev = &platform_sim_device.dev,
.supply = "sim_vcc",
}
};
/* regulator LDO2 constraints */
static struct regulator_init_data ldo2_data = {
.constraints = {
.min_uV = 3300000,
.max_uV = 3300000,
.valid_modes_mask = REGULATOR_MODE_NORMAL,
.apply_uV = 1,
},
.num_consumer_supplies = ARRAY_SIZE(ldo2_consumers),
.consumer_supplies = ldo2_consumers,
};
/* machine regulator devices with thier consumers and constraints */
static struct platform_device wm8350_regulator_devices[] = {
{
.name = "wm8350-regulator",
.id = WM8350_LDO_2,
.dev = {
.platform_data = &ldo2_data,
},
},
};
Changes in detail:-
o Removed all const char* regulator config functions in machine API.
o Created new struct regulator_init_data to contain regulator
machine configuration constraints and consmuers.
o Changed set_supply(), set_machine_constraints(),
set_consumer_device_supply() to remove their string identifier
parameters. Also made them static and moved functions nearer top of
core.c.
o Removed no longer used inline func to_rdev()
o Added regulator_get_init_drvdata() to retrieve init data.
o Added struct device* as parameter to regulator_register().
o Changed my email address.
Signed-off-by: Eric Miao <eric.miao@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2008-10-10 08:22:20 -04:00
|
|
|
/**
|
|
|
|
* struct regulator_consumer_supply - supply -> device mapping
|
|
|
|
*
|
|
|
|
* This maps a supply name to a device.
|
|
|
|
*/
|
|
|
|
struct regulator_consumer_supply {
|
|
|
|
struct device *dev; /* consumer */
|
|
|
|
const char *supply; /* consumer supply - e.g. "vcc" */
|
|
|
|
};
|
2008-04-30 10:46:09 -04:00
|
|
|
|
regulator: core - Rework machine API to remove string based functions.
This improves the machine level API in order to configure
regulator constraints and consumers as platform data and removes the
old string based API that required several calls to set up each regulator.
The intention is to create a struct regulator_init_data, populate
it's fields with constraints, consumers devices, etc and then register
the regulator device from board.c in the standard Linux way.
e.g. regulator LDO2 (supplying codec and sim) platform data.
/* regulator LDO2 consumer devices */
static struct regulator_consumer_supply ldo2_consumers[] = {
{
.dev = &platform_audio_device.dev,
.supply = "codec_avdd",
},
{
.dev = &platform_sim_device.dev,
.supply = "sim_vcc",
}
};
/* regulator LDO2 constraints */
static struct regulator_init_data ldo2_data = {
.constraints = {
.min_uV = 3300000,
.max_uV = 3300000,
.valid_modes_mask = REGULATOR_MODE_NORMAL,
.apply_uV = 1,
},
.num_consumer_supplies = ARRAY_SIZE(ldo2_consumers),
.consumer_supplies = ldo2_consumers,
};
/* machine regulator devices with thier consumers and constraints */
static struct platform_device wm8350_regulator_devices[] = {
{
.name = "wm8350-regulator",
.id = WM8350_LDO_2,
.dev = {
.platform_data = &ldo2_data,
},
},
};
Changes in detail:-
o Removed all const char* regulator config functions in machine API.
o Created new struct regulator_init_data to contain regulator
machine configuration constraints and consmuers.
o Changed set_supply(), set_machine_constraints(),
set_consumer_device_supply() to remove their string identifier
parameters. Also made them static and moved functions nearer top of
core.c.
o Removed no longer used inline func to_rdev()
o Added regulator_get_init_drvdata() to retrieve init data.
o Added struct device* as parameter to regulator_register().
o Changed my email address.
Signed-off-by: Eric Miao <eric.miao@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2008-10-10 08:22:20 -04:00
|
|
|
/**
|
|
|
|
* struct regulator_init_data - regulator platform initialisation data.
|
|
|
|
*
|
|
|
|
* Initialisation constraints, our supply and consumers supplies.
|
|
|
|
*/
|
|
|
|
struct regulator_init_data {
|
|
|
|
struct device *supply_regulator_dev; /* or NULL for LINE */
|
2008-04-30 10:46:09 -04:00
|
|
|
|
regulator: core - Rework machine API to remove string based functions.
This improves the machine level API in order to configure
regulator constraints and consumers as platform data and removes the
old string based API that required several calls to set up each regulator.
The intention is to create a struct regulator_init_data, populate
it's fields with constraints, consumers devices, etc and then register
the regulator device from board.c in the standard Linux way.
e.g. regulator LDO2 (supplying codec and sim) platform data.
/* regulator LDO2 consumer devices */
static struct regulator_consumer_supply ldo2_consumers[] = {
{
.dev = &platform_audio_device.dev,
.supply = "codec_avdd",
},
{
.dev = &platform_sim_device.dev,
.supply = "sim_vcc",
}
};
/* regulator LDO2 constraints */
static struct regulator_init_data ldo2_data = {
.constraints = {
.min_uV = 3300000,
.max_uV = 3300000,
.valid_modes_mask = REGULATOR_MODE_NORMAL,
.apply_uV = 1,
},
.num_consumer_supplies = ARRAY_SIZE(ldo2_consumers),
.consumer_supplies = ldo2_consumers,
};
/* machine regulator devices with thier consumers and constraints */
static struct platform_device wm8350_regulator_devices[] = {
{
.name = "wm8350-regulator",
.id = WM8350_LDO_2,
.dev = {
.platform_data = &ldo2_data,
},
},
};
Changes in detail:-
o Removed all const char* regulator config functions in machine API.
o Created new struct regulator_init_data to contain regulator
machine configuration constraints and consmuers.
o Changed set_supply(), set_machine_constraints(),
set_consumer_device_supply() to remove their string identifier
parameters. Also made them static and moved functions nearer top of
core.c.
o Removed no longer used inline func to_rdev()
o Added regulator_get_init_drvdata() to retrieve init data.
o Added struct device* as parameter to regulator_register().
o Changed my email address.
Signed-off-by: Eric Miao <eric.miao@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2008-10-10 08:22:20 -04:00
|
|
|
struct regulation_constraints constraints;
|
2008-04-30 10:46:09 -04:00
|
|
|
|
regulator: core - Rework machine API to remove string based functions.
This improves the machine level API in order to configure
regulator constraints and consumers as platform data and removes the
old string based API that required several calls to set up each regulator.
The intention is to create a struct regulator_init_data, populate
it's fields with constraints, consumers devices, etc and then register
the regulator device from board.c in the standard Linux way.
e.g. regulator LDO2 (supplying codec and sim) platform data.
/* regulator LDO2 consumer devices */
static struct regulator_consumer_supply ldo2_consumers[] = {
{
.dev = &platform_audio_device.dev,
.supply = "codec_avdd",
},
{
.dev = &platform_sim_device.dev,
.supply = "sim_vcc",
}
};
/* regulator LDO2 constraints */
static struct regulator_init_data ldo2_data = {
.constraints = {
.min_uV = 3300000,
.max_uV = 3300000,
.valid_modes_mask = REGULATOR_MODE_NORMAL,
.apply_uV = 1,
},
.num_consumer_supplies = ARRAY_SIZE(ldo2_consumers),
.consumer_supplies = ldo2_consumers,
};
/* machine regulator devices with thier consumers and constraints */
static struct platform_device wm8350_regulator_devices[] = {
{
.name = "wm8350-regulator",
.id = WM8350_LDO_2,
.dev = {
.platform_data = &ldo2_data,
},
},
};
Changes in detail:-
o Removed all const char* regulator config functions in machine API.
o Created new struct regulator_init_data to contain regulator
machine configuration constraints and consmuers.
o Changed set_supply(), set_machine_constraints(),
set_consumer_device_supply() to remove their string identifier
parameters. Also made them static and moved functions nearer top of
core.c.
o Removed no longer used inline func to_rdev()
o Added regulator_get_init_drvdata() to retrieve init data.
o Added struct device* as parameter to regulator_register().
o Changed my email address.
Signed-off-by: Eric Miao <eric.miao@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2008-10-10 08:22:20 -04:00
|
|
|
int num_consumer_supplies;
|
|
|
|
struct regulator_consumer_supply *consumer_supplies;
|
|
|
|
|
|
|
|
/* optional regulator machine specific init */
|
|
|
|
int (*regulator_init)(void *driver_data);
|
|
|
|
void *driver_data; /* core does not touch this */
|
|
|
|
};
|
2008-04-30 10:46:09 -04:00
|
|
|
|
|
|
|
int regulator_suspend_prepare(suspend_state_t state);
|
|
|
|
|
|
|
|
#endif
|