Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/geom/geom_redboot.c
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2009 Sam Leffler, Errno Consulting 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 * without modification. 13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 14 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 15 * redistribution must be conditioned upon including a substantially 16 * similar Disclaimer requirement for further binary redistribution. 17 * 18 * NO WARRANTY 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 22 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 23 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 24 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 27 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 29 * THE POSSIBILITY OF SUCH DAMAGES. 30 */ 31 32 #include <sys/cdefs.h> 33 __FBSDID("$FreeBSD$"); 34 35 #include <sys/param.h> 36 #include <sys/errno.h> 37 #include <sys/endian.h> 38 #include <sys/systm.h> 39 #include <sys/kernel.h> 40 #include <sys/fcntl.h> 41 #include <sys/malloc.h> 42 #include <sys/bio.h> 43 #include <sys/lock.h> 44 #include <sys/mutex.h> 45 #include <sys/bus.h> 46 47 #include <sys/sbuf.h> 48 #include <geom/geom.h> 49 #include <geom/geom_slice.h> 50 51 #define REDBOOT_CLASS_NAME "REDBOOT" 52 53 struct fis_image_desc { 54 uint8_t name[16]; /* null-terminated name */ 55 uint32_t offset; /* offset in flash */ 56 uint32_t addr; /* address in memory */ 57 uint32_t size; /* image size in bytes */ 58 uint32_t entry; /* offset in image for entry point */ 59 uint32_t dsize; /* data size in bytes */ 60 uint8_t pad[256-(16+7*sizeof(uint32_t)+sizeof(void*))]; 61 struct fis_image_desc *next; /* linked list (in memory) */ 62 uint32_t dsum; /* descriptor checksum */ 63 uint32_t fsum; /* checksum over image data */ 64 }; 65 66 #define FISDIR_NAME "FIS directory" 67 #define REDBCFG_NAME "RedBoot config" 68 #define REDBOOT_NAME "RedBoot" 69 70 #define REDBOOT_MAXSLICE 64 71 #define REDBOOT_MAXOFF \ 72 (REDBOOT_MAXSLICE*sizeof(struct fis_image_desc)) 73 74 struct g_redboot_softc { 75 uint32_t entry[REDBOOT_MAXSLICE]; 76 uint32_t dsize[REDBOOT_MAXSLICE]; 77 uint8_t readonly[REDBOOT_MAXSLICE]; 78 g_access_t *parent_access; 79 }; 80 81 static void 82 g_redboot_print(int i, struct fis_image_desc *fd) 83 { 84 85 printf("[%2d] \"%-15.15s\" %08x:%08x", i, fd->name, 86 fd->offset, fd->size); 87 printf(" addr %08x entry %08x\n", fd->addr, fd->entry); 88 printf(" dsize 0x%x dsum 0x%x fsum 0x%x\n", fd->dsize, 89 fd->dsum, fd->fsum); 90 } 91 92 static int 93 g_redboot_ioctl(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td) 94 { 95 return (ENOIOCTL); 96 } 97 98 static int 99 g_redboot_access(struct g_provider *pp, int dread, int dwrite, int dexcl) 100 { 101 struct g_geom *gp = pp->geom; 102 struct g_slicer *gsp = gp->softc; 103 struct g_redboot_softc *sc = gsp->softc; 104 105 if (dwrite > 0 && sc->readonly[pp->index]) 106 return (EPERM); 107 return (sc->parent_access(pp, dread, dwrite, dexcl)); 108 } 109 110 static int 111 g_redboot_start(struct bio *bp) 112 { 113 struct g_provider *pp; 114 struct g_geom *gp; 115 struct g_redboot_softc *sc; 116 struct g_slicer *gsp; 117 int idx; 118 119 pp = bp->bio_to; 120 idx = pp->index; 121 gp = pp->geom; 122 gsp = gp->softc; 123 sc = gsp->softc; 124 if (bp->bio_cmd == BIO_GETATTR) { 125 if (g_handleattr_int(bp, REDBOOT_CLASS_NAME "::entry", 126 sc->entry[idx])) 127 return (1); 128 if (g_handleattr_int(bp, REDBOOT_CLASS_NAME "::dsize", 129 sc->dsize[idx])) 130 return (1); 131 } 132 133 return (0); 134 } 135 136 static void 137 g_redboot_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, 138 struct g_consumer *cp __unused, struct g_provider *pp) 139 { 140 struct g_redboot_softc *sc; 141 struct g_slicer *gsp; 142 143 gsp = gp->softc; 144 sc = gsp->softc; 145 g_slice_dumpconf(sb, indent, gp, cp, pp); 146 if (pp != NULL) { 147 if (indent == NULL) { 148 sbuf_printf(sb, " entry %d", sc->entry[pp->index]); 149 sbuf_printf(sb, " dsize %d", sc->dsize[pp->index]); 150 } else { 151 sbuf_printf(sb, "%s<entry>%d</entry>\n", indent, 152 sc->entry[pp->index]); 153 sbuf_printf(sb, "%s<dsize>%d</dsize>\n", indent, 154 sc->dsize[pp->index]); 155 } 156 } 157 } 158 159 #include <sys/ctype.h> 160 161 static int 162 nameok(const char name[16]) 163 { 164 int i; 165 166 /* descriptor names are null-terminated printable ascii */ 167 for (i = 0; i < 15; i++) 168 if (!isprint(name[i])) 169 break; 170 return (name[i] == '\0'); 171 } 172 173 static struct fis_image_desc * 174 parse_fis_directory(u_char *buf, size_t bufsize, off_t offset, uint32_t offmask) 175 { 176 #define match(a,b) (bcmp(a, b, sizeof(b)-1) == 0) 177 struct fis_image_desc *fd, *efd; 178 struct fis_image_desc *fisdir, *redbcfg; 179 struct fis_image_desc *head, **tail; 180 int i; 181 182 fd = (struct fis_image_desc *)buf; 183 efd = fd + (bufsize / sizeof(struct fis_image_desc)); 184 #if 0 185 /* 186 * Find the start of the FIS table. 187 */ 188 while (fd < efd && fd->name[0] != 0xff) 189 fd++; 190 if (fd == efd) 191 return (NULL); 192 if (bootverbose) 193 printf("RedBoot FIS table starts at 0x%jx\n", 194 offset + fd - (struct fis_image_desc *) buf); 195 #endif 196 /* 197 * Scan forward collecting entries in a list. 198 */ 199 fisdir = redbcfg = NULL; 200 *(tail = &head) = NULL; 201 for (i = 0; fd < efd; i++, fd++) { 202 if (fd->name[0] == 0xff) 203 continue; 204 if (match(fd->name, FISDIR_NAME)) 205 fisdir = fd; 206 else if (match(fd->name, REDBCFG_NAME)) 207 redbcfg = fd; 208 if (nameok(fd->name)) { 209 /* 210 * NB: flash address includes platform mapping; 211 * strip it so we have only a flash offset. 212 */ 213 fd->offset &= offmask; 214 if (bootverbose) 215 g_redboot_print(i, fd); 216 *tail = fd; 217 *(tail = &fd->next) = NULL; 218 } 219 } 220 if (fisdir == NULL) { 221 if (bootverbose) 222 printf("No RedBoot FIS table located at %lu\n", 223 (long) offset); 224 return (NULL); 225 } 226 if (redbcfg != NULL && 227 fisdir->offset + fisdir->size == redbcfg->offset) { 228 /* 229 * Merged FIS/RedBoot config directory. 230 */ 231 if (bootverbose) 232 printf("FIS/RedBoot merged at 0x%jx (not yet)\n", 233 offset + fisdir->offset); 234 /* XXX */ 235 } 236 return head; 237 #undef match 238 } 239 240 static struct g_geom * 241 g_redboot_taste(struct g_class *mp, struct g_provider *pp, int insist) 242 { 243 struct g_geom *gp; 244 struct g_consumer *cp; 245 struct g_redboot_softc *sc; 246 int error, sectorsize, i; 247 struct fis_image_desc *fd, *head; 248 uint32_t offmask; 249 off_t blksize; /* NB: flash block size stored as stripesize */ 250 u_char *buf; 251 off_t offset; 252 const char *value; 253 char *op; 254 255 offset = 0; 256 if (resource_string_value("redboot", 0, "fisoffset", &value) == 0) { 257 offset = strtouq(value, &op, 0); 258 if (*op != '\0') { 259 offset = 0; 260 } 261 } 262 263 g_trace(G_T_TOPOLOGY, "redboot_taste(%s,%s)", mp->name, pp->name); 264 g_topology_assert(); 265 if (!strcmp(pp->geom->class->name, REDBOOT_CLASS_NAME)) 266 return (NULL); 267 /* XXX only taste flash providers */ 268 if (strncmp(pp->name, "cfi", 3) && 269 strncmp(pp->name, "flash/spi", 9)) 270 return (NULL); 271 gp = g_slice_new(mp, REDBOOT_MAXSLICE, pp, &cp, &sc, sizeof(*sc), 272 g_redboot_start); 273 if (gp == NULL) 274 return (NULL); 275 /* interpose our access method */ 276 sc->parent_access = gp->access; 277 gp->access = g_redboot_access; 278 279 sectorsize = cp->provider->sectorsize; 280 blksize = cp->provider->stripesize; 281 if (powerof2(cp->provider->mediasize)) 282 offmask = cp->provider->mediasize-1; 283 else 284 offmask = 0xffffffff; /* XXX */ 285 if (bootverbose) 286 printf("%s: mediasize %ld secsize %d blksize %ju offmask 0x%x\n", 287 __func__, (long) cp->provider->mediasize, sectorsize, 288 (uintmax_t)blksize, offmask); 289 if (sectorsize < sizeof(struct fis_image_desc) || 290 (sectorsize % sizeof(struct fis_image_desc))) 291 return (NULL); 292 g_topology_unlock(); 293 head = NULL; 294 if(offset == 0) 295 offset = cp->provider->mediasize - blksize; 296 again: 297 buf = g_read_data(cp, offset, blksize, NULL); 298 if (buf != NULL) 299 head = parse_fis_directory(buf, blksize, offset, offmask); 300 if (head == NULL && offset != 0) { 301 g_free(buf); 302 offset = 0; /* check the front */ 303 goto again; 304 } 305 g_topology_lock(); 306 if (head == NULL) { 307 g_free(buf); 308 return NULL; 309 } 310 /* 311 * Craft a slice for each entry. 312 */ 313 for (fd = head, i = 0; fd != NULL; fd = fd->next) { 314 if (fd->name[0] == '\0') 315 continue; 316 error = g_slice_config(gp, i, G_SLICE_CONFIG_SET, 317 fd->offset, fd->size, sectorsize, "redboot/%s", fd->name); 318 if (error) 319 printf("%s: g_slice_config returns %d for \"%s\"\n", 320 __func__, error, fd->name); 321 sc->entry[i] = fd->entry; 322 sc->dsize[i] = fd->dsize; 323 /* disallow writing hard-to-recover entries */ 324 sc->readonly[i] = (strcmp(fd->name, FISDIR_NAME) == 0) || 325 (strcmp(fd->name, REDBOOT_NAME) == 0); 326 i++; 327 } 328 g_free(buf); 329 g_access(cp, -1, 0, 0); 330 if (LIST_EMPTY(&gp->provider)) { 331 g_slice_spoiled(cp); 332 return (NULL); 333 } 334 return (gp); 335 } 336 337 static struct g_class g_redboot_class = { 338 .name = REDBOOT_CLASS_NAME, 339 .version = G_VERSION, 340 .taste = g_redboot_taste, 341 .dumpconf = g_redboot_dumpconf, 342 .ioctl = g_redboot_ioctl, 343 }; 344 DECLARE_GEOM_CLASS(g_redboot_class, g_redboot); 345 MODULE_VERSION(geom_redboot, 0);
Cache object: 527f87ac2931d693f2d8dec2e8a862cd
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]