xref: /openbmc/qemu/target/ppc/cpu-qom.h (revision 2c9dce01)
1 /*
2  * QEMU PowerPC CPU
3  *
4  * Copyright (c) 2012 SUSE LINUX Products GmbH
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, see
18  * <http://www.gnu.org/licenses/lgpl-2.1.html>
19  */
20 #ifndef QEMU_PPC_CPU_QOM_H
21 #define QEMU_PPC_CPU_QOM_H
22 
23 #include "hw/core/cpu.h"
24 #include "qom/object.h"
25 
26 #ifdef TARGET_PPC64
27 #define TYPE_POWERPC_CPU "powerpc64-cpu"
28 #else
29 #define TYPE_POWERPC_CPU "powerpc-cpu"
30 #endif
31 
32 OBJECT_DECLARE_TYPE(PowerPCCPU, PowerPCCPUClass,
33                     POWERPC_CPU)
34 
35 typedef struct CPUPPCState CPUPPCState;
36 typedef struct ppc_tb_t ppc_tb_t;
37 typedef struct ppc_dcr_t ppc_dcr_t;
38 
39 /*****************************************************************************/
40 /* MMU model                                                                 */
41 typedef enum powerpc_mmu_t powerpc_mmu_t;
42 enum powerpc_mmu_t {
43     POWERPC_MMU_UNKNOWN    = 0x00000000,
44     /* Standard 32 bits PowerPC MMU                            */
45     POWERPC_MMU_32B        = 0x00000001,
46     /* PowerPC 6xx MMU with software TLB                       */
47     POWERPC_MMU_SOFT_6xx   = 0x00000002,
48     /* PowerPC 74xx MMU with software TLB                      */
49     POWERPC_MMU_SOFT_74xx  = 0x00000003,
50     /* PowerPC 4xx MMU with software TLB                       */
51     POWERPC_MMU_SOFT_4xx   = 0x00000004,
52     /* PowerPC 4xx MMU with software TLB and zones protections */
53     POWERPC_MMU_SOFT_4xx_Z = 0x00000005,
54     /* PowerPC MMU in real mode only                           */
55     POWERPC_MMU_REAL       = 0x00000006,
56     /* Freescale MPC8xx MMU model                              */
57     POWERPC_MMU_MPC8xx     = 0x00000007,
58     /* BookE MMU model                                         */
59     POWERPC_MMU_BOOKE      = 0x00000008,
60     /* BookE 2.06 MMU model                                    */
61     POWERPC_MMU_BOOKE206   = 0x00000009,
62     /* PowerPC 601 MMU model (specific BATs format)            */
63     POWERPC_MMU_601        = 0x0000000A,
64 #define POWERPC_MMU_64       0x00010000
65     /* 64 bits PowerPC MMU                                     */
66     POWERPC_MMU_64B        = POWERPC_MMU_64 | 0x00000001,
67     /* Architecture 2.03 and later (has LPCR) */
68     POWERPC_MMU_2_03       = POWERPC_MMU_64 | 0x00000002,
69     /* Architecture 2.06 variant                               */
70     POWERPC_MMU_2_06       = POWERPC_MMU_64 | 0x00000003,
71     /* Architecture 2.07 variant                               */
72     POWERPC_MMU_2_07       = POWERPC_MMU_64 | 0x00000004,
73     /* Architecture 3.00 variant                               */
74     POWERPC_MMU_3_00       = POWERPC_MMU_64 | 0x00000005,
75 };
76 
77 static inline bool mmu_is_64bit(powerpc_mmu_t mmu_model)
78 {
79     return mmu_model & POWERPC_MMU_64;
80 }
81 
82 /*****************************************************************************/
83 /* Exception model                                                           */
84 typedef enum powerpc_excp_t powerpc_excp_t;
85 enum powerpc_excp_t {
86     POWERPC_EXCP_UNKNOWN   = 0,
87     /* Standard PowerPC exception model */
88     POWERPC_EXCP_STD,
89     /* PowerPC 40x exception model      */
90     POWERPC_EXCP_40x,
91     /* PowerPC 601 exception model      */
92     POWERPC_EXCP_601,
93     /* PowerPC 602 exception model      */
94     POWERPC_EXCP_602,
95     /* PowerPC 603 exception model      */
96     POWERPC_EXCP_603,
97     /* PowerPC 603e exception model     */
98     POWERPC_EXCP_603E,
99     /* PowerPC G2 exception model       */
100     POWERPC_EXCP_G2,
101     /* PowerPC 604 exception model      */
102     POWERPC_EXCP_604,
103     /* PowerPC 7x0 exception model      */
104     POWERPC_EXCP_7x0,
105     /* PowerPC 7x5 exception model      */
106     POWERPC_EXCP_7x5,
107     /* PowerPC 74xx exception model     */
108     POWERPC_EXCP_74xx,
109     /* BookE exception model            */
110     POWERPC_EXCP_BOOKE,
111     /* PowerPC 970 exception model      */
112     POWERPC_EXCP_970,
113     /* POWER7 exception model           */
114     POWERPC_EXCP_POWER7,
115     /* POWER8 exception model           */
116     POWERPC_EXCP_POWER8,
117     /* POWER9 exception model           */
118     POWERPC_EXCP_POWER9,
119 };
120 
121 /*****************************************************************************/
122 /* PM instructions */
123 typedef enum {
124     PPC_PM_DOZE,
125     PPC_PM_NAP,
126     PPC_PM_SLEEP,
127     PPC_PM_RVWINKLE,
128     PPC_PM_STOP,
129 } powerpc_pm_insn_t;
130 
131 /*****************************************************************************/
132 /* Input pins model                                                          */
133 typedef enum powerpc_input_t powerpc_input_t;
134 enum powerpc_input_t {
135     PPC_FLAGS_INPUT_UNKNOWN = 0,
136     /* PowerPC 6xx bus                  */
137     PPC_FLAGS_INPUT_6xx,
138     /* BookE bus                        */
139     PPC_FLAGS_INPUT_BookE,
140     /* PowerPC 405 bus                  */
141     PPC_FLAGS_INPUT_405,
142     /* PowerPC 970 bus                  */
143     PPC_FLAGS_INPUT_970,
144     /* PowerPC POWER7 bus               */
145     PPC_FLAGS_INPUT_POWER7,
146     /* PowerPC POWER9 bus               */
147     PPC_FLAGS_INPUT_POWER9,
148     /* PowerPC 401 bus                  */
149     PPC_FLAGS_INPUT_401,
150     /* Freescale RCPU bus               */
151     PPC_FLAGS_INPUT_RCPU,
152 };
153 
154 typedef struct PPCHash64Options PPCHash64Options;
155 
156 /**
157  * PowerPCCPUClass:
158  * @parent_realize: The parent class' realize handler.
159  * @parent_reset: The parent class' reset handler.
160  *
161  * A PowerPC CPU model.
162  */
163 struct PowerPCCPUClass {
164     /*< private >*/
165     CPUClass parent_class;
166     /*< public >*/
167 
168     DeviceRealize parent_realize;
169     DeviceUnrealize parent_unrealize;
170     DeviceReset parent_reset;
171     void (*parent_parse_features)(const char *type, char *str, Error **errp);
172 
173     uint32_t pvr;
174     bool (*pvr_match)(struct PowerPCCPUClass *pcc, uint32_t pvr);
175     uint64_t pcr_mask;          /* Available bits in PCR register */
176     uint64_t pcr_supported;     /* Bits for supported PowerISA versions */
177     uint32_t svr;
178     uint64_t insns_flags;
179     uint64_t insns_flags2;
180     uint64_t msr_mask;
181     uint64_t lpcr_mask;         /* Available bits in the LPCR */
182     uint64_t lpcr_pm;           /* Power-saving mode Exit Cause Enable bits */
183     powerpc_mmu_t   mmu_model;
184     powerpc_excp_t  excp_model;
185     powerpc_input_t bus_model;
186     uint32_t flags;
187     int bfd_mach;
188     uint32_t l1_dcache_size, l1_icache_size;
189 #ifndef CONFIG_USER_ONLY
190     unsigned int gdb_num_sprs;
191     const char *gdb_spr_xml;
192 #endif
193     const PPCHash64Options *hash64_opts;
194     struct ppc_radix_page_info *radix_page_info;
195     uint32_t lrg_decr_bits;
196     int n_host_threads;
197     void (*init_proc)(CPUPPCState *env);
198     int  (*check_pow)(CPUPPCState *env);
199     int (*handle_mmu_fault)(PowerPCCPU *cpu, vaddr eaddr, int rwx, int mmu_idx);
200     bool (*interrupts_big_endian)(PowerPCCPU *cpu);
201 };
202 
203 #ifndef CONFIG_USER_ONLY
204 typedef struct PPCTimebase {
205     uint64_t guest_timebase;
206     int64_t time_of_the_day_ns;
207     bool runstate_paused;
208 } PPCTimebase;
209 
210 extern const VMStateDescription vmstate_ppc_timebase;
211 
212 #define VMSTATE_PPC_TIMEBASE_V(_field, _state, _version) {            \
213     .name       = (stringify(_field)),                                \
214     .version_id = (_version),                                         \
215     .size       = sizeof(PPCTimebase),                                \
216     .vmsd       = &vmstate_ppc_timebase,                              \
217     .flags      = VMS_STRUCT,                                         \
218     .offset     = vmstate_offset_value(_state, _field, PPCTimebase),  \
219 }
220 
221 void cpu_ppc_clock_vm_state_change(void *opaque, int running,
222                                    RunState state);
223 #endif
224 
225 #endif
226