<p>Patrick Rudolph has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/25046">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">drivers/vpd: Add VPD support<br><br>Copy ChromeOS VPD driver to add support for VPD without CROMEOS.<br>Possible use case:<br>* Storing calibration data<br>* Storing MAC address<br>* Storing serial<br>* Storing boot options<br><br>TODO: Make use of this driver accross all platforms.<br><br>Change-Id: Id9263bd39bf25d024e93daa57053fefcb1adc53a<br>Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com><br>---<br>A src/drivers/vpd/Kconfig<br>A src/drivers/vpd/Makefile.inc<br>A src/drivers/vpd/lib_vpd.c<br>A src/drivers/vpd/lib_vpd.h<br>A src/drivers/vpd/vpd.c<br>A src/drivers/vpd/vpd.h<br>A src/drivers/vpd/vpd_tables.h<br>7 files changed, 757 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/46/25046/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/drivers/vpd/Kconfig b/src/drivers/vpd/Kconfig</span><br><span>new file mode 100644</span><br><span>index 0000000..335b907</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/Kconfig</span><br><span>@@ -0,0 +1,28 @@</span><br><span style="color: hsl(120, 100%, 40%);">+##</span><br><span style="color: hsl(120, 100%, 40%);">+## This file is part of the coreboot project.</span><br><span style="color: hsl(120, 100%, 40%);">+##</span><br><span style="color: hsl(120, 100%, 40%);">+## Copyright (C) 2012 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+##</span><br><span style="color: hsl(120, 100%, 40%);">+## This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+## it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+## the Free Software Foundation; version 2 of the License.</span><br><span style="color: hsl(120, 100%, 40%);">+##</span><br><span style="color: hsl(120, 100%, 40%);">+## This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+## but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+## GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+##</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+config VPD</span><br><span style="color: hsl(120, 100%, 40%);">+ bool "Support for Vital Product Data tables"</span><br><span style="color: hsl(120, 100%, 40%);">+ default n</span><br><span style="color: hsl(120, 100%, 40%);">+ help</span><br><span style="color: hsl(120, 100%, 40%);">+ Enable support for flash based vital product data.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+if VPD</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+config VPD_DEBUG</span><br><span style="color: hsl(120, 100%, 40%);">+ bool "Enable VPD debug output"</span><br><span style="color: hsl(120, 100%, 40%);">+ default n</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+endif</span><br><span>diff --git a/src/drivers/vpd/Makefile.inc b/src/drivers/vpd/Makefile.inc</span><br><span>new file mode 100644</span><br><span>index 0000000..9b4d1f3</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/Makefile.inc</span><br><span>@@ -0,0 +1,2 @@</span><br><span style="color: hsl(120, 100%, 40%);">+ramstage-$(CONFIG_VPD) += vpd.c</span><br><span style="color: hsl(120, 100%, 40%);">+ramstage-$(CONFIG_VPD) += lib_vpd.c</span><br><span>diff --git a/src/drivers/vpd/lib_vpd.c b/src/drivers/vpd/lib_vpd.c</span><br><span>new file mode 100644</span><br><span>index 0000000..a0e4396</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/lib_vpd.c</span><br><span>@@ -0,0 +1,111 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2014 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Use of this source code is governed by a BSD-style license that can be</span><br><span style="color: hsl(120, 100%, 40%);">+ * found in the LICENSE file.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+#include <assert.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include "lib_vpd.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given an encoded string, this functions decodes the length field which varies</span><br><span style="color: hsl(120, 100%, 40%);">+ * from 1 byte to many bytes.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The in points the actual byte going to be decoded. The *length returns</span><br><span style="color: hsl(120, 100%, 40%);">+ * the decoded length field. The number of consumed bytes will be stroed in</span><br><span style="color: hsl(120, 100%, 40%);">+ * decoded_len.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns VPD_FAIL if more bit is 1, but actually reaches the end of string.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int decodeLen(const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *in,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *length,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *decoded_len)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t more;</span><br><span style="color: hsl(120, 100%, 40%);">+ int i = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ assert(length);</span><br><span style="color: hsl(120, 100%, 40%);">+ assert(decoded_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *length = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ do {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (i >= max_len) return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+ more = in[i] & 0x80;</span><br><span style="color: hsl(120, 100%, 40%);">+ *length <<= 7;</span><br><span style="color: hsl(120, 100%, 40%);">+ *length |= in[i] & 0x7f;</span><br><span style="color: hsl(120, 100%, 40%);">+ ++i;</span><br><span style="color: hsl(120, 100%, 40%);">+ } while (more);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *decoded_len = i;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_OK;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given the encoded string, this function invokes callback with extracted</span><br><span style="color: hsl(120, 100%, 40%);">+ * (key, value). The *consumed will be plused the number of bytes consumed in</span><br><span style="color: hsl(120, 100%, 40%);">+ * this function.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The input_buf points to the first byte of the input buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The *consumed starts from 0, which is actually the next byte to be decoded.</span><br><span style="color: hsl(120, 100%, 40%);">+ * It can be non-zero to be used in multiple calls.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * If one entry is successfully decoded, sends it to callback and returns the</span><br><span style="color: hsl(120, 100%, 40%);">+ * result.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int decodeVpdString(const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *input_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *consumed,</span><br><span style="color: hsl(120, 100%, 40%);">+ VpdDecodeCallback callback,</span><br><span style="color: hsl(120, 100%, 40%);">+ void *callback_arg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int type;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t key_len, value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t decoded_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key, *value;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* type */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (*consumed >= max_len)</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ type = input_buf[*consumed];</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (type) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case VPD_TYPE_INFO:</span><br><span style="color: hsl(120, 100%, 40%);">+ case VPD_TYPE_STRING:</span><br><span style="color: hsl(120, 100%, 40%);">+ (*consumed)++;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* key */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (VPD_OK != decodeLen(max_len - *consumed,</span><br><span style="color: hsl(120, 100%, 40%);">+ &input_buf[*consumed], &key_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ &decoded_len) ||</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed + decoded_len >= max_len) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed += decoded_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ key = &input_buf[*consumed];</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed += key_len;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* value */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (VPD_OK != decodeLen(max_len - *consumed,</span><br><span style="color: hsl(120, 100%, 40%);">+ &input_buf[*consumed],</span><br><span style="color: hsl(120, 100%, 40%);">+ &value_len, &decoded_len) ||</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed + decoded_len > max_len) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed += decoded_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ value = &input_buf[*consumed];</span><br><span style="color: hsl(120, 100%, 40%);">+ *consumed += value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (type == VPD_TYPE_STRING)</span><br><span style="color: hsl(120, 100%, 40%);">+ return callback(key, key_len, value, value_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ callback_arg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_OK;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_OK;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/src/drivers/vpd/lib_vpd.h b/src/drivers/vpd/lib_vpd.h</span><br><span>new file mode 100644</span><br><span>index 0000000..7a7566b</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/lib_vpd.h</span><br><span>@@ -0,0 +1,226 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2013 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Use of this source code is governed by a BSD-style license that can be</span><br><span style="color: hsl(120, 100%, 40%);">+ * found in the LICENSE file.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#ifndef __LIB_VPD__</span><br><span style="color: hsl(120, 100%, 40%);">+#define __LIB_VPD__</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <inttypes.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum {</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_OK = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_FAIL,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum {</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_TYPE_TERMINATOR = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_TYPE_STRING,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_TYPE_INFO = 0xfe,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_TYPE_IMPLICIT_TERMINATOR = 0xff,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum {</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_AS_LONG_AS = -1,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum { /* export_type */</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_EXPORT_KEY_VALUE = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_EXPORT_VALUE,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_EXPORT_AS_PARAMETER,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Callback for decodeVpdString to invoke. */</span><br><span style="color: hsl(120, 100%, 40%);">+typedef int VpdDecodeCallback(const uint8_t *key, int32_t key_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *value, int32_t value_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ void *arg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Container data types */</span><br><span style="color: hsl(120, 100%, 40%);">+struct StringPair {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *key;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *value;</span><br><span style="color: hsl(120, 100%, 40%);">+ int pad_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ int filter_out; /* TRUE means not exported. */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct StringPair *next;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct PairContainer {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct StringPair *first;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/***********************************************************************</span><br><span style="color: hsl(120, 100%, 40%);">+ * Encode and decode VPD entries</span><br><span style="color: hsl(120, 100%, 40%);">+ ***********************************************************************/</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Encodes the len into multiple bytes with the following format.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * 7 6 ............ 0</span><br><span style="color: hsl(120, 100%, 40%);">+ * +----+------------------+</span><br><span style="color: hsl(120, 100%, 40%);">+ * |More| Length | ...</span><br><span style="color: hsl(120, 100%, 40%);">+ * +----+------------------+</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The encode_buf points to the actual position we are going to store.</span><br><span style="color: hsl(120, 100%, 40%);">+ * encoded_len will return the exact bytes we encoded in this function.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns fail if the buffer is not long enough.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int encodeLen(</span><br><span style="color: hsl(120, 100%, 40%);">+ const int32_t len,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *encode_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *encoded_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given an encoded string, this functions decodes the length field which varies</span><br><span style="color: hsl(120, 100%, 40%);">+ * from 1 byte to many bytes.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The in points the actual byte going to be decoded. The *length returns</span><br><span style="color: hsl(120, 100%, 40%);">+ * the decoded length field. The number of consumed bytes will be stroed in</span><br><span style="color: hsl(120, 100%, 40%);">+ * decoded_len.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns VPD_FAIL if more bit is 1, but actually reaches the end of string.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int decodeLen(</span><br><span style="color: hsl(120, 100%, 40%);">+ const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *in,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *length,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *decoded_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Encodes the terminator.</span><br><span style="color: hsl(120, 100%, 40%);">+ * When calling, the output_buf should point to the start of buffer while</span><br><span style="color: hsl(120, 100%, 40%);">+ * *generated_len should contain how many bytes exist in buffer now.</span><br><span style="color: hsl(120, 100%, 40%);">+ * After return, *generated_len would be plused the number of bytes generated</span><br><span style="color: hsl(120, 100%, 40%);">+ * in this function.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int encodeVpdTerminator(</span><br><span style="color: hsl(120, 100%, 40%);">+ const int max_buffer_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *output_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int *generated_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Encodes the given type/key/value pair into buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The pad_value_len is used to control the output value length.</span><br><span style="color: hsl(120, 100%, 40%);">+ * When pad_value_len > 0, the value is outputted into fixed length (pad \0</span><br><span style="color: hsl(120, 100%, 40%);">+ * if the value is shorter). Truncated if too long.</span><br><span style="color: hsl(120, 100%, 40%);">+ * pad_value_len == VPD_NO_LIMIT, output the value as long as possible.</span><br><span style="color: hsl(120, 100%, 40%);">+ * This is useful when we want to fix the structure layout at beginning.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The encoded string will be stored in output_buf. If it is longer than</span><br><span style="color: hsl(120, 100%, 40%);">+ * max_buffer_len, this function returns fail. If the buffer is long enough,</span><br><span style="color: hsl(120, 100%, 40%);">+ * the generated_len will be updated.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * When calling, the output_buf should point to the start of buffer while</span><br><span style="color: hsl(120, 100%, 40%);">+ * *generated_len should contain how many bytes exist in buffer now.</span><br><span style="color: hsl(120, 100%, 40%);">+ * After return, *generated_len would be plused the number of bytes generated</span><br><span style="color: hsl(120, 100%, 40%);">+ * in this function.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The initial value of *generated_len can be non-zero, so that this value</span><br><span style="color: hsl(120, 100%, 40%);">+ * can be used between multiple calls to encodeVpd2Pair().</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int encodeVpdString(</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *value,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int pad_value_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int max_buffer_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *output_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int *generated_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given the encoded string, this function invokes callback with extracted</span><br><span style="color: hsl(120, 100%, 40%);">+ * (key, value). The *consumed will be plused the number of bytes consumed in</span><br><span style="color: hsl(120, 100%, 40%);">+ * this function.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The input_buf points to the first byte of the input buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The *consumed starts from 0, which is actually the next byte to be decoded.</span><br><span style="color: hsl(120, 100%, 40%);">+ * It can be non-zero to be used in multiple calls.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * If one entry is successfully decoded, sends it to callback and returns the</span><br><span style="color: hsl(120, 100%, 40%);">+ * result.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int decodeVpdString(</span><br><span style="color: hsl(120, 100%, 40%);">+ const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *input_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *consumed,</span><br><span style="color: hsl(120, 100%, 40%);">+ VpdDecodeCallback callback,</span><br><span style="color: hsl(120, 100%, 40%);">+ void *callback_arg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/***********************************************************************</span><br><span style="color: hsl(120, 100%, 40%);">+ * Container helpers</span><br><span style="color: hsl(120, 100%, 40%);">+ ***********************************************************************/</span><br><span style="color: hsl(120, 100%, 40%);">+void initContainer(struct PairContainer *container);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct StringPair *findString(struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct StringPair ***prev_next);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* If key is already existed in container, its value will be replaced.</span><br><span style="color: hsl(120, 100%, 40%);">+ * If not existed, creates new entry in container.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+void setString(struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *value,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int pad_len);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* merge all entries in src into dst. If key is duplicate, overwrite it.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+void mergeContainer(struct PairContainer *dst,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct PairContainer *src);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* subtract src from dst.</span><br><span style="color: hsl(120, 100%, 40%);">+*/</span><br><span style="color: hsl(120, 100%, 40%);">+int subtractContainer(struct PairContainer *dst,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct PairContainer *src);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given a container, encode its all entries into the buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int encodeContainer(const struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int max_buf_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int *generated);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Given a VPD blob, decode its entries and push into container.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int decodeToContainer(struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int32_t max_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *input_buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t *consumed);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Set filter for exporting functions.</span><br><span style="color: hsl(120, 100%, 40%);">+ * If filter is NULL, resets the filter so that everything can be exported.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int setContainerFilter(struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *filter);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Remove a key.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns VPD_OK if deleted successfully. Otherwise, VPD_FAIL.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int deleteKey(struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns number of pairs in container.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int lenOfContainer(const struct PairContainer *container);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Export the container content with human-readable text.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The buf points to the first byte of buffer and *generated contains the number</span><br><span style="color: hsl(120, 100%, 40%);">+ * of bytes already existed in buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Afterward, the *generated will be plused on exact bytes this function has</span><br><span style="color: hsl(120, 100%, 40%);">+ * generated.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int exportContainer(const int export_type,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct PairContainer *container,</span><br><span style="color: hsl(120, 100%, 40%);">+ const int max_buf_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *buf,</span><br><span style="color: hsl(120, 100%, 40%);">+ int *generated);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void destroyContainer(struct PairContainer *container);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* __LIB_VPD__ */</span><br><span>diff --git a/src/drivers/vpd/vpd.c b/src/drivers/vpd/vpd.c</span><br><span>new file mode 100644</span><br><span>index 0000000..e620b58</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/vpd.c</span><br><span>@@ -0,0 +1,233 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2014 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Use of this source code is governed by a BSD-style license that can be</span><br><span style="color: hsl(120, 100%, 40%);">+ * found in the LICENSE file.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <console/console.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <cbmem.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <fmap.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdlib.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <timestamp.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include "vpd.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "lib_vpd.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "vpd_tables.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Currently we only support Google VPD 2.0, which has a fixed offset. */</span><br><span style="color: hsl(120, 100%, 40%);">+enum {</span><br><span style="color: hsl(120, 100%, 40%);">+ GOOGLE_VPD_2_0_OFFSET = 0x600,</span><br><span style="color: hsl(120, 100%, 40%);">+ CROSVPD_CBMEM_MAGIC = 0x43524f53,</span><br><span style="color: hsl(120, 100%, 40%);">+ CROSVPD_CBMEM_VERSION = 0x0001,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_gets_arg {</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *key;</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *value;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t key_len, value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ int matched;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_cbmem {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t magic;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t ro_size;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t rw_size;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t blob[0];</span><br><span style="color: hsl(120, 100%, 40%);">+ /* The blob contains both RO and RW data. It starts with RO (0 ..</span><br><span style="color: hsl(120, 100%, 40%);">+ * ro_size) and then RW (ro_size .. ro_size+rw_size).</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* returns the size of data in a VPD 2.0 formatted fmap region, or 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+static int32_t get_vpd_size(const char *fmap_name, int32_t *base)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct google_vpd_info info;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct region_device vpd;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t size;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (fmap_locate_area_as_rdev(fmap_name, &vpd)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "%s: No %s FMAP section.\n", __func__,</span><br><span style="color: hsl(120, 100%, 40%);">+ fmap_name);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ size = region_device_sz(&vpd);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((size < GOOGLE_VPD_2_0_OFFSET + sizeof(info)) ||</span><br><span style="color: hsl(120, 100%, 40%);">+ rdev_chain(&vpd, &vpd, GOOGLE_VPD_2_0_OFFSET,</span><br><span style="color: hsl(120, 100%, 40%);">+ size - GOOGLE_VPD_2_0_OFFSET)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "%s: Too small (%d) for Google VPD 2.0.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__, size);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Try if we can find a google_vpd_info, otherwise read whole VPD. */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rdev_readat(&vpd, &info, *base, sizeof(info)) != sizeof(info)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "ERROR: Failed to read %s header.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ fmap_name);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (memcmp(info.header.magic, VPD_INFO_MAGIC, sizeof(info.header.magic))</span><br><span style="color: hsl(120, 100%, 40%);">+ == 0 && size >= info.size + sizeof(info)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ *base += sizeof(info);</span><br><span style="color: hsl(120, 100%, 40%);">+ size = info.size;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (info.header.tlv.type == VPD_TYPE_TERMINATOR ||</span><br><span style="color: hsl(120, 100%, 40%);">+ info.header.tlv.type == VPD_TYPE_IMPLICIT_TERMINATOR) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_WARNING, "WARNING: %s is uninitialized or empty.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ fmap_name);</span><br><span style="color: hsl(120, 100%, 40%);">+ size = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ size -= GOOGLE_VPD_2_0_OFFSET;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return size;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void cbmem_add_cros_vpd(int is_recovery)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct region_device vpd;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vpd_cbmem *cbmem;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t ro_vpd_base = 0, rw_vpd_base = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ int32_t ro_vpd_size, rw_vpd_size;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ timestamp_add_now(TS_START_COPYVPD);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ro_vpd_size = get_vpd_size("RO_VPD", &ro_vpd_base);</span><br><span style="color: hsl(120, 100%, 40%);">+ rw_vpd_size = get_vpd_size("RW_VPD", &rw_vpd_base);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* no VPD at all? nothing to do then */</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((ro_vpd_size == 0) && (rw_vpd_size == 0))</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem = cbmem_add(CBMEM_ID_VPD, sizeof(*cbmem) + ro_vpd_size +</span><br><span style="color: hsl(120, 100%, 40%);">+ rw_vpd_size);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!cbmem) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "%s: Failed to allocate CBMEM (%u+%u).\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__, ro_vpd_size, rw_vpd_size);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->magic = CROSVPD_CBMEM_MAGIC;</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->version = CROSVPD_CBMEM_VERSION;</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->ro_size = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->rw_size = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ro_vpd_size) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (fmap_locate_area_as_rdev("RO_VPD", &vpd)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* shouldn't happen, but let's be extra defensive */</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "%s: No RO_VPD FMAP section.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ rdev_chain(&vpd, &vpd, GOOGLE_VPD_2_0_OFFSET,</span><br><span style="color: hsl(120, 100%, 40%);">+ region_device_sz(&vpd) - GOOGLE_VPD_2_0_OFFSET);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rdev_readat(&vpd, cbmem->blob, ro_vpd_base, ro_vpd_size) ==</span><br><span style="color: hsl(120, 100%, 40%);">+ ro_vpd_size) {</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->ro_size = ro_vpd_size;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "%s: Reading RO_VPD FMAP section failed.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ ro_vpd_size = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ timestamp_add_now(TS_END_COPYVPD_RO);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rw_vpd_size) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (fmap_locate_area_as_rdev("RW_VPD", &vpd)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* shouldn't happen, but let's be extra defensive */</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR, "%s: No RW_VPD FMAP section.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ rdev_chain(&vpd, &vpd, GOOGLE_VPD_2_0_OFFSET,</span><br><span style="color: hsl(120, 100%, 40%);">+ region_device_sz(&vpd) - GOOGLE_VPD_2_0_OFFSET);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rdev_readat(&vpd, cbmem->blob + ro_vpd_size, rw_vpd_base,</span><br><span style="color: hsl(120, 100%, 40%);">+ rw_vpd_size) == rw_vpd_size) {</span><br><span style="color: hsl(120, 100%, 40%);">+ cbmem->rw_size = rw_vpd_size;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ printk(BIOS_ERR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "%s: Reading RW_VPD FMAP section failed.\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ timestamp_add_now(TS_END_COPYVPD_RW);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int vpd_gets_callback(const uint8_t *key, int32_t key_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *value, int32_t value_len,</span><br><span style="color: hsl(120, 100%, 40%);">+ void *arg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vpd_gets_arg *result = (struct vpd_gets_arg *)arg;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (key_len != result->key_len ||</span><br><span style="color: hsl(120, 100%, 40%);">+ memcmp(key, result->key, key_len) != 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Returns VPD_OK to continue parsing. */</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_OK;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ result->matched = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ result->value = value;</span><br><span style="color: hsl(120, 100%, 40%);">+ result->value_len = value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Returns VPD_FAIL to stop parsing. */</span><br><span style="color: hsl(120, 100%, 40%);">+ return VPD_FAIL;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+const void *vpd_find(const char *key, int *size, enum vpd_region region)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vpd_gets_arg arg = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ int consumed = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct vpd_cbmem *vpd;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ vpd = cbmem_find(CBMEM_ID_VPD);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!vpd || !vpd->ro_size)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ arg.key = (const uint8_t *)key;</span><br><span style="color: hsl(120, 100%, 40%);">+ arg.key_len = strlen(key);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (region == VPD_ANY || region == VPD_RO)</span><br><span style="color: hsl(120, 100%, 40%);">+ while (VPD_OK == decodeVpdString(vpd->ro_size, vpd->blob,</span><br><span style="color: hsl(120, 100%, 40%);">+ &consumed, vpd_gets_callback, &arg)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Iterate until found or no more entries. */</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!arg.matched && region != VPD_RO)</span><br><span style="color: hsl(120, 100%, 40%);">+ while (VPD_OK == decodeVpdString(vpd->rw_size,</span><br><span style="color: hsl(120, 100%, 40%);">+ vpd->blob + vpd->ro_size, &consumed,</span><br><span style="color: hsl(120, 100%, 40%);">+ vpd_gets_callback, &arg)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Iterate until found or no more entries. */</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!arg.matched)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *size = arg.value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ return arg.value;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+char *vpd_gets(const char *key, char *buffer, int size, enum vpd_region region)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ const void *string_address;</span><br><span style="color: hsl(120, 100%, 40%);">+ int string_size;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ string_address = vpd_find(key, &string_size, region);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!string_address)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (size > (string_size + 1)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(buffer, string_address, string_size);</span><br><span style="color: hsl(120, 100%, 40%);">+ buffer[string_size] = '\0';</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(buffer, string_address, size - 1);</span><br><span style="color: hsl(120, 100%, 40%);">+ buffer[size - 1] = '\0';</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return buffer;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+RAMSTAGE_CBMEM_INIT_HOOK(cbmem_add_cros_vpd)</span><br><span>diff --git a/src/drivers/vpd/vpd.h b/src/drivers/vpd/vpd.h</span><br><span>new file mode 100644</span><br><span>index 0000000..1877cc6</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/vpd.h</span><br><span>@@ -0,0 +1,42 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2014 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Use of this source code is governed by a BSD-style license that can be</span><br><span style="color: hsl(120, 100%, 40%);">+ * found in the LICENSE file.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#ifndef __VPD_H__</span><br><span style="color: hsl(120, 100%, 40%);">+#define __VPD_H__</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum vpd_region {</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_ANY = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_RO = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ VPD_RW = 2</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Reads VPD string value by key.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Reads in at most one less than size characters from VPD and stores them</span><br><span style="color: hsl(120, 100%, 40%);">+ * into buffer. A terminating null byte ('\0') is stored after the last</span><br><span style="color: hsl(120, 100%, 40%);">+ * character in the buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns NULL if key is not found, otherwise buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+char *vpd_gets(const char *key, char *buffer, int size, enum vpd_region region);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Find VPD value by key.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Searches for a VPD entry in the VPD cache. If found, places the size of the</span><br><span style="color: hsl(120, 100%, 40%);">+ * entry into '*size' and returns the pointer to the entry data.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This function presumes that VPD is cached in DRAM (which is the case in the</span><br><span style="color: hsl(120, 100%, 40%);">+ * current implementation) and as such returns the pointer into the cache. The</span><br><span style="color: hsl(120, 100%, 40%);">+ * user is not supposed to modify the data, and does not have to free the</span><br><span style="color: hsl(120, 100%, 40%);">+ * memory.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Returns NULL if key is not found.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+const void *vpd_find(const char *key, int *size, enum vpd_region region);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* __CROS_VPD_H__ */</span><br><span>diff --git a/src/drivers/vpd/vpd_tables.h b/src/drivers/vpd/vpd_tables.h</span><br><span>new file mode 100644</span><br><span>index 0000000..822ed08</span><br><span>--- /dev/null</span><br><span>+++ b/src/drivers/vpd/vpd_tables.h</span><br><span>@@ -0,0 +1,115 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2014 The Chromium OS Authors. All rights reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Use of this source code is governed by a BSD-style license that can be</span><br><span style="color: hsl(120, 100%, 40%);">+ * found in the LICENSE file.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Ported from mosys project (http://code.google.com/p/mosys/).</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#ifndef __LIB_VPD_TABLES_H__</span><br><span style="color: hsl(120, 100%, 40%);">+#define __LIB_VPD_TABLES_H__</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <compiler.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <inttypes.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define VPD_ENTRY_MAGIC "_SM_"</span><br><span style="color: hsl(120, 100%, 40%);">+#define VPD_INFO_MAGIC \</span><br><span style="color: hsl(120, 100%, 40%);">+ "\xfe" /* type: VPD header */ \</span><br><span style="color: hsl(120, 100%, 40%);">+ "\x09" /* key length, 9 = 1 + 8 */ \</span><br><span style="color: hsl(120, 100%, 40%);">+ "\x01" /* info version, 1 */ \</span><br><span style="color: hsl(120, 100%, 40%);">+ "gVpdInfo" /* signature, 8 bytes */ \</span><br><span style="color: hsl(120, 100%, 40%);">+ "\x04" /* value length */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Google specific VPD info */</span><br><span style="color: hsl(120, 100%, 40%);">+struct google_vpd_info {</span><br><span style="color: hsl(120, 100%, 40%);">+ union {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t type;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t key_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t info_ver;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t signature[8];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ } tlv;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t magic[12];</span><br><span style="color: hsl(120, 100%, 40%);">+ } header;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t size;</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Entry */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_entry {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t anchor_string[4];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t entry_cksum;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t entry_length;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t major_ver;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t minor_ver;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t max_size;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t entry_rev;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t format_area[5];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t inter_anchor_string[5];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t inter_anchor_cksum;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t table_length;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t table_address;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t table_entry_count;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t bcd_revision;</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Header */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_header {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t type;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t length;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t handle;</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Type 0 - firmware information */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_table_firmware {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t vendor;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t start_address;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t release_date;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t rom_size_64k_blocks;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t characteristics;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t extension[2]; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t major_ver; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t minor_ver; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t ec_major_ver; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t ec_minor_ver; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Type 1 - system information */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_table_system {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t manufacturer;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t name;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t serial_number;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t uuid[16];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t wakeup_type;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t sku_number; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t family; /* v2.4+ */</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Type 127 - end of table */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_table_eot {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct vpd_header header;</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Type 241 - binary blob pointer */</span><br><span style="color: hsl(120, 100%, 40%);">+struct vpd_table_binary_blob_pointer {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t struct_major_version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t struct_minor_version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t vendor;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t description;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t major_version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t minor_version;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t variant;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t reserved[5];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t uuid[16];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t offset;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t size;</span><br><span style="color: hsl(120, 100%, 40%);">+} __packed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* The length and number of strings defined here is not a limitation of VPD.</span><br><span style="color: hsl(120, 100%, 40%);">+ * These numbers were deemed good enough during development. */</span><br><span style="color: hsl(120, 100%, 40%);">+#define VPD_MAX_STRINGS 10</span><br><span style="color: hsl(120, 100%, 40%);">+#define VPD_MAX_STRING_LENGTH 64</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* __LIB_VPD_TABLES_H__ */</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/25046">change 25046</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/25046"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: Id9263bd39bf25d024e93daa57053fefcb1adc53a </div>
<div style="display:none"> Gerrit-Change-Number: 25046 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Patrick Rudolph <patrick.rudolph@9elements.com> </div>