2 * (C) Copyright 2009-2016 CompuLab, Ltd.
4 * Authors: Nikita Kiryanov <nikita@compulab.co.il>
5 * Igor Grinberg <grinberg@compulab.co.il>
7 * SPDX-License-Identifier: GPL-2.0+
11 #include <linux/kernel.h>
12 #include <eeprom_layout.h>
13 #include <eeprom_field.h>
15 #define NO_LAYOUT_FIELDS "Unknown layout. Dumping raw data\n"
17 struct eeprom_field layout_unknown[1] = {
18 { NO_LAYOUT_FIELDS, 256, NULL, eeprom_field_print_bin,
19 eeprom_field_update_bin },
23 * eeprom_layout_detect() - detect layout based on the contents of the data.
24 * @data: Pointer to the data to be analyzed.
26 * Returns: the detected layout version.
28 __weak int eeprom_layout_detect(unsigned char *data)
30 return LAYOUT_VERSION_UNRECOGNIZED;
34 * __eeprom_layout_assign() - set the layout fields
35 * @layout: A pointer to an existing struct layout.
36 * @layout_version: The version number of the desired layout
38 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
41 layout->fields = layout_unknown;
42 layout->num_of_fields = ARRAY_SIZE(layout_unknown);
44 void eeprom_layout_assign(struct eeprom_layout *layout, int layout_version) \
45 __attribute__((weak, alias("__eeprom_layout_assign")));
48 * eeprom_layout_print() - print the layout and the data which is assigned to it
49 * @layout: A pointer to an existing struct layout.
51 static void eeprom_layout_print(const struct eeprom_layout *layout)
54 struct eeprom_field *fields = layout->fields;
56 for (i = 0; i < layout->num_of_fields; i++)
57 fields[i].print(&fields[i]);
61 * eeprom_layout_update_field() - update a single field in the layout data.
62 * @layout: A pointer to an existing struct layout.
63 * @field_name: The name of the field to update.
64 * @new_data: The new field data (a string. Format depends on the field)
66 * Returns: 0 on success, negative error value on failure.
68 static int eeprom_layout_update_field(struct eeprom_layout *layout,
69 char *field_name, char *new_data)
72 struct eeprom_field *fields = layout->fields;
77 if (field_name == NULL)
80 for (i = 0; i < layout->num_of_fields; i++) {
81 if (fields[i].name == RESERVED_FIELDS ||
82 strcmp(fields[i].name, field_name))
85 err = fields[i].update(&fields[i], new_data);
87 printf("Invalid data for field %s\n", field_name);
92 printf("No such field '%s'\n", field_name);
98 * eeprom_layout_setup() - setup layout struct with the layout data and
99 * metadata as dictated by layout_version
100 * @layout: A pointer to an existing struct layout.
101 * @buf: A buffer initialized with the eeprom data.
102 * @buf_size: Size of buf in bytes.
103 * @layout version: The version number of the layout.
105 void eeprom_layout_setup(struct eeprom_layout *layout, unsigned char *buf,
106 unsigned int buf_size, int layout_version)
110 if (layout_version == LAYOUT_VERSION_AUTODETECT)
111 layout->layout_version = eeprom_layout_detect(buf);
113 layout->layout_version = layout_version;
115 eeprom_layout_assign(layout, layout_version);
117 for (i = 0; i < layout->num_of_fields; i++) {
118 layout->fields[i].buf = buf;
119 buf += layout->fields[i].size;
122 layout->data_size = buf_size;
123 layout->print = eeprom_layout_print;
124 layout->update = eeprom_layout_update_field;