summaryrefslogtreecommitdiff
path: root/util/nvmutil/nvmutil.c
diff options
context:
space:
mode:
Diffstat (limited to 'util/nvmutil/nvmutil.c')
-rw-r--r--util/nvmutil/nvmutil.c530
1 files changed, 108 insertions, 422 deletions
diff --git a/util/nvmutil/nvmutil.c b/util/nvmutil/nvmutil.c
index 05459bb7..5217dd5f 100644
--- a/util/nvmutil/nvmutil.c
+++ b/util/nvmutil/nvmutil.c
@@ -1,472 +1,158 @@
-/* SPDX-License-Identifier: MIT */
-/* Copyright (c) 2022-2025 Leah Rowe <leah@libreboot.org> */
-/* Copyright (c) 2023 Riku Viitanen <riku.viitanen@protonmail.com> */
+/* SPDX-License-Identifier: MIT
+ *
+ * Copyright (c) 2022-2026 Leah Rowe <leah@libreboot.org>
+ *
+ * This tool lets you modify Intel GbE NVM (Gigabit Ethernet
+ * Non-Volatile Memory) images, e.g. change the MAC address.
+ * These images configure your Intel Gigabit Ethernet adapter.
+ *
+ * This code is designed to be portable, running on as many
+ * Unix and Unix-like systems as possible (mainly BSD/Linux).
+ */
+#ifdef __OpenBSD__
+#include <sys/param.h>
+#endif
+#include <sys/types.h>
#include <sys/stat.h>
-#include <dirent.h>
-#include <err.h>
#include <errno.h>
#include <fcntl.h>
-#include <stdint.h>
+#include <limits.h>
+#include <stdarg.h>
+#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <time.h>
#include <unistd.h>
-void cmd_setchecksum(void), cmd_brick(void), swap(int partnum), writeGbe(void),
- cmd_dump(void), cmd_setmac(void), readGbe(void), checkdir(const char *path),
- macf(int partnum), hexdump(int partnum), openFiles(const char *path),
- cmd_copy(void), parseMacString(const char *strMac, uint16_t *mac),
- cmd_swap(void);
-int goodChecksum(int partnum);
-uint8_t hextonum(char chs), rhex(void);
-
-#define COMMAND argv[2]
-#define MAC_ADDRESS argv[3]
-#define PARTN argv[3]
-#define NVM_CHECKSUM 0xBABA
-#define NVM_CHECKSUM_WORD 0x3F
-#define NVM_SIZE 128
-
-#define SIZE_4KB 0x1000
-#define SIZE_8KB 0x2000
-#define SIZE_16KB 0x4000
-#define SIZE_128KB 0x20000
-
-uint16_t mac[3] = {0, 0, 0};
-ssize_t nf;
-size_t partsize, gbe[2];
-uint8_t nvmPartChanged[2] = {0, 0}, do_read[2] = {1, 1};
-int flags, rfd, fd, part;
-
-const char *strMac = NULL, *strRMac = "xx:xx:xx:xx:xx:xx", *filename = NULL;
-
-typedef struct op {
- char *str;
- void (*cmd)(void);
- int args;
-} op_t;
-op_t op[] = {
-{ .str = "dump", .cmd = cmd_dump, .args = 3},
-{ .str = "setmac", .cmd = cmd_setmac, .args = 3},
-{ .str = "swap", .cmd = cmd_swap, .args = 3},
-{ .str = "copy", .cmd = cmd_copy, .args = 4},
-{ .str = "brick", .cmd = cmd_brick, .args = 4},
-{ .str = "setchecksum", .cmd = cmd_setchecksum, .args = 4},
-};
-void (*cmd)(void) = NULL;
-
-#define ERR() errno = errno ? errno : ECANCELED
-#define err_if(x) if (x) err(ERR(), "%s", filename)
-
-#define xopen(f,l,p) if ((f = open(l, p)) == -1) err(ERR(), "%s", l); \
- if (fstat(f, &st) == -1) err(ERR(), "%s", l)
-
-#define word(pos16, partnum) ((uint16_t *) gbe[partnum])[pos16]
-#define setWord(pos16, p, val16) if (word(pos16, p) != val16) \
- nvmPartChanged[p] = 1 | (word(pos16, p) = val16)
+#include "include/common.h"
int
main(int argc, char *argv[])
{
-#ifdef __OpenBSD__
- err_if(pledge("stdio rpath wpath unveil", NULL) == -1);
-#endif
+ struct xstate *x;
+ struct commands *cmd;
+ struct xfile *f;
+ unsigned long i;
- if (argc < 2) {
-#ifdef __OpenBSD__
- err_if(pledge("stdio", NULL) == -1);
-#endif
- fprintf(stderr, "Modify Intel GbE NVM images e.g. set MAC\n");
- fprintf(stderr, "USAGE:\n");
- fprintf(stderr, " %s FILE dump\n", argv[0]);
- fprintf(stderr, " %s FILE\n # same as setmac without arg\n",
- argv[0]);
- fprintf(stderr, " %s FILE setmac [MAC]\n", argv[0]);
- fprintf(stderr, " %s FILE swap\n", argv[0]);
- fprintf(stderr, " %s FILE copy 0|1\n", argv[0]);
- fprintf(stderr, " %s FILE brick 0|1\n", argv[0]);
- fprintf(stderr, " %s FILE setchecksum 0|1\n", argv[0]);
- err(errno = ECANCELED, "Too few arguments");
- }
+ char *tmp_path;
- filename = argv[1];
+ struct stat st;
+ int fd;
- flags = O_RDWR;
+ tmp_path = NULL;
- if (argc > 2) {
- if (strcmp(COMMAND, "dump") == 0) {
- flags = O_RDONLY;
-#ifdef __OpenBSD__
- err_if(pledge("stdio rpath unveil", NULL) == -1);
+#ifndef S_ISREG
+ err(ECANCELED, "Can't determine file types (S_ISREG undefined)");
#endif
- }
- }
-
- checkdir("/dev/urandom");
- checkdir(filename);
-
-#ifdef __OpenBSD__
- err_if(unveil("/dev/urandom", "r") == -1);
- if (flags == O_RDONLY) {
- err_if(unveil(filename, "r") == -1);
- err_if(unveil(NULL, NULL) == -1);
- err_if(pledge("stdio rpath", NULL) == -1);
- } else {
- err_if(unveil(filename, "rw") == -1);
- err_if(unveil(NULL, NULL) == -1);
- err_if(pledge("stdio rpath wpath", NULL) == -1);
- }
+#ifndef CHAR_BIT
+ err(ECANCELED, "Unknown char size");
+#else
+ if (CHAR_BIT != 8)
+ err(EINVAL, "Unsupported char size");
#endif
- openFiles(filename);
-#ifdef __OpenBSD__
- err_if(pledge("stdio", NULL) == -1);
+ if (argc < 3)
+ usage();
+
+#ifdef NVMUTIL_UNVEIL
+ /*
+ * if global tmp is a different filesystem,
+ * unveil would trap on final file rename
+ * and we can't know the path in advance
+ */
+ tmp_path = new_tmpfile(&fd, 1, NULL);
+#else
+ tmp_path = new_tmpfile(&fd, 0, NULL);
#endif
- if (argc > 2) {
- for (int i = 0; (i < 6) && (cmd == NULL); i++) {
- if (strcmp(COMMAND, op[i].str) != 0)
- continue;
- if (argc >= op[i].args) {
- cmd = op[i].cmd;
- break;
- }
- err(errno = EINVAL, "Too few args on command '%s'",
- op[i].str);
- }
- } else {
- cmd = cmd_setmac;
- }
-
- if ((cmd == NULL) && (argc > 2)) { /* nvm gbe [MAC] */
- strMac = COMMAND;
- cmd = cmd_setmac;
- } else if (cmd == cmd_setmac) { /* nvm gbe setmac [MAC] */
- strMac = strRMac; /* random MAC */
- if (argc > 3)
- strMac = MAC_ADDRESS;
- } else if ((cmd != NULL) && (argc > 3)) { /* user-supplied partnum */
- err_if((errno = (!((part = PARTN[0] - '0') == 0 || part == 1))
- || PARTN[1] ? EINVAL : errno)); /* only allow '0' or '1' */
- }
- err_if((errno = (cmd == NULL) ? EINVAL : errno));
-
- readGbe();
- (*cmd)();
- writeGbe();
-
- err_if((errno != 0) && (cmd != cmd_dump));
- return errno;
-}
-
-void
-checkdir(const char *path)
-{
- if (opendir(path) != NULL)
- err(errno = EISDIR, "%s", path);
- if (errno == ENOTDIR)
- errno = 0;
- err_if(errno);
-}
-
-void
-openFiles(const char *path)
-{
- struct stat st;
-
- xopen(fd, path, flags);
-
- switch(st.st_size) {
- case SIZE_8KB:
- case SIZE_16KB:
- case SIZE_128KB:
- partsize = st.st_size >> 1;
- break;
- default:
- err(errno = ECANCELED, "Invalid file size (not 8/16/128KiB)");
- break;
- }
-
- xopen(rfd, "/dev/urandom", O_RDONLY);
-}
-
-void
-readGbe(void)
-{
- if ((cmd == cmd_swap) || (cmd == cmd_copy))
- nf = SIZE_4KB;
- else
- nf = NVM_SIZE;
+ if (tmp_path == NULL)
+ err(errno, "Can't create tmpfile");
+
+#ifdef NVMUTIL_PLEDGE
+#ifdef NVMUTIL_UNVEIL
+ if (pledge("stdio flock rpath wpath cpath unveil", NULL) == -1)
+ err(errno, "pledge, unveil");
+ if (unveil("/dev/null", "r") == -1)
+ err(errno, "unveil: /dev/null");
+#else
+ if (pledge("stdio flock rpath wpath cpath", NULL) == -1)
+ err(errno, "pledge");
+#endif
+#endif
- if ((cmd == cmd_copy) || (cmd == cmd_setchecksum) || (cmd == cmd_brick))
- do_read[part ^ 1] = 0;
+ x = xstatus();
- char *buf = malloc(nf << (do_read[0] & do_read[1]));
- if (buf == NULL)
+ if (x == NULL)
err(errno, NULL);
+ if (x->f.buf == NULL)
+ err(EINVAL, "Work buffer not initialised");
- gbe[0] = (size_t) buf;
- gbe[1] = gbe[0] + (nf * (do_read[0] & do_read[1]));
-
- ssize_t tnr = 0;
-
- for (int p = 0; p < 2; p++) {
- if (!do_read[p])
- continue;
-
- ssize_t nr = pread(fd, (uint8_t *) gbe[p], nf, p * partsize);
- err_if(nr == -1);
- if (nr != nf)
- err(errno == ECANCELED,
- "%ld bytes read from '%s', expected %ld bytes\n",
- nr, filename, nf);
-
- tnr += nr;
- swap(p); /* handle big-endian host CPU */
- }
-
- printf("%ld bytes read from file '%s'\n", tnr, filename);
-}
-
-void
-cmd_setmac(void)
-{
- int mac_updated = 0;
- parseMacString(strMac, mac);
-
- printf("MAC address to be written: %s\n", strMac);
-
- for (int partnum = 0; partnum < 2; partnum++) {
- if (!goodChecksum(part = partnum))
- continue;
+ x->argv0 = argv[0];
+ f = &x->f;
- for (int w = 0; w < 3; w++)
- setWord(w, partnum, mac[w]);
+ f->fname = argv[1];
+ f->tname = tmp_path;
+ f->tmp_fd = fd;
- printf("Wrote MAC address to part %d: ", partnum);
- macf(partnum);
+ if(fstat(fd, &st) < 0)
+ err(errno, "can't stat tmpfile");
- cmd_setchecksum();
- mac_updated = 1;
- }
-
- if (mac_updated)
- errno = 0;
-}
-
-void
-parseMacString(const char *strMac, uint16_t *mac)
-{
- uint64_t total = 0;
- if (strnlen(strMac, 20) != 17)
- err(errno = EINVAL, "Invalid MAC address string length");
-
- for (uint8_t h, i = 0; i < 16; i += 3) {
- if (i != 15)
- if (strMac[i + 2] != ':')
- err(errno = EINVAL,
- "Invalid MAC address separator '%c'",
- strMac[i + 2]);
-
- int byte = i / 3;
-
- for (int nib = 0; nib < 2; nib++, total += h) {
- if ((h = hextonum(strMac[i + nib])) > 15)
- err(errno = EINVAL, "Invalid character '%c'",
- strMac[i + nib]);
-
- /* If random, ensure that local/unicast bits are set */
- if ((byte == 0) && (nib == 1))
- if ((strMac[i + nib] == '?') ||
- (strMac[i + nib] == 'x') ||
- (strMac[i + nib] == 'X')) /* random */
- h = (h & 0xE) | 2; /* local, unicast */
-
- mac[byte >> 1] |= ((uint16_t ) h)
- << ((8 * (byte % 2)) + (4 * (nib ^ 1)));
- }
- }
-
- if (total == 0)
- err(errno = EINVAL, "Invalid MAC (all-zero MAC address)");
- if (mac[0] & 1)
- err(errno = EINVAL, "Invalid MAC (multicast bit set)");
-}
-
-uint8_t
-hextonum(char ch)
-{
- if ((ch >= '0') && (ch <= '9'))
- return ch - '0';
- else if ((ch >= 'A') && (ch <= 'F'))
- return ch - 'A' + 10;
- else if ((ch >= 'a') && (ch <= 'f'))
- return ch - 'a' + 10;
- else if ((ch == '?') || (ch == 'x') || (ch == 'X'))
- return rhex(); /* random hex value */
- else
- return 16; /* error: invalid character */
-}
-
-uint8_t
-rhex(void)
-{
- static uint8_t n = 0, rnum[16];
- if (!n)
- err_if(pread(rfd, (uint8_t *) &rnum, (n = 15) + 1, 0) == -1);
- return rnum[n--] & 0xf;
-}
-
-void
-cmd_dump(void)
-{
- for (int partnum = 0, numInvalid = 0; partnum < 2; partnum++) {
- if ((cmd != cmd_dump) && (flags != O_RDONLY) &&
- (!nvmPartChanged[partnum]))
- continue;
-
- if (!goodChecksum(partnum))
- ++numInvalid;
+ f->tmp_dev = st.st_dev;
+ f->tmp_ino = st.st_ino;
- printf("MAC (part %d): ", partnum);
- macf(partnum);
- hexdump(partnum);
+ sanitize_command_list();
- if ((numInvalid < 2) && (partnum))
- errno = 0;
- }
-}
+ set_cmd(argc, argv);
+ set_cmd_args(argc, argv);
-void
-macf(int partnum)
-{
- for (int c = 0; c < 3; c++) {
- uint16_t val16 = word(c, partnum);
- printf("%02x:%02x", val16 & 0xff, val16 >> 8);
- if (c == 2)
- printf("\n");
- else
- printf(":");
- }
-}
+ i = x->i;
+ cmd = &x->cmd[i];
-void
-hexdump(int partnum)
-{
- for (int row = 0; row < 8; row++) {
- printf("%08x ", row << 4);
- for (int c = 0; c < 8; c++) {
- uint16_t val16 = word((row << 3) + c, partnum);
- if (c == 4)
- printf(" ");
- printf(" %02x %02x", val16 & 0xff, val16 >> 8);
- }
- printf("\n");
+#ifdef NVMUTIL_UNVEIL
+ if ((cmd->flags & O_ACCMODE) == O_RDONLY) {
+ if (unveil(f->fname, "r") == -1)
+ err(errno, "%s: unveil r", f->fname);
+ } else {
+ if (unveil(f->tname, "rwc") == -1)
+ err(errno, "%s: unveil rw", f->tname);
}
-}
-
-void
-cmd_setchecksum(void)
-{
- uint16_t val16 = 0;
- for (int c = 0; c < NVM_CHECKSUM_WORD; c++)
- val16 += word(c, part);
-
- setWord(NVM_CHECKSUM_WORD, part, NVM_CHECKSUM - val16);
-}
-
-void
-cmd_brick(void)
-{
- if (goodChecksum(part))
- setWord(NVM_CHECKSUM_WORD, part,
- ((word(NVM_CHECKSUM_WORD, part)) ^ 0xFF));
-}
-
-void
-cmd_copy(void)
-{
- nvmPartChanged[part ^ 1] = goodChecksum(part);
-}
-
-void
-cmd_swap(void) {
- err_if(!(goodChecksum(0) || goodChecksum(1)));
- errno = 0;
- gbe[0] ^= gbe[1];
- gbe[1] ^= gbe[0];
- gbe[0] ^= gbe[1];
+ if (unveil(f->tname, "rwc") == -1)
+ err(errno, "%s: unveil rwc", f->tname);
- nvmPartChanged[0] = nvmPartChanged[1] = 1;
-}
-
-int
-goodChecksum(int partnum)
-{
- uint16_t total = 0;
- for(int w = 0; w <= NVM_CHECKSUM_WORD; w++)
- total += word(w, partnum);
+ if (unveil(NULL, NULL) == -1)
+ err(errno, "unveil block (rw)");
- if (total == NVM_CHECKSUM)
- return 1;
+ if (pledge("stdio flock rpath wpath cpath", NULL) == -1)
+ err(errno, "pledge (kill unveil)");
+#endif
- fprintf(stderr, "WARNING: BAD checksum in part %d\n", partnum);
- errno = ECANCELED;
- return 0;
-}
+ open_gbe_file();
-void
-writeGbe(void)
-{
- ssize_t tnw = 0;
+ memset(f->buf, 0, GBE_BUF_SIZE);
+ memset(f->bufcmp, 0, GBE_BUF_SIZE);
- for (int p = 0; p < 2; p++) {
- if ((!nvmPartChanged[p]) || (flags == O_RDONLY))
- continue;
+ copy_gbe();
- swap(p); /* swap bytes on big-endian host CPUs */
- ssize_t nw = pwrite(fd, (uint8_t *) gbe[p], nf, p * partsize);
- err_if(nw == -1);
- if (nw != nf)
- err(errno == ECANCELED,
- "%ld bytes written to '%s', expected %ld bytes\n",
- nw, filename, nf);
+ read_checksums();
- tnw += nf;
- }
+ run_cmd();
- if ((flags != O_RDONLY) && (cmd != cmd_dump)) {
- if (nvmPartChanged[0] || nvmPartChanged[1])
- printf("The following nvm words were written:\n");
- cmd_dump();
- }
+ if ((cmd->flags & O_ACCMODE) == O_RDWR)
+ write_to_gbe_bin();
- if ((!tnw) && (flags != O_RDONLY) && (!errno))
- fprintf(stderr, "No changes needed on file '%s'\n", filename);
- else if (tnw)
- printf("%ld bytes written to file '%s'\n", tnw, filename);
+ if (exit_cleanup() == -1)
+ err(EIO, "%s: close", f->fname);
- if (tnw)
- errno = 0;
+ if (f->io_err_gbe_bin)
+ err(EIO, "%s: error writing final file");
- err_if(close(fd) == -1);
-}
+ if (f->tname != NULL)
+ free(f->tname);
-void
-swap(int partnum)
-{
- size_t w, x;
- uint8_t *n = (uint8_t *) gbe[partnum];
- int e = 1;
-
- for (w = NVM_SIZE * ((uint8_t *) &e)[0], x = 1; w < NVM_SIZE;
- w += 2, x += 2) {
- n[w] ^= n[x];
- n[x] ^= n[w];
- n[w] ^= n[x];
- }
+ return EXIT_SUCCESS;
}
generated by cgit v1.2.1 (git 2.18.0) at 2026-03-18 21:46:08 +0000