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