1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#ifndef __VIRTIO_H__
21#define __VIRTIO_H__
22
23#include <linux/bitops.h>
24#include <linux/bug.h>
25#define VIRTIO_ID_NET 1
26#define VIRTIO_ID_BLOCK 2
27#define VIRTIO_ID_RNG 4
28#define VIRTIO_ID_MAX_NUM 5
29
30#define VIRTIO_NET_DRV_NAME "virtio-net"
31#define VIRTIO_BLK_DRV_NAME "virtio-blk"
32#define VIRTIO_RNG_DRV_NAME "virtio-rng"
33
34
35
36
37#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
38
39#define VIRTIO_CONFIG_S_DRIVER 2
40
41#define VIRTIO_CONFIG_S_DRIVER_OK 4
42
43#define VIRTIO_CONFIG_S_FEATURES_OK 8
44
45#define VIRTIO_CONFIG_S_NEEDS_RESET 0x40
46
47#define VIRTIO_CONFIG_S_FAILED 0x80
48
49
50
51
52
53
54#define VIRTIO_TRANSPORT_F_START 28
55#define VIRTIO_TRANSPORT_F_END 38
56
57#ifndef VIRTIO_CONFIG_NO_LEGACY
58
59
60
61
62#define VIRTIO_F_NOTIFY_ON_EMPTY 24
63
64
65#define VIRTIO_F_ANY_LAYOUT 27
66#endif
67
68
69#define VIRTIO_F_VERSION_1 32
70
71
72
73
74
75
76
77
78#define VIRTIO_F_IOMMU_PLATFORM 33
79
80
81#define VIRTIO_F_SR_IOV 37
82
83
84
85
86
87
88
89struct virtio_sg {
90 void *addr;
91 size_t length;
92};
93
94struct virtqueue;
95
96
97struct dm_virtio_ops {
98
99
100
101
102
103
104
105
106
107 int (*get_config)(struct udevice *vdev, unsigned int offset,
108 void *buf, unsigned int len);
109
110
111
112
113
114
115
116
117
118 int (*set_config)(struct udevice *vdev, unsigned int offset,
119 const void *buf, unsigned int len);
120
121
122
123
124
125
126
127 int (*generation)(struct udevice *vdev, u32 *counter);
128
129
130
131
132
133
134
135 int (*get_status)(struct udevice *vdev, u8 *status);
136
137
138
139
140
141
142
143 int (*set_status)(struct udevice *vdev, u8 status);
144
145
146
147
148
149
150 int (*reset)(struct udevice *vdev);
151
152
153
154
155
156
157
158 int (*get_features)(struct udevice *vdev, u64 *features);
159
160
161
162
163
164
165 int (*set_features)(struct udevice *vdev);
166
167
168
169
170
171
172
173
174 int (*find_vqs)(struct udevice *vdev, unsigned int nvqs,
175 struct virtqueue *vqs[]);
176
177
178
179
180
181
182 int (*del_vqs)(struct udevice *vdev);
183
184
185
186
187
188
189
190 int (*notify)(struct udevice *vdev, struct virtqueue *vq);
191};
192
193
194#define virtio_get_ops(dev) ((struct dm_virtio_ops *)(dev)->driver->ops)
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210struct virtio_dev_priv {
211 struct list_head vqs;
212 struct udevice *vdev;
213 bool legacy;
214 u32 device;
215 u32 vendor;
216 u64 features;
217 const u32 *feature_table;
218 u32 feature_table_size;
219 const u32 *feature_table_legacy;
220 u32 feature_table_size_legacy;
221};
222
223
224
225
226
227
228
229
230
231
232int virtio_get_config(struct udevice *vdev, unsigned int offset,
233 void *buf, unsigned int len);
234
235
236
237
238
239
240
241
242
243
244int virtio_set_config(struct udevice *vdev, unsigned int offset,
245 void *buf, unsigned int len);
246
247
248
249
250
251
252
253
254int virtio_generation(struct udevice *vdev, u32 *counter);
255
256
257
258
259
260
261
262
263int virtio_get_status(struct udevice *vdev, u8 *status);
264
265
266
267
268
269
270
271
272int virtio_set_status(struct udevice *vdev, u8 status);
273
274
275
276
277
278
279
280int virtio_reset(struct udevice *vdev);
281
282
283
284
285
286
287
288
289int virtio_get_features(struct udevice *vdev, u64 *features);
290
291
292
293
294
295
296
297int virtio_set_features(struct udevice *vdev);
298
299
300
301
302
303
304
305
306
307int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs,
308 struct virtqueue *vqs[]);
309
310
311
312
313
314
315
316int virtio_del_vqs(struct udevice *vdev);
317
318
319
320
321
322
323
324
325int virtio_notify(struct udevice *vdev, struct virtqueue *vq);
326
327
328
329
330
331
332
333void virtio_add_status(struct udevice *vdev, u8 status);
334
335
336
337
338
339
340
341int virtio_finalize_features(struct udevice *vdev);
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359void virtio_driver_features_init(struct virtio_dev_priv *priv,
360 const u32 *feature,
361 u32 feature_size,
362 const u32 *feature_legacy,
363 u32 feature_legacy_size);
364
365
366
367
368
369
370int virtio_init(void);
371
372static inline u16 __virtio16_to_cpu(bool little_endian, __virtio16 val)
373{
374 if (little_endian)
375 return le16_to_cpu((__force __le16)val);
376 else
377 return be16_to_cpu((__force __be16)val);
378}
379
380static inline __virtio16 __cpu_to_virtio16(bool little_endian, u16 val)
381{
382 if (little_endian)
383 return (__force __virtio16)cpu_to_le16(val);
384 else
385 return (__force __virtio16)cpu_to_be16(val);
386}
387
388static inline u32 __virtio32_to_cpu(bool little_endian, __virtio32 val)
389{
390 if (little_endian)
391 return le32_to_cpu((__force __le32)val);
392 else
393 return be32_to_cpu((__force __be32)val);
394}
395
396static inline __virtio32 __cpu_to_virtio32(bool little_endian, u32 val)
397{
398 if (little_endian)
399 return (__force __virtio32)cpu_to_le32(val);
400 else
401 return (__force __virtio32)cpu_to_be32(val);
402}
403
404static inline u64 __virtio64_to_cpu(bool little_endian, __virtio64 val)
405{
406 if (little_endian)
407 return le64_to_cpu((__force __le64)val);
408 else
409 return be64_to_cpu((__force __be64)val);
410}
411
412static inline __virtio64 __cpu_to_virtio64(bool little_endian, u64 val)
413{
414 if (little_endian)
415 return (__force __virtio64)cpu_to_le64(val);
416 else
417 return (__force __virtio64)cpu_to_be64(val);
418}
419
420
421
422
423
424
425
426
427
428
429static inline bool __virtio_test_bit(struct udevice *udev, unsigned int fbit)
430{
431 struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
432
433
434 if (__builtin_constant_p(fbit))
435 BUILD_BUG_ON(fbit >= 64);
436 else
437 WARN_ON(fbit >= 64);
438
439 return uc_priv->features & BIT_ULL(fbit);
440}
441
442
443
444
445
446
447
448
449
450static inline void __virtio_set_bit(struct udevice *udev, unsigned int fbit)
451{
452 struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
453
454
455 if (__builtin_constant_p(fbit))
456 BUILD_BUG_ON(fbit >= 64);
457 else
458 WARN_ON(fbit >= 64);
459
460 uc_priv->features |= BIT_ULL(fbit);
461}
462
463
464
465
466
467
468
469
470
471static inline void __virtio_clear_bit(struct udevice *udev, unsigned int fbit)
472{
473 struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(udev);
474
475
476 if (__builtin_constant_p(fbit))
477 BUILD_BUG_ON(fbit >= 64);
478 else
479 WARN_ON(fbit >= 64);
480
481 uc_priv->features &= ~BIT_ULL(fbit);
482}
483
484
485
486
487
488
489
490
491
492
493static inline bool virtio_has_feature(struct udevice *vdev, unsigned int fbit)
494{
495 if (!(dev_get_flags(vdev) & DM_FLAG_BOUND))
496 WARN_ON(true);
497
498 return __virtio_test_bit(vdev->parent, fbit);
499}
500
501static inline bool virtio_legacy_is_little_endian(void)
502{
503#ifdef __LITTLE_ENDIAN
504 return true;
505#else
506 return false;
507#endif
508}
509
510static inline bool virtio_is_little_endian(struct udevice *vdev)
511{
512 struct virtio_dev_priv *uc_priv = dev_get_uclass_priv(vdev->parent);
513
514 return !uc_priv->legacy || virtio_legacy_is_little_endian();
515}
516
517
518static inline u16 virtio16_to_cpu(struct udevice *vdev, __virtio16 val)
519{
520 return __virtio16_to_cpu(virtio_is_little_endian(vdev), val);
521}
522
523static inline __virtio16 cpu_to_virtio16(struct udevice *vdev, u16 val)
524{
525 return __cpu_to_virtio16(virtio_is_little_endian(vdev), val);
526}
527
528static inline u32 virtio32_to_cpu(struct udevice *vdev, __virtio32 val)
529{
530 return __virtio32_to_cpu(virtio_is_little_endian(vdev), val);
531}
532
533static inline __virtio32 cpu_to_virtio32(struct udevice *vdev, u32 val)
534{
535 return __cpu_to_virtio32(virtio_is_little_endian(vdev), val);
536}
537
538static inline u64 virtio64_to_cpu(struct udevice *vdev, __virtio64 val)
539{
540 return __virtio64_to_cpu(virtio_is_little_endian(vdev), val);
541}
542
543static inline __virtio64 cpu_to_virtio64(struct udevice *vdev, u64 val)
544{
545 return __cpu_to_virtio64(virtio_is_little_endian(vdev), val);
546}
547
548
549static inline void __virtio_cread_many(struct udevice *vdev,
550 unsigned int offset,
551 void *buf, size_t count, size_t bytes)
552{
553 u32 old, gen;
554 int i;
555
556
557 virtio_generation(vdev, &gen);
558 do {
559 old = gen;
560
561 for (i = 0; i < count; i++)
562 virtio_get_config(vdev, offset + bytes * i,
563 buf + i * bytes, bytes);
564
565 virtio_generation(vdev, &gen);
566 } while (gen != old);
567}
568
569static inline void virtio_cread_bytes(struct udevice *vdev,
570 unsigned int offset,
571 void *buf, size_t len)
572{
573 __virtio_cread_many(vdev, offset, buf, len, 1);
574}
575
576static inline u8 virtio_cread8(struct udevice *vdev, unsigned int offset)
577{
578 u8 ret;
579
580 virtio_get_config(vdev, offset, &ret, sizeof(ret));
581 return ret;
582}
583
584static inline void virtio_cwrite8(struct udevice *vdev,
585 unsigned int offset, u8 val)
586{
587 virtio_set_config(vdev, offset, &val, sizeof(val));
588}
589
590static inline u16 virtio_cread16(struct udevice *vdev,
591 unsigned int offset)
592{
593 u16 ret;
594
595 virtio_get_config(vdev, offset, &ret, sizeof(ret));
596 return virtio16_to_cpu(vdev, (__force __virtio16)ret);
597}
598
599static inline void virtio_cwrite16(struct udevice *vdev,
600 unsigned int offset, u16 val)
601{
602 val = (__force u16)cpu_to_virtio16(vdev, val);
603 virtio_set_config(vdev, offset, &val, sizeof(val));
604}
605
606static inline u32 virtio_cread32(struct udevice *vdev,
607 unsigned int offset)
608{
609 u32 ret;
610
611 virtio_get_config(vdev, offset, &ret, sizeof(ret));
612 return virtio32_to_cpu(vdev, (__force __virtio32)ret);
613}
614
615static inline void virtio_cwrite32(struct udevice *vdev,
616 unsigned int offset, u32 val)
617{
618 val = (__force u32)cpu_to_virtio32(vdev, val);
619 virtio_set_config(vdev, offset, &val, sizeof(val));
620}
621
622static inline u64 virtio_cread64(struct udevice *vdev,
623 unsigned int offset)
624{
625 u64 ret;
626
627 __virtio_cread_many(vdev, offset, &ret, 1, sizeof(ret));
628 return virtio64_to_cpu(vdev, (__force __virtio64)ret);
629}
630
631static inline void virtio_cwrite64(struct udevice *vdev,
632 unsigned int offset, u64 val)
633{
634 val = (__force u64)cpu_to_virtio64(vdev, val);
635 virtio_set_config(vdev, offset, &val, sizeof(val));
636}
637
638
639#define virtio_cread(vdev, structname, member, ptr) \
640 do { \
641 \
642 if (!typecheck(typeof((((structname *)0)->member)), *(ptr))) \
643 (*ptr) = 1; \
644 \
645 switch (sizeof(*ptr)) { \
646 case 1: \
647 *(ptr) = virtio_cread8(vdev, \
648 offsetof(structname, member)); \
649 break; \
650 case 2: \
651 *(ptr) = virtio_cread16(vdev, \
652 offsetof(structname, member)); \
653 break; \
654 case 4: \
655 *(ptr) = virtio_cread32(vdev, \
656 offsetof(structname, member)); \
657 break; \
658 case 8: \
659 *(ptr) = virtio_cread64(vdev, \
660 offsetof(structname, member)); \
661 break; \
662 default: \
663 WARN_ON(true); \
664 } \
665 } while (0)
666
667
668#define virtio_cwrite(vdev, structname, member, ptr) \
669 do { \
670 \
671 if (!typecheck(typeof((((structname *)0)->member)), *(ptr))) \
672 WARN_ON((*ptr) == 1); \
673 \
674 switch (sizeof(*ptr)) { \
675 case 1: \
676 virtio_cwrite8(vdev, \
677 offsetof(structname, member), \
678 *(ptr)); \
679 break; \
680 case 2: \
681 virtio_cwrite16(vdev, \
682 offsetof(structname, member), \
683 *(ptr)); \
684 break; \
685 case 4: \
686 virtio_cwrite32(vdev, \
687 offsetof(structname, member), \
688 *(ptr)); \
689 break; \
690 case 8: \
691 virtio_cwrite64(vdev, \
692 offsetof(structname, member), \
693 *(ptr)); \
694 break; \
695 default: \
696 WARN_ON(true); \
697 } \
698 } while (0)
699
700
701#define virtio_cread_feature(vdev, fbit, structname, member, ptr) \
702 ({ \
703 int _r = 0; \
704 if (!virtio_has_feature(vdev, fbit)) \
705 _r = -ENOENT; \
706 else \
707 virtio_cread(vdev, structname, member, ptr); \
708 _r; \
709 })
710
711#endif
712