1/*-
2 * Copyright (c) 2012 Semihalf
3 * Copyright (c) 2009 Jakub Klama <jakub.klama@uj.edu.pl>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: stable/10/sys/geom/geom_flashmap.c 320168 2017-06-20 19:59:57Z marius $");
30
31#include <sys/param.h>
32#include <sys/systm.h>
33#include <sys/kernel.h>
34#include <sys/malloc.h>
35#include <sys/lock.h>
36#include <sys/mutex.h>
37#include <sys/proc.h>
38#include <sys/slicer.h>
39
40#include <geom/geom.h>
41#include <geom/geom_slice.h>
42#include <geom/geom_disk.h>
43
44#include <dev/nand/nand_dev.h>
45
46#define	FLASHMAP_CLASS_NAME "Flashmap"
47
48struct g_flashmap_slice {
49	off_t		sl_start;
50	off_t		sl_end;
51	const char	*sl_name;
52
53	STAILQ_ENTRY(g_flashmap_slice) sl_link;
54};
55
56STAILQ_HEAD(g_flashmap_head, g_flashmap_slice);
57
58static struct {
59	const char	*type;
60	flash_slicer_t	slicer;
61} g_flashmap_slicers[] = {
62	{ "NAND::device",	NULL },
63	{ "CFI::device",	NULL },
64	{ "SPI::device",	NULL },
65	{ "MMC::device",	NULL }
66};
67
68static g_ioctl_t g_flashmap_ioctl;
69static g_taste_t g_flashmap_taste;
70
71static int g_flashmap_load(device_t dev, struct g_provider *pp,
72    flash_slicer_t slicer, struct g_flashmap_head *head);
73static int g_flashmap_modify(struct g_geom *gp, const char *devname,
74    int secsize, struct g_flashmap_head *slices);
75static void g_flashmap_print(struct g_flashmap_slice *slice);
76
77MALLOC_DECLARE(M_FLASHMAP);
78MALLOC_DEFINE(M_FLASHMAP, "geom_flashmap", "GEOM flash memory slicer class");
79
80static void
81g_flashmap_print(struct g_flashmap_slice *slice)
82{
83
84	printf("%08jx-%08jx: %s (%juKB)\n", (uintmax_t)slice->sl_start,
85	    (uintmax_t)slice->sl_end, slice->sl_name,
86	    (uintmax_t)(slice->sl_end - slice->sl_start) / 1024);
87}
88
89static int
90g_flashmap_modify(struct g_geom *gp, const char *devname, int secsize,
91    struct g_flashmap_head *slices)
92{
93	struct g_flashmap_slice *slice;
94	int i, error;
95
96	g_topology_assert();
97
98	i = 0;
99	STAILQ_FOREACH(slice, slices, sl_link) {
100		if (bootverbose) {
101			printf("%s: slice ", devname);
102			g_flashmap_print(slice);
103		}
104
105		error = g_slice_config(gp, i++, G_SLICE_CONFIG_CHECK,
106		    slice->sl_start,
107		    slice->sl_end - slice->sl_start + 1,
108		    secsize, FLASH_SLICES_FMT, gp->name, slice->sl_name);
109
110		if (error)
111			return (error);
112	}
113
114	i = 0;
115	STAILQ_FOREACH(slice, slices, sl_link) {
116		error = g_slice_config(gp, i++, G_SLICE_CONFIG_SET,
117		    slice->sl_start,
118		    slice->sl_end - slice->sl_start + 1,
119		    secsize, "%ss.%s", gp->name, slice->sl_name);
120
121		if (error)
122			return (error);
123	}
124
125	return (0);
126}
127
128static int
129g_flashmap_ioctl(struct g_provider *pp, u_long cmd, void *data, int fflag,
130    struct thread *td)
131{
132	struct g_consumer *cp;
133	struct g_geom *gp;
134
135	if (cmd != NAND_IO_GET_CHIP_PARAM)
136		return (ENOIOCTL);
137
138	cp = LIST_FIRST(&pp->geom->consumer);
139	if (cp == NULL)
140		return (ENOIOCTL);
141	gp = cp->provider->geom;
142	if (gp->ioctl == NULL)
143		return (ENOIOCTL);
144
145	return (gp->ioctl(cp->provider, cmd, data, fflag, td));
146}
147
148static struct g_geom *
149g_flashmap_taste(struct g_class *mp, struct g_provider *pp, int flags)
150{
151	struct g_geom *gp;
152	struct g_consumer *cp;
153	struct g_flashmap_head head;
154	struct g_flashmap_slice *slice, *slice_temp;
155	flash_slicer_t slicer;
156	device_t dev;
157	int i, size;
158
159	g_trace(G_T_TOPOLOGY, "flashmap_taste(%s,%s)", mp->name, pp->name);
160	g_topology_assert();
161
162	if (flags == G_TF_NORMAL &&
163	    strcmp(pp->geom->class->name, G_DISK_CLASS_NAME) != 0)
164		return (NULL);
165
166	gp = g_slice_new(mp, FLASH_SLICES_MAX_NUM, pp, &cp, NULL, 0, NULL);
167	if (gp == NULL)
168		return (NULL);
169
170	STAILQ_INIT(&head);
171
172	do {
173		slicer = NULL;
174		for (i = 0; i < nitems(g_flashmap_slicers); i++) {
175			size = sizeof(device_t);
176			if (g_io_getattr(g_flashmap_slicers[i].type, cp,
177			    &size, &dev) == 0) {
178				slicer = g_flashmap_slicers[i].slicer;
179				break;
180			}
181		}
182		if (slicer == NULL)
183			break;
184
185		if (g_flashmap_load(dev, pp, slicer, &head) == 0)
186			break;
187
188		g_flashmap_modify(gp, cp->provider->name,
189		    cp->provider->sectorsize, &head);
190	} while (0);
191
192	g_access(cp, -1, 0, 0);
193
194	STAILQ_FOREACH_SAFE(slice, &head, sl_link, slice_temp)
195		free(slice, M_FLASHMAP);
196
197	if (LIST_EMPTY(&gp->provider)) {
198		g_slice_spoiled(cp);
199		return (NULL);
200	}
201	return (gp);
202}
203
204static int
205g_flashmap_load(device_t dev, struct g_provider *pp, flash_slicer_t slicer,
206    struct g_flashmap_head *head)
207{
208	struct flash_slice *slices;
209	struct g_flashmap_slice *slice;
210	int i, nslices = 0;
211
212	slices = malloc(sizeof(struct flash_slice) * FLASH_SLICES_MAX_NUM,
213	    M_FLASHMAP, M_WAITOK | M_ZERO);
214	if (slicer(dev, pp->name, slices, &nslices) == 0) {
215		for (i = 0; i < nslices; i++) {
216			slice = malloc(sizeof(struct g_flashmap_slice),
217			    M_FLASHMAP, M_WAITOK);
218
219			slice->sl_name = slices[i].label;
220			slice->sl_start = slices[i].base;
221			slice->sl_end = slices[i].base + slices[i].size - 1;
222
223			STAILQ_INSERT_TAIL(head, slice, sl_link);
224		}
225	}
226
227	free(slices, M_FLASHMAP);
228	return (nslices);
229}
230
231void flash_register_slicer(flash_slicer_t slicer, u_int type, bool force)
232{
233
234	DROP_GIANT();
235	g_topology_lock();
236	if (g_flashmap_slicers[type].slicer == NULL || force == TRUE)
237		g_flashmap_slicers[type].slicer = slicer;
238	g_topology_unlock();
239	PICKUP_GIANT();
240}
241
242static struct g_class g_flashmap_class = {
243	.name = FLASHMAP_CLASS_NAME,
244	.version = G_VERSION,
245	.taste = g_flashmap_taste,
246	.ioctl = g_flashmap_ioctl,
247};
248
249DECLARE_GEOM_CLASS(g_flashmap_class, g_flashmap);
250MODULE_VERSION(g_flashmap, 0);
251