Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / include / asm-ia64 / pal.h
blob8a695d3407d2576a8d51a4c99d2c2201202b2a87
1 #ifndef _ASM_IA64_PAL_H
2 #define _ASM_IA64_PAL_H
4 /*
5 * Processor Abstraction Layer definitions.
7 * This is based on Intel IA-64 Architecture Software Developer's Manual rev 1.0
8 * chapter 11 IA-64 Processor Abstraction Layer
10 * Copyright (C) 1998-2001 Hewlett-Packard Co
11 * David Mosberger-Tang <davidm@hpl.hp.com>
12 * Stephane Eranian <eranian@hpl.hp.com>
13 * Copyright (C) 1999 VA Linux Systems
14 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
15 * Copyright (C) 1999 Srinivasa Prasad Thirumalachar <sprasad@sprasad.engr.sgi.com>
17 * 99/10/01 davidm Make sure we pass zero for reserved parameters.
18 * 00/03/07 davidm Updated pal_cache_flush() to be in sync with PAL v2.6.
19 * 00/03/23 cfleck Modified processor min-state save area to match updated PAL & SAL info
20 * 00/05/24 eranian Updated to latest PAL spec, fix structures bugs, added
21 * 00/05/25 eranian Support for stack calls, and static physical calls
22 * 00/06/18 eranian Support for stacked physical calls
23 * 06/10/26 rja Support for Intel Itanium Architecture Software Developer's
24 * Manual Rev 2.2 (Jan 2006)
28 * Note that some of these calls use a static-register only calling
29 * convention which has nothing to do with the regular calling
30 * convention.
32 #define PAL_CACHE_FLUSH 1 /* flush i/d cache */
33 #define PAL_CACHE_INFO 2 /* get detailed i/d cache info */
34 #define PAL_CACHE_INIT 3 /* initialize i/d cache */
35 #define PAL_CACHE_SUMMARY 4 /* get summary of cache hierarchy */
36 #define PAL_MEM_ATTRIB 5 /* list supported memory attributes */
37 #define PAL_PTCE_INFO 6 /* purge TLB info */
38 #define PAL_VM_INFO 7 /* return supported virtual memory features */
39 #define PAL_VM_SUMMARY 8 /* return summary on supported vm features */
40 #define PAL_BUS_GET_FEATURES 9 /* return processor bus interface features settings */
41 #define PAL_BUS_SET_FEATURES 10 /* set processor bus features */
42 #define PAL_DEBUG_INFO 11 /* get number of debug registers */
43 #define PAL_FIXED_ADDR 12 /* get fixed component of processors's directed address */
44 #define PAL_FREQ_BASE 13 /* base frequency of the platform */
45 #define PAL_FREQ_RATIOS 14 /* ratio of processor, bus and ITC frequency */
46 #define PAL_PERF_MON_INFO 15 /* return performance monitor info */
47 #define PAL_PLATFORM_ADDR 16 /* set processor interrupt block and IO port space addr */
48 #define PAL_PROC_GET_FEATURES 17 /* get configurable processor features & settings */
49 #define PAL_PROC_SET_FEATURES 18 /* enable/disable configurable processor features */
50 #define PAL_RSE_INFO 19 /* return rse information */
51 #define PAL_VERSION 20 /* return version of PAL code */
52 #define PAL_MC_CLEAR_LOG 21 /* clear all processor log info */
53 #define PAL_MC_DRAIN 22 /* drain operations which could result in an MCA */
54 #define PAL_MC_EXPECTED 23 /* set/reset expected MCA indicator */
55 #define PAL_MC_DYNAMIC_STATE 24 /* get processor dynamic state */
56 #define PAL_MC_ERROR_INFO 25 /* get processor MCA info and static state */
57 #define PAL_MC_RESUME 26 /* Return to interrupted process */
58 #define PAL_MC_REGISTER_MEM 27 /* Register memory for PAL to use during MCAs and inits */
59 #define PAL_HALT 28 /* enter the low power HALT state */
60 #define PAL_HALT_LIGHT 29 /* enter the low power light halt state*/
61 #define PAL_COPY_INFO 30 /* returns info needed to relocate PAL */
62 #define PAL_CACHE_LINE_INIT 31 /* init tags & data of cache line */
63 #define PAL_PMI_ENTRYPOINT 32 /* register PMI memory entry points with the processor */
64 #define PAL_ENTER_IA_32_ENV 33 /* enter IA-32 system environment */
65 #define PAL_VM_PAGE_SIZE 34 /* return vm TC and page walker page sizes */
67 #define PAL_MEM_FOR_TEST 37 /* get amount of memory needed for late processor test */
68 #define PAL_CACHE_PROT_INFO 38 /* get i/d cache protection info */
69 #define PAL_REGISTER_INFO 39 /* return AR and CR register information*/
70 #define PAL_SHUTDOWN 40 /* enter processor shutdown state */
71 #define PAL_PREFETCH_VISIBILITY 41 /* Make Processor Prefetches Visible */
72 #define PAL_LOGICAL_TO_PHYSICAL 42 /* returns information on logical to physical processor mapping */
73 #define PAL_CACHE_SHARED_INFO 43 /* returns information on caches shared by logical processor */
74 #define PAL_GET_HW_POLICY 48 /* Get current hardware resource sharing policy */
75 #define PAL_SET_HW_POLICY 49 /* Set current hardware resource sharing policy */
77 #define PAL_COPY_PAL 256 /* relocate PAL procedures and PAL PMI */
78 #define PAL_HALT_INFO 257 /* return the low power capabilities of processor */
79 #define PAL_TEST_PROC 258 /* perform late processor self-test */
80 #define PAL_CACHE_READ 259 /* read tag & data of cacheline for diagnostic testing */
81 #define PAL_CACHE_WRITE 260 /* write tag & data of cacheline for diagnostic testing */
82 #define PAL_VM_TR_READ 261 /* read contents of translation register */
83 #define PAL_GET_PSTATE 262 /* get the current P-state */
84 #define PAL_SET_PSTATE 263 /* set the P-state */
85 #define PAL_BRAND_INFO 274 /* Processor branding information */
87 #define PAL_GET_PSTATE_TYPE_LASTSET 0
88 #define PAL_GET_PSTATE_TYPE_AVGANDRESET 1
89 #define PAL_GET_PSTATE_TYPE_AVGNORESET 2
90 #define PAL_GET_PSTATE_TYPE_INSTANT 3
92 #define PAL_MC_ERROR_INJECT 276 /* Injects processor error or returns injection capabilities */
94 #ifndef __ASSEMBLY__
96 #include <linux/types.h>
97 #include <asm/fpu.h>
100 * Data types needed to pass information into PAL procedures and
101 * interpret information returned by them.
104 /* Return status from the PAL procedure */
105 typedef s64 pal_status_t;
107 #define PAL_STATUS_SUCCESS 0 /* No error */
108 #define PAL_STATUS_UNIMPLEMENTED (-1) /* Unimplemented procedure */
109 #define PAL_STATUS_EINVAL (-2) /* Invalid argument */
110 #define PAL_STATUS_ERROR (-3) /* Error */
111 #define PAL_STATUS_CACHE_INIT_FAIL (-4) /* Could not initialize the
112 * specified level and type of
113 * cache without sideeffects
114 * and "restrict" was 1
116 #define PAL_STATUS_REQUIRES_MEMORY (-9) /* Call requires PAL memory buffer */
118 /* Processor cache level in the hierarchy */
119 typedef u64 pal_cache_level_t;
120 #define PAL_CACHE_LEVEL_L0 0 /* L0 */
121 #define PAL_CACHE_LEVEL_L1 1 /* L1 */
122 #define PAL_CACHE_LEVEL_L2 2 /* L2 */
125 /* Processor cache type at a particular level in the hierarchy */
127 typedef u64 pal_cache_type_t;
128 #define PAL_CACHE_TYPE_INSTRUCTION 1 /* Instruction cache */
129 #define PAL_CACHE_TYPE_DATA 2 /* Data or unified cache */
130 #define PAL_CACHE_TYPE_INSTRUCTION_DATA 3 /* Both Data & Instruction */
133 #define PAL_CACHE_FLUSH_INVALIDATE 1 /* Invalidate clean lines */
134 #define PAL_CACHE_FLUSH_CHK_INTRS 2 /* check for interrupts/mc while flushing */
136 /* Processor cache line size in bytes */
137 typedef int pal_cache_line_size_t;
139 /* Processor cache line state */
140 typedef u64 pal_cache_line_state_t;
141 #define PAL_CACHE_LINE_STATE_INVALID 0 /* Invalid */
142 #define PAL_CACHE_LINE_STATE_SHARED 1 /* Shared */
143 #define PAL_CACHE_LINE_STATE_EXCLUSIVE 2 /* Exclusive */
144 #define PAL_CACHE_LINE_STATE_MODIFIED 3 /* Modified */
146 typedef struct pal_freq_ratio {
147 u32 den, num; /* numerator & denominator */
148 } itc_ratio, proc_ratio;
150 typedef union pal_cache_config_info_1_s {
151 struct {
152 u64 u : 1, /* 0 Unified cache ? */
153 at : 2, /* 2-1 Cache mem attr*/
154 reserved : 5, /* 7-3 Reserved */
155 associativity : 8, /* 16-8 Associativity*/
156 line_size : 8, /* 23-17 Line size */
157 stride : 8, /* 31-24 Stride */
158 store_latency : 8, /*39-32 Store latency*/
159 load_latency : 8, /* 47-40 Load latency*/
160 store_hints : 8, /* 55-48 Store hints*/
161 load_hints : 8; /* 63-56 Load hints */
162 } pcci1_bits;
163 u64 pcci1_data;
164 } pal_cache_config_info_1_t;
166 typedef union pal_cache_config_info_2_s {
167 struct {
168 u32 cache_size; /*cache size in bytes*/
171 u32 alias_boundary : 8, /* 39-32 aliased addr
172 * separation for max
173 * performance.
175 tag_ls_bit : 8, /* 47-40 LSb of addr*/
176 tag_ms_bit : 8, /* 55-48 MSb of addr*/
177 reserved : 8; /* 63-56 Reserved */
178 } pcci2_bits;
179 u64 pcci2_data;
180 } pal_cache_config_info_2_t;
183 typedef struct pal_cache_config_info_s {
184 pal_status_t pcci_status;
185 pal_cache_config_info_1_t pcci_info_1;
186 pal_cache_config_info_2_t pcci_info_2;
187 u64 pcci_reserved;
188 } pal_cache_config_info_t;
190 #define pcci_ld_hints pcci_info_1.pcci1_bits.load_hints
191 #define pcci_st_hints pcci_info_1.pcci1_bits.store_hints
192 #define pcci_ld_latency pcci_info_1.pcci1_bits.load_latency
193 #define pcci_st_latency pcci_info_1.pcci1_bits.store_latency
194 #define pcci_stride pcci_info_1.pcci1_bits.stride
195 #define pcci_line_size pcci_info_1.pcci1_bits.line_size
196 #define pcci_assoc pcci_info_1.pcci1_bits.associativity
197 #define pcci_cache_attr pcci_info_1.pcci1_bits.at
198 #define pcci_unified pcci_info_1.pcci1_bits.u
199 #define pcci_tag_msb pcci_info_2.pcci2_bits.tag_ms_bit
200 #define pcci_tag_lsb pcci_info_2.pcci2_bits.tag_ls_bit
201 #define pcci_alias_boundary pcci_info_2.pcci2_bits.alias_boundary
202 #define pcci_cache_size pcci_info_2.pcci2_bits.cache_size
206 /* Possible values for cache attributes */
208 #define PAL_CACHE_ATTR_WT 0 /* Write through cache */
209 #define PAL_CACHE_ATTR_WB 1 /* Write back cache */
210 #define PAL_CACHE_ATTR_WT_OR_WB 2 /* Either write thru or write
211 * back depending on TLB
212 * memory attributes
216 /* Possible values for cache hints */
218 #define PAL_CACHE_HINT_TEMP_1 0 /* Temporal level 1 */
219 #define PAL_CACHE_HINT_NTEMP_1 1 /* Non-temporal level 1 */
220 #define PAL_CACHE_HINT_NTEMP_ALL 3 /* Non-temporal all levels */
222 /* Processor cache protection information */
223 typedef union pal_cache_protection_element_u {
224 u32 pcpi_data;
225 struct {
226 u32 data_bits : 8, /* # data bits covered by
227 * each unit of protection
230 tagprot_lsb : 6, /* Least -do- */
231 tagprot_msb : 6, /* Most Sig. tag address
232 * bit that this
233 * protection covers.
235 prot_bits : 6, /* # of protection bits */
236 method : 4, /* Protection method */
237 t_d : 2; /* Indicates which part
238 * of the cache this
239 * protection encoding
240 * applies.
242 } pcp_info;
243 } pal_cache_protection_element_t;
245 #define pcpi_cache_prot_part pcp_info.t_d
246 #define pcpi_prot_method pcp_info.method
247 #define pcpi_prot_bits pcp_info.prot_bits
248 #define pcpi_tagprot_msb pcp_info.tagprot_msb
249 #define pcpi_tagprot_lsb pcp_info.tagprot_lsb
250 #define pcpi_data_bits pcp_info.data_bits
252 /* Processor cache part encodings */
253 #define PAL_CACHE_PROT_PART_DATA 0 /* Data protection */
254 #define PAL_CACHE_PROT_PART_TAG 1 /* Tag protection */
255 #define PAL_CACHE_PROT_PART_TAG_DATA 2 /* Tag+data protection (tag is
256 * more significant )
258 #define PAL_CACHE_PROT_PART_DATA_TAG 3 /* Data+tag protection (data is
259 * more significant )
261 #define PAL_CACHE_PROT_PART_MAX 6
264 typedef struct pal_cache_protection_info_s {
265 pal_status_t pcpi_status;
266 pal_cache_protection_element_t pcp_info[PAL_CACHE_PROT_PART_MAX];
267 } pal_cache_protection_info_t;
270 /* Processor cache protection method encodings */
271 #define PAL_CACHE_PROT_METHOD_NONE 0 /* No protection */
272 #define PAL_CACHE_PROT_METHOD_ODD_PARITY 1 /* Odd parity */
273 #define PAL_CACHE_PROT_METHOD_EVEN_PARITY 2 /* Even parity */
274 #define PAL_CACHE_PROT_METHOD_ECC 3 /* ECC protection */
277 /* Processor cache line identification in the hierarchy */
278 typedef union pal_cache_line_id_u {
279 u64 pclid_data;
280 struct {
281 u64 cache_type : 8, /* 7-0 cache type */
282 level : 8, /* 15-8 level of the
283 * cache in the
284 * hierarchy.
286 way : 8, /* 23-16 way in the set
288 part : 8, /* 31-24 part of the
289 * cache
291 reserved : 32; /* 63-32 is reserved*/
292 } pclid_info_read;
293 struct {
294 u64 cache_type : 8, /* 7-0 cache type */
295 level : 8, /* 15-8 level of the
296 * cache in the
297 * hierarchy.
299 way : 8, /* 23-16 way in the set
301 part : 8, /* 31-24 part of the
302 * cache
304 mesi : 8, /* 39-32 cache line
305 * state
307 start : 8, /* 47-40 lsb of data to
308 * invert
310 length : 8, /* 55-48 #bits to
311 * invert
313 trigger : 8; /* 63-56 Trigger error
314 * by doing a load
315 * after the write
318 } pclid_info_write;
319 } pal_cache_line_id_u_t;
321 #define pclid_read_part pclid_info_read.part
322 #define pclid_read_way pclid_info_read.way
323 #define pclid_read_level pclid_info_read.level
324 #define pclid_read_cache_type pclid_info_read.cache_type
326 #define pclid_write_trigger pclid_info_write.trigger
327 #define pclid_write_length pclid_info_write.length
328 #define pclid_write_start pclid_info_write.start
329 #define pclid_write_mesi pclid_info_write.mesi
330 #define pclid_write_part pclid_info_write.part
331 #define pclid_write_way pclid_info_write.way
332 #define pclid_write_level pclid_info_write.level
333 #define pclid_write_cache_type pclid_info_write.cache_type
335 /* Processor cache line part encodings */
336 #define PAL_CACHE_LINE_ID_PART_DATA 0 /* Data */
337 #define PAL_CACHE_LINE_ID_PART_TAG 1 /* Tag */
338 #define PAL_CACHE_LINE_ID_PART_DATA_PROT 2 /* Data protection */
339 #define PAL_CACHE_LINE_ID_PART_TAG_PROT 3 /* Tag protection */
340 #define PAL_CACHE_LINE_ID_PART_DATA_TAG_PROT 4 /* Data+tag
341 * protection
343 typedef struct pal_cache_line_info_s {
344 pal_status_t pcli_status; /* Return status of the read cache line
345 * info call.
347 u64 pcli_data; /* 64-bit data, tag, protection bits .. */
348 u64 pcli_data_len; /* data length in bits */
349 pal_cache_line_state_t pcli_cache_line_state; /* mesi state */
351 } pal_cache_line_info_t;
354 /* Machine Check related crap */
356 /* Pending event status bits */
357 typedef u64 pal_mc_pending_events_t;
359 #define PAL_MC_PENDING_MCA (1 << 0)
360 #define PAL_MC_PENDING_INIT (1 << 1)
362 /* Error information type */
363 typedef u64 pal_mc_info_index_t;
365 #define PAL_MC_INFO_PROCESSOR 0 /* Processor */
366 #define PAL_MC_INFO_CACHE_CHECK 1 /* Cache check */
367 #define PAL_MC_INFO_TLB_CHECK 2 /* Tlb check */
368 #define PAL_MC_INFO_BUS_CHECK 3 /* Bus check */
369 #define PAL_MC_INFO_REQ_ADDR 4 /* Requestor address */
370 #define PAL_MC_INFO_RESP_ADDR 5 /* Responder address */
371 #define PAL_MC_INFO_TARGET_ADDR 6 /* Target address */
372 #define PAL_MC_INFO_IMPL_DEP 7 /* Implementation
373 * dependent
376 #define PAL_TLB_CHECK_OP_PURGE 8
378 typedef struct pal_process_state_info_s {
379 u64 reserved1 : 2,
380 rz : 1, /* PAL_CHECK processor
381 * rendezvous
382 * successful.
385 ra : 1, /* PAL_CHECK attempted
386 * a rendezvous.
388 me : 1, /* Distinct multiple
389 * errors occurred
392 mn : 1, /* Min. state save
393 * area has been
394 * registered with PAL
397 sy : 1, /* Storage integrity
398 * synched
402 co : 1, /* Continuable */
403 ci : 1, /* MC isolated */
404 us : 1, /* Uncontained storage
405 * damage.
409 hd : 1, /* Non-essential hw
410 * lost (no loss of
411 * functionality)
412 * causing the
413 * processor to run in
414 * degraded mode.
417 tl : 1, /* 1 => MC occurred
418 * after an instr was
419 * executed but before
420 * the trap that
421 * resulted from instr
422 * execution was
423 * generated.
424 * (Trap Lost )
426 mi : 1, /* More information available
427 * call PAL_MC_ERROR_INFO
429 pi : 1, /* Precise instruction pointer */
430 pm : 1, /* Precise min-state save area */
432 dy : 1, /* Processor dynamic
433 * state valid
437 in : 1, /* 0 = MC, 1 = INIT */
438 rs : 1, /* RSE valid */
439 cm : 1, /* MC corrected */
440 ex : 1, /* MC is expected */
441 cr : 1, /* Control regs valid*/
442 pc : 1, /* Perf cntrs valid */
443 dr : 1, /* Debug regs valid */
444 tr : 1, /* Translation regs
445 * valid
447 rr : 1, /* Region regs valid */
448 ar : 1, /* App regs valid */
449 br : 1, /* Branch regs valid */
450 pr : 1, /* Predicate registers
451 * valid
454 fp : 1, /* fp registers valid*/
455 b1 : 1, /* Preserved bank one
456 * general registers
457 * are valid
459 b0 : 1, /* Preserved bank zero
460 * general registers
461 * are valid
463 gr : 1, /* General registers
464 * are valid
465 * (excl. banked regs)
467 dsize : 16, /* size of dynamic
468 * state returned
469 * by the processor
472 se : 1, /* Shared error. MCA in a
473 shared structure */
474 reserved2 : 10,
475 cc : 1, /* Cache check */
476 tc : 1, /* TLB check */
477 bc : 1, /* Bus check */
478 rc : 1, /* Register file check */
479 uc : 1; /* Uarch check */
481 } pal_processor_state_info_t;
483 typedef struct pal_cache_check_info_s {
484 u64 op : 4, /* Type of cache
485 * operation that
486 * caused the machine
487 * check.
489 level : 2, /* Cache level */
490 reserved1 : 2,
491 dl : 1, /* Failure in data part
492 * of cache line
494 tl : 1, /* Failure in tag part
495 * of cache line
497 dc : 1, /* Failure in dcache */
498 ic : 1, /* Failure in icache */
499 mesi : 3, /* Cache line state */
500 mv : 1, /* mesi valid */
501 way : 5, /* Way in which the
502 * error occurred
504 wiv : 1, /* Way field valid */
505 reserved2 : 1,
506 dp : 1, /* Data poisoned on MBE */
507 reserved3 : 8,
509 index : 20, /* Cache line index */
510 reserved4 : 2,
512 is : 1, /* instruction set (1 == ia32) */
513 iv : 1, /* instruction set field valid */
514 pl : 2, /* privilege level */
515 pv : 1, /* privilege level field valid */
516 mcc : 1, /* Machine check corrected */
517 tv : 1, /* Target address
518 * structure is valid
520 rq : 1, /* Requester identifier
521 * structure is valid
523 rp : 1, /* Responder identifier
524 * structure is valid
526 pi : 1; /* Precise instruction pointer
527 * structure is valid
529 } pal_cache_check_info_t;
531 typedef struct pal_tlb_check_info_s {
533 u64 tr_slot : 8, /* Slot# of TR where
534 * error occurred
536 trv : 1, /* tr_slot field is valid */
537 reserved1 : 1,
538 level : 2, /* TLB level where failure occurred */
539 reserved2 : 4,
540 dtr : 1, /* Fail in data TR */
541 itr : 1, /* Fail in inst TR */
542 dtc : 1, /* Fail in data TC */
543 itc : 1, /* Fail in inst. TC */
544 op : 4, /* Cache operation */
545 reserved3 : 30,
547 is : 1, /* instruction set (1 == ia32) */
548 iv : 1, /* instruction set field valid */
549 pl : 2, /* privilege level */
550 pv : 1, /* privilege level field valid */
551 mcc : 1, /* Machine check corrected */
552 tv : 1, /* Target address
553 * structure is valid
555 rq : 1, /* Requester identifier
556 * structure is valid
558 rp : 1, /* Responder identifier
559 * structure is valid
561 pi : 1; /* Precise instruction pointer
562 * structure is valid
564 } pal_tlb_check_info_t;
566 typedef struct pal_bus_check_info_s {
567 u64 size : 5, /* Xaction size */
568 ib : 1, /* Internal bus error */
569 eb : 1, /* External bus error */
570 cc : 1, /* Error occurred
571 * during cache-cache
572 * transfer.
574 type : 8, /* Bus xaction type*/
575 sev : 5, /* Bus error severity*/
576 hier : 2, /* Bus hierarchy level */
577 dp : 1, /* Data poisoned on MBE */
578 bsi : 8, /* Bus error status
579 * info
581 reserved2 : 22,
583 is : 1, /* instruction set (1 == ia32) */
584 iv : 1, /* instruction set field valid */
585 pl : 2, /* privilege level */
586 pv : 1, /* privilege level field valid */
587 mcc : 1, /* Machine check corrected */
588 tv : 1, /* Target address
589 * structure is valid
591 rq : 1, /* Requester identifier
592 * structure is valid
594 rp : 1, /* Responder identifier
595 * structure is valid
597 pi : 1; /* Precise instruction pointer
598 * structure is valid
600 } pal_bus_check_info_t;
602 typedef struct pal_reg_file_check_info_s {
603 u64 id : 4, /* Register file identifier */
604 op : 4, /* Type of register
605 * operation that
606 * caused the machine
607 * check.
609 reg_num : 7, /* Register number */
610 rnv : 1, /* reg_num valid */
611 reserved2 : 38,
613 is : 1, /* instruction set (1 == ia32) */
614 iv : 1, /* instruction set field valid */
615 pl : 2, /* privilege level */
616 pv : 1, /* privilege level field valid */
617 mcc : 1, /* Machine check corrected */
618 reserved3 : 3,
619 pi : 1; /* Precise instruction pointer
620 * structure is valid
622 } pal_reg_file_check_info_t;
624 typedef struct pal_uarch_check_info_s {
625 u64 sid : 5, /* Structure identification */
626 level : 3, /* Level of failure */
627 array_id : 4, /* Array identification */
628 op : 4, /* Type of
629 * operation that
630 * caused the machine
631 * check.
633 way : 6, /* Way of structure */
634 wv : 1, /* way valid */
635 xv : 1, /* index valid */
636 reserved1 : 8,
637 index : 8, /* Index or set of the uarch
638 * structure that failed.
640 reserved2 : 24,
642 is : 1, /* instruction set (1 == ia32) */
643 iv : 1, /* instruction set field valid */
644 pl : 2, /* privilege level */
645 pv : 1, /* privilege level field valid */
646 mcc : 1, /* Machine check corrected */
647 tv : 1, /* Target address
648 * structure is valid
650 rq : 1, /* Requester identifier
651 * structure is valid
653 rp : 1, /* Responder identifier
654 * structure is valid
656 pi : 1; /* Precise instruction pointer
657 * structure is valid
659 } pal_uarch_check_info_t;
661 typedef union pal_mc_error_info_u {
662 u64 pmei_data;
663 pal_processor_state_info_t pme_processor;
664 pal_cache_check_info_t pme_cache;
665 pal_tlb_check_info_t pme_tlb;
666 pal_bus_check_info_t pme_bus;
667 pal_reg_file_check_info_t pme_reg_file;
668 pal_uarch_check_info_t pme_uarch;
669 } pal_mc_error_info_t;
671 #define pmci_proc_unknown_check pme_processor.uc
672 #define pmci_proc_bus_check pme_processor.bc
673 #define pmci_proc_tlb_check pme_processor.tc
674 #define pmci_proc_cache_check pme_processor.cc
675 #define pmci_proc_dynamic_state_size pme_processor.dsize
676 #define pmci_proc_gpr_valid pme_processor.gr
677 #define pmci_proc_preserved_bank0_gpr_valid pme_processor.b0
678 #define pmci_proc_preserved_bank1_gpr_valid pme_processor.b1
679 #define pmci_proc_fp_valid pme_processor.fp
680 #define pmci_proc_predicate_regs_valid pme_processor.pr
681 #define pmci_proc_branch_regs_valid pme_processor.br
682 #define pmci_proc_app_regs_valid pme_processor.ar
683 #define pmci_proc_region_regs_valid pme_processor.rr
684 #define pmci_proc_translation_regs_valid pme_processor.tr
685 #define pmci_proc_debug_regs_valid pme_processor.dr
686 #define pmci_proc_perf_counters_valid pme_processor.pc
687 #define pmci_proc_control_regs_valid pme_processor.cr
688 #define pmci_proc_machine_check_expected pme_processor.ex
689 #define pmci_proc_machine_check_corrected pme_processor.cm
690 #define pmci_proc_rse_valid pme_processor.rs
691 #define pmci_proc_machine_check_or_init pme_processor.in
692 #define pmci_proc_dynamic_state_valid pme_processor.dy
693 #define pmci_proc_operation pme_processor.op
694 #define pmci_proc_trap_lost pme_processor.tl
695 #define pmci_proc_hardware_damage pme_processor.hd
696 #define pmci_proc_uncontained_storage_damage pme_processor.us
697 #define pmci_proc_machine_check_isolated pme_processor.ci
698 #define pmci_proc_continuable pme_processor.co
699 #define pmci_proc_storage_intergrity_synced pme_processor.sy
700 #define pmci_proc_min_state_save_area_regd pme_processor.mn
701 #define pmci_proc_distinct_multiple_errors pme_processor.me
702 #define pmci_proc_pal_attempted_rendezvous pme_processor.ra
703 #define pmci_proc_pal_rendezvous_complete pme_processor.rz
706 #define pmci_cache_level pme_cache.level
707 #define pmci_cache_line_state pme_cache.mesi
708 #define pmci_cache_line_state_valid pme_cache.mv
709 #define pmci_cache_line_index pme_cache.index
710 #define pmci_cache_instr_cache_fail pme_cache.ic
711 #define pmci_cache_data_cache_fail pme_cache.dc
712 #define pmci_cache_line_tag_fail pme_cache.tl
713 #define pmci_cache_line_data_fail pme_cache.dl
714 #define pmci_cache_operation pme_cache.op
715 #define pmci_cache_way_valid pme_cache.wv
716 #define pmci_cache_target_address_valid pme_cache.tv
717 #define pmci_cache_way pme_cache.way
718 #define pmci_cache_mc pme_cache.mc
720 #define pmci_tlb_instr_translation_cache_fail pme_tlb.itc
721 #define pmci_tlb_data_translation_cache_fail pme_tlb.dtc
722 #define pmci_tlb_instr_translation_reg_fail pme_tlb.itr
723 #define pmci_tlb_data_translation_reg_fail pme_tlb.dtr
724 #define pmci_tlb_translation_reg_slot pme_tlb.tr_slot
725 #define pmci_tlb_mc pme_tlb.mc
727 #define pmci_bus_status_info pme_bus.bsi
728 #define pmci_bus_req_address_valid pme_bus.rq
729 #define pmci_bus_resp_address_valid pme_bus.rp
730 #define pmci_bus_target_address_valid pme_bus.tv
731 #define pmci_bus_error_severity pme_bus.sev
732 #define pmci_bus_transaction_type pme_bus.type
733 #define pmci_bus_cache_cache_transfer pme_bus.cc
734 #define pmci_bus_transaction_size pme_bus.size
735 #define pmci_bus_internal_error pme_bus.ib
736 #define pmci_bus_external_error pme_bus.eb
737 #define pmci_bus_mc pme_bus.mc
740 * NOTE: this min_state_save area struct only includes the 1KB
741 * architectural state save area. The other 3 KB is scratch space
742 * for PAL.
745 typedef struct pal_min_state_area_s {
746 u64 pmsa_nat_bits; /* nat bits for saved GRs */
747 u64 pmsa_gr[15]; /* GR1 - GR15 */
748 u64 pmsa_bank0_gr[16]; /* GR16 - GR31 */
749 u64 pmsa_bank1_gr[16]; /* GR16 - GR31 */
750 u64 pmsa_pr; /* predicate registers */
751 u64 pmsa_br0; /* branch register 0 */
752 u64 pmsa_rsc; /* ar.rsc */
753 u64 pmsa_iip; /* cr.iip */
754 u64 pmsa_ipsr; /* cr.ipsr */
755 u64 pmsa_ifs; /* cr.ifs */
756 u64 pmsa_xip; /* previous iip */
757 u64 pmsa_xpsr; /* previous psr */
758 u64 pmsa_xfs; /* previous ifs */
759 u64 pmsa_br1; /* branch register 1 */
760 u64 pmsa_reserved[70]; /* pal_min_state_area should total to 1KB */
761 } pal_min_state_area_t;
764 struct ia64_pal_retval {
766 * A zero status value indicates call completed without error.
767 * A negative status value indicates reason of call failure.
768 * A positive status value indicates success but an
769 * informational value should be printed (e.g., "reboot for
770 * change to take effect").
772 s64 status;
773 u64 v0;
774 u64 v1;
775 u64 v2;
779 * Note: Currently unused PAL arguments are generally labeled
780 * "reserved" so the value specified in the PAL documentation
781 * (generally 0) MUST be passed. Reserved parameters are not optional
782 * parameters.
784 extern struct ia64_pal_retval ia64_pal_call_static (u64, u64, u64, u64);
785 extern struct ia64_pal_retval ia64_pal_call_stacked (u64, u64, u64, u64);
786 extern struct ia64_pal_retval ia64_pal_call_phys_static (u64, u64, u64, u64);
787 extern struct ia64_pal_retval ia64_pal_call_phys_stacked (u64, u64, u64, u64);
788 extern void ia64_save_scratch_fpregs (struct ia64_fpreg *);
789 extern void ia64_load_scratch_fpregs (struct ia64_fpreg *);
791 #define PAL_CALL(iprv,a0,a1,a2,a3) do { \
792 struct ia64_fpreg fr[6]; \
793 ia64_save_scratch_fpregs(fr); \
794 iprv = ia64_pal_call_static(a0, a1, a2, a3); \
795 ia64_load_scratch_fpregs(fr); \
796 } while (0)
798 #define PAL_CALL_STK(iprv,a0,a1,a2,a3) do { \
799 struct ia64_fpreg fr[6]; \
800 ia64_save_scratch_fpregs(fr); \
801 iprv = ia64_pal_call_stacked(a0, a1, a2, a3); \
802 ia64_load_scratch_fpregs(fr); \
803 } while (0)
805 #define PAL_CALL_PHYS(iprv,a0,a1,a2,a3) do { \
806 struct ia64_fpreg fr[6]; \
807 ia64_save_scratch_fpregs(fr); \
808 iprv = ia64_pal_call_phys_static(a0, a1, a2, a3); \
809 ia64_load_scratch_fpregs(fr); \
810 } while (0)
812 #define PAL_CALL_PHYS_STK(iprv,a0,a1,a2,a3) do { \
813 struct ia64_fpreg fr[6]; \
814 ia64_save_scratch_fpregs(fr); \
815 iprv = ia64_pal_call_phys_stacked(a0, a1, a2, a3); \
816 ia64_load_scratch_fpregs(fr); \
817 } while (0)
819 typedef int (*ia64_pal_handler) (u64, ...);
820 extern ia64_pal_handler ia64_pal;
821 extern void ia64_pal_handler_init (void *);
823 extern ia64_pal_handler ia64_pal;
825 extern pal_cache_config_info_t l0d_cache_config_info;
826 extern pal_cache_config_info_t l0i_cache_config_info;
827 extern pal_cache_config_info_t l1_cache_config_info;
828 extern pal_cache_config_info_t l2_cache_config_info;
830 extern pal_cache_protection_info_t l0d_cache_protection_info;
831 extern pal_cache_protection_info_t l0i_cache_protection_info;
832 extern pal_cache_protection_info_t l1_cache_protection_info;
833 extern pal_cache_protection_info_t l2_cache_protection_info;
835 extern pal_cache_config_info_t pal_cache_config_info_get(pal_cache_level_t,
836 pal_cache_type_t);
838 extern pal_cache_protection_info_t pal_cache_protection_info_get(pal_cache_level_t,
839 pal_cache_type_t);
842 extern void pal_error(int);
845 /* Useful wrappers for the current list of pal procedures */
847 typedef union pal_bus_features_u {
848 u64 pal_bus_features_val;
849 struct {
850 u64 pbf_reserved1 : 29;
851 u64 pbf_req_bus_parking : 1;
852 u64 pbf_bus_lock_mask : 1;
853 u64 pbf_enable_half_xfer_rate : 1;
854 u64 pbf_reserved2 : 20;
855 u64 pbf_enable_shared_line_replace : 1;
856 u64 pbf_enable_exclusive_line_replace : 1;
857 u64 pbf_disable_xaction_queueing : 1;
858 u64 pbf_disable_resp_err_check : 1;
859 u64 pbf_disable_berr_check : 1;
860 u64 pbf_disable_bus_req_internal_err_signal : 1;
861 u64 pbf_disable_bus_req_berr_signal : 1;
862 u64 pbf_disable_bus_init_event_check : 1;
863 u64 pbf_disable_bus_init_event_signal : 1;
864 u64 pbf_disable_bus_addr_err_check : 1;
865 u64 pbf_disable_bus_addr_err_signal : 1;
866 u64 pbf_disable_bus_data_err_check : 1;
867 } pal_bus_features_s;
868 } pal_bus_features_u_t;
870 extern void pal_bus_features_print (u64);
872 /* Provide information about configurable processor bus features */
873 static inline s64
874 ia64_pal_bus_get_features (pal_bus_features_u_t *features_avail,
875 pal_bus_features_u_t *features_status,
876 pal_bus_features_u_t *features_control)
878 struct ia64_pal_retval iprv;
879 PAL_CALL_PHYS(iprv, PAL_BUS_GET_FEATURES, 0, 0, 0);
880 if (features_avail)
881 features_avail->pal_bus_features_val = iprv.v0;
882 if (features_status)
883 features_status->pal_bus_features_val = iprv.v1;
884 if (features_control)
885 features_control->pal_bus_features_val = iprv.v2;
886 return iprv.status;
889 /* Enables/disables specific processor bus features */
890 static inline s64
891 ia64_pal_bus_set_features (pal_bus_features_u_t feature_select)
893 struct ia64_pal_retval iprv;
894 PAL_CALL_PHYS(iprv, PAL_BUS_SET_FEATURES, feature_select.pal_bus_features_val, 0, 0);
895 return iprv.status;
898 /* Get detailed cache information */
899 static inline s64
900 ia64_pal_cache_config_info (u64 cache_level, u64 cache_type, pal_cache_config_info_t *conf)
902 struct ia64_pal_retval iprv;
904 PAL_CALL(iprv, PAL_CACHE_INFO, cache_level, cache_type, 0);
906 if (iprv.status == 0) {
907 conf->pcci_status = iprv.status;
908 conf->pcci_info_1.pcci1_data = iprv.v0;
909 conf->pcci_info_2.pcci2_data = iprv.v1;
910 conf->pcci_reserved = iprv.v2;
912 return iprv.status;
916 /* Get detailed cche protection information */
917 static inline s64
918 ia64_pal_cache_prot_info (u64 cache_level, u64 cache_type, pal_cache_protection_info_t *prot)
920 struct ia64_pal_retval iprv;
922 PAL_CALL(iprv, PAL_CACHE_PROT_INFO, cache_level, cache_type, 0);
924 if (iprv.status == 0) {
925 prot->pcpi_status = iprv.status;
926 prot->pcp_info[0].pcpi_data = iprv.v0 & 0xffffffff;
927 prot->pcp_info[1].pcpi_data = iprv.v0 >> 32;
928 prot->pcp_info[2].pcpi_data = iprv.v1 & 0xffffffff;
929 prot->pcp_info[3].pcpi_data = iprv.v1 >> 32;
930 prot->pcp_info[4].pcpi_data = iprv.v2 & 0xffffffff;
931 prot->pcp_info[5].pcpi_data = iprv.v2 >> 32;
933 return iprv.status;
937 * Flush the processor instruction or data caches. *PROGRESS must be
938 * initialized to zero before calling this for the first time..
940 static inline s64
941 ia64_pal_cache_flush (u64 cache_type, u64 invalidate, u64 *progress, u64 *vector)
943 struct ia64_pal_retval iprv;
944 PAL_CALL(iprv, PAL_CACHE_FLUSH, cache_type, invalidate, *progress);
945 if (vector)
946 *vector = iprv.v0;
947 *progress = iprv.v1;
948 return iprv.status;
952 /* Initialize the processor controlled caches */
953 static inline s64
954 ia64_pal_cache_init (u64 level, u64 cache_type, u64 rest)
956 struct ia64_pal_retval iprv;
957 PAL_CALL(iprv, PAL_CACHE_INIT, level, cache_type, rest);
958 return iprv.status;
961 /* Initialize the tags and data of a data or unified cache line of
962 * processor controlled cache to known values without the availability
963 * of backing memory.
965 static inline s64
966 ia64_pal_cache_line_init (u64 physical_addr, u64 data_value)
968 struct ia64_pal_retval iprv;
969 PAL_CALL(iprv, PAL_CACHE_LINE_INIT, physical_addr, data_value, 0);
970 return iprv.status;
974 /* Read the data and tag of a processor controlled cache line for diags */
975 static inline s64
976 ia64_pal_cache_read (pal_cache_line_id_u_t line_id, u64 physical_addr)
978 struct ia64_pal_retval iprv;
979 PAL_CALL_PHYS_STK(iprv, PAL_CACHE_READ, line_id.pclid_data,
980 physical_addr, 0);
981 return iprv.status;
984 /* Return summary information about the hierarchy of caches controlled by the processor */
985 static inline s64
986 ia64_pal_cache_summary (u64 *cache_levels, u64 *unique_caches)
988 struct ia64_pal_retval iprv;
989 PAL_CALL(iprv, PAL_CACHE_SUMMARY, 0, 0, 0);
990 if (cache_levels)
991 *cache_levels = iprv.v0;
992 if (unique_caches)
993 *unique_caches = iprv.v1;
994 return iprv.status;
997 /* Write the data and tag of a processor-controlled cache line for diags */
998 static inline s64
999 ia64_pal_cache_write (pal_cache_line_id_u_t line_id, u64 physical_addr, u64 data)
1001 struct ia64_pal_retval iprv;
1002 PAL_CALL_PHYS_STK(iprv, PAL_CACHE_WRITE, line_id.pclid_data,
1003 physical_addr, data);
1004 return iprv.status;
1008 /* Return the parameters needed to copy relocatable PAL procedures from ROM to memory */
1009 static inline s64
1010 ia64_pal_copy_info (u64 copy_type, u64 num_procs, u64 num_iopics,
1011 u64 *buffer_size, u64 *buffer_align)
1013 struct ia64_pal_retval iprv;
1014 PAL_CALL(iprv, PAL_COPY_INFO, copy_type, num_procs, num_iopics);
1015 if (buffer_size)
1016 *buffer_size = iprv.v0;
1017 if (buffer_align)
1018 *buffer_align = iprv.v1;
1019 return iprv.status;
1022 /* Copy relocatable PAL procedures from ROM to memory */
1023 static inline s64
1024 ia64_pal_copy_pal (u64 target_addr, u64 alloc_size, u64 processor, u64 *pal_proc_offset)
1026 struct ia64_pal_retval iprv;
1027 PAL_CALL(iprv, PAL_COPY_PAL, target_addr, alloc_size, processor);
1028 if (pal_proc_offset)
1029 *pal_proc_offset = iprv.v0;
1030 return iprv.status;
1033 /* Return the number of instruction and data debug register pairs */
1034 static inline s64
1035 ia64_pal_debug_info (u64 *inst_regs, u64 *data_regs)
1037 struct ia64_pal_retval iprv;
1038 PAL_CALL(iprv, PAL_DEBUG_INFO, 0, 0, 0);
1039 if (inst_regs)
1040 *inst_regs = iprv.v0;
1041 if (data_regs)
1042 *data_regs = iprv.v1;
1044 return iprv.status;
1047 #ifdef TBD
1048 /* Switch from IA64-system environment to IA-32 system environment */
1049 static inline s64
1050 ia64_pal_enter_ia32_env (ia32_env1, ia32_env2, ia32_env3)
1052 struct ia64_pal_retval iprv;
1053 PAL_CALL(iprv, PAL_ENTER_IA_32_ENV, ia32_env1, ia32_env2, ia32_env3);
1054 return iprv.status;
1056 #endif
1058 /* Get unique geographical address of this processor on its bus */
1059 static inline s64
1060 ia64_pal_fixed_addr (u64 *global_unique_addr)
1062 struct ia64_pal_retval iprv;
1063 PAL_CALL(iprv, PAL_FIXED_ADDR, 0, 0, 0);
1064 if (global_unique_addr)
1065 *global_unique_addr = iprv.v0;
1066 return iprv.status;
1069 /* Get base frequency of the platform if generated by the processor */
1070 static inline s64
1071 ia64_pal_freq_base (u64 *platform_base_freq)
1073 struct ia64_pal_retval iprv;
1074 PAL_CALL(iprv, PAL_FREQ_BASE, 0, 0, 0);
1075 if (platform_base_freq)
1076 *platform_base_freq = iprv.v0;
1077 return iprv.status;
1081 * Get the ratios for processor frequency, bus frequency and interval timer to
1082 * to base frequency of the platform
1084 static inline s64
1085 ia64_pal_freq_ratios (struct pal_freq_ratio *proc_ratio, struct pal_freq_ratio *bus_ratio,
1086 struct pal_freq_ratio *itc_ratio)
1088 struct ia64_pal_retval iprv;
1089 PAL_CALL(iprv, PAL_FREQ_RATIOS, 0, 0, 0);
1090 if (proc_ratio)
1091 *(u64 *)proc_ratio = iprv.v0;
1092 if (bus_ratio)
1093 *(u64 *)bus_ratio = iprv.v1;
1094 if (itc_ratio)
1095 *(u64 *)itc_ratio = iprv.v2;
1096 return iprv.status;
1100 * Get the current hardware resource sharing policy of the processor
1102 static inline s64
1103 ia64_pal_get_hw_policy (u64 proc_num, u64 *cur_policy, u64 *num_impacted,
1104 u64 *la)
1106 struct ia64_pal_retval iprv;
1107 PAL_CALL(iprv, PAL_GET_HW_POLICY, proc_num, 0, 0);
1108 if (cur_policy)
1109 *cur_policy = iprv.v0;
1110 if (num_impacted)
1111 *num_impacted = iprv.v1;
1112 if (la)
1113 *la = iprv.v2;
1114 return iprv.status;
1117 /* Make the processor enter HALT or one of the implementation dependent low
1118 * power states where prefetching and execution are suspended and cache and
1119 * TLB coherency is not maintained.
1121 static inline s64
1122 ia64_pal_halt (u64 halt_state)
1124 struct ia64_pal_retval iprv;
1125 PAL_CALL(iprv, PAL_HALT, halt_state, 0, 0);
1126 return iprv.status;
1129 typedef union pal_power_mgmt_info_u {
1130 u64 ppmi_data;
1131 struct {
1132 u64 exit_latency : 16,
1133 entry_latency : 16,
1134 power_consumption : 28,
1135 im : 1,
1136 co : 1,
1137 reserved : 2;
1138 } pal_power_mgmt_info_s;
1139 } pal_power_mgmt_info_u_t;
1141 /* Return information about processor's optional power management capabilities. */
1142 static inline s64
1143 ia64_pal_halt_info (pal_power_mgmt_info_u_t *power_buf)
1145 struct ia64_pal_retval iprv;
1146 PAL_CALL_STK(iprv, PAL_HALT_INFO, (unsigned long) power_buf, 0, 0);
1147 return iprv.status;
1150 /* Get the current P-state information */
1151 static inline s64
1152 ia64_pal_get_pstate (u64 *pstate_index, unsigned long type)
1154 struct ia64_pal_retval iprv;
1155 PAL_CALL_STK(iprv, PAL_GET_PSTATE, type, 0, 0);
1156 *pstate_index = iprv.v0;
1157 return iprv.status;
1160 /* Set the P-state */
1161 static inline s64
1162 ia64_pal_set_pstate (u64 pstate_index)
1164 struct ia64_pal_retval iprv;
1165 PAL_CALL_STK(iprv, PAL_SET_PSTATE, pstate_index, 0, 0);
1166 return iprv.status;
1169 /* Processor branding information*/
1170 static inline s64
1171 ia64_pal_get_brand_info (char *brand_info)
1173 struct ia64_pal_retval iprv;
1174 PAL_CALL_STK(iprv, PAL_BRAND_INFO, 0, (u64)brand_info, 0);
1175 return iprv.status;
1178 /* Cause the processor to enter LIGHT HALT state, where prefetching and execution are
1179 * suspended, but cache and TLB coherency is maintained.
1181 static inline s64
1182 ia64_pal_halt_light (void)
1184 struct ia64_pal_retval iprv;
1185 PAL_CALL(iprv, PAL_HALT_LIGHT, 0, 0, 0);
1186 return iprv.status;
1189 /* Clear all the processor error logging registers and reset the indicator that allows
1190 * the error logging registers to be written. This procedure also checks the pending
1191 * machine check bit and pending INIT bit and reports their states.
1193 static inline s64
1194 ia64_pal_mc_clear_log (u64 *pending_vector)
1196 struct ia64_pal_retval iprv;
1197 PAL_CALL(iprv, PAL_MC_CLEAR_LOG, 0, 0, 0);
1198 if (pending_vector)
1199 *pending_vector = iprv.v0;
1200 return iprv.status;
1203 /* Ensure that all outstanding transactions in a processor are completed or that any
1204 * MCA due to thes outstanding transaction is taken.
1206 static inline s64
1207 ia64_pal_mc_drain (void)
1209 struct ia64_pal_retval iprv;
1210 PAL_CALL(iprv, PAL_MC_DRAIN, 0, 0, 0);
1211 return iprv.status;
1214 /* Return the machine check dynamic processor state */
1215 static inline s64
1216 ia64_pal_mc_dynamic_state (u64 offset, u64 *size, u64 *pds)
1218 struct ia64_pal_retval iprv;
1219 PAL_CALL(iprv, PAL_MC_DYNAMIC_STATE, offset, 0, 0);
1220 if (size)
1221 *size = iprv.v0;
1222 if (pds)
1223 *pds = iprv.v1;
1224 return iprv.status;
1227 /* Return processor machine check information */
1228 static inline s64
1229 ia64_pal_mc_error_info (u64 info_index, u64 type_index, u64 *size, u64 *error_info)
1231 struct ia64_pal_retval iprv;
1232 PAL_CALL(iprv, PAL_MC_ERROR_INFO, info_index, type_index, 0);
1233 if (size)
1234 *size = iprv.v0;
1235 if (error_info)
1236 *error_info = iprv.v1;
1237 return iprv.status;
1240 /* Injects the requested processor error or returns info on
1241 * supported injection capabilities for current processor implementation
1243 static inline s64
1244 ia64_pal_mc_error_inject_phys (u64 err_type_info, u64 err_struct_info,
1245 u64 err_data_buffer, u64 *capabilities, u64 *resources)
1247 struct ia64_pal_retval iprv;
1248 PAL_CALL_PHYS_STK(iprv, PAL_MC_ERROR_INJECT, err_type_info,
1249 err_struct_info, err_data_buffer);
1250 if (capabilities)
1251 *capabilities= iprv.v0;
1252 if (resources)
1253 *resources= iprv.v1;
1254 return iprv.status;
1257 static inline s64
1258 ia64_pal_mc_error_inject_virt (u64 err_type_info, u64 err_struct_info,
1259 u64 err_data_buffer, u64 *capabilities, u64 *resources)
1261 struct ia64_pal_retval iprv;
1262 PAL_CALL_STK(iprv, PAL_MC_ERROR_INJECT, err_type_info,
1263 err_struct_info, err_data_buffer);
1264 if (capabilities)
1265 *capabilities= iprv.v0;
1266 if (resources)
1267 *resources= iprv.v1;
1268 return iprv.status;
1271 /* Inform PALE_CHECK whether a machine check is expected so that PALE_CHECK willnot
1272 * attempt to correct any expected machine checks.
1274 static inline s64
1275 ia64_pal_mc_expected (u64 expected, u64 *previous)
1277 struct ia64_pal_retval iprv;
1278 PAL_CALL(iprv, PAL_MC_EXPECTED, expected, 0, 0);
1279 if (previous)
1280 *previous = iprv.v0;
1281 return iprv.status;
1284 /* Register a platform dependent location with PAL to which it can save
1285 * minimal processor state in the event of a machine check or initialization
1286 * event.
1288 static inline s64
1289 ia64_pal_mc_register_mem (u64 physical_addr)
1291 struct ia64_pal_retval iprv;
1292 PAL_CALL(iprv, PAL_MC_REGISTER_MEM, physical_addr, 0, 0);
1293 return iprv.status;
1296 /* Restore minimal architectural processor state, set CMC interrupt if necessary
1297 * and resume execution
1299 static inline s64
1300 ia64_pal_mc_resume (u64 set_cmci, u64 save_ptr)
1302 struct ia64_pal_retval iprv;
1303 PAL_CALL(iprv, PAL_MC_RESUME, set_cmci, save_ptr, 0);
1304 return iprv.status;
1307 /* Return the memory attributes implemented by the processor */
1308 static inline s64
1309 ia64_pal_mem_attrib (u64 *mem_attrib)
1311 struct ia64_pal_retval iprv;
1312 PAL_CALL(iprv, PAL_MEM_ATTRIB, 0, 0, 0);
1313 if (mem_attrib)
1314 *mem_attrib = iprv.v0 & 0xff;
1315 return iprv.status;
1318 /* Return the amount of memory needed for second phase of processor
1319 * self-test and the required alignment of memory.
1321 static inline s64
1322 ia64_pal_mem_for_test (u64 *bytes_needed, u64 *alignment)
1324 struct ia64_pal_retval iprv;
1325 PAL_CALL(iprv, PAL_MEM_FOR_TEST, 0, 0, 0);
1326 if (bytes_needed)
1327 *bytes_needed = iprv.v0;
1328 if (alignment)
1329 *alignment = iprv.v1;
1330 return iprv.status;
1333 typedef union pal_perf_mon_info_u {
1334 u64 ppmi_data;
1335 struct {
1336 u64 generic : 8,
1337 width : 8,
1338 cycles : 8,
1339 retired : 8,
1340 reserved : 32;
1341 } pal_perf_mon_info_s;
1342 } pal_perf_mon_info_u_t;
1344 /* Return the performance monitor information about what can be counted
1345 * and how to configure the monitors to count the desired events.
1347 static inline s64
1348 ia64_pal_perf_mon_info (u64 *pm_buffer, pal_perf_mon_info_u_t *pm_info)
1350 struct ia64_pal_retval iprv;
1351 PAL_CALL(iprv, PAL_PERF_MON_INFO, (unsigned long) pm_buffer, 0, 0);
1352 if (pm_info)
1353 pm_info->ppmi_data = iprv.v0;
1354 return iprv.status;
1357 /* Specifies the physical address of the processor interrupt block
1358 * and I/O port space.
1360 static inline s64
1361 ia64_pal_platform_addr (u64 type, u64 physical_addr)
1363 struct ia64_pal_retval iprv;
1364 PAL_CALL(iprv, PAL_PLATFORM_ADDR, type, physical_addr, 0);
1365 return iprv.status;
1368 /* Set the SAL PMI entrypoint in memory */
1369 static inline s64
1370 ia64_pal_pmi_entrypoint (u64 sal_pmi_entry_addr)
1372 struct ia64_pal_retval iprv;
1373 PAL_CALL(iprv, PAL_PMI_ENTRYPOINT, sal_pmi_entry_addr, 0, 0);
1374 return iprv.status;
1377 struct pal_features_s;
1378 /* Provide information about configurable processor features */
1379 static inline s64
1380 ia64_pal_proc_get_features (u64 *features_avail,
1381 u64 *features_status,
1382 u64 *features_control,
1383 u64 features_set)
1385 struct ia64_pal_retval iprv;
1386 PAL_CALL_PHYS(iprv, PAL_PROC_GET_FEATURES, 0, features_set, 0);
1387 if (iprv.status == 0) {
1388 *features_avail = iprv.v0;
1389 *features_status = iprv.v1;
1390 *features_control = iprv.v2;
1392 return iprv.status;
1395 /* Enable/disable processor dependent features */
1396 static inline s64
1397 ia64_pal_proc_set_features (u64 feature_select)
1399 struct ia64_pal_retval iprv;
1400 PAL_CALL_PHYS(iprv, PAL_PROC_SET_FEATURES, feature_select, 0, 0);
1401 return iprv.status;
1405 * Put everything in a struct so we avoid the global offset table whenever
1406 * possible.
1408 typedef struct ia64_ptce_info_s {
1409 u64 base;
1410 u32 count[2];
1411 u32 stride[2];
1412 } ia64_ptce_info_t;
1414 /* Return the information required for the architected loop used to purge
1415 * (initialize) the entire TC
1417 static inline s64
1418 ia64_get_ptce (ia64_ptce_info_t *ptce)
1420 struct ia64_pal_retval iprv;
1422 if (!ptce)
1423 return -1;
1425 PAL_CALL(iprv, PAL_PTCE_INFO, 0, 0, 0);
1426 if (iprv.status == 0) {
1427 ptce->base = iprv.v0;
1428 ptce->count[0] = iprv.v1 >> 32;
1429 ptce->count[1] = iprv.v1 & 0xffffffff;
1430 ptce->stride[0] = iprv.v2 >> 32;
1431 ptce->stride[1] = iprv.v2 & 0xffffffff;
1433 return iprv.status;
1436 /* Return info about implemented application and control registers. */
1437 static inline s64
1438 ia64_pal_register_info (u64 info_request, u64 *reg_info_1, u64 *reg_info_2)
1440 struct ia64_pal_retval iprv;
1441 PAL_CALL(iprv, PAL_REGISTER_INFO, info_request, 0, 0);
1442 if (reg_info_1)
1443 *reg_info_1 = iprv.v0;
1444 if (reg_info_2)
1445 *reg_info_2 = iprv.v1;
1446 return iprv.status;
1449 typedef union pal_hints_u {
1450 u64 ph_data;
1451 struct {
1452 u64 si : 1,
1453 li : 1,
1454 reserved : 62;
1455 } pal_hints_s;
1456 } pal_hints_u_t;
1458 /* Return information about the register stack and RSE for this processor
1459 * implementation.
1461 static inline s64
1462 ia64_pal_rse_info (u64 *num_phys_stacked, pal_hints_u_t *hints)
1464 struct ia64_pal_retval iprv;
1465 PAL_CALL(iprv, PAL_RSE_INFO, 0, 0, 0);
1466 if (num_phys_stacked)
1467 *num_phys_stacked = iprv.v0;
1468 if (hints)
1469 hints->ph_data = iprv.v1;
1470 return iprv.status;
1474 * Set the current hardware resource sharing policy of the processor
1476 static inline s64
1477 ia64_pal_set_hw_policy (u64 policy)
1479 struct ia64_pal_retval iprv;
1480 PAL_CALL(iprv, PAL_SET_HW_POLICY, policy, 0, 0);
1481 return iprv.status;
1484 /* Cause the processor to enter SHUTDOWN state, where prefetching and execution are
1485 * suspended, but cause cache and TLB coherency to be maintained.
1486 * This is usually called in IA-32 mode.
1488 static inline s64
1489 ia64_pal_shutdown (void)
1491 struct ia64_pal_retval iprv;
1492 PAL_CALL(iprv, PAL_SHUTDOWN, 0, 0, 0);
1493 return iprv.status;
1496 /* Perform the second phase of processor self-test. */
1497 static inline s64
1498 ia64_pal_test_proc (u64 test_addr, u64 test_size, u64 attributes, u64 *self_test_state)
1500 struct ia64_pal_retval iprv;
1501 PAL_CALL(iprv, PAL_TEST_PROC, test_addr, test_size, attributes);
1502 if (self_test_state)
1503 *self_test_state = iprv.v0;
1504 return iprv.status;
1507 typedef union pal_version_u {
1508 u64 pal_version_val;
1509 struct {
1510 u64 pv_pal_b_rev : 8;
1511 u64 pv_pal_b_model : 8;
1512 u64 pv_reserved1 : 8;
1513 u64 pv_pal_vendor : 8;
1514 u64 pv_pal_a_rev : 8;
1515 u64 pv_pal_a_model : 8;
1516 u64 pv_reserved2 : 16;
1517 } pal_version_s;
1518 } pal_version_u_t;
1522 * Return PAL version information. While the documentation states that
1523 * PAL_VERSION can be called in either physical or virtual mode, some
1524 * implementations only allow physical calls. We don't call it very often,
1525 * so the overhead isn't worth eliminating.
1527 static inline s64
1528 ia64_pal_version (pal_version_u_t *pal_min_version, pal_version_u_t *pal_cur_version)
1530 struct ia64_pal_retval iprv;
1531 PAL_CALL_PHYS(iprv, PAL_VERSION, 0, 0, 0);
1532 if (pal_min_version)
1533 pal_min_version->pal_version_val = iprv.v0;
1535 if (pal_cur_version)
1536 pal_cur_version->pal_version_val = iprv.v1;
1538 return iprv.status;
1541 typedef union pal_tc_info_u {
1542 u64 pti_val;
1543 struct {
1544 u64 num_sets : 8,
1545 associativity : 8,
1546 num_entries : 16,
1547 pf : 1,
1548 unified : 1,
1549 reduce_tr : 1,
1550 reserved : 29;
1551 } pal_tc_info_s;
1552 } pal_tc_info_u_t;
1554 #define tc_reduce_tr pal_tc_info_s.reduce_tr
1555 #define tc_unified pal_tc_info_s.unified
1556 #define tc_pf pal_tc_info_s.pf
1557 #define tc_num_entries pal_tc_info_s.num_entries
1558 #define tc_associativity pal_tc_info_s.associativity
1559 #define tc_num_sets pal_tc_info_s.num_sets
1562 /* Return information about the virtual memory characteristics of the processor
1563 * implementation.
1565 static inline s64
1566 ia64_pal_vm_info (u64 tc_level, u64 tc_type, pal_tc_info_u_t *tc_info, u64 *tc_pages)
1568 struct ia64_pal_retval iprv;
1569 PAL_CALL(iprv, PAL_VM_INFO, tc_level, tc_type, 0);
1570 if (tc_info)
1571 tc_info->pti_val = iprv.v0;
1572 if (tc_pages)
1573 *tc_pages = iprv.v1;
1574 return iprv.status;
1577 /* Get page size information about the virtual memory characteristics of the processor
1578 * implementation.
1580 static inline s64
1581 ia64_pal_vm_page_size (u64 *tr_pages, u64 *vw_pages)
1583 struct ia64_pal_retval iprv;
1584 PAL_CALL(iprv, PAL_VM_PAGE_SIZE, 0, 0, 0);
1585 if (tr_pages)
1586 *tr_pages = iprv.v0;
1587 if (vw_pages)
1588 *vw_pages = iprv.v1;
1589 return iprv.status;
1592 typedef union pal_vm_info_1_u {
1593 u64 pvi1_val;
1594 struct {
1595 u64 vw : 1,
1596 phys_add_size : 7,
1597 key_size : 8,
1598 max_pkr : 8,
1599 hash_tag_id : 8,
1600 max_dtr_entry : 8,
1601 max_itr_entry : 8,
1602 max_unique_tcs : 8,
1603 num_tc_levels : 8;
1604 } pal_vm_info_1_s;
1605 } pal_vm_info_1_u_t;
1607 #define PAL_MAX_PURGES 0xFFFF /* all ones is means unlimited */
1609 typedef union pal_vm_info_2_u {
1610 u64 pvi2_val;
1611 struct {
1612 u64 impl_va_msb : 8,
1613 rid_size : 8,
1614 max_purges : 16,
1615 reserved : 32;
1616 } pal_vm_info_2_s;
1617 } pal_vm_info_2_u_t;
1619 /* Get summary information about the virtual memory characteristics of the processor
1620 * implementation.
1622 static inline s64
1623 ia64_pal_vm_summary (pal_vm_info_1_u_t *vm_info_1, pal_vm_info_2_u_t *vm_info_2)
1625 struct ia64_pal_retval iprv;
1626 PAL_CALL(iprv, PAL_VM_SUMMARY, 0, 0, 0);
1627 if (vm_info_1)
1628 vm_info_1->pvi1_val = iprv.v0;
1629 if (vm_info_2)
1630 vm_info_2->pvi2_val = iprv.v1;
1631 return iprv.status;
1634 typedef union pal_itr_valid_u {
1635 u64 piv_val;
1636 struct {
1637 u64 access_rights_valid : 1,
1638 priv_level_valid : 1,
1639 dirty_bit_valid : 1,
1640 mem_attr_valid : 1,
1641 reserved : 60;
1642 } pal_tr_valid_s;
1643 } pal_tr_valid_u_t;
1645 /* Read a translation register */
1646 static inline s64
1647 ia64_pal_tr_read (u64 reg_num, u64 tr_type, u64 *tr_buffer, pal_tr_valid_u_t *tr_valid)
1649 struct ia64_pal_retval iprv;
1650 PAL_CALL_PHYS_STK(iprv, PAL_VM_TR_READ, reg_num, tr_type,(u64)ia64_tpa(tr_buffer));
1651 if (tr_valid)
1652 tr_valid->piv_val = iprv.v0;
1653 return iprv.status;
1657 * PAL_PREFETCH_VISIBILITY transaction types
1659 #define PAL_VISIBILITY_VIRTUAL 0
1660 #define PAL_VISIBILITY_PHYSICAL 1
1663 * PAL_PREFETCH_VISIBILITY return codes
1665 #define PAL_VISIBILITY_OK 1
1666 #define PAL_VISIBILITY_OK_REMOTE_NEEDED 0
1667 #define PAL_VISIBILITY_INVAL_ARG -2
1668 #define PAL_VISIBILITY_ERROR -3
1670 static inline s64
1671 ia64_pal_prefetch_visibility (s64 trans_type)
1673 struct ia64_pal_retval iprv;
1674 PAL_CALL(iprv, PAL_PREFETCH_VISIBILITY, trans_type, 0, 0);
1675 return iprv.status;
1678 /* data structure for getting information on logical to physical mappings */
1679 typedef union pal_log_overview_u {
1680 struct {
1681 u64 num_log :16, /* Total number of logical
1682 * processors on this die
1684 tpc :8, /* Threads per core */
1685 reserved3 :8, /* Reserved */
1686 cpp :8, /* Cores per processor */
1687 reserved2 :8, /* Reserved */
1688 ppid :8, /* Physical processor ID */
1689 reserved1 :8; /* Reserved */
1690 } overview_bits;
1691 u64 overview_data;
1692 } pal_log_overview_t;
1694 typedef union pal_proc_n_log_info1_u{
1695 struct {
1696 u64 tid :16, /* Thread id */
1697 reserved2 :16, /* Reserved */
1698 cid :16, /* Core id */
1699 reserved1 :16; /* Reserved */
1700 } ppli1_bits;
1701 u64 ppli1_data;
1702 } pal_proc_n_log_info1_t;
1704 typedef union pal_proc_n_log_info2_u {
1705 struct {
1706 u64 la :16, /* Logical address */
1707 reserved :48; /* Reserved */
1708 } ppli2_bits;
1709 u64 ppli2_data;
1710 } pal_proc_n_log_info2_t;
1712 typedef struct pal_logical_to_physical_s
1714 pal_log_overview_t overview;
1715 pal_proc_n_log_info1_t ppli1;
1716 pal_proc_n_log_info2_t ppli2;
1717 } pal_logical_to_physical_t;
1719 #define overview_num_log overview.overview_bits.num_log
1720 #define overview_tpc overview.overview_bits.tpc
1721 #define overview_cpp overview.overview_bits.cpp
1722 #define overview_ppid overview.overview_bits.ppid
1723 #define log1_tid ppli1.ppli1_bits.tid
1724 #define log1_cid ppli1.ppli1_bits.cid
1725 #define log2_la ppli2.ppli2_bits.la
1727 /* Get information on logical to physical processor mappings. */
1728 static inline s64
1729 ia64_pal_logical_to_phys(u64 proc_number, pal_logical_to_physical_t *mapping)
1731 struct ia64_pal_retval iprv;
1733 PAL_CALL(iprv, PAL_LOGICAL_TO_PHYSICAL, proc_number, 0, 0);
1735 if (iprv.status == PAL_STATUS_SUCCESS)
1737 mapping->overview.overview_data = iprv.v0;
1738 mapping->ppli1.ppli1_data = iprv.v1;
1739 mapping->ppli2.ppli2_data = iprv.v2;
1742 return iprv.status;
1745 typedef struct pal_cache_shared_info_s
1747 u64 num_shared;
1748 pal_proc_n_log_info1_t ppli1;
1749 pal_proc_n_log_info2_t ppli2;
1750 } pal_cache_shared_info_t;
1752 /* Get information on logical to physical processor mappings. */
1753 static inline s64
1754 ia64_pal_cache_shared_info(u64 level,
1755 u64 type,
1756 u64 proc_number,
1757 pal_cache_shared_info_t *info)
1759 struct ia64_pal_retval iprv;
1761 PAL_CALL(iprv, PAL_CACHE_SHARED_INFO, level, type, proc_number);
1763 if (iprv.status == PAL_STATUS_SUCCESS) {
1764 info->num_shared = iprv.v0;
1765 info->ppli1.ppli1_data = iprv.v1;
1766 info->ppli2.ppli2_data = iprv.v2;
1769 return iprv.status;
1771 #endif /* __ASSEMBLY__ */
1773 #endif /* _ASM_IA64_PAL_H */