12874c5fdSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2437a58dbSPaul Mackerras /*
3437a58dbSPaul Mackerras * c 2001 PPC 64 Team, IBM Corp
4437a58dbSPaul Mackerras *
5437a58dbSPaul Mackerras * /dev/nvram driver for PPC64
6437a58dbSPaul Mackerras */
7437a58dbSPaul Mackerras
8437a58dbSPaul Mackerras #include <linux/types.h>
9437a58dbSPaul Mackerras #include <linux/errno.h>
10437a58dbSPaul Mackerras #include <linux/fs.h>
11437a58dbSPaul Mackerras #include <linux/miscdevice.h>
12437a58dbSPaul Mackerras #include <linux/fcntl.h>
13437a58dbSPaul Mackerras #include <linux/nvram.h>
14437a58dbSPaul Mackerras #include <linux/init.h>
15437a58dbSPaul Mackerras #include <linux/slab.h>
16437a58dbSPaul Mackerras #include <linux/spinlock.h>
1778989f0aSHari Bathini #include <linux/kmsg_dump.h>
18b808b1d6SAl Viro #include <linux/pagemap.h>
1978989f0aSHari Bathini #include <linux/pstore.h>
2078989f0aSHari Bathini #include <linux/zlib.h>
217c0f6ba6SLinus Torvalds #include <linux/uaccess.h>
22*e6f6390aSChristophe Leroy #include <linux/of.h>
23437a58dbSPaul Mackerras #include <asm/nvram.h>
24437a58dbSPaul Mackerras #include <asm/rtas.h>
25437a58dbSPaul Mackerras #include <asm/machdep.h>
26437a58dbSPaul Mackerras
27437a58dbSPaul Mackerras #undef DEBUG_NVRAM
28437a58dbSPaul Mackerras
2936673307SBenjamin Herrenschmidt #define NVRAM_HEADER_LEN sizeof(struct nvram_header)
3036673307SBenjamin Herrenschmidt #define NVRAM_BLOCK_LEN NVRAM_HEADER_LEN
3174d51d02SBenjamin Herrenschmidt
3274d51d02SBenjamin Herrenschmidt /* If change this size, then change the size of NVNAME_LEN */
3374d51d02SBenjamin Herrenschmidt struct nvram_header {
3474d51d02SBenjamin Herrenschmidt unsigned char signature;
3574d51d02SBenjamin Herrenschmidt unsigned char checksum;
3674d51d02SBenjamin Herrenschmidt unsigned short length;
376024ede9SJim Keniston /* Terminating null required only for names < 12 chars. */
3874d51d02SBenjamin Herrenschmidt char name[12];
3974d51d02SBenjamin Herrenschmidt };
4074d51d02SBenjamin Herrenschmidt
4174d51d02SBenjamin Herrenschmidt struct nvram_partition {
4274d51d02SBenjamin Herrenschmidt struct list_head partition;
4374d51d02SBenjamin Herrenschmidt struct nvram_header header;
4474d51d02SBenjamin Herrenschmidt unsigned int index;
4574d51d02SBenjamin Herrenschmidt };
4674d51d02SBenjamin Herrenschmidt
47690d1a9bSJim Keniston static LIST_HEAD(nvram_partitions);
48437a58dbSPaul Mackerras
4978989f0aSHari Bathini #ifdef CONFIG_PPC_PSERIES
5078989f0aSHari Bathini struct nvram_os_partition rtas_log_partition = {
5178989f0aSHari Bathini .name = "ibm,rtas-log",
5278989f0aSHari Bathini .req_size = 2079,
5378989f0aSHari Bathini .min_size = 1055,
5478989f0aSHari Bathini .index = -1,
5578989f0aSHari Bathini .os_partition = true
5678989f0aSHari Bathini };
5778989f0aSHari Bathini #endif
5878989f0aSHari Bathini
5978989f0aSHari Bathini struct nvram_os_partition oops_log_partition = {
6078989f0aSHari Bathini .name = "lnx,oops-log",
6178989f0aSHari Bathini .req_size = 4000,
6278989f0aSHari Bathini .min_size = 2000,
6378989f0aSHari Bathini .index = -1,
6478989f0aSHari Bathini .os_partition = true
6578989f0aSHari Bathini };
6678989f0aSHari Bathini
6778989f0aSHari Bathini static const char *nvram_os_partitions[] = {
6878989f0aSHari Bathini #ifdef CONFIG_PPC_PSERIES
6978989f0aSHari Bathini "ibm,rtas-log",
7078989f0aSHari Bathini #endif
7178989f0aSHari Bathini "lnx,oops-log",
7278989f0aSHari Bathini NULL
7378989f0aSHari Bathini };
7478989f0aSHari Bathini
7578989f0aSHari Bathini static void oops_to_nvram(struct kmsg_dumper *dumper,
7678989f0aSHari Bathini enum kmsg_dump_reason reason);
7778989f0aSHari Bathini
7878989f0aSHari Bathini static struct kmsg_dumper nvram_kmsg_dumper = {
7978989f0aSHari Bathini .dump = oops_to_nvram
8078989f0aSHari Bathini };
8178989f0aSHari Bathini
8278989f0aSHari Bathini /*
8378989f0aSHari Bathini * For capturing and compressing an oops or panic report...
8478989f0aSHari Bathini
8578989f0aSHari Bathini * big_oops_buf[] holds the uncompressed text we're capturing.
8678989f0aSHari Bathini *
8778989f0aSHari Bathini * oops_buf[] holds the compressed text, preceded by a oops header.
8878989f0aSHari Bathini * oops header has u16 holding the version of oops header (to differentiate
8978989f0aSHari Bathini * between old and new format header) followed by u16 holding the length of
9078989f0aSHari Bathini * the compressed* text (*Or uncompressed, if compression fails.) and u64
9178989f0aSHari Bathini * holding the timestamp. oops_buf[] gets written to NVRAM.
9278989f0aSHari Bathini *
9378989f0aSHari Bathini * oops_log_info points to the header. oops_data points to the compressed text.
9478989f0aSHari Bathini *
9578989f0aSHari Bathini * +- oops_buf
9678989f0aSHari Bathini * | +- oops_data
9778989f0aSHari Bathini * v v
9878989f0aSHari Bathini * +-----------+-----------+-----------+------------------------+
9978989f0aSHari Bathini * | version | length | timestamp | text |
10078989f0aSHari Bathini * | (2 bytes) | (2 bytes) | (8 bytes) | (oops_data_sz bytes) |
10178989f0aSHari Bathini * +-----------+-----------+-----------+------------------------+
10278989f0aSHari Bathini * ^
10378989f0aSHari Bathini * +- oops_log_info
10478989f0aSHari Bathini *
10578989f0aSHari Bathini * We preallocate these buffers during init to avoid kmalloc during oops/panic.
10678989f0aSHari Bathini */
10778989f0aSHari Bathini static size_t big_oops_buf_sz;
10878989f0aSHari Bathini static char *big_oops_buf, *oops_buf;
10978989f0aSHari Bathini static char *oops_data;
11078989f0aSHari Bathini static size_t oops_data_sz;
11178989f0aSHari Bathini
11278989f0aSHari Bathini /* Compression parameters */
11378989f0aSHari Bathini #define COMPR_LEVEL 6
11478989f0aSHari Bathini #define WINDOW_BITS 12
11578989f0aSHari Bathini #define MEM_LEVEL 4
11678989f0aSHari Bathini static struct z_stream_s stream;
11778989f0aSHari Bathini
11878989f0aSHari Bathini #ifdef CONFIG_PSTORE
119f7618299SHari Bathini #ifdef CONFIG_PPC_POWERNV
120f7618299SHari Bathini static struct nvram_os_partition skiboot_partition = {
121f7618299SHari Bathini .name = "ibm,skiboot",
122f7618299SHari Bathini .index = -1,
123f7618299SHari Bathini .os_partition = false
124f7618299SHari Bathini };
125f7618299SHari Bathini #endif
126f7618299SHari Bathini
12778989f0aSHari Bathini #ifdef CONFIG_PPC_PSERIES
12878989f0aSHari Bathini static struct nvram_os_partition of_config_partition = {
12978989f0aSHari Bathini .name = "of-config",
13078989f0aSHari Bathini .index = -1,
13178989f0aSHari Bathini .os_partition = false
13278989f0aSHari Bathini };
13378989f0aSHari Bathini #endif
13478989f0aSHari Bathini
13578989f0aSHari Bathini static struct nvram_os_partition common_partition = {
13678989f0aSHari Bathini .name = "common",
13778989f0aSHari Bathini .index = -1,
13878989f0aSHari Bathini .os_partition = false
13978989f0aSHari Bathini };
14078989f0aSHari Bathini
14178989f0aSHari Bathini static enum pstore_type_id nvram_type_ids[] = {
14278989f0aSHari Bathini PSTORE_TYPE_DMESG,
14378989f0aSHari Bathini PSTORE_TYPE_PPC_COMMON,
14478989f0aSHari Bathini -1,
14578989f0aSHari Bathini -1,
14678989f0aSHari Bathini -1
14778989f0aSHari Bathini };
14878989f0aSHari Bathini static int read_type;
14978989f0aSHari Bathini #endif
15078989f0aSHari Bathini
15178989f0aSHari Bathini /* nvram_write_os_partition
15278989f0aSHari Bathini *
15378989f0aSHari Bathini * We need to buffer the error logs into nvram to ensure that we have
15478989f0aSHari Bathini * the failure information to decode. If we have a severe error there
15578989f0aSHari Bathini * is no way to guarantee that the OS or the machine is in a state to
15678989f0aSHari Bathini * get back to user land and write the error to disk. For example if
15778989f0aSHari Bathini * the SCSI device driver causes a Machine Check by writing to a bad
15878989f0aSHari Bathini * IO address, there is no way of guaranteeing that the device driver
15978989f0aSHari Bathini * is in any state that is would also be able to write the error data
16078989f0aSHari Bathini * captured to disk, thus we buffer it in NVRAM for analysis on the
16178989f0aSHari Bathini * next boot.
16278989f0aSHari Bathini *
16378989f0aSHari Bathini * In NVRAM the partition containing the error log buffer will looks like:
16478989f0aSHari Bathini * Header (in bytes):
16578989f0aSHari Bathini * +-----------+----------+--------+------------+------------------+
16678989f0aSHari Bathini * | signature | checksum | length | name | data |
16778989f0aSHari Bathini * |0 |1 |2 3|4 15|16 length-1|
16878989f0aSHari Bathini * +-----------+----------+--------+------------+------------------+
16978989f0aSHari Bathini *
17078989f0aSHari Bathini * The 'data' section would look like (in bytes):
17178989f0aSHari Bathini * +--------------+------------+-----------------------------------+
17278989f0aSHari Bathini * | event_logged | sequence # | error log |
17378989f0aSHari Bathini * |0 3|4 7|8 error_log_size-1|
17478989f0aSHari Bathini * +--------------+------------+-----------------------------------+
17578989f0aSHari Bathini *
17678989f0aSHari Bathini * event_logged: 0 if event has not been logged to syslog, 1 if it has
17778989f0aSHari Bathini * sequence #: The unique sequence # for each event. (until it wraps)
17878989f0aSHari Bathini * error log: The error log from event_scan
17978989f0aSHari Bathini */
nvram_write_os_partition(struct nvram_os_partition * part,char * buff,int length,unsigned int err_type,unsigned int error_log_cnt)18078989f0aSHari Bathini int nvram_write_os_partition(struct nvram_os_partition *part,
18178989f0aSHari Bathini char *buff, int length,
18278989f0aSHari Bathini unsigned int err_type,
18378989f0aSHari Bathini unsigned int error_log_cnt)
18478989f0aSHari Bathini {
18578989f0aSHari Bathini int rc;
18678989f0aSHari Bathini loff_t tmp_index;
18778989f0aSHari Bathini struct err_log_info info;
18878989f0aSHari Bathini
18978989f0aSHari Bathini if (part->index == -1)
19078989f0aSHari Bathini return -ESPIPE;
19178989f0aSHari Bathini
19278989f0aSHari Bathini if (length > part->size)
19378989f0aSHari Bathini length = part->size;
19478989f0aSHari Bathini
19578989f0aSHari Bathini info.error_type = cpu_to_be32(err_type);
19678989f0aSHari Bathini info.seq_num = cpu_to_be32(error_log_cnt);
19778989f0aSHari Bathini
19878989f0aSHari Bathini tmp_index = part->index;
19978989f0aSHari Bathini
200a0828cf5SMarkus Elfring rc = ppc_md.nvram_write((char *)&info, sizeof(info), &tmp_index);
20178989f0aSHari Bathini if (rc <= 0) {
20278989f0aSHari Bathini pr_err("%s: Failed nvram_write (%d)\n", __func__, rc);
20378989f0aSHari Bathini return rc;
20478989f0aSHari Bathini }
20578989f0aSHari Bathini
20678989f0aSHari Bathini rc = ppc_md.nvram_write(buff, length, &tmp_index);
20778989f0aSHari Bathini if (rc <= 0) {
20878989f0aSHari Bathini pr_err("%s: Failed nvram_write (%d)\n", __func__, rc);
20978989f0aSHari Bathini return rc;
21078989f0aSHari Bathini }
21178989f0aSHari Bathini
21278989f0aSHari Bathini return 0;
21378989f0aSHari Bathini }
21478989f0aSHari Bathini
21578989f0aSHari Bathini /* nvram_read_partition
21678989f0aSHari Bathini *
21778989f0aSHari Bathini * Reads nvram partition for at most 'length'
21878989f0aSHari Bathini */
nvram_read_partition(struct nvram_os_partition * part,char * buff,int length,unsigned int * err_type,unsigned int * error_log_cnt)21978989f0aSHari Bathini int nvram_read_partition(struct nvram_os_partition *part, char *buff,
22078989f0aSHari Bathini int length, unsigned int *err_type,
22178989f0aSHari Bathini unsigned int *error_log_cnt)
22278989f0aSHari Bathini {
22378989f0aSHari Bathini int rc;
22478989f0aSHari Bathini loff_t tmp_index;
22578989f0aSHari Bathini struct err_log_info info;
22678989f0aSHari Bathini
22778989f0aSHari Bathini if (part->index == -1)
22878989f0aSHari Bathini return -1;
22978989f0aSHari Bathini
23078989f0aSHari Bathini if (length > part->size)
23178989f0aSHari Bathini length = part->size;
23278989f0aSHari Bathini
23378989f0aSHari Bathini tmp_index = part->index;
23478989f0aSHari Bathini
23578989f0aSHari Bathini if (part->os_partition) {
236a0828cf5SMarkus Elfring rc = ppc_md.nvram_read((char *)&info, sizeof(info), &tmp_index);
23778989f0aSHari Bathini if (rc <= 0) {
23878989f0aSHari Bathini pr_err("%s: Failed nvram_read (%d)\n", __func__, rc);
23978989f0aSHari Bathini return rc;
24078989f0aSHari Bathini }
24178989f0aSHari Bathini }
24278989f0aSHari Bathini
24378989f0aSHari Bathini rc = ppc_md.nvram_read(buff, length, &tmp_index);
24478989f0aSHari Bathini if (rc <= 0) {
24578989f0aSHari Bathini pr_err("%s: Failed nvram_read (%d)\n", __func__, rc);
24678989f0aSHari Bathini return rc;
24778989f0aSHari Bathini }
24878989f0aSHari Bathini
24978989f0aSHari Bathini if (part->os_partition) {
25078989f0aSHari Bathini *error_log_cnt = be32_to_cpu(info.seq_num);
25178989f0aSHari Bathini *err_type = be32_to_cpu(info.error_type);
25278989f0aSHari Bathini }
25378989f0aSHari Bathini
25478989f0aSHari Bathini return 0;
25578989f0aSHari Bathini }
25678989f0aSHari Bathini
25778989f0aSHari Bathini /* nvram_init_os_partition
25878989f0aSHari Bathini *
25978989f0aSHari Bathini * This sets up a partition with an "OS" signature.
26078989f0aSHari Bathini *
26178989f0aSHari Bathini * The general strategy is the following:
26278989f0aSHari Bathini * 1.) If a partition with the indicated name already exists...
26378989f0aSHari Bathini * - If it's large enough, use it.
26478989f0aSHari Bathini * - Otherwise, recycle it and keep going.
26578989f0aSHari Bathini * 2.) Search for a free partition that is large enough.
26678989f0aSHari Bathini * 3.) If there's not a free partition large enough, recycle any obsolete
26778989f0aSHari Bathini * OS partitions and try again.
26878989f0aSHari Bathini * 4.) Will first try getting a chunk that will satisfy the requested size.
26978989f0aSHari Bathini * 5.) If a chunk of the requested size cannot be allocated, then try finding
27078989f0aSHari Bathini * a chunk that will satisfy the minum needed.
27178989f0aSHari Bathini *
27278989f0aSHari Bathini * Returns 0 on success, else -1.
27378989f0aSHari Bathini */
nvram_init_os_partition(struct nvram_os_partition * part)27478989f0aSHari Bathini int __init nvram_init_os_partition(struct nvram_os_partition *part)
27578989f0aSHari Bathini {
27678989f0aSHari Bathini loff_t p;
27778989f0aSHari Bathini int size;
27878989f0aSHari Bathini
27978989f0aSHari Bathini /* Look for ours */
28078989f0aSHari Bathini p = nvram_find_partition(part->name, NVRAM_SIG_OS, &size);
28178989f0aSHari Bathini
28278989f0aSHari Bathini /* Found one but too small, remove it */
28378989f0aSHari Bathini if (p && size < part->min_size) {
28478989f0aSHari Bathini pr_info("nvram: Found too small %s partition,"
28578989f0aSHari Bathini " removing it...\n", part->name);
28678989f0aSHari Bathini nvram_remove_partition(part->name, NVRAM_SIG_OS, NULL);
28778989f0aSHari Bathini p = 0;
28878989f0aSHari Bathini }
28978989f0aSHari Bathini
29078989f0aSHari Bathini /* Create one if we didn't find */
29178989f0aSHari Bathini if (!p) {
29278989f0aSHari Bathini p = nvram_create_partition(part->name, NVRAM_SIG_OS,
29378989f0aSHari Bathini part->req_size, part->min_size);
29478989f0aSHari Bathini if (p == -ENOSPC) {
29578989f0aSHari Bathini pr_info("nvram: No room to create %s partition, "
29678989f0aSHari Bathini "deleting any obsolete OS partitions...\n",
29778989f0aSHari Bathini part->name);
29878989f0aSHari Bathini nvram_remove_partition(NULL, NVRAM_SIG_OS,
29978989f0aSHari Bathini nvram_os_partitions);
30078989f0aSHari Bathini p = nvram_create_partition(part->name, NVRAM_SIG_OS,
30178989f0aSHari Bathini part->req_size, part->min_size);
30278989f0aSHari Bathini }
30378989f0aSHari Bathini }
30478989f0aSHari Bathini
30578989f0aSHari Bathini if (p <= 0) {
30678989f0aSHari Bathini pr_err("nvram: Failed to find or create %s"
30778989f0aSHari Bathini " partition, err %d\n", part->name, (int)p);
30878989f0aSHari Bathini return -1;
30978989f0aSHari Bathini }
31078989f0aSHari Bathini
31178989f0aSHari Bathini part->index = p;
31278989f0aSHari Bathini part->size = nvram_get_partition_size(p) - sizeof(struct err_log_info);
31378989f0aSHari Bathini
31478989f0aSHari Bathini return 0;
31578989f0aSHari Bathini }
31678989f0aSHari Bathini
31778989f0aSHari Bathini /* Derived from logfs_compress() */
nvram_compress(const void * in,void * out,size_t inlen,size_t outlen)31878989f0aSHari Bathini static int nvram_compress(const void *in, void *out, size_t inlen,
31978989f0aSHari Bathini size_t outlen)
32078989f0aSHari Bathini {
32178989f0aSHari Bathini int err, ret;
32278989f0aSHari Bathini
32378989f0aSHari Bathini ret = -EIO;
32478989f0aSHari Bathini err = zlib_deflateInit2(&stream, COMPR_LEVEL, Z_DEFLATED, WINDOW_BITS,
32578989f0aSHari Bathini MEM_LEVEL, Z_DEFAULT_STRATEGY);
32678989f0aSHari Bathini if (err != Z_OK)
32778989f0aSHari Bathini goto error;
32878989f0aSHari Bathini
32978989f0aSHari Bathini stream.next_in = in;
33078989f0aSHari Bathini stream.avail_in = inlen;
33178989f0aSHari Bathini stream.total_in = 0;
33278989f0aSHari Bathini stream.next_out = out;
33378989f0aSHari Bathini stream.avail_out = outlen;
33478989f0aSHari Bathini stream.total_out = 0;
33578989f0aSHari Bathini
33678989f0aSHari Bathini err = zlib_deflate(&stream, Z_FINISH);
33778989f0aSHari Bathini if (err != Z_STREAM_END)
33878989f0aSHari Bathini goto error;
33978989f0aSHari Bathini
34078989f0aSHari Bathini err = zlib_deflateEnd(&stream);
34178989f0aSHari Bathini if (err != Z_OK)
34278989f0aSHari Bathini goto error;
34378989f0aSHari Bathini
34478989f0aSHari Bathini if (stream.total_out >= stream.total_in)
34578989f0aSHari Bathini goto error;
34678989f0aSHari Bathini
34778989f0aSHari Bathini ret = stream.total_out;
34878989f0aSHari Bathini error:
34978989f0aSHari Bathini return ret;
35078989f0aSHari Bathini }
35178989f0aSHari Bathini
35278989f0aSHari Bathini /* Compress the text from big_oops_buf into oops_buf. */
zip_oops(size_t text_len)35378989f0aSHari Bathini static int zip_oops(size_t text_len)
35478989f0aSHari Bathini {
35578989f0aSHari Bathini struct oops_log_info *oops_hdr = (struct oops_log_info *)oops_buf;
35678989f0aSHari Bathini int zipped_len = nvram_compress(big_oops_buf, oops_data, text_len,
35778989f0aSHari Bathini oops_data_sz);
35878989f0aSHari Bathini if (zipped_len < 0) {
35978989f0aSHari Bathini pr_err("nvram: compression failed; returned %d\n", zipped_len);
36078989f0aSHari Bathini pr_err("nvram: logging uncompressed oops/panic report\n");
36178989f0aSHari Bathini return -1;
36278989f0aSHari Bathini }
36378989f0aSHari Bathini oops_hdr->version = cpu_to_be16(OOPS_HDR_VERSION);
36478989f0aSHari Bathini oops_hdr->report_length = cpu_to_be16(zipped_len);
365e4a9616cSHari Bathini oops_hdr->timestamp = cpu_to_be64(ktime_get_real_seconds());
36678989f0aSHari Bathini return 0;
36778989f0aSHari Bathini }
36878989f0aSHari Bathini
36978989f0aSHari Bathini #ifdef CONFIG_PSTORE
nvram_pstore_open(struct pstore_info * psi)37078989f0aSHari Bathini static int nvram_pstore_open(struct pstore_info *psi)
37178989f0aSHari Bathini {
37278989f0aSHari Bathini /* Reset the iterator to start reading partitions again */
37378989f0aSHari Bathini read_type = -1;
37478989f0aSHari Bathini return 0;
37578989f0aSHari Bathini }
37678989f0aSHari Bathini
37778989f0aSHari Bathini /**
37878989f0aSHari Bathini * nvram_pstore_write - pstore write callback for nvram
37976cc9580SKees Cook * @record: pstore record to write, with @id to be set
38078989f0aSHari Bathini *
38178989f0aSHari Bathini * Called by pstore_dump() when an oops or panic report is logged in the
38278989f0aSHari Bathini * printk buffer.
38378989f0aSHari Bathini * Returns 0 on successful write.
38478989f0aSHari Bathini */
nvram_pstore_write(struct pstore_record * record)38576cc9580SKees Cook static int nvram_pstore_write(struct pstore_record *record)
38678989f0aSHari Bathini {
38778989f0aSHari Bathini int rc;
38878989f0aSHari Bathini unsigned int err_type = ERR_TYPE_KERNEL_PANIC;
38978989f0aSHari Bathini struct oops_log_info *oops_hdr = (struct oops_log_info *) oops_buf;
39078989f0aSHari Bathini
39178989f0aSHari Bathini /* part 1 has the recent messages from printk buffer */
39276cc9580SKees Cook if (record->part > 1 || (record->type != PSTORE_TYPE_DMESG))
39378989f0aSHari Bathini return -1;
39478989f0aSHari Bathini
39578989f0aSHari Bathini if (clobbering_unread_rtas_event())
39678989f0aSHari Bathini return -1;
39778989f0aSHari Bathini
39878989f0aSHari Bathini oops_hdr->version = cpu_to_be16(OOPS_HDR_VERSION);
39976cc9580SKees Cook oops_hdr->report_length = cpu_to_be16(record->size);
400e4a9616cSHari Bathini oops_hdr->timestamp = cpu_to_be64(ktime_get_real_seconds());
40178989f0aSHari Bathini
40276cc9580SKees Cook if (record->compressed)
40378989f0aSHari Bathini err_type = ERR_TYPE_KERNEL_PANIC_GZ;
40478989f0aSHari Bathini
40578989f0aSHari Bathini rc = nvram_write_os_partition(&oops_log_partition, oops_buf,
40676cc9580SKees Cook (int) (sizeof(*oops_hdr) + record->size), err_type,
40776cc9580SKees Cook record->count);
40878989f0aSHari Bathini
40978989f0aSHari Bathini if (rc != 0)
41078989f0aSHari Bathini return rc;
41178989f0aSHari Bathini
41276cc9580SKees Cook record->id = record->part;
41378989f0aSHari Bathini return 0;
41478989f0aSHari Bathini }
41578989f0aSHari Bathini
41678989f0aSHari Bathini /*
41778989f0aSHari Bathini * Reads the oops/panic report, rtas, of-config and common partition.
41878989f0aSHari Bathini * Returns the length of the data we read from each partition.
41978989f0aSHari Bathini * Returns 0 if we've been called before.
42078989f0aSHari Bathini */
nvram_pstore_read(struct pstore_record * record)421125cc42bSKees Cook static ssize_t nvram_pstore_read(struct pstore_record *record)
42278989f0aSHari Bathini {
42378989f0aSHari Bathini struct oops_log_info *oops_hdr;
42478989f0aSHari Bathini unsigned int err_type, id_no, size = 0;
42578989f0aSHari Bathini struct nvram_os_partition *part = NULL;
42678989f0aSHari Bathini char *buff = NULL;
42778989f0aSHari Bathini int sig = 0;
42878989f0aSHari Bathini loff_t p;
42978989f0aSHari Bathini
43078989f0aSHari Bathini read_type++;
43178989f0aSHari Bathini
43278989f0aSHari Bathini switch (nvram_type_ids[read_type]) {
43378989f0aSHari Bathini case PSTORE_TYPE_DMESG:
43478989f0aSHari Bathini part = &oops_log_partition;
435125cc42bSKees Cook record->type = PSTORE_TYPE_DMESG;
43678989f0aSHari Bathini break;
43778989f0aSHari Bathini case PSTORE_TYPE_PPC_COMMON:
43878989f0aSHari Bathini sig = NVRAM_SIG_SYS;
43978989f0aSHari Bathini part = &common_partition;
440125cc42bSKees Cook record->type = PSTORE_TYPE_PPC_COMMON;
441125cc42bSKees Cook record->id = PSTORE_TYPE_PPC_COMMON;
442125cc42bSKees Cook record->time.tv_sec = 0;
443125cc42bSKees Cook record->time.tv_nsec = 0;
44478989f0aSHari Bathini break;
44578989f0aSHari Bathini #ifdef CONFIG_PPC_PSERIES
44678989f0aSHari Bathini case PSTORE_TYPE_PPC_RTAS:
44778989f0aSHari Bathini part = &rtas_log_partition;
448125cc42bSKees Cook record->type = PSTORE_TYPE_PPC_RTAS;
449125cc42bSKees Cook record->time.tv_sec = last_rtas_event;
450125cc42bSKees Cook record->time.tv_nsec = 0;
45178989f0aSHari Bathini break;
45278989f0aSHari Bathini case PSTORE_TYPE_PPC_OF:
45378989f0aSHari Bathini sig = NVRAM_SIG_OF;
45478989f0aSHari Bathini part = &of_config_partition;
455125cc42bSKees Cook record->type = PSTORE_TYPE_PPC_OF;
456125cc42bSKees Cook record->id = PSTORE_TYPE_PPC_OF;
457125cc42bSKees Cook record->time.tv_sec = 0;
458125cc42bSKees Cook record->time.tv_nsec = 0;
45978989f0aSHari Bathini break;
46078989f0aSHari Bathini #endif
461f7618299SHari Bathini #ifdef CONFIG_PPC_POWERNV
462f7618299SHari Bathini case PSTORE_TYPE_PPC_OPAL:
463f7618299SHari Bathini sig = NVRAM_SIG_FW;
464f7618299SHari Bathini part = &skiboot_partition;
465125cc42bSKees Cook record->type = PSTORE_TYPE_PPC_OPAL;
466125cc42bSKees Cook record->id = PSTORE_TYPE_PPC_OPAL;
467125cc42bSKees Cook record->time.tv_sec = 0;
468125cc42bSKees Cook record->time.tv_nsec = 0;
469f7618299SHari Bathini break;
470f7618299SHari Bathini #endif
47178989f0aSHari Bathini default:
47278989f0aSHari Bathini return 0;
47378989f0aSHari Bathini }
47478989f0aSHari Bathini
47578989f0aSHari Bathini if (!part->os_partition) {
47678989f0aSHari Bathini p = nvram_find_partition(part->name, sig, &size);
47778989f0aSHari Bathini if (p <= 0) {
47878989f0aSHari Bathini pr_err("nvram: Failed to find partition %s, "
47978989f0aSHari Bathini "err %d\n", part->name, (int)p);
48078989f0aSHari Bathini return 0;
48178989f0aSHari Bathini }
48278989f0aSHari Bathini part->index = p;
48378989f0aSHari Bathini part->size = size;
48478989f0aSHari Bathini }
48578989f0aSHari Bathini
48678989f0aSHari Bathini buff = kmalloc(part->size, GFP_KERNEL);
48778989f0aSHari Bathini
48878989f0aSHari Bathini if (!buff)
48978989f0aSHari Bathini return -ENOMEM;
49078989f0aSHari Bathini
49178989f0aSHari Bathini if (nvram_read_partition(part, buff, part->size, &err_type, &id_no)) {
49278989f0aSHari Bathini kfree(buff);
49378989f0aSHari Bathini return 0;
49478989f0aSHari Bathini }
49578989f0aSHari Bathini
496125cc42bSKees Cook record->count = 0;
49778989f0aSHari Bathini
49878989f0aSHari Bathini if (part->os_partition)
499125cc42bSKees Cook record->id = id_no;
50078989f0aSHari Bathini
50178989f0aSHari Bathini if (nvram_type_ids[read_type] == PSTORE_TYPE_DMESG) {
50278989f0aSHari Bathini size_t length, hdr_size;
50378989f0aSHari Bathini
50478989f0aSHari Bathini oops_hdr = (struct oops_log_info *)buff;
50578989f0aSHari Bathini if (be16_to_cpu(oops_hdr->version) < OOPS_HDR_VERSION) {
50678989f0aSHari Bathini /* Old format oops header had 2-byte record size */
50778989f0aSHari Bathini hdr_size = sizeof(u16);
50878989f0aSHari Bathini length = be16_to_cpu(oops_hdr->version);
509125cc42bSKees Cook record->time.tv_sec = 0;
510125cc42bSKees Cook record->time.tv_nsec = 0;
51178989f0aSHari Bathini } else {
51278989f0aSHari Bathini hdr_size = sizeof(*oops_hdr);
51378989f0aSHari Bathini length = be16_to_cpu(oops_hdr->report_length);
514125cc42bSKees Cook record->time.tv_sec = be64_to_cpu(oops_hdr->timestamp);
515125cc42bSKees Cook record->time.tv_nsec = 0;
51678989f0aSHari Bathini }
517125cc42bSKees Cook record->buf = kmemdup(buff + hdr_size, length, GFP_KERNEL);
5180d0fecc5SPan Xinhui kfree(buff);
519125cc42bSKees Cook if (record->buf == NULL)
52078989f0aSHari Bathini return -ENOMEM;
52178989f0aSHari Bathini
522125cc42bSKees Cook record->ecc_notice_size = 0;
52378989f0aSHari Bathini if (err_type == ERR_TYPE_KERNEL_PANIC_GZ)
524125cc42bSKees Cook record->compressed = true;
52578989f0aSHari Bathini else
526125cc42bSKees Cook record->compressed = false;
52778989f0aSHari Bathini return length;
52878989f0aSHari Bathini }
52978989f0aSHari Bathini
530125cc42bSKees Cook record->buf = buff;
53178989f0aSHari Bathini return part->size;
53278989f0aSHari Bathini }
53378989f0aSHari Bathini
53478989f0aSHari Bathini static struct pstore_info nvram_pstore_info = {
53578989f0aSHari Bathini .owner = THIS_MODULE,
53678989f0aSHari Bathini .name = "nvram",
537041939c1SAnkit Kumar .flags = PSTORE_FLAGS_DMESG,
53878989f0aSHari Bathini .open = nvram_pstore_open,
53978989f0aSHari Bathini .read = nvram_pstore_read,
54078989f0aSHari Bathini .write = nvram_pstore_write,
54178989f0aSHari Bathini };
54278989f0aSHari Bathini
nvram_pstore_init(void)543d276960dSNick Child static int __init nvram_pstore_init(void)
54478989f0aSHari Bathini {
54578989f0aSHari Bathini int rc = 0;
54678989f0aSHari Bathini
547f7618299SHari Bathini if (machine_is(pseries)) {
54878989f0aSHari Bathini nvram_type_ids[2] = PSTORE_TYPE_PPC_RTAS;
54978989f0aSHari Bathini nvram_type_ids[3] = PSTORE_TYPE_PPC_OF;
550f7618299SHari Bathini } else
551f7618299SHari Bathini nvram_type_ids[2] = PSTORE_TYPE_PPC_OPAL;
55278989f0aSHari Bathini
55378989f0aSHari Bathini nvram_pstore_info.buf = oops_data;
55478989f0aSHari Bathini nvram_pstore_info.bufsize = oops_data_sz;
55578989f0aSHari Bathini
55678989f0aSHari Bathini rc = pstore_register(&nvram_pstore_info);
55774943dabSHari Bathini if (rc && (rc != -EPERM))
55874943dabSHari Bathini /* Print error only when pstore.backend == nvram */
55974943dabSHari Bathini pr_err("nvram: pstore_register() failed, returned %d. "
56074943dabSHari Bathini "Defaults to kmsg_dump\n", rc);
56178989f0aSHari Bathini
56278989f0aSHari Bathini return rc;
56378989f0aSHari Bathini }
56478989f0aSHari Bathini #else
nvram_pstore_init(void)565d276960dSNick Child static int __init nvram_pstore_init(void)
56678989f0aSHari Bathini {
56778989f0aSHari Bathini return -1;
56878989f0aSHari Bathini }
56978989f0aSHari Bathini #endif
57078989f0aSHari Bathini
nvram_init_oops_partition(int rtas_partition_exists)57178989f0aSHari Bathini void __init nvram_init_oops_partition(int rtas_partition_exists)
57278989f0aSHari Bathini {
57378989f0aSHari Bathini int rc;
57478989f0aSHari Bathini
57578989f0aSHari Bathini rc = nvram_init_os_partition(&oops_log_partition);
57678989f0aSHari Bathini if (rc != 0) {
57778989f0aSHari Bathini #ifdef CONFIG_PPC_PSERIES
57878989f0aSHari Bathini if (!rtas_partition_exists) {
57978989f0aSHari Bathini pr_err("nvram: Failed to initialize oops partition!");
58078989f0aSHari Bathini return;
58178989f0aSHari Bathini }
58278989f0aSHari Bathini pr_notice("nvram: Using %s partition to log both"
58378989f0aSHari Bathini " RTAS errors and oops/panic reports\n",
58478989f0aSHari Bathini rtas_log_partition.name);
58578989f0aSHari Bathini memcpy(&oops_log_partition, &rtas_log_partition,
58678989f0aSHari Bathini sizeof(rtas_log_partition));
58778989f0aSHari Bathini #else
58878989f0aSHari Bathini pr_err("nvram: Failed to initialize oops partition!");
58978989f0aSHari Bathini return;
59078989f0aSHari Bathini #endif
59178989f0aSHari Bathini }
59278989f0aSHari Bathini oops_buf = kmalloc(oops_log_partition.size, GFP_KERNEL);
59378989f0aSHari Bathini if (!oops_buf) {
59478989f0aSHari Bathini pr_err("nvram: No memory for %s partition\n",
59578989f0aSHari Bathini oops_log_partition.name);
59678989f0aSHari Bathini return;
59778989f0aSHari Bathini }
59878989f0aSHari Bathini oops_data = oops_buf + sizeof(struct oops_log_info);
59978989f0aSHari Bathini oops_data_sz = oops_log_partition.size - sizeof(struct oops_log_info);
60078989f0aSHari Bathini
60178989f0aSHari Bathini rc = nvram_pstore_init();
60278989f0aSHari Bathini
60378989f0aSHari Bathini if (!rc)
60478989f0aSHari Bathini return;
60578989f0aSHari Bathini
60678989f0aSHari Bathini /*
60778989f0aSHari Bathini * Figure compression (preceded by elimination of each line's <n>
60878989f0aSHari Bathini * severity prefix) will reduce the oops/panic report to at most
60978989f0aSHari Bathini * 45% of its original size.
61078989f0aSHari Bathini */
61178989f0aSHari Bathini big_oops_buf_sz = (oops_data_sz * 100) / 45;
61278989f0aSHari Bathini big_oops_buf = kmalloc(big_oops_buf_sz, GFP_KERNEL);
61378989f0aSHari Bathini if (big_oops_buf) {
61478989f0aSHari Bathini stream.workspace = kmalloc(zlib_deflate_workspacesize(
61578989f0aSHari Bathini WINDOW_BITS, MEM_LEVEL), GFP_KERNEL);
61678989f0aSHari Bathini if (!stream.workspace) {
61778989f0aSHari Bathini pr_err("nvram: No memory for compression workspace; "
61878989f0aSHari Bathini "skipping compression of %s partition data\n",
61978989f0aSHari Bathini oops_log_partition.name);
62078989f0aSHari Bathini kfree(big_oops_buf);
62178989f0aSHari Bathini big_oops_buf = NULL;
62278989f0aSHari Bathini }
62378989f0aSHari Bathini } else {
62478989f0aSHari Bathini pr_err("No memory for uncompressed %s data; "
62578989f0aSHari Bathini "skipping compression\n", oops_log_partition.name);
62678989f0aSHari Bathini stream.workspace = NULL;
62778989f0aSHari Bathini }
62878989f0aSHari Bathini
62978989f0aSHari Bathini rc = kmsg_dump_register(&nvram_kmsg_dumper);
63078989f0aSHari Bathini if (rc != 0) {
63178989f0aSHari Bathini pr_err("nvram: kmsg_dump_register() failed; returned %d\n", rc);
63278989f0aSHari Bathini kfree(oops_buf);
63378989f0aSHari Bathini kfree(big_oops_buf);
63478989f0aSHari Bathini kfree(stream.workspace);
63578989f0aSHari Bathini }
63678989f0aSHari Bathini }
63778989f0aSHari Bathini
63878989f0aSHari Bathini /*
63978989f0aSHari Bathini * This is our kmsg_dump callback, called after an oops or panic report
64078989f0aSHari Bathini * has been written to the printk buffer. We want to capture as much
64178989f0aSHari Bathini * of the printk buffer as possible. First, capture as much as we can
64278989f0aSHari Bathini * that we think will compress sufficiently to fit in the lnx,oops-log
64378989f0aSHari Bathini * partition. If that's too much, go back and capture uncompressed text.
64478989f0aSHari Bathini */
oops_to_nvram(struct kmsg_dumper * dumper,enum kmsg_dump_reason reason)64578989f0aSHari Bathini static void oops_to_nvram(struct kmsg_dumper *dumper,
64678989f0aSHari Bathini enum kmsg_dump_reason reason)
64778989f0aSHari Bathini {
64878989f0aSHari Bathini struct oops_log_info *oops_hdr = (struct oops_log_info *)oops_buf;
64978989f0aSHari Bathini static unsigned int oops_count = 0;
650f9f3f02dSJohn Ogness static struct kmsg_dump_iter iter;
65178989f0aSHari Bathini static bool panicking = false;
65278989f0aSHari Bathini static DEFINE_SPINLOCK(lock);
65378989f0aSHari Bathini unsigned long flags;
65478989f0aSHari Bathini size_t text_len;
65578989f0aSHari Bathini unsigned int err_type = ERR_TYPE_KERNEL_PANIC_GZ;
65678989f0aSHari Bathini int rc = -1;
65778989f0aSHari Bathini
65878989f0aSHari Bathini switch (reason) {
6596d3cf962SKees Cook case KMSG_DUMP_SHUTDOWN:
66078989f0aSHari Bathini /* These are almost always orderly shutdowns. */
66178989f0aSHari Bathini return;
66278989f0aSHari Bathini case KMSG_DUMP_OOPS:
66378989f0aSHari Bathini break;
66478989f0aSHari Bathini case KMSG_DUMP_PANIC:
66578989f0aSHari Bathini panicking = true;
66678989f0aSHari Bathini break;
66778989f0aSHari Bathini case KMSG_DUMP_EMERG:
66878989f0aSHari Bathini if (panicking)
66978989f0aSHari Bathini /* Panic report already captured. */
67078989f0aSHari Bathini return;
67178989f0aSHari Bathini break;
67278989f0aSHari Bathini default:
67378989f0aSHari Bathini pr_err("%s: ignoring unrecognized KMSG_DUMP_* reason %d\n",
67478989f0aSHari Bathini __func__, (int) reason);
67578989f0aSHari Bathini return;
67678989f0aSHari Bathini }
67778989f0aSHari Bathini
67878989f0aSHari Bathini if (clobbering_unread_rtas_event())
67978989f0aSHari Bathini return;
68078989f0aSHari Bathini
68178989f0aSHari Bathini if (!spin_trylock_irqsave(&lock, flags))
68278989f0aSHari Bathini return;
68378989f0aSHari Bathini
68478989f0aSHari Bathini if (big_oops_buf) {
685f9f3f02dSJohn Ogness kmsg_dump_rewind(&iter);
686f9f3f02dSJohn Ogness kmsg_dump_get_buffer(&iter, false,
68778989f0aSHari Bathini big_oops_buf, big_oops_buf_sz, &text_len);
68878989f0aSHari Bathini rc = zip_oops(text_len);
68978989f0aSHari Bathini }
69078989f0aSHari Bathini if (rc != 0) {
691f9f3f02dSJohn Ogness kmsg_dump_rewind(&iter);
692f9f3f02dSJohn Ogness kmsg_dump_get_buffer(&iter, false,
69378989f0aSHari Bathini oops_data, oops_data_sz, &text_len);
69478989f0aSHari Bathini err_type = ERR_TYPE_KERNEL_PANIC;
69578989f0aSHari Bathini oops_hdr->version = cpu_to_be16(OOPS_HDR_VERSION);
69678989f0aSHari Bathini oops_hdr->report_length = cpu_to_be16(text_len);
697e4a9616cSHari Bathini oops_hdr->timestamp = cpu_to_be64(ktime_get_real_seconds());
69878989f0aSHari Bathini }
69978989f0aSHari Bathini
70078989f0aSHari Bathini (void) nvram_write_os_partition(&oops_log_partition, oops_buf,
70178989f0aSHari Bathini (int) (sizeof(*oops_hdr) + text_len), err_type,
70278989f0aSHari Bathini ++oops_count);
70378989f0aSHari Bathini
70478989f0aSHari Bathini spin_unlock_irqrestore(&lock, flags);
70578989f0aSHari Bathini }
70678989f0aSHari Bathini
707437a58dbSPaul Mackerras #ifdef DEBUG_NVRAM
nvram_print_partitions(char * label)70832c105c3SThomas Gleixner static void __init nvram_print_partitions(char * label)
709437a58dbSPaul Mackerras {
710437a58dbSPaul Mackerras struct nvram_partition * tmp_part;
711437a58dbSPaul Mackerras
712437a58dbSPaul Mackerras printk(KERN_WARNING "--------%s---------\n", label);
713437a58dbSPaul Mackerras printk(KERN_WARNING "indx\t\tsig\tchks\tlen\tname\n");
714690d1a9bSJim Keniston list_for_each_entry(tmp_part, &nvram_partitions, partition) {
715e0513d9eSChen Gang printk(KERN_WARNING "%4d \t%02x\t%02x\t%d\t%12.12s\n",
716437a58dbSPaul Mackerras tmp_part->index, tmp_part->header.signature,
717437a58dbSPaul Mackerras tmp_part->header.checksum, tmp_part->header.length,
718437a58dbSPaul Mackerras tmp_part->header.name);
719437a58dbSPaul Mackerras }
720437a58dbSPaul Mackerras }
721437a58dbSPaul Mackerras #endif
722437a58dbSPaul Mackerras
723437a58dbSPaul Mackerras
nvram_write_header(struct nvram_partition * part)72432c105c3SThomas Gleixner static int __init nvram_write_header(struct nvram_partition * part)
725437a58dbSPaul Mackerras {
726437a58dbSPaul Mackerras loff_t tmp_index;
727437a58dbSPaul Mackerras int rc;
728c81095a4SCedric Le Goater struct nvram_header phead;
729c81095a4SCedric Le Goater
730c81095a4SCedric Le Goater memcpy(&phead, &part->header, NVRAM_HEADER_LEN);
731c81095a4SCedric Le Goater phead.length = cpu_to_be16(phead.length);
732437a58dbSPaul Mackerras
733437a58dbSPaul Mackerras tmp_index = part->index;
734c81095a4SCedric Le Goater rc = ppc_md.nvram_write((char *)&phead, NVRAM_HEADER_LEN, &tmp_index);
735437a58dbSPaul Mackerras
736437a58dbSPaul Mackerras return rc;
737437a58dbSPaul Mackerras }
738437a58dbSPaul Mackerras
739437a58dbSPaul Mackerras
nvram_checksum(struct nvram_header * p)74032c105c3SThomas Gleixner static unsigned char __init nvram_checksum(struct nvram_header *p)
741437a58dbSPaul Mackerras {
742437a58dbSPaul Mackerras unsigned int c_sum, c_sum2;
743437a58dbSPaul Mackerras unsigned short *sp = (unsigned short *)p->name; /* assume 6 shorts */
744437a58dbSPaul Mackerras c_sum = p->signature + p->length + sp[0] + sp[1] + sp[2] + sp[3] + sp[4] + sp[5];
745437a58dbSPaul Mackerras
746437a58dbSPaul Mackerras /* The sum may have spilled into the 3rd byte. Fold it back. */
747437a58dbSPaul Mackerras c_sum = ((c_sum & 0xffff) + (c_sum >> 16)) & 0xffff;
748437a58dbSPaul Mackerras /* The sum cannot exceed 2 bytes. Fold it into a checksum */
749437a58dbSPaul Mackerras c_sum2 = (c_sum >> 8) + (c_sum << 8);
750437a58dbSPaul Mackerras c_sum = ((c_sum + c_sum2) >> 8) & 0xff;
751437a58dbSPaul Mackerras return c_sum;
752437a58dbSPaul Mackerras }
753437a58dbSPaul Mackerras
7540f4ac132SJim Keniston /*
7550f4ac132SJim Keniston * Per the criteria passed via nvram_remove_partition(), should this
7560f4ac132SJim Keniston * partition be removed? 1=remove, 0=keep
7570f4ac132SJim Keniston */
nvram_can_remove_partition(struct nvram_partition * part,const char * name,int sig,const char * exceptions[])758d276960dSNick Child static int __init nvram_can_remove_partition(struct nvram_partition *part,
7590f4ac132SJim Keniston const char *name, int sig, const char *exceptions[])
7600f4ac132SJim Keniston {
7610f4ac132SJim Keniston if (part->header.signature != sig)
7620f4ac132SJim Keniston return 0;
7630f4ac132SJim Keniston if (name) {
7640f4ac132SJim Keniston if (strncmp(name, part->header.name, 12))
7650f4ac132SJim Keniston return 0;
7660f4ac132SJim Keniston } else if (exceptions) {
7670f4ac132SJim Keniston const char **except;
7680f4ac132SJim Keniston for (except = exceptions; *except; except++) {
7690f4ac132SJim Keniston if (!strncmp(*except, part->header.name, 12))
7700f4ac132SJim Keniston return 0;
7710f4ac132SJim Keniston }
7720f4ac132SJim Keniston }
7730f4ac132SJim Keniston return 1;
7740f4ac132SJim Keniston }
7750f4ac132SJim Keniston
776fa2b4e54SBenjamin Herrenschmidt /**
777fa2b4e54SBenjamin Herrenschmidt * nvram_remove_partition - Remove one or more partitions in nvram
778fa2b4e54SBenjamin Herrenschmidt * @name: name of the partition to remove, or NULL for a
779fa2b4e54SBenjamin Herrenschmidt * signature only match
780fa2b4e54SBenjamin Herrenschmidt * @sig: signature of the partition(s) to remove
7810f4ac132SJim Keniston * @exceptions: When removing all partitions with a matching signature,
7820f4ac132SJim Keniston * leave these alone.
783fa2b4e54SBenjamin Herrenschmidt */
784fa2b4e54SBenjamin Herrenschmidt
nvram_remove_partition(const char * name,int sig,const char * exceptions[])7850f4ac132SJim Keniston int __init nvram_remove_partition(const char *name, int sig,
7860f4ac132SJim Keniston const char *exceptions[])
787437a58dbSPaul Mackerras {
788fa2b4e54SBenjamin Herrenschmidt struct nvram_partition *part, *prev, *tmp;
789437a58dbSPaul Mackerras int rc;
790437a58dbSPaul Mackerras
791690d1a9bSJim Keniston list_for_each_entry(part, &nvram_partitions, partition) {
7920f4ac132SJim Keniston if (!nvram_can_remove_partition(part, name, sig, exceptions))
793437a58dbSPaul Mackerras continue;
794437a58dbSPaul Mackerras
795fa2b4e54SBenjamin Herrenschmidt /* Make partition a free partition */
796437a58dbSPaul Mackerras part->header.signature = NVRAM_SIG_FREE;
79711b7e154SPan Xinhui memset(part->header.name, 'w', 12);
798437a58dbSPaul Mackerras part->header.checksum = nvram_checksum(&part->header);
799437a58dbSPaul Mackerras rc = nvram_write_header(part);
800437a58dbSPaul Mackerras if (rc <= 0) {
801fa2b4e54SBenjamin Herrenschmidt printk(KERN_ERR "nvram_remove_partition: nvram_write failed (%d)\n", rc);
802437a58dbSPaul Mackerras return rc;
803437a58dbSPaul Mackerras }
804fa2b4e54SBenjamin Herrenschmidt }
805437a58dbSPaul Mackerras
806fa2b4e54SBenjamin Herrenschmidt /* Merge contiguous ones */
807fa2b4e54SBenjamin Herrenschmidt prev = NULL;
808690d1a9bSJim Keniston list_for_each_entry_safe(part, tmp, &nvram_partitions, partition) {
809fa2b4e54SBenjamin Herrenschmidt if (part->header.signature != NVRAM_SIG_FREE) {
810fa2b4e54SBenjamin Herrenschmidt prev = NULL;
811fa2b4e54SBenjamin Herrenschmidt continue;
812fa2b4e54SBenjamin Herrenschmidt }
813fa2b4e54SBenjamin Herrenschmidt if (prev) {
814fa2b4e54SBenjamin Herrenschmidt prev->header.length += part->header.length;
81511b7e154SPan Xinhui prev->header.checksum = nvram_checksum(&prev->header);
81611b7e154SPan Xinhui rc = nvram_write_header(prev);
817fa2b4e54SBenjamin Herrenschmidt if (rc <= 0) {
818fa2b4e54SBenjamin Herrenschmidt printk(KERN_ERR "nvram_remove_partition: nvram_write failed (%d)\n", rc);
819fa2b4e54SBenjamin Herrenschmidt return rc;
820fa2b4e54SBenjamin Herrenschmidt }
821fa2b4e54SBenjamin Herrenschmidt list_del(&part->partition);
822fa2b4e54SBenjamin Herrenschmidt kfree(part);
823fa2b4e54SBenjamin Herrenschmidt } else
824fa2b4e54SBenjamin Herrenschmidt prev = part;
825437a58dbSPaul Mackerras }
826437a58dbSPaul Mackerras
827437a58dbSPaul Mackerras return 0;
828437a58dbSPaul Mackerras }
829437a58dbSPaul Mackerras
8304e7c77a3SBenjamin Herrenschmidt /**
8314e7c77a3SBenjamin Herrenschmidt * nvram_create_partition - Create a partition in nvram
8324e7c77a3SBenjamin Herrenschmidt * @name: name of the partition to create
8334e7c77a3SBenjamin Herrenschmidt * @sig: signature of the partition to create
83436673307SBenjamin Herrenschmidt * @req_size: size of data to allocate in bytes
8354e7c77a3SBenjamin Herrenschmidt * @min_size: minimum acceptable size (0 means req_size)
836e49e2e87SBenjamin Herrenschmidt *
837e49e2e87SBenjamin Herrenschmidt * Returns a negative error code or a positive nvram index
838e49e2e87SBenjamin Herrenschmidt * of the beginning of the data area of the newly created
839e49e2e87SBenjamin Herrenschmidt * partition. If you provided a min_size smaller than req_size
840e49e2e87SBenjamin Herrenschmidt * you need to query for the actual size yourself after the
841e49e2e87SBenjamin Herrenschmidt * call using nvram_partition_get_size().
842437a58dbSPaul Mackerras */
nvram_create_partition(const char * name,int sig,int req_size,int min_size)843edc79a2fSBenjamin Herrenschmidt loff_t __init nvram_create_partition(const char *name, int sig,
8444e7c77a3SBenjamin Herrenschmidt int req_size, int min_size)
845437a58dbSPaul Mackerras {
846437a58dbSPaul Mackerras struct nvram_partition *part;
847437a58dbSPaul Mackerras struct nvram_partition *new_part;
848437a58dbSPaul Mackerras struct nvram_partition *free_part = NULL;
849cef0d5adSBenjamin Herrenschmidt static char nv_init_vals[16];
850437a58dbSPaul Mackerras loff_t tmp_index;
851437a58dbSPaul Mackerras long size = 0;
852437a58dbSPaul Mackerras int rc;
853437a58dbSPaul Mackerras
85420e07af7SFinn Thain BUILD_BUG_ON(NVRAM_BLOCK_LEN != 16);
85520e07af7SFinn Thain
85636673307SBenjamin Herrenschmidt /* Convert sizes from bytes to blocks */
857b7115316SChristophe Leroy req_size = ALIGN(req_size, NVRAM_BLOCK_LEN) / NVRAM_BLOCK_LEN;
858b7115316SChristophe Leroy min_size = ALIGN(min_size, NVRAM_BLOCK_LEN) / NVRAM_BLOCK_LEN;
85936673307SBenjamin Herrenschmidt
8604e7c77a3SBenjamin Herrenschmidt /* If no minimum size specified, make it the same as the
8614e7c77a3SBenjamin Herrenschmidt * requested size
8624e7c77a3SBenjamin Herrenschmidt */
8634e7c77a3SBenjamin Herrenschmidt if (min_size == 0)
8644e7c77a3SBenjamin Herrenschmidt min_size = req_size;
865e49e2e87SBenjamin Herrenschmidt if (min_size > req_size)
866e49e2e87SBenjamin Herrenschmidt return -EINVAL;
8674e7c77a3SBenjamin Herrenschmidt
86836673307SBenjamin Herrenschmidt /* Now add one block to each for the header */
86936673307SBenjamin Herrenschmidt req_size += 1;
87036673307SBenjamin Herrenschmidt min_size += 1;
87136673307SBenjamin Herrenschmidt
872437a58dbSPaul Mackerras /* Find a free partition that will give us the maximum needed size
873437a58dbSPaul Mackerras If can't find one that will give us the minimum size needed */
874690d1a9bSJim Keniston list_for_each_entry(part, &nvram_partitions, partition) {
875437a58dbSPaul Mackerras if (part->header.signature != NVRAM_SIG_FREE)
876437a58dbSPaul Mackerras continue;
877437a58dbSPaul Mackerras
8784e7c77a3SBenjamin Herrenschmidt if (part->header.length >= req_size) {
8794e7c77a3SBenjamin Herrenschmidt size = req_size;
880437a58dbSPaul Mackerras free_part = part;
881437a58dbSPaul Mackerras break;
882437a58dbSPaul Mackerras }
8834e7c77a3SBenjamin Herrenschmidt if (part->header.length > size &&
8844e7c77a3SBenjamin Herrenschmidt part->header.length >= min_size) {
8854e7c77a3SBenjamin Herrenschmidt size = part->header.length;
886437a58dbSPaul Mackerras free_part = part;
887437a58dbSPaul Mackerras }
888437a58dbSPaul Mackerras }
889437a58dbSPaul Mackerras if (!size)
890437a58dbSPaul Mackerras return -ENOSPC;
891437a58dbSPaul Mackerras
892437a58dbSPaul Mackerras /* Create our OS partition */
893c9599881SChristophe Leroy new_part = kzalloc(sizeof(*new_part), GFP_KERNEL);
894437a58dbSPaul Mackerras if (!new_part) {
895b6080db4SChristophe Jaillet pr_err("%s: kmalloc failed\n", __func__);
896437a58dbSPaul Mackerras return -ENOMEM;
897437a58dbSPaul Mackerras }
898437a58dbSPaul Mackerras
899437a58dbSPaul Mackerras new_part->index = free_part->index;
9004e7c77a3SBenjamin Herrenschmidt new_part->header.signature = sig;
901437a58dbSPaul Mackerras new_part->header.length = size;
902c9599881SChristophe Leroy memcpy(new_part->header.name, name, strnlen(name, sizeof(new_part->header.name)));
903437a58dbSPaul Mackerras new_part->header.checksum = nvram_checksum(&new_part->header);
904437a58dbSPaul Mackerras
905437a58dbSPaul Mackerras rc = nvram_write_header(new_part);
906437a58dbSPaul Mackerras if (rc <= 0) {
907b6080db4SChristophe Jaillet pr_err("%s: nvram_write_header failed (%d)\n", __func__, rc);
9087d523187SChristophe Jaillet kfree(new_part);
909437a58dbSPaul Mackerras return rc;
910437a58dbSPaul Mackerras }
911e49e2e87SBenjamin Herrenschmidt list_add_tail(&new_part->partition, &free_part->partition);
912437a58dbSPaul Mackerras
913e49e2e87SBenjamin Herrenschmidt /* Adjust or remove the partition we stole the space from */
914e49e2e87SBenjamin Herrenschmidt if (free_part->header.length > size) {
915e49e2e87SBenjamin Herrenschmidt free_part->index += size * NVRAM_BLOCK_LEN;
916e49e2e87SBenjamin Herrenschmidt free_part->header.length -= size;
917e49e2e87SBenjamin Herrenschmidt free_part->header.checksum = nvram_checksum(&free_part->header);
918e49e2e87SBenjamin Herrenschmidt rc = nvram_write_header(free_part);
919e49e2e87SBenjamin Herrenschmidt if (rc <= 0) {
920b6080db4SChristophe Jaillet pr_err("%s: nvram_write_header failed (%d)\n",
921b6080db4SChristophe Jaillet __func__, rc);
922e49e2e87SBenjamin Herrenschmidt return rc;
923e49e2e87SBenjamin Herrenschmidt }
924e49e2e87SBenjamin Herrenschmidt } else {
925e49e2e87SBenjamin Herrenschmidt list_del(&free_part->partition);
926e49e2e87SBenjamin Herrenschmidt kfree(free_part);
927e49e2e87SBenjamin Herrenschmidt }
928e49e2e87SBenjamin Herrenschmidt
929e49e2e87SBenjamin Herrenschmidt /* Clear the new partition */
930cef0d5adSBenjamin Herrenschmidt for (tmp_index = new_part->index + NVRAM_HEADER_LEN;
931cef0d5adSBenjamin Herrenschmidt tmp_index < ((size - 1) * NVRAM_BLOCK_LEN);
932cef0d5adSBenjamin Herrenschmidt tmp_index += NVRAM_BLOCK_LEN) {
933cef0d5adSBenjamin Herrenschmidt rc = ppc_md.nvram_write(nv_init_vals, NVRAM_BLOCK_LEN, &tmp_index);
934437a58dbSPaul Mackerras if (rc <= 0) {
935b6080db4SChristophe Jaillet pr_err("%s: nvram_write failed (%d)\n",
936b6080db4SChristophe Jaillet __func__, rc);
937437a58dbSPaul Mackerras return rc;
938437a58dbSPaul Mackerras }
939cef0d5adSBenjamin Herrenschmidt }
940437a58dbSPaul Mackerras
941e49e2e87SBenjamin Herrenschmidt return new_part->index + NVRAM_HEADER_LEN;
942437a58dbSPaul Mackerras }
943437a58dbSPaul Mackerras
944e49e2e87SBenjamin Herrenschmidt /**
945e49e2e87SBenjamin Herrenschmidt * nvram_get_partition_size - Get the data size of an nvram partition
946e49e2e87SBenjamin Herrenschmidt * @data_index: This is the offset of the start of the data of
947e49e2e87SBenjamin Herrenschmidt * the partition. The same value that is returned by
948e49e2e87SBenjamin Herrenschmidt * nvram_create_partition().
949e49e2e87SBenjamin Herrenschmidt */
nvram_get_partition_size(loff_t data_index)950edc79a2fSBenjamin Herrenschmidt int nvram_get_partition_size(loff_t data_index)
951e49e2e87SBenjamin Herrenschmidt {
952e49e2e87SBenjamin Herrenschmidt struct nvram_partition *part;
953437a58dbSPaul Mackerras
954690d1a9bSJim Keniston list_for_each_entry(part, &nvram_partitions, partition) {
955e49e2e87SBenjamin Herrenschmidt if (part->index + NVRAM_HEADER_LEN == data_index)
956e49e2e87SBenjamin Herrenschmidt return (part->header.length - 1) * NVRAM_BLOCK_LEN;
957437a58dbSPaul Mackerras }
958e49e2e87SBenjamin Herrenschmidt return -1;
959437a58dbSPaul Mackerras }
960437a58dbSPaul Mackerras
961437a58dbSPaul Mackerras
962cf5cbf9fSBenjamin Herrenschmidt /**
963cf5cbf9fSBenjamin Herrenschmidt * nvram_find_partition - Find an nvram partition by signature and name
964cf5cbf9fSBenjamin Herrenschmidt * @name: Name of the partition or NULL for any name
965cf5cbf9fSBenjamin Herrenschmidt * @sig: Signature to test against
966cf5cbf9fSBenjamin Herrenschmidt * @out_size: if non-NULL, returns the size of the data part of the partition
967cf5cbf9fSBenjamin Herrenschmidt */
nvram_find_partition(const char * name,int sig,int * out_size)968cf5cbf9fSBenjamin Herrenschmidt loff_t nvram_find_partition(const char *name, int sig, int *out_size)
969cf5cbf9fSBenjamin Herrenschmidt {
970cf5cbf9fSBenjamin Herrenschmidt struct nvram_partition *p;
971cf5cbf9fSBenjamin Herrenschmidt
972690d1a9bSJim Keniston list_for_each_entry(p, &nvram_partitions, partition) {
973cf5cbf9fSBenjamin Herrenschmidt if (p->header.signature == sig &&
974cf5cbf9fSBenjamin Herrenschmidt (!name || !strncmp(p->header.name, name, 12))) {
975cf5cbf9fSBenjamin Herrenschmidt if (out_size)
976cf5cbf9fSBenjamin Herrenschmidt *out_size = (p->header.length - 1) *
977cf5cbf9fSBenjamin Herrenschmidt NVRAM_BLOCK_LEN;
978cf5cbf9fSBenjamin Herrenschmidt return p->index + NVRAM_HEADER_LEN;
979cf5cbf9fSBenjamin Herrenschmidt }
980cf5cbf9fSBenjamin Herrenschmidt }
981cf5cbf9fSBenjamin Herrenschmidt return 0;
982cf5cbf9fSBenjamin Herrenschmidt }
983cf5cbf9fSBenjamin Herrenschmidt
nvram_scan_partitions(void)984edc79a2fSBenjamin Herrenschmidt int __init nvram_scan_partitions(void)
985437a58dbSPaul Mackerras {
986437a58dbSPaul Mackerras loff_t cur_index = 0;
987437a58dbSPaul Mackerras struct nvram_header phead;
988437a58dbSPaul Mackerras struct nvram_partition * tmp_part;
989437a58dbSPaul Mackerras unsigned char c_sum;
990437a58dbSPaul Mackerras char * header;
991437a58dbSPaul Mackerras int total_size;
992437a58dbSPaul Mackerras int err;
993437a58dbSPaul Mackerras
994edc79a2fSBenjamin Herrenschmidt if (ppc_md.nvram_size == NULL || ppc_md.nvram_size() <= 0)
995437a58dbSPaul Mackerras return -ENODEV;
996437a58dbSPaul Mackerras total_size = ppc_md.nvram_size();
997437a58dbSPaul Mackerras
9985cbded58SRobert P. J. Day header = kmalloc(NVRAM_HEADER_LEN, GFP_KERNEL);
999437a58dbSPaul Mackerras if (!header) {
1000437a58dbSPaul Mackerras printk(KERN_ERR "nvram_scan_partitions: Failed kmalloc\n");
1001437a58dbSPaul Mackerras return -ENOMEM;
1002437a58dbSPaul Mackerras }
1003437a58dbSPaul Mackerras
1004437a58dbSPaul Mackerras while (cur_index < total_size) {
1005437a58dbSPaul Mackerras
1006437a58dbSPaul Mackerras err = ppc_md.nvram_read(header, NVRAM_HEADER_LEN, &cur_index);
1007437a58dbSPaul Mackerras if (err != NVRAM_HEADER_LEN) {
1008437a58dbSPaul Mackerras printk(KERN_ERR "nvram_scan_partitions: Error parsing "
1009437a58dbSPaul Mackerras "nvram partitions\n");
1010437a58dbSPaul Mackerras goto out;
1011437a58dbSPaul Mackerras }
1012437a58dbSPaul Mackerras
1013437a58dbSPaul Mackerras cur_index -= NVRAM_HEADER_LEN; /* nvram_read will advance us */
1014437a58dbSPaul Mackerras
1015437a58dbSPaul Mackerras memcpy(&phead, header, NVRAM_HEADER_LEN);
1016437a58dbSPaul Mackerras
1017c81095a4SCedric Le Goater phead.length = be16_to_cpu(phead.length);
1018c81095a4SCedric Le Goater
1019437a58dbSPaul Mackerras err = 0;
1020437a58dbSPaul Mackerras c_sum = nvram_checksum(&phead);
1021437a58dbSPaul Mackerras if (c_sum != phead.checksum) {
1022437a58dbSPaul Mackerras printk(KERN_WARNING "WARNING: nvram partition checksum"
1023437a58dbSPaul Mackerras " was %02x, should be %02x!\n",
1024437a58dbSPaul Mackerras phead.checksum, c_sum);
1025437a58dbSPaul Mackerras printk(KERN_WARNING "Terminating nvram partition scan\n");
1026437a58dbSPaul Mackerras goto out;
1027437a58dbSPaul Mackerras }
1028437a58dbSPaul Mackerras if (!phead.length) {
1029437a58dbSPaul Mackerras printk(KERN_WARNING "WARNING: nvram corruption "
1030437a58dbSPaul Mackerras "detected: 0-length partition\n");
1031437a58dbSPaul Mackerras goto out;
1032437a58dbSPaul Mackerras }
1033a0828cf5SMarkus Elfring tmp_part = kmalloc(sizeof(*tmp_part), GFP_KERNEL);
1034437a58dbSPaul Mackerras err = -ENOMEM;
1035437a58dbSPaul Mackerras if (!tmp_part) {
1036437a58dbSPaul Mackerras printk(KERN_ERR "nvram_scan_partitions: kmalloc failed\n");
1037437a58dbSPaul Mackerras goto out;
1038437a58dbSPaul Mackerras }
1039437a58dbSPaul Mackerras
1040437a58dbSPaul Mackerras memcpy(&tmp_part->header, &phead, NVRAM_HEADER_LEN);
1041437a58dbSPaul Mackerras tmp_part->index = cur_index;
1042690d1a9bSJim Keniston list_add_tail(&tmp_part->partition, &nvram_partitions);
1043437a58dbSPaul Mackerras
1044437a58dbSPaul Mackerras cur_index += phead.length * NVRAM_BLOCK_LEN;
1045437a58dbSPaul Mackerras }
1046437a58dbSPaul Mackerras err = 0;
1047437a58dbSPaul Mackerras
1048edc79a2fSBenjamin Herrenschmidt #ifdef DEBUG_NVRAM
1049edc79a2fSBenjamin Herrenschmidt nvram_print_partitions("NVRAM Partitions");
1050edc79a2fSBenjamin Herrenschmidt #endif
1051edc79a2fSBenjamin Herrenschmidt
1052437a58dbSPaul Mackerras out:
1053437a58dbSPaul Mackerras kfree(header);
1054437a58dbSPaul Mackerras return err;
1055437a58dbSPaul Mackerras }
1056