summaryrefslogtreecommitdiff
path: root/zephyr/shim/src/hooks.c
blob: dee7c204415a9a1bdf98a0c4feb614f69a4202ec (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/* Copyright 2020 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#include <kernel.h>
#include <zephyr.h>

#include "common.h"
#include "console.h"
#include "hooks.h"
#include "task.h"
#include "timer.h"

#define DEFERRED_STACK_SIZE 1024

/*
 * Deferred thread is always the lowest priority, and preemptive if
 * available.
 */
#ifdef CONFIG_PREEMPT_ENABLED
#define DEFERRED_THREAD_PRIORITY (CONFIG_NUM_PREEMPT_PRIORITIES - 1)
#else
#define DEFERRED_THREAD_PRIORITY -1
#endif

static K_THREAD_STACK_DEFINE(deferred_thread, DEFERRED_STACK_SIZE);
static struct k_work_q deferred_work_queue;

static void deferred_work_queue_handler(struct k_work *work)
{
	struct deferred_data *data =
		CONTAINER_OF(work, struct deferred_data, delayed_work.work);

	data->routine();
}

static int init_deferred_work_queue(const struct device *unused)
{
	ARG_UNUSED(unused);
	k_work_q_start(&deferred_work_queue, deferred_thread,
		       DEFERRED_STACK_SIZE, DEFERRED_THREAD_PRIORITY);
	return 0;
}
SYS_INIT(init_deferred_work_queue, APPLICATION, 0);

void zephyr_shim_setup_deferred(const struct deferred_data *data)
{
	struct deferred_data *non_const = (struct deferred_data *)data;

	k_delayed_work_init(&non_const->delayed_work,
			    deferred_work_queue_handler);
}

int hook_call_deferred(const struct deferred_data *data, int us)
{
	struct deferred_data *non_const = (struct deferred_data *)data;
	int rv = 0;

	if (us == -1) {
		k_delayed_work_cancel(&non_const->delayed_work);
	} else if (us >= 0) {
		rv = k_delayed_work_submit_to_queue(&deferred_work_queue,
						    &non_const->delayed_work,
						    K_USEC(us));
		if (rv < 0)
			cprints(CC_HOOK,
				"Warning: deferred call not submitted.");
	} else {
		return EC_ERROR_PARAM2;
	}

	return rv;
}

static struct zephyr_shim_hook_list *hook_registry[HOOK_TYPE_COUNT];

void zephyr_shim_setup_hook(enum hook_type type, void (*routine)(void),
			    int priority, struct zephyr_shim_hook_list *entry)
{
	struct zephyr_shim_hook_list **loc = &hook_registry[type];

	/* Find the correct place to put the entry in the registry. */
	while (*loc && (*loc)->priority < priority)
		loc = &((*loc)->next);

	/* Setup the entry. */
	entry->routine = routine;
	entry->priority = priority;
	entry->next = *loc;

	/* Insert the entry. */
	*loc = entry;
}

void hook_notify(enum hook_type type)
{
	struct zephyr_shim_hook_list *p;

	for (p = hook_registry[type]; p; p = p->next)
		p->routine();
}

void hook_task(void *u)
{
	/* Periodic hooks will be called first time through the loop */
	static uint64_t last_second = -SECOND;
	static uint64_t last_tick = -HOOK_TICK_INTERVAL;

	while (1) {
		uint64_t t = get_time().val;
		int next = 0;

		if (t - last_tick >= HOOK_TICK_INTERVAL) {
			hook_notify(HOOK_TICK);
			last_tick = t;
		}

		if (t - last_second >= SECOND) {
			hook_notify(HOOK_SECOND);
			last_second = t;
		}

		/* Calculate when next tick needs to occur */
		t = get_time().val;
		if (last_tick + HOOK_TICK_INTERVAL > t)
			next = last_tick + HOOK_TICK_INTERVAL - t;

		/*
		 * Sleep until next tick, unless we've already exceeded
		 * HOOK_TICK_INTERVAL.
		 */
		if (next > 0)
			task_wait_event(next);
	}
}