xref: /openbmc/qemu/target/s390x/cpu_features.h (revision 2e1cacfb)
1 /*
2  * CPU features/facilities helper structs and utility functions for s390
3  *
4  * Copyright 2016 IBM Corp.
5  *
6  * Author(s): Michael Mueller <mimu@linux.vnet.ibm.com>
7  *            David Hildenbrand <dahi@linux.vnet.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or (at
10  * your option) any later version. See the COPYING file in the top-level
11  * directory.
12  */
13 
14 #ifndef TARGET_S390X_CPU_FEATURES_H
15 #define TARGET_S390X_CPU_FEATURES_H
16 
17 #include "qemu/bitmap.h"
18 #include "cpu_features_def.h"
19 #include "target/s390x/gen-features.h"
20 
21 /* CPU features are announced via different ways */
22 typedef enum {
23     S390_FEAT_TYPE_STFL,
24     S390_FEAT_TYPE_SCLP_CONF_CHAR,
25     S390_FEAT_TYPE_SCLP_CONF_CHAR_EXT,
26     S390_FEAT_TYPE_SCLP_FAC134,
27     S390_FEAT_TYPE_SCLP_CPU,
28     S390_FEAT_TYPE_MISC,
29     S390_FEAT_TYPE_PLO,
30     S390_FEAT_TYPE_PTFF,
31     S390_FEAT_TYPE_KMAC,
32     S390_FEAT_TYPE_KMC,
33     S390_FEAT_TYPE_KM,
34     S390_FEAT_TYPE_KIMD,
35     S390_FEAT_TYPE_KLMD,
36     S390_FEAT_TYPE_PCKMO,
37     S390_FEAT_TYPE_KMCTR,
38     S390_FEAT_TYPE_KMF,
39     S390_FEAT_TYPE_KMO,
40     S390_FEAT_TYPE_PCC,
41     S390_FEAT_TYPE_PPNO,
42     S390_FEAT_TYPE_KMA,
43     S390_FEAT_TYPE_KDSA,
44     S390_FEAT_TYPE_SORTL,
45     S390_FEAT_TYPE_DFLTCC,
46     S390_FEAT_TYPE_UV_FEAT_GUEST,
47 } S390FeatType;
48 
49 /* Definition of a CPU feature */
50 typedef struct {
51     const char *name;       /* name exposed to the user */
52     const char *desc;       /* description exposed to the user */
53     S390FeatType type;      /* feature type (way of indication)*/
54     int bit;                /* bit within the feature type area (fixed) */
55 } S390FeatDef;
56 
57 /* use ordinary bitmap operations to work with features */
58 typedef unsigned long S390FeatBitmap[BITS_TO_LONGS(S390_FEAT_MAX)];
59 
60 /* 64bit based bitmap used to init S390FeatBitmap from generated data */
61 typedef uint64_t S390FeatInit[S390_FEAT_MAX / 64 + 1];
62 
63 const S390FeatDef *s390_feat_def(S390Feat feat);
64 S390Feat s390_feat_by_type_and_bit(S390FeatType type, int bit);
65 void s390_init_feat_bitmap(const S390FeatInit init, S390FeatBitmap bitmap);
66 void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
67                           uint8_t *data);
68 void s390_add_from_feat_block(S390FeatBitmap features, S390FeatType type,
69                           uint8_t *data);
70 void s390_feat_bitmap_to_ascii(const S390FeatBitmap features, void *opaque,
71                                void (*fn)(const char *name, void *opaque));
72 void s390_get_deprecated_features(S390FeatBitmap features);
73 
74 /* Definition of a CPU feature group */
75 typedef struct {
76     const char *name;       /* name exposed to the user */
77     const char *desc;       /* description exposed to the user */
78     S390FeatBitmap feat;    /* features contained in the group */
79     S390FeatInit init;      /* used to init feat from generated data */
80 } S390FeatGroupDef;
81 
82 const S390FeatGroupDef *s390_feat_group_def(S390FeatGroup group);
83 
84 #define BE_BIT_NR(BIT) (BIT ^ (BITS_PER_LONG - 1))
85 
86 static inline void clear_be_bit(unsigned int bit_nr, uint8_t *array)
87 {
88     array[bit_nr / 8] &= ~(0x80 >> (bit_nr % 8));
89 }
90 static inline void set_be_bit(unsigned int bit_nr, uint8_t *array)
91 {
92     array[bit_nr / 8] |= 0x80 >> (bit_nr % 8);
93 }
94 static inline bool test_be_bit(unsigned int bit_nr, const uint8_t *array)
95 {
96     return array[bit_nr / 8] & (0x80 >> (bit_nr % 8));
97 }
98 #endif /* TARGET_S390X_CPU_FEATURES_H */
99