[linux-2.6-block.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>
#include <linux/time.h>
#include <linux/cpumask.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 __be32 rtas_arg_t;

struct rtas_args {
	__be32 token;
	__be32 nargs;
	__be32 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
#define RTAS_TYPE_HOTPLUG		0xE5
/* 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 {
	/* Byte 0 */
	uint8_t		byte0;			/* Architectural version */

	/* Byte 1 */
	uint8_t		byte1;
	/* XXXXXXXX
	 * XXX		3: Severity level of error
	 *    XX	2: Degree of recovery
	 *      X	1: Extended log present?
	 *       XX	2: Reserved
	 */

	/* Byte 2 */
	uint8_t		byte2;
	/* XXXXXXXX
	 * XXXX		4: Initiator of event
	 *     XXXX	4: Target of failed operation
	 */
	uint8_t		byte3;			/* General event or error*/
	__be32		extended_log_length;	/* length in bytes */
	unsigned char	buffer[1];		/* Start of extended log */
						/* Variable length.      */
};

static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
{
	return (elog->byte1 & 0xE0) >> 5;
}

static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
{
	return (elog->byte1 & 0x18) >> 3;
}

static inline
void rtas_set_disposition_recovered(struct rtas_error_log *elog)
{
	elog->byte1 &= ~0x18;
	elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
}

static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
{
	return (elog->byte1 & 0x04) >> 2;
}

static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
{
	return (elog->byte2 & 0xf0) >> 4;
}

#define rtas_error_type(x)	((x)->byte3)

static inline
uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
{
	return be32_to_cpu(elog->extended_log_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 */
	uint8_t byte0;
	/* XXXXXXXX
	 * X		1: Log valid
	 *  X		1: Unrecoverable error
	 *   X		1: Recoverable (correctable or successfully retried)
	 *    X		1: Bypassed unrecoverable error (degraded operation)
	 *     X	1: Predictive error
	 *      X	1: "New" log (always 1 for data returned from RTAS)
	 *       X	1: Big Endian
	 *        X	1: Reserved
	 */

	/* Byte 1 */
	uint8_t byte1;			/* reserved */

	/* Byte 2 */
	uint8_t byte2;
	/* XXXXXXXX
	 * X		1: Set to 1 (indicating log is in PowerPC format)
	 *  XXX		3: Reserved
	 *     XXXX	4: Log format used for bytes 12-2047
	 */

	/* Byte 3 */
	uint8_t byte3;			/* reserved */
	/* Byte 4-11 */
	uint8_t reserved[8];		/* reserved */
	/* Byte 12-15 */
	__be32  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.		*/
};

static
inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
{
	return ext_log->byte2 & 0x0F;
}

static
inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
{
	return be32_to_cpu(ext_log->company_id);
}

/* 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')
#define PSERIES_ELOG_SECT_ID_HOTPLUG		(('H' << 8) | 'P')
#define PSERIES_ELOG_SECT_ID_MCE		(('M' << 8) | 'C')

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

static
inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
{
	return be16_to_cpu(sect->id);
}

static
inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
{
	return be16_to_cpu(sect->length);
}

/* RTAS pseries hotplug errorlog section */
struct pseries_hp_errorlog {
	u8	resource;
	u8	action;
	u8	id_type;
	u8	reserved;
	union {
		__be32	drc_index;
		__be32	drc_count;
		struct { __be32 count, index; } ic;
		char	drc_name[1];
	} _drc_u;
};

#define PSERIES_HP_ELOG_RESOURCE_CPU	1
#define PSERIES_HP_ELOG_RESOURCE_MEM	2
#define PSERIES_HP_ELOG_RESOURCE_SLOT	3
#define PSERIES_HP_ELOG_RESOURCE_PHB	4
#define PSERIES_HP_ELOG_RESOURCE_PMEM   6

#define PSERIES_HP_ELOG_ACTION_ADD	1
#define PSERIES_HP_ELOG_ACTION_REMOVE	2
#define PSERIES_HP_ELOG_ACTION_READD	3

#define PSERIES_HP_ELOG_ID_DRC_NAME	1
#define PSERIES_HP_ELOG_ID_DRC_INDEX	2
#define PSERIES_HP_ELOG_ID_DRC_COUNT	3
#define PSERIES_HP_ELOG_ID_DRC_IC	4

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 int rtas_token(const char *service);
extern int rtas_service_present(const char *service);
extern int rtas_call(int token, int, int, int *, ...);
void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
			int nret, ...);
extern void __noreturn rtas_restart(char *cmd);
extern void rtas_power_off(void);
extern void __noreturn 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_sensor_fast(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 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_online_cpus_mask(cpumask_var_t cpus);
extern int rtas_offline_cpus_mask(cpumask_var_t cpus);
extern int rtas_ibm_suspend_me(u64 handle);

struct rtc_time;
extern time64_t 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 time64_t last_rtas_event;
extern int clobbering_unread_rtas_event(void);
extern int pseries_devicetree_update(s32 scope);
extern void post_mobility_fixup(void);
#else
static inline int clobbering_unread_rtas_event(void) { return 0; }
#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 rtas_give_timebase(void);
extern void 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);
void rtas_initialize(void);
#else
static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
static inline void pSeries_coalesce_init(void) { }
static inline void rtas_initialize(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>
e4a9616c	7	#include <linux/time.h>
8dce6b22	8	#include <linux/cpumask.h>
9b6b563c PM	9
	10	/*
	11	* Definitions for talking to the RTAS on CHRP machines.
	12	*
	13	* Copyright (C) 2001 Peter Bergner
	14	* Copyright (C) 2001 PPC 64 Team, IBM Corp
	15	*
	16	* This program is free software; you can redistribute it and/or
	17	* modify it under the terms of the GNU General Public License
	18	* as published by the Free Software Foundation; either version
	19	* 2 of the License, or (at your option) any later version.
	20	*/
	21
	22	#define RTAS_UNKNOWN_SERVICE (-1)
fe333321	23	#define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
9b6b563c PM	24
	25	/* Buffer size for ppc_rtas system call. */
	26	#define RTAS_RMOBUF_MAX (64 * 1024)
	27
	28	/* RTAS return status codes */
368a6ba5	29	#define RTAS_NOT_SUSPENDABLE -9004
9b6b563c PM	30	#define RTAS_BUSY -2 /* RTAS Busy */
	31	#define RTAS_EXTENDED_DELAY_MIN 9900
	32	#define RTAS_EXTENDED_DELAY_MAX 9905
	33
	34	/*
	35	* In general to call RTAS use rtas_token("string") to lookup
	36	* an RTAS token for the given string (e.g. "event-scan").
	37	* To actually perform the call use
	38	* ret = rtas_call(token, n_in, n_out, ...)
	39	* Where n_in is the number of input parameters and
	40	* n_out is the number of output parameters
	41	*
	42	* If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
	43	* will be returned as a token. rtas_call() does look for this
	44	* token and error out gracefully so rtas_call(rtas_token("str"), ...)
	45	* may be safely used for one-shot calls to RTAS.
	46	*
	47	*/
	48
27128264	49	typedef __be32 rtas_arg_t;
9b6b563c PM	50
9b6b563c PM	51	struct rtas_args {
27128264 AB	52	__be32 token;
	53	__be32 nargs;
	54	__be32 nret;
9b6b563c PM	55	rtas_arg_t args[16];
	56	rtas_arg_t rets; / Pointer to return values in args[]. */
	57	};
	58
9b6b563c PM	59	struct rtas_t {
	60	unsigned long entry; /* physical address pointer */
	61	unsigned long base; /* physical address pointer */
	62	unsigned long size;
445c8951	63	arch_spinlock_t lock;
9b6b563c PM	64	struct rtas_args args;
	65	struct device_node dev; / virtual address pointer */
	66	};
	67
8fe93f8d BK	68	struct rtas_suspend_me_data {
	69	atomic_t working; /* number of cpus accessing this struct */
	70	atomic_t done;
	71	int token; /* ibm,suspend-me */
	72	atomic_t error;
	73	struct completion complete; / wait on this until working == 0 */
	74	};
	75
9b6b563c PM	76	/* RTAS event classes */
	77	#define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
	78	#define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
9b6b563c	79	#define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
4a9f9506 AB	80	#define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */
4a9f9506 AB	81	#define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff
9b6b563c PM	82
	83	/* RTAS event severity */
	84	#define RTAS_SEVERITY_FATAL 0x5
	85	#define RTAS_SEVERITY_ERROR 0x4
	86	#define RTAS_SEVERITY_ERROR_SYNC 0x3
	87	#define RTAS_SEVERITY_WARNING 0x2
	88	#define RTAS_SEVERITY_EVENT 0x1
	89	#define RTAS_SEVERITY_NO_ERROR 0x0
	90
	91	/* RTAS event disposition */
	92	#define RTAS_DISP_FULLY_RECOVERED 0x0
	93	#define RTAS_DISP_LIMITED_RECOVERY 0x1
	94	#define RTAS_DISP_NOT_RECOVERED 0x2
	95
	96	/* RTAS event initiator */
	97	#define RTAS_INITIATOR_UNKNOWN 0x0
	98	#define RTAS_INITIATOR_CPU 0x1
	99	#define RTAS_INITIATOR_PCI 0x2
	100	#define RTAS_INITIATOR_ISA 0x3
	101	#define RTAS_INITIATOR_MEMORY 0x4
	102	#define RTAS_INITIATOR_POWERMGM 0x5
	103
	104	/* RTAS event target */
	105	#define RTAS_TARGET_UNKNOWN 0x0
	106	#define RTAS_TARGET_CPU 0x1
	107	#define RTAS_TARGET_PCI 0x2
	108	#define RTAS_TARGET_ISA 0x3
	109	#define RTAS_TARGET_MEMORY 0x4
	110	#define RTAS_TARGET_POWERMGM 0x5
	111
	112	/* RTAS event type */
	113	#define RTAS_TYPE_RETRY 0x01
	114	#define RTAS_TYPE_TCE_ERR 0x02
	115	#define RTAS_TYPE_INTERN_DEV_FAIL 0x03
	116	#define RTAS_TYPE_TIMEOUT 0x04
	117	#define RTAS_TYPE_DATA_PARITY 0x05
	118	#define RTAS_TYPE_ADDR_PARITY 0x06
	119	#define RTAS_TYPE_CACHE_PARITY 0x07
	120	#define RTAS_TYPE_ADDR_INVALID 0x08
	121	#define RTAS_TYPE_ECC_UNCORR 0x09
	122	#define RTAS_TYPE_ECC_CORR 0x0a
	123	#define RTAS_TYPE_EPOW 0x40
	124	#define RTAS_TYPE_PLATFORM 0xE0
	125	#define RTAS_TYPE_IO 0xE1
	126	#define RTAS_TYPE_INFO 0xE2
	127	#define RTAS_TYPE_DEALLOC 0xE3
	128	#define RTAS_TYPE_DUMP 0xE4
4c5d87db	129	#define RTAS_TYPE_HOTPLUG 0xE5
9b6b563c PM	130	/* I don't add PowerMGM events right now, this is a different topic */
	131	#define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
	132	#define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
	133	#define RTAS_TYPE_PMGM_LID_OPEN 0x62
	134	#define RTAS_TYPE_PMGM_LID_CLOSE 0x63
	135	#define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
	136	#define RTAS_TYPE_PMGM_WAKE_BTN 0x65
	137	#define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
	138	#define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
	139	#define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
	140	#define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
	141	#define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
	142	#define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
	143	#define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
	144	#define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
	145	#define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
	146	#define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
	147	#define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
	148	#define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
49c68a85 JL	149	/* Platform Resource Reassignment Notification */
49c68a85 JL	150	#define RTAS_TYPE_PRRN 0xA0
9b6b563c	151
b08e281b MN	152	/* RTAS check-exception vector offset */
	153	#define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500
	154
9b6b563c	155	struct rtas_error_log {
a08a53ea GK	156	/* Byte 0 */
	157	uint8_t byte0; /* Architectural version */
	158
	159	/* Byte 1 */
	160	uint8_t byte1;
	161	/* XXXXXXXX
	162	* XXX 3: Severity level of error
	163	* XX 2: Degree of recovery
	164	* X 1: Extended log present?
	165	* XX 2: Reserved
	166	*/
	167
	168	/* Byte 2 */
	169	uint8_t byte2;
	170	/* XXXXXXXX
	171	* XXXX 4: Initiator of event
	172	* XXXX 4: Target of failed operation
	173	*/
	174	uint8_t byte3; /* General event or error*/
	175	__be32 extended_log_length; /* length in bytes */
	176	unsigned char buffer[1]; /* Start of extended log */
4cb46380 THFL	177	/* Variable length. */
	178	};
	179
a08a53ea GK	180	static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
	181	{
	182	return (elog->byte1 & 0xE0) >> 5;
	183	}
	184
	185	static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
	186	{
	187	return (elog->byte1 & 0x18) >> 3;
	188	}
	189
04fce21c MS	190	static inline
	191	void rtas_set_disposition_recovered(struct rtas_error_log *elog)
	192	{
	193	elog->byte1 &= ~0x18;
	194	elog->byte1 \|= (RTAS_DISP_FULLY_RECOVERED << 3);
	195	}
	196
a08a53ea GK	197	static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
	198	{
	199	return (elog->byte1 & 0x04) >> 2;
	200	}
	201
8f0b8056 MS	202	static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
	203	{
	204	return (elog->byte2 & 0xf0) >> 4;
	205	}
	206
a08a53ea GK	207	#define rtas_error_type(x) ((x)->byte3)
	208
	209	static inline
	210	uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
	211	{
	212	return be32_to_cpu(elog->extended_log_length);
	213	}
	214
4cb46380 THFL	215	#define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
	216
	217	#define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) \| ('B' << 16) \| ('M' << 8))
	218
	219	/* RTAS general extended event log, Version 6. The extended log starts
	220	* from "buffer" field of struct rtas_error_log defined above.
	221	*/
	222	struct rtas_ext_event_log_v6 {
	223	/* Byte 0 */
a08a53ea GK	224	uint8_t byte0;
	225	/* XXXXXXXX
	226	* X 1: Log valid
	227	* X 1: Unrecoverable error
	228	* X 1: Recoverable (correctable or successfully retried)
	229	* X 1: Bypassed unrecoverable error (degraded operation)
	230	* X 1: Predictive error
	231	* X 1: "New" log (always 1 for data returned from RTAS)
	232	* X 1: Big Endian
	233	* X 1: Reserved
	234	*/
	235
4cb46380	236	/* Byte 1 */
a08a53ea GK	237	uint8_t byte1; /* reserved */
a08a53ea GK	238
4cb46380	239	/* Byte 2 */
a08a53ea GK	240	uint8_t byte2;
	241	/* XXXXXXXX
	242	* X 1: Set to 1 (indicating log is in PowerPC format)
	243	* XXX 3: Reserved
	244	* XXXX 4: Log format used for bytes 12-2047
	245	*/
	246
4cb46380	247	/* Byte 3 */
a08a53ea	248	uint8_t byte3; /* reserved */
4cb46380 THFL	249	/* Byte 4-11 */
	250	uint8_t reserved[8]; /* reserved */
	251	/* Byte 12-15 */
a08a53ea	252	__be32 company_id; /* Company ID of the company */
4cb46380 THFL	253	/* that defines the format for */
	254	/* the vendor specific log type */
	255	/* Byte 16-end of log */
	256	uint8_t vendor_log[1]; /* Start of vendor specific log */
	257	/* Variable length. */
9b6b563c PM	258	};
9b6b563c PM	259
a08a53ea GK	260	static
	261	inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
	262	{
	263	return ext_log->byte2 & 0x0F;
	264	}
	265
	266	static
	267	inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
	268	{
	269	return be32_to_cpu(ext_log->company_id);
	270	}
	271
6431f208 AB	272	/* pSeries event log format */
	273
	274	/* Two bytes ASCII section IDs */
	275	#define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) \| 'H')
	276	#define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) \| 'H')
	277	#define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) \| 'S')
	278	#define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) \| 'H')
	279	#define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) \| 'T')
	280	#define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) \| 'S')
	281	#define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) \| 'H')
	282	#define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) \| 'W')
	283	#define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) \| 'P')
	284	#define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) \| 'R')
	285	#define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) \| 'M')
	286	#define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) \| 'P')
	287	#define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) \| 'E')
	288	#define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) \| 'I')
	289	#define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) \| 'H')
	290	#define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) \| 'D')
366d395c	291	#define PSERIES_ELOG_SECT_ID_HOTPLUG (('H' << 8) \| 'P')
04fce21c	292	#define PSERIES_ELOG_SECT_ID_MCE (('M' << 8) \| 'C')
6431f208 AB	293
	294	/* Vendor specific Platform Event Log Format, Version 6, section header */
	295	struct pseries_errorlog {
a08a53ea GK	296	__be16 id; /* 0x00 2-byte ASCII section ID */
a08a53ea GK	297	__be16 length; /* 0x02 Section length in bytes */
6431f208 AB	298	uint8_t version; /* 0x04 Section version */
6431f208 AB	299	uint8_t subtype; /* 0x05 Section subtype */
a08a53ea	300	__be16 creator_component; /* 0x06 Creator component ID */
6431f208 AB	301	uint8_t data[]; /* 0x08 Start of section data */
	302	};
	303
a08a53ea GK	304	static
	305	inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
	306	{
	307	return be16_to_cpu(sect->id);
	308	}
	309
	310	static
	311	inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
	312	{
	313	return be16_to_cpu(sect->length);
	314	}
	315
366d395c NF	316	/* RTAS pseries hotplug errorlog section */
	317	struct pseries_hp_errorlog {
	318	u8 resource;
	319	u8 action;
	320	u8 id_type;
	321	u8 reserved;
	322	union {
	323	__be32 drc_index;
	324	__be32 drc_count;
333f7b76	325	struct { __be32 count, index; } ic;
366d395c NF	326	char drc_name[1];
	327	} _drc_u;
	328	};
	329
	330	#define PSERIES_HP_ELOG_RESOURCE_CPU 1
	331	#define PSERIES_HP_ELOG_RESOURCE_MEM 2
	332	#define PSERIES_HP_ELOG_RESOURCE_SLOT 3
	333	#define PSERIES_HP_ELOG_RESOURCE_PHB 4
4c5d87db	334	#define PSERIES_HP_ELOG_RESOURCE_PMEM 6
366d395c NF	335
	336	#define PSERIES_HP_ELOG_ACTION_ADD 1
	337	#define PSERIES_HP_ELOG_ACTION_REMOVE 2
e70d5970	338	#define PSERIES_HP_ELOG_ACTION_READD 3
366d395c NF	339
	340	#define PSERIES_HP_ELOG_ID_DRC_NAME 1
	341	#define PSERIES_HP_ELOG_ID_DRC_INDEX 2
	342	#define PSERIES_HP_ELOG_ID_DRC_COUNT 3
333f7b76	343	#define PSERIES_HP_ELOG_ID_DRC_IC 4
366d395c	344
6431f208 AB	345	struct pseries_errorlog get_pseries_errorlog(struct rtas_error_log log,
	346	uint16_t section_id);
	347
f4fcbbe9 PM	348	/*
	349	* This can be set by the rtas_flash module so that it can get called
	350	* as the absolutely last thing before the kernel terminates.
9b6b563c	351	*/
f4fcbbe9	352	extern void (*rtas_flash_term_hook)(int);
9b6b563c PM	353
	354	extern struct rtas_t rtas;
	355
9b6b563c	356	extern int rtas_token(const char *service);
f2d6d2d8	357	extern int rtas_service_present(const char *service);
9b6b563c	358	extern int rtas_call(int token, int, int, int *, ...);
209eb4e5 ME	359	void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
209eb4e5 ME	360	int nret, ...);
95ec77c0	361	extern void __noreturn rtas_restart(char *cmd);
9b6b563c	362	extern void rtas_power_off(void);
95ec77c0	363	extern void __noreturn rtas_halt(void);
8f515061	364	extern void rtas_os_term(char *str);
9b6b563c	365	extern int rtas_get_sensor(int sensor, int index, int *state);
1c2cb594	366	extern int rtas_get_sensor_fast(int sensor, int index, int *state);
9b6b563c PM	367	extern int rtas_get_power_level(int powerdomain, int *level);
9b6b563c PM	368	extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
edc72ac4	369	extern bool rtas_indicator_present(int token, int *maxindex);
9b6b563c	370	extern int rtas_set_indicator(int indicator, int index, int new_value);
81b73dd9	371	extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
9b6b563c	372	extern void rtas_progress(char *s, unsigned short hex);
8fe93f8d BK	373	extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
8fe93f8d BK	374	extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
120496ac RJ	375	extern int rtas_online_cpus_mask(cpumask_var_t cpus);
120496ac RJ	376	extern int rtas_offline_cpus_mask(cpumask_var_t cpus);
c03e7374	377	extern int rtas_ibm_suspend_me(u64 handle);
9b6b563c PM	378
9b6b563c PM	379	struct rtc_time;
5bfd6435	380	extern time64_t rtas_get_boot_time(void);
9b6b563c PM	381	extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
	382	extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
	383
507279db JR	384	extern unsigned int rtas_busy_delay_time(int status);
507279db JR	385	extern unsigned int rtas_busy_delay(int status);
9b6b563c	386
458148c0 ME	387	extern int early_init_dt_scan_rtas(unsigned long node,
	388	const char uname, int depth, void data);
	389
9b6b563c PM	390	extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
9b6b563c PM	391
762ec157	392	#ifdef CONFIG_PPC_PSERIES
e4a9616c	393	extern time64_t last_rtas_event;
78989f0a	394	extern int clobbering_unread_rtas_event(void);
762ec157	395	extern int pseries_devicetree_update(s32 scope);
6b36ba84	396	extern void post_mobility_fixup(void);
78989f0a HB	397	#else
78989f0a HB	398	static inline int clobbering_unread_rtas_event(void) { return 0; }
762ec157 NF	399	#endif
762ec157 NF	400
df17f56d RN	401	#ifdef CONFIG_PPC_RTAS_DAEMON
	402	extern void rtas_cancel_event_scan(void);
	403	#else
	404	static inline void rtas_cancel_event_scan(void) { }
	405	#endif
	406
9b6b563c PM	407	/* Error types logged. */
	408	#define ERR_FLAG_ALREADY_LOGGED 0x0
	409	#define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
	410	#define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
6c493685 JK	411	#define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */
6c493685 JK	412	#define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */
9b6b563c PM	413
9b6b563c PM	414	/* All the types and not flags */
6c493685 JK	415	#define ERR_TYPE_MASK \
6c493685 JK	416	(ERR_TYPE_RTAS_LOG \| ERR_TYPE_KERNEL_PANIC \| ERR_TYPE_KERNEL_PANIC_GZ)
9b6b563c PM	417
	418	#define RTAS_DEBUG KERN_DEBUG "RTAS: "
	419
	420	#define RTAS_ERROR_LOG_MAX 2048
	421
	422	/*
	423	* Return the firmware-specified size of the error log buffer
	424	* for all rtas calls that require an error buffer argument.
	425	* This includes 'check-exception' and 'rtas-last-error'.
	426	*/
	427	extern int rtas_get_error_log_max(void);
	428
	429	/* Event Scan Parameters */
	430	#define EVENT_SCAN_ALL_EVENTS 0xf0000000
	431	#define SURVEILLANCE_TOKEN 9000
	432	#define LOG_NUMBER 64 /* must be a power of two */
	433	#define LOG_NUMBER_MASK (LOG_NUMBER-1)
	434
	435	/* Some RTAS ops require a data buffer and that buffer must be < 4G.
	436	* Rather than having a memory allocator, just use this buffer
	437	* (get the lock first), make the RTAS call. Copy the data instead
	438	* of holding the buffer for long.
	439	*/
	440
	441	#define RTAS_DATA_BUF_SIZE 4096
	442	extern spinlock_t rtas_data_buf_lock;
	443	extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
	444
9b6b563c PM	445	/* RMO buffer reserved for user-space RTAS use */
	446	extern unsigned long rtas_rmo_buf;
	447
	448	#define GLOBAL_INTERRUPT_QUEUE 9005
	449
6f3d5d3c ME	450	/**
	451	* rtas_config_addr - Format a busno, devfn and reg for RTAS.
	452	* @busno: The bus number.
	453	* @devfn: The device and function number as encoded by PCI_DEVFN().
	454	* @reg: The register number.
	455	*
	456	* This function encodes the given busno, devfn and register number as
	457	* required for RTAS calls that take a "config_addr" parameter.
	458	* See PAPR requirement 7.3.4-1 for more info.
	459	*/
	460	static inline u32 rtas_config_addr(int busno, int devfn, int reg)
	461	{
	462	return ((reg & 0xf00) << 20) \| ((busno & 0xff) << 16) \|
	463	(devfn << 8) \| (reg & 0xff);
	464	}
	465
061d19f2 PG	466	extern void rtas_give_timebase(void);
061d19f2 PG	467	extern void rtas_take_timebase(void);
c4007a2f	468
8a3e3d31	469	#ifdef CONFIG_PPC_RTAS
	470	static inline int page_is_rtas_user_buf(unsigned long pfn)
	471	{
	472	unsigned long paddr = (pfn << PAGE_SHIFT);
	473	if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
	474	return 1;
	475	return 0;
	476	}
f459d63e NF	477
	478	/* Not the best place to put pSeries_coalesce_init, will be fixed when we
	479	* move some of the rtas suspend-me stuff to pseries */
	480	extern void pSeries_coalesce_init(void);
b1923caa	481	void rtas_initialize(void);
8a3e3d31	482	#else
8a3e3d31	483	static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
f459d63e	484	static inline void pSeries_coalesce_init(void) { }
b1923caa	485	static inline void rtas_initialize(void) { };
8a3e3d31	486	#endif
8a3e3d31	487
ae3a197e DH	488	extern int call_rtas(const char , int, int, unsigned long , ...);
ae3a197e DH	489
88ced031	490	#endif /* __KERNEL__ */
9b6b563c	491	#endif /* _POWERPC_RTAS_H */