summaryrefslogtreecommitdiff
path: root/drivers/remoteproc/adi_sc5xx_rproc.c
blob: 86acd1b98c70d9d4be2f08071479cfb4e5c12460 (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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * (C) Copyright 2022 - Analog Devices, Inc.
 *
 * Written and/or maintained by Timesys Corporation
 *
 * Contact: Nathan Barrett-Morrison <nathan.morrison@timesys.com>
 * Contact: Greg Malysa <greg.malysa@timesys.com>
 *
 * Analog Devices SC5xx remoteproc driver for loading code onto SHARC cores
 */

#include <dm.h>
#include <regmap.h>
#include <remoteproc.h>
#include <syscon.h>
#include <dm/device_compat.h>
#include <linux/delay.h>
#include <linux/io.h>

/* Register offsets */
#ifdef CONFIG_SC58X
#define ADI_RCU_REG_CTL		0x00
#define ADI_RCU_REG_STAT	0x04
#define ADI_RCU_REG_CRCTL	0x08
#define ADI_RCU_REG_CRSTAT	0x0c
#define ADI_RCU_REG_SIDIS	0x10
#define ADI_RCU_REG_SISTAT	0x14
#define ADI_RCU_REG_BCODE	0x1c
#define ADI_RCU_REG_SVECT0	0x20
#define ADI_RCU_REG_SVECT1	0x24
#define ADI_RCU_REG_SVECT2	0x28
#define ADI_RCU_REG_MSG		0x60
#define ADI_RCU_REG_MSG_SET	0x64
#define ADI_RCU_REG_MSG_CLR	0x68
#else
#define ADI_RCU_REG_CTL		0x00
#define ADI_RCU_REG_STAT	0x04
#define ADI_RCU_REG_CRCTL	0x08
#define ADI_RCU_REG_CRSTAT	0x0c
#define ADI_RCU_REG_SRRQSTAT	0x18
#define ADI_RCU_REG_SIDIS	0x1c
#define ADI_RCU_REG_SISTAT	0x20
#define ADI_RCU_REG_SVECT_LCK	0x24
#define ADI_RCU_REG_BCODE	0x28
#define ADI_RCU_REG_SVECT0	0x2c
#define ADI_RCU_REG_SVECT1	0x30
#define ADI_RCU_REG_SVECT2	0x34
#define ADI_RCU_REG_MSG		0x6c
#define ADI_RCU_REG_MSG_SET	0x70
#define ADI_RCU_REG_MSG_CLR	0x74
#endif /* CONFIG_SC58X */

/* Register bit definitions */
#define ADI_RCU_CTL_SYSRST		BIT(0)

/* Bit values for the RCU0_MSG register */
#define RCU0_MSG_C0IDLE			0x00000100		/* Core 0 Idle */
#define RCU0_MSG_C1IDLE			0x00000200		/* Core 1 Idle */
#define RCU0_MSG_C2IDLE			0x00000400		/* Core 2 Idle */
#define RCU0_MSG_CRR0			0x00001000		/* Core 0 reset request */
#define RCU0_MSG_CRR1			0x00002000		/* Core 1 reset request */
#define RCU0_MSG_CRR2			0x00004000		/* Core 2 reset request */
#define RCU0_MSG_C1ACTIVATE		0x00080000		/* Core 1 Activated */
#define RCU0_MSG_C2ACTIVATE		0x00100000		/* Core 2 Activated */

struct sc5xx_rproc_data {
	/* Address to load to svect when rebooting core */
	u32 load_addr;

	/* RCU parameters */
	struct regmap *rcu;
	u32 svect_offset;
	u32 coreid;
};

struct block_code_flag {
	u32 bcode:4,		/* 0-3 */
	    bflag_save:1,	/* 4 */
	    bflag_aux:1,	/* 5 */
	    breserved:1,	/* 6 */
	    bflag_forward:1,	/* 7 */
	    bflag_fill:1,	/* 8 */
	    bflag_quickboot:1,	/* 9 */
	    bflag_callback:1,	/* 10 */
	    bflag_init:1,	/* 11 */
	    bflag_ignore:1,	/* 12 */
	    bflag_indirect:1,	/* 13 */
	    bflag_first:1,	/* 14 */
	    bflag_final:1,	/* 15 */
	    bhdrchk:8,		/* 16-23 */
	    bhdrsign:8;		/* 0xAD, 0xAC or 0xAB */
};

struct ldr_hdr {
	struct block_code_flag bcode_flag;
	u32 target_addr;
	u32 byte_count;
	u32 argument;
};

static int is_final(struct ldr_hdr *hdr)
{
	return hdr->bcode_flag.bflag_final;
}

static int is_empty(struct ldr_hdr *hdr)
{
	return hdr->bcode_flag.bflag_ignore || (hdr->byte_count == 0);
}

static int adi_valid_firmware(struct ldr_hdr *adi_ldr_hdr)
{
	if (!adi_ldr_hdr->byte_count &&
	    (adi_ldr_hdr->bcode_flag.bhdrsign == 0xAD ||
	     adi_ldr_hdr->bcode_flag.bhdrsign == 0xAC ||
	     adi_ldr_hdr->bcode_flag.bhdrsign == 0xAB))
		return 1;

	return 0;
}

static int sharc_load(struct udevice *dev, ulong addr, ulong size)
{
	struct sc5xx_rproc_data *priv = dev_get_priv(dev);
	size_t offset;
	u8 *buf = (u8 *)addr;
	struct ldr_hdr *ldr = (struct ldr_hdr *)addr;
	struct ldr_hdr *block_hdr;
	struct ldr_hdr *next_hdr;

	if (!adi_valid_firmware(ldr)) {
		dev_err(dev, "Firmware at 0x%lx does not appear to be an LDR image\n", addr);
		dev_err(dev, "Note: Signed firmware is not currently supported\n");
		return -EINVAL;
	}

	do {
		block_hdr = (struct ldr_hdr *)buf;
		offset = sizeof(struct ldr_hdr) + (block_hdr->bcode_flag.bflag_fill ?
							0 : block_hdr->byte_count);
		next_hdr = (struct ldr_hdr *)(buf + offset);

		if (block_hdr->bcode_flag.bflag_first)
			priv->load_addr = (unsigned long)block_hdr->target_addr;

		if (!is_empty(block_hdr)) {
			if (block_hdr->bcode_flag.bflag_fill) {
				memset_io((void *)(phys_addr_t)block_hdr->target_addr,
					  block_hdr->argument,
					  block_hdr->byte_count);
			} else {
				memcpy_toio((void *)(phys_addr_t)block_hdr->target_addr,
					  buf + sizeof(struct ldr_hdr),
					  block_hdr->byte_count);
			}
		}

		if (is_final(block_hdr))
			break;

		buf += offset;
	} while (1);

	return 0;
}

static void sharc_reset(struct sc5xx_rproc_data *priv)
{
	u32 coreid = priv->coreid;
	u32 val;

	/* First put core in reset.
	 * Clear CRSTAT bit for given coreid.
	 */
	regmap_write(priv->rcu, ADI_RCU_REG_CRSTAT, 1 << coreid);

	/* Set SIDIS to disable the system interface */
	regmap_read(priv->rcu, ADI_RCU_REG_SIDIS, &val);
	regmap_write(priv->rcu, ADI_RCU_REG_SIDIS, val | (1 << (coreid - 1)));

	/*
	 * Wait for access to coreX have been disabled and all the pending
	 * transactions have completed
	 */
	udelay(50);

	/* Set CRCTL bit to put core in reset */
	regmap_read(priv->rcu, ADI_RCU_REG_CRCTL, &val);
	regmap_write(priv->rcu, ADI_RCU_REG_CRCTL, val | (1 << coreid));

	/* Poll until Core is in reset */
	while (!(regmap_read(priv->rcu, ADI_RCU_REG_CRSTAT, &val), val & (1 << coreid)))
		;

	/* Clear SIDIS to reenable the system interface */
	regmap_read(priv->rcu, ADI_RCU_REG_SIDIS, &val);
	regmap_write(priv->rcu, ADI_RCU_REG_SIDIS, val & ~(1 << (coreid - 1)));

	udelay(50);

	/* Take Core out of reset */
	regmap_read(priv->rcu, ADI_RCU_REG_CRCTL, &val);
	regmap_write(priv->rcu, ADI_RCU_REG_CRCTL, val & ~(1 << coreid));

	/* Wait for done */
	udelay(50);
}

static int sharc_start(struct udevice *dev)
{
	struct sc5xx_rproc_data *priv = dev_get_priv(dev);

	/* Write load address to appropriate SVECT for core */
	regmap_write(priv->rcu, priv->svect_offset, priv->load_addr);

	sharc_reset(priv);

	/* Clear the IDLE bit when start the SHARC core */
	regmap_write(priv->rcu, ADI_RCU_REG_MSG_CLR, RCU0_MSG_C0IDLE << priv->coreid);

	/* Notify CCES */
	regmap_write(priv->rcu, ADI_RCU_REG_MSG_SET, RCU0_MSG_C1ACTIVATE << (priv->coreid - 1));
	return 0;
}

static const struct dm_rproc_ops sc5xx_ops = {
	.load = sharc_load,
	.start = sharc_start,
};

static int sc5xx_probe(struct udevice *dev)
{
	struct sc5xx_rproc_data *priv = dev_get_priv(dev);
	u32 coreid;

	if (dev_read_u32(dev, "coreid", &coreid)) {
		dev_err(dev, "Missing property coreid\n");
		return -ENOENT;
	}

	priv->coreid = coreid;
	switch (coreid) {
	case 1:
		priv->svect_offset = ADI_RCU_REG_SVECT1;
		break;
	case 2:
		priv->svect_offset = ADI_RCU_REG_SVECT2;
		break;
	default:
		dev_err(dev, "Invalid value %d for coreid, must be 1 or 2\n", coreid);
		return -EINVAL;
	}

	priv->rcu = syscon_regmap_lookup_by_phandle(dev, "adi,rcu");
	if (IS_ERR(priv->rcu))
		return PTR_ERR(priv->rcu);

	dev_err(dev, "sc5xx remoteproc core %d available\n", priv->coreid);

	return 0;
}

static const struct udevice_id sc5xx_ids[] = {
	{ .compatible = "adi,sc5xx-rproc" },
	{ }
};

U_BOOT_DRIVER(adi_sc5xx_rproc) = {
	.name = "adi_sc5xx_rproc",
	.of_match = sc5xx_ids,
	.id = UCLASS_REMOTEPROC,
	.ops = &sc5xx_ops,
	.probe = sc5xx_probe,
	.priv_auto = sizeof(struct sc5xx_rproc_data),
	.flags = 0,
};