[deliverable/linux.git] / arch / powerpc / include / asm / rtas.h

#ifndef _POWERPC_RTAS_H
#define _POWERPC_RTAS_H
#ifdef __KERNEL__

#include <linux/spinlock.h>
#include <asm/page.h>

/*
 * Definitions for talking to the RTAS on CHRP machines.
 *
 * Copyright (C) 2001 Peter Bergner
 * Copyright (C) 2001 PPC 64 Team, IBM Corp
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#define RTAS_UNKNOWN_SERVICE (-1)
#define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */

/* Buffer size for ppc_rtas system call. */
#define RTAS_RMOBUF_MAX (64 * 1024)

/* RTAS return status codes */
#define RTAS_NOT_SUSPENDABLE	-9004
#define RTAS_BUSY		-2    /* RTAS Busy */
#define RTAS_EXTENDED_DELAY_MIN	9900
#define RTAS_EXTENDED_DELAY_MAX	9905

/*
 * In general to call RTAS use rtas_token("string") to lookup
 * an RTAS token for the given string (e.g. "event-scan").
 * To actually perform the call use
 *    ret = rtas_call(token, n_in, n_out, ...)
 * Where n_in is the number of input parameters and
 *       n_out is the number of output parameters
 *
 * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
 * will be returned as a token.  rtas_call() does look for this
 * token and error out gracefully so rtas_call(rtas_token("str"), ...)
 * may be safely used for one-shot calls to RTAS.
 *
 */

typedef u32 rtas_arg_t;

struct rtas_args {
	u32 token;
	u32 nargs;
	u32 nret; 
	rtas_arg_t args[16];
	rtas_arg_t *rets;     /* Pointer to return values in args[]. */
};  

struct rtas_t {
	unsigned long entry;		/* physical address pointer */
	unsigned long base;		/* physical address pointer */
	unsigned long size;
	arch_spinlock_t lock;
	struct rtas_args args;
	struct device_node *dev;	/* virtual address pointer */
};

struct rtas_suspend_me_data {
	atomic_t working; /* number of cpus accessing this struct */
	atomic_t done;
	int token; /* ibm,suspend-me */
	atomic_t error;
	struct completion *complete; /* wait on this until working == 0 */
};

/* RTAS event classes */
#define RTAS_INTERNAL_ERROR		0x80000000 /* set bit 0 */
#define RTAS_EPOW_WARNING		0x40000000 /* set bit 1 */
#define RTAS_HOTPLUG_EVENTS		0x10000000 /* set bit 3 */
#define RTAS_IO_EVENTS			0x08000000 /* set bit 4 */
#define RTAS_EVENT_SCAN_ALL_EVENTS	0xffffffff

/* RTAS event severity */
#define RTAS_SEVERITY_FATAL		0x5
#define RTAS_SEVERITY_ERROR		0x4
#define RTAS_SEVERITY_ERROR_SYNC	0x3
#define RTAS_SEVERITY_WARNING		0x2
#define RTAS_SEVERITY_EVENT		0x1
#define RTAS_SEVERITY_NO_ERROR		0x0

/* RTAS event disposition */
#define RTAS_DISP_FULLY_RECOVERED	0x0
#define RTAS_DISP_LIMITED_RECOVERY	0x1
#define RTAS_DISP_NOT_RECOVERED		0x2

/* RTAS event initiator */
#define RTAS_INITIATOR_UNKNOWN		0x0
#define RTAS_INITIATOR_CPU		0x1
#define RTAS_INITIATOR_PCI		0x2
#define RTAS_INITIATOR_ISA		0x3
#define RTAS_INITIATOR_MEMORY		0x4
#define RTAS_INITIATOR_POWERMGM		0x5

/* RTAS event target */
#define RTAS_TARGET_UNKNOWN		0x0
#define RTAS_TARGET_CPU			0x1
#define RTAS_TARGET_PCI			0x2
#define RTAS_TARGET_ISA			0x3
#define RTAS_TARGET_MEMORY		0x4
#define RTAS_TARGET_POWERMGM		0x5

/* RTAS event type */
#define RTAS_TYPE_RETRY			0x01
#define RTAS_TYPE_TCE_ERR		0x02
#define RTAS_TYPE_INTERN_DEV_FAIL	0x03
#define RTAS_TYPE_TIMEOUT		0x04
#define RTAS_TYPE_DATA_PARITY		0x05
#define RTAS_TYPE_ADDR_PARITY		0x06
#define RTAS_TYPE_CACHE_PARITY		0x07
#define RTAS_TYPE_ADDR_INVALID		0x08
#define RTAS_TYPE_ECC_UNCORR		0x09
#define RTAS_TYPE_ECC_CORR		0x0a
#define RTAS_TYPE_EPOW			0x40
#define RTAS_TYPE_PLATFORM		0xE0
#define RTAS_TYPE_IO			0xE1
#define RTAS_TYPE_INFO			0xE2
#define RTAS_TYPE_DEALLOC		0xE3
#define RTAS_TYPE_DUMP			0xE4
/* I don't add PowerMGM events right now, this is a different topic */ 
#define RTAS_TYPE_PMGM_POWER_SW_ON	0x60
#define RTAS_TYPE_PMGM_POWER_SW_OFF	0x61
#define RTAS_TYPE_PMGM_LID_OPEN		0x62
#define RTAS_TYPE_PMGM_LID_CLOSE	0x63
#define RTAS_TYPE_PMGM_SLEEP_BTN	0x64
#define RTAS_TYPE_PMGM_WAKE_BTN		0x65
#define RTAS_TYPE_PMGM_BATTERY_WARN	0x66
#define RTAS_TYPE_PMGM_BATTERY_CRIT	0x67
#define RTAS_TYPE_PMGM_SWITCH_TO_BAT	0x68
#define RTAS_TYPE_PMGM_SWITCH_TO_AC	0x69
#define RTAS_TYPE_PMGM_KBD_OR_MOUSE	0x6a
#define RTAS_TYPE_PMGM_ENCLOS_OPEN	0x6b
#define RTAS_TYPE_PMGM_ENCLOS_CLOSED	0x6c
#define RTAS_TYPE_PMGM_RING_INDICATE	0x6d
#define RTAS_TYPE_PMGM_LAN_ATTENTION	0x6e
#define RTAS_TYPE_PMGM_TIME_ALARM	0x6f
#define RTAS_TYPE_PMGM_CONFIG_CHANGE	0x70
#define RTAS_TYPE_PMGM_SERVICE_PROC	0x71
/* Platform Resource Reassignment Notification */
#define RTAS_TYPE_PRRN			0xA0

/* RTAS check-exception vector offset */
#define RTAS_VECTOR_EXTERNAL_INTERRUPT	0x500

struct rtas_error_log {
	unsigned long version:8;		/* Architectural version */
	unsigned long severity:3;		/* Severity level of error */
	unsigned long disposition:2;		/* Degree of recovery */
	unsigned long extended:1;		/* extended log present? */
	unsigned long /* reserved */ :2;	/* Reserved for future use */
	unsigned long initiator:4;		/* Initiator of event */
	unsigned long target:4;			/* Target of failed operation */
	unsigned long type:8;			/* General event or error*/
	unsigned long extended_log_length:32;	/* length in bytes */
	unsigned char buffer[1];		/* Start of extended log */
						/* Variable length.      */
};

#define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG	14

#define RTAS_V6EXT_COMPANY_ID_IBM	(('I' << 24) | ('B' << 16) | ('M' << 8))

/* RTAS general extended event log, Version 6. The extended log starts
 * from "buffer" field of struct rtas_error_log defined above.
 */
struct rtas_ext_event_log_v6 {
	/* Byte 0 */
	uint32_t log_valid:1;		/* 1:Log valid */
	uint32_t unrecoverable_error:1;	/* 1:Unrecoverable error */
	uint32_t recoverable_error:1;	/* 1:recoverable (correctable	*/
					/*   or successfully retried)	*/
	uint32_t degraded_operation:1;	/* 1:Unrecoverable err, bypassed*/
					/*   - degraded operation (e.g.	*/
					/*   CPU or mem taken off-line)	*/
	uint32_t predictive_error:1;
	uint32_t new_log:1;		/* 1:"New" log (Always 1 for	*/
					/*   data returned from RTAS	*/
	uint32_t big_endian:1;		/* 1: Big endian */
	uint32_t :1;			/* reserved */
	/* Byte 1 */
	uint32_t :8;			/* reserved */
	/* Byte 2 */
	uint32_t powerpc_format:1;	/* Set to 1 (indicating log is	*/
					/* in PowerPC format		*/
	uint32_t :3;			/* reserved */
	uint32_t log_format:4;		/* Log format indicator. Define	*/
					/* format used for byte 12-2047	*/
	/* Byte 3 */
	uint32_t :8;			/* reserved */
	/* Byte 4-11 */
	uint8_t reserved[8];		/* reserved */
	/* Byte 12-15 */
	uint32_t company_id;		/* Company ID of the company	*/
					/* that defines the format for	*/
					/* the vendor specific log type	*/
	/* Byte 16-end of log */
	uint8_t vendor_log[1];		/* Start of vendor specific log	*/
					/* Variable length.		*/
};

/* pSeries event log format */

/* Two bytes ASCII section IDs */
#define PSERIES_ELOG_SECT_ID_PRIV_HDR		(('P' << 8) | 'H')
#define PSERIES_ELOG_SECT_ID_USER_HDR		(('U' << 8) | 'H')
#define PSERIES_ELOG_SECT_ID_PRIMARY_SRC	(('P' << 8) | 'S')
#define PSERIES_ELOG_SECT_ID_EXTENDED_UH	(('E' << 8) | 'H')
#define PSERIES_ELOG_SECT_ID_FAILING_MTMS	(('M' << 8) | 'T')
#define PSERIES_ELOG_SECT_ID_SECONDARY_SRC	(('S' << 8) | 'S')
#define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR	(('D' << 8) | 'H')
#define PSERIES_ELOG_SECT_ID_FW_ERROR		(('S' << 8) | 'W')
#define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID	(('L' << 8) | 'P')
#define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID	(('L' << 8) | 'R')
#define PSERIES_ELOG_SECT_ID_HMC_ID		(('H' << 8) | 'M')
#define PSERIES_ELOG_SECT_ID_EPOW		(('E' << 8) | 'P')
#define PSERIES_ELOG_SECT_ID_IO_EVENT		(('I' << 8) | 'E')
#define PSERIES_ELOG_SECT_ID_MANUFACT_INFO	(('M' << 8) | 'I')
#define PSERIES_ELOG_SECT_ID_CALL_HOME		(('C' << 8) | 'H')
#define PSERIES_ELOG_SECT_ID_USER_DEF		(('U' << 8) | 'D')

/* Vendor specific Platform Event Log Format, Version 6, section header */
struct pseries_errorlog {
	uint16_t id;			/* 0x00 2-byte ASCII section ID	*/
	uint16_t length;		/* 0x02 Section length in bytes	*/
	uint8_t version;		/* 0x04 Section version		*/
	uint8_t subtype;		/* 0x05 Section subtype		*/
	uint16_t creator_component;	/* 0x06 Creator component ID	*/
	uint8_t data[];			/* 0x08 Start of section data	*/
};

struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
					      uint16_t section_id);

/*
 * This can be set by the rtas_flash module so that it can get called
 * as the absolutely last thing before the kernel terminates.
 */
extern void (*rtas_flash_term_hook)(int);

extern struct rtas_t rtas;

extern void enter_rtas(unsigned long);
extern int rtas_token(const char *service);
extern int rtas_service_present(const char *service);
extern int rtas_call(int token, int, int, int *, ...);
extern void rtas_restart(char *cmd);
extern void rtas_power_off(void);
extern void rtas_halt(void);
extern void rtas_os_term(char *str);
extern int rtas_get_sensor(int sensor, int index, int *state);
extern int rtas_get_power_level(int powerdomain, int *level);
extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
extern bool rtas_indicator_present(int token, int *maxindex);
extern int rtas_set_indicator(int indicator, int index, int new_value);
extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
extern void rtas_progress(char *s, unsigned short hex);
extern void rtas_initialize(void);
extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
extern int rtas_ibm_suspend_me(struct rtas_args *);

struct rtc_time;
extern unsigned long rtas_get_boot_time(void);
extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
extern int rtas_set_rtc_time(struct rtc_time *rtc_time);

extern unsigned int rtas_busy_delay_time(int status);
extern unsigned int rtas_busy_delay(int status);

extern int early_init_dt_scan_rtas(unsigned long node,
		const char *uname, int depth, void *data);

extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);

#ifdef CONFIG_PPC_PSERIES
extern int pseries_devicetree_update(s32 scope);
#endif

#ifdef CONFIG_PPC_RTAS_DAEMON
extern void rtas_cancel_event_scan(void);
#else
static inline void rtas_cancel_event_scan(void) { }
#endif

/* Error types logged.  */
#define ERR_FLAG_ALREADY_LOGGED	0x0
#define ERR_FLAG_BOOT		0x1 	/* log was pulled from NVRAM on boot */
#define ERR_TYPE_RTAS_LOG	0x2	/* from rtas event-scan */
#define ERR_TYPE_KERNEL_PANIC	0x4	/* from die()/panic() */
#define ERR_TYPE_KERNEL_PANIC_GZ 0x8	/* ditto, compressed */

/* All the types and not flags */
#define ERR_TYPE_MASK \
	(ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)

#define RTAS_DEBUG KERN_DEBUG "RTAS: "
 
#define RTAS_ERROR_LOG_MAX 2048

/*
 * Return the firmware-specified size of the error log buffer
 *  for all rtas calls that require an error buffer argument.
 *  This includes 'check-exception' and 'rtas-last-error'.
 */
extern int rtas_get_error_log_max(void);

/* Event Scan Parameters */
#define EVENT_SCAN_ALL_EVENTS	0xf0000000
#define SURVEILLANCE_TOKEN	9000
#define LOG_NUMBER		64		/* must be a power of two */
#define LOG_NUMBER_MASK		(LOG_NUMBER-1)

/* Some RTAS ops require a data buffer and that buffer must be < 4G.
 * Rather than having a memory allocator, just use this buffer
 * (get the lock first), make the RTAS call.  Copy the data instead
 * of holding the buffer for long.
 */

#define RTAS_DATA_BUF_SIZE 4096
extern spinlock_t rtas_data_buf_lock;
extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];

/* RMO buffer reserved for user-space RTAS use */
extern unsigned long rtas_rmo_buf;

#define GLOBAL_INTERRUPT_QUEUE 9005

/**
 * rtas_config_addr - Format a busno, devfn and reg for RTAS.
 * @busno: The bus number.
 * @devfn: The device and function number as encoded by PCI_DEVFN().
 * @reg: The register number.
 *
 * This function encodes the given busno, devfn and register number as
 * required for RTAS calls that take a "config_addr" parameter.
 * See PAPR requirement 7.3.4-1 for more info.
 */
static inline u32 rtas_config_addr(int busno, int devfn, int reg)
{
	return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
			(devfn << 8) | (reg & 0xff);
}

extern void __cpuinit rtas_give_timebase(void);
extern void __cpuinit rtas_take_timebase(void);

#ifdef CONFIG_PPC_RTAS
static inline int page_is_rtas_user_buf(unsigned long pfn)
{
	unsigned long paddr = (pfn << PAGE_SHIFT);
	if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
		return 1;
	return 0;
}

/* Not the best place to put pSeries_coalesce_init, will be fixed when we
 * move some of the rtas suspend-me stuff to pseries */
extern void pSeries_coalesce_init(void);
#else
static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
static inline void pSeries_coalesce_init(void) { }
#endif

extern int call_rtas(const char *, int, int, unsigned long *, ...);

#endif /* __KERNEL__ */
#endif /* _POWERPC_RTAS_H */
Commit	Line	Data
9b6b563c PM	1	#ifndef _POWERPC_RTAS_H
9b6b563c PM	2	#define _POWERPC_RTAS_H
88ced031	3	#ifdef __KERNEL__
9b6b563c PM	4
	5	#include <linux/spinlock.h>
	6	#include <asm/page.h>
	7
	8	/*
	9	* Definitions for talking to the RTAS on CHRP machines.
	10	*
	11	* Copyright (C) 2001 Peter Bergner
	12	* Copyright (C) 2001 PPC 64 Team, IBM Corp
	13	*
	14	* This program is free software; you can redistribute it and/or
	15	* modify it under the terms of the GNU General Public License
	16	* as published by the Free Software Foundation; either version
	17	* 2 of the License, or (at your option) any later version.
	18	*/
	19
	20	#define RTAS_UNKNOWN_SERVICE (-1)
fe333321	21	#define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
9b6b563c PM	22
	23	/* Buffer size for ppc_rtas system call. */
	24	#define RTAS_RMOBUF_MAX (64 * 1024)
	25
	26	/* RTAS return status codes */
368a6ba5	27	#define RTAS_NOT_SUSPENDABLE -9004
9b6b563c PM	28	#define RTAS_BUSY -2 /* RTAS Busy */
	29	#define RTAS_EXTENDED_DELAY_MIN 9900
	30	#define RTAS_EXTENDED_DELAY_MAX 9905
	31
	32	/*
	33	* In general to call RTAS use rtas_token("string") to lookup
	34	* an RTAS token for the given string (e.g. "event-scan").
	35	* To actually perform the call use
	36	* ret = rtas_call(token, n_in, n_out, ...)
	37	* Where n_in is the number of input parameters and
	38	* n_out is the number of output parameters
	39	*
	40	* If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
	41	* will be returned as a token. rtas_call() does look for this
	42	* token and error out gracefully so rtas_call(rtas_token("str"), ...)
	43	* may be safely used for one-shot calls to RTAS.
	44	*
	45	*/
	46
	47	typedef u32 rtas_arg_t;
	48
	49	struct rtas_args {
	50	u32 token;
	51	u32 nargs;
	52	u32 nret;
	53	rtas_arg_t args[16];
	54	rtas_arg_t rets; / Pointer to return values in args[]. */
	55	};
	56
9b6b563c PM	57	struct rtas_t {
	58	unsigned long entry; /* physical address pointer */
	59	unsigned long base; /* physical address pointer */
	60	unsigned long size;
445c8951	61	arch_spinlock_t lock;
9b6b563c PM	62	struct rtas_args args;
	63	struct device_node dev; / virtual address pointer */
	64	};
	65
8fe93f8d BK	66	struct rtas_suspend_me_data {
	67	atomic_t working; /* number of cpus accessing this struct */
	68	atomic_t done;
	69	int token; /* ibm,suspend-me */
	70	atomic_t error;
	71	struct completion complete; / wait on this until working == 0 */
	72	};
	73
9b6b563c PM	74	/* RTAS event classes */
	75	#define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
	76	#define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
9b6b563c	77	#define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
4a9f9506 AB	78	#define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */
4a9f9506 AB	79	#define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff
9b6b563c PM	80
	81	/* RTAS event severity */
	82	#define RTAS_SEVERITY_FATAL 0x5
	83	#define RTAS_SEVERITY_ERROR 0x4
	84	#define RTAS_SEVERITY_ERROR_SYNC 0x3
	85	#define RTAS_SEVERITY_WARNING 0x2
	86	#define RTAS_SEVERITY_EVENT 0x1
	87	#define RTAS_SEVERITY_NO_ERROR 0x0
	88
	89	/* RTAS event disposition */
	90	#define RTAS_DISP_FULLY_RECOVERED 0x0
	91	#define RTAS_DISP_LIMITED_RECOVERY 0x1
	92	#define RTAS_DISP_NOT_RECOVERED 0x2
	93
	94	/* RTAS event initiator */
	95	#define RTAS_INITIATOR_UNKNOWN 0x0
	96	#define RTAS_INITIATOR_CPU 0x1
	97	#define RTAS_INITIATOR_PCI 0x2
	98	#define RTAS_INITIATOR_ISA 0x3
	99	#define RTAS_INITIATOR_MEMORY 0x4
	100	#define RTAS_INITIATOR_POWERMGM 0x5
	101
	102	/* RTAS event target */
	103	#define RTAS_TARGET_UNKNOWN 0x0
	104	#define RTAS_TARGET_CPU 0x1
	105	#define RTAS_TARGET_PCI 0x2
	106	#define RTAS_TARGET_ISA 0x3
	107	#define RTAS_TARGET_MEMORY 0x4
	108	#define RTAS_TARGET_POWERMGM 0x5
	109
	110	/* RTAS event type */
	111	#define RTAS_TYPE_RETRY 0x01
	112	#define RTAS_TYPE_TCE_ERR 0x02
	113	#define RTAS_TYPE_INTERN_DEV_FAIL 0x03
	114	#define RTAS_TYPE_TIMEOUT 0x04
	115	#define RTAS_TYPE_DATA_PARITY 0x05
	116	#define RTAS_TYPE_ADDR_PARITY 0x06
	117	#define RTAS_TYPE_CACHE_PARITY 0x07
	118	#define RTAS_TYPE_ADDR_INVALID 0x08
	119	#define RTAS_TYPE_ECC_UNCORR 0x09
	120	#define RTAS_TYPE_ECC_CORR 0x0a
	121	#define RTAS_TYPE_EPOW 0x40
	122	#define RTAS_TYPE_PLATFORM 0xE0
	123	#define RTAS_TYPE_IO 0xE1
	124	#define RTAS_TYPE_INFO 0xE2
	125	#define RTAS_TYPE_DEALLOC 0xE3
	126	#define RTAS_TYPE_DUMP 0xE4
	127	/* I don't add PowerMGM events right now, this is a different topic */
	128	#define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
	129	#define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
	130	#define RTAS_TYPE_PMGM_LID_OPEN 0x62
	131	#define RTAS_TYPE_PMGM_LID_CLOSE 0x63
	132	#define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
	133	#define RTAS_TYPE_PMGM_WAKE_BTN 0x65
	134	#define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
	135	#define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
	136	#define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
	137	#define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
	138	#define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
	139	#define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
	140	#define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
	141	#define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
	142	#define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
	143	#define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
144	#define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
145	#define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
49c68a85 JL	146	/* Platform Resource Reassignment Notification */
49c68a85 JL	147	#define RTAS_TYPE_PRRN 0xA0
9b6b563c	148
b08e281b MN	149	/* RTAS check-exception vector offset */
	150	#define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500
	151
9b6b563c PM	152	struct rtas_error_log {
	153	unsigned long version:8; /* Architectural version */
	154	unsigned long severity:3; /* Severity level of error */
	155	unsigned long disposition:2; /* Degree of recovery */
	156	unsigned long extended:1; /* extended log present? */
	157	unsigned long /* reserved / :2; / Reserved for future use */
	158	unsigned long initiator:4; /* Initiator of event */
	159	unsigned long target:4; /* Target of failed operation */
	160	unsigned long type:8; /* General event or error*/
	161	unsigned long extended_log_length:32; /* length in bytes */
4cb46380 THFL	162	unsigned char buffer[1]; /* Start of extended log */
	163	/* Variable length. */
	164	};
	165
	166	#define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
	167
	168	#define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) \| ('B' << 16) \| ('M' << 8))
	169
	170	/* RTAS general extended event log, Version 6. The extended log starts
	171	* from "buffer" field of struct rtas_error_log defined above.
	172	*/
	173	struct rtas_ext_event_log_v6 {
	174	/* Byte 0 */
	175	uint32_t log_valid:1; /* 1:Log valid */
	176	uint32_t unrecoverable_error:1; /* 1:Unrecoverable error */
	177	uint32_t recoverable_error:1; /* 1:recoverable (correctable */
	178	/* or successfully retried) */
	179	uint32_t degraded_operation:1; /* 1:Unrecoverable err, bypassed*/
	180	/* - degraded operation (e.g. */
	181	/* CPU or mem taken off-line) */
	182	uint32_t predictive_error:1;
	183	uint32_t new_log:1; /* 1:"New" log (Always 1 for */
	184	/* data returned from RTAS */
	185	uint32_t big_endian:1; /* 1: Big endian */
	186	uint32_t :1; /* reserved */
	187	/* Byte 1 */
	188	uint32_t :8; /* reserved */
	189	/* Byte 2 */
	190	uint32_t powerpc_format:1; /* Set to 1 (indicating log is */
	191	/* in PowerPC format */
	192	uint32_t :3; /* reserved */
	193	uint32_t log_format:4; /* Log format indicator. Define */
	194	/* format used for byte 12-2047 */
	195	/* Byte 3 */
	196	uint32_t :8; /* reserved */
	197	/* Byte 4-11 */
	198	uint8_t reserved[8]; /* reserved */
	199	/* Byte 12-15 */
	200	uint32_t company_id; /* Company ID of the company */
	201	/* that defines the format for */
	202	/* the vendor specific log type */
	203	/* Byte 16-end of log */
	204	uint8_t vendor_log[1]; /* Start of vendor specific log */
	205	/* Variable length. */
9b6b563c PM	206	};
9b6b563c PM	207
6431f208 AB	208	/* pSeries event log format */
	209
	210	/* Two bytes ASCII section IDs */
	211	#define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) \| 'H')
	212	#define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) \| 'H')
	213	#define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) \| 'S')
	214	#define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) \| 'H')
	215	#define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) \| 'T')
	216	#define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) \| 'S')
	217	#define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) \| 'H')
	218	#define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) \| 'W')
	219	#define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) \| 'P')
	220	#define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) \| 'R')
	221	#define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) \| 'M')
	222	#define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) \| 'P')
	223	#define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) \| 'E')
	224	#define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) \| 'I')
	225	#define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) \| 'H')
	226	#define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) \| 'D')
	227
	228	/* Vendor specific Platform Event Log Format, Version 6, section header */
	229	struct pseries_errorlog {
	230	uint16_t id; /* 0x00 2-byte ASCII section ID */
	231	uint16_t length; /* 0x02 Section length in bytes */
	232	uint8_t version; /* 0x04 Section version */
	233	uint8_t subtype; /* 0x05 Section subtype */
	234	uint16_t creator_component; /* 0x06 Creator component ID */
	235	uint8_t data[]; /* 0x08 Start of section data */
	236	};
	237
	238	struct pseries_errorlog get_pseries_errorlog(struct rtas_error_log log,
	239	uint16_t section_id);
	240
f4fcbbe9 PM	241	/*
	242	* This can be set by the rtas_flash module so that it can get called
	243	* as the absolutely last thing before the kernel terminates.
9b6b563c	244	*/
f4fcbbe9	245	extern void (*rtas_flash_term_hook)(int);
9b6b563c PM	246
	247	extern struct rtas_t rtas;
	248
	249	extern void enter_rtas(unsigned long);
	250	extern int rtas_token(const char *service);
f2d6d2d8	251	extern int rtas_service_present(const char *service);
9b6b563c	252	extern int rtas_call(int token, int, int, int *, ...);
9b6b563c PM	253	extern void rtas_restart(char *cmd);
	254	extern void rtas_power_off(void);
	255	extern void rtas_halt(void);
8f515061	256	extern void rtas_os_term(char *str);
9b6b563c PM	257	extern int rtas_get_sensor(int sensor, int index, int *state);
	258	extern int rtas_get_power_level(int powerdomain, int *level);
	259	extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
edc72ac4	260	extern bool rtas_indicator_present(int token, int *maxindex);
9b6b563c	261	extern int rtas_set_indicator(int indicator, int index, int new_value);
81b73dd9	262	extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
9b6b563c PM	263	extern void rtas_progress(char *s, unsigned short hex);
9b6b563c PM	264	extern void rtas_initialize(void);
8fe93f8d BK	265	extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
8fe93f8d BK	266	extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
d8862be1	267	extern int rtas_ibm_suspend_me(struct rtas_args *);
9b6b563c PM	268
9b6b563c PM	269	struct rtc_time;
143a1dec	270	extern unsigned long rtas_get_boot_time(void);
9b6b563c PM	271	extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
	272	extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
	273
507279db JR	274	extern unsigned int rtas_busy_delay_time(int status);
507279db JR	275	extern unsigned int rtas_busy_delay(int status);
9b6b563c	276
458148c0 ME	277	extern int early_init_dt_scan_rtas(unsigned long node,
	278	const char uname, int depth, void data);
	279
9b6b563c PM	280	extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
9b6b563c PM	281
762ec157 NF	282	#ifdef CONFIG_PPC_PSERIES
	283	extern int pseries_devicetree_update(s32 scope);
	284	#endif
	285
df17f56d RN	286	#ifdef CONFIG_PPC_RTAS_DAEMON
	287	extern void rtas_cancel_event_scan(void);
	288	#else
	289	static inline void rtas_cancel_event_scan(void) { }
	290	#endif
	291
9b6b563c PM	292	/* Error types logged. */
	293	#define ERR_FLAG_ALREADY_LOGGED 0x0
	294	#define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
	295	#define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
6c493685 JK	296	#define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */
6c493685 JK	297	#define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */
9b6b563c PM	298
9b6b563c PM	299	/* All the types and not flags */
6c493685 JK	300	#define ERR_TYPE_MASK \
6c493685 JK	301	(ERR_TYPE_RTAS_LOG \| ERR_TYPE_KERNEL_PANIC \| ERR_TYPE_KERNEL_PANIC_GZ)
9b6b563c PM	302
	303	#define RTAS_DEBUG KERN_DEBUG "RTAS: "
	304
	305	#define RTAS_ERROR_LOG_MAX 2048
	306
	307	/*
	308	* Return the firmware-specified size of the error log buffer
	309	* for all rtas calls that require an error buffer argument.
	310	* This includes 'check-exception' and 'rtas-last-error'.
	311	*/
	312	extern int rtas_get_error_log_max(void);
	313
	314	/* Event Scan Parameters */
	315	#define EVENT_SCAN_ALL_EVENTS 0xf0000000
	316	#define SURVEILLANCE_TOKEN 9000
	317	#define LOG_NUMBER 64 /* must be a power of two */
	318	#define LOG_NUMBER_MASK (LOG_NUMBER-1)
	319
	320	/* Some RTAS ops require a data buffer and that buffer must be < 4G.
	321	* Rather than having a memory allocator, just use this buffer
	322	* (get the lock first), make the RTAS call. Copy the data instead
	323	* of holding the buffer for long.
	324	*/
	325
	326	#define RTAS_DATA_BUF_SIZE 4096
	327	extern spinlock_t rtas_data_buf_lock;
	328	extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
	329
9b6b563c PM	330	/* RMO buffer reserved for user-space RTAS use */
	331	extern unsigned long rtas_rmo_buf;
	332
	333	#define GLOBAL_INTERRUPT_QUEUE 9005
	334
6f3d5d3c ME	335	/**
	336	* rtas_config_addr - Format a busno, devfn and reg for RTAS.
	337	* @busno: The bus number.
	338	* @devfn: The device and function number as encoded by PCI_DEVFN().
	339	* @reg: The register number.
	340	*
	341	* This function encodes the given busno, devfn and register number as
	342	* required for RTAS calls that take a "config_addr" parameter.
	343	* See PAPR requirement 7.3.4-1 for more info.
	344	*/
	345	static inline u32 rtas_config_addr(int busno, int devfn, int reg)
	346	{
	347	return ((reg & 0xf00) << 20) \| ((busno & 0xff) << 16) \|
	348	(devfn << 8) \| (reg & 0xff);
	349	}
	350
c4007a2f BH	351	extern void __cpuinit rtas_give_timebase(void);
	352	extern void __cpuinit rtas_take_timebase(void);
	353
8a3e3d31	354	#ifdef CONFIG_PPC_RTAS
	355	static inline int page_is_rtas_user_buf(unsigned long pfn)
	356	{
	357	unsigned long paddr = (pfn << PAGE_SHIFT);
	358	if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
	359	return 1;
	360	return 0;
	361	}
f459d63e NF	362
	363	/* Not the best place to put pSeries_coalesce_init, will be fixed when we
	364	* move some of the rtas suspend-me stuff to pseries */
	365	extern void pSeries_coalesce_init(void);
8a3e3d31	366	#else
8a3e3d31	367	static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
f459d63e	368	static inline void pSeries_coalesce_init(void) { }
8a3e3d31	369	#endif
8a3e3d31	370
ae3a197e DH	371	extern int call_rtas(const char , int, int, unsigned long , ...);
ae3a197e DH	372
88ced031	373	#endif /* __KERNEL__ */
9b6b563c	374	#endif /* _POWERPC_RTAS_H */