aboutsummaryrefslogtreecommitdiff
path: root/include/linux/resume-dependency.h
blob: b13aa3e2b0e17373bd7adc5b0b426c737a5fa691 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
#ifndef __RESUME_DEPENDENCY_H__
#define __RESUME_DEPENDENCY_H__

/* Resume dependency framework
 *
 * (C) 2008 Openmoko, Inc.
 * Author: Andy Green <andy@openmoko.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; version 2.1.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */

#include <linux/list.h>

struct resume_dependency {
	struct list_head list;

	void (*callback)(void *); /* called with context as arg */
	void * context;
	int called_flag; /* set to 1 after called, use for multi dep */
};

/* if you are a driver accept to have other drivers as dependencies, you need to
 * instantiate a struct resume_dependency above, then initialize it by invoking
 * init_resume_dependency_list() on it
 */

#define init_resume_dependency_list(_head) \
	INIT_LIST_HEAD(&_head.list);


/* if your resume function depends on something else being resumed first, you
 * can register the dependency by calling this in your suspend function with
 * head being the list held by the thing you are dependent on, and dep being
 * your struct resume_dependency
 */

#define register_resume_dependency(_head, _dep) { \
	_dep->called_flag = 0; \
	list_add(&_dep->list, &_head->list); \
}

/* In the resume function that things can be dependent on, at the end you
 * invoke this macro.  This calls back the dependent resumes now it is safe to
 * use the resumed thing they were dependent on.
 */

#define callback_all_resume_dependencies(_head) { \
	struct list_head *_pos, *_q; \
	struct resume_dependency *_dep; \
\
	list_for_each_safe(pos, _q, &_head.list) { \
		_dep = list_entry(_pos, struct resume_dependency, list); \
		_dep->called_flag = 1; \
		(_dep->callback)(dep->context); \
		list_del(_pos); \
	} \
}

/* if your resume action is dependent on multiple drivers being resumed already,
 * register the same callback with each driver you are dependent on, and check
 * .called_flag for all of the struct resume_dependency.  When they are all 1
 * you know it is the last callback and you can resume, otherwise just return
 */

#endif