Make read-only guarantee user-settable
[petitboot] / discover / platform-powerpc.c
index d1d4191ede7df64f485e75d59e6826237d7525b7..fc96305ad70bc56d71d5e002a5b03617a84a57a6 100644 (file)
@@ -9,15 +9,20 @@
 #include <sys/fcntl.h>
 #include <sys/stat.h>
 
+#include <file/file.h>
 #include <talloc/talloc.h>
 #include <list/list.h>
 #include <log/log.h>
 #include <process/process.h>
 
 #include "platform.h"
+#include "ipmi.h"
+#include "dt.h"
 
 static const char *partition = "common";
 static const char *sysparams_dir = "/sys/firmware/opal/sysparams/";
+static const char *devtree_dir = "/proc/device-tree/";
+static const int ipmi_timeout = 500; /* milliseconds */
 
 struct param {
        char                    *name;
@@ -27,13 +32,28 @@ struct param {
 };
 
 struct platform_powerpc {
-       struct list             params;
+       struct list     params;
+       struct ipmi     *ipmi;
+       bool            ipmi_bootdev_persistent;
+       int             (*get_ipmi_bootdev)(
+                               struct platform_powerpc *platform,
+                               uint8_t *bootdev, bool *persistent);
+       int             (*clear_ipmi_bootdev)(
+                               struct platform_powerpc *platform,
+                               bool persistent);
+       int             (*set_os_boot_sensor)(
+                               struct platform_powerpc *platform);
 };
 
 static const char *known_params[] = {
        "auto-boot?",
        "petitboot,network",
        "petitboot,timeout",
+       "petitboot,bootdev",
+       "petitboot,bootdevs",
+       "petitboot,language",
+       "petitboot,debug?",
+       "petitboot,write?",
        NULL,
 };
 
@@ -323,7 +343,7 @@ out_err:
 static int parse_one_dns_config(struct config *config,
                char *confstr)
 {
-       char *tok, *saveptr;
+       char *tok, *saveptr = NULL;
 
        for (tok = strtok_r(confstr, ",", &saveptr); tok;
                        tok = strtok_r(NULL, ",", &saveptr)) {
@@ -344,8 +364,8 @@ static int parse_one_dns_config(struct config *config,
 static void populate_network_config(struct platform_powerpc *platform,
                struct config *config)
 {
+       char *val, *saveptr = NULL;
        const char *cval;
-       char *val;
        int i;
 
        cval = get_param(platform, "petitboot,network");
@@ -355,7 +375,7 @@ static void populate_network_config(struct platform_powerpc *platform,
        val = talloc_strdup(config, cval);
 
        for (i = 0; ; i++) {
-               char *tok, *saveptr;
+               char *tok;
 
                tok = strtok_r(i == 0 ? val : NULL, " ", &saveptr);
                if (!tok)
@@ -371,6 +391,131 @@ static void populate_network_config(struct platform_powerpc *platform,
        talloc_free(val);
 }
 
+static int read_bootdev(void *ctx, char **pos, struct autoboot_option *opt)
+{
+       char *delim = strchr(*pos, ' ');
+       int len, prefix = 0, rc = -1;
+       enum device_type type;
+
+       if (!strncmp(*pos, "uuid:", strlen("uuid:"))) {
+               prefix = strlen("uuid:");
+               opt->boot_type = BOOT_DEVICE_UUID;
+               rc = 0;
+       } else if (!strncmp(*pos, "mac:", strlen("mac:"))) {
+               prefix = strlen("mac:");
+               opt->boot_type = BOOT_DEVICE_UUID;
+               rc = 0;
+       } else {
+               type = find_device_type(*pos);
+               if (type != DEVICE_TYPE_UNKNOWN) {
+                       opt->type = type;
+                       opt->boot_type = BOOT_DEVICE_TYPE;
+                       rc = 0;
+               }
+       }
+
+       if (opt->boot_type == BOOT_DEVICE_UUID) {
+               if (delim)
+                       len = (int)(delim - *pos) - prefix;
+               else
+                       len = strlen(*pos);
+
+               opt->uuid = talloc_strndup(ctx, *pos + prefix, len);
+       }
+
+       /* Always advance pointer to next option or end */
+       if (delim)
+               *pos = delim + 1;
+       else
+               *pos += strlen(*pos);
+
+       return rc;
+}
+
+static void populate_bootdev_config(struct platform_powerpc *platform,
+               struct config *config)
+{
+       struct autoboot_option *opt, *new = NULL;
+       char *pos, *end, *old_dev = NULL;
+       const char delim = ' ';
+       unsigned int n_new = 0;
+       const char *val;
+       bool conflict;
+
+       /* Check for old-style bootdev */
+       val = get_param(platform, "petitboot,bootdev");
+       if (val && strlen(val)) {
+               pos = talloc_strdup(config, val);
+               if (!strncmp(val, "uuid:", strlen("uuid:")))
+                       old_dev = talloc_strdup(config,
+                                               val + strlen("uuid:"));
+               else if (!strncmp(val, "mac:", strlen("mac:")))
+                       old_dev = talloc_strdup(config,
+                                               val + strlen("mac:"));
+       }
+
+       /* Check for ordered bootdevs */
+       val = get_param(platform, "petitboot,bootdevs");
+       if (!val || !strlen(val)) {
+               pos = end = NULL;
+       } else {
+               pos = talloc_strdup(config, val);
+               end = strchr(pos, '\0');
+       }
+
+       while (pos && pos < end) {
+               opt = talloc(config, struct autoboot_option);
+
+               if (read_bootdev(config, &pos, opt)) {
+                       pb_log("bootdev config is in an unknown format "
+                              "(expected uuid:... or mac:...)");
+                       talloc_free(opt);
+                       if (strchr(pos, delim))
+                               continue;
+                       return;
+               }
+
+               new = talloc_realloc(config, new, struct autoboot_option,
+                                    n_new + 1);
+               new[n_new] = *opt;
+               n_new++;
+               talloc_free(opt);
+
+       }
+
+       if (!n_new && !old_dev) {
+               /* If autoboot has been disabled, clear the default options */
+               if (!config->autoboot_enabled) {
+                       talloc_free(config->autoboot_opts);
+                       config->n_autoboot_opts = 0;
+               }
+               return;
+       }
+
+       conflict = old_dev && (!n_new ||
+                                   new[0].boot_type == BOOT_DEVICE_TYPE ||
+                                   /* Canonical UUIDs are 36 characters long */
+                                   strncmp(new[0].uuid, old_dev, 36));
+
+       if (!conflict) {
+               talloc_free(config->autoboot_opts);
+               config->autoboot_opts = new;
+               config->n_autoboot_opts = n_new;
+               return;
+       }
+
+       /*
+        * Difference detected, defer to old format in case it has been updated
+        * recently
+        */
+       pb_debug("Old autoboot bootdev detected\n");
+       talloc_free(config->autoboot_opts);
+       config->autoboot_opts = talloc(config, struct autoboot_option);
+       config->autoboot_opts[0].boot_type = BOOT_DEVICE_UUID;
+       config->autoboot_opts[0].uuid = talloc_strdup(config, old_dev);
+       config->n_autoboot_opts = 1;
+}
+
 static void populate_config(struct platform_powerpc *platform,
                struct config *config)
 {
@@ -393,7 +538,21 @@ static void populate_config(struct platform_powerpc *platform,
                }
        }
 
+       val = get_param(platform, "petitboot,language");
+       config->lang = val ? talloc_strdup(config, val) : NULL;
+
        populate_network_config(platform, config);
+
+       populate_bootdev_config(platform, config);
+
+       if (!config->debug) {
+               val = get_param(platform, "petitboot,debug?");
+               config->debug = val && !strcmp(val, "true");
+       }
+
+       val = get_param(platform, "petitboot,write?");
+       if (val)
+               config->allow_writes = !strcmp(val, "true");
 }
 
 static char *iface_config_str(void *ctx, struct interface_config *config)
@@ -481,6 +640,45 @@ static void update_network_config(struct platform_powerpc *platform,
        talloc_free(val);
 }
 
+static void update_bootdev_config(struct platform_powerpc *platform,
+               struct config *config)
+{
+       char *val = NULL, *boot_str = NULL, *tmp = NULL, *first = NULL;
+       struct autoboot_option *opt;
+       const char delim = ' ';
+       unsigned int i;
+
+       if (!config->n_autoboot_opts)
+               first = val = "";
+       else if (config->autoboot_opts[0].boot_type == BOOT_DEVICE_UUID)
+               first = talloc_asprintf(config, "uuid:%s",
+                                       config->autoboot_opts[0].uuid);
+       else
+               first = "";
+
+       for (i = 0; i < config->n_autoboot_opts; i++) {
+               opt = &config->autoboot_opts[i];
+               switch (opt->boot_type) {
+                       case BOOT_DEVICE_TYPE:
+                               boot_str = talloc_asprintf(config, "%s%c",
+                                               device_type_name(opt->type),
+                                               delim);
+                               break;
+                       case BOOT_DEVICE_UUID:
+                               boot_str = talloc_asprintf(config, "uuid:%s%c",
+                                               opt->uuid, delim);
+                               break;
+                       }
+                       tmp = val = talloc_asprintf_append(val, "%s", boot_str);
+       }
+
+       update_string_config(platform, "petitboot,bootdevs", val);
+       update_string_config(platform, "petitboot,bootdev", first);
+       talloc_free(tmp);
+       if (boot_str)
+               talloc_free(boot_str);
+}
+
 static int update_config(struct platform_powerpc *platform,
                struct config *config, struct config *defaults)
 {
@@ -499,36 +697,56 @@ static int update_config(struct platform_powerpc *platform,
                val = tmp = talloc_asprintf(platform, "%d",
                                config->autoboot_timeout_sec);
 
+       if (config->ipmi_bootdev == IPMI_BOOTDEV_INVALID &&
+           platform->clear_ipmi_bootdev) {
+               platform->clear_ipmi_bootdev(platform,
+                               config->ipmi_bootdev_persistent);
+               config->ipmi_bootdev = IPMI_BOOTDEV_NONE;
+               config->ipmi_bootdev_persistent = false;
+       }
+
        update_string_config(platform, "petitboot,timeout", val);
        if (tmp)
                talloc_free(tmp);
 
+       val = config->lang ?: "";
+       update_string_config(platform, "petitboot,language", val);
+
+       if (config->allow_writes == defaults->allow_writes)
+               val = "";
+       else
+               val = config->allow_writes ? "true" : "false";
+       update_string_config(platform, "petitboot,write?", val);
+
        update_network_config(platform, config);
 
+       update_bootdev_config(platform, config);
+
        return write_nvram(platform);
 }
 
-static void set_exclusive_devtype(struct config *config,
-               enum device_type devtype)
+static void set_ipmi_bootdev(struct config *config, enum ipmi_bootdev bootdev,
+               bool persistent)
 {
-       config->n_boot_priorities = 2;
-       config->boot_priorities = talloc_realloc(config,
-                       config->boot_priorities, struct boot_priority,
-                       config->n_boot_priorities);
-       config->boot_priorities[0].type = devtype;
-       config->boot_priorities[0].priority = 0;
-       config->boot_priorities[1].type = DEVICE_TYPE_ANY;
-       config->boot_priorities[1].priority = -1;
-}
+       config->ipmi_bootdev = bootdev;
+       config->ipmi_bootdev_persistent = persistent;
 
-/* bootdev options that we recognise */
-enum ipmi_bootdev {
-       IPMI_BOOTDEV_NONE = 0x00,
-       IPMI_BOOTDEV_NETWORK = 0x01,
-       IPMI_BOOTDEV_DISK = 0x2,
-       IPMI_BOOTDEV_CDROM = 0x5,
-       IPMI_BOOTDEV_SETUP = 0x6,
-};
+       switch (bootdev) {
+       case IPMI_BOOTDEV_NONE:
+       case IPMI_BOOTDEV_DISK:
+       case IPMI_BOOTDEV_NETWORK:
+       case IPMI_BOOTDEV_CDROM:
+       default:
+               break;
+       case IPMI_BOOTDEV_SETUP:
+               config->autoboot_enabled = false;
+               break;
+       case IPMI_BOOTDEV_SAFE:
+               config->autoboot_enabled = false;
+               config->safe_mode = true;
+               break;
+       }
+}
 
 static int read_bootdev_sysparam(const char *name, uint8_t *val)
 {
@@ -560,17 +778,10 @@ static int read_bootdev_sysparam(const char *name, uint8_t *val)
 
        pb_debug("powerpc: sysparam %s: 0x%02x\n", name, buf[0]);
 
-       switch (buf[0]) {
-       default:
+       if (!ipmi_bootdev_is_valid(buf[0]))
                return -1;
-       case IPMI_BOOTDEV_NONE:
-       case IPMI_BOOTDEV_NETWORK:
-       case IPMI_BOOTDEV_DISK:
-       case IPMI_BOOTDEV_CDROM:
-       case IPMI_BOOTDEV_SETUP:
-               *val = buf[0];
-       }
 
+       *val = buf[0];
        return 0;
 }
 
@@ -614,7 +825,23 @@ static int write_bootdev_sysparam(const char *name, uint8_t val)
        return rc;
 }
 
-static void parse_opal_sysparams(struct config *config)
+static int clear_ipmi_bootdev_sysparams(
+               struct platform_powerpc *platform __attribute__((unused)),
+               bool persistent)
+{
+       if (persistent) {
+               /* invalidate default-boot-device setting */
+               write_bootdev_sysparam("default-boot-device", 0xff);
+       } else {
+               /* invalidate next-boot-device setting */
+               write_bootdev_sysparam("next-boot-device", 0xff);
+       }
+       return 0;
+}
+
+static int get_ipmi_bootdev_sysparams(
+               struct platform_powerpc *platform __attribute__((unused)),
+               uint8_t *bootdev, bool *persistent)
 {
        uint8_t next_bootdev, default_bootdev;
        bool next_valid, default_valid;
@@ -628,31 +855,133 @@ static void parse_opal_sysparams(struct config *config)
 
        /* nothing valid? no need to change the config */
        if (!next_valid && !default_valid)
-               return;
+               return -1;
 
-       if (next_valid) {
-               /* invalidate next-boot-device setting */
-               write_bootdev_sysparam("next-boot-device", 0xff);
-       } else {
-               next_bootdev = default_bootdev;
+       *persistent = !next_valid;
+       *bootdev = next_valid ? next_bootdev : default_bootdev;
+       return 0;
+}
+
+static int clear_ipmi_bootdev_ipmi(struct platform_powerpc *platform,
+                                  bool persistent __attribute__((unused)))
+{
+       uint16_t resp_len;
+       uint8_t resp[1];
+       uint8_t req[] = {
+               0x05, /* parameter selector: boot flags */
+               0x80, /* data 1: valid */
+               0x00, /* data 2: bootdev: no override */
+               0x00, /* data 3: system defaults */
+               0x00, /* data 4: no request for shared mode, mux defaults */
+               0x00, /* data 5: no instance request */
+       };
+
+       resp_len = sizeof(resp);
+
+       ipmi_transaction(platform->ipmi, IPMI_NETFN_CHASSIS,
+                       IPMI_CMD_CHASSIS_SET_SYSTEM_BOOT_OPTIONS,
+                       req, sizeof(req),
+                       resp, &resp_len,
+                       ipmi_timeout);
+       return 0;
+}
+
+static int get_ipmi_bootdev_ipmi(struct platform_powerpc *platform,
+               uint8_t *bootdev, bool *persistent)
+{
+       uint16_t resp_len;
+       uint8_t resp[8];
+       int rc;
+       uint8_t req[] = {
+               0x05, /* parameter selector: boot flags */
+               0x00, /* no set selector */
+               0x00, /* no block selector */
+       };
+
+       resp_len = sizeof(resp);
+       rc = ipmi_transaction(platform->ipmi, IPMI_NETFN_CHASSIS,
+                       IPMI_CMD_CHASSIS_GET_SYSTEM_BOOT_OPTIONS,
+                       req, sizeof(req),
+                       resp, &resp_len,
+                       ipmi_timeout);
+       if (rc) {
+               pb_log("platform: error reading IPMI boot options\n");
+               return -1;
        }
 
-       switch (next_bootdev) {
-       case IPMI_BOOTDEV_NONE:
-               return;
-       case IPMI_BOOTDEV_DISK:
-               set_exclusive_devtype(config, DEVICE_TYPE_DISK);
-               break;
-       case IPMI_BOOTDEV_NETWORK:
-               set_exclusive_devtype(config, DEVICE_TYPE_NETWORK);
-               break;
-       case IPMI_BOOTDEV_CDROM:
-               set_exclusive_devtype(config, DEVICE_TYPE_OPTICAL);
-               break;
-       case IPMI_BOOTDEV_SETUP:
-               config->autoboot_enabled = false;
-               break;
+       if (resp_len != sizeof(resp)) {
+               pb_log("platform: unexpected length (%d) in "
+                               "boot options response\n", resp_len);
+               return -1;
        }
+
+       if (resp[0] != 0) {
+               pb_log("platform: non-zero completion code %d from IPMI req\n",
+                               resp[0]);
+               return -1;
+       }
+
+       /* check for correct parameter version */
+       if ((resp[1] & 0xf) != 0x1) {
+               pb_log("platform: unexpected version (0x%x) in "
+                               "boot options response\n", resp[0]);
+               return -1;
+       }
+
+       /* check for valid paramters */
+       if (resp[2] & 0x80) {
+               pb_debug("platform: boot options are invalid/locked\n");
+               return -1;
+       }
+
+       *persistent = false;
+
+       /* check for valid flags */
+       if (!(resp[3] & 0x80)) {
+               pb_debug("platform: boot flags are invalid, ignoring\n");
+               return 0;
+       }
+
+       *persistent = resp[3] & 0x40;
+       *bootdev = (resp[4] >> 2) & 0x0f;
+       return 0;
+}
+
+static int set_ipmi_os_boot_sensor(struct platform_powerpc *platform)
+{
+       int sensor_number;
+       uint16_t resp_len;
+       uint8_t resp[1];
+       uint8_t req[] = {
+               0x00, /* sensor number: os boot */
+               0xA9, /* operation: set everything */
+               0x00, /* sensor reading: none */
+               0x40, /* assertion mask lsb: set state 6 */
+               0x00, /* assertion mask msb: none */
+               0x00, /* deassertion mask lsb: none */
+               0x00, /* deassertion mask msb: none */
+               0x00, /* event data 1: none */
+               0x00, /* event data 2: none */
+               0x00, /* event data 3: none */
+       };
+
+       sensor_number = get_ipmi_sensor(platform, IPMI_SENSOR_ID_OS_BOOT);
+       if (sensor_number < 0) {
+               pb_log("Couldn't find OS boot sensor in device tree\n");
+               return -1;
+       }
+
+       req[0] = sensor_number;
+
+       resp_len = sizeof(resp);
+
+       ipmi_transaction(platform->ipmi, IPMI_NETFN_SE,
+                       IPMI_CMD_SENSOR_SET,
+                       req, sizeof(req),
+                       resp, &resp_len,
+                       ipmi_timeout); return 0;
+
+       return 0;
 }
 
 static int load_config(struct platform *p, struct config *config)
@@ -666,7 +995,15 @@ static int load_config(struct platform *p, struct config *config)
 
        populate_config(platform, config);
 
-       parse_opal_sysparams(config);
+       if (platform->get_ipmi_bootdev) {
+               bool bootdev_persistent;
+               uint8_t bootdev;
+               rc = platform->get_ipmi_bootdev(platform, &bootdev,
+                               &bootdev_persistent);
+               if (!rc && ipmi_bootdev_is_valid(bootdev)) {
+                       set_ipmi_bootdev(config, bootdev, bootdev_persistent);
+               }
+       }
 
        return 0;
 }
@@ -686,13 +1023,45 @@ static int save_config(struct platform *p, struct config *config)
        return rc;
 }
 
+static void pre_boot(struct platform *p, const struct config *config)
+{
+       struct platform_powerpc *platform = to_platform_powerpc(p);
+
+       if (!config->ipmi_bootdev_persistent && platform->clear_ipmi_bootdev)
+               platform->clear_ipmi_bootdev(platform, false);
+
+       if (platform->set_os_boot_sensor)
+               platform->set_os_boot_sensor(platform);
+}
+
+static int get_sysinfo(struct platform *p, struct system_info *sysinfo)
+{
+       struct platform_powerpc *platform = p->platform_data;
+       char *buf, *filename;
+       int len, rc;
+
+       filename = talloc_asprintf(platform, "%smodel", devtree_dir);
+       rc = read_file(platform, filename, &buf, &len);
+       if (rc == 0)
+               sysinfo->type = talloc_steal(sysinfo, buf);
+       talloc_free(filename);
+
+       filename = talloc_asprintf(platform, "%ssystem-id", devtree_dir);
+       rc = read_file(platform, filename, &buf, &len);
+       if (rc == 0)
+               sysinfo->identifier = talloc_steal(sysinfo, buf);
+       talloc_free(filename);
+
+       return 0;
+}
+
 static bool probe(struct platform *p, void *ctx)
 {
        struct platform_powerpc *platform;
        struct stat statbuf;
        int rc;
 
-       /* we need a device tree and a working nvram binary */
+       /* we need a device tree */
        rc = stat("/proc/device-tree", &statbuf);
        if (rc)
                return false;
@@ -700,23 +1069,39 @@ static bool probe(struct platform *p, void *ctx)
        if (!S_ISDIR(statbuf.st_mode))
                return false;
 
-       rc = process_run_simple(ctx, "nvram", "--print-config", NULL);
-       if (!WIFEXITED(rc) || WEXITSTATUS(rc) != 0)
-               return false;
-
-       platform = talloc(ctx, struct platform_powerpc);
+       platform = talloc_zero(ctx, struct platform_powerpc);
        list_init(&platform->params);
 
        p->platform_data = platform;
+
+       if (ipmi_present()) {
+               pb_debug("platform: using direct IPMI for IPMI paramters\n");
+               platform->ipmi = ipmi_open(platform);
+               platform->get_ipmi_bootdev = get_ipmi_bootdev_ipmi;
+               platform->clear_ipmi_bootdev = clear_ipmi_bootdev_ipmi;
+               platform->set_os_boot_sensor = set_ipmi_os_boot_sensor;
+
+       } else if (!stat(sysparams_dir, &statbuf)) {
+               pb_debug("platform: using sysparams for IPMI paramters\n");
+               platform->get_ipmi_bootdev = get_ipmi_bootdev_sysparams;
+               platform->clear_ipmi_bootdev = clear_ipmi_bootdev_sysparams;
+
+       } else {
+               pb_log("platform: no IPMI parameter support\n");
+       }
+
        return true;
 }
 
+
 static struct platform platform_powerpc = {
-       .name           = "powerpc",
-       .dhcp_arch_id   = 0x000e,
-       .probe          = probe,
-       .load_config    = load_config,
-       .save_config    = save_config,
+       .name                   = "powerpc",
+       .dhcp_arch_id           = 0x000e,
+       .probe                  = probe,
+       .load_config            = load_config,
+       .save_config            = save_config,
+       .pre_boot               = pre_boot,
+       .get_sysinfo            = get_sysinfo,
 };
 
 register_platform(platform_powerpc);