vchiq_arm.h revision 1.1.14.2
1 /** 2 * Copyright (c) 2010-2012 Broadcom. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions, and the following disclaimer, 9 * without modification. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. The names of the above-listed copyright holders may not be used 14 * to endorse or promote products derived from this software without 15 * specific prior written permission. 16 * 17 * ALTERNATIVELY, this software may be distributed under the terms of the 18 * GNU General Public License ("GPL") version 2, as published by the Free 19 * Software Foundation. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 22 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 23 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 27 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 28 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 29 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef VCHIQ_ARM_H 35 #define VCHIQ_ARM_H 36 37 #include "vchiq_core.h" 38 39 40 enum vc_suspend_status { 41 VC_SUSPEND_FORCE_CANCELED = -3, /* Force suspend canceled, too busy */ 42 VC_SUSPEND_REJECTED = -2, /* Videocore rejected suspend request */ 43 VC_SUSPEND_FAILED = -1, /* Videocore suspend failed */ 44 VC_SUSPEND_IDLE = 0, /* VC active, no suspend actions */ 45 VC_SUSPEND_REQUESTED, /* User has requested suspend */ 46 VC_SUSPEND_IN_PROGRESS, /* Slot handler has recvd suspend request */ 47 VC_SUSPEND_SUSPENDED /* Videocore suspend succeeded */ 48 }; 49 50 enum vc_resume_status { 51 VC_RESUME_FAILED = -1, /* Videocore resume failed */ 52 VC_RESUME_IDLE = 0, /* VC suspended, no resume actions */ 53 VC_RESUME_REQUESTED, /* User has requested resume */ 54 VC_RESUME_IN_PROGRESS, /* Slot handler has received resume request */ 55 VC_RESUME_RESUMED /* Videocore resumed successfully (active) */ 56 }; 57 58 59 enum USE_TYPE_E { 60 USE_TYPE_SERVICE, 61 USE_TYPE_SERVICE_NO_RESUME, 62 USE_TYPE_VCHIQ 63 }; 64 65 66 67 typedef struct vchiq_arm_state_struct { 68 /* Keepalive-related data */ 69 VCHIQ_THREAD_T ka_thread; 70 struct completion ka_evt; 71 atomic_t ka_use_count; 72 atomic_t ka_use_ack_count; 73 atomic_t ka_release_count; 74 75 struct completion vc_suspend_complete; 76 struct completion vc_resume_complete; 77 78 rwlock_t susp_res_lock; 79 enum vc_suspend_status vc_suspend_state; 80 enum vc_resume_status vc_resume_state; 81 82 unsigned int wake_address; 83 84 struct timer_list suspend_timer; 85 int suspend_timer_timeout; 86 int suspend_timer_running; 87 88 /* Global use count for videocore. 89 ** This is equal to the sum of the use counts for all services. When 90 ** this hits zero the videocore suspend procedure will be initiated. 91 */ 92 int videocore_use_count; 93 94 /* Use count to track requests from videocore peer. 95 ** This use count is not associated with a service, so needs to be 96 ** tracked separately with the state. 97 */ 98 int peer_use_count; 99 100 /* Flag to indicate whether resume is blocked. This happens when the 101 ** ARM is suspending 102 */ 103 struct completion resume_blocker; 104 int resume_blocked; 105 struct completion blocked_blocker; 106 int blocked_count; 107 108 int autosuspend_override; 109 110 /* Flag to indicate that the first vchiq connect has made it through. 111 ** This means that both sides should be fully ready, and we should 112 ** be able to suspend after this point. 113 */ 114 int first_connect; 115 116 unsigned long long suspend_start_time; 117 unsigned long long sleep_start_time; 118 unsigned long long resume_start_time; 119 unsigned long long last_wake_time; 120 121 } VCHIQ_ARM_STATE_T; 122 123 extern int vchiq_arm_log_level; 124 extern int vchiq_susp_log_level; 125 126 extern int __init 127 vchiq_platform_init(VCHIQ_STATE_T *state); 128 129 extern void __exit 130 vchiq_platform_exit(VCHIQ_STATE_T *state); 131 132 extern VCHIQ_STATE_T * 133 vchiq_get_state(void); 134 135 extern VCHIQ_STATUS_T 136 vchiq_arm_vcsuspend(VCHIQ_STATE_T *state); 137 138 extern VCHIQ_STATUS_T 139 vchiq_arm_force_suspend(VCHIQ_STATE_T *state); 140 141 extern int 142 vchiq_arm_allow_resume(VCHIQ_STATE_T *state); 143 144 extern VCHIQ_STATUS_T 145 vchiq_arm_vcresume(VCHIQ_STATE_T *state); 146 147 extern VCHIQ_STATUS_T 148 vchiq_arm_init_state(VCHIQ_STATE_T *state, VCHIQ_ARM_STATE_T *arm_state); 149 150 extern int 151 vchiq_check_resume(VCHIQ_STATE_T *state); 152 153 extern void 154 vchiq_check_suspend(VCHIQ_STATE_T *state); 155 156 extern VCHIQ_STATUS_T 157 vchiq_platform_suspend(VCHIQ_STATE_T *state); 158 159 extern int 160 vchiq_platform_videocore_wanted(VCHIQ_STATE_T *state); 161 162 extern int 163 vchiq_platform_use_suspend_timer(void); 164 165 extern void 166 vchiq_dump_platform_use_state(VCHIQ_STATE_T *state); 167 168 extern void 169 vchiq_dump_service_use_state(VCHIQ_STATE_T *state); 170 171 extern VCHIQ_ARM_STATE_T* 172 vchiq_platform_get_arm_state(VCHIQ_STATE_T *state); 173 174 extern int 175 vchiq_videocore_wanted(VCHIQ_STATE_T *state); 176 177 extern VCHIQ_STATUS_T 178 vchiq_use_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service, 179 enum USE_TYPE_E use_type); 180 extern VCHIQ_STATUS_T 181 vchiq_release_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service); 182 183 void 184 set_suspend_state(VCHIQ_ARM_STATE_T *arm_state, 185 enum vc_suspend_status new_state); 186 187 void 188 set_resume_state(VCHIQ_ARM_STATE_T *arm_state, 189 enum vc_resume_status new_state); 190 191 void 192 start_suspend_timer(VCHIQ_ARM_STATE_T *arm_state); 193 194 extern int vchiq_proc_init(void); 195 extern void vchiq_proc_deinit(void); 196 extern struct proc_dir_entry *vchiq_proc_top(void); 197 extern struct proc_dir_entry *vchiq_clients_top(void); 198 199 200 #endif /* VCHIQ_ARM_H */ 201
Indexes created Fri Oct 03 02:09:57 GMT 2025