sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
5c2750a960
nuttx/drivers/power/pm.h

153 lines
4.8 KiB
C
Raw Normal View History

Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/****************************************************************************
Rename pm_internal.h to pm.h
2015-12-30 01:19:03 +01:00
* drivers/power/pm
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
*
drivers/power: add pm_unregister
2018-03-06 14:59:17 +01:00
* Copyright (C) 2011-2012, 2016, 2018 Gregory Nutt. All rights reserved.
Create directory structures to support power-related devices git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4321 42af7a65-404d-4744-a932-0658087f49c3
2012-01-22 17:42:49 +01:00
* Author: Gregory Nutt <gnutt@nuttx.org>
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
* Author: Matias Nitsche <mnitsche@dc.uba.ar>
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
Rename pm_internal.h to pm.h
2015-12-30 01:19:03 +01:00
#ifndef __DRIVERS_POWER_PM_H
#define __DRIVERS_POWER_PM_H
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <queue.h>
Correct recurring typo: semaphore not semapore
2017-10-09 17:57:56 +02:00
#include <nuttx/semaphore.h>
Update to use 64-bit timer when available
2016-01-21 18:54:26 +01:00
#include <nuttx/clock.h>
#include <nuttx/power/pm.h>
drivers/power: PM: Add timer to decrease PM level automatically
2018-08-27 21:28:48 +02:00
#include <nuttx/wdog.h>
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
#ifdef CONFIG_PM
/****************************************************************************
Make some file section headers more consistent with standard
2015-04-08 15:15:32 +02:00
* Pre-processor Definitions
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
****************************************************************************/
drivers/power: Run tools/nxstyle against all .c and .h files in this directory.
2019-10-29 01:28:41 +01:00
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/****************************************************************************
* Name: pm_lock
*
Make sure that labeling is used consistently in all function headers (part 2).
2018-02-01 19:03:55 +01:00
* Description:
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
* Lock the power management registry. NOTE: This function may return
* an error if a signal is received while what (errno == EINTR).
*
****************************************************************************/
Squashed commit of the following: This commit backs out most of commit b4747286b19d3b15193b2a5e8a0fe48fa0a8638c. That change was added because sem_wait() would sometimes cause cancellation points inappropriated. But with these recent changes, nxsem_wait() is used instead and it is not a cancellation point. In the OS, all calls to sem_wait() changed to nxsem_wait(). nxsem_wait() does not return errors via errno so each place where nxsem_wait() is now called must not examine the errno variable. In all OS functions (not libraries), change sem_wait() to nxsem_wait(). This will prevent the OS from creating bogus cancellation points and from modifying the per-task errno variable. sched/semaphore: Add the function nxsem_wait(). This is a new internal OS interface. It is functionally equivalent to sem_wait() except that (1) it is not a cancellation point, and (2) it does not set the per-thread errno value on return.
2017-10-04 23:22:27 +02:00
#define pm_lock() nxsem_wait(&g_pmglobals.regsem);
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/****************************************************************************
* Name: pm_unlock
*
Make sure that labeling is used consistently in all function headers (part 2).
2018-02-01 19:03:55 +01:00
* Description:
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
* Unlock the power management registry.
*
****************************************************************************/
Squashed commit of the following: sched/semaphore: Add nxsem_post() which is identical to sem_post() except that it never modifies the errno variable. Changed all references to sem_post in the OS to nxsem_post(). sched/semaphore: Add nxsem_destroy() which is identical to sem_destroy() except that it never modifies the errno variable. Changed all references to sem_destroy() in the OS to nxsem_destroy(). libc/semaphore and sched/semaphore: Add nxsem_getprotocol() and nxsem_setprotocola which are identical to sem_getprotocol() and set_setprotocol() except that they never modifies the errno variable. Changed all references to sem_setprotocol in the OS to nxsem_setprotocol(). sem_getprotocol() was not used in the OS
2017-10-03 23:35:24 +02:00
#define pm_unlock() nxsem_post(&g_pmglobals.regsem);
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/****************************************************************************
* Public Types
****************************************************************************/
drivers/power/pm: Use the start time of state btime) to calculate thrcnt; remove the loop whose count may be very big after the long idle
2018-11-10 14:30:23 +01:00
PM: Add domain to all PM interfaces. Internal PM data structures now handle multiple PM domains.
2016-03-27 21:03:47 +02:00
/* This describes the activity and state for one domain */
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
PM: Add domain to all PM interfaces. Internal PM data structures now handle multiple PM domains.
2016-03-27 21:03:47 +02:00
struct pm_domain_s
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
{
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
/* The current state for this PM domain (as determined by an
* explicit call to pm_changestate())
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
*/
uint8_t state;
drivers/power/pm: Use the start time of state btime) to calculate thrcnt; remove the loop whose count may be very big after the long idle
2018-11-10 14:30:23 +01:00
drivers/power: PM: Add pm_stay and pm_relax function so special apps(e.g. mediaplayer) could disable suspend during playback much like linux kernel counterpart
2018-08-27 21:16:34 +02:00
/* The power state lock count */
uint16_t stay[PM_COUNT];
PM: Add domain to all PM interfaces. Internal PM data structures now handle multiple PM domains.
2016-03-27 21:03:47 +02:00
};
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
/* This structure encapsulates all of the global data used by the PM system */
PM: Add domain to all PM interfaces. Internal PM data structures now handle multiple PM domains.
2016-03-27 21:03:47 +02:00
struct pm_global_s
{
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
/* This semaphore manages mutually exclusive access to the power management
* registry. It must be initialized to the value 1.
*/
sem_t regsem;
drivers/pm: PM: Decrease the power state in the reverse order. Since the child driver need power off before parent driver.
2018-08-27 21:22:11 +02:00
/* registry is a doubly-linked list of registered power management
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
* callback structures. To ensure mutually exclusive access, this list
* must be locked by calling pm_lock() before it is accessed.
*/
drivers/pm: PM: Decrease the power state in the reverse order. Since the child driver need power off before parent driver.
2018-08-27 21:22:11 +02:00
dq_queue_t registry;
drivers/power: PM: Make power manager service available as soon as possible: (1) Initialize g_pmglobals at the definition, (2) skip hold the lock if OS isn't ready
2018-08-27 21:24:13 +02:00
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
/* The state information for each PM domain */
drivers/power: PM: Make power manager service available as soon as possible: (1) Initialize g_pmglobals at the definition, (2) skip hold the lock if OS isn't ready
2018-08-27 21:24:13 +02:00
struct pm_domain_s domain[CONFIG_PM_NDOMAINS];
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
/* A pointer to the PM governor instance */
FAR const struct pm_governor_s *governor;
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
};
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
# define EXTERN extern "C"
extern "C"
{
#else
# define EXTERN extern
#endif
/* All PM global data: */
EXTERN struct pm_global_s g_pmglobals;
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
/*****************************************************************************
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
* Public Function Prototypes
drivers/power/pm: Historically, the NuttX PM subsystem has consisted of two functional components: (1) an "Upper" part that detects state changes based on a random walk driven by activity levels, and (2) and "lower" part that implementst the state changes. This change decouples that upper activity-based logic from the lower random walk logic and allows use of other upper state detection logic (such as a custom, application-specific state machine).
2019-11-09 16:09:33 +01:00
*****************************************************************************/
Add a basic power management framework git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3936 42af7a65-404d-4744-a932-0658087f49c3
2011-09-04 21:24:27 +02:00
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* CONFIG_PM */
Rename pm_internal.h to pm.h
2015-12-30 01:19:03 +01:00
#endif /* #define __DRIVERS_POWER_PM_H */
Reference in New Issue Copy Permalink