fda14704c5e744fc0e8470250e9c862a8f4c4fd2
[people/mcb30/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 configuration setting
127  *
128  * @v ipaddr            IP address field
129  * @v setting           Configuration setting
130  * @v tag               DHCP option tag
131  */
132 static void ibft_set_ipaddr_option ( struct ibft_ipaddr *ipaddr,
133                                      struct setting *setting ) {
134         struct in_addr in = { 0 };
135         fetch_ipv4_setting ( NULL, setting, &in );
136         ibft_set_ipaddr ( ipaddr, in );
137 }
138
139 /**
140  * Allocate a string within iBFT
141  *
142  * @v strings           iBFT string block descriptor
143  * @v string            String field to fill in
144  * @v len               Length of string to allocate (excluding NUL)
145  * @ret rc              Return status code
146  */
147 static int ibft_alloc_string ( struct ibft_string_block *strings,
148                                struct ibft_string *string, size_t len ) {
149         char *dest;
150         unsigned int remaining;
151
152         dest = ( ( ( char * ) strings->table ) + strings->offset );
153         remaining = ( strings->table->acpi.length - strings->offset );
154         if ( len >= remaining )
155                 return -ENOMEM;
156
157         string->offset = strings->offset;
158         string->length = len;
159         strings->offset += ( len + 1 );
160         return 0;
161 }
162
163 /**
164  * Fill in a string field within iBFT
165  *
166  * @v strings           iBFT string block descriptor
167  * @v string            String field
168  * @v data              String to fill in
169  * @ret rc              Return status code
170  */
171 static int ibft_set_string ( struct ibft_string_block *strings,
172                              struct ibft_string *string, const char *data ) {
173         size_t len = strlen ( data );
174         char *dest;
175         int rc;
176
177         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
178                 return rc;
179         dest = ( ( ( char * ) strings->table ) + string->offset );
180         strcpy ( dest, data );
181
182         return 0;
183 }
184
185 /**
186  * Fill in a string field within iBFT from configuration setting
187  *
188  * @v strings           iBFT string block descriptor
189  * @v string            String field
190  * @v setting           Configuration setting
191  * @ret rc              Return status code
192  */
193 static int ibft_set_string_option ( struct ibft_string_block *strings,
194                                     struct ibft_string *string,
195                                     struct setting *setting ) {
196         int len;
197         char *dest;
198         int rc;
199
200         len = fetch_setting_len ( NULL, setting );
201         if ( len < 0 ) {
202                 string->offset = 0;
203                 string->length = 0;
204                 return 0;
205         }
206
207         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
208                 return rc;
209         dest = ( ( ( char * ) strings->table ) + string->offset );
210         fetch_string_setting ( NULL, setting, dest, ( len + 1 ) );
211         return 0;
212 }
213
214 /**
215  * Fill in NIC portion of iBFT
216  *
217  * @v nic               NIC portion of iBFT
218  * @v strings           iBFT string block descriptor
219  * @v netdev            Network device
220  * @ret rc              Return status code
221  */
222 static int ibft_fill_nic ( struct ibft_nic *nic,
223                            struct ibft_string_block *strings,
224                            struct net_device *netdev ) {
225         struct in_addr netmask_addr = { 0 };
226         unsigned int netmask_count = 0;
227         int rc;
228
229         /* Extract values from DHCP configuration */
230         ibft_set_ipaddr_option ( &nic->ip_address, &ip_setting );
231         ibft_set_ipaddr_option ( &nic->gateway, &gateway_setting );
232         ibft_set_ipaddr_option ( &nic->dns[0], &dns_setting );
233         if ( ( rc = ibft_set_string_option ( strings, &nic->hostname,
234                                              &hostname_setting ) ) != 0 )
235                 return rc;
236
237         /* Derive subnet mask prefix from subnet mask */
238         fetch_ipv4_setting ( NULL, &netmask_setting, &netmask_addr );
239         while ( netmask_addr.s_addr ) {
240                 if ( netmask_addr.s_addr & 0x1 )
241                         netmask_count++;
242                 netmask_addr.s_addr >>= 1;
243         }
244         nic->subnet_mask_prefix = netmask_count;
245
246         /* Extract values from net-device configuration */
247         memcpy ( nic->mac_address, netdev->ll_addr,
248                  sizeof ( nic->mac_address ) );
249         nic->pci_bus_dev_func = netdev->dev->desc.location;
250
251         return 0;
252 }
253
254 /**
255  * Fill in Initiator portion of iBFT
256  *
257  * @v initiator         Initiator portion of iBFT
258  * @v strings           iBFT string block descriptor
259  * @ret rc              Return status code
260  */
261 static int ibft_fill_initiator ( struct ibft_initiator *initiator,
262                                  struct ibft_string_block *strings ) {
263         const char *initiator_iqn = iscsi_initiator_iqn();
264         int rc;
265
266         if ( ( rc = ibft_set_string ( strings, &initiator->initiator_name,
267                                       initiator_iqn ) ) != 0 )
268                 return rc;
269
270         return 0;
271 }
272
273 /**
274  * Fill in Target portion of iBFT
275  *
276  * @v target            Target portion of iBFT
277  * @v strings           iBFT string block descriptor
278  * @v iscsi             iSCSI session
279  * @ret rc              Return status code
280  */
281 static int ibft_fill_target ( struct ibft_target *target,
282                               struct ibft_string_block *strings,
283                               struct iscsi_session *iscsi ) {
284         struct sockaddr_in *sin_target =
285                 ( struct sockaddr_in * ) &iscsi->target_sockaddr;
286         int rc;
287
288         /* Fill in Target values */
289         ibft_set_ipaddr ( &target->ip_address, sin_target->sin_addr );
290         target->socket = ntohs ( sin_target->sin_port );
291         if ( ( rc = ibft_set_string ( strings, &target->target_name,
292                                       iscsi->target_iqn ) ) != 0 )
293                 return rc;
294         if ( iscsi->username ) {
295                 if ( ( rc = ibft_set_string ( strings, &target->chap_name,
296                                               iscsi->username ) ) != 0 )
297                         return rc;
298         }
299         if ( iscsi->password ) {
300                 if ( ( rc = ibft_set_string ( strings, &target->chap_secret,
301                                               iscsi->password ) ) != 0 )
302                         return rc;
303                 target->chap_type = IBFT_CHAP_ONE_WAY;
304         }
305
306         return 0;
307 }
308
309 /**
310  * Fill in all variable portions of iBFT
311  *
312  * @v netdev            Network device
313  * @v initiator_iqn     Initiator IQN
314  * @v st_target         Target socket address
315  * @v target_iqn        Target IQN
316  * @ret rc              Return status code
317  *
318  */
319 int ibft_fill_data ( struct net_device *netdev,
320                      struct iscsi_session *iscsi ) {
321         struct ibft_string_block strings = {
322                 .table = &ibftab.table,
323                 .offset = offsetof ( typeof ( ibftab ), strings ),
324         };
325         int rc;
326
327         /* Fill in NIC, Initiator and Target portions */
328         if ( ( rc = ibft_fill_nic ( &ibftab.nic, &strings, netdev ) ) != 0 )
329                 return rc;
330         if ( ( rc = ibft_fill_initiator ( &ibftab.initiator,
331                                           &strings ) ) != 0 )
332                 return rc;
333         if ( ( rc = ibft_fill_target ( &ibftab.target, &strings,
334                                        iscsi ) ) != 0 )
335                 return rc;
336
337         /* Update checksum */
338         acpi_fix_checksum ( &ibftab.table.acpi );
339
340         return 0;
341 }