[i386] Move iSCSI and AoE boot code to arch/i386/interface/pcbios
[people/peper/gpxe.git] / src / arch / i386 / interface / pcbios / 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, or NULL
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         char *dest;
174         int rc;
175
176         if ( ! data )
177                 return 0;
178
179         if ( ( rc = ibft_alloc_string ( strings, string,
180                                         strlen ( data ) ) ) != 0 )
181                 return rc;
182         dest = ( ( ( char * ) strings->table ) + string->offset );
183         strcpy ( dest, data );
184
185         return 0;
186 }
187
188 /**
189  * Fill in a string field within iBFT from configuration setting
190  *
191  * @v strings           iBFT string block descriptor
192  * @v string            String field
193  * @v setting           Configuration setting
194  * @ret rc              Return status code
195  */
196 static int ibft_set_string_option ( struct ibft_string_block *strings,
197                                     struct ibft_string *string,
198                                     struct setting *setting ) {
199         int len;
200         char *dest;
201         int rc;
202
203         len = fetch_setting_len ( NULL, setting );
204         if ( len < 0 ) {
205                 string->offset = 0;
206                 string->length = 0;
207                 return 0;
208         }
209
210         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
211                 return rc;
212         dest = ( ( ( char * ) strings->table ) + string->offset );
213         fetch_string_setting ( NULL, setting, dest, ( len + 1 ) );
214         return 0;
215 }
216
217 /**
218  * Fill in NIC portion of iBFT
219  *
220  * @v nic               NIC portion of iBFT
221  * @v strings           iBFT string block descriptor
222  * @v netdev            Network device
223  * @ret rc              Return status code
224  */
225 static int ibft_fill_nic ( struct ibft_nic *nic,
226                            struct ibft_string_block *strings,
227                            struct net_device *netdev ) {
228         struct in_addr netmask_addr = { 0 };
229         unsigned int netmask_count = 0;
230         int rc;
231
232         /* Extract values from DHCP configuration */
233         ibft_set_ipaddr_option ( &nic->ip_address, &ip_setting );
234         ibft_set_ipaddr_option ( &nic->gateway, &gateway_setting );
235         ibft_set_ipaddr_option ( &nic->dns[0], &dns_setting );
236         if ( ( rc = ibft_set_string_option ( strings, &nic->hostname,
237                                              &hostname_setting ) ) != 0 )
238                 return rc;
239
240         /* Derive subnet mask prefix from subnet mask */
241         fetch_ipv4_setting ( NULL, &netmask_setting, &netmask_addr );
242         while ( netmask_addr.s_addr ) {
243                 if ( netmask_addr.s_addr & 0x1 )
244                         netmask_count++;
245                 netmask_addr.s_addr >>= 1;
246         }
247         nic->subnet_mask_prefix = netmask_count;
248
249         /* Extract values from net-device configuration */
250         memcpy ( nic->mac_address, netdev->ll_addr,
251                  sizeof ( nic->mac_address ) );
252         nic->pci_bus_dev_func = netdev->dev->desc.location;
253
254         return 0;
255 }
256
257 /**
258  * Fill in Initiator portion of iBFT
259  *
260  * @v initiator         Initiator portion of iBFT
261  * @v strings           iBFT string block descriptor
262  * @ret rc              Return status code
263  */
264 static int ibft_fill_initiator ( struct ibft_initiator *initiator,
265                                  struct ibft_string_block *strings ) {
266         const char *initiator_iqn = iscsi_initiator_iqn();
267         int rc;
268
269         if ( ( rc = ibft_set_string ( strings, &initiator->initiator_name,
270                                       initiator_iqn ) ) != 0 )
271                 return rc;
272
273         return 0;
274 }
275
276 /**
277  * Fill in Target CHAP portion of iBFT
278  *
279  * @v target            Target portion of iBFT
280  * @v strings           iBFT string block descriptor
281  * @v iscsi             iSCSI session
282  * @ret rc              Return status code
283  */
284 static int ibft_fill_target_chap ( struct ibft_target *target,
285                                    struct ibft_string_block *strings,
286                                    struct iscsi_session *iscsi ) {
287         int rc;
288
289         if ( ! iscsi->initiator_username )
290                 return 0;
291         assert ( iscsi->initiator_password );
292
293         target->chap_type = IBFT_CHAP_ONE_WAY;
294         if ( ( rc = ibft_set_string ( strings, &target->chap_name,
295                                       iscsi->initiator_username ) ) != 0 )
296                 return rc;
297         if ( ( rc = ibft_set_string ( strings, &target->chap_secret,
298                                       iscsi->initiator_password ) ) != 0 )
299                 return rc;
300         return 0;
301 }
302
303 /**
304  * Fill in Target Reverse CHAP portion of iBFT
305  *
306  * @v target            Target portion of iBFT
307  * @v strings           iBFT string block descriptor
308  * @v iscsi             iSCSI session
309  * @ret rc              Return status code
310  */
311 static int ibft_fill_target_reverse_chap ( struct ibft_target *target,
312                                            struct ibft_string_block *strings,
313                                            struct iscsi_session *iscsi ) {
314         int rc;
315
316         if ( ! iscsi->target_username )
317                 return 0;
318         assert ( iscsi->target_password );
319         assert ( iscsi->initiator_username );
320         assert ( iscsi->initiator_password );
321
322         target->chap_type = IBFT_CHAP_MUTUAL;
323         if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_name,
324                                       iscsi->target_username ) ) != 0 )
325                 return rc;
326         if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_secret,
327                                       iscsi->target_password ) ) != 0 )
328                 return rc;
329         return 0;
330 }
331
332 /**
333  * Fill in Target portion of iBFT
334  *
335  * @v target            Target portion of iBFT
336  * @v strings           iBFT string block descriptor
337  * @v iscsi             iSCSI session
338  * @ret rc              Return status code
339  */
340 static int ibft_fill_target ( struct ibft_target *target,
341                               struct ibft_string_block *strings,
342                               struct iscsi_session *iscsi ) {
343         struct sockaddr_in *sin_target =
344                 ( struct sockaddr_in * ) &iscsi->target_sockaddr;
345         int rc;
346
347         /* Fill in Target values */
348         ibft_set_ipaddr ( &target->ip_address, sin_target->sin_addr );
349         target->socket = ntohs ( sin_target->sin_port );
350         if ( ( rc = ibft_set_string ( strings, &target->target_name,
351                                       iscsi->target_iqn ) ) != 0 )
352                 return rc;
353         if ( ( rc = ibft_fill_target_chap ( target, strings, iscsi ) ) != 0 )
354                 return rc;
355         if ( ( rc = ibft_fill_target_reverse_chap ( target, strings,
356                                                     iscsi ) ) != 0 )
357                 return rc;
358
359         return 0;
360 }
361
362 /**
363  * Fill in all variable portions of iBFT
364  *
365  * @v netdev            Network device
366  * @v initiator_iqn     Initiator IQN
367  * @v st_target         Target socket address
368  * @v target_iqn        Target IQN
369  * @ret rc              Return status code
370  *
371  */
372 int ibft_fill_data ( struct net_device *netdev,
373                      struct iscsi_session *iscsi ) {
374         struct ibft_string_block strings = {
375                 .table = &ibftab.table,
376                 .offset = offsetof ( typeof ( ibftab ), strings ),
377         };
378         int rc;
379
380         /* Fill in NIC, Initiator and Target portions */
381         if ( ( rc = ibft_fill_nic ( &ibftab.nic, &strings, netdev ) ) != 0 )
382                 return rc;
383         if ( ( rc = ibft_fill_initiator ( &ibftab.initiator,
384                                           &strings ) ) != 0 )
385                 return rc;
386         if ( ( rc = ibft_fill_target ( &ibftab.target, &strings,
387                                        iscsi ) ) != 0 )
388                 return rc;
389
390         /* Update checksum */
391         acpi_fix_checksum ( &ibftab.table.acpi );
392
393         return 0;
394 }