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