xref: /OK3568_Linux_fs/kernel/arch/powerpc/include/asm/nvram.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * NVRAM definitions and access functions.
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun #ifndef _ASM_POWERPC_NVRAM_H
6*4882a593Smuzhiyun #define _ASM_POWERPC_NVRAM_H
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/types.h>
9*4882a593Smuzhiyun #include <linux/errno.h>
10*4882a593Smuzhiyun #include <linux/list.h>
11*4882a593Smuzhiyun #include <uapi/asm/nvram.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /*
14*4882a593Smuzhiyun  * Set oops header version to distinguish between old and new format header.
15*4882a593Smuzhiyun  * lnx,oops-log partition max size is 4000, header version > 4000 will
16*4882a593Smuzhiyun  * help in identifying new header.
17*4882a593Smuzhiyun  */
18*4882a593Smuzhiyun #define OOPS_HDR_VERSION 5000
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun struct err_log_info {
21*4882a593Smuzhiyun 	__be32 error_type;
22*4882a593Smuzhiyun 	__be32 seq_num;
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun struct nvram_os_partition {
26*4882a593Smuzhiyun 	const char *name;
27*4882a593Smuzhiyun 	int req_size;	/* desired size, in bytes */
28*4882a593Smuzhiyun 	int min_size;	/* minimum acceptable size (0 means req_size) */
29*4882a593Smuzhiyun 	long size;	/* size of data portion (excluding err_log_info) */
30*4882a593Smuzhiyun 	long index;	/* offset of data portion of partition */
31*4882a593Smuzhiyun 	bool os_partition; /* partition initialized by OS, not FW */
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun struct oops_log_info {
35*4882a593Smuzhiyun 	__be16 version;
36*4882a593Smuzhiyun 	__be16 report_length;
37*4882a593Smuzhiyun 	__be64 timestamp;
38*4882a593Smuzhiyun } __attribute__((packed));
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun extern struct nvram_os_partition oops_log_partition;
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #ifdef CONFIG_PPC_PSERIES
43*4882a593Smuzhiyun extern struct nvram_os_partition rtas_log_partition;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun extern int nvram_write_error_log(char * buff, int length,
46*4882a593Smuzhiyun 					 unsigned int err_type, unsigned int err_seq);
47*4882a593Smuzhiyun extern int nvram_read_error_log(char * buff, int length,
48*4882a593Smuzhiyun 					 unsigned int * err_type, unsigned int *err_seq);
49*4882a593Smuzhiyun extern int nvram_clear_error_log(void);
50*4882a593Smuzhiyun extern int pSeries_nvram_init(void);
51*4882a593Smuzhiyun #endif /* CONFIG_PPC_PSERIES */
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #ifdef CONFIG_MMIO_NVRAM
54*4882a593Smuzhiyun extern int mmio_nvram_init(void);
55*4882a593Smuzhiyun #else
mmio_nvram_init(void)56*4882a593Smuzhiyun static inline int mmio_nvram_init(void)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun 	return -ENODEV;
59*4882a593Smuzhiyun }
60*4882a593Smuzhiyun #endif
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun extern int __init nvram_scan_partitions(void);
63*4882a593Smuzhiyun extern loff_t nvram_create_partition(const char *name, int sig,
64*4882a593Smuzhiyun 				     int req_size, int min_size);
65*4882a593Smuzhiyun extern int nvram_remove_partition(const char *name, int sig,
66*4882a593Smuzhiyun 					const char *exceptions[]);
67*4882a593Smuzhiyun extern int nvram_get_partition_size(loff_t data_index);
68*4882a593Smuzhiyun extern loff_t nvram_find_partition(const char *name, int sig, int *out_size);
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /* Return partition offset in nvram */
71*4882a593Smuzhiyun extern int	pmac_get_partition(int partition);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun /* Direct access to XPRAM on PowerMacs */
74*4882a593Smuzhiyun extern u8	pmac_xpram_read(int xpaddr);
75*4882a593Smuzhiyun extern void	pmac_xpram_write(int xpaddr, u8 data);
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun /* Initialize NVRAM OS partition */
78*4882a593Smuzhiyun extern int __init nvram_init_os_partition(struct nvram_os_partition *part);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun /* Initialize NVRAM oops partition */
81*4882a593Smuzhiyun extern void __init nvram_init_oops_partition(int rtas_partition_exists);
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun /* Read a NVRAM partition */
84*4882a593Smuzhiyun extern int nvram_read_partition(struct nvram_os_partition *part, char *buff,
85*4882a593Smuzhiyun 				int length, unsigned int *err_type,
86*4882a593Smuzhiyun 				unsigned int *error_log_cnt);
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun /* Write to NVRAM OS partition */
89*4882a593Smuzhiyun extern int nvram_write_os_partition(struct nvram_os_partition *part,
90*4882a593Smuzhiyun 				    char *buff, int length,
91*4882a593Smuzhiyun 				    unsigned int err_type,
92*4882a593Smuzhiyun 				    unsigned int error_log_cnt);
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun #endif /* _ASM_POWERPC_NVRAM_H */
95