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.
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/types.h>
38 #include <linux/errno.h>
39 #include <linux/cdev.h>
41 #include <linux/device.h>
43 #include <linux/highmem.h>
44 #include <linux/pagemap.h>
45 #include <linux/bug.h>
46 #include <linux/semaphore.h>
47 #include <linux/list.h>
49 #include <linux/platform_device.h>
50 #include <soc/bcm2835/raspberrypi-firmware.h>
52 #include "vchiq_core.h"
53 #include "vchiq_ioctl.h"
54 #include "vchiq_arm.h"
55 #include "vchiq_debugfs.h"
56 #include "vchiq_killable.h"
58 #define DEVICE_NAME "vchiq"
60 /* Override the default prefix, which would be vchiq_arm (from the filename) */
61 #undef MODULE_PARAM_PREFIX
62 #define MODULE_PARAM_PREFIX DEVICE_NAME "."
66 /* Some per-instance constants */
67 #define MAX_COMPLETIONS 16
68 #define MAX_SERVICES 64
69 #define MAX_ELEMENTS 8
70 #define MSG_QUEUE_SIZE 64
72 #define KEEPALIVE_VER 1
73 #define KEEPALIVE_VER_MIN KEEPALIVE_VER
75 /* Run time control of log level, based on KERN_XXX level. */
76 int vchiq_arm_log_level = VCHIQ_LOG_DEFAULT;
77 int vchiq_susp_log_level = VCHIQ_LOG_ERROR;
79 #define SUSPEND_TIMER_TIMEOUT_MS 100
80 #define SUSPEND_RETRY_TIMER_TIMEOUT_MS 1000
82 #define VC_SUSPEND_NUM_OFFSET 3 /* number of values before idle which are -ve */
83 static const char *const suspend_state_names[] = {
84 "VC_SUSPEND_FORCE_CANCELED",
85 "VC_SUSPEND_REJECTED",
88 "VC_SUSPEND_REQUESTED",
89 "VC_SUSPEND_IN_PROGRESS",
90 "VC_SUSPEND_SUSPENDED"
92 #define VC_RESUME_NUM_OFFSET 1 /* number of values before idle which are -ve */
93 static const char *const resume_state_names[] = {
96 "VC_RESUME_REQUESTED",
97 "VC_RESUME_IN_PROGRESS",
100 /* The number of times we allow force suspend to timeout before actually
101 ** _forcing_ suspend. This is to cater for SW which fails to release vchiq
102 ** correctly - we don't want to prevent ARM suspend indefinitely in this case.
104 #define FORCE_SUSPEND_FAIL_MAX 8
106 /* The time in ms allowed for videocore to go idle when force suspend has been
108 #define FORCE_SUSPEND_TIMEOUT_MS 200
111 static void suspend_timer_callback(unsigned long context);
114 typedef struct user_service_struct {
115 VCHIQ_SERVICE_T *service;
117 VCHIQ_INSTANCE_T instance;
119 char dequeue_pending;
121 int message_available_pos;
124 struct semaphore insert_event;
125 struct semaphore remove_event;
126 struct semaphore close_event;
127 VCHIQ_HEADER_T * msg_queue[MSG_QUEUE_SIZE];
130 struct bulk_waiter_node {
131 struct bulk_waiter bulk_waiter;
133 struct list_head list;
136 struct vchiq_instance_struct {
137 VCHIQ_STATE_T *state;
138 VCHIQ_COMPLETION_DATA_T completions[MAX_COMPLETIONS];
139 int completion_insert;
140 int completion_remove;
141 struct semaphore insert_event;
142 struct semaphore remove_event;
143 struct mutex completion_mutex;
149 int use_close_delivered;
152 struct list_head bulk_waiter_list;
153 struct mutex bulk_waiter_list_mutex;
155 VCHIQ_DEBUGFS_NODE_T debugfs_node;
158 typedef struct dump_context_struct {
165 static struct cdev vchiq_cdev;
166 static dev_t vchiq_devid;
167 static VCHIQ_STATE_T g_state;
168 static struct class *vchiq_class;
169 static struct device *vchiq_dev;
170 static DEFINE_SPINLOCK(msg_queue_spinlock);
172 static const char *const ioctl_names[] = {
178 "QUEUE_BULK_TRANSMIT",
179 "QUEUE_BULK_RECEIVE",
187 "SET_SERVICE_OPTION",
193 vchiq_static_assert((sizeof(ioctl_names)/sizeof(ioctl_names[0])) ==
194 (VCHIQ_IOC_MAX + 1));
197 dump_phys_mem(void *virt_addr, uint32_t num_bytes);
199 /****************************************************************************
203 ***************************************************************************/
205 static VCHIQ_STATUS_T
206 add_completion(VCHIQ_INSTANCE_T instance, VCHIQ_REASON_T reason,
207 VCHIQ_HEADER_T *header, USER_SERVICE_T *user_service,
210 VCHIQ_COMPLETION_DATA_T *completion;
211 DEBUG_INITIALISE(g_state.local)
213 while (instance->completion_insert ==
214 (instance->completion_remove + MAX_COMPLETIONS)) {
215 /* Out of space - wait for the client */
216 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
217 vchiq_log_trace(vchiq_arm_log_level,
218 "add_completion - completion queue full");
219 DEBUG_COUNT(COMPLETION_QUEUE_FULL_COUNT);
220 if (down_interruptible(&instance->remove_event) != 0) {
221 vchiq_log_info(vchiq_arm_log_level,
222 "service_callback interrupted");
224 } else if (instance->closing) {
225 vchiq_log_info(vchiq_arm_log_level,
226 "service_callback closing");
229 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
233 &instance->completions[instance->completion_insert &
234 (MAX_COMPLETIONS - 1)];
236 completion->header = header;
237 completion->reason = reason;
238 /* N.B. service_userdata is updated while processing AWAIT_COMPLETION */
239 completion->service_userdata = user_service->service;
240 completion->bulk_userdata = bulk_userdata;
242 if (reason == VCHIQ_SERVICE_CLOSED) {
243 /* Take an extra reference, to be held until
244 this CLOSED notification is delivered. */
245 lock_service(user_service->service);
246 if (instance->use_close_delivered)
247 user_service->close_pending = 1;
250 /* A write barrier is needed here to ensure that the entire completion
251 record is written out before the insert point. */
254 if (reason == VCHIQ_MESSAGE_AVAILABLE)
255 user_service->message_available_pos =
256 instance->completion_insert;
257 instance->completion_insert++;
259 up(&instance->insert_event);
261 return VCHIQ_SUCCESS;
264 /****************************************************************************
268 ***************************************************************************/
270 static VCHIQ_STATUS_T
271 service_callback(VCHIQ_REASON_T reason, VCHIQ_HEADER_T *header,
272 VCHIQ_SERVICE_HANDLE_T handle, void *bulk_userdata)
274 /* How do we ensure the callback goes to the right client?
275 ** The service_user data points to a USER_SERVICE_T record containing
276 ** the original callback and the user state structure, which contains a
277 ** circular buffer for completion records.
279 USER_SERVICE_T *user_service;
280 VCHIQ_SERVICE_T *service;
281 VCHIQ_INSTANCE_T instance;
282 DEBUG_INITIALISE(g_state.local)
284 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
286 service = handle_to_service(handle);
288 user_service = (USER_SERVICE_T *)service->base.userdata;
289 instance = user_service->instance;
291 if (!instance || instance->closing)
292 return VCHIQ_SUCCESS;
294 vchiq_log_trace(vchiq_arm_log_level,
295 "service_callback - service %lx(%d,%p), reason %d, header %lx, "
296 "instance %lx, bulk_userdata %lx",
297 (unsigned long)user_service,
298 service->localport, user_service->userdata,
299 reason, (unsigned long)header,
300 (unsigned long)instance, (unsigned long)bulk_userdata);
302 if (header && user_service->is_vchi) {
303 spin_lock(&msg_queue_spinlock);
304 while (user_service->msg_insert ==
305 (user_service->msg_remove + MSG_QUEUE_SIZE)) {
306 spin_unlock(&msg_queue_spinlock);
307 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
308 DEBUG_COUNT(MSG_QUEUE_FULL_COUNT);
309 vchiq_log_trace(vchiq_arm_log_level,
310 "service_callback - msg queue full");
311 /* If there is no MESSAGE_AVAILABLE in the completion
314 if ((user_service->message_available_pos -
315 instance->completion_remove) < 0) {
316 VCHIQ_STATUS_T status;
317 vchiq_log_info(vchiq_arm_log_level,
318 "Inserting extra MESSAGE_AVAILABLE");
319 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
320 status = add_completion(instance, reason,
321 NULL, user_service, bulk_userdata);
322 if (status != VCHIQ_SUCCESS) {
323 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
328 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
329 if (down_interruptible(&user_service->remove_event)
331 vchiq_log_info(vchiq_arm_log_level,
332 "service_callback interrupted");
333 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
335 } else if (instance->closing) {
336 vchiq_log_info(vchiq_arm_log_level,
337 "service_callback closing");
338 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
341 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
342 spin_lock(&msg_queue_spinlock);
345 user_service->msg_queue[user_service->msg_insert &
346 (MSG_QUEUE_SIZE - 1)] = header;
347 user_service->msg_insert++;
348 spin_unlock(&msg_queue_spinlock);
350 up(&user_service->insert_event);
352 /* If there is a thread waiting in DEQUEUE_MESSAGE, or if
353 ** there is a MESSAGE_AVAILABLE in the completion queue then
354 ** bypass the completion queue.
356 if (((user_service->message_available_pos -
357 instance->completion_remove) >= 0) ||
358 user_service->dequeue_pending) {
359 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
360 user_service->dequeue_pending = 0;
361 return VCHIQ_SUCCESS;
366 DEBUG_TRACE(SERVICE_CALLBACK_LINE);
368 return add_completion(instance, reason, header, user_service,
372 /****************************************************************************
376 ***************************************************************************/
378 user_service_free(void *userdata)
383 /****************************************************************************
387 ***************************************************************************/
388 static void close_delivered(USER_SERVICE_T *user_service)
390 vchiq_log_info(vchiq_arm_log_level,
391 "close_delivered(handle=%x)",
392 user_service->service->handle);
394 if (user_service->close_pending) {
395 /* Allow the underlying service to be culled */
396 unlock_service(user_service->service);
398 /* Wake the user-thread blocked in close_ or remove_service */
399 up(&user_service->close_event);
401 user_service->close_pending = 0;
405 /****************************************************************************
409 ***************************************************************************/
411 vchiq_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
413 VCHIQ_INSTANCE_T instance = file->private_data;
414 VCHIQ_STATUS_T status = VCHIQ_SUCCESS;
415 VCHIQ_SERVICE_T *service = NULL;
418 DEBUG_INITIALISE(g_state.local)
420 vchiq_log_trace(vchiq_arm_log_level,
421 "vchiq_ioctl - instance %x, cmd %s, arg %lx",
422 (unsigned int)instance,
423 ((_IOC_TYPE(cmd) == VCHIQ_IOC_MAGIC) &&
424 (_IOC_NR(cmd) <= VCHIQ_IOC_MAX)) ?
425 ioctl_names[_IOC_NR(cmd)] : "<invalid>", arg);
428 case VCHIQ_IOC_SHUTDOWN:
429 if (!instance->connected)
432 /* Remove all services */
434 while ((service = next_service_by_instance(instance->state,
435 instance, &i)) != NULL) {
436 status = vchiq_remove_service(service->handle);
437 unlock_service(service);
438 if (status != VCHIQ_SUCCESS)
443 if (status == VCHIQ_SUCCESS) {
444 /* Wake the completion thread and ask it to exit */
445 instance->closing = 1;
446 up(&instance->insert_event);
451 case VCHIQ_IOC_CONNECT:
452 if (instance->connected) {
456 rc = mutex_lock_interruptible(&instance->state->mutex);
458 vchiq_log_error(vchiq_arm_log_level,
459 "vchiq: connect: could not lock mutex for "
461 instance->state->id, rc);
465 status = vchiq_connect_internal(instance->state, instance);
466 mutex_unlock(&instance->state->mutex);
468 if (status == VCHIQ_SUCCESS)
469 instance->connected = 1;
471 vchiq_log_error(vchiq_arm_log_level,
472 "vchiq: could not connect: %d", status);
475 case VCHIQ_IOC_CREATE_SERVICE: {
476 VCHIQ_CREATE_SERVICE_T args;
477 USER_SERVICE_T *user_service = NULL;
482 (&args, (const void __user *)arg,
483 sizeof(args)) != 0) {
488 user_service = kmalloc(sizeof(USER_SERVICE_T), GFP_KERNEL);
495 if (!instance->connected) {
500 srvstate = VCHIQ_SRVSTATE_OPENING;
503 instance->connected ?
504 VCHIQ_SRVSTATE_LISTENING :
505 VCHIQ_SRVSTATE_HIDDEN;
508 userdata = args.params.userdata;
509 args.params.callback = service_callback;
510 args.params.userdata = user_service;
511 service = vchiq_add_service_internal(
513 &args.params, srvstate,
514 instance, user_service_free);
516 if (service != NULL) {
517 user_service->service = service;
518 user_service->userdata = userdata;
519 user_service->instance = instance;
520 user_service->is_vchi = (args.is_vchi != 0);
521 user_service->dequeue_pending = 0;
522 user_service->close_pending = 0;
523 user_service->message_available_pos =
524 instance->completion_remove - 1;
525 user_service->msg_insert = 0;
526 user_service->msg_remove = 0;
527 sema_init(&user_service->insert_event, 0);
528 sema_init(&user_service->remove_event, 0);
529 sema_init(&user_service->close_event, 0);
532 status = vchiq_open_service_internal
533 (service, instance->pid);
534 if (status != VCHIQ_SUCCESS) {
535 vchiq_remove_service(service->handle);
537 ret = (status == VCHIQ_RETRY) ?
543 if (copy_to_user((void __user *)
544 &(((VCHIQ_CREATE_SERVICE_T __user *)
546 (const void *)&service->handle,
547 sizeof(service->handle)) != 0) {
549 vchiq_remove_service(service->handle);
559 case VCHIQ_IOC_CLOSE_SERVICE: {
560 VCHIQ_SERVICE_HANDLE_T handle = (VCHIQ_SERVICE_HANDLE_T)arg;
562 service = find_service_for_instance(instance, handle);
563 if (service != NULL) {
564 USER_SERVICE_T *user_service =
565 (USER_SERVICE_T *)service->base.userdata;
566 /* close_pending is false on first entry, and when the
567 wait in vchiq_close_service has been interrupted. */
568 if (!user_service->close_pending) {
569 status = vchiq_close_service(service->handle);
570 if (status != VCHIQ_SUCCESS)
574 /* close_pending is true once the underlying service
575 has been closed until the client library calls the
576 CLOSE_DELIVERED ioctl, signalling close_event. */
577 if (user_service->close_pending &&
578 down_interruptible(&user_service->close_event))
579 status = VCHIQ_RETRY;
585 case VCHIQ_IOC_REMOVE_SERVICE: {
586 VCHIQ_SERVICE_HANDLE_T handle = (VCHIQ_SERVICE_HANDLE_T)arg;
588 service = find_service_for_instance(instance, handle);
589 if (service != NULL) {
590 USER_SERVICE_T *user_service =
591 (USER_SERVICE_T *)service->base.userdata;
592 /* close_pending is false on first entry, and when the
593 wait in vchiq_close_service has been interrupted. */
594 if (!user_service->close_pending) {
595 status = vchiq_remove_service(service->handle);
596 if (status != VCHIQ_SUCCESS)
600 /* close_pending is true once the underlying service
601 has been closed until the client library calls the
602 CLOSE_DELIVERED ioctl, signalling close_event. */
603 if (user_service->close_pending &&
604 down_interruptible(&user_service->close_event))
605 status = VCHIQ_RETRY;
611 case VCHIQ_IOC_USE_SERVICE:
612 case VCHIQ_IOC_RELEASE_SERVICE: {
613 VCHIQ_SERVICE_HANDLE_T handle = (VCHIQ_SERVICE_HANDLE_T)arg;
615 service = find_service_for_instance(instance, handle);
616 if (service != NULL) {
617 status = (cmd == VCHIQ_IOC_USE_SERVICE) ?
618 vchiq_use_service_internal(service) :
619 vchiq_release_service_internal(service);
620 if (status != VCHIQ_SUCCESS) {
621 vchiq_log_error(vchiq_susp_log_level,
622 "%s: cmd %s returned error %d for "
623 "service %c%c%c%c:%03d",
625 (cmd == VCHIQ_IOC_USE_SERVICE) ?
626 "VCHIQ_IOC_USE_SERVICE" :
627 "VCHIQ_IOC_RELEASE_SERVICE",
629 VCHIQ_FOURCC_AS_4CHARS(
630 service->base.fourcc),
638 case VCHIQ_IOC_QUEUE_MESSAGE: {
639 VCHIQ_QUEUE_MESSAGE_T args;
641 (&args, (const void __user *)arg,
642 sizeof(args)) != 0) {
647 service = find_service_for_instance(instance, args.handle);
649 if ((service != NULL) && (args.count <= MAX_ELEMENTS)) {
650 /* Copy elements into kernel space */
651 VCHIQ_ELEMENT_T elements[MAX_ELEMENTS];
652 if (copy_from_user(elements, args.elements,
653 args.count * sizeof(VCHIQ_ELEMENT_T)) == 0)
654 status = vchiq_queue_message
656 elements, args.count);
664 case VCHIQ_IOC_QUEUE_BULK_TRANSMIT:
665 case VCHIQ_IOC_QUEUE_BULK_RECEIVE: {
666 VCHIQ_QUEUE_BULK_TRANSFER_T args;
667 struct bulk_waiter_node *waiter = NULL;
668 VCHIQ_BULK_DIR_T dir =
669 (cmd == VCHIQ_IOC_QUEUE_BULK_TRANSMIT) ?
670 VCHIQ_BULK_TRANSMIT : VCHIQ_BULK_RECEIVE;
673 (&args, (const void __user *)arg,
674 sizeof(args)) != 0) {
679 service = find_service_for_instance(instance, args.handle);
685 if (args.mode == VCHIQ_BULK_MODE_BLOCKING) {
686 waiter = kzalloc(sizeof(struct bulk_waiter_node),
692 args.userdata = &waiter->bulk_waiter;
693 } else if (args.mode == VCHIQ_BULK_MODE_WAITING) {
694 struct list_head *pos;
695 mutex_lock(&instance->bulk_waiter_list_mutex);
696 list_for_each(pos, &instance->bulk_waiter_list) {
697 if (list_entry(pos, struct bulk_waiter_node,
698 list)->pid == current->pid) {
699 waiter = list_entry(pos,
700 struct bulk_waiter_node,
707 mutex_unlock(&instance->bulk_waiter_list_mutex);
709 vchiq_log_error(vchiq_arm_log_level,
710 "no bulk_waiter found for pid %d",
715 vchiq_log_info(vchiq_arm_log_level,
716 "found bulk_waiter %x for pid %d",
717 (unsigned int)waiter, current->pid);
718 args.userdata = &waiter->bulk_waiter;
720 status = vchiq_bulk_transfer
722 VCHI_MEM_HANDLE_INVALID,
723 args.data, args.size,
724 args.userdata, args.mode,
728 if ((status != VCHIQ_RETRY) || fatal_signal_pending(current) ||
729 !waiter->bulk_waiter.bulk) {
730 if (waiter->bulk_waiter.bulk) {
731 /* Cancel the signal when the transfer
733 spin_lock(&bulk_waiter_spinlock);
734 waiter->bulk_waiter.bulk->userdata = NULL;
735 spin_unlock(&bulk_waiter_spinlock);
739 const VCHIQ_BULK_MODE_T mode_waiting =
740 VCHIQ_BULK_MODE_WAITING;
741 waiter->pid = current->pid;
742 mutex_lock(&instance->bulk_waiter_list_mutex);
743 list_add(&waiter->list, &instance->bulk_waiter_list);
744 mutex_unlock(&instance->bulk_waiter_list_mutex);
745 vchiq_log_info(vchiq_arm_log_level,
746 "saved bulk_waiter %x for pid %d",
747 (unsigned int)waiter, current->pid);
749 if (copy_to_user((void __user *)
750 &(((VCHIQ_QUEUE_BULK_TRANSFER_T __user *)
752 (const void *)&mode_waiting,
753 sizeof(mode_waiting)) != 0)
758 case VCHIQ_IOC_AWAIT_COMPLETION: {
759 VCHIQ_AWAIT_COMPLETION_T args;
761 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
762 if (!instance->connected) {
767 if (copy_from_user(&args, (const void __user *)arg,
768 sizeof(args)) != 0) {
773 mutex_lock(&instance->completion_mutex);
775 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
776 while ((instance->completion_remove ==
777 instance->completion_insert)
778 && !instance->closing) {
780 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
781 mutex_unlock(&instance->completion_mutex);
782 rc = down_interruptible(&instance->insert_event);
783 mutex_lock(&instance->completion_mutex);
785 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
786 vchiq_log_info(vchiq_arm_log_level,
787 "AWAIT_COMPLETION interrupted");
792 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
794 /* A read memory barrier is needed to stop prefetch of a stale
800 int msgbufcount = args.msgbufcount;
801 for (ret = 0; ret < args.count; ret++) {
802 VCHIQ_COMPLETION_DATA_T *completion;
803 VCHIQ_SERVICE_T *service;
804 USER_SERVICE_T *user_service;
805 VCHIQ_HEADER_T *header;
806 if (instance->completion_remove ==
807 instance->completion_insert)
809 completion = &instance->completions[
810 instance->completion_remove &
811 (MAX_COMPLETIONS - 1)];
813 service = completion->service_userdata;
814 user_service = service->base.userdata;
815 completion->service_userdata =
816 user_service->userdata;
818 header = completion->header;
823 msglen = header->size +
824 sizeof(VCHIQ_HEADER_T);
825 /* This must be a VCHIQ-style service */
826 if (args.msgbufsize < msglen) {
829 "header %x: msgbufsize"
831 (unsigned int)header,
834 WARN(1, "invalid message "
840 if (msgbufcount <= 0)
841 /* Stall here for lack of a
842 ** buffer for the message. */
844 /* Get the pointer from user space */
846 if (copy_from_user(&msgbuf,
847 (const void __user *)
848 &args.msgbufs[msgbufcount],
849 sizeof(msgbuf)) != 0) {
855 /* Copy the message to user space */
856 if (copy_to_user(msgbuf, header,
863 /* Now it has been copied, the message
864 ** can be released. */
865 vchiq_release_message(service->handle,
868 /* The completion must point to the
870 completion->header = msgbuf;
873 if ((completion->reason ==
874 VCHIQ_SERVICE_CLOSED) &&
875 !instance->use_close_delivered)
876 unlock_service(service);
878 if (copy_to_user((void __user *)(
880 ret * sizeof(VCHIQ_COMPLETION_DATA_T)),
882 sizeof(VCHIQ_COMPLETION_DATA_T)) != 0) {
888 instance->completion_remove++;
891 if (msgbufcount != args.msgbufcount) {
892 if (copy_to_user((void __user *)
893 &((VCHIQ_AWAIT_COMPLETION_T *)arg)->
896 sizeof(msgbufcount)) != 0) {
903 up(&instance->remove_event);
904 mutex_unlock(&instance->completion_mutex);
905 DEBUG_TRACE(AWAIT_COMPLETION_LINE);
908 case VCHIQ_IOC_DEQUEUE_MESSAGE: {
909 VCHIQ_DEQUEUE_MESSAGE_T args;
910 USER_SERVICE_T *user_service;
911 VCHIQ_HEADER_T *header;
913 DEBUG_TRACE(DEQUEUE_MESSAGE_LINE);
915 (&args, (const void __user *)arg,
916 sizeof(args)) != 0) {
920 service = find_service_for_instance(instance, args.handle);
925 user_service = (USER_SERVICE_T *)service->base.userdata;
926 if (user_service->is_vchi == 0) {
931 spin_lock(&msg_queue_spinlock);
932 if (user_service->msg_remove == user_service->msg_insert) {
933 if (!args.blocking) {
934 spin_unlock(&msg_queue_spinlock);
935 DEBUG_TRACE(DEQUEUE_MESSAGE_LINE);
939 user_service->dequeue_pending = 1;
941 spin_unlock(&msg_queue_spinlock);
942 DEBUG_TRACE(DEQUEUE_MESSAGE_LINE);
943 if (down_interruptible(
944 &user_service->insert_event) != 0) {
945 vchiq_log_info(vchiq_arm_log_level,
946 "DEQUEUE_MESSAGE interrupted");
950 spin_lock(&msg_queue_spinlock);
951 } while (user_service->msg_remove ==
952 user_service->msg_insert);
958 BUG_ON((int)(user_service->msg_insert -
959 user_service->msg_remove) < 0);
961 header = user_service->msg_queue[user_service->msg_remove &
962 (MSG_QUEUE_SIZE - 1)];
963 user_service->msg_remove++;
964 spin_unlock(&msg_queue_spinlock);
966 up(&user_service->remove_event);
969 else if (header->size <= args.bufsize) {
970 /* Copy to user space if msgbuf is not NULL */
971 if ((args.buf == NULL) ||
972 (copy_to_user((void __user *)args.buf,
974 header->size) == 0)) {
976 vchiq_release_message(
982 vchiq_log_error(vchiq_arm_log_level,
983 "header %x: bufsize %x < size %x",
984 (unsigned int)header, args.bufsize,
986 WARN(1, "invalid size\n");
989 DEBUG_TRACE(DEQUEUE_MESSAGE_LINE);
992 case VCHIQ_IOC_GET_CLIENT_ID: {
993 VCHIQ_SERVICE_HANDLE_T handle = (VCHIQ_SERVICE_HANDLE_T)arg;
995 ret = vchiq_get_client_id(handle);
998 case VCHIQ_IOC_GET_CONFIG: {
999 VCHIQ_GET_CONFIG_T args;
1000 VCHIQ_CONFIG_T config;
1002 if (copy_from_user(&args, (const void __user *)arg,
1003 sizeof(args)) != 0) {
1007 if (args.config_size > sizeof(config)) {
1011 status = vchiq_get_config(instance, args.config_size, &config);
1012 if (status == VCHIQ_SUCCESS) {
1013 if (copy_to_user((void __user *)args.pconfig,
1014 &config, args.config_size) != 0) {
1021 case VCHIQ_IOC_SET_SERVICE_OPTION: {
1022 VCHIQ_SET_SERVICE_OPTION_T args;
1025 &args, (const void __user *)arg,
1026 sizeof(args)) != 0) {
1031 service = find_service_for_instance(instance, args.handle);
1037 status = vchiq_set_service_option(
1038 args.handle, args.option, args.value);
1041 case VCHIQ_IOC_DUMP_PHYS_MEM: {
1042 VCHIQ_DUMP_MEM_T args;
1045 (&args, (const void __user *)arg,
1046 sizeof(args)) != 0) {
1050 dump_phys_mem(args.virt_addr, args.num_bytes);
1053 case VCHIQ_IOC_LIB_VERSION: {
1054 unsigned int lib_version = (unsigned int)arg;
1056 if (lib_version < VCHIQ_VERSION_MIN)
1058 else if (lib_version >= VCHIQ_VERSION_CLOSE_DELIVERED)
1059 instance->use_close_delivered = 1;
1062 case VCHIQ_IOC_CLOSE_DELIVERED: {
1063 VCHIQ_SERVICE_HANDLE_T handle = (VCHIQ_SERVICE_HANDLE_T)arg;
1065 service = find_closed_service_for_instance(instance, handle);
1066 if (service != NULL) {
1067 USER_SERVICE_T *user_service =
1068 (USER_SERVICE_T *)service->base.userdata;
1069 close_delivered(user_service);
1081 unlock_service(service);
1084 if (status == VCHIQ_ERROR)
1086 else if (status == VCHIQ_RETRY)
1090 if ((status == VCHIQ_SUCCESS) && (ret < 0) && (ret != -EINTR) &&
1091 (ret != -EWOULDBLOCK))
1092 vchiq_log_info(vchiq_arm_log_level,
1093 " ioctl instance %lx, cmd %s -> status %d, %ld",
1094 (unsigned long)instance,
1095 (_IOC_NR(cmd) <= VCHIQ_IOC_MAX) ?
1096 ioctl_names[_IOC_NR(cmd)] :
1100 vchiq_log_trace(vchiq_arm_log_level,
1101 " ioctl instance %lx, cmd %s -> status %d, %ld",
1102 (unsigned long)instance,
1103 (_IOC_NR(cmd) <= VCHIQ_IOC_MAX) ?
1104 ioctl_names[_IOC_NR(cmd)] :
1111 /****************************************************************************
1115 ***************************************************************************/
1118 vchiq_open(struct inode *inode, struct file *file)
1120 int dev = iminor(inode) & 0x0f;
1121 vchiq_log_info(vchiq_arm_log_level, "vchiq_open");
1125 VCHIQ_STATE_T *state = vchiq_get_state();
1126 VCHIQ_INSTANCE_T instance;
1129 vchiq_log_error(vchiq_arm_log_level,
1130 "vchiq has no connection to VideoCore");
1134 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1138 instance->state = state;
1139 instance->pid = current->tgid;
1141 ret = vchiq_debugfs_add_instance(instance);
1147 sema_init(&instance->insert_event, 0);
1148 sema_init(&instance->remove_event, 0);
1149 mutex_init(&instance->completion_mutex);
1150 mutex_init(&instance->bulk_waiter_list_mutex);
1151 INIT_LIST_HEAD(&instance->bulk_waiter_list);
1153 file->private_data = instance;
1157 vchiq_log_error(vchiq_arm_log_level,
1158 "Unknown minor device: %d", dev);
1165 /****************************************************************************
1169 ***************************************************************************/
1172 vchiq_release(struct inode *inode, struct file *file)
1174 int dev = iminor(inode) & 0x0f;
1178 VCHIQ_INSTANCE_T instance = file->private_data;
1179 VCHIQ_STATE_T *state = vchiq_get_state();
1180 VCHIQ_SERVICE_T *service;
1183 vchiq_log_info(vchiq_arm_log_level,
1184 "vchiq_release: instance=%lx",
1185 (unsigned long)instance);
1192 /* Ensure videocore is awake to allow termination. */
1193 vchiq_use_internal(instance->state, NULL,
1196 mutex_lock(&instance->completion_mutex);
1198 /* Wake the completion thread and ask it to exit */
1199 instance->closing = 1;
1200 up(&instance->insert_event);
1202 mutex_unlock(&instance->completion_mutex);
1204 /* Wake the slot handler if the completion queue is full. */
1205 up(&instance->remove_event);
1207 /* Mark all services for termination... */
1209 while ((service = next_service_by_instance(state, instance,
1211 USER_SERVICE_T *user_service = service->base.userdata;
1213 /* Wake the slot handler if the msg queue is full. */
1214 up(&user_service->remove_event);
1216 vchiq_terminate_service_internal(service);
1217 unlock_service(service);
1220 /* ...and wait for them to die */
1222 while ((service = next_service_by_instance(state, instance, &i))
1224 USER_SERVICE_T *user_service = service->base.userdata;
1226 down(&service->remove_event);
1228 BUG_ON(service->srvstate != VCHIQ_SRVSTATE_FREE);
1230 spin_lock(&msg_queue_spinlock);
1232 while (user_service->msg_remove !=
1233 user_service->msg_insert) {
1234 VCHIQ_HEADER_T *header = user_service->
1235 msg_queue[user_service->msg_remove &
1236 (MSG_QUEUE_SIZE - 1)];
1237 user_service->msg_remove++;
1238 spin_unlock(&msg_queue_spinlock);
1241 vchiq_release_message(
1244 spin_lock(&msg_queue_spinlock);
1247 spin_unlock(&msg_queue_spinlock);
1249 unlock_service(service);
1252 /* Release any closed services */
1253 while (instance->completion_remove !=
1254 instance->completion_insert) {
1255 VCHIQ_COMPLETION_DATA_T *completion;
1256 VCHIQ_SERVICE_T *service;
1257 completion = &instance->completions[
1258 instance->completion_remove &
1259 (MAX_COMPLETIONS - 1)];
1260 service = completion->service_userdata;
1261 if (completion->reason == VCHIQ_SERVICE_CLOSED)
1263 USER_SERVICE_T *user_service =
1264 service->base.userdata;
1266 /* Wake any blocked user-thread */
1267 if (instance->use_close_delivered)
1268 up(&user_service->close_event);
1269 unlock_service(service);
1271 instance->completion_remove++;
1274 /* Release the PEER service count. */
1275 vchiq_release_internal(instance->state, NULL);
1278 struct list_head *pos, *next;
1279 list_for_each_safe(pos, next,
1280 &instance->bulk_waiter_list) {
1281 struct bulk_waiter_node *waiter;
1282 waiter = list_entry(pos,
1283 struct bulk_waiter_node,
1286 vchiq_log_info(vchiq_arm_log_level,
1287 "bulk_waiter - cleaned up %x "
1289 (unsigned int)waiter, waiter->pid);
1294 vchiq_debugfs_remove_instance(instance);
1297 file->private_data = NULL;
1301 vchiq_log_error(vchiq_arm_log_level,
1302 "Unknown minor device: %d", dev);
1310 /****************************************************************************
1314 ***************************************************************************/
1317 vchiq_dump(void *dump_context, const char *str, int len)
1319 DUMP_CONTEXT_T *context = (DUMP_CONTEXT_T *)dump_context;
1321 if (context->actual < context->space) {
1323 if (context->offset > 0) {
1324 int skip_bytes = min(len, (int)context->offset);
1327 context->offset -= skip_bytes;
1328 if (context->offset > 0)
1331 copy_bytes = min(len, (int)(context->space - context->actual));
1332 if (copy_bytes == 0)
1334 if (copy_to_user(context->buf + context->actual, str,
1336 context->actual = -EFAULT;
1337 context->actual += copy_bytes;
1340 /* If tne terminating NUL is included in the length, then it
1341 ** marks the end of a line and should be replaced with a
1342 ** carriage return. */
1343 if ((len == 0) && (str[copy_bytes - 1] == '\0')) {
1345 if (copy_to_user(context->buf + context->actual - 1,
1347 context->actual = -EFAULT;
1352 /****************************************************************************
1354 * vchiq_dump_platform_instance_state
1356 ***************************************************************************/
1359 vchiq_dump_platform_instances(void *dump_context)
1361 VCHIQ_STATE_T *state = vchiq_get_state();
1366 /* There is no list of instances, so instead scan all services,
1367 marking those that have been dumped. */
1369 for (i = 0; i < state->unused_service; i++) {
1370 VCHIQ_SERVICE_T *service = state->services[i];
1371 VCHIQ_INSTANCE_T instance;
1373 if (service && (service->base.callback == service_callback)) {
1374 instance = service->instance;
1380 for (i = 0; i < state->unused_service; i++) {
1381 VCHIQ_SERVICE_T *service = state->services[i];
1382 VCHIQ_INSTANCE_T instance;
1384 if (service && (service->base.callback == service_callback)) {
1385 instance = service->instance;
1386 if (instance && !instance->mark) {
1387 len = snprintf(buf, sizeof(buf),
1388 "Instance %x: pid %d,%s completions "
1390 (unsigned int)instance, instance->pid,
1391 instance->connected ? " connected, " :
1393 instance->completion_insert -
1394 instance->completion_remove,
1397 vchiq_dump(dump_context, buf, len + 1);
1405 /****************************************************************************
1407 * vchiq_dump_platform_service_state
1409 ***************************************************************************/
1412 vchiq_dump_platform_service_state(void *dump_context, VCHIQ_SERVICE_T *service)
1414 USER_SERVICE_T *user_service = (USER_SERVICE_T *)service->base.userdata;
1418 len = snprintf(buf, sizeof(buf), " instance %x",
1419 (unsigned int)service->instance);
1421 if ((service->base.callback == service_callback) &&
1422 user_service->is_vchi) {
1423 len += snprintf(buf + len, sizeof(buf) - len,
1425 user_service->msg_insert - user_service->msg_remove,
1428 if (user_service->dequeue_pending)
1429 len += snprintf(buf + len, sizeof(buf) - len,
1430 " (dequeue pending)");
1433 vchiq_dump(dump_context, buf, len + 1);
1436 /****************************************************************************
1440 ***************************************************************************/
1443 dump_phys_mem(void *virt_addr, uint32_t num_bytes)
1446 uint8_t *end_virt_addr = virt_addr + num_bytes;
1453 struct page **pages;
1454 uint8_t *kmapped_virt_ptr;
1456 /* Align virtAddr and endVirtAddr to 16 byte boundaries. */
1458 virt_addr = (void *)((unsigned long)virt_addr & ~0x0fuL);
1459 end_virt_addr = (void *)(((unsigned long)end_virt_addr + 15uL) &
1462 offset = (int)(long)virt_addr & (PAGE_SIZE - 1);
1463 end_offset = (int)(long)end_virt_addr & (PAGE_SIZE - 1);
1465 num_pages = (offset + num_bytes + PAGE_SIZE - 1) / PAGE_SIZE;
1467 pages = kmalloc(sizeof(struct page *) * num_pages, GFP_KERNEL);
1468 if (pages == NULL) {
1469 vchiq_log_error(vchiq_arm_log_level,
1470 "Unable to allocation memory for %d pages\n",
1475 down_read(¤t->mm->mmap_sem);
1476 rc = get_user_pages(current, /* task */
1477 current->mm, /* mm */
1478 (unsigned long)virt_addr, /* start */
1479 num_pages, /* len */
1482 pages, /* pages (array of page pointers) */
1484 up_read(¤t->mm->mmap_sem);
1489 while (offset < end_offset) {
1491 int page_offset = offset % PAGE_SIZE;
1492 page_idx = offset / PAGE_SIZE;
1494 if (page_idx != prev_idx) {
1498 page = pages[page_idx];
1499 kmapped_virt_ptr = kmap(page);
1501 prev_idx = page_idx;
1504 if (vchiq_arm_log_level >= VCHIQ_LOG_TRACE)
1505 vchiq_log_dump_mem("ph",
1506 (uint32_t)(unsigned long)&kmapped_virt_ptr[
1508 &kmapped_virt_ptr[page_offset], 16);
1515 for (page_idx = 0; page_idx < num_pages; page_idx++)
1516 page_cache_release(pages[page_idx]);
1521 /****************************************************************************
1525 ***************************************************************************/
1528 vchiq_read(struct file *file, char __user *buf,
1529 size_t count, loff_t *ppos)
1531 DUMP_CONTEXT_T context;
1534 context.space = count;
1535 context.offset = *ppos;
1537 vchiq_dump_state(&context, &g_state);
1539 *ppos += context.actual;
1541 return context.actual;
1545 vchiq_get_state(void)
1548 if (g_state.remote == NULL)
1549 printk(KERN_ERR "%s: g_state.remote == NULL\n", __func__);
1550 else if (g_state.remote->initialised != 1)
1551 printk(KERN_NOTICE "%s: g_state.remote->initialised != 1 (%d)\n",
1552 __func__, g_state.remote->initialised);
1554 return ((g_state.remote != NULL) &&
1555 (g_state.remote->initialised == 1)) ? &g_state : NULL;
1558 static const struct file_operations
1560 .owner = THIS_MODULE,
1561 .unlocked_ioctl = vchiq_ioctl,
1563 .release = vchiq_release,
1568 * Autosuspend related functionality
1572 vchiq_videocore_wanted(VCHIQ_STATE_T *state)
1574 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
1576 /* autosuspend not supported - always return wanted */
1578 else if (arm_state->blocked_count)
1580 else if (!arm_state->videocore_use_count)
1581 /* usage count zero - check for override unless we're forcing */
1582 if (arm_state->resume_blocked)
1585 return vchiq_platform_videocore_wanted(state);
1587 /* non-zero usage count - videocore still required */
1591 static VCHIQ_STATUS_T
1592 vchiq_keepalive_vchiq_callback(VCHIQ_REASON_T reason,
1593 VCHIQ_HEADER_T *header,
1594 VCHIQ_SERVICE_HANDLE_T service_user,
1597 vchiq_log_error(vchiq_susp_log_level,
1598 "%s callback reason %d", __func__, reason);
1603 vchiq_keepalive_thread_func(void *v)
1605 VCHIQ_STATE_T *state = (VCHIQ_STATE_T *) v;
1606 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
1608 VCHIQ_STATUS_T status;
1609 VCHIQ_INSTANCE_T instance;
1610 VCHIQ_SERVICE_HANDLE_T ka_handle;
1612 VCHIQ_SERVICE_PARAMS_T params = {
1613 .fourcc = VCHIQ_MAKE_FOURCC('K', 'E', 'E', 'P'),
1614 .callback = vchiq_keepalive_vchiq_callback,
1615 .version = KEEPALIVE_VER,
1616 .version_min = KEEPALIVE_VER_MIN
1619 status = vchiq_initialise(&instance);
1620 if (status != VCHIQ_SUCCESS) {
1621 vchiq_log_error(vchiq_susp_log_level,
1622 "%s vchiq_initialise failed %d", __func__, status);
1626 status = vchiq_connect(instance);
1627 if (status != VCHIQ_SUCCESS) {
1628 vchiq_log_error(vchiq_susp_log_level,
1629 "%s vchiq_connect failed %d", __func__, status);
1633 status = vchiq_add_service(instance, ¶ms, &ka_handle);
1634 if (status != VCHIQ_SUCCESS) {
1635 vchiq_log_error(vchiq_susp_log_level,
1636 "%s vchiq_open_service failed %d", __func__, status);
1641 long rc = 0, uc = 0;
1642 if (wait_for_completion_interruptible(&arm_state->ka_evt)
1644 vchiq_log_error(vchiq_susp_log_level,
1645 "%s interrupted", __func__);
1646 flush_signals(current);
1650 /* read and clear counters. Do release_count then use_count to
1651 * prevent getting more releases than uses */
1652 rc = atomic_xchg(&arm_state->ka_release_count, 0);
1653 uc = atomic_xchg(&arm_state->ka_use_count, 0);
1655 /* Call use/release service the requisite number of times.
1656 * Process use before release so use counts don't go negative */
1658 atomic_inc(&arm_state->ka_use_ack_count);
1659 status = vchiq_use_service(ka_handle);
1660 if (status != VCHIQ_SUCCESS) {
1661 vchiq_log_error(vchiq_susp_log_level,
1662 "%s vchiq_use_service error %d",
1667 status = vchiq_release_service(ka_handle);
1668 if (status != VCHIQ_SUCCESS) {
1669 vchiq_log_error(vchiq_susp_log_level,
1670 "%s vchiq_release_service error %d",
1677 vchiq_shutdown(instance);
1685 vchiq_arm_init_state(VCHIQ_STATE_T *state, VCHIQ_ARM_STATE_T *arm_state)
1687 VCHIQ_STATUS_T status = VCHIQ_SUCCESS;
1690 rwlock_init(&arm_state->susp_res_lock);
1692 init_completion(&arm_state->ka_evt);
1693 atomic_set(&arm_state->ka_use_count, 0);
1694 atomic_set(&arm_state->ka_use_ack_count, 0);
1695 atomic_set(&arm_state->ka_release_count, 0);
1697 init_completion(&arm_state->vc_suspend_complete);
1699 init_completion(&arm_state->vc_resume_complete);
1700 /* Initialise to 'done' state. We only want to block on resume
1701 * completion while videocore is suspended. */
1702 set_resume_state(arm_state, VC_RESUME_RESUMED);
1704 init_completion(&arm_state->resume_blocker);
1705 /* Initialise to 'done' state. We only want to block on this
1706 * completion while resume is blocked */
1707 complete_all(&arm_state->resume_blocker);
1709 init_completion(&arm_state->blocked_blocker);
1710 /* Initialise to 'done' state. We only want to block on this
1711 * completion while things are waiting on the resume blocker */
1712 complete_all(&arm_state->blocked_blocker);
1714 arm_state->suspend_timer_timeout = SUSPEND_TIMER_TIMEOUT_MS;
1715 arm_state->suspend_timer_running = 0;
1716 init_timer(&arm_state->suspend_timer);
1717 arm_state->suspend_timer.data = (unsigned long)(state);
1718 arm_state->suspend_timer.function = suspend_timer_callback;
1720 arm_state->first_connect = 0;
1727 ** Functions to modify the state variables;
1728 ** set_suspend_state
1731 ** There are more state variables than we might like, so ensure they remain in
1732 ** step. Suspend and resume state are maintained separately, since most of
1733 ** these state machines can operate independently. However, there are a few
1734 ** states where state transitions in one state machine cause a reset to the
1735 ** other state machine. In addition, there are some completion events which
1736 ** need to occur on state machine reset and end-state(s), so these are also
1737 ** dealt with in these functions.
1739 ** In all states we set the state variable according to the input, but in some
1740 ** cases we perform additional steps outlined below;
1742 ** VC_SUSPEND_IDLE - Initialise the suspend completion at the same time.
1743 ** The suspend completion is completed after any suspend
1744 ** attempt. When we reset the state machine we also reset
1745 ** the completion. This reset occurs when videocore is
1746 ** resumed, and also if we initiate suspend after a suspend
1749 ** VC_SUSPEND_IN_PROGRESS - This state is considered the point of no return for
1750 ** suspend - ie from this point on we must try to suspend
1751 ** before resuming can occur. We therefore also reset the
1752 ** resume state machine to VC_RESUME_IDLE in this state.
1754 ** VC_SUSPEND_SUSPENDED - Suspend has completed successfully. Also call
1755 ** complete_all on the suspend completion to notify
1756 ** anything waiting for suspend to happen.
1758 ** VC_SUSPEND_REJECTED - Videocore rejected suspend. Videocore will also
1759 ** initiate resume, so no need to alter resume state.
1760 ** We call complete_all on the suspend completion to notify
1761 ** of suspend rejection.
1763 ** VC_SUSPEND_FAILED - We failed to initiate videocore suspend. We notify the
1764 ** suspend completion and reset the resume state machine.
1766 ** VC_RESUME_IDLE - Initialise the resume completion at the same time. The
1767 ** resume completion is in it's 'done' state whenever
1768 ** videcore is running. Therfore, the VC_RESUME_IDLE state
1769 ** implies that videocore is suspended.
1770 ** Hence, any thread which needs to wait until videocore is
1771 ** running can wait on this completion - it will only block
1772 ** if videocore is suspended.
1774 ** VC_RESUME_RESUMED - Resume has completed successfully. Videocore is running.
1775 ** Call complete_all on the resume completion to unblock
1776 ** any threads waiting for resume. Also reset the suspend
1777 ** state machine to it's idle state.
1779 ** VC_RESUME_FAILED - Currently unused - no mechanism to fail resume exists.
1783 set_suspend_state(VCHIQ_ARM_STATE_T *arm_state,
1784 enum vc_suspend_status new_state)
1786 /* set the state in all cases */
1787 arm_state->vc_suspend_state = new_state;
1789 /* state specific additional actions */
1790 switch (new_state) {
1791 case VC_SUSPEND_FORCE_CANCELED:
1792 complete_all(&arm_state->vc_suspend_complete);
1794 case VC_SUSPEND_REJECTED:
1795 complete_all(&arm_state->vc_suspend_complete);
1797 case VC_SUSPEND_FAILED:
1798 complete_all(&arm_state->vc_suspend_complete);
1799 arm_state->vc_resume_state = VC_RESUME_RESUMED;
1800 complete_all(&arm_state->vc_resume_complete);
1802 case VC_SUSPEND_IDLE:
1803 reinit_completion(&arm_state->vc_suspend_complete);
1805 case VC_SUSPEND_REQUESTED:
1807 case VC_SUSPEND_IN_PROGRESS:
1808 set_resume_state(arm_state, VC_RESUME_IDLE);
1810 case VC_SUSPEND_SUSPENDED:
1811 complete_all(&arm_state->vc_suspend_complete);
1820 set_resume_state(VCHIQ_ARM_STATE_T *arm_state,
1821 enum vc_resume_status new_state)
1823 /* set the state in all cases */
1824 arm_state->vc_resume_state = new_state;
1826 /* state specific additional actions */
1827 switch (new_state) {
1828 case VC_RESUME_FAILED:
1830 case VC_RESUME_IDLE:
1831 reinit_completion(&arm_state->vc_resume_complete);
1833 case VC_RESUME_REQUESTED:
1835 case VC_RESUME_IN_PROGRESS:
1837 case VC_RESUME_RESUMED:
1838 complete_all(&arm_state->vc_resume_complete);
1839 set_suspend_state(arm_state, VC_SUSPEND_IDLE);
1848 /* should be called with the write lock held */
1850 start_suspend_timer(VCHIQ_ARM_STATE_T *arm_state)
1852 del_timer(&arm_state->suspend_timer);
1853 arm_state->suspend_timer.expires = jiffies +
1854 msecs_to_jiffies(arm_state->
1855 suspend_timer_timeout);
1856 add_timer(&arm_state->suspend_timer);
1857 arm_state->suspend_timer_running = 1;
1860 /* should be called with the write lock held */
1862 stop_suspend_timer(VCHIQ_ARM_STATE_T *arm_state)
1864 if (arm_state->suspend_timer_running) {
1865 del_timer(&arm_state->suspend_timer);
1866 arm_state->suspend_timer_running = 0;
1871 need_resume(VCHIQ_STATE_T *state)
1873 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
1874 return (arm_state->vc_suspend_state > VC_SUSPEND_IDLE) &&
1875 (arm_state->vc_resume_state < VC_RESUME_REQUESTED) &&
1876 vchiq_videocore_wanted(state);
1880 block_resume(VCHIQ_ARM_STATE_T *arm_state)
1882 int status = VCHIQ_SUCCESS;
1883 const unsigned long timeout_val =
1884 msecs_to_jiffies(FORCE_SUSPEND_TIMEOUT_MS);
1885 int resume_count = 0;
1887 /* Allow any threads which were blocked by the last force suspend to
1888 * complete if they haven't already. Only give this one shot; if
1889 * blocked_count is incremented after blocked_blocker is completed
1890 * (which only happens when blocked_count hits 0) then those threads
1891 * will have to wait until next time around */
1892 if (arm_state->blocked_count) {
1893 reinit_completion(&arm_state->blocked_blocker);
1894 write_unlock_bh(&arm_state->susp_res_lock);
1895 vchiq_log_info(vchiq_susp_log_level, "%s wait for previously "
1896 "blocked clients", __func__);
1897 if (wait_for_completion_interruptible_timeout(
1898 &arm_state->blocked_blocker, timeout_val)
1900 vchiq_log_error(vchiq_susp_log_level, "%s wait for "
1901 "previously blocked clients failed" , __func__);
1902 status = VCHIQ_ERROR;
1903 write_lock_bh(&arm_state->susp_res_lock);
1906 vchiq_log_info(vchiq_susp_log_level, "%s previously blocked "
1907 "clients resumed", __func__);
1908 write_lock_bh(&arm_state->susp_res_lock);
1911 /* We need to wait for resume to complete if it's in process */
1912 while (arm_state->vc_resume_state != VC_RESUME_RESUMED &&
1913 arm_state->vc_resume_state > VC_RESUME_IDLE) {
1914 if (resume_count > 1) {
1915 status = VCHIQ_ERROR;
1916 vchiq_log_error(vchiq_susp_log_level, "%s waited too "
1917 "many times for resume" , __func__);
1920 write_unlock_bh(&arm_state->susp_res_lock);
1921 vchiq_log_info(vchiq_susp_log_level, "%s wait for resume",
1923 if (wait_for_completion_interruptible_timeout(
1924 &arm_state->vc_resume_complete, timeout_val)
1926 vchiq_log_error(vchiq_susp_log_level, "%s wait for "
1927 "resume failed (%s)", __func__,
1928 resume_state_names[arm_state->vc_resume_state +
1929 VC_RESUME_NUM_OFFSET]);
1930 status = VCHIQ_ERROR;
1931 write_lock_bh(&arm_state->susp_res_lock);
1934 vchiq_log_info(vchiq_susp_log_level, "%s resumed", __func__);
1935 write_lock_bh(&arm_state->susp_res_lock);
1938 reinit_completion(&arm_state->resume_blocker);
1939 arm_state->resume_blocked = 1;
1946 unblock_resume(VCHIQ_ARM_STATE_T *arm_state)
1948 complete_all(&arm_state->resume_blocker);
1949 arm_state->resume_blocked = 0;
1952 /* Initiate suspend via slot handler. Should be called with the write lock
1955 vchiq_arm_vcsuspend(VCHIQ_STATE_T *state)
1957 VCHIQ_STATUS_T status = VCHIQ_ERROR;
1958 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
1963 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
1964 status = VCHIQ_SUCCESS;
1967 switch (arm_state->vc_suspend_state) {
1968 case VC_SUSPEND_REQUESTED:
1969 vchiq_log_info(vchiq_susp_log_level, "%s: suspend already "
1970 "requested", __func__);
1972 case VC_SUSPEND_IN_PROGRESS:
1973 vchiq_log_info(vchiq_susp_log_level, "%s: suspend already in "
1974 "progress", __func__);
1978 /* We don't expect to be in other states, so log but continue
1980 vchiq_log_error(vchiq_susp_log_level,
1981 "%s unexpected suspend state %s", __func__,
1982 suspend_state_names[arm_state->vc_suspend_state +
1983 VC_SUSPEND_NUM_OFFSET]);
1985 case VC_SUSPEND_REJECTED:
1986 case VC_SUSPEND_FAILED:
1987 /* Ensure any idle state actions have been run */
1988 set_suspend_state(arm_state, VC_SUSPEND_IDLE);
1990 case VC_SUSPEND_IDLE:
1991 vchiq_log_info(vchiq_susp_log_level,
1992 "%s: suspending", __func__);
1993 set_suspend_state(arm_state, VC_SUSPEND_REQUESTED);
1994 /* kick the slot handler thread to initiate suspend */
1995 request_poll(state, NULL, 0);
2000 vchiq_log_trace(vchiq_susp_log_level, "%s exit %d", __func__, status);
2005 vchiq_platform_check_suspend(VCHIQ_STATE_T *state)
2007 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2013 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2015 write_lock_bh(&arm_state->susp_res_lock);
2016 if (arm_state->vc_suspend_state == VC_SUSPEND_REQUESTED &&
2017 arm_state->vc_resume_state == VC_RESUME_RESUMED) {
2018 set_suspend_state(arm_state, VC_SUSPEND_IN_PROGRESS);
2021 write_unlock_bh(&arm_state->susp_res_lock);
2024 vchiq_platform_suspend(state);
2027 vchiq_log_trace(vchiq_susp_log_level, "%s exit", __func__);
2033 output_timeout_error(VCHIQ_STATE_T *state)
2035 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2036 char service_err[50] = "";
2037 int vc_use_count = arm_state->videocore_use_count;
2038 int active_services = state->unused_service;
2041 if (!arm_state->videocore_use_count) {
2042 snprintf(service_err, 50, " Videocore usecount is 0");
2045 for (i = 0; i < active_services; i++) {
2046 VCHIQ_SERVICE_T *service_ptr = state->services[i];
2047 if (service_ptr && service_ptr->service_use_count &&
2048 (service_ptr->srvstate != VCHIQ_SRVSTATE_FREE)) {
2049 snprintf(service_err, 50, " %c%c%c%c(%d) service has "
2050 "use count %d%s", VCHIQ_FOURCC_AS_4CHARS(
2051 service_ptr->base.fourcc),
2052 service_ptr->client_id,
2053 service_ptr->service_use_count,
2054 service_ptr->service_use_count ==
2055 vc_use_count ? "" : " (+ more)");
2061 vchiq_log_error(vchiq_susp_log_level,
2062 "timed out waiting for vc suspend (%d).%s",
2063 arm_state->autosuspend_override, service_err);
2067 /* Try to get videocore into suspended state, regardless of autosuspend state.
2068 ** We don't actually force suspend, since videocore may get into a bad state
2069 ** if we force suspend at a bad time. Instead, we wait for autosuspend to
2070 ** determine a good point to suspend. If this doesn't happen within 100ms we
2073 ** Returns VCHIQ_SUCCESS if videocore suspended successfully, VCHIQ_RETRY if
2074 ** videocore failed to suspend in time or VCHIQ_ERROR if interrupted.
2077 vchiq_arm_force_suspend(VCHIQ_STATE_T *state)
2079 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2080 VCHIQ_STATUS_T status = VCHIQ_ERROR;
2087 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2089 write_lock_bh(&arm_state->susp_res_lock);
2091 status = block_resume(arm_state);
2092 if (status != VCHIQ_SUCCESS)
2094 if (arm_state->vc_suspend_state == VC_SUSPEND_SUSPENDED) {
2095 /* Already suspended - just block resume and exit */
2096 vchiq_log_info(vchiq_susp_log_level, "%s already suspended",
2098 status = VCHIQ_SUCCESS;
2100 } else if (arm_state->vc_suspend_state <= VC_SUSPEND_IDLE) {
2101 /* initiate suspend immediately in the case that we're waiting
2102 * for the timeout */
2103 stop_suspend_timer(arm_state);
2104 if (!vchiq_videocore_wanted(state)) {
2105 vchiq_log_info(vchiq_susp_log_level, "%s videocore "
2106 "idle, initiating suspend", __func__);
2107 status = vchiq_arm_vcsuspend(state);
2108 } else if (arm_state->autosuspend_override <
2109 FORCE_SUSPEND_FAIL_MAX) {
2110 vchiq_log_info(vchiq_susp_log_level, "%s letting "
2111 "videocore go idle", __func__);
2112 status = VCHIQ_SUCCESS;
2114 vchiq_log_warning(vchiq_susp_log_level, "%s failed too "
2115 "many times - attempting suspend", __func__);
2116 status = vchiq_arm_vcsuspend(state);
2119 vchiq_log_info(vchiq_susp_log_level, "%s videocore suspend "
2120 "in progress - wait for completion", __func__);
2121 status = VCHIQ_SUCCESS;
2124 /* Wait for suspend to happen due to system idle (not forced..) */
2125 if (status != VCHIQ_SUCCESS)
2126 goto unblock_resume;
2129 write_unlock_bh(&arm_state->susp_res_lock);
2131 rc = wait_for_completion_interruptible_timeout(
2132 &arm_state->vc_suspend_complete,
2133 msecs_to_jiffies(FORCE_SUSPEND_TIMEOUT_MS));
2135 write_lock_bh(&arm_state->susp_res_lock);
2137 vchiq_log_warning(vchiq_susp_log_level, "%s "
2138 "interrupted waiting for suspend", __func__);
2139 status = VCHIQ_ERROR;
2140 goto unblock_resume;
2141 } else if (rc == 0) {
2142 if (arm_state->vc_suspend_state > VC_SUSPEND_IDLE) {
2143 /* Repeat timeout once if in progress */
2149 arm_state->autosuspend_override++;
2150 output_timeout_error(state);
2152 status = VCHIQ_RETRY;
2153 goto unblock_resume;
2155 } while (0 < (repeat--));
2157 /* Check and report state in case we need to abort ARM suspend */
2158 if (arm_state->vc_suspend_state != VC_SUSPEND_SUSPENDED) {
2159 status = VCHIQ_RETRY;
2160 vchiq_log_error(vchiq_susp_log_level,
2161 "%s videocore suspend failed (state %s)", __func__,
2162 suspend_state_names[arm_state->vc_suspend_state +
2163 VC_SUSPEND_NUM_OFFSET]);
2164 /* Reset the state only if it's still in an error state.
2165 * Something could have already initiated another suspend. */
2166 if (arm_state->vc_suspend_state < VC_SUSPEND_IDLE)
2167 set_suspend_state(arm_state, VC_SUSPEND_IDLE);
2169 goto unblock_resume;
2172 /* successfully suspended - unlock and exit */
2176 /* all error states need to unblock resume before exit */
2177 unblock_resume(arm_state);
2180 write_unlock_bh(&arm_state->susp_res_lock);
2183 vchiq_log_trace(vchiq_susp_log_level, "%s exit %d", __func__, status);
2188 vchiq_check_suspend(VCHIQ_STATE_T *state)
2190 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2195 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2197 write_lock_bh(&arm_state->susp_res_lock);
2198 if (arm_state->vc_suspend_state != VC_SUSPEND_SUSPENDED &&
2199 arm_state->first_connect &&
2200 !vchiq_videocore_wanted(state)) {
2201 vchiq_arm_vcsuspend(state);
2203 write_unlock_bh(&arm_state->susp_res_lock);
2206 vchiq_log_trace(vchiq_susp_log_level, "%s exit", __func__);
2212 vchiq_arm_allow_resume(VCHIQ_STATE_T *state)
2214 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2221 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2223 write_lock_bh(&arm_state->susp_res_lock);
2224 unblock_resume(arm_state);
2225 resume = vchiq_check_resume(state);
2226 write_unlock_bh(&arm_state->susp_res_lock);
2229 if (wait_for_completion_interruptible(
2230 &arm_state->vc_resume_complete) < 0) {
2231 vchiq_log_error(vchiq_susp_log_level,
2232 "%s interrupted", __func__);
2233 /* failed, cannot accurately derive suspend
2234 * state, so exit early. */
2239 read_lock_bh(&arm_state->susp_res_lock);
2240 if (arm_state->vc_suspend_state == VC_SUSPEND_SUSPENDED) {
2241 vchiq_log_info(vchiq_susp_log_level,
2242 "%s: Videocore remains suspended", __func__);
2244 vchiq_log_info(vchiq_susp_log_level,
2245 "%s: Videocore resumed", __func__);
2248 read_unlock_bh(&arm_state->susp_res_lock);
2250 vchiq_log_trace(vchiq_susp_log_level, "%s exit %d", __func__, ret);
2254 /* This function should be called with the write lock held */
2256 vchiq_check_resume(VCHIQ_STATE_T *state)
2258 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2264 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2266 if (need_resume(state)) {
2267 set_resume_state(arm_state, VC_RESUME_REQUESTED);
2268 request_poll(state, NULL, 0);
2273 vchiq_log_trace(vchiq_susp_log_level, "%s exit", __func__);
2278 vchiq_platform_check_resume(VCHIQ_STATE_T *state)
2280 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2286 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2288 write_lock_bh(&arm_state->susp_res_lock);
2289 if (arm_state->wake_address == 0) {
2290 vchiq_log_info(vchiq_susp_log_level,
2291 "%s: already awake", __func__);
2294 if (arm_state->vc_resume_state == VC_RESUME_IN_PROGRESS) {
2295 vchiq_log_info(vchiq_susp_log_level,
2296 "%s: already resuming", __func__);
2300 if (arm_state->vc_resume_state == VC_RESUME_REQUESTED) {
2301 set_resume_state(arm_state, VC_RESUME_IN_PROGRESS);
2304 vchiq_log_trace(vchiq_susp_log_level,
2305 "%s: not resuming (resume state %s)", __func__,
2306 resume_state_names[arm_state->vc_resume_state +
2307 VC_RESUME_NUM_OFFSET]);
2310 write_unlock_bh(&arm_state->susp_res_lock);
2313 vchiq_platform_resume(state);
2316 vchiq_log_trace(vchiq_susp_log_level, "%s exit", __func__);
2324 vchiq_use_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service,
2325 enum USE_TYPE_E use_type)
2327 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2328 VCHIQ_STATUS_T ret = VCHIQ_SUCCESS;
2331 int local_uc, local_entity_uc;
2336 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2338 if (use_type == USE_TYPE_VCHIQ) {
2339 sprintf(entity, "VCHIQ: ");
2340 entity_uc = &arm_state->peer_use_count;
2341 } else if (service) {
2342 sprintf(entity, "%c%c%c%c:%03d",
2343 VCHIQ_FOURCC_AS_4CHARS(service->base.fourcc),
2344 service->client_id);
2345 entity_uc = &service->service_use_count;
2347 vchiq_log_error(vchiq_susp_log_level, "%s null service "
2353 write_lock_bh(&arm_state->susp_res_lock);
2354 while (arm_state->resume_blocked) {
2355 /* If we call 'use' while force suspend is waiting for suspend,
2356 * then we're about to block the thread which the force is
2357 * waiting to complete, so we're bound to just time out. In this
2358 * case, set the suspend state such that the wait will be
2359 * canceled, so we can complete as quickly as possible. */
2360 if (arm_state->resume_blocked && arm_state->vc_suspend_state ==
2362 set_suspend_state(arm_state, VC_SUSPEND_FORCE_CANCELED);
2365 /* If suspend is already in progress then we need to block */
2366 if (!try_wait_for_completion(&arm_state->resume_blocker)) {
2367 /* Indicate that there are threads waiting on the resume
2368 * blocker. These need to be allowed to complete before
2369 * a _second_ call to force suspend can complete,
2370 * otherwise low priority threads might never actually
2372 arm_state->blocked_count++;
2373 write_unlock_bh(&arm_state->susp_res_lock);
2374 vchiq_log_info(vchiq_susp_log_level, "%s %s resume "
2375 "blocked - waiting...", __func__, entity);
2376 if (wait_for_completion_killable(
2377 &arm_state->resume_blocker) != 0) {
2378 vchiq_log_error(vchiq_susp_log_level, "%s %s "
2379 "wait for resume blocker interrupted",
2382 write_lock_bh(&arm_state->susp_res_lock);
2383 arm_state->blocked_count--;
2384 write_unlock_bh(&arm_state->susp_res_lock);
2387 vchiq_log_info(vchiq_susp_log_level, "%s %s resume "
2388 "unblocked", __func__, entity);
2389 write_lock_bh(&arm_state->susp_res_lock);
2390 if (--arm_state->blocked_count == 0)
2391 complete_all(&arm_state->blocked_blocker);
2395 stop_suspend_timer(arm_state);
2397 local_uc = ++arm_state->videocore_use_count;
2398 local_entity_uc = ++(*entity_uc);
2400 /* If there's a pending request which hasn't yet been serviced then
2401 * just clear it. If we're past VC_SUSPEND_REQUESTED state then
2402 * vc_resume_complete will block until we either resume or fail to
2404 if (arm_state->vc_suspend_state <= VC_SUSPEND_REQUESTED)
2405 set_suspend_state(arm_state, VC_SUSPEND_IDLE);
2407 if ((use_type != USE_TYPE_SERVICE_NO_RESUME) && need_resume(state)) {
2408 set_resume_state(arm_state, VC_RESUME_REQUESTED);
2409 vchiq_log_info(vchiq_susp_log_level,
2410 "%s %s count %d, state count %d",
2411 __func__, entity, local_entity_uc, local_uc);
2412 request_poll(state, NULL, 0);
2414 vchiq_log_trace(vchiq_susp_log_level,
2415 "%s %s count %d, state count %d",
2416 __func__, entity, *entity_uc, local_uc);
2419 write_unlock_bh(&arm_state->susp_res_lock);
2421 /* Completion is in a done state when we're not suspended, so this won't
2422 * block for the non-suspended case. */
2423 if (!try_wait_for_completion(&arm_state->vc_resume_complete)) {
2424 vchiq_log_info(vchiq_susp_log_level, "%s %s wait for resume",
2426 if (wait_for_completion_killable(
2427 &arm_state->vc_resume_complete) != 0) {
2428 vchiq_log_error(vchiq_susp_log_level, "%s %s wait for "
2429 "resume interrupted", __func__, entity);
2433 vchiq_log_info(vchiq_susp_log_level, "%s %s resumed", __func__,
2437 if (ret == VCHIQ_SUCCESS) {
2438 VCHIQ_STATUS_T status = VCHIQ_SUCCESS;
2439 long ack_cnt = atomic_xchg(&arm_state->ka_use_ack_count, 0);
2440 while (ack_cnt && (status == VCHIQ_SUCCESS)) {
2441 /* Send the use notify to videocore */
2442 status = vchiq_send_remote_use_active(state);
2443 if (status == VCHIQ_SUCCESS)
2447 &arm_state->ka_use_ack_count);
2452 vchiq_log_trace(vchiq_susp_log_level, "%s exit %d", __func__, ret);
2457 vchiq_release_internal(VCHIQ_STATE_T *state, VCHIQ_SERVICE_T *service)
2459 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2460 VCHIQ_STATUS_T ret = VCHIQ_SUCCESS;
2463 int local_uc, local_entity_uc;
2468 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2471 sprintf(entity, "%c%c%c%c:%03d",
2472 VCHIQ_FOURCC_AS_4CHARS(service->base.fourcc),
2473 service->client_id);
2474 entity_uc = &service->service_use_count;
2476 sprintf(entity, "PEER: ");
2477 entity_uc = &arm_state->peer_use_count;
2480 write_lock_bh(&arm_state->susp_res_lock);
2481 if (!arm_state->videocore_use_count || !(*entity_uc)) {
2482 /* Don't use BUG_ON - don't allow user thread to crash kernel */
2483 WARN_ON(!arm_state->videocore_use_count);
2484 WARN_ON(!(*entity_uc));
2488 local_uc = --arm_state->videocore_use_count;
2489 local_entity_uc = --(*entity_uc);
2491 if (!vchiq_videocore_wanted(state)) {
2492 if (vchiq_platform_use_suspend_timer() &&
2493 !arm_state->resume_blocked) {
2494 /* Only use the timer if we're not trying to force
2495 * suspend (=> resume_blocked) */
2496 start_suspend_timer(arm_state);
2498 vchiq_log_info(vchiq_susp_log_level,
2499 "%s %s count %d, state count %d - suspending",
2500 __func__, entity, *entity_uc,
2501 arm_state->videocore_use_count);
2502 vchiq_arm_vcsuspend(state);
2505 vchiq_log_trace(vchiq_susp_log_level,
2506 "%s %s count %d, state count %d",
2507 __func__, entity, *entity_uc,
2508 arm_state->videocore_use_count);
2511 write_unlock_bh(&arm_state->susp_res_lock);
2514 vchiq_log_trace(vchiq_susp_log_level, "%s exit %d", __func__, ret);
2519 vchiq_on_remote_use(VCHIQ_STATE_T *state)
2521 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2522 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2523 atomic_inc(&arm_state->ka_use_count);
2524 complete(&arm_state->ka_evt);
2528 vchiq_on_remote_release(VCHIQ_STATE_T *state)
2530 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2531 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2532 atomic_inc(&arm_state->ka_release_count);
2533 complete(&arm_state->ka_evt);
2537 vchiq_use_service_internal(VCHIQ_SERVICE_T *service)
2539 return vchiq_use_internal(service->state, service, USE_TYPE_SERVICE);
2543 vchiq_release_service_internal(VCHIQ_SERVICE_T *service)
2545 return vchiq_release_internal(service->state, service);
2548 VCHIQ_DEBUGFS_NODE_T *
2549 vchiq_instance_get_debugfs_node(VCHIQ_INSTANCE_T instance)
2551 return &instance->debugfs_node;
2555 vchiq_instance_get_use_count(VCHIQ_INSTANCE_T instance)
2557 VCHIQ_SERVICE_T *service;
2558 int use_count = 0, i;
2560 while ((service = next_service_by_instance(instance->state,
2561 instance, &i)) != NULL) {
2562 use_count += service->service_use_count;
2563 unlock_service(service);
2569 vchiq_instance_get_pid(VCHIQ_INSTANCE_T instance)
2571 return instance->pid;
2575 vchiq_instance_get_trace(VCHIQ_INSTANCE_T instance)
2577 return instance->trace;
2581 vchiq_instance_set_trace(VCHIQ_INSTANCE_T instance, int trace)
2583 VCHIQ_SERVICE_T *service;
2586 while ((service = next_service_by_instance(instance->state,
2587 instance, &i)) != NULL) {
2588 service->trace = trace;
2589 unlock_service(service);
2591 instance->trace = (trace != 0);
2594 static void suspend_timer_callback(unsigned long context)
2596 VCHIQ_STATE_T *state = (VCHIQ_STATE_T *)context;
2597 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2600 vchiq_log_info(vchiq_susp_log_level,
2601 "%s - suspend timer expired - check suspend", __func__);
2602 vchiq_check_suspend(state);
2608 vchiq_use_service_no_resume(VCHIQ_SERVICE_HANDLE_T handle)
2610 VCHIQ_STATUS_T ret = VCHIQ_ERROR;
2611 VCHIQ_SERVICE_T *service = find_service_by_handle(handle);
2613 ret = vchiq_use_internal(service->state, service,
2614 USE_TYPE_SERVICE_NO_RESUME);
2615 unlock_service(service);
2621 vchiq_use_service(VCHIQ_SERVICE_HANDLE_T handle)
2623 VCHIQ_STATUS_T ret = VCHIQ_ERROR;
2624 VCHIQ_SERVICE_T *service = find_service_by_handle(handle);
2626 ret = vchiq_use_internal(service->state, service,
2628 unlock_service(service);
2634 vchiq_release_service(VCHIQ_SERVICE_HANDLE_T handle)
2636 VCHIQ_STATUS_T ret = VCHIQ_ERROR;
2637 VCHIQ_SERVICE_T *service = find_service_by_handle(handle);
2639 ret = vchiq_release_internal(service->state, service);
2640 unlock_service(service);
2646 vchiq_dump_service_use_state(VCHIQ_STATE_T *state)
2648 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2650 /* Only dump 64 services */
2651 static const int local_max_services = 64;
2652 /* If there's more than 64 services, only dump ones with
2653 * non-zero counts */
2654 int only_nonzero = 0;
2655 static const char *nz = "<-- preventing suspend";
2657 enum vc_suspend_status vc_suspend_state;
2658 enum vc_resume_status vc_resume_state;
2661 int active_services;
2662 struct service_data_struct {
2666 } service_data[local_max_services];
2671 read_lock_bh(&arm_state->susp_res_lock);
2672 vc_suspend_state = arm_state->vc_suspend_state;
2673 vc_resume_state = arm_state->vc_resume_state;
2674 peer_count = arm_state->peer_use_count;
2675 vc_use_count = arm_state->videocore_use_count;
2676 active_services = state->unused_service;
2677 if (active_services > local_max_services)
2680 for (i = 0; (i < active_services) && (j < local_max_services); i++) {
2681 VCHIQ_SERVICE_T *service_ptr = state->services[i];
2685 if (only_nonzero && !service_ptr->service_use_count)
2688 if (service_ptr->srvstate != VCHIQ_SRVSTATE_FREE) {
2689 service_data[j].fourcc = service_ptr->base.fourcc;
2690 service_data[j].clientid = service_ptr->client_id;
2691 service_data[j++].use_count = service_ptr->
2696 read_unlock_bh(&arm_state->susp_res_lock);
2698 vchiq_log_warning(vchiq_susp_log_level,
2699 "-- Videcore suspend state: %s --",
2700 suspend_state_names[vc_suspend_state + VC_SUSPEND_NUM_OFFSET]);
2701 vchiq_log_warning(vchiq_susp_log_level,
2702 "-- Videcore resume state: %s --",
2703 resume_state_names[vc_resume_state + VC_RESUME_NUM_OFFSET]);
2706 vchiq_log_warning(vchiq_susp_log_level, "Too many active "
2707 "services (%d). Only dumping up to first %d services "
2708 "with non-zero use-count", active_services,
2709 local_max_services);
2711 for (i = 0; i < j; i++) {
2712 vchiq_log_warning(vchiq_susp_log_level,
2713 "----- %c%c%c%c:%d service count %d %s",
2714 VCHIQ_FOURCC_AS_4CHARS(service_data[i].fourcc),
2715 service_data[i].clientid,
2716 service_data[i].use_count,
2717 service_data[i].use_count ? nz : "");
2719 vchiq_log_warning(vchiq_susp_log_level,
2720 "----- VCHIQ use count count %d", peer_count);
2721 vchiq_log_warning(vchiq_susp_log_level,
2722 "--- Overall vchiq instance use count %d", vc_use_count);
2724 vchiq_dump_platform_use_state(state);
2728 vchiq_check_service(VCHIQ_SERVICE_T *service)
2730 VCHIQ_ARM_STATE_T *arm_state;
2731 VCHIQ_STATUS_T ret = VCHIQ_ERROR;
2733 if (!service || !service->state)
2736 vchiq_log_trace(vchiq_susp_log_level, "%s", __func__);
2738 arm_state = vchiq_platform_get_arm_state(service->state);
2740 read_lock_bh(&arm_state->susp_res_lock);
2741 if (service->service_use_count)
2742 ret = VCHIQ_SUCCESS;
2743 read_unlock_bh(&arm_state->susp_res_lock);
2745 if (ret == VCHIQ_ERROR) {
2746 vchiq_log_error(vchiq_susp_log_level,
2747 "%s ERROR - %c%c%c%c:%d service count %d, "
2748 "state count %d, videocore suspend state %s", __func__,
2749 VCHIQ_FOURCC_AS_4CHARS(service->base.fourcc),
2750 service->client_id, service->service_use_count,
2751 arm_state->videocore_use_count,
2752 suspend_state_names[arm_state->vc_suspend_state +
2753 VC_SUSPEND_NUM_OFFSET]);
2754 vchiq_dump_service_use_state(service->state);
2760 /* stub functions */
2761 void vchiq_on_remote_use_active(VCHIQ_STATE_T *state)
2766 void vchiq_platform_conn_state_changed(VCHIQ_STATE_T *state,
2767 VCHIQ_CONNSTATE_T oldstate, VCHIQ_CONNSTATE_T newstate)
2769 VCHIQ_ARM_STATE_T *arm_state = vchiq_platform_get_arm_state(state);
2770 vchiq_log_info(vchiq_susp_log_level, "%d: %s->%s", state->id,
2771 get_conn_state_name(oldstate), get_conn_state_name(newstate));
2772 if (state->conn_state == VCHIQ_CONNSTATE_CONNECTED) {
2773 write_lock_bh(&arm_state->susp_res_lock);
2774 if (!arm_state->first_connect) {
2775 char threadname[10];
2776 arm_state->first_connect = 1;
2777 write_unlock_bh(&arm_state->susp_res_lock);
2778 snprintf(threadname, sizeof(threadname), "VCHIQka-%d",
2780 arm_state->ka_thread = kthread_create(
2781 &vchiq_keepalive_thread_func,
2784 if (arm_state->ka_thread == NULL) {
2785 vchiq_log_error(vchiq_susp_log_level,
2786 "vchiq: FATAL: couldn't create thread %s",
2789 wake_up_process(arm_state->ka_thread);
2792 write_unlock_bh(&arm_state->susp_res_lock);
2796 static int vchiq_probe(struct platform_device *pdev)
2798 struct device_node *fw_node;
2799 struct rpi_firmware *fw;
2803 fw_node = of_parse_phandle(pdev->dev.of_node, "firmware", 0);
2804 /* Remove comment when booting without Device Tree is no longer supported
2806 dev_err(&pdev->dev, "Missing firmware node\n");
2810 fw = rpi_firmware_get(fw_node);
2812 return -EPROBE_DEFER;
2814 platform_set_drvdata(pdev, fw);
2816 /* create debugfs entries */
2817 err = vchiq_debugfs_init();
2819 goto failed_debugfs_init;
2821 err = alloc_chrdev_region(&vchiq_devid, VCHIQ_MINOR, 1, DEVICE_NAME);
2823 vchiq_log_error(vchiq_arm_log_level,
2824 "Unable to allocate device number");
2825 goto failed_alloc_chrdev;
2827 cdev_init(&vchiq_cdev, &vchiq_fops);
2828 vchiq_cdev.owner = THIS_MODULE;
2829 err = cdev_add(&vchiq_cdev, vchiq_devid, 1);
2831 vchiq_log_error(vchiq_arm_log_level,
2832 "Unable to register device");
2833 goto failed_cdev_add;
2836 /* create sysfs entries */
2837 vchiq_class = class_create(THIS_MODULE, DEVICE_NAME);
2838 ptr_err = vchiq_class;
2839 if (IS_ERR(ptr_err))
2840 goto failed_class_create;
2842 vchiq_dev = device_create(vchiq_class, NULL,
2843 vchiq_devid, NULL, "vchiq");
2844 ptr_err = vchiq_dev;
2845 if (IS_ERR(ptr_err))
2846 goto failed_device_create;
2848 err = vchiq_platform_init(pdev, &g_state);
2850 goto failed_platform_init;
2852 vchiq_log_info(vchiq_arm_log_level,
2853 "vchiq: initialised - version %d (min %d), device %d.%d",
2854 VCHIQ_VERSION, VCHIQ_VERSION_MIN,
2855 MAJOR(vchiq_devid), MINOR(vchiq_devid));
2859 failed_platform_init:
2860 device_destroy(vchiq_class, vchiq_devid);
2861 failed_device_create:
2862 class_destroy(vchiq_class);
2863 failed_class_create:
2864 cdev_del(&vchiq_cdev);
2865 err = PTR_ERR(ptr_err);
2867 unregister_chrdev_region(vchiq_devid, 1);
2868 failed_alloc_chrdev:
2869 vchiq_debugfs_deinit();
2870 failed_debugfs_init:
2871 vchiq_log_warning(vchiq_arm_log_level, "could not load vchiq");
2875 static int vchiq_remove(struct platform_device *pdev)
2877 device_destroy(vchiq_class, vchiq_devid);
2878 class_destroy(vchiq_class);
2879 cdev_del(&vchiq_cdev);
2880 unregister_chrdev_region(vchiq_devid, 1);
2885 static const struct of_device_id vchiq_of_match[] = {
2886 { .compatible = "brcm,bcm2835-vchiq", },
2889 MODULE_DEVICE_TABLE(of, vchiq_of_match);
2891 static struct platform_driver vchiq_driver = {
2893 .name = "bcm2835_vchiq",
2894 .owner = THIS_MODULE,
2895 .of_match_table = vchiq_of_match,
2897 .probe = vchiq_probe,
2898 .remove = vchiq_remove,
2900 module_platform_driver(vchiq_driver);
2902 MODULE_LICENSE("GPL");
2903 MODULE_AUTHOR("Broadcom Corporation");