treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 156
[linux-block.git] / arch / powerpc / include / asm / lppaca.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * lppaca.h
4  * Copyright (C) 2001  Mike Corrigan IBM Corporation
5  */
6 #ifndef _ASM_POWERPC_LPPACA_H
7 #define _ASM_POWERPC_LPPACA_H
8 #ifdef __KERNEL__
9
10 /*
11  * These definitions relate to hypervisors that only exist when using
12  * a server type processor
13  */
14 #ifdef CONFIG_PPC_BOOK3S
15
16 /*
17  * This control block contains the data that is shared between the
18  * hypervisor and the OS.
19  */
20 #include <linux/cache.h>
21 #include <linux/threads.h>
22 #include <asm/types.h>
23 #include <asm/mmu.h>
24 #include <asm/firmware.h>
25
26 /*
27  * The lppaca is the "virtual processor area" registered with the hypervisor,
28  * H_REGISTER_VPA etc.
29  *
30  * According to PAPR, the structure is 640 bytes long, must be L1 cache line
31  * aligned, and must not cross a 4kB boundary. Its size field must be at
32  * least 640 bytes (but may be more).
33  *
34  * Pre-v4.14 KVM hypervisors reject the VPA if its size field is smaller than
35  * 1kB, so we dynamically allocate 1kB and advertise size as 1kB, but keep
36  * this structure as the canonical 640 byte size.
37  */
38 struct lppaca {
39         /* cacheline 1 contains read-only data */
40
41         __be32  desc;                   /* Eye catcher 0xD397D781 */
42         __be16  size;                   /* Size of this struct */
43         u8      reserved1[3];
44         u8      __old_status;           /* Old status, including shared proc */
45         u8      reserved3[14];
46         volatile __be32 dyn_hw_node_id; /* Dynamic hardware node id */
47         volatile __be32 dyn_hw_proc_id; /* Dynamic hardware proc id */
48         u8      reserved4[56];
49         volatile u8 vphn_assoc_counts[8]; /* Virtual processor home node */
50                                           /* associativity change counters */
51         u8      reserved5[32];
52
53         /* cacheline 2 contains local read-write data */
54
55         u8      reserved6[48];
56         u8      cede_latency_hint;
57         u8      ebb_regs_in_use;
58         u8      reserved7[6];
59         u8      dtl_enable_mask;        /* Dispatch Trace Log mask */
60         u8      donate_dedicated_cpu;   /* Donate dedicated CPU cycles */
61         u8      fpregs_in_use;
62         u8      pmcregs_in_use;
63         u8      reserved8[28];
64         __be64  wait_state_cycles;      /* Wait cycles for this proc */
65         u8      reserved9[28];
66         __be16  slb_count;              /* # of SLBs to maintain */
67         u8      idle;                   /* Indicate OS is idle */
68         u8      vmxregs_in_use;
69
70         /* cacheline 3 is shared with other processors */
71
72         /*
73          * This is the yield_count.  An "odd" value (low bit on) means that
74          * the processor is yielded (either because of an OS yield or a
75          * hypervisor preempt).  An even value implies that the processor is
76          * currently executing.
77          * NOTE: Even dedicated processor partitions can yield so this
78          * field cannot be used to determine if we are shared or dedicated.
79          */
80         volatile __be32 yield_count;
81         volatile __be32 dispersion_count; /* dispatch changed physical cpu */
82         volatile __be64 cmo_faults;     /* CMO page fault count */
83         volatile __be64 cmo_fault_time; /* CMO page fault time */
84         u8      reserved10[104];
85
86         /* cacheline 4-5 */
87
88         __be32  page_ins;               /* CMO Hint - # page ins by OS */
89         u8      reserved11[148];
90         volatile __be64 dtl_idx;        /* Dispatch Trace Log head index */
91         u8      reserved12[96];
92 } ____cacheline_aligned;
93
94 #define lppaca_of(cpu)  (*paca_ptrs[cpu]->lppaca_ptr)
95
96 /*
97  * We are using a non architected field to determine if a partition is
98  * shared or dedicated. This currently works on both KVM and PHYP, but
99  * we will have to transition to something better.
100  */
101 #define LPPACA_OLD_SHARED_PROC          2
102
103 static inline bool lppaca_shared_proc(struct lppaca *l)
104 {
105         if (!firmware_has_feature(FW_FEATURE_SPLPAR))
106                 return false;
107         return !!(l->__old_status & LPPACA_OLD_SHARED_PROC);
108 }
109
110 /*
111  * SLB shadow buffer structure as defined in the PAPR.  The save_area
112  * contains adjacent ESID and VSID pairs for each shadowed SLB.  The
113  * ESID is stored in the lower 64bits, then the VSID.
114  */
115 struct slb_shadow {
116         __be32  persistent;             /* Number of persistent SLBs */
117         __be32  buffer_length;          /* Total shadow buffer length */
118         __be64  reserved;
119         struct  {
120                 __be64     esid;
121                 __be64  vsid;
122         } save_area[SLB_NUM_BOLTED];
123 } ____cacheline_aligned;
124
125 /*
126  * Layout of entries in the hypervisor's dispatch trace log buffer.
127  */
128 struct dtl_entry {
129         u8      dispatch_reason;
130         u8      preempt_reason;
131         __be16  processor_id;
132         __be32  enqueue_to_dispatch_time;
133         __be32  ready_to_enqueue_time;
134         __be32  waiting_to_ready_time;
135         __be64  timebase;
136         __be64  fault_addr;
137         __be64  srr0;
138         __be64  srr1;
139 };
140
141 #define DISPATCH_LOG_BYTES      4096    /* bytes per cpu */
142 #define N_DISPATCH_LOG          (DISPATCH_LOG_BYTES / sizeof(struct dtl_entry))
143
144 extern struct kmem_cache *dtl_cache;
145
146 /*
147  * When CONFIG_VIRT_CPU_ACCOUNTING_NATIVE = y, the cpu accounting code controls
148  * reading from the dispatch trace log.  If other code wants to consume
149  * DTL entries, it can set this pointer to a function that will get
150  * called once for each DTL entry that gets processed.
151  */
152 extern void (*dtl_consumer)(struct dtl_entry *entry, u64 index);
153
154 #endif /* CONFIG_PPC_BOOK3S */
155 #endif /* __KERNEL__ */
156 #endif /* _ASM_POWERPC_LPPACA_H */