diff options
Diffstat (limited to 'qemu/roms/ipxe/src/drivers/block/ibft.c')
-rw-r--r-- | qemu/roms/ipxe/src/drivers/block/ibft.c | 497 |
1 files changed, 0 insertions, 497 deletions
diff --git a/qemu/roms/ipxe/src/drivers/block/ibft.c b/qemu/roms/ipxe/src/drivers/block/ibft.c deleted file mode 100644 index 6aabd766a..000000000 --- a/qemu/roms/ipxe/src/drivers/block/ibft.c +++ /dev/null @@ -1,497 +0,0 @@ -/* - * Copyright Fen Systems Ltd. 2007. Portions of this code are derived - * from IBM Corporation Sample Programs. Copyright IBM Corporation - * 2004, 2007. All rights reserved. - * - * Permission is hereby granted, free of charge, to any person - * obtaining a copy of this software and associated documentation - * files (the "Software"), to deal in the Software without - * restriction, including without limitation the rights to use, copy, - * modify, merge, publish, distribute, sublicense, and/or sell copies - * of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS - * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN - * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - * - */ - -FILE_LICENCE ( BSD2 ); - -#include <stdint.h> -#include <stdio.h> -#include <string.h> -#include <errno.h> -#include <byteswap.h> -#include <ipxe/pci.h> -#include <ipxe/acpi.h> -#include <ipxe/in.h> -#include <ipxe/netdevice.h> -#include <ipxe/ethernet.h> -#include <ipxe/vlan.h> -#include <ipxe/dhcp.h> -#include <ipxe/iscsi.h> -#include <ipxe/ibft.h> - -/** @file - * - * iSCSI boot firmware table - * - * The information in this file is derived from the document "iSCSI - * Boot Firmware Table (iBFT)" as published by IBM at - * - * ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf - * - */ - -/** - * An iBFT created by iPXE - * - */ -struct ipxe_ibft { - /** The fixed section */ - struct ibft_table table; - /** The Initiator section */ - struct ibft_initiator initiator __attribute__ (( aligned ( 16 ) )); - /** The NIC section */ - struct ibft_nic nic __attribute__ (( aligned ( 16 ) )); - /** The Target section */ - struct ibft_target target __attribute__ (( aligned ( 16 ) )); - /** Strings block */ - char strings[0]; -} __attribute__ (( packed, aligned ( 16 ) )); - -/** - * iSCSI string block descriptor - * - * This is an internal structure that we use to keep track of the - * allocation of string data. - */ -struct ibft_strings { - /** The iBFT containing these strings */ - struct ibft_table *table; - /** Offset of first free byte within iBFT */ - size_t offset; - /** Total length of the iBFT */ - size_t len; -}; - -/** - * Fill in an IP address field within iBFT - * - * @v ipaddr IP address field - * @v in IPv4 address - */ -static void ibft_set_ipaddr ( struct ibft_ipaddr *ipaddr, struct in_addr in ) { - memset ( ipaddr, 0, sizeof ( *ipaddr ) ); - if ( in.s_addr ) { - ipaddr->in = in; - ipaddr->ones = 0xffff; - } -} - -/** - * Fill in an IP address within iBFT from configuration setting - * - * @v settings Parent settings block, or NULL - * @v ipaddr IP address field - * @v setting Configuration setting - * @v count Maximum number of IP addresses - */ -static void ibft_set_ipaddr_setting ( struct settings *settings, - struct ibft_ipaddr *ipaddr, - const struct setting *setting, - unsigned int count ) { - struct in_addr in[count]; - unsigned int i; - - fetch_ipv4_array_setting ( settings, setting, in, count ); - for ( i = 0 ; i < count ; i++ ) { - ibft_set_ipaddr ( &ipaddr[i], in[i] ); - } -} - -/** - * Read IP address from iBFT (for debugging) - * - * @v strings iBFT string block descriptor - * @v string String field - * @ret ipaddr IP address string - */ -static const char * ibft_ipaddr ( struct ibft_ipaddr *ipaddr ) { - return inet_ntoa ( ipaddr->in ); -} - -/** - * Allocate a string within iBFT - * - * @v strings iBFT string block descriptor - * @v string String field to fill in - * @v len Length of string to allocate (excluding NUL) - * @ret dest String destination, or NULL - */ -static char * ibft_alloc_string ( struct ibft_strings *strings, - struct ibft_string *string, size_t len ) { - - if ( ( strings->offset + len ) >= strings->len ) - return NULL; - - string->offset = cpu_to_le16 ( strings->offset ); - string->len = cpu_to_le16 ( len ); - strings->offset += ( len + 1 ); - - return ( ( ( char * ) strings->table ) + string->offset ); -} - -/** - * Fill in a string field within iBFT - * - * @v strings iBFT string block descriptor - * @v string String field - * @v data String to fill in, or NULL - * @ret rc Return status code - */ -static int ibft_set_string ( struct ibft_strings *strings, - struct ibft_string *string, const char *data ) { - char *dest; - - if ( ! data ) - return 0; - - dest = ibft_alloc_string ( strings, string, strlen ( data ) ); - if ( ! dest ) - return -ENOBUFS; - strcpy ( dest, data ); - - return 0; -} - -/** - * Fill in a string field within iBFT from configuration setting - * - * @v settings Parent settings block, or NULL - * @v strings iBFT string block descriptor - * @v string String field - * @v setting Configuration setting - * @ret rc Return status code - */ -static int ibft_set_string_setting ( struct settings *settings, - struct ibft_strings *strings, - struct ibft_string *string, - const struct setting *setting ) { - struct settings *origin; - struct setting fetched; - int len; - char *dest; - - len = fetch_setting ( settings, setting, &origin, &fetched, NULL, 0 ); - if ( len < 0 ) { - string->offset = 0; - string->len = 0; - return 0; - } - - dest = ibft_alloc_string ( strings, string, len ); - if ( ! dest ) - return -ENOBUFS; - fetch_string_setting ( origin, &fetched, dest, ( len + 1 )); - - return 0; -} - -/** - * Read string from iBFT (for debugging) - * - * @v strings iBFT string block descriptor - * @v string String field - * @ret data String content (or "<empty>") - */ -static const char * ibft_string ( struct ibft_strings *strings, - struct ibft_string *string ) { - return ( string->offset ? - ( ( ( char * ) strings->table ) + string->offset ) : NULL ); -} - -/** - * Fill in NIC portion of iBFT - * - * @v nic NIC portion of iBFT - * @v strings iBFT string block descriptor - * @v netdev Network device - * @ret rc Return status code - */ -static int ibft_fill_nic ( struct ibft_nic *nic, - struct ibft_strings *strings, - struct net_device *netdev ) { - struct ll_protocol *ll_protocol = netdev->ll_protocol; - struct in_addr netmask_addr = { 0 }; - unsigned int netmask_count = 0; - struct settings *parent = netdev_settings ( netdev ); - struct settings *origin; - int rc; - - /* Fill in common header */ - nic->header.structure_id = IBFT_STRUCTURE_ID_NIC; - nic->header.version = 1; - nic->header.length = cpu_to_le16 ( sizeof ( *nic ) ); - nic->header.flags = ( IBFT_FL_NIC_BLOCK_VALID | - IBFT_FL_NIC_FIRMWARE_BOOT_SELECTED ); - - /* Determine origin of IP address */ - fetch_setting ( parent, &ip_setting, &origin, NULL, NULL, 0 ); - nic->origin = ( ( origin == parent ) ? - IBFT_NIC_ORIGIN_MANUAL : IBFT_NIC_ORIGIN_DHCP ); - DBG ( "iBFT NIC origin = %d\n", nic->origin ); - - /* Extract values from configuration settings */ - ibft_set_ipaddr_setting ( parent, &nic->ip_address, &ip_setting, 1 ); - DBG ( "iBFT NIC IP = %s\n", ibft_ipaddr ( &nic->ip_address ) ); - ibft_set_ipaddr_setting ( parent, &nic->gateway, &gateway_setting, 1 ); - DBG ( "iBFT NIC gateway = %s\n", ibft_ipaddr ( &nic->gateway ) ); - ibft_set_ipaddr_setting ( NULL, &nic->dns[0], &dns_setting, - ( sizeof ( nic->dns ) / - sizeof ( nic->dns[0] ) ) ); - DBG ( "iBFT NIC DNS = %s", ibft_ipaddr ( &nic->dns[0] ) ); - DBG ( ", %s\n", ibft_ipaddr ( &nic->dns[1] ) ); - if ( ( rc = ibft_set_string_setting ( NULL, strings, &nic->hostname, - &hostname_setting ) ) != 0 ) - return rc; - DBG ( "iBFT NIC hostname = %s\n", - ibft_string ( strings, &nic->hostname ) ); - - /* Derive subnet mask prefix from subnet mask */ - fetch_ipv4_setting ( parent, &netmask_setting, &netmask_addr ); - while ( netmask_addr.s_addr ) { - if ( netmask_addr.s_addr & 0x1 ) - netmask_count++; - netmask_addr.s_addr >>= 1; - } - nic->subnet_mask_prefix = netmask_count; - DBG ( "iBFT NIC subnet = /%d\n", nic->subnet_mask_prefix ); - - /* Extract values from net-device configuration */ - nic->vlan = cpu_to_le16 ( vlan_tag ( netdev ) ); - DBG ( "iBFT NIC VLAN = %02x\n", le16_to_cpu ( nic->vlan ) ); - if ( ( rc = ll_protocol->eth_addr ( netdev->ll_addr, - nic->mac_address ) ) != 0 ) { - DBG ( "Could not determine iBFT MAC: %s\n", strerror ( rc ) ); - return rc; - } - DBG ( "iBFT NIC MAC = %s\n", eth_ntoa ( nic->mac_address ) ); - nic->pci_bus_dev_func = cpu_to_le16 ( netdev->dev->desc.location ); - DBG ( "iBFT NIC PCI = %04x\n", le16_to_cpu ( nic->pci_bus_dev_func ) ); - - return 0; -} - -/** - * Fill in Initiator portion of iBFT - * - * @v initiator Initiator portion of iBFT - * @v strings iBFT string block descriptor - * @v iscsi iSCSI session - * @ret rc Return status code - */ -static int ibft_fill_initiator ( struct ibft_initiator *initiator, - struct ibft_strings *strings, - struct iscsi_session *iscsi ) { - int rc; - - /* Fill in common header */ - initiator->header.structure_id = IBFT_STRUCTURE_ID_INITIATOR; - initiator->header.version = 1; - initiator->header.length = cpu_to_le16 ( sizeof ( *initiator ) ); - initiator->header.flags = ( IBFT_FL_INITIATOR_BLOCK_VALID | - IBFT_FL_INITIATOR_FIRMWARE_BOOT_SELECTED ); - - /* Fill in hostname */ - if ( ( rc = ibft_set_string ( strings, &initiator->initiator_name, - iscsi->initiator_iqn ) ) != 0 ) - return rc; - DBG ( "iBFT initiator hostname = %s\n", - ibft_string ( strings, &initiator->initiator_name ) ); - - return 0; -} - -/** - * Fill in Target CHAP portion of iBFT - * - * @v target Target portion of iBFT - * @v strings iBFT string block descriptor - * @v iscsi iSCSI session - * @ret rc Return status code - */ -static int ibft_fill_target_chap ( struct ibft_target *target, - struct ibft_strings *strings, - struct iscsi_session *iscsi ) { - int rc; - - if ( ! ( iscsi->status & ISCSI_STATUS_AUTH_FORWARD_REQUIRED ) ) - return 0; - - assert ( iscsi->initiator_username ); - assert ( iscsi->initiator_password ); - - target->chap_type = IBFT_CHAP_ONE_WAY; - if ( ( rc = ibft_set_string ( strings, &target->chap_name, - iscsi->initiator_username ) ) != 0 ) - return rc; - DBG ( "iBFT target username = %s\n", - ibft_string ( strings, &target->chap_name ) ); - if ( ( rc = ibft_set_string ( strings, &target->chap_secret, - iscsi->initiator_password ) ) != 0 ) - return rc; - DBG ( "iBFT target password = <redacted>\n" ); - - return 0; -} - -/** - * Fill in Target Reverse CHAP portion of iBFT - * - * @v target Target portion of iBFT - * @v strings iBFT string block descriptor - * @v iscsi iSCSI session - * @ret rc Return status code - */ -static int ibft_fill_target_reverse_chap ( struct ibft_target *target, - struct ibft_strings *strings, - struct iscsi_session *iscsi ) { - int rc; - - if ( ! ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_REQUIRED ) ) - return 0; - - assert ( iscsi->initiator_username ); - assert ( iscsi->initiator_password ); - assert ( iscsi->target_username ); - assert ( iscsi->target_password ); - - target->chap_type = IBFT_CHAP_MUTUAL; - if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_name, - iscsi->target_username ) ) != 0 ) - return rc; - DBG ( "iBFT target reverse username = %s\n", - ibft_string ( strings, &target->chap_name ) ); - if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_secret, - iscsi->target_password ) ) != 0 ) - return rc; - DBG ( "iBFT target reverse password = <redacted>\n" ); - - return 0; -} - -/** - * Fill in Target portion of iBFT - * - * @v target Target portion of iBFT - * @v strings iBFT string block descriptor - * @v iscsi iSCSI session - * @ret rc Return status code - */ -static int ibft_fill_target ( struct ibft_target *target, - struct ibft_strings *strings, - struct iscsi_session *iscsi ) { - struct sockaddr_in *sin_target = - ( struct sockaddr_in * ) &iscsi->target_sockaddr; - int rc; - - /* Fill in common header */ - target->header.structure_id = IBFT_STRUCTURE_ID_TARGET; - target->header.version = 1; - target->header.length = cpu_to_le16 ( sizeof ( *target ) ); - target->header.flags = ( IBFT_FL_TARGET_BLOCK_VALID | - IBFT_FL_TARGET_FIRMWARE_BOOT_SELECTED ); - - /* Fill in Target values */ - ibft_set_ipaddr ( &target->ip_address, sin_target->sin_addr ); - DBG ( "iBFT target IP = %s\n", ibft_ipaddr ( &target->ip_address ) ); - target->socket = cpu_to_le16 ( ntohs ( sin_target->sin_port ) ); - DBG ( "iBFT target port = %d\n", target->socket ); - memcpy ( &target->boot_lun, &iscsi->lun, sizeof ( target->boot_lun ) ); - DBG ( "iBFT target boot LUN = " SCSI_LUN_FORMAT "\n", - SCSI_LUN_DATA ( target->boot_lun ) ); - if ( ( rc = ibft_set_string ( strings, &target->target_name, - iscsi->target_iqn ) ) != 0 ) - return rc; - DBG ( "iBFT target name = %s\n", - ibft_string ( strings, &target->target_name ) ); - if ( ( rc = ibft_fill_target_chap ( target, strings, iscsi ) ) != 0 ) - return rc; - if ( ( rc = ibft_fill_target_reverse_chap ( target, strings, - iscsi ) ) != 0 ) - return rc; - - return 0; -} - -/** - * Fill in iBFT - * - * @v iscsi iSCSI session - * @v acpi ACPI table - * @v len Length of ACPI table - * @ret rc Return status code - */ -int ibft_describe ( struct iscsi_session *iscsi, - struct acpi_description_header *acpi, - size_t len ) { - struct ipxe_ibft *ibft = - container_of ( acpi, struct ipxe_ibft, table.acpi ); - struct ibft_strings strings = { - .table = &ibft->table, - .offset = offsetof ( typeof ( *ibft ), strings ), - .len = len, - }; - struct net_device *netdev; - int rc; - - /* Ugly hack. Now that we have a generic interface mechanism - * that can support ioctls, we can potentially eliminate this. - */ - netdev = last_opened_netdev(); - if ( ! netdev ) { - DBGC ( iscsi, "iSCSI %p cannot guess network device\n", - iscsi ); - return -ENODEV; - } - - /* Fill in ACPI header */ - ibft->table.acpi.signature = cpu_to_le32 ( IBFT_SIG ); - ibft->table.acpi.length = cpu_to_le32 ( len ); - ibft->table.acpi.revision = 1; - - /* Fill in Control block */ - ibft->table.control.header.structure_id = IBFT_STRUCTURE_ID_CONTROL; - ibft->table.control.header.version = 1; - ibft->table.control.header.length = - cpu_to_le16 ( sizeof ( ibft->table.control ) ); - ibft->table.control.initiator = - cpu_to_le16 ( offsetof ( typeof ( *ibft ), initiator ) ); - ibft->table.control.nic_0 = - cpu_to_le16 ( offsetof ( typeof ( *ibft ), nic ) ); - ibft->table.control.target_0 = - cpu_to_le16 ( offsetof ( typeof ( *ibft ), target ) ); - - /* Fill in NIC, Initiator and Target blocks */ - if ( ( rc = ibft_fill_nic ( &ibft->nic, &strings, netdev ) ) != 0 ) - return rc; - if ( ( rc = ibft_fill_initiator ( &ibft->initiator, &strings, - iscsi ) ) != 0 ) - return rc; - if ( ( rc = ibft_fill_target ( &ibft->target, &strings, - iscsi ) ) != 0 ) - return rc; - - return 0; -} |