aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/misc/amd-sbi/rmi-i2c.c
blob: f0cc99000b695cd0f01a6e859f521f09efa340de (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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * rmi-i2c.c - Side band RMI over I2C support for AMD out
 *             of band management
 *
 * Copyright (C) 2024 Advanced Micro Devices, Inc.
 */

#include <linux/delay.h>
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/i3c/device.h>
#include <linux/i3c/master.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/of.h>
#include <linux/regmap.h>
#include "rmi-core.h"

#define REV_TWO_BYTE_ADDR	0x21

static int sbrmi_enable_alert(struct sbrmi_data *data)
{
	int ctrl, ret;

	/*
	 * Enable the SB-RMI Software alert status
	 * by writing 0 to bit 4 of Control register(0x1)
	 */
	ret = regmap_read(data->regmap, SBRMI_CTRL, &ctrl);
	if (ret < 0)
		return ret;

	if (ctrl & 0x10) {
		ctrl &= ~0x10;
		return regmap_write(data->regmap, SBRMI_CTRL, ctrl);
	}

	return 0;
}

static int sbrmi_get_max_pwr_limit(struct sbrmi_data *data)
{
	struct apml_mbox_msg msg = { 0 };
	int ret;

	msg.cmd = SBRMI_READ_PKG_MAX_PWR_LIMIT;
	ret = rmi_mailbox_xfer(data, &msg);
	if (ret < 0)
		return ret;
	data->pwr_limit_max = msg.mb_in_out;

	return ret;
}

static int sbrmi_common_probe(struct device *dev, struct regmap *regmap, uint8_t address)
{
	struct sbrmi_data *data;
	int ret;

	data = devm_kzalloc(dev, sizeof(struct sbrmi_data), GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	data->regmap = regmap;
	mutex_init(&data->lock);

	/* Enable alert for SB-RMI sequence */
	ret = sbrmi_enable_alert(data);
	if (ret < 0)
		return ret;

	/* Cache maximum power limit */
	ret = sbrmi_get_max_pwr_limit(data);
	if (ret < 0)
		return ret;

	data->dev_static_addr = address;

	dev_set_drvdata(dev, data);

	ret = create_hwmon_sensor_device(dev, data);
	if (ret < 0)
		return ret;
	return create_misc_rmi_device(data, dev);
}

static struct regmap_config sbrmi_regmap_config = {
	.reg_bits = 8,
	.val_bits = 8,
};

static struct regmap_config sbrmi_regmap_config_ext = {
	.reg_bits = 16,
	.val_bits = 8,
	.reg_format_endian = REGMAP_ENDIAN_LITTLE,
};

static int sbrmi_i2c_probe(struct i2c_client *client)
{
	struct device *dev = &client->dev;
	struct regmap *regmap;
	int rev, ret;

	regmap = devm_regmap_init_i2c(client, &sbrmi_regmap_config);
	if (IS_ERR(regmap))
		return PTR_ERR(regmap);

	ret = regmap_read(regmap, SBRMI_REV, &rev);
	if (ret)
		return ret;

	/*
	 * For Turin and newer platforms, revision is 0x21 or later. This is
	 * to identify the two byte register address size. However, one
	 * byte transaction can be successful.
	 * Verify if revision is 0x21 or later, if yes, switch to 2 byte
	 * address size.
	 * Continuously using 1 byte address for revision 0x21 or later can lead
	 * to bus corruption.
	 */
	if (rev >= REV_TWO_BYTE_ADDR) {
		regmap = devm_regmap_init_i2c(client, &sbrmi_regmap_config_ext);
		if (IS_ERR(regmap))
			return PTR_ERR(regmap);
	}
	return sbrmi_common_probe(dev, regmap, client->addr);
}

static void sbrmi_i2c_remove(struct i2c_client *client)
{
	struct sbrmi_data *data = dev_get_drvdata(&client->dev);

	misc_deregister(&data->sbrmi_misc_dev);
	/* Assign fops and parent of misc dev to NULL */
	data->sbrmi_misc_dev.fops = NULL;
	data->sbrmi_misc_dev.parent = NULL;
	dev_info(&client->dev, "Removed sbrmi-i2c driver\n");
	return;
}

static const struct i2c_device_id sbrmi_id[] = {
	{"sbrmi-i2c"},
	{}
};
MODULE_DEVICE_TABLE(i2c, sbrmi_id);

static const struct of_device_id __maybe_unused sbrmi_of_match[] = {
	{
		.compatible = "amd,sbrmi",
	},
	{ },
};
MODULE_DEVICE_TABLE(of, sbrmi_of_match);

static struct i2c_driver sbrmi_driver = {
	.driver = {
		.name = "sbrmi-i2c",
		.of_match_table = of_match_ptr(sbrmi_of_match),
	},
	.probe = sbrmi_i2c_probe,
	.remove = sbrmi_i2c_remove,
	.id_table = sbrmi_id,
};

static int sbrmi_i3c_probe(struct i3c_device *i3cdev)
{
	struct device *dev = i3cdev_to_dev(i3cdev);
	struct regmap *regmap;
	int rev, ret;

	regmap = devm_regmap_init_i3c(i3cdev, &sbrmi_regmap_config);
	if (IS_ERR(regmap))
		return PTR_ERR(regmap);

	ret = regmap_read(regmap, SBRMI_REV, &rev);
	if (ret)
		return ret;

	/*
	 * For Turin and newer platforms, revision is 0x21 or later. This is
	 * to identify the two byte register address size. However, one
	 * byte transaction can be successful.
	 * Verify if revision is 0x21 or later, if yes, switch to 2 byte
	 * address size.
	 * Continuously using 1 byte address for revision 0x21 or later can lead
	 * to bus corruption.
	 */
	if (rev >= REV_TWO_BYTE_ADDR) {
		regmap = devm_regmap_init_i3c(i3cdev, &sbrmi_regmap_config_ext);
		if (IS_ERR(regmap))
			return PTR_ERR(regmap);
	}

	/*
	 * AMD APML I3C devices support static address.
	 * If static address is defined, dynamic address is same as static address.
	 * In case static address is not defined, I3C master controller defined
	 * dynamic address is used.
	 */
	return sbrmi_common_probe(dev, regmap, i3cdev->desc->info.dyn_addr);
}

static void sbrmi_i3c_remove(struct i3c_device *i3cdev)
{
	struct sbrmi_data *data = dev_get_drvdata(&i3cdev->dev);

	misc_deregister(&data->sbrmi_misc_dev);
}

static const struct i3c_device_id sbrmi_i3c_id[] = {
	/* PID for AMD SBRMI device */
	I3C_DEVICE_EXTRA_INFO(0x112, 0x0, 0x2, NULL),
	{}
};
MODULE_DEVICE_TABLE(i3c, sbrmi_i3c_id);

static struct i3c_driver sbrmi_i3c_driver = {
	.driver = {
		.name = "sbrmi-i3c",
	},
	.probe = sbrmi_i3c_probe,
	.remove = sbrmi_i3c_remove,
	.id_table = sbrmi_i3c_id,
};

module_i3c_i2c_driver(sbrmi_i3c_driver, &sbrmi_driver);

MODULE_AUTHOR("Akshay Gupta <akshay.gupta@amd.com>");
MODULE_AUTHOR("Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>");
MODULE_DESCRIPTION("Hwmon driver for AMD SB-RMI emulated sensor");
MODULE_LICENSE("GPL");