2 * Copyright (c) 2014 Raspberry Pi (Trading) Ltd. All rights reserved.
3 * Copyright (c) 2010-2012 Broadcom. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The names of the above-listed copyright holders may not be used
15 * to endorse or promote products derived from this software without
16 * specific prior written permission.
18 * ALTERNATIVELY, this software may be distributed under the terms of the
19 * GNU General Public License ("GPL") version 2, as published by the Free
20 * Software Foundation.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
23 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
26 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <linux/mutex.h>
39 #include <linux/platform_device.h>
40 #include <linux/semaphore.h>
41 #include <linux/atomic.h>
42 #include "vchiq_core.h"
43 #include "vchiq_debugfs.h"
45 enum vc_suspend_status {
46 VC_SUSPEND_FORCE_CANCELED = -3, /* Force suspend canceled, too busy */
47 VC_SUSPEND_REJECTED = -2, /* Videocore rejected suspend request */
48 VC_SUSPEND_FAILED = -1, /* Videocore suspend failed */
49 VC_SUSPEND_IDLE = 0, /* VC active, no suspend actions */
50 VC_SUSPEND_REQUESTED, /* User has requested suspend */
51 VC_SUSPEND_IN_PROGRESS, /* Slot handler has recvd suspend request */
52 VC_SUSPEND_SUSPENDED /* Videocore suspend succeeded */
55 enum vc_resume_status {
56 VC_RESUME_FAILED = -1, /* Videocore resume failed */
57 VC_RESUME_IDLE = 0, /* VC suspended, no resume actions */
58 VC_RESUME_REQUESTED, /* User has requested resume */
59 VC_RESUME_IN_PROGRESS, /* Slot handler has received resume request */
60 VC_RESUME_RESUMED /* Videocore resumed successfully (active) */
65 USE_TYPE_SERVICE_NO_RESUME,
69 typedef struct vchiq_arm_state_struct {
70 /* Keepalive-related data */
71 struct task_struct *ka_thread;
72 struct completion ka_evt;
73 atomic_t ka_use_count;
74 atomic_t ka_use_ack_count;
75 atomic_t ka_release_count;
77 struct completion vc_suspend_complete;
78 struct completion vc_resume_complete;
80 rwlock_t susp_res_lock;
81 enum vc_suspend_status vc_suspend_state;
82 enum vc_resume_status vc_resume_state;
84 unsigned int wake_address;
87 struct timer_list suspend_timer;
88 int suspend_timer_timeout;
89 int suspend_timer_running;
91 /* Global use count for videocore.
92 ** This is equal to the sum of the use counts for all services. When
93 ** this hits zero the videocore suspend procedure will be initiated.
95 int videocore_use_count;
97 /* Use count to track requests from videocore peer.
98 ** This use count is not associated with a service, so needs to be
99 ** tracked separately with the state.
103 /* Flag to indicate whether resume is blocked. This happens when the
106 struct completion resume_blocker;
108 struct completion blocked_blocker;
111 int autosuspend_override;
113 /* Flag to indicate that the first vchiq connect has made it through.
114 ** This means that both sides should be fully ready, and we should
115 ** be able to suspend after this point.
119 unsigned long long suspend_start_time;
120 unsigned long long sleep_start_time;
121 unsigned long long resume_start_time;
122 unsigned long long last_wake_time;
126 extern int vchiq_arm_log_level;
127 extern int vchiq_susp_log_level;
129 int vchiq_platform_init(struct platform_device *pdev, VCHIQ_STATE_T *state);
131 extern VCHIQ_STATE_T *
132 vchiq_get_state(void);
134 extern VCHIQ_STATUS_T
135 vchiq_arm_vcsuspend(VCHIQ_STATE_T *state);
137 extern VCHIQ_STATUS_T
138 vchiq_arm_force_suspend(VCHIQ_STATE_T *state);
141 vchiq_arm_allow_resume(VCHIQ_STATE_T *state);
143 extern VCHIQ_STATUS_T
144 vchiq_arm_vcresume(VCHIQ_STATE_T *state);
146 extern VCHIQ_STATUS_T
147 vchiq_arm_init_state(VCHIQ_STATE_T *state, VCHIQ_ARM_STATE_T *arm_state);
150 vchiq_check_resume(VCHIQ_STATE_T *state);
153 vchiq_check_suspend(VCHIQ_STATE_T *state);
155 vchiq_use_service(VCHIQ_SERVICE_HANDLE_T handle);
157 extern VCHIQ_STATUS_T
158 vchiq_release_service(VCHIQ_SERVICE_HANDLE_T handle);
160 extern VCHIQ_STATUS_T
161 vchiq_check_service(VCHIQ_SERVICE_T *service);
163 extern VCHIQ_STATUS_T
164 vchiq_platform_suspend(VCHIQ_STATE_T *state);
167 vchiq_platform_videocore_wanted(VCHIQ_STATE_T *state);
170 vchiq_platform_use_suspend_timer(void);
173 vchiq_dump_platform_use_state(VCHIQ_STATE_T *state);
176 vchiq_dump_service_use_state(VCHIQ_STATE_T *state);
178 extern VCHIQ_ARM_STATE_T*
179 vchiq_platform_get_arm_state(VCHIQ_STATE_T *state);
182 vchiq_videocore_wanted(VCHIQ_STATE_T *state);
184 extern VCHIQ_STATUS_T
185 vchiq_use_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service,
186 enum USE_TYPE_E use_type);
187 extern VCHIQ_STATUS_T
188 vchiq_release_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service);
190 extern VCHIQ_DEBUGFS_NODE_T *
191 vchiq_instance_get_debugfs_node(VCHIQ_INSTANCE_T instance);
194 vchiq_instance_get_use_count(VCHIQ_INSTANCE_T instance);
197 vchiq_instance_get_pid(VCHIQ_INSTANCE_T instance);
200 vchiq_instance_get_trace(VCHIQ_INSTANCE_T instance);
203 vchiq_instance_set_trace(VCHIQ_INSTANCE_T instance, int trace);
206 set_suspend_state(VCHIQ_ARM_STATE_T *arm_state,
207 enum vc_suspend_status new_state);
210 set_resume_state(VCHIQ_ARM_STATE_T *arm_state,
211 enum vc_resume_status new_state);
214 start_suspend_timer(VCHIQ_ARM_STATE_T *arm_state);
216 #endif /* VCHIQ_ARM_H */