blob: 6c26c4daaec99765c6fe87cae79a75fa7dc963a6 [file] [log] [blame]
Marco Stornelli56d611a2010-05-26 14:43:54 -07001/*
2 * RAM Oops/Panic logger
3 *
4 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
Kees Cook9ba80d92012-05-03 15:45:02 +10005 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
Marco Stornelli56d611a2010-05-26 14:43:54 -07006 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19 * 02110-1301 USA
20 *
21 */
22
Marco Stornelli01692562011-07-26 16:08:57 -070023#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24
Marco Stornelli56d611a2010-05-26 14:43:54 -070025#include <linux/kernel.h>
James Bottomley83c1b312011-07-29 17:11:32 +040026#include <linux/err.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070027#include <linux/module.h>
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -070028#include <linux/version.h>
Kees Cook9ba80d92012-05-03 15:45:02 +100029#include <linux/pstore.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070030#include <linux/time.h>
31#include <linux/io.h>
32#include <linux/ioport.h>
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -070033#include <linux/platform_device.h>
Marco Stornelli13aefd72011-07-26 16:08:57 -070034#include <linux/slab.h>
Anton Vorontsov24203032012-07-17 19:49:37 -070035#include <linux/compiler.h>
Anton Vorontsov1894a252012-05-16 05:43:08 -070036#include <linux/pstore_ram.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070037
38#define RAMOOPS_KERNMSG_HDR "===="
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -070039#define MIN_MEM_SIZE 4096UL
Marco Stornelli56d611a2010-05-26 14:43:54 -070040
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -070041static ulong record_size = MIN_MEM_SIZE;
42module_param(record_size, ulong, 0400);
43MODULE_PARM_DESC(record_size,
44 "size of each dump done on oops/panic");
Marco Stornelli56d611a2010-05-26 14:43:54 -070045
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070046static ulong ramoops_console_size = MIN_MEM_SIZE;
47module_param_named(console_size, ramoops_console_size, ulong, 0400);
48MODULE_PARM_DESC(console_size, "size of kernel console log");
49
Anton Vorontsova694d1b2012-07-09 17:10:44 -070050static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
51module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
52MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
53
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080054static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
55module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
56MODULE_PARM_DESC(pmsg_size, "size of user space message log");
57
Marco Stornelli56d611a2010-05-26 14:43:54 -070058static ulong mem_address;
59module_param(mem_address, ulong, 0400);
60MODULE_PARM_DESC(mem_address,
61 "start of reserved RAM used to store oops/panic logs");
62
63static ulong mem_size;
64module_param(mem_size, ulong, 0400);
65MODULE_PARM_DESC(mem_size,
66 "size of reserved RAM used to store oops/panic logs");
67
Tony Lindgren027bc8b2014-09-16 13:50:01 -070068static unsigned int mem_type;
69module_param(mem_type, uint, 0600);
70MODULE_PARM_DESC(mem_type,
71 "set to 1 to try to use unbuffered memory (default 0)");
72
Marco Stornelli56d611a2010-05-26 14:43:54 -070073static int dump_oops = 1;
74module_param(dump_oops, int, 0600);
75MODULE_PARM_DESC(dump_oops,
76 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
77
Anton Vorontsov39eb7e972012-05-17 00:15:34 -070078static int ramoops_ecc;
79module_param_named(ecc, ramoops_ecc, int, 0600);
80MODULE_PARM_DESC(ramoops_ecc,
Anton Vorontsov5ca5d4e2012-07-09 17:03:19 -070081 "if non-zero, the option enables ECC support and specifies "
82 "ECC buffer size in bytes (1 is a special value, means 16 "
83 "bytes ECC)");
Anton Vorontsov39eb7e972012-05-17 00:15:34 -070084
Kees Cook9ba80d92012-05-03 15:45:02 +100085struct ramoops_context {
Anton Vorontsov896fc1f2012-05-17 00:15:18 -070086 struct persistent_ram_zone **przs;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070087 struct persistent_ram_zone *cprz;
Anton Vorontsova694d1b2012-07-09 17:10:44 -070088 struct persistent_ram_zone *fprz;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080089 struct persistent_ram_zone *mprz;
Marco Stornelli56d611a2010-05-26 14:43:54 -070090 phys_addr_t phys_addr;
91 unsigned long size;
Tony Lindgren027bc8b2014-09-16 13:50:01 -070092 unsigned int memtype;
Kees Cook9ba80d92012-05-03 15:45:02 +100093 size_t record_size;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070094 size_t console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -070095 size_t ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080096 size_t pmsg_size;
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -070097 int dump_oops;
Arve Hjønnevågc31ad082012-05-22 16:33:23 -070098 struct persistent_ram_ecc_info ecc_info;
Anton Vorontsovcac2eb72012-05-26 06:20:20 -070099 unsigned int max_dump_cnt;
100 unsigned int dump_write_cnt;
Liu ShuoX57fd8352014-03-17 11:24:49 +1100101 /* _read_cnt need clear on ramoops_pstore_open */
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700102 unsigned int dump_read_cnt;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700103 unsigned int console_read_cnt;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700104 unsigned int ftrace_read_cnt;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800105 unsigned int pmsg_read_cnt;
Kees Cook9ba80d92012-05-03 15:45:02 +1000106 struct pstore_info pstore;
107};
Marco Stornelli56d611a2010-05-26 14:43:54 -0700108
Marco Stornelli13aefd72011-07-26 16:08:57 -0700109static struct platform_device *dummy;
110static struct ramoops_platform_data *dummy_data;
111
Kees Cook9ba80d92012-05-03 15:45:02 +1000112static int ramoops_pstore_open(struct pstore_info *psi)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700113{
Kees Cook9ba80d92012-05-03 15:45:02 +1000114 struct ramoops_context *cxt = psi->data;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700115
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700116 cxt->dump_read_cnt = 0;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700117 cxt->console_read_cnt = 0;
Liu ShuoX57fd8352014-03-17 11:24:49 +1100118 cxt->ftrace_read_cnt = 0;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800119 cxt->pmsg_read_cnt = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000120 return 0;
121}
122
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700123static struct persistent_ram_zone *
124ramoops_get_next_prz(struct persistent_ram_zone *przs[], uint *c, uint max,
125 u64 *id,
126 enum pstore_type_id *typep, enum pstore_type_id type,
127 bool update)
128{
129 struct persistent_ram_zone *prz;
130 int i = (*c)++;
131
132 if (i >= max)
133 return NULL;
134
135 prz = przs[i];
Liu ShuoXb0aa9312014-03-17 13:57:49 -0700136 if (!prz)
137 return NULL;
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700138
Liu ShuoXaa9a4a12014-03-17 11:24:49 +1100139 /* Update old/shadowed buffer. */
140 if (update)
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700141 persistent_ram_save_old(prz);
Liu ShuoXaa9a4a12014-03-17 11:24:49 +1100142
143 if (!persistent_ram_old_size(prz))
144 return NULL;
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700145
146 *typep = type;
147 *id = i;
148
149 return prz;
150}
151
Ben Zhanga28726b2014-10-30 17:14:21 -0700152static int ramoops_read_kmsg_hdr(char *buffer, struct timespec *time,
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700153 bool *compressed)
154{
155 char data_type;
Ben Zhanga28726b2014-10-30 17:14:21 -0700156 int header_length = 0;
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700157
Ben Zhanga28726b2014-10-30 17:14:21 -0700158 if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n%n", &time->tv_sec,
159 &time->tv_nsec, &data_type, &header_length) == 3) {
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700160 if (data_type == 'C')
161 *compressed = true;
162 else
163 *compressed = false;
Ben Zhanga28726b2014-10-30 17:14:21 -0700164 } else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu\n%n",
165 &time->tv_sec, &time->tv_nsec, &header_length) == 2) {
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700166 *compressed = false;
167 } else {
168 time->tv_sec = 0;
169 time->tv_nsec = 0;
170 *compressed = false;
171 }
Ben Zhanga28726b2014-10-30 17:14:21 -0700172 return header_length;
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700173}
174
Mark Salyzynf44f9652015-01-13 14:32:50 -0800175static bool prz_ok(struct persistent_ram_zone *prz)
176{
177 return !!prz && !!(persistent_ram_old_size(prz) +
178 persistent_ram_ecc_string(prz, NULL, 0));
179}
180
Kees Cook9ba80d92012-05-03 15:45:02 +1000181static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -0800182 int *count, struct timespec *time,
Aruna Balakrishnaiah9a4e1392013-08-16 13:53:19 -0700183 char **buf, bool *compressed,
184 struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000185{
186 ssize_t size;
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800187 ssize_t ecc_notice_size;
Kees Cook9ba80d92012-05-03 15:45:02 +1000188 struct ramoops_context *cxt = psi->data;
Ben Zhange036bd32015-05-21 09:50:34 -0700189 struct persistent_ram_zone *prz = NULL;
190 int header_length = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000191
Ben Zhange036bd32015-05-21 09:50:34 -0700192 /* Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
193 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
194 * valid time stamps, so it is initialized to zero.
195 */
196 time->tv_sec = 0;
197 time->tv_nsec = 0;
198 *compressed = false;
199
200 /* Find the next valid persistent_ram_zone for DMESG */
201 while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
202 prz = ramoops_get_next_prz(cxt->przs, &cxt->dump_read_cnt,
203 cxt->max_dump_cnt, id, type,
204 PSTORE_TYPE_DMESG, 1);
205 if (!prz_ok(prz))
206 continue;
207 header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
208 time, compressed);
209 /* Clear and skip this DMESG record if it has no valid header */
210 if (!header_length) {
211 persistent_ram_free_old(prz);
212 persistent_ram_zap(prz);
213 prz = NULL;
214 }
215 }
216
Mark Salyzynf44f9652015-01-13 14:32:50 -0800217 if (!prz_ok(prz))
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700218 prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
219 1, id, type, PSTORE_TYPE_CONSOLE, 0);
Mark Salyzynf44f9652015-01-13 14:32:50 -0800220 if (!prz_ok(prz))
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700221 prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
222 1, id, type, PSTORE_TYPE_FTRACE, 0);
Mark Salyzynf44f9652015-01-13 14:32:50 -0800223 if (!prz_ok(prz))
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800224 prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
225 1, id, type, PSTORE_TYPE_PMSG, 0);
226 if (!prz_ok(prz))
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700227 return 0;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700228
Ben Zhange036bd32015-05-21 09:50:34 -0700229 size = persistent_ram_old_size(prz) - header_length;
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800230
231 /* ECC correction notice */
232 ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
233
234 *buf = kmalloc(size + ecc_notice_size + 1, GFP_KERNEL);
Kees Cook9ba80d92012-05-03 15:45:02 +1000235 if (*buf == NULL)
236 return -ENOMEM;
Kees Cook9ba80d92012-05-03 15:45:02 +1000237
Ben Zhanga28726b2014-10-30 17:14:21 -0700238 memcpy(*buf, (char *)persistent_ram_old(prz) + header_length, size);
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800239 persistent_ram_ecc_string(prz, *buf + size, ecc_notice_size + 1);
240
241 return size + ecc_notice_size;
Kees Cook9ba80d92012-05-03 15:45:02 +1000242}
243
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700244static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
245 bool compressed)
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700246{
247 char *hdr;
Kees Cook1e817fb2012-11-19 10:26:16 -0800248 struct timespec timestamp;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700249 size_t len;
250
Kees Cook1e817fb2012-11-19 10:26:16 -0800251 /* Report zeroed timestamp if called before timekeeping has resumed. */
252 if (__getnstimeofday(&timestamp)) {
253 timestamp.tv_sec = 0;
254 timestamp.tv_nsec = 0;
255 }
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700256 hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n",
257 (long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000),
258 compressed ? 'C' : 'D');
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700259 WARN_ON_ONCE(!hdr);
260 len = hdr ? strlen(hdr) : 0;
261 persistent_ram_write(prz, hdr, len);
262 kfree(hdr);
263
264 return len;
265}
266
Anton Vorontsov24203032012-07-17 19:49:37 -0700267static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
268 enum kmsg_dump_reason reason,
269 u64 *id, unsigned int part,
Aruna Balakrishnaiah6bbbca72013-06-27 14:02:56 +0530270 const char *buf,
Aruna Balakrishnaiahb3b515b2013-08-16 13:52:47 -0700271 bool compressed, size_t size,
Anton Vorontsov24203032012-07-17 19:49:37 -0700272 struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000273{
Kees Cook9ba80d92012-05-03 15:45:02 +1000274 struct ramoops_context *cxt = psi->data;
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800275 struct persistent_ram_zone *prz;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700276 size_t hlen;
Kees Cook9ba80d92012-05-03 15:45:02 +1000277
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700278 if (type == PSTORE_TYPE_CONSOLE) {
279 if (!cxt->cprz)
280 return -ENOMEM;
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700281 persistent_ram_write(cxt->cprz, buf, size);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700282 return 0;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700283 } else if (type == PSTORE_TYPE_FTRACE) {
284 if (!cxt->fprz)
285 return -ENOMEM;
286 persistent_ram_write(cxt->fprz, buf, size);
287 return 0;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800288 } else if (type == PSTORE_TYPE_PMSG) {
289 if (!cxt->mprz)
290 return -ENOMEM;
291 persistent_ram_write(cxt->mprz, buf, size);
292 return 0;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700293 }
294
Kees Cook9ba80d92012-05-03 15:45:02 +1000295 if (type != PSTORE_TYPE_DMESG)
296 return -EINVAL;
297
298 /* Out of the various dmesg dump types, ramoops is currently designed
299 * to only store crash logs, rather than storing general kernel logs.
300 */
Seiji Aguchifc2d5572011-01-12 16:59:29 -0800301 if (reason != KMSG_DUMP_OOPS &&
WANG Conga3dd3322012-01-12 17:20:11 -0800302 reason != KMSG_DUMP_PANIC)
Kees Cook9ba80d92012-05-03 15:45:02 +1000303 return -EINVAL;
Seiji Aguchifc2d5572011-01-12 16:59:29 -0800304
Kees Cook9ba80d92012-05-03 15:45:02 +1000305 /* Skip Oopes when configured to do so. */
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -0700306 if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
Kees Cook9ba80d92012-05-03 15:45:02 +1000307 return -EINVAL;
308
309 /* Explicitly only take the first part of any new crash.
310 * If our buffer is larger than kmsg_bytes, this can never happen,
311 * and if our buffer is smaller than kmsg_bytes, we don't want the
312 * report split across multiple records.
313 */
314 if (part != 1)
315 return -ENOSPC;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700316
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800317 if (!cxt->przs)
318 return -ENOSPC;
319
320 prz = cxt->przs[cxt->dump_write_cnt];
321
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700322 hlen = ramoops_write_kmsg_hdr(prz, compressed);
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700323 if (size + hlen > prz->buffer_size)
324 size = prz->buffer_size - hlen;
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700325 persistent_ram_write(prz, buf, size);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700326
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700327 cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
Kees Cook9ba80d92012-05-03 15:45:02 +1000328
329 return 0;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700330}
331
Seiji Aguchi755d4fe2012-11-26 16:07:44 -0800332static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
Seiji Aguchia9efd392012-11-14 20:27:28 +0000333 struct timespec time, struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000334{
Kees Cook9ba80d92012-05-03 15:45:02 +1000335 struct ramoops_context *cxt = psi->data;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700336 struct persistent_ram_zone *prz;
Kees Cook9ba80d92012-05-03 15:45:02 +1000337
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700338 switch (type) {
339 case PSTORE_TYPE_DMESG:
340 if (id >= cxt->max_dump_cnt)
341 return -EINVAL;
342 prz = cxt->przs[id];
343 break;
344 case PSTORE_TYPE_CONSOLE:
345 prz = cxt->cprz;
346 break;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700347 case PSTORE_TYPE_FTRACE:
348 prz = cxt->fprz;
349 break;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800350 case PSTORE_TYPE_PMSG:
351 prz = cxt->mprz;
352 break;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700353 default:
Kees Cook9ba80d92012-05-03 15:45:02 +1000354 return -EINVAL;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700355 }
Kees Cook9ba80d92012-05-03 15:45:02 +1000356
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700357 persistent_ram_free_old(prz);
358 persistent_ram_zap(prz);
Kees Cook9ba80d92012-05-03 15:45:02 +1000359
360 return 0;
361}
362
363static struct ramoops_context oops_cxt = {
364 .pstore = {
365 .owner = THIS_MODULE,
366 .name = "ramoops",
367 .open = ramoops_pstore_open,
368 .read = ramoops_pstore_read,
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700369 .write_buf = ramoops_pstore_write_buf,
Kees Cook9ba80d92012-05-03 15:45:02 +1000370 .erase = ramoops_pstore_erase,
371 },
372};
373
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700374static void ramoops_free_przs(struct ramoops_context *cxt)
375{
376 int i;
377
Liu ShuoX34f0ec82014-03-17 14:07:00 -0700378 cxt->max_dump_cnt = 0;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700379 if (!cxt->przs)
380 return;
381
Anton Vorontsov90b58d92012-06-18 19:15:51 -0700382 for (i = 0; !IS_ERR_OR_NULL(cxt->przs[i]); i++)
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700383 persistent_ram_free(cxt->przs[i]);
384 kfree(cxt->przs);
385}
386
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800387static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
388 phys_addr_t *paddr, size_t dump_mem_sz)
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700389{
390 int err = -ENOMEM;
391 int i;
392
393 if (!cxt->record_size)
394 return 0;
395
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800396 if (*paddr + dump_mem_sz - cxt->phys_addr > cxt->size) {
397 dev_err(dev, "no room for dumps\n");
398 return -ENOMEM;
399 }
400
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700401 cxt->max_dump_cnt = dump_mem_sz / cxt->record_size;
402 if (!cxt->max_dump_cnt)
403 return -ENOMEM;
404
405 cxt->przs = kzalloc(sizeof(*cxt->przs) * cxt->max_dump_cnt,
406 GFP_KERNEL);
407 if (!cxt->przs) {
408 dev_err(dev, "failed to initialize a prz array for dumps\n");
Liu ShuoX34f0ec82014-03-17 14:07:00 -0700409 goto fail_prz;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700410 }
411
412 for (i = 0; i < cxt->max_dump_cnt; i++) {
long.wanglong07239fc2015-05-21 09:47:22 -0700413 cxt->przs[i] = persistent_ram_new(*paddr, cxt->record_size, 0,
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700414 &cxt->ecc_info,
415 cxt->memtype);
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700416 if (IS_ERR(cxt->przs[i])) {
417 err = PTR_ERR(cxt->przs[i]);
418 dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
long.wanglong07239fc2015-05-21 09:47:22 -0700419 cxt->record_size, (unsigned long long)*paddr, err);
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700420 goto fail_prz;
421 }
long.wanglong07239fc2015-05-21 09:47:22 -0700422 *paddr += cxt->record_size;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700423 }
424
425 return 0;
426fail_prz:
427 ramoops_free_przs(cxt);
428 return err;
429}
430
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800431static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
432 struct persistent_ram_zone **prz,
433 phys_addr_t *paddr, size_t sz, u32 sig)
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700434{
435 if (!sz)
436 return 0;
437
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800438 if (*paddr + sz - cxt->phys_addr > cxt->size) {
439 dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
440 sz, (unsigned long long)*paddr,
441 cxt->size, (unsigned long long)cxt->phys_addr);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700442 return -ENOMEM;
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800443 }
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700444
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700445 *prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info, cxt->memtype);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700446 if (IS_ERR(*prz)) {
447 int err = PTR_ERR(*prz);
448
449 dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
450 sz, (unsigned long long)*paddr, err);
451 return err;
452 }
453
454 persistent_ram_zap(*prz);
455
456 *paddr += sz;
457
458 return 0;
459}
460
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800461static int ramoops_probe(struct platform_device *pdev)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700462{
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700463 struct device *dev = &pdev->dev;
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700464 struct ramoops_platform_data *pdata = pdev->dev.platform_data;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700465 struct ramoops_context *cxt = &oops_cxt;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700466 size_t dump_mem_sz;
467 phys_addr_t paddr;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700468 int err = -EINVAL;
469
Kees Cook9ba80d92012-05-03 15:45:02 +1000470 /* Only a single ramoops area allowed at a time, so fail extra
471 * probes.
472 */
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700473 if (cxt->max_dump_cnt)
Kees Cook9ba80d92012-05-03 15:45:02 +1000474 goto fail_out;
475
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700476 if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800477 !pdata->ftrace_size && !pdata->pmsg_size)) {
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700478 pr_err("The memory size and the record/console size must be "
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -0700479 "non-zero\n");
Kees Cook9ba80d92012-05-03 15:45:02 +1000480 goto fail_out;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700481 }
482
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200483 if (pdata->record_size && !is_power_of_2(pdata->record_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200484 pdata->record_size = rounddown_pow_of_two(pdata->record_size);
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200485 if (pdata->console_size && !is_power_of_2(pdata->console_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200486 pdata->console_size = rounddown_pow_of_two(pdata->console_size);
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200487 if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200488 pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800489 if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
490 pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700491
Marco Stornelli13aefd72011-07-26 16:08:57 -0700492 cxt->size = pdata->mem_size;
493 cxt->phys_addr = pdata->mem_address;
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700494 cxt->memtype = pdata->mem_type;
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -0700495 cxt->record_size = pdata->record_size;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700496 cxt->console_size = pdata->console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700497 cxt->ftrace_size = pdata->ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800498 cxt->pmsg_size = pdata->pmsg_size;
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -0700499 cxt->dump_oops = pdata->dump_oops;
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700500 cxt->ecc_info = pdata->ecc_info;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700501
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700502 paddr = cxt->phys_addr;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700503
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800504 dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
505 - cxt->pmsg_size;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700506 err = ramoops_init_przs(dev, cxt, &paddr, dump_mem_sz);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700507 if (err)
508 goto fail_out;
509
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -0700510 err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
511 cxt->console_size, 0);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700512 if (err)
513 goto fail_init_cprz;
514
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -0700515 err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
516 LINUX_VERSION_CODE);
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700517 if (err)
518 goto fail_init_fprz;
519
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800520 err = ramoops_init_prz(dev, cxt, &cxt->mprz, &paddr, cxt->pmsg_size, 0);
521 if (err)
522 goto fail_init_mprz;
523
Kees Cook9ba80d92012-05-03 15:45:02 +1000524 cxt->pstore.data = cxt;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700525 /*
Anton Vorontsova384f6412012-07-19 15:47:11 -0700526 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
527 * have to handle dumps, we must have at least record_size buffer. And
528 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
529 * ZERO_SIZE_PTR).
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700530 */
Anton Vorontsova384f6412012-07-19 15:47:11 -0700531 if (cxt->console_size)
532 cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
533 cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
Kees Cook9ba80d92012-05-03 15:45:02 +1000534 cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
535 spin_lock_init(&cxt->pstore.buf_lock);
536 if (!cxt->pstore.buf) {
537 pr_err("cannot allocate pstore buffer\n");
Wei Yongjun47110b82013-05-07 19:39:20 +0800538 err = -ENOMEM;
Kees Cook9ba80d92012-05-03 15:45:02 +1000539 goto fail_clear;
540 }
541
Kees Cook9ba80d92012-05-03 15:45:02 +1000542 err = pstore_register(&cxt->pstore);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700543 if (err) {
Kees Cook9ba80d92012-05-03 15:45:02 +1000544 pr_err("registering with pstore failed\n");
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700545 goto fail_buf;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700546 }
547
Kees Cookc7552012012-01-12 17:20:59 -0800548 /*
549 * Update the module parameter variables as well so they are visible
550 * through /sys/module/ramoops/parameters/
551 */
552 mem_size = pdata->mem_size;
553 mem_address = pdata->mem_address;
554 record_size = pdata->record_size;
555 dump_oops = pdata->dump_oops;
Wang Long62f269e2015-03-09 07:39:07 +0000556 ramoops_console_size = pdata->console_size;
557 ramoops_pmsg_size = pdata->pmsg_size;
558 ramoops_ftrace_size = pdata->ftrace_size;
Kees Cookc7552012012-01-12 17:20:59 -0800559
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700560 pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
Randy Dunlapd109a672012-05-03 15:45:03 +1000561 cxt->size, (unsigned long long)cxt->phys_addr,
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700562 cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
Kees Cook9ba80d92012-05-03 15:45:02 +1000563
Marco Stornelli56d611a2010-05-26 14:43:54 -0700564 return 0;
565
Kees Cook9ba80d92012-05-03 15:45:02 +1000566fail_buf:
567 kfree(cxt->pstore.buf);
568fail_clear:
569 cxt->pstore.bufsize = 0;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800570 kfree(cxt->mprz);
571fail_init_mprz:
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700572 kfree(cxt->fprz);
573fail_init_fprz:
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700574 kfree(cxt->cprz);
575fail_init_cprz:
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700576 ramoops_free_przs(cxt);
Kees Cook9ba80d92012-05-03 15:45:02 +1000577fail_out:
Marco Stornelli56d611a2010-05-26 14:43:54 -0700578 return err;
579}
580
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700581static int __exit ramoops_remove(struct platform_device *pdev)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700582{
Kees Cook9ba80d92012-05-03 15:45:02 +1000583#if 0
584 /* TODO(kees): We cannot unload ramoops since pstore doesn't support
585 * unregistering yet.
586 */
Marco Stornelli56d611a2010-05-26 14:43:54 -0700587 struct ramoops_context *cxt = &oops_cxt;
588
Marco Stornelli56d611a2010-05-26 14:43:54 -0700589 iounmap(cxt->virt_addr);
590 release_mem_region(cxt->phys_addr, cxt->size);
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700591 cxt->max_dump_cnt = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000592
593 /* TODO(kees): When pstore supports unregistering, call it here. */
594 kfree(cxt->pstore.buf);
595 cxt->pstore.bufsize = 0;
596
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700597 return 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000598#endif
599 return -EBUSY;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700600}
601
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700602static struct platform_driver ramoops_driver = {
Anton Vorontsov924d3712012-06-18 19:15:50 -0700603 .probe = ramoops_probe,
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700604 .remove = __exit_p(ramoops_remove),
605 .driver = {
606 .name = "ramoops",
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700607 },
608};
609
Anton Vorontsov924d3712012-06-18 19:15:50 -0700610static void ramoops_register_dummy(void)
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700611{
Anton Vorontsov924d3712012-06-18 19:15:50 -0700612 if (!mem_size)
613 return;
Marco Stornelli13aefd72011-07-26 16:08:57 -0700614
Anton Vorontsov924d3712012-06-18 19:15:50 -0700615 pr_info("using module parameters\n");
616
617 dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
618 if (!dummy_data) {
619 pr_info("could not allocate pdata\n");
620 return;
Marco Stornelli13aefd72011-07-26 16:08:57 -0700621 }
622
Anton Vorontsov924d3712012-06-18 19:15:50 -0700623 dummy_data->mem_size = mem_size;
624 dummy_data->mem_address = mem_address;
Wang Long07855052015-05-21 09:52:29 -0700625 dummy_data->mem_type = mem_type;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700626 dummy_data->record_size = record_size;
627 dummy_data->console_size = ramoops_console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700628 dummy_data->ftrace_size = ramoops_ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800629 dummy_data->pmsg_size = ramoops_pmsg_size;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700630 dummy_data->dump_oops = dump_oops;
Anton Vorontsov5ca5d4e2012-07-09 17:03:19 -0700631 /*
632 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
633 * (using 1 byte for ECC isn't much of use anyway).
634 */
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700635 dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700636
637 dummy = platform_device_register_data(NULL, "ramoops", -1,
638 dummy_data, sizeof(struct ramoops_platform_data));
639 if (IS_ERR(dummy)) {
640 pr_info("could not create platform device: %ld\n",
641 PTR_ERR(dummy));
642 }
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700643}
644
Anton Vorontsov924d3712012-06-18 19:15:50 -0700645static int __init ramoops_init(void)
646{
647 ramoops_register_dummy();
648 return platform_driver_register(&ramoops_driver);
649}
650postcore_initcall(ramoops_init);
651
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700652static void __exit ramoops_exit(void)
653{
654 platform_driver_unregister(&ramoops_driver);
Jovi Zhangb4a871b2012-08-20 14:58:26 +0800655 platform_device_unregister(dummy);
Marco Stornelli13aefd72011-07-26 16:08:57 -0700656 kfree(dummy_data);
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700657}
Marco Stornelli56d611a2010-05-26 14:43:54 -0700658module_exit(ramoops_exit);
659
660MODULE_LICENSE("GPL");
661MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
662MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");