[settings] Add the notion of a "tag magic" to numbered settings
[people/sha0/gpxe.git] / src / arch / i386 / firmware / pcbios / smbios_settings.c
1 /*
2  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <string.h>
21 #include <errno.h>
22 #include <gpxe/settings.h>
23 #include <gpxe/init.h>
24 #include <gpxe/uuid.h>
25 #include <smbios.h>
26
27 /** SMBIOS settings tag magic number */
28 #define SMBIOS_TAG_MAGIC 0x5B /* "SmBios" */
29
30 /**
31  * Construct SMBIOS empty tag
32  *
33  * @ret tag             SMBIOS setting tag
34  */
35 #define SMBIOS_EMPTY_TAG ( SMBIOS_TAG_MAGIC << 24 )
36
37 /**
38  * Construct SMBIOS raw-data tag
39  *
40  * @v _type             SMBIOS structure type number
41  * @v _structure        SMBIOS structure data type
42  * @v _field            Field within SMBIOS structure data type
43  * @ret tag             SMBIOS setting tag
44  */
45 #define SMBIOS_RAW_TAG( _type, _structure, _field )             \
46         ( ( SMBIOS_TAG_MAGIC << 24 ) |                          \
47           ( (_type) << 16 ) |                                   \
48           ( offsetof ( _structure, _field ) << 8 ) |            \
49           ( sizeof ( ( ( _structure * ) 0 )->_field ) ) )
50
51 /**
52  * Construct SMBIOS string tag
53  *
54  * @v _type             SMBIOS structure type number
55  * @v _structure        SMBIOS structure data type
56  * @v _field            Field within SMBIOS structure data type
57  * @ret tag             SMBIOS setting tag
58  */
59 #define SMBIOS_STRING_TAG( _type, _structure, _field )          \
60         ( ( SMBIOS_TAG_MAGIC << 24 ) |                          \
61           ( (_type) << 16 ) |                                   \
62           ( offsetof ( _structure, _field ) << 8 ) )
63
64 /**
65  * Store value of SMBIOS setting
66  *
67  * @v settings          Settings block
68  * @v setting           Setting to store
69  * @v data              Setting data, or NULL to clear setting
70  * @v len               Length of setting data
71  * @ret rc              Return status code
72  */
73 static int smbios_store ( struct settings *settings __unused,
74                           struct setting *setting __unused,
75                           const void *data __unused, size_t len __unused ) {
76         /* Cannot write data into SMBIOS */
77         return -ENOTSUP;
78 }
79
80 /**
81  * Fetch value of SMBIOS setting
82  *
83  * @v settings          Settings block, or NULL to search all blocks
84  * @v setting           Setting to fetch
85  * @v data              Buffer to fill with setting data
86  * @v len               Length of buffer
87  * @ret len             Length of setting data, or negative error
88  */
89 static int smbios_fetch ( struct settings *settings __unused,
90                           struct setting *setting,
91                           void *data, size_t len ) {
92         struct smbios_structure structure;
93         unsigned int tag_magic;
94         unsigned int tag_type;
95         unsigned int tag_offset;
96         unsigned int tag_len;
97         int rc;
98
99         /* Split tag into type, offset and length */
100         tag_magic = ( setting->tag >> 24 );
101         tag_type = ( ( setting->tag >> 16 ) & 0xff );
102         tag_offset = ( ( setting->tag >> 8 ) & 0xff );
103         tag_len = ( setting->tag & 0xff );
104         if ( tag_magic != SMBIOS_TAG_MAGIC )
105                 return -ENOENT;
106
107         /* Find SMBIOS structure */
108         if ( ( rc = find_smbios_structure ( tag_type, &structure ) ) != 0 )
109                 return rc;
110
111         {
112                 uint8_t buf[structure.header.len];
113
114                 /* Read SMBIOS structure */
115                 if ( ( rc = read_smbios_structure ( &structure, buf,
116                                                     sizeof ( buf ) ) ) != 0 )
117                         return rc;
118
119                 if ( tag_len == 0 ) {
120                         /* String */
121                         return read_smbios_string ( &structure,
122                                                     buf[tag_offset],
123                                                     data, len );
124                 } else {
125                         /* Raw data */
126                         if ( len > tag_len )
127                                 len = tag_len;
128                         memcpy ( data, &buf[tag_offset], len );
129                         return tag_len;
130                 }
131         }
132 }
133
134 /** SMBIOS settings operations */
135 static struct settings_operations smbios_settings_operations = {
136         .store = smbios_store,
137         .fetch = smbios_fetch,
138 };
139
140 /** SMBIOS settings */
141 static struct settings smbios_settings = {
142         .refcnt = NULL,
143         .name = "smbios",
144         .tag_magic = SMBIOS_EMPTY_TAG,
145         .siblings = LIST_HEAD_INIT ( smbios_settings.siblings ),
146         .children = LIST_HEAD_INIT ( smbios_settings.children ),
147         .op = &smbios_settings_operations,
148 };
149
150 /** Initialise SMBIOS settings */
151 static void smbios_init ( void ) {
152         int rc;
153
154         if ( ( rc = register_settings ( &smbios_settings, NULL ) ) != 0 ) {
155                 DBG ( "SMBIOS could not register settings: %s\n",
156                       strerror ( rc ) );
157                 return;
158         }
159 }
160
161 /** SMBIOS settings initialiser */
162 struct init_fn smbios_init_fn __init_fn ( INIT_NORMAL ) = {
163         .initialise = smbios_init,
164 };
165
166 /** UUID setting obtained via SMBIOS */
167 struct setting uuid_setting __setting = {
168         .name = "uuid",
169         .description = "UUID",
170         .tag = SMBIOS_RAW_TAG ( SMBIOS_TYPE_SYSTEM_INFORMATION,
171                                 struct smbios_system_information, uuid ),
172         .type = &setting_type_uuid,
173 };
174
175 /** Other SMBIOS named settings */
176 struct setting smbios_named_settings[] __setting = {
177         {
178                 .name = "manufacturer",
179                 .description = "Manufacturer",
180                 .tag = SMBIOS_STRING_TAG ( SMBIOS_TYPE_SYSTEM_INFORMATION,
181                                            struct smbios_system_information,
182                                            manufacturer ),
183                 .type = &setting_type_string,
184         },
185         {
186                 .name = "product",
187                 .description = "Product name",
188                 .tag = SMBIOS_STRING_TAG ( SMBIOS_TYPE_SYSTEM_INFORMATION,
189                                            struct smbios_system_information,
190                                            product ),
191                 .type = &setting_type_string,
192         },
193         {
194                 .name = "serial",
195                 .description = "Serial number",
196                 .tag = SMBIOS_STRING_TAG ( SMBIOS_TYPE_SYSTEM_INFORMATION,
197                                            struct smbios_system_information,
198                                            serial ),
199                 .type = &setting_type_string,
200         },
201 };