summaryrefslogtreecommitdiff
path: root/zephyr/emul/tcpc/emul_tcpci_generic.c
blob: 204e040ede9d43451821b894c9897841e60640ed (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* Copyright 2022 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#define DT_DRV_COMPAT cros_tcpci_generic_emul

#include <zephyr/logging/log.h>
LOG_MODULE_REGISTER(tcpci_generic_emul, CONFIG_TCPCI_EMUL_LOG_LEVEL);

#include <zephyr/device.h>
#include <zephyr/drivers/emul.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/drivers/i2c_emul.h>
#include <zephyr/ztest.h>

#include "tcpm/tcpci.h"
#include "emul/emul_stub_device.h"

#include "emul/emul_common_i2c.h"
#include "emul/tcpc/emul_tcpci.h"

/**
 * @brief Function called for each byte of read message from TCPCI emulator
 *
 * @param emul Pointer to I2C TCPCI emulator
 * @param reg First byte of last write message
 * @param val Pointer where byte to read should be stored
 * @param bytes Number of bytes already read
 *
 * @return 0 on success
 * @return -EIO on invalid read request
 */
static int tcpci_generic_emul_read_byte(const struct emul *emul, int reg,
					uint8_t *val, int bytes)
{
	LOG_DBG("TCPCI Generic 0x%x: read reg 0x%x", emul->bus.i2c->addr, reg);

	return tcpci_emul_read_byte(emul, reg, val, bytes);
}

/**
 * @brief Function called for each byte of write message to TCPCI emulator
 *
 * @param emul Pointer to I2C TCPCI emulator
 * @param reg First byte of write message
 * @param val Received byte of write message
 * @param bytes Number of bytes already received
 *
 * @return 0 on success
 * @return -EIO on invalid write request
 */
static int tcpci_generic_emul_write_byte(const struct emul *emul, int reg,
					 uint8_t val, int bytes)
{
	LOG_DBG("TCPCI Generic 0x%x: write reg 0x%x", emul->bus.i2c->addr, reg);

	return tcpci_emul_write_byte(emul, reg, val, bytes);
}

/**
 * @brief Function called on the end of write message to TCPCI emulator
 *
 * @param emul Pointer to I2C TCPCI emulator
 * @param reg Register which is written
 * @param msg_len Length of handled I2C message
 *
 * @return 0 on success
 * @return -EIO on error
 */
static int tcpci_generic_emul_finish_write(const struct emul *emul, int reg,
					   int msg_len)
{
	LOG_DBG("TCPCI Generic 0x%x: finish write reg 0x%x",
		emul->bus.i2c->addr, reg);

	return tcpci_emul_handle_write(emul, reg, msg_len);
}

/**
 * @brief Get currently accessed register, which always equals to selected
 *        register from TCPCI emulator.
 *
 * @param emul Pointer to I2C TCPCI emulator
 * @param reg First byte of last write message
 * @param bytes Number of bytes already handled from current message
 * @param read If currently handled is read message
 *
 * @return Currently accessed register
 */
static int tcpci_generic_emul_access_reg(const struct emul *emul, int reg,
					 int bytes, bool read)
{
	return reg;
}

/**
 * @brief Function called on reset
 *
 * @param emul Pointer to TCPC emulator
 */
static void tcpci_generic_emul_reset(const struct emul *emul)
{
	tcpci_emul_reset(emul);
}

/**
 * @brief Set up a new TCPCI generic emulator
 *
 * This should be called for each TCPCI Generic device that needs to be
 * emulated.
 *
 * @param emul Emulation information
 * @param parent Device to emulate
 *
 * @return 0 indicating success (always)
 */
static int tcpci_generic_emul_init(const struct emul *emul,
				   const struct device *parent)
{
	struct tcpc_emul_data *tcpc_data = emul->data;
	struct tcpci_ctx *tcpci_ctx = tcpc_data->tcpci_ctx;
	const struct device *i2c_dev;

	i2c_dev = parent;

	tcpci_ctx->common.write_byte = tcpci_generic_emul_write_byte;
	tcpci_ctx->common.finish_write = tcpci_generic_emul_finish_write;
	tcpci_ctx->common.read_byte = tcpci_generic_emul_read_byte;
	tcpci_ctx->common.access_reg = tcpci_generic_emul_access_reg;

	tcpci_emul_i2c_init(emul, i2c_dev);

	tcpci_generic_emul_reset(emul);

	return 0;
}

static int i2c_tcpci_generic_emul_transfer(const struct emul *target,
					   struct i2c_msg *msgs, int num_msgs,
					   int addr)
{
	struct tcpc_emul_data *tcpc_data = target->data;
	struct tcpci_ctx *tcpci_ctx = tcpc_data->tcpci_ctx;

	return i2c_common_emul_transfer_workhorse(target, &tcpci_ctx->common,
						  &tcpc_data->i2c_cfg, msgs,
						  num_msgs, addr);
}

struct i2c_emul_api i2c_tcpci_generic_emul_api = {
	.transfer = i2c_tcpci_generic_emul_transfer,
};

#define TCPCI_GENERIC_EMUL(n)                                     \
	TCPCI_EMUL_DEFINE(n, tcpci_generic_emul_init, NULL, NULL, \
			  &i2c_tcpci_generic_emul_api)

DT_INST_FOREACH_STATUS_OKAY(TCPCI_GENERIC_EMUL)

#ifdef CONFIG_ZTEST_NEW_API
#define TCPCI_GENERIC_EMUL_RESET_RULE_BEFORE(n) \
	tcpci_generic_emul_reset(EMUL_DT_GET(DT_DRV_INST(n)));
static void
tcpci_generic_emul_reset_rule_before(const struct ztest_unit_test *test,
				     void *data)
{
	ARG_UNUSED(test);
	ARG_UNUSED(data);
	DT_INST_FOREACH_STATUS_OKAY(TCPCI_GENERIC_EMUL_RESET_RULE_BEFORE);
}
ZTEST_RULE(tcpci_generic_emul_reset, tcpci_generic_emul_reset_rule_before,
	   NULL);
#endif /* CONFIG_ZTEST_NEW_API */

DT_INST_FOREACH_STATUS_OKAY(EMUL_STUB_DEVICE);

struct i2c_common_emul_data *
emul_tcpci_generic_get_i2c_common_data(const struct emul *emul)
{
	struct tcpc_emul_data *tcpc_data = emul->data;
	struct tcpci_ctx *tcpci_ctx = tcpc_data->tcpci_ctx;

	return &tcpci_ctx->common;
}