[Settings] Use a settings applicator in ibft.c
[people/mdeck/gpxe.git] / src / core / ibft.c
1 /*
2  * Copyright Fen Systems Ltd. 2007.  Portions of this code are derived
3  * from IBM Corporation Sample Programs.  Copyright IBM Corporation
4  * 2004, 2007.  All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of this software and associated documentation
8  * files (the "Software"), to deal in the Software without
9  * restriction, including without limitation the rights to use, copy,
10  * modify, merge, publish, distribute, sublicense, and/or sell copies
11  * of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24  * SOFTWARE.
25  *
26  */
27
28 #include <stdint.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <errno.h>
32 #include <byteswap.h>
33 #include <realmode.h>
34 #include <gpxe/pci.h>
35 #include <gpxe/acpi.h>
36 #include <gpxe/in.h>
37 #include <gpxe/netdevice.h>
38 #include <gpxe/dhcp.h>
39 #include <gpxe/iscsi.h>
40 #include <gpxe/ibft.h>
41
42 /** @file
43  *
44  * iSCSI boot firmware table
45  *
46  * The information in this file is derived from the document "iSCSI
47  * Boot Firmware Table (iBFT)" as published by IBM at
48  *
49  * ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf
50  *
51  */
52
53 #define ibftab __use_data16 ( ibftab )
54 /** The iBFT used by gPXE */
55 struct gpxe_ibft __data16 ( ibftab ) = {
56         /* Table header */
57         .table = {
58                 /* ACPI header */
59                 .acpi = {
60                         .signature = IBFT_SIG,
61                         .length = sizeof ( ibftab ),
62                         .revision = 1,
63                         .oem_id = "FENSYS",
64                         .oem_table_id = "gPXE",
65                 },
66                 /* Control block */
67                 .control = {
68                         .header = {
69                                 .structure_id = IBFT_STRUCTURE_ID_CONTROL,
70                                 .version = 1,
71                                 .length = sizeof ( ibftab.table.control ),
72                                 .flags = 0,
73                         },
74                         .initiator = offsetof ( typeof ( ibftab ), initiator ),
75                         .nic_0 = offsetof ( typeof ( ibftab ), nic ),
76                         .target_0 = offsetof ( typeof ( ibftab ), target ),
77                 },
78         },
79         /* iSCSI initiator information */
80         .initiator = {
81                 .header = {
82                         .structure_id = IBFT_STRUCTURE_ID_INITIATOR,
83                         .version = 1,
84                         .length = sizeof ( ibftab.initiator ),
85                         .flags = ( IBFT_FL_INITIATOR_BLOCK_VALID |
86                                    IBFT_FL_INITIATOR_FIRMWARE_BOOT_SELECTED ),
87                 },
88         },
89         /* NIC information */
90         .nic = {
91                 .header = {
92                         .structure_id = IBFT_STRUCTURE_ID_NIC,
93                         .version = 1,
94                         .length = sizeof ( ibftab.nic ),
95                         .flags = ( IBFT_FL_NIC_BLOCK_VALID |
96                                    IBFT_FL_NIC_FIRMWARE_BOOT_SELECTED ),
97                 },
98         },
99         /* iSCSI target information */
100         .target = {
101                 .header = {
102                         .structure_id = IBFT_STRUCTURE_ID_TARGET,
103                         .version = 1,
104                         .length = sizeof ( ibftab.target ),
105                         .flags = ( IBFT_FL_TARGET_BLOCK_VALID |
106                                    IBFT_FL_TARGET_FIRMWARE_BOOT_SELECTED ),
107                 },
108         },
109 };
110
111 /**
112  * Fill in an IP address field within iBFT
113  *
114  * @v ipaddr            IP address field
115  * @v in                IPv4 address
116  */
117 static void ibft_set_ipaddr ( struct ibft_ipaddr *ipaddr, struct in_addr in ) {
118         memset ( ipaddr, 0, sizeof ( ipaddr ) );
119         if ( in.s_addr ) {
120                 ipaddr->in = in;
121                 ipaddr->ones = 0xffff;
122         }
123 }
124
125 /**
126  * Fill in an IP address within iBFT from DHCP option
127  *
128  * @v ipaddr            IP address field
129  * @v tag               DHCP option tag
130  */
131 static void ibft_set_ipaddr_option ( struct ibft_ipaddr *ipaddr,
132                                      unsigned int tag ) {
133         struct in_addr in = { 0 };
134         fetch_ipv4_setting ( NULL, tag, &in );
135         ibft_set_ipaddr ( ipaddr, in );
136 }
137
138 /**
139  * Allocate a string within iBFT
140  *
141  * @v strings           iBFT string block descriptor
142  * @v string            String field to fill in
143  * @v len               Length of string to allocate (excluding NUL)
144  * @ret rc              Return status code
145  */
146 static int ibft_alloc_string ( struct ibft_string_block *strings,
147                                struct ibft_string *string, size_t len ) {
148         char *dest;
149         unsigned int remaining;
150
151         dest = ( ( ( char * ) strings->table ) + strings->offset );
152         remaining = ( strings->table->acpi.length - strings->offset );
153         if ( len >= remaining )
154                 return -ENOMEM;
155
156         string->offset = strings->offset;
157         string->length = len;
158         strings->offset += ( len + 1 );
159         return 0;
160 }
161
162 /**
163  * Fill in a string field within iBFT
164  *
165  * @v strings           iBFT string block descriptor
166  * @v string            String field
167  * @v data              String to fill in
168  * @ret rc              Return status code
169  */
170 static int ibft_set_string ( struct ibft_string_block *strings,
171                              struct ibft_string *string, const char *data ) {
172         size_t len = strlen ( data );
173         char *dest;
174         int rc;
175
176         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
177                 return rc;
178         dest = ( ( ( char * ) strings->table ) + string->offset );
179         strcpy ( dest, data );
180
181         return 0;
182 }
183
184 /**
185  * Fill in a string field within iBFT from DHCP option
186  *
187  * @v strings           iBFT string block descriptor
188  * @v string            String field
189  * @v tag               DHCP option tag
190  * @ret rc              Return status code
191  */
192 static int ibft_set_string_option ( struct ibft_string_block *strings,
193                                     struct ibft_string *string,
194                                     unsigned int tag ) {
195         int len;
196         char *dest;
197         int rc;
198
199         len = fetch_setting_len ( NULL, tag );
200         if ( len < 0 ) {
201                 string->offset = 0;
202                 string->length = 0;
203                 return 0;
204         }
205
206         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
207                 return rc;
208         dest = ( ( ( char * ) strings->table ) + string->offset );
209         fetch_string_setting ( NULL, tag, dest, ( len + 1 ) );
210         return 0;
211 }
212
213 /**
214  * Fill in NIC portion of iBFT
215  *
216  * @v nic               NIC portion of iBFT
217  * @v strings           iBFT string block descriptor
218  * @v netdev            Network device
219  * @ret rc              Return status code
220  */
221 static int ibft_fill_nic ( struct ibft_nic *nic,
222                            struct ibft_string_block *strings,
223                            struct net_device *netdev ) {
224         struct in_addr netmask_addr = { 0 };
225         unsigned int netmask_count = 0;
226         int rc;
227
228         /* Extract values from DHCP configuration */
229         ibft_set_ipaddr_option ( &nic->ip_address, DHCP_EB_YIADDR );
230         ibft_set_ipaddr_option ( &nic->gateway, DHCP_ROUTERS );
231         ibft_set_ipaddr_option ( &nic->dns[0], DHCP_DNS_SERVERS );
232         if ( ( rc = ibft_set_string_option ( strings, &nic->hostname,
233                                              DHCP_HOST_NAME ) ) != 0 )
234                 return rc;
235
236         /* Derive subnet mask prefix from subnet mask */
237         fetch_ipv4_setting ( NULL, DHCP_SUBNET_MASK, &netmask_addr );
238         while ( netmask_addr.s_addr ) {
239                 if ( netmask_addr.s_addr & 0x1 )
240                         netmask_count++;
241                 netmask_addr.s_addr >>= 1;
242         }
243         nic->subnet_mask_prefix = netmask_count;
244
245         /* Extract values from net-device configuration */
246         memcpy ( nic->mac_address, netdev->ll_addr,
247                  sizeof ( nic->mac_address ) );
248         nic->pci_bus_dev_func = netdev->dev->desc.location;
249
250         return 0;
251 }
252
253 /**
254  * Fill in Initiator portion of iBFT
255  *
256  * @v initiator         Initiator portion of iBFT
257  * @v strings           iBFT string block descriptor
258  * @ret rc              Return status code
259  */
260 static int ibft_fill_initiator ( struct ibft_initiator *initiator,
261                                  struct ibft_string_block *strings ) {
262         const char *initiator_iqn = iscsi_initiator_iqn();
263         int rc;
264
265         if ( ( rc = ibft_set_string ( strings, &initiator->initiator_name,
266                                       initiator_iqn ) ) != 0 )
267                 return rc;
268
269         return 0;
270 }
271
272 /**
273  * Fill in Target portion of iBFT
274  *
275  * @v target            Target portion of iBFT
276  * @v strings           iBFT string block descriptor
277  * @v iscsi             iSCSI session
278  * @ret rc              Return status code
279  */
280 static int ibft_fill_target ( struct ibft_target *target,
281                               struct ibft_string_block *strings,
282                               struct iscsi_session *iscsi ) {
283         struct sockaddr_in *sin_target =
284                 ( struct sockaddr_in * ) &iscsi->target_sockaddr;
285         int rc;
286
287         /* Fill in Target values */
288         ibft_set_ipaddr ( &target->ip_address, sin_target->sin_addr );
289         target->socket = ntohs ( sin_target->sin_port );
290         if ( ( rc = ibft_set_string ( strings, &target->target_name,
291                                       iscsi->target_iqn ) ) != 0 )
292                 return rc;
293         if ( iscsi->username ) {
294                 if ( ( rc = ibft_set_string ( strings, &target->chap_name,
295                                               iscsi->username ) ) != 0 )
296                         return rc;
297         }
298         if ( iscsi->password ) {
299                 if ( ( rc = ibft_set_string ( strings, &target->chap_secret,
300                                               iscsi->password ) ) != 0 )
301                         return rc;
302                 target->chap_type = IBFT_CHAP_ONE_WAY;
303         }
304
305         return 0;
306 }
307
308 /**
309  * Fill in all variable portions of iBFT
310  *
311  * @v netdev            Network device
312  * @v initiator_iqn     Initiator IQN
313  * @v st_target         Target socket address
314  * @v target_iqn        Target IQN
315  * @ret rc              Return status code
316  *
317  */
318 int ibft_fill_data ( struct net_device *netdev,
319                      struct iscsi_session *iscsi ) {
320         struct ibft_string_block strings = {
321                 .table = &ibftab.table,
322                 .offset = offsetof ( typeof ( ibftab ), strings ),
323         };
324         int rc;
325
326         /* Fill in NIC, Initiator and Target portions */
327         if ( ( rc = ibft_fill_nic ( &ibftab.nic, &strings, netdev ) ) != 0 )
328                 return rc;
329         if ( ( rc = ibft_fill_initiator ( &ibftab.initiator,
330                                           &strings ) ) != 0 )
331                 return rc;
332         if ( ( rc = ibft_fill_target ( &ibftab.target, &strings,
333                                        iscsi ) ) != 0 )
334                 return rc;
335
336         /* Update checksum */
337         acpi_fix_checksum ( &ibftab.table.acpi );
338
339         return 0;
340 }