Blame view

drivers/fpga/altera-cvp.c 19 KB
8e8e69d67   Thomas Gleixner   treewide: Replace...
1
  // SPDX-License-Identifier: GPL-2.0-only
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
2
3
4
5
6
7
8
  /*
   * FPGA Manager Driver for Altera Arria/Cyclone/Stratix CvP
   *
   * Copyright (C) 2017 DENX Software Engineering
   *
   * Anatolij Gustschin <agust@denx.de>
   *
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
   * Manage Altera FPGA firmware using PCIe CvP.
   * Firmware must be in binary "rbf" format.
   */
  
  #include <linux/delay.h>
  #include <linux/device.h>
  #include <linux/fpga/fpga-mgr.h>
  #include <linux/module.h>
  #include <linux/pci.h>
  #include <linux/sizes.h>
  
  #define CVP_BAR		0	/* BAR used for data transfer in memory mode */
  #define CVP_DUMMY_WR	244	/* dummy writes to clear CvP state machine */
  #define TIMEOUT_US	2000	/* CVP STATUS timeout for USERMODE polling */
  
  /* Vendor Specific Extended Capability Registers */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
25
  #define VSE_PCIE_EXT_CAP_ID		0x0
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
26
  #define VSE_PCIE_EXT_CAP_ID_VAL		0x000b	/* 16bit */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
27
  #define VSE_CVP_STATUS			0x1c	/* 32bit */
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
28
29
30
31
32
33
  #define VSE_CVP_STATUS_CFG_RDY		BIT(18)	/* CVP_CONFIG_READY */
  #define VSE_CVP_STATUS_CFG_ERR		BIT(19)	/* CVP_CONFIG_ERROR */
  #define VSE_CVP_STATUS_CVP_EN		BIT(20)	/* ctrl block is enabling CVP */
  #define VSE_CVP_STATUS_USERMODE		BIT(21)	/* USERMODE */
  #define VSE_CVP_STATUS_CFG_DONE		BIT(23)	/* CVP_CONFIG_DONE */
  #define VSE_CVP_STATUS_PLD_CLK_IN_USE	BIT(24)	/* PLD_CLK_IN_USE */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
34
  #define VSE_CVP_MODE_CTRL		0x20	/* 32bit */
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
35
36
37
38
  #define VSE_CVP_MODE_CTRL_CVP_MODE	BIT(0)	/* CVP (1) or normal mode (0) */
  #define VSE_CVP_MODE_CTRL_HIP_CLK_SEL	BIT(1) /* PMA (1) or fabric clock (0) */
  #define VSE_CVP_MODE_CTRL_NUMCLKS_OFF	8	/* NUMCLKS bits offset */
  #define VSE_CVP_MODE_CTRL_NUMCLKS_MASK	GENMASK(15, 8)
eb12511f0   Thor Thayer   fpga: altera-cvp:...
39
40
  #define VSE_CVP_DATA			0x28	/* 32bit */
  #define VSE_CVP_PROG_CTRL		0x2c	/* 32bit */
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
41
42
  #define VSE_CVP_PROG_CTRL_CONFIG	BIT(0)
  #define VSE_CVP_PROG_CTRL_START_XFER	BIT(1)
e58915179   Thor Thayer   fpga: altera-cvp:...
43
  #define VSE_CVP_PROG_CTRL_MASK		GENMASK(1, 0)
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
44

eb12511f0   Thor Thayer   fpga: altera-cvp:...
45
  #define VSE_UNCOR_ERR_STATUS		0x34	/* 32bit */
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
46
  #define VSE_UNCOR_ERR_CVP_CFG_ERR	BIT(5)	/* CVP_CONFIG_ERROR_LATCHED */
e58915179   Thor Thayer   fpga: altera-cvp:...
47
48
49
50
51
52
53
54
55
56
  #define V1_VSEC_OFFSET			0x200	/* Vendor Specific Offset V1 */
  /* V2 Defines */
  #define VSE_CVP_TX_CREDITS		0x49	/* 8bit */
  
  #define V2_CREDIT_TIMEOUT_US		20000
  #define V2_CHECK_CREDIT_US		10
  #define V2_POLL_TIMEOUT_US		1000000
  #define V2_USER_TIMEOUT_US		500000
  
  #define V1_POLL_TIMEOUT_US		10
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
57
58
  #define DRV_NAME		"altera-cvp"
  #define ALTERA_CVP_MGR_NAME	"Altera CvP FPGA Manager"
e58915179   Thor Thayer   fpga: altera-cvp:...
59
60
61
  /* Write block sizes */
  #define ALTERA_CVP_V1_SIZE	4
  #define ALTERA_CVP_V2_SIZE	4096
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
62
63
  /* Optional CvP config error status check for debugging */
  static bool altera_cvp_chkcfg;
e58915179   Thor Thayer   fpga: altera-cvp:...
64
  struct cvp_priv;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
65
66
67
68
  struct altera_cvp_conf {
  	struct fpga_manager	*mgr;
  	struct pci_dev		*pci_dev;
  	void __iomem		*map;
998c1de56   Carlos A Petry   fpga: altera-cvp:...
69
70
  	void			(*write_data)(struct altera_cvp_conf *conf,
  					      u32 data);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
71
72
  	char			mgr_name[64];
  	u8			numclks;
e58915179   Thor Thayer   fpga: altera-cvp:...
73
  	u32			sent_packets;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
74
  	u32			vsec_offset;
e58915179   Thor Thayer   fpga: altera-cvp:...
75
  	const struct cvp_priv	*priv;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
76
  };
e58915179   Thor Thayer   fpga: altera-cvp:...
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  struct cvp_priv {
  	void	(*switch_clk)(struct altera_cvp_conf *conf);
  	int	(*clear_state)(struct altera_cvp_conf *conf);
  	int	(*wait_credit)(struct fpga_manager *mgr, u32 blocks);
  	size_t	block_size;
  	int	poll_time_us;
  	int	user_time_us;
  };
  
  static int altera_read_config_byte(struct altera_cvp_conf *conf,
  				   int where, u8 *val)
  {
  	return pci_read_config_byte(conf->pci_dev, conf->vsec_offset + where,
  				    val);
  }
eb12511f0   Thor Thayer   fpga: altera-cvp:...
92
93
94
95
96
97
98
99
100
101
102
103
104
  static int altera_read_config_dword(struct altera_cvp_conf *conf,
  				    int where, u32 *val)
  {
  	return pci_read_config_dword(conf->pci_dev, conf->vsec_offset + where,
  				     val);
  }
  
  static int altera_write_config_dword(struct altera_cvp_conf *conf,
  				     int where, u32 val)
  {
  	return pci_write_config_dword(conf->pci_dev, conf->vsec_offset + where,
  				      val);
  }
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
105
106
107
108
  static enum fpga_mgr_states altera_cvp_state(struct fpga_manager *mgr)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
  	u32 status;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
109
  	altera_read_config_dword(conf, VSE_CVP_STATUS, &status);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
  
  	if (status & VSE_CVP_STATUS_CFG_DONE)
  		return FPGA_MGR_STATE_OPERATING;
  
  	if (status & VSE_CVP_STATUS_CVP_EN)
  		return FPGA_MGR_STATE_POWER_UP;
  
  	return FPGA_MGR_STATE_UNKNOWN;
  }
  
  static void altera_cvp_write_data_iomem(struct altera_cvp_conf *conf, u32 val)
  {
  	writel(val, conf->map);
  }
  
  static void altera_cvp_write_data_config(struct altera_cvp_conf *conf, u32 val)
  {
eb12511f0   Thor Thayer   fpga: altera-cvp:...
127
128
  	pci_write_config_dword(conf->pci_dev, conf->vsec_offset + VSE_CVP_DATA,
  			       val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
129
130
131
132
133
134
135
136
137
  }
  
  /* switches between CvP clock and internal clock */
  static void altera_cvp_dummy_write(struct altera_cvp_conf *conf)
  {
  	unsigned int i;
  	u32 val;
  
  	/* set 1 CVP clock cycle for every CVP Data Register Write */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
138
  	altera_read_config_dword(conf, VSE_CVP_MODE_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
139
140
  	val &= ~VSE_CVP_MODE_CTRL_NUMCLKS_MASK;
  	val |= 1 << VSE_CVP_MODE_CTRL_NUMCLKS_OFF;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
141
  	altera_write_config_dword(conf, VSE_CVP_MODE_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
  
  	for (i = 0; i < CVP_DUMMY_WR; i++)
  		conf->write_data(conf, 0); /* dummy data, could be any value */
  }
  
  static int altera_cvp_wait_status(struct altera_cvp_conf *conf, u32 status_mask,
  				  u32 status_val, int timeout_us)
  {
  	unsigned int retries;
  	u32 val;
  
  	retries = timeout_us / 10;
  	if (timeout_us % 10)
  		retries++;
  
  	do {
eb12511f0   Thor Thayer   fpga: altera-cvp:...
158
  		altera_read_config_dword(conf, VSE_CVP_STATUS, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
159
160
161
162
163
164
165
166
167
  		if ((val & status_mask) == status_val)
  			return 0;
  
  		/* use small usleep value to re-check and break early */
  		usleep_range(10, 11);
  	} while (--retries);
  
  	return -ETIMEDOUT;
  }
d2083d040   Thor Thayer   fpga: altera-cvp:...
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
  static int altera_cvp_chk_error(struct fpga_manager *mgr, size_t bytes)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
  	u32 val;
  	int ret;
  
  	/* STEP 10 (optional) - check CVP_CONFIG_ERROR flag */
  	ret = altera_read_config_dword(conf, VSE_CVP_STATUS, &val);
  	if (ret || (val & VSE_CVP_STATUS_CFG_ERR)) {
  		dev_err(&mgr->dev, "CVP_CONFIG_ERROR after %zu bytes!
  ",
  			bytes);
  		return -EPROTO;
  	}
  	return 0;
  }
e58915179   Thor Thayer   fpga: altera-cvp:...
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
  /*
   * CvP Version2 Functions
   * Recent Intel FPGAs use a credit mechanism to throttle incoming
   * bitstreams and a different method of clearing the state.
   */
  
  static int altera_cvp_v2_clear_state(struct altera_cvp_conf *conf)
  {
  	u32 val;
  	int ret;
  
  	/* Clear the START_XFER and CVP_CONFIG bits */
  	ret = altera_read_config_dword(conf, VSE_CVP_PROG_CTRL, &val);
  	if (ret) {
  		dev_err(&conf->pci_dev->dev,
  			"Error reading CVP Program Control Register
  ");
  		return ret;
  	}
  
  	val &= ~VSE_CVP_PROG_CTRL_MASK;
  	ret = altera_write_config_dword(conf, VSE_CVP_PROG_CTRL, val);
  	if (ret) {
  		dev_err(&conf->pci_dev->dev,
  			"Error writing CVP Program Control Register
  ");
  		return ret;
  	}
  
  	return altera_cvp_wait_status(conf, VSE_CVP_STATUS_CFG_RDY, 0,
  				      conf->priv->poll_time_us);
  }
  
  static int altera_cvp_v2_wait_for_credit(struct fpga_manager *mgr,
  					 u32 blocks)
  {
  	u32 timeout = V2_CREDIT_TIMEOUT_US / V2_CHECK_CREDIT_US;
  	struct altera_cvp_conf *conf = mgr->priv;
  	int ret;
  	u8 val;
  
  	do {
  		ret = altera_read_config_byte(conf, VSE_CVP_TX_CREDITS, &val);
  		if (ret) {
  			dev_err(&conf->pci_dev->dev,
  				"Error reading CVP Credit Register
  ");
  			return ret;
  		}
  
  		/* Return if there is space in FIFO */
  		if (val - (u8)conf->sent_packets)
  			return 0;
  
  		ret = altera_cvp_chk_error(mgr, blocks * ALTERA_CVP_V2_SIZE);
  		if (ret) {
  			dev_err(&conf->pci_dev->dev,
  				"CE Bit error credit reg[0x%x]:sent[0x%x]
  ",
  				val, conf->sent_packets);
  			return -EAGAIN;
  		}
  
  		/* Limit the check credit byte traffic */
  		usleep_range(V2_CHECK_CREDIT_US, V2_CHECK_CREDIT_US + 1);
  	} while (timeout--);
  
  	dev_err(&conf->pci_dev->dev, "Timeout waiting for credit
  ");
  	return -ETIMEDOUT;
  }
d2083d040   Thor Thayer   fpga: altera-cvp:...
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
  static int altera_cvp_send_block(struct altera_cvp_conf *conf,
  				 const u32 *data, size_t len)
  {
  	u32 mask, words = len / sizeof(u32);
  	int i, remainder;
  
  	for (i = 0; i < words; i++)
  		conf->write_data(conf, *data++);
  
  	/* write up to 3 trailing bytes, if any */
  	remainder = len % sizeof(u32);
  	if (remainder) {
  		mask = BIT(remainder * 8) - 1;
  		if (mask)
  			conf->write_data(conf, *data & mask);
  	}
  
  	return 0;
  }
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
274
275
276
277
  static int altera_cvp_teardown(struct fpga_manager *mgr,
  			       struct fpga_image_info *info)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
278
279
280
281
  	int ret;
  	u32 val;
  
  	/* STEP 12 - reset START_XFER bit */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
282
  	altera_read_config_dword(conf, VSE_CVP_PROG_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
283
  	val &= ~VSE_CVP_PROG_CTRL_START_XFER;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
284
  	altera_write_config_dword(conf, VSE_CVP_PROG_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
285
286
287
  
  	/* STEP 13 - reset CVP_CONFIG bit */
  	val &= ~VSE_CVP_PROG_CTRL_CONFIG;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
288
  	altera_write_config_dword(conf, VSE_CVP_PROG_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
289
290
291
292
293
294
  
  	/*
  	 * STEP 14
  	 * - set CVP_NUMCLKS to 1 and then issue CVP_DUMMY_WR dummy
  	 *   writes to the HIP
  	 */
e58915179   Thor Thayer   fpga: altera-cvp:...
295
296
  	if (conf->priv->switch_clk)
  		conf->priv->switch_clk(conf);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
297
298
  
  	/* STEP 15 - poll CVP_CONFIG_READY bit for 0 with 10us timeout */
e58915179   Thor Thayer   fpga: altera-cvp:...
299
300
  	ret = altera_cvp_wait_status(conf, VSE_CVP_STATUS_CFG_RDY, 0,
  				     conf->priv->poll_time_us);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
301
302
303
304
305
306
307
308
309
310
311
312
  	if (ret)
  		dev_err(&mgr->dev, "CFG_RDY == 0 timeout
  ");
  
  	return ret;
  }
  
  static int altera_cvp_write_init(struct fpga_manager *mgr,
  				 struct fpga_image_info *info,
  				 const char *buf, size_t count)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
  	u32 iflags, val;
  	int ret;
  
  	iflags = info ? info->flags : 0;
  
  	if (iflags & FPGA_MGR_PARTIAL_RECONFIG) {
  		dev_err(&mgr->dev, "Partial reconfiguration not supported.
  ");
  		return -EINVAL;
  	}
  
  	/* Determine allowed clock to data ratio */
  	if (iflags & FPGA_MGR_COMPRESSED_BITSTREAM)
  		conf->numclks = 8; /* ratio for all compressed images */
  	else if (iflags & FPGA_MGR_ENCRYPTED_BITSTREAM)
  		conf->numclks = 4; /* for uncompressed and encrypted images */
  	else
  		conf->numclks = 1; /* for uncompressed and unencrypted images */
  
  	/* STEP 1 - read CVP status and check CVP_EN flag */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
333
  	altera_read_config_dword(conf, VSE_CVP_STATUS, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
  	if (!(val & VSE_CVP_STATUS_CVP_EN)) {
  		dev_err(&mgr->dev, "CVP mode off: 0x%04x
  ", val);
  		return -ENODEV;
  	}
  
  	if (val & VSE_CVP_STATUS_CFG_RDY) {
  		dev_warn(&mgr->dev, "CvP already started, teardown first
  ");
  		ret = altera_cvp_teardown(mgr, info);
  		if (ret)
  			return ret;
  	}
  
  	/*
  	 * STEP 2
  	 * - set HIP_CLK_SEL and CVP_MODE (must be set in the order mentioned)
  	 */
  	/* switch from fabric to PMA clock */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
353
  	altera_read_config_dword(conf, VSE_CVP_MODE_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
354
  	val |= VSE_CVP_MODE_CTRL_HIP_CLK_SEL;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
355
  	altera_write_config_dword(conf, VSE_CVP_MODE_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
356
357
  
  	/* set CVP mode */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
358
  	altera_read_config_dword(conf, VSE_CVP_MODE_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
359
  	val |= VSE_CVP_MODE_CTRL_CVP_MODE;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
360
  	altera_write_config_dword(conf, VSE_CVP_MODE_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
361
362
363
364
365
  
  	/*
  	 * STEP 3
  	 * - set CVP_NUMCLKS to 1 and issue CVP_DUMMY_WR dummy writes to the HIP
  	 */
e58915179   Thor Thayer   fpga: altera-cvp:...
366
367
368
369
370
371
372
373
374
375
376
377
378
  	if (conf->priv->switch_clk)
  		conf->priv->switch_clk(conf);
  
  	if (conf->priv->clear_state) {
  		ret = conf->priv->clear_state(conf);
  		if (ret) {
  			dev_err(&mgr->dev, "Problem clearing out state
  ");
  			return ret;
  		}
  	}
  
  	conf->sent_packets = 0;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
379
380
  
  	/* STEP 4 - set CVP_CONFIG bit */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
381
  	altera_read_config_dword(conf, VSE_CVP_PROG_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
382
383
  	/* request control block to begin transfer using CVP */
  	val |= VSE_CVP_PROG_CTRL_CONFIG;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
384
  	altera_write_config_dword(conf, VSE_CVP_PROG_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
385

e58915179   Thor Thayer   fpga: altera-cvp:...
386
  	/* STEP 5 - poll CVP_CONFIG READY for 1 with timeout */
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
387
  	ret = altera_cvp_wait_status(conf, VSE_CVP_STATUS_CFG_RDY,
e58915179   Thor Thayer   fpga: altera-cvp:...
388
389
  				     VSE_CVP_STATUS_CFG_RDY,
  				     conf->priv->poll_time_us);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
390
391
392
393
394
395
396
397
398
399
  	if (ret) {
  		dev_warn(&mgr->dev, "CFG_RDY == 1 timeout
  ");
  		return ret;
  	}
  
  	/*
  	 * STEP 6
  	 * - set CVP_NUMCLKS to 1 and issue CVP_DUMMY_WR dummy writes to the HIP
  	 */
e58915179   Thor Thayer   fpga: altera-cvp:...
400
401
402
403
404
405
406
407
408
409
410
  	if (conf->priv->switch_clk)
  		conf->priv->switch_clk(conf);
  
  	if (altera_cvp_chkcfg) {
  		ret = altera_cvp_chk_error(mgr, 0);
  		if (ret) {
  			dev_warn(&mgr->dev, "CFG_RDY == 1 timeout
  ");
  			return ret;
  		}
  	}
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
411
412
  
  	/* STEP 7 - set START_XFER */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
413
  	altera_read_config_dword(conf, VSE_CVP_PROG_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
414
  	val |= VSE_CVP_PROG_CTRL_START_XFER;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
415
  	altera_write_config_dword(conf, VSE_CVP_PROG_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
416
417
  
  	/* STEP 8 - start transfer (set CVP_NUMCLKS for bitstream) */
e58915179   Thor Thayer   fpga: altera-cvp:...
418
419
420
421
422
423
  	if (conf->priv->switch_clk) {
  		altera_read_config_dword(conf, VSE_CVP_MODE_CTRL, &val);
  		val &= ~VSE_CVP_MODE_CTRL_NUMCLKS_MASK;
  		val |= conf->numclks << VSE_CVP_MODE_CTRL_NUMCLKS_OFF;
  		altera_write_config_dword(conf, VSE_CVP_MODE_CTRL, val);
  	}
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
424
425
  	return 0;
  }
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
426
427
428
429
  static int altera_cvp_write(struct fpga_manager *mgr, const char *buf,
  			    size_t count)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
d2083d040   Thor Thayer   fpga: altera-cvp:...
430
  	size_t done, remaining, len;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
431
  	const u32 *data;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
432
  	int status = 0;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
433
434
435
436
437
  
  	/* STEP 9 - write 32-bit data from RBF file to CVP data register */
  	data = (u32 *)buf;
  	remaining = count;
  	done = 0;
d2083d040   Thor Thayer   fpga: altera-cvp:...
438
  	while (remaining) {
e58915179   Thor Thayer   fpga: altera-cvp:...
439
440
441
442
443
444
445
446
447
448
449
450
  		/* Use credit throttling if available */
  		if (conf->priv->wait_credit) {
  			status = conf->priv->wait_credit(mgr, done);
  			if (status) {
  				dev_err(&conf->pci_dev->dev,
  					"Wait Credit ERR: 0x%x
  ", status);
  				return status;
  			}
  		}
  
  		len = min(conf->priv->block_size, remaining);
d2083d040   Thor Thayer   fpga: altera-cvp:...
451
  		altera_cvp_send_block(conf, data, len);
e58915179   Thor Thayer   fpga: altera-cvp:...
452
  		data += len / sizeof(u32);
d2083d040   Thor Thayer   fpga: altera-cvp:...
453
454
  		done += len;
  		remaining -= len;
e58915179   Thor Thayer   fpga: altera-cvp:...
455
  		conf->sent_packets++;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
  
  		/*
  		 * STEP 10 (optional) and STEP 11
  		 * - check error flag
  		 * - loop until data transfer completed
  		 * Config images can be huge (more than 40 MiB), so
  		 * only check after a new 4k data block has been written.
  		 * This reduces the number of checks and speeds up the
  		 * configuration process.
  		 */
  		if (altera_cvp_chkcfg && !(done % SZ_4K)) {
  			status = altera_cvp_chk_error(mgr, done);
  			if (status < 0)
  				return status;
  		}
  	}
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
472
473
474
475
476
477
478
479
480
481
  	if (altera_cvp_chkcfg)
  		status = altera_cvp_chk_error(mgr, count);
  
  	return status;
  }
  
  static int altera_cvp_write_complete(struct fpga_manager *mgr,
  				     struct fpga_image_info *info)
  {
  	struct altera_cvp_conf *conf = mgr->priv;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
482
  	u32 mask, val;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
483
  	int ret;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
484
485
486
487
488
489
  
  	ret = altera_cvp_teardown(mgr, info);
  	if (ret)
  		return ret;
  
  	/* STEP 16 - check CVP_CONFIG_ERROR_LATCHED bit */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
490
  	altera_read_config_dword(conf, VSE_UNCOR_ERR_STATUS, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
491
492
493
494
495
496
497
  	if (val & VSE_UNCOR_ERR_CVP_CFG_ERR) {
  		dev_err(&mgr->dev, "detected CVP_CONFIG_ERROR_LATCHED!
  ");
  		return -EPROTO;
  	}
  
  	/* STEP 17 - reset CVP_MODE and HIP_CLK_SEL bit */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
498
  	altera_read_config_dword(conf, VSE_CVP_MODE_CTRL, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
499
500
  	val &= ~VSE_CVP_MODE_CTRL_HIP_CLK_SEL;
  	val &= ~VSE_CVP_MODE_CTRL_CVP_MODE;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
501
  	altera_write_config_dword(conf, VSE_CVP_MODE_CTRL, val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
502
503
504
  
  	/* STEP 18 - poll PLD_CLK_IN_USE and USER_MODE bits */
  	mask = VSE_CVP_STATUS_PLD_CLK_IN_USE | VSE_CVP_STATUS_USERMODE;
e58915179   Thor Thayer   fpga: altera-cvp:...
505
506
  	ret = altera_cvp_wait_status(conf, mask, mask,
  				     conf->priv->user_time_us);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
507
508
509
510
511
512
513
514
515
516
517
518
519
  	if (ret)
  		dev_err(&mgr->dev, "PLD_CLK_IN_USE|USERMODE timeout
  ");
  
  	return ret;
  }
  
  static const struct fpga_manager_ops altera_cvp_ops = {
  	.state		= altera_cvp_state,
  	.write_init	= altera_cvp_write_init,
  	.write		= altera_cvp_write,
  	.write_complete	= altera_cvp_write_complete,
  };
e58915179   Thor Thayer   fpga: altera-cvp:...
520
521
522
523
524
525
526
527
528
529
530
531
532
533
  static const struct cvp_priv cvp_priv_v1 = {
  	.switch_clk	= altera_cvp_dummy_write,
  	.block_size	= ALTERA_CVP_V1_SIZE,
  	.poll_time_us	= V1_POLL_TIMEOUT_US,
  	.user_time_us	= TIMEOUT_US,
  };
  
  static const struct cvp_priv cvp_priv_v2 = {
  	.clear_state	= altera_cvp_v2_clear_state,
  	.wait_credit	= altera_cvp_v2_wait_for_credit,
  	.block_size	= ALTERA_CVP_V2_SIZE,
  	.poll_time_us	= V2_POLL_TIMEOUT_US,
  	.user_time_us	= V2_USER_TIMEOUT_US,
  };
55e001aab   Greg Kroah-Hartman   fpga: altera-cvp:...
534
  static ssize_t chkcfg_show(struct device_driver *dev, char *buf)
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
535
536
537
538
  {
  	return snprintf(buf, 3, "%d
  ", altera_cvp_chkcfg);
  }
55e001aab   Greg Kroah-Hartman   fpga: altera-cvp:...
539
  static ssize_t chkcfg_store(struct device_driver *drv, const char *buf,
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
540
541
542
543
544
545
546
547
548
549
  			    size_t count)
  {
  	int ret;
  
  	ret = kstrtobool(buf, &altera_cvp_chkcfg);
  	if (ret)
  		return ret;
  
  	return count;
  }
55e001aab   Greg Kroah-Hartman   fpga: altera-cvp:...
550
  static DRIVER_ATTR_RW(chkcfg);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
551
552
553
554
  
  static int altera_cvp_probe(struct pci_dev *pdev,
  			    const struct pci_device_id *dev_id);
  static void altera_cvp_remove(struct pci_dev *pdev);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
  static struct pci_device_id altera_cvp_id_tbl[] = {
  	{ PCI_VDEVICE(ALTERA, PCI_ANY_ID) },
  	{ }
  };
  MODULE_DEVICE_TABLE(pci, altera_cvp_id_tbl);
  
  static struct pci_driver altera_cvp_driver = {
  	.name   = DRV_NAME,
  	.id_table = altera_cvp_id_tbl,
  	.probe  = altera_cvp_probe,
  	.remove = altera_cvp_remove,
  };
  
  static int altera_cvp_probe(struct pci_dev *pdev,
  			    const struct pci_device_id *dev_id)
  {
  	struct altera_cvp_conf *conf;
7085e2a94   Alan Tull   fpga: manager: ch...
572
  	struct fpga_manager *mgr;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
573
  	int ret, offset;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
574
  	u16 cmd, val;
68f60538d   Andreas Puhm   fpga: altera-cvp:...
575
  	u32 regval;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
576
577
578
579
580
581
582
583
  
  	/* Discover the Vendor Specific Offset for this device */
  	offset = pci_find_next_ext_capability(pdev, 0, PCI_EXT_CAP_ID_VNDR);
  	if (!offset) {
  		dev_err(&pdev->dev, "No Vendor Specific Offset.
  ");
  		return -ENODEV;
  	}
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
584
585
586
587
588
589
  
  	/*
  	 * First check if this is the expected FPGA device. PCI config
  	 * space access works without enabling the PCI device, memory
  	 * space access is enabled further down.
  	 */
eb12511f0   Thor Thayer   fpga: altera-cvp:...
590
  	pci_read_config_word(pdev, offset + VSE_PCIE_EXT_CAP_ID, &val);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
591
592
593
594
595
  	if (val != VSE_PCIE_EXT_CAP_ID_VAL) {
  		dev_err(&pdev->dev, "Wrong EXT_CAP_ID value 0x%x
  ", val);
  		return -ENODEV;
  	}
eb12511f0   Thor Thayer   fpga: altera-cvp:...
596
  	pci_read_config_dword(pdev, offset + VSE_CVP_STATUS, &regval);
68f60538d   Andreas Puhm   fpga: altera-cvp:...
597
598
599
600
601
602
603
  	if (!(regval & VSE_CVP_STATUS_CVP_EN)) {
  		dev_err(&pdev->dev,
  			"CVP is disabled for this device: CVP_STATUS Reg 0x%x
  ",
  			regval);
  		return -ENODEV;
  	}
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
604
605
606
  	conf = devm_kzalloc(&pdev->dev, sizeof(*conf), GFP_KERNEL);
  	if (!conf)
  		return -ENOMEM;
eb12511f0   Thor Thayer   fpga: altera-cvp:...
607
  	conf->vsec_offset = offset;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
  	/*
  	 * Enable memory BAR access. We cannot use pci_enable_device() here
  	 * because it will make the driver unusable with FPGA devices that
  	 * have additional big IOMEM resources (e.g. 4GiB BARs) on 32-bit
  	 * platform. Such BARs will not have an assigned address range and
  	 * pci_enable_device() will fail, complaining about not claimed BAR,
  	 * even if the concerned BAR is not needed for FPGA configuration
  	 * at all. Thus, enable the device via PCI config space command.
  	 */
  	pci_read_config_word(pdev, PCI_COMMAND, &cmd);
  	if (!(cmd & PCI_COMMAND_MEMORY)) {
  		cmd |= PCI_COMMAND_MEMORY;
  		pci_write_config_word(pdev, PCI_COMMAND, cmd);
  	}
  
  	ret = pci_request_region(pdev, CVP_BAR, "CVP");
  	if (ret) {
  		dev_err(&pdev->dev, "Requesting CVP BAR region failed
  ");
  		goto err_disable;
  	}
  
  	conf->pci_dev = pdev;
  	conf->write_data = altera_cvp_write_data_iomem;
e58915179   Thor Thayer   fpga: altera-cvp:...
632
633
634
635
  	if (conf->vsec_offset == V1_VSEC_OFFSET)
  		conf->priv = &cvp_priv_v1;
  	else
  		conf->priv = &cvp_priv_v2;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
636
637
638
639
640
641
642
643
644
  	conf->map = pci_iomap(pdev, CVP_BAR, 0);
  	if (!conf->map) {
  		dev_warn(&pdev->dev, "Mapping CVP BAR failed
  ");
  		conf->write_data = altera_cvp_write_data_config;
  	}
  
  	snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",
  		 ALTERA_CVP_MGR_NAME, pci_name(pdev));
084181fe8   Alan Tull   fpga: mgr: add de...
645
646
  	mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,
  				   &altera_cvp_ops, conf);
122c5770c   Christophe Jaillet   fpga: altera-cvp:...
647
648
649
650
  	if (!mgr) {
  		ret = -ENOMEM;
  		goto err_unmap;
  	}
7085e2a94   Alan Tull   fpga: manager: ch...
651
652
653
654
  
  	pci_set_drvdata(pdev, mgr);
  
  	ret = fpga_mgr_register(mgr);
084181fe8   Alan Tull   fpga: mgr: add de...
655
  	if (ret)
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
656
  		goto err_unmap;
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
657
658
659
  	return 0;
  
  err_unmap:
187fade88   Anatolij Gustschin   fpga: altera-cvp:...
660
661
  	if (conf->map)
  		pci_iounmap(pdev, conf->map);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
662
663
664
665
666
667
668
669
670
671
672
673
  	pci_release_region(pdev, CVP_BAR);
  err_disable:
  	cmd &= ~PCI_COMMAND_MEMORY;
  	pci_write_config_word(pdev, PCI_COMMAND, cmd);
  	return ret;
  }
  
  static void altera_cvp_remove(struct pci_dev *pdev)
  {
  	struct fpga_manager *mgr = pci_get_drvdata(pdev);
  	struct altera_cvp_conf *conf = mgr->priv;
  	u16 cmd;
7085e2a94   Alan Tull   fpga: manager: ch...
674
  	fpga_mgr_unregister(mgr);
187fade88   Anatolij Gustschin   fpga: altera-cvp:...
675
676
  	if (conf->map)
  		pci_iounmap(pdev, conf->map);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
677
678
679
680
681
  	pci_release_region(pdev, CVP_BAR);
  	pci_read_config_word(pdev, PCI_COMMAND, &cmd);
  	cmd &= ~PCI_COMMAND_MEMORY;
  	pci_write_config_word(pdev, PCI_COMMAND, cmd);
  }
30522a951   Anatolij Gustschin   fpga: altera-cvp:...
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
  static int __init altera_cvp_init(void)
  {
  	int ret;
  
  	ret = pci_register_driver(&altera_cvp_driver);
  	if (ret)
  		return ret;
  
  	ret = driver_create_file(&altera_cvp_driver.driver,
  				 &driver_attr_chkcfg);
  	if (ret)
  		pr_warn("Can't create sysfs chkcfg file
  ");
  
  	return 0;
  }
  
  static void __exit altera_cvp_exit(void)
  {
  	driver_remove_file(&altera_cvp_driver.driver, &driver_attr_chkcfg);
  	pci_unregister_driver(&altera_cvp_driver);
  }
  
  module_init(altera_cvp_init);
  module_exit(altera_cvp_exit);
34d1dc17c   Anatolij Gustschin   fpga manager: Add...
707
708
709
710
  
  MODULE_LICENSE("GPL v2");
  MODULE_AUTHOR("Anatolij Gustschin <agust@denx.de>");
  MODULE_DESCRIPTION("Module to load Altera FPGA over CvP");