1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * (C) Copyright 2009-2016 CompuLab, Ltd.
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Authors: Nikita Kiryanov <nikita@compulab.co.il>
5*4882a593Smuzhiyun * Igor Grinberg <grinberg@compulab.co.il>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <common.h>
11*4882a593Smuzhiyun #include <linux/kernel.h>
12*4882a593Smuzhiyun #include <eeprom_layout.h>
13*4882a593Smuzhiyun #include <eeprom_field.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #define NO_LAYOUT_FIELDS "Unknown layout. Dumping raw data\n"
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun struct eeprom_field layout_unknown[1] = {
18*4882a593Smuzhiyun { NO_LAYOUT_FIELDS, 256, NULL, eeprom_field_print_bin,
19*4882a593Smuzhiyun eeprom_field_update_bin },
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun /*
23*4882a593Smuzhiyun * eeprom_layout_detect() - detect layout based on the contents of the data.
24*4882a593Smuzhiyun * @data: Pointer to the data to be analyzed.
25*4882a593Smuzhiyun *
26*4882a593Smuzhiyun * Returns: the detected layout version.
27*4882a593Smuzhiyun */
eeprom_layout_detect(unsigned char * data)28*4882a593Smuzhiyun __weak int eeprom_layout_detect(unsigned char *data)
29*4882a593Smuzhiyun {
30*4882a593Smuzhiyun return LAYOUT_VERSION_UNRECOGNIZED;
31*4882a593Smuzhiyun }
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun /*
34*4882a593Smuzhiyun * __eeprom_layout_assign() - set the layout fields
35*4882a593Smuzhiyun * @layout: A pointer to an existing struct layout.
36*4882a593Smuzhiyun * @layout_version: The version number of the desired layout
37*4882a593Smuzhiyun */
__eeprom_layout_assign(struct eeprom_layout * layout,int layout_version)38*4882a593Smuzhiyun __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
39*4882a593Smuzhiyun int layout_version)
40*4882a593Smuzhiyun {
41*4882a593Smuzhiyun layout->fields = layout_unknown;
42*4882a593Smuzhiyun layout->num_of_fields = ARRAY_SIZE(layout_unknown);
43*4882a593Smuzhiyun }
44*4882a593Smuzhiyun void eeprom_layout_assign(struct eeprom_layout *layout, int layout_version) \
45*4882a593Smuzhiyun __attribute__((weak, alias("__eeprom_layout_assign")));
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun /*
48*4882a593Smuzhiyun * eeprom_layout_print() - print the layout and the data which is assigned to it
49*4882a593Smuzhiyun * @layout: A pointer to an existing struct layout.
50*4882a593Smuzhiyun */
eeprom_layout_print(const struct eeprom_layout * layout)51*4882a593Smuzhiyun static void eeprom_layout_print(const struct eeprom_layout *layout)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun int i;
54*4882a593Smuzhiyun struct eeprom_field *fields = layout->fields;
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun for (i = 0; i < layout->num_of_fields; i++)
57*4882a593Smuzhiyun fields[i].print(&fields[i]);
58*4882a593Smuzhiyun }
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun /*
61*4882a593Smuzhiyun * eeprom_layout_update_field() - update a single field in the layout data.
62*4882a593Smuzhiyun * @layout: A pointer to an existing struct layout.
63*4882a593Smuzhiyun * @field_name: The name of the field to update.
64*4882a593Smuzhiyun * @new_data: The new field data (a string. Format depends on the field)
65*4882a593Smuzhiyun *
66*4882a593Smuzhiyun * Returns: 0 on success, negative error value on failure.
67*4882a593Smuzhiyun */
eeprom_layout_update_field(struct eeprom_layout * layout,char * field_name,char * new_data)68*4882a593Smuzhiyun static int eeprom_layout_update_field(struct eeprom_layout *layout,
69*4882a593Smuzhiyun char *field_name, char *new_data)
70*4882a593Smuzhiyun {
71*4882a593Smuzhiyun int i, err;
72*4882a593Smuzhiyun struct eeprom_field *fields = layout->fields;
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun if (new_data == NULL)
75*4882a593Smuzhiyun return 0;
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun if (field_name == NULL)
78*4882a593Smuzhiyun return -1;
79*4882a593Smuzhiyun
80*4882a593Smuzhiyun for (i = 0; i < layout->num_of_fields; i++) {
81*4882a593Smuzhiyun if (fields[i].name == RESERVED_FIELDS ||
82*4882a593Smuzhiyun strcmp(fields[i].name, field_name))
83*4882a593Smuzhiyun continue;
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun err = fields[i].update(&fields[i], new_data);
86*4882a593Smuzhiyun if (err)
87*4882a593Smuzhiyun printf("Invalid data for field %s\n", field_name);
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun return err;
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun printf("No such field '%s'\n", field_name);
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun return -1;
95*4882a593Smuzhiyun }
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun /*
98*4882a593Smuzhiyun * eeprom_layout_setup() - setup layout struct with the layout data and
99*4882a593Smuzhiyun * metadata as dictated by layout_version
100*4882a593Smuzhiyun * @layout: A pointer to an existing struct layout.
101*4882a593Smuzhiyun * @buf: A buffer initialized with the eeprom data.
102*4882a593Smuzhiyun * @buf_size: Size of buf in bytes.
103*4882a593Smuzhiyun * @layout version: The version number of the layout.
104*4882a593Smuzhiyun */
eeprom_layout_setup(struct eeprom_layout * layout,unsigned char * buf,unsigned int buf_size,int layout_version)105*4882a593Smuzhiyun void eeprom_layout_setup(struct eeprom_layout *layout, unsigned char *buf,
106*4882a593Smuzhiyun unsigned int buf_size, int layout_version)
107*4882a593Smuzhiyun {
108*4882a593Smuzhiyun int i;
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun if (layout_version == LAYOUT_VERSION_AUTODETECT)
111*4882a593Smuzhiyun layout->layout_version = eeprom_layout_detect(buf);
112*4882a593Smuzhiyun else
113*4882a593Smuzhiyun layout->layout_version = layout_version;
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun eeprom_layout_assign(layout, layout_version);
116*4882a593Smuzhiyun layout->data = buf;
117*4882a593Smuzhiyun for (i = 0; i < layout->num_of_fields; i++) {
118*4882a593Smuzhiyun layout->fields[i].buf = buf;
119*4882a593Smuzhiyun buf += layout->fields[i].size;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun layout->data_size = buf_size;
123*4882a593Smuzhiyun layout->print = eeprom_layout_print;
124*4882a593Smuzhiyun layout->update = eeprom_layout_update_field;
125*4882a593Smuzhiyun }
126