Linux Audio

Check our new training course

Loading...
v5.9
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Thunderbolt/USB4 retimer support.
  4 *
  5 * Copyright (C) 2020, Intel Corporation
  6 * Authors: Kranthi Kuntala <kranthi.kuntala@intel.com>
  7 *	    Mika Westerberg <mika.westerberg@linux.intel.com>
  8 */
  9
 10#include <linux/delay.h>
 11#include <linux/pm_runtime.h>
 12#include <linux/sched/signal.h>
 13
 14#include "sb_regs.h"
 15#include "tb.h"
 16
 17#define TB_MAX_RETIMER_INDEX	6
 18
 19static int tb_retimer_nvm_read(void *priv, unsigned int offset, void *val,
 20			       size_t bytes)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 21{
 22	struct tb_nvm *nvm = priv;
 23	struct tb_retimer *rt = tb_to_retimer(nvm->dev);
 24	int ret;
 25
 26	pm_runtime_get_sync(&rt->dev);
 27
 28	if (!mutex_trylock(&rt->tb->lock)) {
 29		ret = restart_syscall();
 30		goto out;
 31	}
 32
 33	ret = usb4_port_retimer_nvm_read(rt->port, rt->index, offset, val, bytes);
 34	mutex_unlock(&rt->tb->lock);
 35
 36out:
 37	pm_runtime_mark_last_busy(&rt->dev);
 38	pm_runtime_put_autosuspend(&rt->dev);
 39
 40	return ret;
 41}
 42
 43static int tb_retimer_nvm_write(void *priv, unsigned int offset, void *val,
 44				size_t bytes)
 45{
 46	struct tb_nvm *nvm = priv;
 47	struct tb_retimer *rt = tb_to_retimer(nvm->dev);
 48	int ret = 0;
 49
 50	if (!mutex_trylock(&rt->tb->lock))
 51		return restart_syscall();
 52
 53	ret = tb_nvm_write_buf(nvm, offset, val, bytes);
 54	mutex_unlock(&rt->tb->lock);
 55
 56	return ret;
 57}
 58
 59static int tb_retimer_nvm_add(struct tb_retimer *rt)
 60{
 61	struct tb_nvm *nvm;
 62	u32 val, nvm_size;
 63	int ret;
 64
 65	nvm = tb_nvm_alloc(&rt->dev);
 66	if (IS_ERR(nvm))
 67		return PTR_ERR(nvm);
 68
 69	ret = usb4_port_retimer_nvm_read(rt->port, rt->index, NVM_VERSION, &val,
 70					 sizeof(val));
 71	if (ret)
 72		goto err_nvm;
 
 73
 74	nvm->major = val >> 16;
 75	nvm->minor = val >> 8;
 76
 77	ret = usb4_port_retimer_nvm_read(rt->port, rt->index, NVM_FLASH_SIZE,
 78					 &val, sizeof(val));
 79	if (ret)
 80		goto err_nvm;
 81
 82	nvm_size = (SZ_1M << (val & 7)) / 8;
 83	nvm_size = (nvm_size - SZ_16K) / 2;
 84
 85	ret = tb_nvm_add_active(nvm, nvm_size, tb_retimer_nvm_read);
 86	if (ret)
 87		goto err_nvm;
 88
 89	ret = tb_nvm_add_non_active(nvm, NVM_MAX_SIZE, tb_retimer_nvm_write);
 90	if (ret)
 91		goto err_nvm;
 92
 93	rt->nvm = nvm;
 
 94	return 0;
 95
 96err_nvm:
 97	tb_nvm_free(nvm);
 
 
 
 98	return ret;
 99}
100
101static int tb_retimer_nvm_validate_and_write(struct tb_retimer *rt)
102{
103	unsigned int image_size, hdr_size;
104	const u8 *buf = rt->nvm->buf;
105	u16 ds_size, device;
 
 
 
 
106
 
107	image_size = rt->nvm->buf_data_size;
108	if (image_size < NVM_MIN_SIZE || image_size > NVM_MAX_SIZE)
109		return -EINVAL;
110
111	/*
112	 * FARB pointer must point inside the image and must at least
113	 * contain parts of the digital section we will be reading here.
114	 */
115	hdr_size = (*(u32 *)buf) & 0xffffff;
116	if (hdr_size + NVM_DEVID + 2 >= image_size)
117		return -EINVAL;
118
119	/* Digital section start should be aligned to 4k page */
120	if (!IS_ALIGNED(hdr_size, SZ_4K))
121		return -EINVAL;
122
123	/*
124	 * Read digital section size and check that it also fits inside
125	 * the image.
126	 */
127	ds_size = *(u16 *)(buf + hdr_size);
128	if (ds_size >= image_size)
129		return -EINVAL;
 
 
 
 
 
 
 
 
 
 
 
 
 
130
131	/*
132	 * Make sure the device ID in the image matches the retimer
133	 * hardware.
134	 */
135	device = *(u16 *)(buf + hdr_size + NVM_DEVID);
136	if (device != rt->device)
137		return -EINVAL;
138
139	/* Skip headers in the image */
140	buf += hdr_size;
141	image_size -= hdr_size;
142
143	return usb4_port_retimer_nvm_write(rt->port, rt->index, 0, buf,
144					   image_size);
145}
146
147static ssize_t device_show(struct device *dev, struct device_attribute *attr,
148			   char *buf)
149{
150	struct tb_retimer *rt = tb_to_retimer(dev);
151
152	return sprintf(buf, "%#x\n", rt->device);
153}
154static DEVICE_ATTR_RO(device);
155
156static ssize_t nvm_authenticate_show(struct device *dev,
157	struct device_attribute *attr, char *buf)
158{
159	struct tb_retimer *rt = tb_to_retimer(dev);
160	int ret;
161
162	if (!mutex_trylock(&rt->tb->lock))
163		return restart_syscall();
164
165	if (!rt->nvm)
166		ret = -EAGAIN;
 
 
167	else
168		ret = sprintf(buf, "%#x\n", rt->auth_status);
169
170	mutex_unlock(&rt->tb->lock);
171
172	return ret;
173}
174
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
175static ssize_t nvm_authenticate_store(struct device *dev,
176	struct device_attribute *attr, const char *buf, size_t count)
177{
178	struct tb_retimer *rt = tb_to_retimer(dev);
179	bool val;
180	int ret;
181
182	pm_runtime_get_sync(&rt->dev);
183
184	if (!mutex_trylock(&rt->tb->lock)) {
185		ret = restart_syscall();
186		goto exit_rpm;
187	}
188
189	if (!rt->nvm) {
190		ret = -EAGAIN;
191		goto exit_unlock;
192	}
193
194	ret = kstrtobool(buf, &val);
195	if (ret)
196		goto exit_unlock;
197
198	/* Always clear status */
199	rt->auth_status = 0;
200
201	if (val) {
202		if (!rt->nvm->buf) {
203			ret = -EINVAL;
204			goto exit_unlock;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
205		}
206
207		ret = tb_retimer_nvm_validate_and_write(rt);
208		if (ret)
209			goto exit_unlock;
210
211		ret = usb4_port_retimer_nvm_authenticate(rt->port, rt->index);
212	}
213
214exit_unlock:
 
 
215	mutex_unlock(&rt->tb->lock);
216exit_rpm:
217	pm_runtime_mark_last_busy(&rt->dev);
218	pm_runtime_put_autosuspend(&rt->dev);
219
220	if (ret)
221		return ret;
222	return count;
223}
224static DEVICE_ATTR_RW(nvm_authenticate);
225
226static ssize_t nvm_version_show(struct device *dev,
227				struct device_attribute *attr, char *buf)
228{
229	struct tb_retimer *rt = tb_to_retimer(dev);
230	int ret;
231
232	if (!mutex_trylock(&rt->tb->lock))
233		return restart_syscall();
234
235	if (!rt->nvm)
236		ret = -EAGAIN;
237	else
238		ret = sprintf(buf, "%x.%x\n", rt->nvm->major, rt->nvm->minor);
239
240	mutex_unlock(&rt->tb->lock);
241	return ret;
242}
243static DEVICE_ATTR_RO(nvm_version);
244
245static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
246			   char *buf)
247{
248	struct tb_retimer *rt = tb_to_retimer(dev);
249
250	return sprintf(buf, "%#x\n", rt->vendor);
251}
252static DEVICE_ATTR_RO(vendor);
253
254static struct attribute *retimer_attrs[] = {
255	&dev_attr_device.attr,
256	&dev_attr_nvm_authenticate.attr,
257	&dev_attr_nvm_version.attr,
258	&dev_attr_vendor.attr,
259	NULL
260};
261
262static const struct attribute_group retimer_group = {
263	.attrs = retimer_attrs,
264};
265
266static const struct attribute_group *retimer_groups[] = {
267	&retimer_group,
268	NULL
269};
270
271static void tb_retimer_release(struct device *dev)
272{
273	struct tb_retimer *rt = tb_to_retimer(dev);
274
275	kfree(rt);
276}
277
278struct device_type tb_retimer_type = {
279	.name = "thunderbolt_retimer",
280	.groups = retimer_groups,
281	.release = tb_retimer_release,
282};
283
284static int tb_retimer_add(struct tb_port *port, u8 index, u32 auth_status)
285{
286	struct tb_retimer *rt;
287	u32 vendor, device;
288	int ret;
289
290	if (!port->cap_usb4)
291		return -EINVAL;
292
293	ret = usb4_port_retimer_read(port, index, USB4_SB_VENDOR_ID, &vendor,
294				     sizeof(vendor));
295	if (ret) {
296		if (ret != -ENODEV)
297			tb_port_warn(port, "failed read retimer VendorId: %d\n", ret);
298		return ret;
299	}
300
301	ret = usb4_port_retimer_read(port, index, USB4_SB_PRODUCT_ID, &device,
302				     sizeof(device));
303	if (ret) {
304		if (ret != -ENODEV)
305			tb_port_warn(port, "failed read retimer ProductId: %d\n", ret);
306		return ret;
307	}
308
309	if (vendor != PCI_VENDOR_ID_INTEL && vendor != 0x8087) {
310		tb_port_info(port, "retimer NVM format of vendor %#x is not supported\n",
311			     vendor);
312		return -EOPNOTSUPP;
313	}
314
315	/*
316	 * Check that it supports NVM operations. If not then don't add
317	 * the device at all.
318	 */
319	ret = usb4_port_retimer_nvm_sector_size(port, index);
320	if (ret < 0)
321		return ret;
322
323	rt = kzalloc(sizeof(*rt), GFP_KERNEL);
324	if (!rt)
325		return -ENOMEM;
326
327	rt->index = index;
328	rt->vendor = vendor;
329	rt->device = device;
330	rt->auth_status = auth_status;
331	rt->port = port;
332	rt->tb = port->sw->tb;
333
334	rt->dev.parent = &port->sw->dev;
335	rt->dev.bus = &tb_bus_type;
336	rt->dev.type = &tb_retimer_type;
337	dev_set_name(&rt->dev, "%s:%u.%u", dev_name(&port->sw->dev),
338		     port->port, index);
339
340	ret = device_register(&rt->dev);
341	if (ret) {
342		dev_err(&rt->dev, "failed to register retimer: %d\n", ret);
343		put_device(&rt->dev);
344		return ret;
345	}
346
347	ret = tb_retimer_nvm_add(rt);
348	if (ret) {
349		dev_err(&rt->dev, "failed to add NVM devices: %d\n", ret);
350		device_del(&rt->dev);
351		return ret;
352	}
353
354	dev_info(&rt->dev, "new retimer found, vendor=%#x device=%#x\n",
355		 rt->vendor, rt->device);
356
357	pm_runtime_no_callbacks(&rt->dev);
358	pm_runtime_set_active(&rt->dev);
359	pm_runtime_enable(&rt->dev);
360	pm_runtime_set_autosuspend_delay(&rt->dev, TB_AUTOSUSPEND_DELAY);
361	pm_runtime_mark_last_busy(&rt->dev);
362	pm_runtime_use_autosuspend(&rt->dev);
363
364	return 0;
365}
366
367static void tb_retimer_remove(struct tb_retimer *rt)
368{
369	dev_info(&rt->dev, "retimer disconnected\n");
370	tb_nvm_free(rt->nvm);
371	device_unregister(&rt->dev);
372}
373
374struct tb_retimer_lookup {
375	const struct tb_port *port;
376	u8 index;
377};
378
379static int retimer_match(struct device *dev, void *data)
380{
381	const struct tb_retimer_lookup *lookup = data;
382	struct tb_retimer *rt = tb_to_retimer(dev);
383
384	return rt && rt->port == lookup->port && rt->index == lookup->index;
385}
386
387static struct tb_retimer *tb_port_find_retimer(struct tb_port *port, u8 index)
388{
389	struct tb_retimer_lookup lookup = { .port = port, .index = index };
390	struct device *dev;
391
392	dev = device_find_child(&port->sw->dev, &lookup, retimer_match);
393	if (dev)
394		return tb_to_retimer(dev);
395
396	return NULL;
397}
398
399/**
400 * tb_retimer_scan() - Scan for on-board retimers under port
401 * @port: USB4 port to scan
 
402 *
403 * Tries to enumerate on-board retimers connected to @port. Found
404 * retimers are registered as children of @port. Does not scan for cable
405 * retimers for now.
 
406 */
407int tb_retimer_scan(struct tb_port *port)
408{
409	u32 status[TB_MAX_RETIMER_INDEX] = {};
410	int ret, i, last_idx = 0;
411
412	if (!port->cap_usb4)
413		return 0;
414
415	/*
416	 * Send broadcast RT to make sure retimer indices facing this
417	 * port are set.
418	 */
419	ret = usb4_port_enumerate_retimers(port);
420	if (ret)
421		return ret;
422
423	/*
424	 * Before doing anything else, read the authentication status.
425	 * If the retimer has it set, store it for the new retimer
426	 * device instance.
427	 */
428	for (i = 1; i <= TB_MAX_RETIMER_INDEX; i++)
429		usb4_port_retimer_nvm_authenticate_status(port, i, &status[i]);
 
 
 
 
 
430
431	for (i = 1; i <= TB_MAX_RETIMER_INDEX; i++) {
432		/*
433		 * Last retimer is true only for the last on-board
434		 * retimer (the one connected directly to the Type-C
435		 * port).
436		 */
437		ret = usb4_port_retimer_is_last(port, i);
438		if (ret > 0)
439			last_idx = i;
440		else if (ret < 0)
441			break;
442	}
443
 
 
444	if (!last_idx)
445		return 0;
446
447	/* Add on-board retimers if they do not exist already */
 
448	for (i = 1; i <= last_idx; i++) {
449		struct tb_retimer *rt;
450
451		rt = tb_port_find_retimer(port, i);
452		if (rt) {
453			put_device(&rt->dev);
454		} else {
455			ret = tb_retimer_add(port, i, status[i]);
456			if (ret && ret != -EOPNOTSUPP)
457				return ret;
458		}
459	}
460
461	return 0;
462}
463
464static int remove_retimer(struct device *dev, void *data)
465{
466	struct tb_retimer *rt = tb_to_retimer(dev);
467	struct tb_port *port = data;
468
469	if (rt && rt->port == port)
470		tb_retimer_remove(rt);
471	return 0;
472}
473
474/**
475 * tb_retimer_remove_all() - Remove all retimers under port
476 * @port: USB4 port whose retimers to remove
477 *
478 * This removes all previously added retimers under @port.
479 */
480void tb_retimer_remove_all(struct tb_port *port)
481{
482	if (port->cap_usb4)
483		device_for_each_child_reverse(&port->sw->dev, port,
 
 
 
484					      remove_retimer);
485}
v6.8
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Thunderbolt/USB4 retimer support.
  4 *
  5 * Copyright (C) 2020, Intel Corporation
  6 * Authors: Kranthi Kuntala <kranthi.kuntala@intel.com>
  7 *	    Mika Westerberg <mika.westerberg@linux.intel.com>
  8 */
  9
 10#include <linux/delay.h>
 11#include <linux/pm_runtime.h>
 12#include <linux/sched/signal.h>
 13
 14#include "sb_regs.h"
 15#include "tb.h"
 16
 17#define TB_MAX_RETIMER_INDEX	6
 18
 19/**
 20 * tb_retimer_nvm_read() - Read contents of retimer NVM
 21 * @rt: Retimer device
 22 * @address: NVM address (in bytes) to start reading
 23 * @buf: Data read from NVM is stored here
 24 * @size: Number of bytes to read
 25 *
 26 * Reads retimer NVM and copies the contents to @buf. Returns %0 if the
 27 * read was successful and negative errno in case of failure.
 28 */
 29int tb_retimer_nvm_read(struct tb_retimer *rt, unsigned int address, void *buf,
 30			size_t size)
 31{
 32	return usb4_port_retimer_nvm_read(rt->port, rt->index, address, buf, size);
 33}
 34
 35static int nvm_read(void *priv, unsigned int offset, void *val, size_t bytes)
 36{
 37	struct tb_nvm *nvm = priv;
 38	struct tb_retimer *rt = tb_to_retimer(nvm->dev);
 39	int ret;
 40
 41	pm_runtime_get_sync(&rt->dev);
 42
 43	if (!mutex_trylock(&rt->tb->lock)) {
 44		ret = restart_syscall();
 45		goto out;
 46	}
 47
 48	ret = tb_retimer_nvm_read(rt, offset, val, bytes);
 49	mutex_unlock(&rt->tb->lock);
 50
 51out:
 52	pm_runtime_mark_last_busy(&rt->dev);
 53	pm_runtime_put_autosuspend(&rt->dev);
 54
 55	return ret;
 56}
 57
 58static int nvm_write(void *priv, unsigned int offset, void *val, size_t bytes)
 
 59{
 60	struct tb_nvm *nvm = priv;
 61	struct tb_retimer *rt = tb_to_retimer(nvm->dev);
 62	int ret = 0;
 63
 64	if (!mutex_trylock(&rt->tb->lock))
 65		return restart_syscall();
 66
 67	ret = tb_nvm_write_buf(nvm, offset, val, bytes);
 68	mutex_unlock(&rt->tb->lock);
 69
 70	return ret;
 71}
 72
 73static int tb_retimer_nvm_add(struct tb_retimer *rt)
 74{
 75	struct tb_nvm *nvm;
 
 76	int ret;
 77
 78	nvm = tb_nvm_alloc(&rt->dev);
 79	if (IS_ERR(nvm)) {
 80		ret = PTR_ERR(nvm) == -EOPNOTSUPP ? 0 : PTR_ERR(nvm);
 
 
 
 
 81		goto err_nvm;
 82	}
 83
 84	ret = tb_nvm_read_version(nvm);
 
 
 
 
 85	if (ret)
 86		goto err_nvm;
 87
 88	ret = tb_nvm_add_active(nvm, nvm_read);
 
 
 
 89	if (ret)
 90		goto err_nvm;
 91
 92	ret = tb_nvm_add_non_active(nvm, nvm_write);
 93	if (ret)
 94		goto err_nvm;
 95
 96	rt->nvm = nvm;
 97	dev_dbg(&rt->dev, "NVM version %x.%x\n", nvm->major, nvm->minor);
 98	return 0;
 99
100err_nvm:
101	dev_dbg(&rt->dev, "NVM upgrade disabled\n");
102	if (!IS_ERR(nvm))
103		tb_nvm_free(nvm);
104
105	return ret;
106}
107
108static int tb_retimer_nvm_validate_and_write(struct tb_retimer *rt)
109{
110	unsigned int image_size;
111	const u8 *buf;
112	int ret;
113
114	ret = tb_nvm_validate(rt->nvm);
115	if (ret)
116		return ret;
117
118	buf = rt->nvm->buf_data_start;
119	image_size = rt->nvm->buf_data_size;
 
 
120
121	ret = usb4_port_retimer_nvm_write(rt->port, rt->index, 0, buf,
122					 image_size);
123	if (ret)
124		return ret;
 
 
 
 
 
 
 
125
126	rt->nvm->flushed = true;
127	return 0;
128}
129
130static int tb_retimer_nvm_authenticate(struct tb_retimer *rt, bool auth_only)
131{
132	u32 status;
133	int ret;
134
135	if (auth_only) {
136		ret = usb4_port_retimer_nvm_set_offset(rt->port, rt->index, 0);
137		if (ret)
138			return ret;
139	}
140
141	ret = usb4_port_retimer_nvm_authenticate(rt->port, rt->index);
142	if (ret)
143		return ret;
144
145	usleep_range(100, 150);
146
147	/*
148	 * Check the status now if we still can access the retimer. It
149	 * is expected that the below fails.
150	 */
151	ret = usb4_port_retimer_nvm_authenticate_status(rt->port, rt->index,
152							&status);
153	if (!ret) {
154		rt->auth_status = status;
155		return status ? -EINVAL : 0;
156	}
 
157
158	return 0;
 
159}
160
161static ssize_t device_show(struct device *dev, struct device_attribute *attr,
162			   char *buf)
163{
164	struct tb_retimer *rt = tb_to_retimer(dev);
165
166	return sysfs_emit(buf, "%#x\n", rt->device);
167}
168static DEVICE_ATTR_RO(device);
169
170static ssize_t nvm_authenticate_show(struct device *dev,
171	struct device_attribute *attr, char *buf)
172{
173	struct tb_retimer *rt = tb_to_retimer(dev);
174	int ret;
175
176	if (!mutex_trylock(&rt->tb->lock))
177		return restart_syscall();
178
179	if (!rt->nvm)
180		ret = -EAGAIN;
181	else if (rt->no_nvm_upgrade)
182		ret = -EOPNOTSUPP;
183	else
184		ret = sysfs_emit(buf, "%#x\n", rt->auth_status);
185
186	mutex_unlock(&rt->tb->lock);
187
188	return ret;
189}
190
191static void tb_retimer_nvm_authenticate_status(struct tb_port *port, u32 *status)
192{
193	int i;
194
195	tb_port_dbg(port, "reading NVM authentication status of retimers\n");
196
197	/*
198	 * Before doing anything else, read the authentication status.
199	 * If the retimer has it set, store it for the new retimer
200	 * device instance.
201	 */
202	for (i = 1; i <= TB_MAX_RETIMER_INDEX; i++)
203		usb4_port_retimer_nvm_authenticate_status(port, i, &status[i]);
204}
205
206static void tb_retimer_set_inbound_sbtx(struct tb_port *port)
207{
208	int i;
209
210	/*
211	 * When USB4 port is online sideband communications are
212	 * already up.
213	 */
214	if (!usb4_port_device_is_offline(port->usb4))
215		return;
216
217	tb_port_dbg(port, "enabling sideband transactions\n");
218
219	for (i = 1; i <= TB_MAX_RETIMER_INDEX; i++)
220		usb4_port_retimer_set_inbound_sbtx(port, i);
221}
222
223static void tb_retimer_unset_inbound_sbtx(struct tb_port *port)
224{
225	int i;
226
227	/*
228	 * When USB4 port is offline we need to keep the sideband
229	 * communications up to make it possible to communicate with
230	 * the connected retimers.
231	 */
232	if (usb4_port_device_is_offline(port->usb4))
233		return;
234
235	tb_port_dbg(port, "disabling sideband transactions\n");
236
237	for (i = TB_MAX_RETIMER_INDEX; i >= 1; i--)
238		usb4_port_retimer_unset_inbound_sbtx(port, i);
239}
240
241static ssize_t nvm_authenticate_store(struct device *dev,
242	struct device_attribute *attr, const char *buf, size_t count)
243{
244	struct tb_retimer *rt = tb_to_retimer(dev);
245	int val, ret;
 
246
247	pm_runtime_get_sync(&rt->dev);
248
249	if (!mutex_trylock(&rt->tb->lock)) {
250		ret = restart_syscall();
251		goto exit_rpm;
252	}
253
254	if (!rt->nvm) {
255		ret = -EAGAIN;
256		goto exit_unlock;
257	}
258
259	ret = kstrtoint(buf, 10, &val);
260	if (ret)
261		goto exit_unlock;
262
263	/* Always clear status */
264	rt->auth_status = 0;
265
266	if (val) {
267		/*
268		 * When NVM authentication starts the retimer is not
269		 * accessible so calling tb_retimer_unset_inbound_sbtx()
270		 * will fail and therefore we do not call it. Exception
271		 * is when the validation fails or we only write the new
272		 * NVM image without authentication.
273		 */
274		tb_retimer_set_inbound_sbtx(rt->port);
275		if (val == AUTHENTICATE_ONLY) {
276			ret = tb_retimer_nvm_authenticate(rt, true);
277		} else {
278			if (!rt->nvm->flushed) {
279				if (!rt->nvm->buf) {
280					ret = -EINVAL;
281					goto exit_unlock;
282				}
283
284				ret = tb_retimer_nvm_validate_and_write(rt);
285				if (ret || val == WRITE_ONLY)
286					goto exit_unlock;
287			}
288			if (val == WRITE_AND_AUTHENTICATE)
289				ret = tb_retimer_nvm_authenticate(rt, false);
290		}
 
 
 
 
 
 
291	}
292
293exit_unlock:
294	if (ret || val == WRITE_ONLY)
295		tb_retimer_unset_inbound_sbtx(rt->port);
296	mutex_unlock(&rt->tb->lock);
297exit_rpm:
298	pm_runtime_mark_last_busy(&rt->dev);
299	pm_runtime_put_autosuspend(&rt->dev);
300
301	if (ret)
302		return ret;
303	return count;
304}
305static DEVICE_ATTR_RW(nvm_authenticate);
306
307static ssize_t nvm_version_show(struct device *dev,
308				struct device_attribute *attr, char *buf)
309{
310	struct tb_retimer *rt = tb_to_retimer(dev);
311	int ret;
312
313	if (!mutex_trylock(&rt->tb->lock))
314		return restart_syscall();
315
316	if (!rt->nvm)
317		ret = -EAGAIN;
318	else
319		ret = sysfs_emit(buf, "%x.%x\n", rt->nvm->major, rt->nvm->minor);
320
321	mutex_unlock(&rt->tb->lock);
322	return ret;
323}
324static DEVICE_ATTR_RO(nvm_version);
325
326static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
327			   char *buf)
328{
329	struct tb_retimer *rt = tb_to_retimer(dev);
330
331	return sysfs_emit(buf, "%#x\n", rt->vendor);
332}
333static DEVICE_ATTR_RO(vendor);
334
335static struct attribute *retimer_attrs[] = {
336	&dev_attr_device.attr,
337	&dev_attr_nvm_authenticate.attr,
338	&dev_attr_nvm_version.attr,
339	&dev_attr_vendor.attr,
340	NULL
341};
342
343static const struct attribute_group retimer_group = {
344	.attrs = retimer_attrs,
345};
346
347static const struct attribute_group *retimer_groups[] = {
348	&retimer_group,
349	NULL
350};
351
352static void tb_retimer_release(struct device *dev)
353{
354	struct tb_retimer *rt = tb_to_retimer(dev);
355
356	kfree(rt);
357}
358
359struct device_type tb_retimer_type = {
360	.name = "thunderbolt_retimer",
361	.groups = retimer_groups,
362	.release = tb_retimer_release,
363};
364
365static int tb_retimer_add(struct tb_port *port, u8 index, u32 auth_status)
366{
367	struct tb_retimer *rt;
368	u32 vendor, device;
369	int ret;
370
 
 
 
371	ret = usb4_port_retimer_read(port, index, USB4_SB_VENDOR_ID, &vendor,
372				     sizeof(vendor));
373	if (ret) {
374		if (ret != -ENODEV)
375			tb_port_warn(port, "failed read retimer VendorId: %d\n", ret);
376		return ret;
377	}
378
379	ret = usb4_port_retimer_read(port, index, USB4_SB_PRODUCT_ID, &device,
380				     sizeof(device));
381	if (ret) {
382		if (ret != -ENODEV)
383			tb_port_warn(port, "failed read retimer ProductId: %d\n", ret);
384		return ret;
385	}
386
 
 
 
 
 
 
387	/*
388	 * Check that it supports NVM operations. If not then don't add
389	 * the device at all.
390	 */
391	ret = usb4_port_retimer_nvm_sector_size(port, index);
392	if (ret < 0)
393		return ret;
394
395	rt = kzalloc(sizeof(*rt), GFP_KERNEL);
396	if (!rt)
397		return -ENOMEM;
398
399	rt->index = index;
400	rt->vendor = vendor;
401	rt->device = device;
402	rt->auth_status = auth_status;
403	rt->port = port;
404	rt->tb = port->sw->tb;
405
406	rt->dev.parent = &port->usb4->dev;
407	rt->dev.bus = &tb_bus_type;
408	rt->dev.type = &tb_retimer_type;
409	dev_set_name(&rt->dev, "%s:%u.%u", dev_name(&port->sw->dev),
410		     port->port, index);
411
412	ret = device_register(&rt->dev);
413	if (ret) {
414		dev_err(&rt->dev, "failed to register retimer: %d\n", ret);
415		put_device(&rt->dev);
416		return ret;
417	}
418
419	ret = tb_retimer_nvm_add(rt);
420	if (ret) {
421		dev_err(&rt->dev, "failed to add NVM devices: %d\n", ret);
422		device_unregister(&rt->dev);
423		return ret;
424	}
425
426	dev_info(&rt->dev, "new retimer found, vendor=%#x device=%#x\n",
427		 rt->vendor, rt->device);
428
429	pm_runtime_no_callbacks(&rt->dev);
430	pm_runtime_set_active(&rt->dev);
431	pm_runtime_enable(&rt->dev);
432	pm_runtime_set_autosuspend_delay(&rt->dev, TB_AUTOSUSPEND_DELAY);
433	pm_runtime_mark_last_busy(&rt->dev);
434	pm_runtime_use_autosuspend(&rt->dev);
435
436	return 0;
437}
438
439static void tb_retimer_remove(struct tb_retimer *rt)
440{
441	dev_info(&rt->dev, "retimer disconnected\n");
442	tb_nvm_free(rt->nvm);
443	device_unregister(&rt->dev);
444}
445
446struct tb_retimer_lookup {
447	const struct tb_port *port;
448	u8 index;
449};
450
451static int retimer_match(struct device *dev, void *data)
452{
453	const struct tb_retimer_lookup *lookup = data;
454	struct tb_retimer *rt = tb_to_retimer(dev);
455
456	return rt && rt->port == lookup->port && rt->index == lookup->index;
457}
458
459static struct tb_retimer *tb_port_find_retimer(struct tb_port *port, u8 index)
460{
461	struct tb_retimer_lookup lookup = { .port = port, .index = index };
462	struct device *dev;
463
464	dev = device_find_child(&port->usb4->dev, &lookup, retimer_match);
465	if (dev)
466		return tb_to_retimer(dev);
467
468	return NULL;
469}
470
471/**
472 * tb_retimer_scan() - Scan for on-board retimers under port
473 * @port: USB4 port to scan
474 * @add: If true also registers found retimers
475 *
476 * Brings the sideband into a state where retimers can be accessed.
477 * Then Tries to enumerate on-board retimers connected to @port. Found
478 * retimers are registered as children of @port if @add is set.  Does
479 * not scan for cable retimers for now.
480 */
481int tb_retimer_scan(struct tb_port *port, bool add)
482{
483	u32 status[TB_MAX_RETIMER_INDEX + 1] = {};
484	int ret, i, last_idx = 0;
485
 
 
 
486	/*
487	 * Send broadcast RT to make sure retimer indices facing this
488	 * port are set.
489	 */
490	ret = usb4_port_enumerate_retimers(port);
491	if (ret)
492		return ret;
493
494	/*
495	 * Immediately after sending enumerate retimers read the
496	 * authentication status of each retimer.
 
497	 */
498	tb_retimer_nvm_authenticate_status(port, status);
499
500	/*
501	 * Enable sideband channel for each retimer. We can do this
502	 * regardless whether there is device connected or not.
503	 */
504	tb_retimer_set_inbound_sbtx(port);
505
506	for (i = 1; i <= TB_MAX_RETIMER_INDEX; i++) {
507		/*
508		 * Last retimer is true only for the last on-board
509		 * retimer (the one connected directly to the Type-C
510		 * port).
511		 */
512		ret = usb4_port_retimer_is_last(port, i);
513		if (ret > 0)
514			last_idx = i;
515		else if (ret < 0)
516			break;
517	}
518
519	tb_retimer_unset_inbound_sbtx(port);
520
521	if (!last_idx)
522		return 0;
523
524	/* Add on-board retimers if they do not exist already */
525	ret = 0;
526	for (i = 1; i <= last_idx; i++) {
527		struct tb_retimer *rt;
528
529		rt = tb_port_find_retimer(port, i);
530		if (rt) {
531			put_device(&rt->dev);
532		} else if (add) {
533			ret = tb_retimer_add(port, i, status[i]);
534			if (ret && ret != -EOPNOTSUPP)
535				break;
536		}
537	}
538
539	return ret;
540}
541
542static int remove_retimer(struct device *dev, void *data)
543{
544	struct tb_retimer *rt = tb_to_retimer(dev);
545	struct tb_port *port = data;
546
547	if (rt && rt->port == port)
548		tb_retimer_remove(rt);
549	return 0;
550}
551
552/**
553 * tb_retimer_remove_all() - Remove all retimers under port
554 * @port: USB4 port whose retimers to remove
555 *
556 * This removes all previously added retimers under @port.
557 */
558void tb_retimer_remove_all(struct tb_port *port)
559{
560	struct usb4_port *usb4;
561
562	usb4 = port->usb4;
563	if (usb4)
564		device_for_each_child_reverse(&usb4->dev, port,
565					      remove_retimer);
566}