summaryrefslogtreecommitdiff
path: root/zephyr/shim/src/i2c.c
blob: 3dba7cde3819038d51e5b88ee8389e6afb2fd641 (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
/* 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 <sys/util.h>

#include "console.h"
#include "i2c.h"
#include "i2c/i2c.h"

/*
 * The named-i2c-ports node is required by the I2C shim
 */
#if !DT_NODE_EXISTS(DT_PATH(named_i2c_ports))
#error I2C shim requires the named-i2c-ports node to be defined.
#endif

/*
 * Initialize device bindings in i2c_devices.
 * This macro should be called from within DT_FOREACH_CHILD.
 */
#define INIT_DEV_BINDING(id) \
	[I2C_PORT(id)] = DEVICE_DT_GET(DT_PHANDLE(id, i2c_port)),

#define INIT_REMOTE_PORTS(id) \
	[I2C_PORT(id)] = DT_PROP_OR(id, remote_port, -1),

#define I2C_PORT_INIT(id)             \
	{                             \
		.name = DT_LABEL(id), \
		.port = I2C_PORT(id), \
	},
/*
 * Long term we will not need these, for now they're needed to get things to
 * build since these extern symbols are usually defined in
 * board/${BOARD}/board.c.
 *
 * Since all the ports will eventually be handled by device tree. This will
 * be removed at that point.
 */
const struct i2c_port_t i2c_ports[] = {
	DT_FOREACH_CHILD(DT_PATH(named_i2c_ports), I2C_PORT_INIT)
};
const unsigned int i2c_ports_used = ARRAY_SIZE(i2c_ports);
static const int i2c_remote_ports[I2C_PORT_COUNT] = {
	DT_FOREACH_CHILD(DT_PATH(named_i2c_ports), INIT_REMOTE_PORTS)
};
static int i2c_physical_ports[I2C_PORT_COUNT];

static const struct device *i2c_devices[I2C_PORT_COUNT] = {
	DT_FOREACH_CHILD(DT_PATH(named_i2c_ports), INIT_DEV_BINDING)
};

static int init_device_bindings(const struct device *device)
{
	ARG_UNUSED(device);

	/*
	 * The EC application may lock the I2C bus for more than a single
	 * I2C transaction. Initialize the i2c_physical_ports[] array to map
	 * each named-i2c-ports child to the physical bus assignment.
	 *
	 * TODO(b/199918263): zephyr: Optimize I2C mutexes
	 * Modify the port_mutex[] array defined by i2c_controller.c
	 * so that only mutexes for unique physical ports are created to
	 * save space.
	 */
	i2c_physical_ports[0] = 0;
	for (int child = 1; child < I2C_PORT_COUNT; child++) {
		for (int phys_port = 0; phys_port < I2C_PORT_COUNT;
		     phys_port++) {
			if (i2c_devices[child] == i2c_devices[phys_port]) {
				i2c_physical_ports[child] = phys_port;
				break;
			}
		}
	}
	return 0;
}
SYS_INIT(init_device_bindings, POST_KERNEL, 51);

const struct device *i2c_get_device_for_port(const int port)
{
	if (port < 0 || port >= I2C_PORT_COUNT)
		return NULL;
	return i2c_devices[port];
}

int i2c_get_port_from_remote_port(int remote_port)
{
	for (int port = 0; port < I2C_PORT_COUNT; port++) {
		if (i2c_remote_ports[port] == remote_port)
			return port;
	}

	/*
	 * Remote port is not defined, return 1:1 mapping to support TCPC
	 * firmware updates, which always query the EC for the correct I2C
	 * port number.
	 */
	return remote_port;
}

int i2c_get_physical_port(int enum_port)
{
	int i2c_port = i2c_physical_ports[enum_port];

	/*
	 * Return -1 for caller if physical port is not defined or the
	 * port number is out of port_mutex space.
	 * Please ensure the caller won't change anything if -1 received.
	 */
	return (i2c_port < I2C_PORT_COUNT) ? i2c_port : -1;
}

#ifdef CONFIG_PLATFORM_EC_CONSOLE_CMD_I2C_PORTMAP
static int command_i2c_portmap(int argc, char **argv)
{
	int i;

	ccprintf("Zephyr physical I2C ports (%d):\n", I2C_PORT_COUNT);
	for (i = 0; i < I2C_PORT_COUNT; i++) {
		ccprintf("  %d : %d\n", i, i2c_physical_ports[i]);
	}
	ccprintf("Zephyr remote I2C ports (%d):\n", I2C_PORT_COUNT);
	for (i = 0; i < I2C_PORT_COUNT; i++) {
		ccprintf("  %d : %d\n", i, i2c_remote_ports[i]);
	}

	return EC_RES_SUCCESS;
}
DECLARE_CONSOLE_COMMAND(i2c_portmap, command_i2c_portmap, NULL,
			"Show I2C port mapping");
#endif /* CONFIG_PLATFORM_EC_CONSOLE_CMD_I2C_PORTMAP */