xref: /freebsd/sys/dev/fdt/fdt_slicer.c (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2012 Semihalf.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/slicer.h>
36 
37 #include <dev/fdt/fdt_common.h>
38 #include <dev/ofw/ofw_bus.h>
39 #include <dev/ofw/openfirm.h>
40 
41 #ifdef DEBUG
42 #define debugf(fmt, args...) do { printf("%s(): ", __func__);	\
43     printf(fmt,##args); } while (0)
44 #else
45 #define debugf(fmt, args...)
46 #endif
47 
48 static int fdt_flash_fill_slices(device_t dev, const char *provider,
49     struct flash_slice *slices, int *slices_num);
50 static void fdt_slicer_init(void);
51 
52 static int
53 fdt_flash_fill_slices(device_t dev, const char *provider __unused,
54     struct flash_slice *slices, int *slices_num)
55 {
56 	char *slice_name;
57 	phandle_t dt_node, dt_child;
58 	u_long base, size;
59 	int i;
60 	ssize_t name_len;
61 
62 	/*
63 	 * We assume the caller provides buffer for FLASH_SLICES_MAX_NUM
64 	 * flash_slice structures.
65 	 */
66 	if (slices == NULL) {
67 		*slices_num = 0;
68 		return (ENOMEM);
69 	}
70 
71 	dt_node = ofw_bus_get_node(dev);
72 	for (dt_child = OF_child(dt_node), i = 0; dt_child != 0;
73 	    dt_child = OF_peer(dt_child)) {
74 
75 		if (i == FLASH_SLICES_MAX_NUM) {
76 			debugf("not enough buffer for slice i=%d\n", i);
77 			break;
78 		}
79 
80 		/*
81 		 * Retrieve start and size of the slice.
82 		 */
83 		if (fdt_regsize(dt_child, &base, &size) != 0) {
84 			debugf("error during processing reg property, i=%d\n",
85 			    i);
86 			continue;
87 		}
88 
89 		if (size == 0) {
90 			debugf("slice i=%d with no size\n", i);
91 			continue;
92 		}
93 
94 		/*
95 		 * Retrieve label.
96 		 */
97 		name_len = OF_getprop_alloc(dt_child, "label", sizeof(char),
98 		    (void **)&slice_name);
99 		if (name_len <= 0) {
100 			/* Use node name if no label defined */
101 			name_len = OF_getprop_alloc(dt_child, "name",
102 			    sizeof(char), (void **)&slice_name);
103 			if (name_len <= 0) {
104 				debugf("slice i=%d with no name\n", i);
105 				slice_name = NULL;
106 			}
107 		}
108 
109 		/*
110 		 * Fill slice entry data.
111 		 */
112 		slices[i].base = base;
113 		slices[i].size = size;
114 		slices[i].label = slice_name;
115 		i++;
116 	}
117 
118 	*slices_num = i;
119 	return (0);
120 }
121 
122 static void
123 fdt_slicer_init(void)
124 {
125 
126 	flash_register_slicer(fdt_flash_fill_slices, FLASH_SLICES_TYPE_NAND,
127 	   FALSE);
128 	flash_register_slicer(fdt_flash_fill_slices, FLASH_SLICES_TYPE_CFI,
129 	   FALSE);
130 	flash_register_slicer(fdt_flash_fill_slices, FLASH_SLICES_TYPE_SPI,
131 	   FALSE);
132 }
133 
134 /*
135  * Must be initialized after GEOM classes (SI_SUB_DRIVERS/SI_ORDER_FIRST),
136  * i. e. after g_init() is called, due to the use of the GEOM topology_lock
137  * in flash_register_slicer().  However, must be before SI_SUB_CONFIGURE.
138  */
139 SYSINIT(fdt_slicer_rootconf, SI_SUB_DRIVERS, SI_ORDER_SECOND, fdt_slicer_init,
140     NULL);
141