sys/dev/fdt/fdt_slicer.c

   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/module.h>
  36 #include <sys/slicer.h>
  37
  38 #include <dev/fdt/fdt_common.h>
  39 #include <dev/ofw/ofw_bus.h>
  40 #include <dev/ofw/openfirm.h>
  41
  42 #ifdef DEBUG
  43 #define debugf(fmt, args...) do { printf("%s(): ", __func__);   \
  44     printf(fmt,##args); } while (0)
  45 #else
  46 #define debugf(fmt, args...)
  47 #endif
  48
  49 static int fill_slices(device_t dev, const char *provider,
  50     struct flash_slice *slices, int *slices_num);
  51 static void fdt_slicer_init(void);
  52
  53 static int
  54 fill_slices(device_t dev, const char *provider __unused,
  55     struct flash_slice *slices, int *slices_num)
  56 {
  57         char *slice_name;
  58         phandle_t node, child;
  59         u_long base, size;
  60         int i;
  61         ssize_t nmlen;
  62
  63         /*
  64          * We assume the caller provides buffer for FLASH_SLICES_MAX_NUM
  65          * flash_slice structures.
  66          */
  67         if (slices == NULL) {
  68                 *slices_num = 0;
  69                 return (ENOMEM);
  70         }
  71
  72         i = 0;
  73         node = ofw_bus_get_node(dev);
  74         for (child = OF_child(node); child != 0; child = OF_peer(child)) {
  75
  76                 /* Nodes with a compatible property are not slices. */
  77                 if (OF_hasprop(child, "compatible"))
  78                         continue;
  79
  80                 if (i == FLASH_SLICES_MAX_NUM) {
  81                         debugf("not enough buffer for slice i=%d\n", i);
  82                         break;
  83                 }
  84
  85                 /* Retrieve start and size of the slice. */
  86                 if (fdt_regsize(child, &base, &size) != 0) {
  87                         debugf("error during processing reg property, i=%d\n",
  88                             i);
  89                         continue;
  90                 }
  91
  92                 if (size == 0) {
  93                         debugf("slice i=%d with no size\n", i);
  94                         continue;
  95                 }
  96
  97                 /* Retrieve label. */
  98                 nmlen = OF_getprop_alloc(child, "label", (void **)&slice_name);
  99                 if (nmlen <= 0) {
 100                         /* Use node name if no label defined */
 101                         nmlen = OF_getprop_alloc(child, "name",
 102                             (void **)&slice_name);
 103                         if (nmlen <= 0) {
 104                                 debugf("slice i=%d with no name\n", i);
 105                                 slice_name = NULL;
 106                         }
 107                 }
 108
 109                 /* Fill slice entry data. */
 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(fill_slices, FLASH_SLICES_TYPE_NAND, false);
 125         flash_register_slicer(fill_slices, FLASH_SLICES_TYPE_CFI, false);
 126         flash_register_slicer(fill_slices, FLASH_SLICES_TYPE_SPI, false);
 127 }
 128
 129 static void
 130 fdt_slicer_cleanup(void)
 131 {
 132
 133         flash_register_slicer(NULL, FLASH_SLICES_TYPE_NAND, true);
 134         flash_register_slicer(NULL, FLASH_SLICES_TYPE_CFI, true);
 135         flash_register_slicer(NULL, FLASH_SLICES_TYPE_SPI, true);
 136 }
 137
 138 /*
 139  * Must be initialized after GEOM classes (SI_SUB_DRIVERS/SI_ORDER_FIRST),
 140  * i. e. after g_init() is called, due to the use of the GEOM topology_lock
 141  * in flash_register_slicer().  However, must be before SI_SUB_CONFIGURE.
 142  */
 143 SYSINIT(fdt_slicer, SI_SUB_DRIVERS, SI_ORDER_SECOND, fdt_slicer_init, NULL);
 144 SYSUNINIT(fdt_slicer, SI_SUB_DRIVERS, SI_ORDER_SECOND, fdt_slicer_cleanup, NULL);
 145
 146 static int
 147 mod_handler(module_t mod, int type, void *data)
 148 {
 149
 150         /*
 151          * Nothing to do here: the SYSINIT/SYSUNINIT defined above run
 152          * automatically at module load/unload time.
 153          */
 154         return (0);
 155 }
 156
 157 static moduledata_t fdt_slicer_mod = {
 158         "fdt_slicer", mod_handler, NULL
 159 };
 160
 161 DECLARE_MODULE(fdt_slicer, fdt_slicer_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
 162 MODULE_VERSION(fdt_slicer, 1);