1 #ifndef _ASM_IA64_SAL_H
2 #define _ASM_IA64_SAL_H
5 * System Abstraction Layer definitions.
7 * This is based on version 2.5 of the manual "IA-64 System
10 * Copyright (C) 2001 Intel
11 * Copyright (C) 2002 Jenna Hall <jenna.s.hall@intel.com>
12 * Copyright (C) 2001 Fred Lewis <frederick.v.lewis@intel.com>
13 * Copyright (C) 1998, 1999, 2001, 2003 Hewlett-Packard Co
14 * David Mosberger-Tang <davidm@hpl.hp.com>
15 * Copyright (C) 1999 Srinivasa Prasad Thirumalachar <sprasad@sprasad.engr.sgi.com>
17 * 02/01/04 J. Hall Updated Error Record Structures to conform to July 2001
18 * revision of the SAL spec.
19 * 01/01/03 fvlewis Updated Error Record Structures to conform with Nov. 2000
20 * revision of the SAL spec.
21 * 99/09/29 davidm Updated for SAL 2.6.
22 * 00/03/29 cfleck Updated SAL Error Logging info for processor (SAL 2.6)
23 * (plus examples of platform error info structures from smariset @ Intel)
26 #define IA64_SAL_PLATFORM_FEATURE_BUS_LOCK_BIT 0
27 #define IA64_SAL_PLATFORM_FEATURE_IRQ_REDIR_HINT_BIT 1
28 #define IA64_SAL_PLATFORM_FEATURE_IPI_REDIR_HINT_BIT 2
29 #define IA64_SAL_PLATFORM_FEATURE_ITC_DRIFT_BIT 3
31 #define IA64_SAL_PLATFORM_FEATURE_BUS_LOCK (1<<IA64_SAL_PLATFORM_FEATURE_BUS_LOCK_BIT)
32 #define IA64_SAL_PLATFORM_FEATURE_IRQ_REDIR_HINT (1<<IA64_SAL_PLATFORM_FEATURE_IRQ_REDIR_HINT_BIT)
33 #define IA64_SAL_PLATFORM_FEATURE_IPI_REDIR_HINT (1<<IA64_SAL_PLATFORM_FEATURE_IPI_REDIR_HINT_BIT)
34 #define IA64_SAL_PLATFORM_FEATURE_ITC_DRIFT (1<<IA64_SAL_PLATFORM_FEATURE_ITC_DRIFT_BIT)
38 #include <linux/spinlock.h>
39 #include <linux/efi.h>
42 #include <asm/system.h>
45 extern spinlock_t sal_lock;
47 /* SAL spec _requires_ eight args for each call. */
48 #define __SAL_CALL(result,a0,a1,a2,a3,a4,a5,a6,a7) \
49 result = (*ia64_sal)(a0,a1,a2,a3,a4,a5,a6,a7)
51 # define SAL_CALL(result,args...) do { \
52 unsigned long __ia64_sc_flags; \
53 struct ia64_fpreg __ia64_sc_fr[6]; \
54 ia64_save_scratch_fpregs(__ia64_sc_fr); \
55 spin_lock_irqsave(&sal_lock, __ia64_sc_flags); \
56 __SAL_CALL(result, args); \
57 spin_unlock_irqrestore(&sal_lock, __ia64_sc_flags); \
58 ia64_load_scratch_fpregs(__ia64_sc_fr); \
61 # define SAL_CALL_NOLOCK(result,args...) do { \
62 unsigned long __ia64_scn_flags; \
63 struct ia64_fpreg __ia64_scn_fr[6]; \
64 ia64_save_scratch_fpregs(__ia64_scn_fr); \
65 local_irq_save(__ia64_scn_flags); \
66 __SAL_CALL(result, args); \
67 local_irq_restore(__ia64_scn_flags); \
68 ia64_load_scratch_fpregs(__ia64_scn_fr); \
71 # define SAL_CALL_REENTRANT(result,args...) do { \
72 struct ia64_fpreg __ia64_scs_fr[6]; \
73 ia64_save_scratch_fpregs(__ia64_scs_fr); \
74 __SAL_CALL(result, args); \
75 ia64_load_scratch_fpregs(__ia64_scs_fr); \
78 #define SAL_SET_VECTORS 0x01000000
79 #define SAL_GET_STATE_INFO 0x01000001
80 #define SAL_GET_STATE_INFO_SIZE 0x01000002
81 #define SAL_CLEAR_STATE_INFO 0x01000003
82 #define SAL_MC_RENDEZ 0x01000004
83 #define SAL_MC_SET_PARAMS 0x01000005
84 #define SAL_REGISTER_PHYSICAL_ADDR 0x01000006
86 #define SAL_CACHE_FLUSH 0x01000008
87 #define SAL_CACHE_INIT 0x01000009
88 #define SAL_PCI_CONFIG_READ 0x01000010
89 #define SAL_PCI_CONFIG_WRITE 0x01000011
90 #define SAL_FREQ_BASE 0x01000012
92 #define SAL_UPDATE_PAL 0x01000020
94 struct ia64_sal_retval {
96 * A zero status value indicates call completed without error.
97 * A negative status value indicates reason of call failure.
98 * A positive status value indicates success but an
99 * informational value should be printed (e.g., "reboot for
100 * change to take effect").
108 typedef struct ia64_sal_retval (*ia64_sal_handler) (u64, ...);
111 SAL_FREQ_BASE_PLATFORM = 0,
112 SAL_FREQ_BASE_INTERVAL_TIMER = 1,
113 SAL_FREQ_BASE_REALTIME_CLOCK = 2
117 * The SAL system table is followed by a variable number of variable
118 * length descriptors. The structure of these descriptors follows
120 * The defininition follows SAL specs from July 2000
122 struct ia64_sal_systab {
123 u8 signature[4]; /* should be "SST_" */
124 u32 size; /* size of this table in bytes */
127 u16 entry_count; /* # of entries in variable portion */
134 /* oem_id & product_id: terminating NUL is missing if string is exactly 32 bytes long. */
136 u8 product_id[32]; /* ASCII product id */
140 enum sal_systab_entry_type {
141 SAL_DESC_ENTRY_POINT = 0,
143 SAL_DESC_PLATFORM_FEATURE = 2,
146 SAL_DESC_AP_WAKEUP = 5
158 #define SAL_DESC_SIZE(type) "\060\040\020\040\020\020"[(unsigned) type]
160 typedef struct ia64_sal_desc_entry_point {
167 }ia64_sal_desc_entry_point_t;
169 typedef struct ia64_sal_desc_memory {
171 u8 used_by_sal; /* needs to be mapped for SAL? */
172 u8 mem_attr; /* current memory attribute setting */
173 u8 access_rights; /* access rights set up by SAL */
174 u8 mem_attr_mask; /* mask of supported memory attributes */
176 u8 mem_type; /* memory type */
177 u8 mem_usage; /* memory usage */
178 u64 addr; /* physical address of memory */
179 u32 length; /* length (multiple of 4KB pages) */
182 } ia64_sal_desc_memory_t;
184 typedef struct ia64_sal_desc_platform_feature {
188 } ia64_sal_desc_platform_feature_t;
190 typedef struct ia64_sal_desc_tr {
192 u8 tr_type; /* 0 == instruction, 1 == data */
193 u8 regnum; /* translation register number */
195 u64 addr; /* virtual address of area covered */
196 u64 page_size; /* encoded page size */
198 } ia64_sal_desc_tr_t;
200 typedef struct ia64_sal_desc_ptc {
203 u32 num_domains; /* # of coherence domains */
204 u64 domain_info; /* physical address of domain info table */
205 } ia64_sal_desc_ptc_t;
207 typedef struct ia64_sal_ptc_domain_info {
208 u64 proc_count; /* number of processors in domain */
209 u64 proc_list; /* physical address of LID array */
210 } ia64_sal_ptc_domain_info_t;
212 typedef struct ia64_sal_ptc_domain_proc_entry {
213 u64 id : 8; /* id of processor */
214 u64 eid : 8; /* eid of processor */
215 } ia64_sal_ptc_domain_proc_entry_t;
218 #define IA64_SAL_AP_EXTERNAL_INT 0
220 typedef struct ia64_sal_desc_ap_wakeup {
222 u8 mechanism; /* 0 == external interrupt */
224 u64 vector; /* interrupt vector in range 0x10-0xff */
225 } ia64_sal_desc_ap_wakeup_t ;
227 extern ia64_sal_handler ia64_sal;
228 extern struct ia64_sal_desc_ptc *ia64_ptc_domain_info;
230 extern const char *ia64_sal_strerror (long status);
231 extern void ia64_sal_init (struct ia64_sal_systab *sal_systab);
233 /* SAL information type encodings */
235 SAL_INFO_TYPE_MCA = 0, /* Machine check abort information */
236 SAL_INFO_TYPE_INIT = 1, /* Init information */
237 SAL_INFO_TYPE_CMC = 2, /* Corrected machine check information */
238 SAL_INFO_TYPE_CPE = 3 /* Corrected platform error information */
241 /* Encodings for machine check parameter types */
243 SAL_MC_PARAM_RENDEZ_INT = 1, /* Rendezvous interrupt */
244 SAL_MC_PARAM_RENDEZ_WAKEUP = 2, /* Wakeup */
245 SAL_MC_PARAM_CPE_INT = 3 /* Corrected Platform Error Int */
248 /* Encodings for rendezvous mechanisms */
250 SAL_MC_PARAM_MECHANISM_INT = 1, /* Use interrupt */
251 SAL_MC_PARAM_MECHANISM_MEM = 2 /* Use memory synchronization variable*/
254 /* Encodings for vectors which can be registered by the OS with SAL */
256 SAL_VECTOR_OS_MCA = 0,
257 SAL_VECTOR_OS_INIT = 1,
258 SAL_VECTOR_OS_BOOT_RENDEZ = 2
261 /* Encodings for mca_opt parameter sent to SAL_MC_SET_PARAMS */
262 #define SAL_MC_PARAM_RZ_ALWAYS 0x1
263 #define SAL_MC_PARAM_BINIT_ESCALATE 0x10
266 * Definition of the SAL Error Log from the SAL spec
269 /* SAL Error Record Section GUID Definitions */
270 #define SAL_PROC_DEV_ERR_SECT_GUID \
271 EFI_GUID(0xe429faf1, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
272 #define SAL_PLAT_MEM_DEV_ERR_SECT_GUID \
273 EFI_GUID(0xe429faf2, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
274 #define SAL_PLAT_SEL_DEV_ERR_SECT_GUID \
275 EFI_GUID(0xe429faf3, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
276 #define SAL_PLAT_PCI_BUS_ERR_SECT_GUID \
277 EFI_GUID(0xe429faf4, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
278 #define SAL_PLAT_SMBIOS_DEV_ERR_SECT_GUID \
279 EFI_GUID(0xe429faf5, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
280 #define SAL_PLAT_PCI_COMP_ERR_SECT_GUID \
281 EFI_GUID(0xe429faf6, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
282 #define SAL_PLAT_SPECIFIC_ERR_SECT_GUID \
283 EFI_GUID(0xe429faf7, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
284 #define SAL_PLAT_HOST_CTLR_ERR_SECT_GUID \
285 EFI_GUID(0xe429faf8, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
286 #define SAL_PLAT_BUS_ERR_SECT_GUID \
287 EFI_GUID(0xe429faf9, 0x3cb7, 0x11d4, 0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81)
289 #define MAX_CACHE_ERRORS 6
290 #define MAX_TLB_ERRORS 6
291 #define MAX_BUS_ERRORS 1
293 /* Definition of version according to SAL spec for logging purposes */
294 typedef struct sal_log_revision {
295 u8 minor; /* BCD (0..99) */
296 u8 major; /* BCD (0..99) */
297 } sal_log_revision_t;
299 /* Definition of timestamp according to SAL spec for logging purposes */
300 typedef struct sal_log_timestamp {
301 u8 slh_second; /* Second (0..59) */
302 u8 slh_minute; /* Minute (0..59) */
303 u8 slh_hour; /* Hour (0..23) */
305 u8 slh_day; /* Day (1..31) */
306 u8 slh_month; /* Month (1..12) */
307 u8 slh_year; /* Year (00..99) */
308 u8 slh_century; /* Century (19, 20, 21, ...) */
309 } sal_log_timestamp_t;
311 /* Definition of log record header structures */
312 typedef struct sal_log_record_header {
313 u64 id; /* Unique monotonically increasing ID */
314 sal_log_revision_t revision; /* Major and Minor revision of header */
315 u16 severity; /* Error Severity */
316 u32 len; /* Length of this error log in bytes */
317 sal_log_timestamp_t timestamp; /* Timestamp */
318 efi_guid_t platform_guid; /* Unique OEM Platform ID */
319 } sal_log_record_header_t;
321 /* Definition of log section header structures */
322 typedef struct sal_log_sec_header {
323 efi_guid_t guid; /* Unique Section ID */
324 sal_log_revision_t revision; /* Major and Minor revision of Section */
326 u32 len; /* Section length */
327 } sal_log_section_hdr_t;
329 typedef struct sal_log_mod_error_info {
332 requestor_identifier : 1,
333 responder_identifier : 1,
334 target_identifier : 1,
339 u64 requestor_identifier;
340 u64 responder_identifier;
341 u64 target_identifier;
343 } sal_log_mod_error_info_t;
345 typedef struct sal_processor_static_info {
355 pal_min_state_area_t min_state_area;
360 struct ia64_fpreg fr[128];
361 } sal_processor_static_info_t;
363 struct sal_cpuid_info {
368 typedef struct sal_log_processor_info {
369 sal_log_section_hdr_t header;
371 u64 proc_error_map : 1,
372 proc_state_param : 1,
374 psi_static_struct : 1,
378 num_reg_file_check : 4,
384 u64 proc_state_parameter;
387 * The rest of this structure consists of variable-length arrays, which can't be
390 sal_log_mod_error_info_t info[0];
392 * This is what the rest looked like if C supported variable-length arrays:
394 * sal_log_mod_error_info_t cache_check_info[.valid.num_cache_check];
395 * sal_log_mod_error_info_t tlb_check_info[.valid.num_tlb_check];
396 * sal_log_mod_error_info_t bus_check_info[.valid.num_bus_check];
397 * sal_log_mod_error_info_t reg_file_check_info[.valid.num_reg_file_check];
398 * sal_log_mod_error_info_t ms_check_info[.valid.num_ms_check];
399 * struct sal_cpuid_info cpuid_info;
400 * sal_processor_static_info_t processor_static_info;
402 } sal_log_processor_info_t;
404 /* Given a sal_log_processor_info_t pointer, return a pointer to the processor_static_info: */
405 #define SAL_LPI_PSI_INFO(l) \
406 ({ sal_log_processor_info_t *_l = (l); \
407 ((sal_processor_static_info_t *) \
408 ((char *) _l->info + ((_l->valid.num_cache_check + _l->valid.num_tlb_check \
409 + _l->valid.num_bus_check + _l->valid.num_reg_file_check \
410 + _l->valid.num_ms_check) * sizeof(sal_log_mod_error_info_t) \
411 + sizeof(struct sal_cpuid_info)))); \
414 /* platform error log structures */
416 typedef struct sal_log_mem_dev_err_info {
417 sal_log_section_hdr_t header;
419 u64 error_status : 1,
454 u8 oem_data[1]; /* Variable length data */
455 } sal_log_mem_dev_err_info_t;
457 typedef struct sal_log_sel_dev_err_info {
458 sal_log_section_hdr_t header;
483 } sal_log_sel_dev_err_info_t;
485 typedef struct sal_log_pci_bus_err_info {
486 sal_log_section_hdr_t header;
510 u8 oem_data[1]; /* Variable length data */
511 } sal_log_pci_bus_err_info_t;
513 typedef struct sal_log_smbios_dev_err_info {
514 sal_log_section_hdr_t header;
525 u8 data[1]; /* data of variable length, length == slsmb_length */
526 } sal_log_smbios_dev_err_info_t;
528 typedef struct sal_log_pci_comp_err_info {
529 sal_log_section_hdr_t header;
552 u64 reg_data_pairs[1];
554 * array of address/data register pairs is num_mem_regs + num_io_regs elements
555 * long. Each array element consists of a u64 address followed by a u64 data
556 * value. The oem_data array immediately follows the reg_data_pairs array
558 u8 oem_data[1]; /* Variable length data */
559 } sal_log_pci_comp_err_info_t;
561 typedef struct sal_log_plat_specific_err_info {
562 sal_log_section_hdr_t header;
571 u8 oem_data[1]; /* platform specific variable length data */
572 } sal_log_plat_specific_err_info_t;
574 typedef struct sal_log_host_ctlr_err_info {
575 sal_log_section_hdr_t header;
590 u8 oem_data[1]; /* Variable length OEM data */
591 } sal_log_host_ctlr_err_info_t;
593 typedef struct sal_log_plat_bus_err_info {
594 sal_log_section_hdr_t header;
609 u8 oem_data[1]; /* Variable length OEM data */
610 } sal_log_plat_bus_err_info_t;
612 /* Overall platform error section structure */
613 typedef union sal_log_platform_err_info {
614 sal_log_mem_dev_err_info_t mem_dev_err;
615 sal_log_sel_dev_err_info_t sel_dev_err;
616 sal_log_pci_bus_err_info_t pci_bus_err;
617 sal_log_smbios_dev_err_info_t smbios_dev_err;
618 sal_log_pci_comp_err_info_t pci_comp_err;
619 sal_log_plat_specific_err_info_t plat_specific_err;
620 sal_log_host_ctlr_err_info_t host_ctlr_err;
621 sal_log_plat_bus_err_info_t plat_bus_err;
622 } sal_log_platform_err_info_t;
624 /* SAL log over-all, multi-section error record structure (processor+platform) */
625 typedef struct err_rec {
626 sal_log_record_header_t sal_elog_header;
627 sal_log_processor_info_t proc_err;
628 sal_log_platform_err_info_t plat_err;
629 u8 oem_data_pad[1024];
633 * Now define a couple of inline functions for improved type checking
637 ia64_sal_freq_base (unsigned long which, unsigned long *ticks_per_second,
638 unsigned long *drift_info)
640 struct ia64_sal_retval isrv;
642 SAL_CALL(isrv, SAL_FREQ_BASE, which, 0, 0, 0, 0, 0, 0);
643 *ticks_per_second = isrv.v0;
644 *drift_info = isrv.v1;
648 /* Flush all the processor and platform level instruction and/or data caches */
650 ia64_sal_cache_flush (u64 cache_type)
652 struct ia64_sal_retval isrv;
653 SAL_CALL(isrv, SAL_CACHE_FLUSH, cache_type, 0, 0, 0, 0, 0, 0);
658 /* Initialize all the processor and platform level instruction and data caches */
660 ia64_sal_cache_init (void)
662 struct ia64_sal_retval isrv;
663 SAL_CALL(isrv, SAL_CACHE_INIT, 0, 0, 0, 0, 0, 0, 0);
668 * Clear the processor and platform information logged by SAL with respect to the machine
669 * state at the time of MCA's, INITs, CMCs, or CPEs.
672 ia64_sal_clear_state_info (u64 sal_info_type)
674 struct ia64_sal_retval isrv;
675 SAL_CALL_REENTRANT(isrv, SAL_CLEAR_STATE_INFO, sal_info_type, 0,
681 /* Get the processor and platform information logged by SAL with respect to the machine
682 * state at the time of the MCAs, INITs, CMCs, or CPEs.
685 ia64_sal_get_state_info (u64 sal_info_type, u64 *sal_info)
687 struct ia64_sal_retval isrv;
688 SAL_CALL_REENTRANT(isrv, SAL_GET_STATE_INFO, sal_info_type, 0,
689 sal_info, 0, 0, 0, 0);
697 * Get the maximum size of the information logged by SAL with respect to the machine state
698 * at the time of MCAs, INITs, CMCs, or CPEs.
701 ia64_sal_get_state_info_size (u64 sal_info_type)
703 struct ia64_sal_retval isrv;
704 SAL_CALL_REENTRANT(isrv, SAL_GET_STATE_INFO_SIZE, sal_info_type, 0,
712 * Causes the processor to go into a spin loop within SAL where SAL awaits a wakeup from
713 * the monarch processor. Must not lock, because it will not return on any cpu until the
714 * monarch processor sends a wake up.
717 ia64_sal_mc_rendez (void)
719 struct ia64_sal_retval isrv;
720 SAL_CALL_NOLOCK(isrv, SAL_MC_RENDEZ, 0, 0, 0, 0, 0, 0, 0);
725 * Allow the OS to specify the interrupt number to be used by SAL to interrupt OS during
726 * the machine check rendezvous sequence as well as the mechanism to wake up the
727 * non-monarch processor at the end of machine check processing.
728 * Returns the complete ia64_sal_retval because some calls return more than just a status
731 static inline struct ia64_sal_retval
732 ia64_sal_mc_set_params (u64 param_type, u64 i_or_m, u64 i_or_m_val, u64 timeout, u64 rz_always)
734 struct ia64_sal_retval isrv;
735 SAL_CALL(isrv, SAL_MC_SET_PARAMS, param_type, i_or_m, i_or_m_val,
736 timeout, rz_always, 0, 0);
740 /* Read from PCI configuration space */
742 ia64_sal_pci_config_read (u64 pci_config_addr, u64 size, u64 *value)
744 struct ia64_sal_retval isrv;
745 SAL_CALL(isrv, SAL_PCI_CONFIG_READ, pci_config_addr, size, 0, 0, 0, 0, 0);
751 /* Write to PCI configuration space */
753 ia64_sal_pci_config_write (u64 pci_config_addr, u64 size, u64 value)
755 struct ia64_sal_retval isrv;
756 SAL_CALL(isrv, SAL_PCI_CONFIG_WRITE, pci_config_addr, size, value,
762 * Register physical addresses of locations needed by SAL when SAL procedures are invoked
766 ia64_sal_register_physical_addr (u64 phys_entry, u64 phys_addr)
768 struct ia64_sal_retval isrv;
769 SAL_CALL(isrv, SAL_REGISTER_PHYSICAL_ADDR, phys_entry, phys_addr,
775 * Register software dependent code locations within SAL. These locations are handlers or
776 * entry points where SAL will pass control for the specified event. These event handlers
777 * are for the bott rendezvous, MCAs and INIT scenarios.
780 ia64_sal_set_vectors (u64 vector_type,
781 u64 handler_addr1, u64 gp1, u64 handler_len1,
782 u64 handler_addr2, u64 gp2, u64 handler_len2)
784 struct ia64_sal_retval isrv;
785 SAL_CALL(isrv, SAL_SET_VECTORS, vector_type,
786 handler_addr1, gp1, handler_len1,
787 handler_addr2, gp2, handler_len2);
792 /* Update the contents of PAL block in the non-volatile storage device */
794 ia64_sal_update_pal (u64 param_buf, u64 scratch_buf, u64 scratch_buf_size,
795 u64 *error_code, u64 *scratch_buf_size_needed)
797 struct ia64_sal_retval isrv;
798 SAL_CALL(isrv, SAL_UPDATE_PAL, param_buf, scratch_buf, scratch_buf_size,
801 *error_code = isrv.v0;
802 if (scratch_buf_size_needed)
803 *scratch_buf_size_needed = isrv.v1;
807 extern unsigned long sal_platform_features;
809 extern int (*salinfo_platform_oemdata)(const u8 *, u8 **, u64 *);
811 #endif /* __ASSEMBLY__ */
813 #endif /* _ASM_IA64_SAL_H */