From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Provide an API to call the device suspend/resume functions.

Change-Id: I352481897a4bf431fc9eb78540fc81f5e552c4be
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/include/device.h b/include/device.h
index 5dbb52f..40adbe8 100644
--- a/include/device.h
+++ b/include/device.h
@@ -266,6 +266,16 @@ static inline int _null_suspend_resume(struct device *device)
return 0;
};

+static inline int device_suspend(struct device *device)
+{
+ return device->config->dev_ops->suspend(device);
+}
+
+static inline int device_resume(struct device *device)
+{
+ return device->config->dev_ops->resume(device);
+}
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Some devices may have no work to do in suspend/resume, but every
device is required to provided a suspend/resume function to the power
management subsystem. Provide generic noop suspend/resume functions
to be reused by devices saving the code space for every device
defining their own noop functions.

Change-Id: Ia1c2edd97fc9cdaff36967f2e4901fadbaca65bf
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/include/device.h b/include/device.h
index 64b1e6f..5dbb52f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -261,6 +261,11 @@ struct device {
void _sys_device_do_config_level(int level);
struct device* device_get_binding(char *name);

+static inline int _null_suspend_resume(struct device *device)
+{
+ return 0;
+};
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Suspend and resume are generic functions that each device should
support. Move the suspend/resume API functions to the top level
device structure. This change allows for the application to call
suspend/resume without needing to know device type.

Change-Id: I2fa7b13f75faeb83106ced83cd07ddbae4c915d6
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 74 insertions(+)

diff --git a/include/device.h b/include/device.h
index e2e657d..64b1e6f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -147,6 +147,70 @@ extern "C" {
*/
#define DEVICE_DECLARE(name) extern struct device DEVICE_NAME_GET(name)

+/**
+ * @def DEVICE_INIT_PM
+ *
+ * @brief create device object and set it up for boot time initialization
+ *
+ * @details This macro defines a device object that is automatically
+ * configured by the kernel during system initialization.
+ *
+ * @param dev_name Device name.
+ *
+ * @param drv_name The name this instance of the driver exposes to
+ * the system.
+ *
+ * @param init_fn Address to the init function of the driver.
+ *
+ * @param device_fn Address of device_ops structure for device.
+ *
+ * @param data Pointer to the device's configuration data.
+ *
+ * @param cfg_info The address to the structure containing the
+ * configuration information for this instance of the driver.
+ *
+ * @param level The initialization level at which configuration occurs.
+ * Must be one of the following symbols, which are listed in the order
+ * they are performed by the kernel:
+ *
+ * PRIMARY: Used for devices that have no dependencies, such as those
+ * that rely solely on hardware present in the processor/SOC. These devices
+ * cannot use any kernel services during configuration, since they are not
+ * yet available.
+ *
+ * SECONDARY: Used for devices that rely on the initialization of devices
+ * initialized as part of the PRIMARY level. These devices cannot use any
+ * kernel services during configuration, since they are not yet available.
+ *
+ * NANOKERNEL: Used for devices that require nanokernel services during
+ * configuration.
+ *
+ * MICROKERNEL: Used for devices that require microkernel services during
+ * configuration.
+ *
+ * APPLICATION: Used for application components (i.e. non-kernel components)
+ * that need automatic configuration. These devices can use all services
+ * provided by the kernel during configuration.
+ *
+ * @param prio The initialization priority of the device, relative to
+ * other devices of the same initialization level. Specified as an integer
+ * value in the range 0 to 99; lower values indicate earlier initialization.
+ * Must be a decimal integer literal without leading zeroes or sign (e.g. 32),
+ * or an equivalent symbolic name (e.g. #define MY_INIT_PRIO 32); symbolic
+ * expressions are *not* permitted
+ * (e.g. CONFIG_KERNEL_INIT_PRIORITY_DEFAULT + 5).
+ */
+
+#define DECLARE_INIT_PM(cfg_name, drv_name, init_fn, \
+ device_fn, config)\
+ static struct device_config config_##cfg_name __used \
+ __attribute__((__section__(".devconfig.init"))) = { \
+ .name = drv_name, .init = (init_fn), \
+ .dev_ops = device_fn, \
+ .config_info = (config) \
+ }
+
+
/* Common Error Codes devices can provide */
#define DEV_OK 0 /* No error */
#define DEV_FAIL 1 /* General operation failure */
@@ -160,6 +224,15 @@ extern "C" {
struct device;

/**
+ * @brief Specify the operations common across all devices
+ * @param init init function for the driver
+ */
+struct device_ops {
+ int (*suspend)(struct device *device);
+ int (*resume)(struct device *device);
+};
+
+/**
* @brief Static device information (In ROM) Per driver instance
* @param name name of the device
* @param init init function for the driver
@@ -168,6 +241,7 @@ struct device;
struct device_config {
char *name;
int (*init)(struct device *device);
+ struct device_ops *dev_ops;
void *config_info;
};

--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Since this change set was loosely based on my RFC on the subject prior
to release it is worth bringing the orginal design into this thread.

Given that most/all platforms we are targeting will care deeply about
power consumption this patch set changes the device model to *require*
that every driver do something about suspend/resume even it is just
providing a null implementation if there is nothing the device needs
to do during a suspend/resume cycle.

This patch does the following things:
Adds suspend/resume to *all* devices.

Provides a null suspend/resume implementation that can be used by
*all* drivers.

Provides an interface for the power management infrastrcuture (PMI) to
call suspend/resume on the device without needing to know the type
of the device.

Provides an interface where the PMI can register callbacks with the
driver to be called when suspend has completed and resume has
started. These call backs allow the PMI to do any processing
required to complete the suspend/resume of the device. e.g. clock
control, power to IP block. This is needed since there may be
multiple devices attached to a single clock or power island which
can only be disabled once all attached devices are suspended and
must be turned on prior to the first device resuming.

This keeps *all* the information about a device in one place. Forces
all drivers to support the suspend/resume interface.

This will require that all the current drivers be updated to support
the new interface. Now is the right time to do this before we get a
*bunch* more drivers added to the tree.

Patch 1 adds a PM enabled version of DEVICE_INIT() which is only there
to keep things building while the drivers are being updated. Once all
the drivers have been updated we can remove the extra macro with a
single tree wide change.

The API to suspend/resume all devices in the system was meant to show
how the PMI might want to suspend all devices and is not complete
since there is no error handling. After thinking about it more it is
not clear to me that we should provide this convienence API.

The changes to the GPIO interface and driver are meant to illustrate
the changes that will need to be applied to all the drivers in the
system.

Dirk Brandewie (8):
device: Add suspend/resume api functions to device structure
device: Add _null_suspend_resume() function
device: Add generic device_{suspend, resume}() API
device: Add API to suspend/resume all devices in the system.
device: pm: Add API for power management entity to register pm
callbacks
gpio: Remove suspend/resume from GPIO API
gpio: gpio_dw: Use generic suspend suspend/resume API
gpio: gpio_dw: Add suport for device_register_pm_ops()

drivers/gpio/gpio_dw.c | 48 ++++++++++++++++----
drivers/gpio/gpio_dw.h | 2 +
include/device.h | 109 +++++++++++++++++++++++++++++++++++++++++++++
include/gpio.h | 27 -----------
include/pm.h | 25 +++++++++++
kernel/nanokernel/device.c | 40 +++++++++++++++++
6 files changed, 216 insertions(+), 35 deletions(-)
create mode 100644 include/pm.h

--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: Ib989e2a45b7c97728b79b4908d6d0aa8d0957999
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
drivers/gpio/gpio_dw.c | 24 +++++++++++++++++++++++-
drivers/gpio/gpio_dw.h | 2 ++
2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio_dw.c b/drivers/gpio/gpio_dw.c
index 4b3da49..db84ee9 100644
--- a/drivers/gpio/gpio_dw.c
+++ b/drivers/gpio/gpio_dw.c
@@ -280,18 +280,39 @@ static inline int gpio_dw_disable_callback(struct device *port, int access_op,

static inline int gpio_dw_suspend_port(struct device *port)
{
+ struct gpio_dw_runtime *context = port->driver_data;
+
_gpio_dw_clock_off(port);
+ if (context->pm_ops->suspend) {
+ context->pm_ops->suspend(context->pm_context);
+ }

return 0;
}

static inline int gpio_dw_resume_port(struct device *port)
{
+ struct gpio_dw_runtime *context = port->driver_data;
+
_gpio_dw_clock_on(port);
+ if (context->pm_ops->resume) {
+ context->pm_ops->resume(context->pm_context);
+ }

return 0;
}

+static inline void gpio_dw_register_pm_ops(struct device *port,
+ struct pm_ops *pm_ops,
+ void *pm_context)
+{
+ struct gpio_dw_runtime *context = port->driver_data;
+
+ context->pm_ops = pm_ops;
+ context->pm_context = pm_context;
+}
+
+
#ifdef CONFIG_SOC_QUARK_SE
static inline void gpio_dw_unmask_int(uint32_t mask_addr)
{
@@ -417,7 +438,8 @@ int gpio_dw_initialize(struct device *port)

struct device_ops gpio_dw_dev_ops = {
.suspend = gpio_dw_suspend_port,
- .resume = gpio_dw_resume_port
+ .resume = gpio_dw_resume_port,
+ .register_pm_ops = gpio_dw_register_pm_ops
};

/* Bindings to the plaform */
diff --git a/drivers/gpio/gpio_dw.h b/drivers/gpio/gpio_dw.h
index a5f82f0..88dbbad 100644
--- a/drivers/gpio/gpio_dw.h
+++ b/drivers/gpio/gpio_dw.h
@@ -55,6 +55,8 @@ struct gpio_dw_runtime {
gpio_callback_t callback;
uint32_t enabled_callbacks;
uint8_t port_callback;
+ struct pm_ops *pm_ops;
+ void *pm_context;
};

#ifdef __cplusplus
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: I55c2c8132172e841214e53be76545b5c84ba1a3c
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
drivers/gpio/gpio_dw.c | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/drivers/gpio/gpio_dw.c b/drivers/gpio/gpio_dw.c
index 85150a6..4b3da49 100644
--- a/drivers/gpio/gpio_dw.c
+++ b/drivers/gpio/gpio_dw.c
@@ -354,8 +354,6 @@ static struct gpio_driver_api api_funcs = {
.set_callback = gpio_dw_set_callback,
.enable_callback = gpio_dw_enable_callback,
.disable_callback = gpio_dw_disable_callback,
- .suspend = gpio_dw_suspend_port,
- .resume = gpio_dw_resume_port
};

#ifdef CONFIG_PCI
@@ -417,6 +415,11 @@ int gpio_dw_initialize(struct device *port)
return 0;
}

+struct device_ops gpio_dw_dev_ops = {
+ .suspend = gpio_dw_suspend_port,
+ .resume = gpio_dw_resume_port
+};
+
/* Bindings to the plaform */
#if CONFIG_GPIO_DW_0
void gpio_config_0_irq(struct device *port);
@@ -448,9 +451,12 @@ struct gpio_dw_config gpio_config_0 = {

struct gpio_dw_runtime gpio_0_runtime;

-DEVICE_INIT(gpio_dw_0, CONFIG_GPIO_DW_0_NAME, gpio_dw_initialize,
- &gpio_0_runtime, &gpio_config_0,
- SECONDARY, CONFIG_GPIO_DW_INIT_PRIORITY);
+
+DECLARE_INIT_PM(gpio_0, CONFIG_GPIO_DW_0_NAME,
+ gpio_dw_initialize, &gpio_dw_dev_ops,
+ &gpio_config_0);
+SYS_DEFINE_DEVICE(gpio_0, &gpio_0_runtime, SECONDARY,
+ CONFIG_GPIO_DW_INIT_PRIORITY);

#ifdef CONFIG_GPIO_DW_0_IRQ_DIRECT
#ifdef CONFIG_IOAPIC
@@ -522,9 +528,13 @@ struct gpio_dw_config gpio_dw_config_1 = {

struct gpio_dw_runtime gpio_1_runtime;

-DEVICE_INIT(gpio_dw_1, CONFIG_GPIO_DW_1_NAME, gpio_dw_initialize,
- &gpio_1_runtime, &gpio_dw_config_1,
- SECONDARY, CONFIG_GPIO_DW_INIT_PRIORITY);
+
+DECLARE_INIT_PM(gpio_1, CONFIG_GPIO_DW_1_NAME,
+ gpio_dw_initialize, &gpio_dw_dev_ops,
+ &gpio_dw_config_1);
+
+SYS_DEFINE_DEVICE(gpio_1, &gpio_1_runtime, SECONDARY,
+ CONFIG_GPIO_DW_INIT_PRIORITY);

#ifdef CONFIG_GPIO_DW_1_IRQ_DIRECT
#ifdef CONFIG_IOAPIC
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: Ib989e2a45b7c97728b79b4908d6d0aa8d0957999
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
drivers/gpio/gpio_dw.c | 24 +++++++++++++++++++++++-
drivers/gpio/gpio_dw.h | 2 ++
2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio_dw.c b/drivers/gpio/gpio_dw.c
index 4b3da49..db84ee9 100644
--- a/drivers/gpio/gpio_dw.c
+++ b/drivers/gpio/gpio_dw.c
@@ -280,18 +280,39 @@ static inline int gpio_dw_disable_callback(struct device *port, int access_op,

static inline int gpio_dw_suspend_port(struct device *port)
{
+ struct gpio_dw_runtime *context = port->driver_data;
+
_gpio_dw_clock_off(port);
+ if (context->pm_ops->suspend) {
+ context->pm_ops->suspend(context->pm_context);
+ }

return 0;
}

static inline int gpio_dw_resume_port(struct device *port)
{
+ struct gpio_dw_runtime *context = port->driver_data;
+
_gpio_dw_clock_on(port);
+ if (context->pm_ops->resume) {
+ context->pm_ops->resume(context->pm_context);
+ }

return 0;
}

+static inline void gpio_dw_register_pm_ops(struct device *port,
+ struct pm_ops *pm_ops,
+ void *pm_context)
+{
+ struct gpio_dw_runtime *context = port->driver_data;
+
+ context->pm_ops = pm_ops;
+ context->pm_context = pm_context;
+}
+
+
#ifdef CONFIG_SOC_QUARK_SE
static inline void gpio_dw_unmask_int(uint32_t mask_addr)
{
@@ -417,7 +438,8 @@ int gpio_dw_initialize(struct device *port)

struct device_ops gpio_dw_dev_ops = {
.suspend = gpio_dw_suspend_port,
- .resume = gpio_dw_resume_port
+ .resume = gpio_dw_resume_port,
+ .register_pm_ops = gpio_dw_register_pm_ops
};

/* Bindings to the plaform */
diff --git a/drivers/gpio/gpio_dw.h b/drivers/gpio/gpio_dw.h
index a5f82f0..88dbbad 100644
--- a/drivers/gpio/gpio_dw.h
+++ b/drivers/gpio/gpio_dw.h
@@ -55,6 +55,8 @@ struct gpio_dw_runtime {
gpio_callback_t callback;
uint32_t enabled_callbacks;
uint8_t port_callback;
+ struct pm_ops *pm_ops;
+ void *pm_context;
};

#ifdef __cplusplus
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: I55c2c8132172e841214e53be76545b5c84ba1a3c
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
drivers/gpio/gpio_dw.c | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/drivers/gpio/gpio_dw.c b/drivers/gpio/gpio_dw.c
index 85150a6..4b3da49 100644
--- a/drivers/gpio/gpio_dw.c
+++ b/drivers/gpio/gpio_dw.c
@@ -354,8 +354,6 @@ static struct gpio_driver_api api_funcs = {
.set_callback = gpio_dw_set_callback,
.enable_callback = gpio_dw_enable_callback,
.disable_callback = gpio_dw_disable_callback,
- .suspend = gpio_dw_suspend_port,
- .resume = gpio_dw_resume_port
};

#ifdef CONFIG_PCI
@@ -417,6 +415,11 @@ int gpio_dw_initialize(struct device *port)
return 0;
}

+struct device_ops gpio_dw_dev_ops = {
+ .suspend = gpio_dw_suspend_port,
+ .resume = gpio_dw_resume_port
+};
+
/* Bindings to the plaform */
#if CONFIG_GPIO_DW_0
void gpio_config_0_irq(struct device *port);
@@ -448,9 +451,12 @@ struct gpio_dw_config gpio_config_0 = {

struct gpio_dw_runtime gpio_0_runtime;

-DEVICE_INIT(gpio_dw_0, CONFIG_GPIO_DW_0_NAME, gpio_dw_initialize,
- &gpio_0_runtime, &gpio_config_0,
- SECONDARY, CONFIG_GPIO_DW_INIT_PRIORITY);
+
+DECLARE_INIT_PM(gpio_0, CONFIG_GPIO_DW_0_NAME,
+ gpio_dw_initialize, &gpio_dw_dev_ops,
+ &gpio_config_0);
+SYS_DEFINE_DEVICE(gpio_0, &gpio_0_runtime, SECONDARY,
+ CONFIG_GPIO_DW_INIT_PRIORITY);

#ifdef CONFIG_GPIO_DW_0_IRQ_DIRECT
#ifdef CONFIG_IOAPIC
@@ -522,9 +528,13 @@ struct gpio_dw_config gpio_dw_config_1 = {

struct gpio_dw_runtime gpio_1_runtime;

-DEVICE_INIT(gpio_dw_1, CONFIG_GPIO_DW_1_NAME, gpio_dw_initialize,
- &gpio_1_runtime, &gpio_dw_config_1,
- SECONDARY, CONFIG_GPIO_DW_INIT_PRIORITY);
+
+DECLARE_INIT_PM(gpio_1, CONFIG_GPIO_DW_1_NAME,
+ gpio_dw_initialize, &gpio_dw_dev_ops,
+ &gpio_dw_config_1);
+
+SYS_DEFINE_DEVICE(gpio_1, &gpio_1_runtime, SECONDARY,
+ CONFIG_GPIO_DW_INIT_PRIORITY);

#ifdef CONFIG_GPIO_DW_1_IRQ_DIRECT
#ifdef CONFIG_IOAPIC
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Device suspend/resume API is now implemented in top level device API.

Change-Id: I2386765813aee2a94e54cb2914ee9ec3644b90c7
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/gpio.h | 27 ---------------------------
1 file changed, 27 deletions(-)

diff --git a/include/gpio.h b/include/gpio.h
index b79c393..3a5e213 100644
--- a/include/gpio.h
+++ b/include/gpio.h
@@ -160,8 +160,6 @@ struct gpio_driver_api {
gpio_set_callback_t set_callback;
gpio_enable_callback_t enable_callback;
gpio_disable_callback_t disable_callback;
- gpio_suspend_port_t suspend;
- gpio_resume_port_t resume;
};
/**
* @endcond
@@ -325,31 +323,6 @@ static inline int gpio_port_disable_callback(struct device *port)
return api->disable_callback(port, GPIO_ACCESS_BY_PORT, 0);
}

-/**
- * @brief Save the state of the device and make it go to the
- * low power state.
- * @param port Pointer to the device structure for the driver instance.
- */
-static inline int gpio_suspend(struct device *port)
-{
- struct gpio_driver_api *api;
-
- api = (struct gpio_driver_api *) port->driver_api;
- return api->suspend(port);
-}
-
-/**
- * @brief Restore the state stored during suspend and resume operation.
- * @param port Pointer to the device structure for the driver instance.
- */
-static inline int gpio_resume(struct device *port)
-{
- struct gpio_driver_api *api;
-
- api = (struct gpio_driver_api *) port->driver_api;
- return api->resume(port);
-}
-
#ifdef __cplusplus
}
#endif
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Device suspend/resume API is now implemented in top level device API.

Change-Id: I2386765813aee2a94e54cb2914ee9ec3644b90c7
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/gpio.h | 27 ---------------------------
1 file changed, 27 deletions(-)

diff --git a/include/gpio.h b/include/gpio.h
index b79c393..3a5e213 100644
--- a/include/gpio.h
+++ b/include/gpio.h
@@ -160,8 +160,6 @@ struct gpio_driver_api {
gpio_set_callback_t set_callback;
gpio_enable_callback_t enable_callback;
gpio_disable_callback_t disable_callback;
- gpio_suspend_port_t suspend;
- gpio_resume_port_t resume;
};
/**
* @endcond
@@ -325,31 +323,6 @@ static inline int gpio_port_disable_callback(struct device *port)
return api->disable_callback(port, GPIO_ACCESS_BY_PORT, 0);
}

-/**
- * @brief Save the state of the device and make it go to the
- * low power state.
- * @param port Pointer to the device structure for the driver instance.
- */
-static inline int gpio_suspend(struct device *port)
-{
- struct gpio_driver_api *api;
-
- api = (struct gpio_driver_api *) port->driver_api;
- return api->suspend(port);
-}
-
-/**
- * @brief Restore the state stored during suspend and resume operation.
- * @param port Pointer to the device structure for the driver instance.
- */
-static inline int gpio_resume(struct device *port)
-{
- struct gpio_driver_api *api;
-
- api = (struct gpio_driver_api *) port->driver_api;
- return api->resume(port);
-}
-
#ifdef __cplusplus
}
#endif
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Provide a mechanism for the power management infrastructure to be
notified of power management events in the driver.

Change-Id: If78fe3610679ba82c52c1ef056781f8afd0be352
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 18 ++++++++++++++++++
include/pm.h | 25 +++++++++++++++++++++++++
2 files changed, 43 insertions(+)
create mode 100644 include/pm.h

diff --git a/include/device.h b/include/device.h
index 793b68f..95fbcb4 100644
--- a/include/device.h
+++ b/include/device.h
@@ -33,6 +33,8 @@
extern "C" {
#endif

+#include <pm.h>
+
/**
* @def DEVICE_INIT
*
@@ -230,6 +232,8 @@ struct device;
struct device_ops {
int (*suspend)(struct device *device);
int (*resume)(struct device *device);
+ void (*register_pm_ops)(struct device *device,
+ struct pm_ops *pm_ops, void *context);
};

/**
@@ -278,6 +282,20 @@ static inline int device_resume(struct device *device)
return device->config->dev_ops->resume(device);
}

+static inline int _null_device_register_pm_ops(struct device *device,
+ struct pm_ops *pm_ops,
+ void *context)
+{
+ return 0;
+};
+
+static inline void device_register_pm_ops(struct device *device,
+ struct pm_ops *pm_ops,
+ void *context)
+{
+ device->config->dev_ops->register_pm_ops(device, pm_ops, context);
+}
+
/**
* Synchronous calls API
*/
diff --git a/include/pm.h b/include/pm.h
new file mode 100644
index 0000000..a63e693
--- /dev/null
+++ b/include/pm.h
@@ -0,0 +1,25 @@
+
+/*
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef _PM_H_
+#define _PM_H_
+
+struct pm_ops {
+ void (*suspend)(void* context);
+ void (*resume)(void* context);
+};
+#endif /* _PM_H_ */
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Provide a mechanism for the power management infrastructure to be
notified of power management events in the driver.

Change-Id: If78fe3610679ba82c52c1ef056781f8afd0be352
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 18 ++++++++++++++++++
include/pm.h | 25 +++++++++++++++++++++++++
2 files changed, 43 insertions(+)
create mode 100644 include/pm.h

diff --git a/include/device.h b/include/device.h
index 793b68f..95fbcb4 100644
--- a/include/device.h
+++ b/include/device.h
@@ -33,6 +33,8 @@
extern "C" {
#endif

+#include <pm.h>
+
/**
* @def DEVICE_INIT
*
@@ -230,6 +232,8 @@ struct device;
struct device_ops {
int (*suspend)(struct device *device);
int (*resume)(struct device *device);
+ void (*register_pm_ops)(struct device *device,
+ struct pm_ops *pm_ops, void *context);
};

/**
@@ -278,6 +282,20 @@ static inline int device_resume(struct device *device)
return device->config->dev_ops->resume(device);
}

+static inline int _null_device_register_pm_ops(struct device *device,
+ struct pm_ops *pm_ops,
+ void *context)
+{
+ return 0;
+};
+
+static inline void device_register_pm_ops(struct device *device,
+ struct pm_ops *pm_ops,
+ void *context)
+{
+ device->config->dev_ops->register_pm_ops(device, pm_ops, context);
+}
+
/**
* Synchronous calls API
*/
diff --git a/include/pm.h b/include/pm.h
new file mode 100644
index 0000000..a63e693
--- /dev/null
+++ b/include/pm.h
@@ -0,0 +1,25 @@
+
+/*
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef _PM_H_
+#define _PM_H_
+
+struct pm_ops {
+ void (*suspend)(void* context);
+ void (*resume)(void* context);
+};
+#endif /* _PM_H_ */
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: Iea0f97998bec4e2b0443a8fcc712dad71d42ae54
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 2 ++
kernel/nanokernel/device.c | 40 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 42 insertions(+)

diff --git a/include/device.h b/include/device.h
index 40adbe8..793b68f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -260,6 +260,8 @@ struct device {

void _sys_device_do_config_level(int level);
struct device* device_get_binding(char *name);
+void device_suspend_all(void);
+void device_resume_all(void);

static inline int _null_suspend_resume(struct device *device)
{
diff --git a/kernel/nanokernel/device.c b/kernel/nanokernel/device.c
index f86f95f..e862ef8 100644
--- a/kernel/nanokernel/device.c
+++ b/kernel/nanokernel/device.c
@@ -42,6 +42,46 @@ void _sys_device_do_config_level(int level)
}

/**
+ * @brief Execute all the device suspend proceedures
+ *
+ * @details Invokes the suspend routine for each device object
+ * created by the SYS_DEFINE_DEVICE_PM().
+ * The linker script places the device objects in memory in the order
+ * required to maintain device dependencies.
+ *
+ */
+void device_suspend_all(void)
+{
+ struct device *info;
+
+ for (info = __device_init_end -1 ;
+ info > __device_init_start ; info--) {
+ struct device_config *device = info->config;
+ device->dev_ops->suspend(info);
+ }
+}
+
+/**
+ * @brief Execute all the device resume proceedures
+ *
+ * @details Invokes the resume routine for each device object
+ * created by the SYS_DEFINE_DEVICE_PM().
+ * The linker script places the device objects in memory in the order
+ * required to maintain device dependencies.
+ *
+ */
+void device_resume_all(void)
+{
+ struct device *info;
+
+ for (info = __device_init_start;
+ info < __device_init_end ; info++) {
+ struct device_config *device = info->config;
+ device->dev_ops->resume(info);
+ }
+}
+
+/**
* @brief Retrieve the device structure for a driver by name
*
* @details Device objects are created via the DEVICE_INIT() macro and
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Provide an API to call the device suspend/resume functions.

Change-Id: I352481897a4bf431fc9eb78540fc81f5e552c4be
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/include/device.h b/include/device.h
index 5dbb52f..40adbe8 100644
--- a/include/device.h
+++ b/include/device.h
@@ -266,6 +266,16 @@ static inline int _null_suspend_resume(struct device *device)
return 0;
};

+static inline int device_suspend(struct device *device)
+{
+ return device->config->dev_ops->suspend(device);
+}
+
+static inline int device_resume(struct device *device)
+{
+ return device->config->dev_ops->resume(device);
+}
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Change-Id: Iea0f97998bec4e2b0443a8fcc712dad71d42ae54
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 2 ++
kernel/nanokernel/device.c | 40 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 42 insertions(+)

diff --git a/include/device.h b/include/device.h
index 40adbe8..793b68f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -260,6 +260,8 @@ struct device {

void _sys_device_do_config_level(int level);
struct device* device_get_binding(char *name);
+void device_suspend_all(void);
+void device_resume_all(void);

static inline int _null_suspend_resume(struct device *device)
{
diff --git a/kernel/nanokernel/device.c b/kernel/nanokernel/device.c
index f86f95f..e862ef8 100644
--- a/kernel/nanokernel/device.c
+++ b/kernel/nanokernel/device.c
@@ -42,6 +42,46 @@ void _sys_device_do_config_level(int level)
}

/**
+ * @brief Execute all the device suspend proceedures
+ *
+ * @details Invokes the suspend routine for each device object
+ * created by the SYS_DEFINE_DEVICE_PM().
+ * The linker script places the device objects in memory in the order
+ * required to maintain device dependencies.
+ *
+ */
+void device_suspend_all(void)
+{
+ struct device *info;
+
+ for (info = __device_init_end -1 ;
+ info > __device_init_start ; info--) {
+ struct device_config *device = info->config;
+ device->dev_ops->suspend(info);
+ }
+}
+
+/**
+ * @brief Execute all the device resume proceedures
+ *
+ * @details Invokes the resume routine for each device object
+ * created by the SYS_DEFINE_DEVICE_PM().
+ * The linker script places the device objects in memory in the order
+ * required to maintain device dependencies.
+ *
+ */
+void device_resume_all(void)
+{
+ struct device *info;
+
+ for (info = __device_init_start;
+ info < __device_init_end ; info++) {
+ struct device_config *device = info->config;
+ device->dev_ops->resume(info);
+ }
+}
+
+/**
* @brief Retrieve the device structure for a driver by name
*
* @details Device objects are created via the DEVICE_INIT() macro and
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Provide an API to call the device suspend/resume functions.

Change-Id: I352481897a4bf431fc9eb78540fc81f5e552c4be
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/include/device.h b/include/device.h
index 5dbb52f..40adbe8 100644
--- a/include/device.h
+++ b/include/device.h
@@ -266,6 +266,16 @@ static inline int _null_suspend_resume(struct device *device)
return 0;
};

+static inline int device_suspend(struct device *device)
+{
+ return device->config->dev_ops->suspend(device);
+}
+
+static inline int device_resume(struct device *device)
+{
+ return device->config->dev_ops->resume(device);
+}
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Some devices may have no work to do in suspend/resume, but every
device is required to provided a suspend/resume function to the power
management subsystem. Provide generic noop suspend/resume functions
to be reused by devices saving the code space for every device
defining their own noop functions.

Change-Id: Ia1c2edd97fc9cdaff36967f2e4901fadbaca65bf
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/include/device.h b/include/device.h
index 64b1e6f..5dbb52f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -261,6 +261,11 @@ struct device {
void _sys_device_do_config_level(int level);
struct device* device_get_binding(char *name);

+static inline int _null_suspend_resume(struct device *device)
+{
+ return 0;
+};
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Suspend and resume are generic functions that each device should
support. Move the suspend/resume API functions to the top level
device structure. This change allows for the application to call
suspend/resume without needing to know device type.

Change-Id: I2fa7b13f75faeb83106ced83cd07ddbae4c915d6
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 74 insertions(+)

diff --git a/include/device.h b/include/device.h
index e2e657d..64b1e6f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -147,6 +147,70 @@ extern "C" {
*/
#define DEVICE_DECLARE(name) extern struct device DEVICE_NAME_GET(name)

+/**
+ * @def DEVICE_INIT_PM
+ *
+ * @brief create device object and set it up for boot time initialization
+ *
+ * @details This macro defines a device object that is automatically
+ * configured by the kernel during system initialization.
+ *
+ * @param dev_name Device name.
+ *
+ * @param drv_name The name this instance of the driver exposes to
+ * the system.
+ *
+ * @param init_fn Address to the init function of the driver.
+ *
+ * @param device_fn Address of device_ops structure for device.
+ *
+ * @param data Pointer to the device's configuration data.
+ *
+ * @param cfg_info The address to the structure containing the
+ * configuration information for this instance of the driver.
+ *
+ * @param level The initialization level at which configuration occurs.
+ * Must be one of the following symbols, which are listed in the order
+ * they are performed by the kernel:
+ *
+ * PRIMARY: Used for devices that have no dependencies, such as those
+ * that rely solely on hardware present in the processor/SOC. These devices
+ * cannot use any kernel services during configuration, since they are not
+ * yet available.
+ *
+ * SECONDARY: Used for devices that rely on the initialization of devices
+ * initialized as part of the PRIMARY level. These devices cannot use any
+ * kernel services during configuration, since they are not yet available.
+ *
+ * NANOKERNEL: Used for devices that require nanokernel services during
+ * configuration.
+ *
+ * MICROKERNEL: Used for devices that require microkernel services during
+ * configuration.
+ *
+ * APPLICATION: Used for application components (i.e. non-kernel components)
+ * that need automatic configuration. These devices can use all services
+ * provided by the kernel during configuration.
+ *
+ * @param prio The initialization priority of the device, relative to
+ * other devices of the same initialization level. Specified as an integer
+ * value in the range 0 to 99; lower values indicate earlier initialization.
+ * Must be a decimal integer literal without leading zeroes or sign (e.g. 32),
+ * or an equivalent symbolic name (e.g. #define MY_INIT_PRIO 32); symbolic
+ * expressions are *not* permitted
+ * (e.g. CONFIG_KERNEL_INIT_PRIORITY_DEFAULT + 5).
+ */
+
+#define DECLARE_INIT_PM(cfg_name, drv_name, init_fn, \
+ device_fn, config)\
+ static struct device_config config_##cfg_name __used \
+ __attribute__((__section__(".devconfig.init"))) = { \
+ .name = drv_name, .init = (init_fn), \
+ .dev_ops = device_fn, \
+ .config_info = (config) \
+ }
+
+
/* Common Error Codes devices can provide */
#define DEV_OK 0 /* No error */
#define DEV_FAIL 1 /* General operation failure */
@@ -160,6 +224,15 @@ extern "C" {
struct device;

/**
+ * @brief Specify the operations common across all devices
+ * @param init init function for the driver
+ */
+struct device_ops {
+ int (*suspend)(struct device *device);
+ int (*resume)(struct device *device);
+};
+
+/**
* @brief Static device information (In ROM) Per driver instance
* @param name name of the device
* @param init init function for the driver
@@ -168,6 +241,7 @@ struct device;
struct device_config {
char *name;
int (*init)(struct device *device);
+ struct device_ops *dev_ops;
void *config_info;
};

--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Some devices may have no work to do in suspend/resume, but every
device is required to provided a suspend/resume function to the power
management subsystem. Provide generic noop suspend/resume functions
to be reused by devices saving the code space for every device
defining their own noop functions.

Change-Id: Ia1c2edd97fc9cdaff36967f2e4901fadbaca65bf
Signed-off-by: Dirk Brandewie <dirk.j.brandewie(a)intel.com>
---
include/device.h | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/include/device.h b/include/device.h
index 64b1e6f..5dbb52f 100644
--- a/include/device.h
+++ b/include/device.h
@@ -261,6 +261,11 @@ struct device {
void _sys_device_do_config_level(int level);
struct device* device_get_binding(char *name);

+static inline int _null_suspend_resume(struct device *device)
+{
+ return 0;
+};
+
/**
* Synchronous calls API
*/
--
2.4.3

From: Dirk Brandewie <dirk.j.brandewie(a)intel.com>

Since this change set was loosely based on my RFC on the subject prior
to release it is worth bringing the orginal design into this thread.

Given that most/all platforms we are targeting will care deeply about
power consumption this patch set changes the device model to *require*
that every driver do something about suspend/resume even it is just
providing a null implementation if there is nothing the device needs
to do during a suspend/resume cycle.

This patch does the following things:
Adds suspend/resume to *all* devices.

Provides a null suspend/resume implementation that can be used by
*all* drivers.

Provides an interface for the power management infrastrcuture (PMI) to
call suspend/resume on the device without needing to know the type
of the device.

Provides an interface where the PMI can register callbacks with the
driver to be called when suspend has completed and resume has
started. These call backs allow the PMI to do any processing
required to complete the suspend/resume of the device. e.g. clock
control, power to IP block. This is needed since there may be
multiple devices attached to a single clock or power island which
can only be disabled once all attached devices are suspended and
must be turned on prior to the first device resuming.

This keeps *all* the information about a device in one place. Forces
all drivers to support the suspend/resume interface.

This will require that all the current drivers be updated to support
the new interface. Now is the right time to do this before we get a
*bunch* more drivers added to the tree.

Patch 1 adds a PM enabled version of DEVICE_INIT() which is only there
to keep things building while the drivers are being updated. Once all
the drivers have been updated we can remove the extra macro with a
single tree wide change.

The API to suspend/resume all devices in the system was meant to show
how the PMI might want to suspend all devices and is not complete
since there is no error handling. After thinking about it more it is
not clear to me that we should provide this convienence API.

The changes to the GPIO interface and driver are meant to illustrate
the changes that will need to be applied to all the drivers in the
system.

Dirk Brandewie (8):
device: Add suspend/resume api functions to device structure
device: Add _null_suspend_resume() function
device: Add generic device_{suspend, resume}() API
device: Add API to suspend/resume all devices in the system.
device: pm: Add API for power management entity to register pm
callbacks
gpio: Remove suspend/resume from GPIO API
gpio: gpio_dw: Use generic suspend suspend/resume API
gpio: gpio_dw: Add suport for device_register_pm_ops()

drivers/gpio/gpio_dw.c | 48 ++++++++++++++++----
drivers/gpio/gpio_dw.h | 2 +
include/device.h | 109 +++++++++++++++++++++++++++++++++++++++++++++
include/gpio.h | 27 -----------
include/pm.h | 25 +++++++++++
kernel/nanokernel/device.c | 40 +++++++++++++++++
6 files changed, 216 insertions(+), 35 deletions(-)
create mode 100644 include/pm.h

--
2.4.3