arm: mach-k3: Enable dcache in SPL
[oweals/u-boot.git] / drivers / virtio / virtio_pci_legacy.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
4  *
5  * VirtIO PCI bus transport driver
6  * Ported from Linux drivers/virtio/virtio_pci*.c
7  */
8
9 #include <common.h>
10 #include <dm.h>
11 #include <virtio_types.h>
12 #include <virtio.h>
13 #include <virtio_ring.h>
14 #include <dm/device.h>
15 #include <linux/compat.h>
16 #include <linux/err.h>
17 #include <linux/io.h>
18 #include "virtio_pci.h"
19
20 #define VIRTIO_PCI_DRV_NAME     "virtio-pci.l"
21
22 /* PCI device ID in the range 0x1000 to 0x103f */
23 #define VIRTIO_PCI_VENDOR_ID    0x1af4
24 #define VIRTIO_PCI_DEVICE_ID00  0x1000
25 #define VIRTIO_PCI_DEVICE_ID01  0x1001
26 #define VIRTIO_PCI_DEVICE_ID02  0x1002
27 #define VIRTIO_PCI_DEVICE_ID03  0x1003
28 #define VIRTIO_PCI_DEVICE_ID04  0x1004
29 #define VIRTIO_PCI_DEVICE_ID05  0x1005
30 #define VIRTIO_PCI_DEVICE_ID06  0x1006
31 #define VIRTIO_PCI_DEVICE_ID07  0x1007
32 #define VIRTIO_PCI_DEVICE_ID08  0x1008
33 #define VIRTIO_PCI_DEVICE_ID09  0x1009
34 #define VIRTIO_PCI_DEVICE_ID0A  0x100a
35 #define VIRTIO_PCI_DEVICE_ID0B  0x100b
36 #define VIRTIO_PCI_DEVICE_ID0C  0x100c
37 #define VIRTIO_PCI_DEVICE_ID0D  0x100d
38 #define VIRTIO_PCI_DEVICE_ID0E  0x100e
39 #define VIRTIO_PCI_DEVICE_ID0F  0x100f
40 #define VIRTIO_PCI_DEVICE_ID10  0x1010
41 #define VIRTIO_PCI_DEVICE_ID11  0x1011
42 #define VIRTIO_PCI_DEVICE_ID12  0x1012
43 #define VIRTIO_PCI_DEVICE_ID13  0x1013
44 #define VIRTIO_PCI_DEVICE_ID14  0x1014
45 #define VIRTIO_PCI_DEVICE_ID15  0x1015
46 #define VIRTIO_PCI_DEVICE_ID16  0x1016
47 #define VIRTIO_PCI_DEVICE_ID17  0x1017
48 #define VIRTIO_PCI_DEVICE_ID18  0x1018
49 #define VIRTIO_PCI_DEVICE_ID19  0x1019
50 #define VIRTIO_PCI_DEVICE_ID1A  0x101a
51 #define VIRTIO_PCI_DEVICE_ID1B  0x101b
52 #define VIRTIO_PCI_DEVICE_ID1C  0x101c
53 #define VIRTIO_PCI_DEVICE_ID1D  0x101d
54 #define VIRTIO_PCI_DEVICE_ID1E  0x101e
55 #define VIRTIO_PCI_DEVICE_ID1F  0x101f
56 #define VIRTIO_PCI_DEVICE_ID20  0x1020
57 #define VIRTIO_PCI_DEVICE_ID21  0x1021
58 #define VIRTIO_PCI_DEVICE_ID22  0x1022
59 #define VIRTIO_PCI_DEVICE_ID23  0x1023
60 #define VIRTIO_PCI_DEVICE_ID24  0x1024
61 #define VIRTIO_PCI_DEVICE_ID25  0x1025
62 #define VIRTIO_PCI_DEVICE_ID26  0x1026
63 #define VIRTIO_PCI_DEVICE_ID27  0x1027
64 #define VIRTIO_PCI_DEVICE_ID28  0x1028
65 #define VIRTIO_PCI_DEVICE_ID29  0x1029
66 #define VIRTIO_PCI_DEVICE_ID2A  0x102a
67 #define VIRTIO_PCI_DEVICE_ID2B  0x102b
68 #define VIRTIO_PCI_DEVICE_ID2C  0x102c
69 #define VIRTIO_PCI_DEVICE_ID2D  0x102d
70 #define VIRTIO_PCI_DEVICE_ID2E  0x102e
71 #define VIRTIO_PCI_DEVICE_ID2F  0x102f
72 #define VIRTIO_PCI_DEVICE_ID30  0x1030
73 #define VIRTIO_PCI_DEVICE_ID31  0x1031
74 #define VIRTIO_PCI_DEVICE_ID32  0x1032
75 #define VIRTIO_PCI_DEVICE_ID33  0x1033
76 #define VIRTIO_PCI_DEVICE_ID34  0x1034
77 #define VIRTIO_PCI_DEVICE_ID35  0x1035
78 #define VIRTIO_PCI_DEVICE_ID36  0x1036
79 #define VIRTIO_PCI_DEVICE_ID37  0x1037
80 #define VIRTIO_PCI_DEVICE_ID38  0x1038
81 #define VIRTIO_PCI_DEVICE_ID39  0x1039
82 #define VIRTIO_PCI_DEVICE_ID3A  0x103a
83 #define VIRTIO_PCI_DEVICE_ID3B  0x103b
84 #define VIRTIO_PCI_DEVICE_ID3C  0x103c
85 #define VIRTIO_PCI_DEVICE_ID3D  0x103d
86 #define VIRTIO_PCI_DEVICE_ID3E  0x103e
87 #define VIRTIO_PCI_DEVICE_ID3F  0x103f
88
89 /**
90  * virtio pci transport driver private data
91  *
92  * @ioaddr:     pci transport device register base
93  * @version:    pci transport device version
94  */
95 struct virtio_pci_priv {
96         void __iomem *ioaddr;
97 };
98
99 static int virtio_pci_get_config(struct udevice *udev, unsigned int offset,
100                                  void *buf, unsigned int len)
101 {
102         struct virtio_pci_priv *priv = dev_get_priv(udev);
103         void __iomem *ioaddr = priv->ioaddr + VIRTIO_PCI_CONFIG_OFF(false);
104         u8 *ptr = buf;
105         int i;
106
107         for (i = 0; i < len; i++)
108                 ptr[i] = ioread8(ioaddr + i);
109
110         return 0;
111 }
112
113 static int virtio_pci_set_config(struct udevice *udev, unsigned int offset,
114                                  const void *buf, unsigned int len)
115 {
116         struct virtio_pci_priv *priv = dev_get_priv(udev);
117         void __iomem *ioaddr = priv->ioaddr + VIRTIO_PCI_CONFIG_OFF(false);
118         const u8 *ptr = buf;
119         int i;
120
121         for (i = 0; i < len; i++)
122                 iowrite8(ptr[i], ioaddr + i);
123
124         return 0;
125 }
126
127 static int virtio_pci_get_status(struct udevice *udev, u8 *status)
128 {
129         struct virtio_pci_priv *priv = dev_get_priv(udev);
130
131         *status = ioread8(priv->ioaddr + VIRTIO_PCI_STATUS);
132
133         return 0;
134 }
135
136 static int virtio_pci_set_status(struct udevice *udev, u8 status)
137 {
138         struct virtio_pci_priv *priv = dev_get_priv(udev);
139
140         /* We should never be setting status to 0 */
141         WARN_ON(status == 0);
142
143         iowrite8(status, priv->ioaddr + VIRTIO_PCI_STATUS);
144
145         return 0;
146 }
147
148 static int virtio_pci_reset(struct udevice *udev)
149 {
150         struct virtio_pci_priv *priv = dev_get_priv(udev);
151
152         /* 0 status means a reset */
153         iowrite8(0, priv->ioaddr + VIRTIO_PCI_STATUS);
154
155         /*
156          * Flush out the status write, and flush in device writes,
157          * including MSI-X interrupts, if any.
158          */
159         ioread8(priv->ioaddr + VIRTIO_PCI_STATUS);
160
161         return 0;
162 }
163
164 static int virtio_pci_get_features(struct udevice *udev, u64 *features)
165 {
166         struct virtio_pci_priv *priv = dev_get_priv(udev);
167
168         /*
169          * When someone needs more than 32 feature bits, we'll need to
170          * steal a bit to indicate that the rest are somewhere else.
171          */
172         *features = ioread32(priv->ioaddr + VIRTIO_PCI_HOST_FEATURES);
173
174         return 0;
175 }
176
177 static int virtio_pci_set_features(struct udevice *udev)
178 {
179         struct virtio_pci_priv *priv = dev_get_priv(udev);
180         struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
181
182         /* Make sure we don't have any features > 32 bits! */
183         WARN_ON((u32)uc_priv->features != uc_priv->features);
184
185         /* We only support 32 feature bits */
186         iowrite32(uc_priv->features, priv->ioaddr + VIRTIO_PCI_GUEST_FEATURES);
187
188         return 0;
189 }
190
191 static struct virtqueue *virtio_pci_setup_vq(struct udevice *udev,
192                                              unsigned int index)
193 {
194         struct virtio_pci_priv *priv = dev_get_priv(udev);
195         struct virtqueue *vq;
196         unsigned int num;
197         int err;
198
199         /* Select the queue we're interested in */
200         iowrite16(index, priv->ioaddr + VIRTIO_PCI_QUEUE_SEL);
201
202         /* Check if queue is either not available or already active */
203         num = ioread16(priv->ioaddr + VIRTIO_PCI_QUEUE_NUM);
204         if (!num || ioread32(priv->ioaddr + VIRTIO_PCI_QUEUE_PFN)) {
205                 err = -ENOENT;
206                 goto error_available;
207         }
208
209         /* Create the vring */
210         vq = vring_create_virtqueue(index, num, VIRTIO_PCI_VRING_ALIGN, udev);
211         if (!vq) {
212                 err = -ENOMEM;
213                 goto error_available;
214         }
215
216         /* Activate the queue */
217         iowrite32(virtqueue_get_desc_addr(vq) >> VIRTIO_PCI_QUEUE_ADDR_SHIFT,
218                   priv->ioaddr + VIRTIO_PCI_QUEUE_PFN);
219
220         return vq;
221
222 error_available:
223         return ERR_PTR(err);
224 }
225
226 static void virtio_pci_del_vq(struct virtqueue *vq)
227 {
228         struct virtio_pci_priv *priv = dev_get_priv(vq->vdev);
229         unsigned int index = vq->index;
230
231         iowrite16(index, priv->ioaddr + VIRTIO_PCI_QUEUE_SEL);
232
233         /* Select and deactivate the queue */
234         iowrite32(0, priv->ioaddr + VIRTIO_PCI_QUEUE_PFN);
235
236         vring_del_virtqueue(vq);
237 }
238
239 static int virtio_pci_del_vqs(struct udevice *udev)
240 {
241         struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
242         struct virtqueue *vq, *n;
243
244         list_for_each_entry_safe(vq, n, &uc_priv->vqs, list)
245                 virtio_pci_del_vq(vq);
246
247         return 0;
248 }
249
250 static int virtio_pci_find_vqs(struct udevice *udev, unsigned int nvqs,
251                                struct virtqueue *vqs[])
252 {
253         int i;
254
255         for (i = 0; i < nvqs; ++i) {
256                 vqs[i] = virtio_pci_setup_vq(udev, i);
257                 if (IS_ERR(vqs[i])) {
258                         virtio_pci_del_vqs(udev);
259                         return PTR_ERR(vqs[i]);
260                 }
261         }
262
263         return 0;
264 }
265
266 static int virtio_pci_notify(struct udevice *udev, struct virtqueue *vq)
267 {
268         struct virtio_pci_priv *priv = dev_get_priv(udev);
269
270         /*
271          * We write the queue's selector into the notification register
272          * to signal the other end
273          */
274         iowrite16(vq->index, priv->ioaddr + VIRTIO_PCI_QUEUE_NOTIFY);
275
276         return 0;
277 }
278
279 static int virtio_pci_bind(struct udevice *udev)
280 {
281         static unsigned int num_devs;
282         char name[20];
283
284         /* Create a unique device name for PCI type devices */
285         sprintf(name, "%s#%u", VIRTIO_PCI_DRV_NAME, num_devs++);
286         device_set_name(udev, name);
287
288         return 0;
289 }
290
291 static int virtio_pci_probe(struct udevice *udev)
292 {
293         struct pci_child_platdata *pplat = dev_get_parent_platdata(udev);
294         struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
295         struct virtio_pci_priv *priv = dev_get_priv(udev);
296         u16 subvendor, subdevice;
297         u8 revision;
298
299         /* We only own devices >= 0x1000 and <= 0x103f: leave the rest. */
300         if (pplat->device < 0x1000 || pplat->device > 0x103f)
301                 return -ENODEV;
302
303         /* Transitional devices must have a PCI revision ID of 0 */
304         dm_pci_read_config8(udev, PCI_REVISION_ID, &revision);
305         if (revision != VIRTIO_PCI_ABI_VERSION) {
306                 printf("(%s): virtio_pci expected ABI version %d, got %d\n",
307                        udev->name, VIRTIO_PCI_ABI_VERSION, revision);
308                 return -ENODEV;
309         }
310
311         /*
312          * Transitional devices must have the PCI subsystem device ID matching
313          * the virtio device ID
314          */
315         dm_pci_read_config16(udev, PCI_SUBSYSTEM_ID, &subdevice);
316         dm_pci_read_config16(udev, PCI_SUBSYSTEM_VENDOR_ID, &subvendor);
317         uc_priv->device = subdevice;
318         uc_priv->vendor = subvendor;
319
320         priv->ioaddr = dm_pci_map_bar(udev, PCI_BASE_ADDRESS_0, PCI_REGION_IO);
321         if (!priv->ioaddr)
322                 return -ENXIO;
323         debug("(%s): virtio legacy device reg base %04lx\n",
324               udev->name, (ulong)priv->ioaddr);
325
326         debug("(%s): device (%d) vendor (%08x) version (%d)\n", udev->name,
327               uc_priv->device, uc_priv->vendor, revision);
328
329         return 0;
330 }
331
332 static const struct dm_virtio_ops virtio_pci_ops = {
333         .get_config     = virtio_pci_get_config,
334         .set_config     = virtio_pci_set_config,
335         .get_status     = virtio_pci_get_status,
336         .set_status     = virtio_pci_set_status,
337         .reset          = virtio_pci_reset,
338         .get_features   = virtio_pci_get_features,
339         .set_features   = virtio_pci_set_features,
340         .find_vqs       = virtio_pci_find_vqs,
341         .del_vqs        = virtio_pci_del_vqs,
342         .notify         = virtio_pci_notify,
343 };
344
345 U_BOOT_DRIVER(virtio_pci_legacy) = {
346         .name   = VIRTIO_PCI_DRV_NAME,
347         .id     = UCLASS_VIRTIO,
348         .ops    = &virtio_pci_ops,
349         .bind   = virtio_pci_bind,
350         .probe  = virtio_pci_probe,
351         .priv_auto_alloc_size = sizeof(struct virtio_pci_priv),
352 };
353
354 static struct pci_device_id virtio_pci_supported[] = {
355         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID00) },
356         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID01) },
357         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID02) },
358         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID03) },
359         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID04) },
360         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID05) },
361         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID06) },
362         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID07) },
363         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID08) },
364         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID09) },
365         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0A) },
366         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0B) },
367         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0C) },
368         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0D) },
369         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0E) },
370         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID0F) },
371         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID10) },
372         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID11) },
373         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID12) },
374         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID13) },
375         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID14) },
376         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID15) },
377         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID16) },
378         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID17) },
379         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID18) },
380         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID19) },
381         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1A) },
382         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1B) },
383         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1C) },
384         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1D) },
385         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1E) },
386         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID1F) },
387         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID20) },
388         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID21) },
389         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID22) },
390         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID23) },
391         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID24) },
392         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID25) },
393         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID26) },
394         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID27) },
395         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID28) },
396         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID29) },
397         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2A) },
398         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2B) },
399         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2C) },
400         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2D) },
401         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2E) },
402         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID2F) },
403         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID30) },
404         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID31) },
405         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID32) },
406         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID33) },
407         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID34) },
408         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID35) },
409         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID36) },
410         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID37) },
411         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID38) },
412         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID39) },
413         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3A) },
414         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3B) },
415         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3C) },
416         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3D) },
417         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3E) },
418         { PCI_DEVICE(VIRTIO_PCI_VENDOR_ID, VIRTIO_PCI_DEVICE_ID3F) },
419         {},
420 };
421
422 U_BOOT_PCI_DEVICE(virtio_pci_legacy, virtio_pci_supported);