blob: 6bdf4e525677a1d774387203047d61a12c64a969 [file] [log] [blame]
Scott Wood9a310d22008-01-15 17:54:43 -06001/*
2 * Flash partitions described by the OF (or flattened) device tree
3 *
David Woodhousea1452a32010-08-08 20:58:20 +01004 * Copyright © 2006 MontaVista Software Inc.
Scott Wood9a310d22008-01-15 17:54:43 -06005 * Author: Vitaly Wool <vwool@ru.mvista.com>
6 *
7 * Revised to handle newer style flash binding by:
David Woodhousea1452a32010-08-08 20:58:20 +01008 * Copyright © 2007 David Gibson, IBM Corporation.
Scott Wood9a310d22008-01-15 17:54:43 -06009 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 */
15
16#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/of.h>
19#include <linux/mtd/mtd.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Scott Wood9a310d22008-01-15 17:54:43 -060021#include <linux/mtd/partitions.h>
22
Josh Wue79265b2013-08-05 19:14:38 +080023static bool node_has_compatible(struct device_node *pp)
24{
25 return of_get_property(pp, "compatible", NULL);
26}
27
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +040028static int parse_ofpart_partitions(struct mtd_info *master,
Brian Norrisb9adf462015-12-04 15:25:14 -080029 const struct mtd_partition **pparts,
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +040030 struct mtd_part_parser_data *data)
31{
Brian Norrisc3168d22015-12-04 15:25:13 -080032 struct mtd_partition *parts;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000033 struct device_node *mtd_node;
34 struct device_node *ofpart_node;
Scott Wood9a310d22008-01-15 17:54:43 -060035 const char *partname;
36 struct device_node *pp;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000037 int nr_parts, i, ret = 0;
38 bool dedicated = true;
Scott Wood9a310d22008-01-15 17:54:43 -060039
Dmitry Eremin-Solenikov628376f2011-05-30 01:05:33 +040040
Brian Norrise270bca2015-10-30 20:33:29 -070041 /* Pull of_node from the master device node */
42 mtd_node = mtd_get_of_node(master);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000043 if (!mtd_node)
Dmitry Eremin-Solenikov628376f2011-05-30 01:05:33 +040044 return 0;
45
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000046 ofpart_node = of_get_child_by_name(mtd_node, "partitions");
47 if (!ofpart_node) {
Brian Norris8c62b4e2015-12-03 14:26:52 -080048 /*
49 * We might get here even when ofpart isn't used at all (e.g.,
50 * when using another parser), so don't be louder than
51 * KERN_DEBUG
52 */
Rob Herring1d706072017-07-18 16:43:17 -050053 pr_debug("%s: 'partitions' subnode not found on %pOF. Trying to parse direct subnodes as partitions.\n",
54 master->name, mtd_node);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000055 ofpart_node = mtd_node;
56 dedicated = false;
Brian Norrise488ca92015-12-03 14:47:32 -080057 } else if (!of_device_is_compatible(ofpart_node, "fixed-partitions")) {
58 /* The 'partitions' subnode might be used by another parser */
59 return 0;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000060 }
61
Scott Wood9a310d22008-01-15 17:54:43 -060062 /* First count the subnodes */
Scott Wood9a310d22008-01-15 17:54:43 -060063 nr_parts = 0;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000064 for_each_child_of_node(ofpart_node, pp) {
65 if (!dedicated && node_has_compatible(pp))
Josh Wue79265b2013-08-05 19:14:38 +080066 continue;
67
Scott Wood9a310d22008-01-15 17:54:43 -060068 nr_parts++;
Josh Wue79265b2013-08-05 19:14:38 +080069 }
Scott Wood9a310d22008-01-15 17:54:43 -060070
71 if (nr_parts == 0)
72 return 0;
73
Brian Norrisc3168d22015-12-04 15:25:13 -080074 parts = kzalloc(nr_parts * sizeof(*parts), GFP_KERNEL);
75 if (!parts)
Scott Wood9a310d22008-01-15 17:54:43 -060076 return -ENOMEM;
77
Scott Wood9a310d22008-01-15 17:54:43 -060078 i = 0;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000079 for_each_child_of_node(ofpart_node, pp) {
Ian Munsie766f2712010-10-01 17:06:08 +100080 const __be32 *reg;
Scott Wood9a310d22008-01-15 17:54:43 -060081 int len;
Joe Schaack05ff8c22013-02-21 16:29:45 -060082 int a_cells, s_cells;
Scott Wood9a310d22008-01-15 17:54:43 -060083
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000084 if (!dedicated && node_has_compatible(pp))
Josh Wue79265b2013-08-05 19:14:38 +080085 continue;
86
Benjamin Krillebd5a742009-08-25 15:52:41 +020087 reg = of_get_property(pp, "reg", &len);
88 if (!reg) {
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000089 if (dedicated) {
Rob Herring1d706072017-07-18 16:43:17 -050090 pr_debug("%s: ofpart partition %pOF (%pOF) missing reg property.\n",
91 master->name, pp,
92 mtd_node);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +000093 goto ofpart_fail;
94 } else {
95 nr_parts--;
96 continue;
97 }
Benjamin Krill4b08e142009-01-23 17:18:05 +010098 }
99
Joe Schaack05ff8c22013-02-21 16:29:45 -0600100 a_cells = of_n_addr_cells(pp);
101 s_cells = of_n_size_cells(pp);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000102 if (len / 4 != a_cells + s_cells) {
Rob Herring1d706072017-07-18 16:43:17 -0500103 pr_debug("%s: ofpart partition %pOF (%pOF) error parsing reg property.\n",
104 master->name, pp,
105 mtd_node);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000106 goto ofpart_fail;
107 }
108
Brian Norrisc3168d22015-12-04 15:25:13 -0800109 parts[i].offset = of_read_number(reg, a_cells);
110 parts[i].size = of_read_number(reg + a_cells, s_cells);
Sascha Hauer42e94012017-02-09 11:50:24 +0100111 parts[i].of_node = pp;
Scott Wood9a310d22008-01-15 17:54:43 -0600112
113 partname = of_get_property(pp, "label", &len);
114 if (!partname)
115 partname = of_get_property(pp, "name", &len);
Brian Norrisc3168d22015-12-04 15:25:13 -0800116 parts[i].name = partname;
Scott Wood9a310d22008-01-15 17:54:43 -0600117
118 if (of_get_property(pp, "read-only", &len))
Brian Norrisc3168d22015-12-04 15:25:13 -0800119 parts[i].mask_flags |= MTD_WRITEABLE;
Josh Radelab0b00b2012-11-14 14:11:32 -0800120
121 if (of_get_property(pp, "lock", &len))
Brian Norrisc3168d22015-12-04 15:25:13 -0800122 parts[i].mask_flags |= MTD_POWERUP_LOCK;
Scott Wood9a310d22008-01-15 17:54:43 -0600123
124 i++;
125 }
126
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000127 if (!nr_parts)
128 goto ofpart_none;
Benjamin Krillebd5a742009-08-25 15:52:41 +0200129
Brian Norrisc3168d22015-12-04 15:25:13 -0800130 *pparts = parts;
Scott Wood9a310d22008-01-15 17:54:43 -0600131 return nr_parts;
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000132
133ofpart_fail:
Rob Herring1d706072017-07-18 16:43:17 -0500134 pr_err("%s: error parsing ofpart partition %pOF (%pOF)\n",
135 master->name, pp, mtd_node);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000136 ret = -EINVAL;
137ofpart_none:
138 of_node_put(pp);
Brian Norrisc3168d22015-12-04 15:25:13 -0800139 kfree(parts);
Michal Suchanek5cfdedb2015-08-18 15:34:09 +0000140 return ret;
Scott Wood9a310d22008-01-15 17:54:43 -0600141}
Adrian Bunk950bcb22008-04-14 17:19:46 +0300142
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400143static struct mtd_part_parser ofpart_parser = {
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400144 .parse_fn = parse_ofpart_partitions,
145 .name = "ofpart",
146};
147
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400148static int parse_ofoldpart_partitions(struct mtd_info *master,
Brian Norrisb9adf462015-12-04 15:25:14 -0800149 const struct mtd_partition **pparts,
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400150 struct mtd_part_parser_data *data)
151{
Brian Norrisc3168d22015-12-04 15:25:13 -0800152 struct mtd_partition *parts;
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400153 struct device_node *dp;
154 int i, plen, nr_parts;
155 const struct {
156 __be32 offset, len;
157 } *part;
158 const char *names;
159
Brian Norrise270bca2015-10-30 20:33:29 -0700160 /* Pull of_node from the master device node */
161 dp = mtd_get_of_node(master);
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400162 if (!dp)
163 return 0;
164
165 part = of_get_property(dp, "partitions", &plen);
166 if (!part)
167 return 0; /* No partitions found */
168
Rob Herring1d706072017-07-18 16:43:17 -0500169 pr_warn("Device tree uses obsolete partition map binding: %pOF\n", dp);
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400170
171 nr_parts = plen / sizeof(part[0]);
172
Brian Norrisc3168d22015-12-04 15:25:13 -0800173 parts = kzalloc(nr_parts * sizeof(*parts), GFP_KERNEL);
174 if (!parts)
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400175 return -ENOMEM;
176
177 names = of_get_property(dp, "partition-names", &plen);
178
179 for (i = 0; i < nr_parts; i++) {
Brian Norrisc3168d22015-12-04 15:25:13 -0800180 parts[i].offset = be32_to_cpu(part->offset);
181 parts[i].size = be32_to_cpu(part->len) & ~1;
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400182 /* bit 0 set signifies read only partition */
183 if (be32_to_cpu(part->len) & 1)
Brian Norrisc3168d22015-12-04 15:25:13 -0800184 parts[i].mask_flags = MTD_WRITEABLE;
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400185
186 if (names && (plen > 0)) {
187 int len = strlen(names) + 1;
188
Brian Norrisc3168d22015-12-04 15:25:13 -0800189 parts[i].name = names;
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400190 plen -= len;
191 names += len;
192 } else {
Brian Norrisc3168d22015-12-04 15:25:13 -0800193 parts[i].name = "unnamed";
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400194 }
195
196 part++;
197 }
198
Brian Norrisc3168d22015-12-04 15:25:13 -0800199 *pparts = parts;
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400200 return nr_parts;
201}
202
203static struct mtd_part_parser ofoldpart_parser = {
Dmitry Eremin-Solenikovfbcf62a2011-05-30 01:26:17 +0400204 .parse_fn = parse_ofoldpart_partitions,
205 .name = "ofoldpart",
206};
207
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400208static int __init ofpart_parser_init(void)
209{
Axel Lin6e14a612013-12-01 19:01:06 +0800210 register_mtd_parser(&ofpart_parser);
211 register_mtd_parser(&ofoldpart_parser);
212 return 0;
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400213}
214
Lubomir Rintel422f3892013-01-16 02:12:50 +0100215static void __exit ofpart_parser_exit(void)
216{
217 deregister_mtd_parser(&ofpart_parser);
218 deregister_mtd_parser(&ofoldpart_parser);
219}
220
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400221module_init(ofpart_parser_init);
Lubomir Rintel422f3892013-01-16 02:12:50 +0100222module_exit(ofpart_parser_exit);
Dmitry Eremin-Solenikovd26c87d2011-05-29 21:32:33 +0400223
Adrian Bunk950bcb22008-04-14 17:19:46 +0300224MODULE_LICENSE("GPL");
Dmitry Eremin-Solenikovd6137ba2011-06-27 01:02:59 +0400225MODULE_DESCRIPTION("Parser for MTD partitioning information in device tree");
226MODULE_AUTHOR("Vitaly Wool, David Gibson");
Dmitry Eremin-Solenikov9786f6e2011-06-27 16:34:46 +0400227/*
228 * When MTD core cannot find the requested parser, it tries to load the module
229 * with the same name. Since we provide the ofoldpart parser, we should have
230 * the corresponding alias.
231 */
232MODULE_ALIAS("ofoldpart");