a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Copyright (C) 2010 Michael Brown <mbrown@fensystems.co.uk>.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is free software; you can redistribute it and/or
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * modify it under the terms of the GNU General Public License as
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * published by the Free Software Foundation; either version 2 of the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * License, or any later version.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is distributed in the hope that it will be useful, but
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * WITHOUT ANY WARRANTY; without even the implied warranty of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * General Public License for more details.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * You should have received a copy of the GNU General Public License
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * along with this program; if not, write to the Free Software
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * PCI Vital Product Data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Initialise PCI Vital Product Data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v pci PCI device
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint pci_vpd_init ( struct pci_vpd *vpd, struct pci_device *pci ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Initialise structure */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Locate VPD capability */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync vpd->cap = pci_find_capability ( pci, PCI_CAP_ID_VPD );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Read one dword of PCI Vital Product Data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v address Address to read
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret data Read data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int pci_vpd_read_dword ( struct pci_vpd *vpd, int address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Fail if no VPD present */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Return cached value, if present */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Initiate read */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_write_config_word ( pci, ( cap + PCI_VPD_ADDRESS ), address );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait for read to complete */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( retries = 0 ; retries < PCI_VPD_MAX_WAIT_MS ; retries++ ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check if data is ready */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_read_config_word ( pci, ( cap + PCI_VPD_ADDRESS ), &flag );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_read_config_dword ( pci, ( cap + PCI_VPD_DATA ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Populate cache */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait 1ms before retrying */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD %04x read via %02x timed out\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Write one dword of PCI Vital Product Data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v address Address to write
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Data to write
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int pci_vpd_write_dword ( struct pci_vpd *vpd, int address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Fail if no VPD present */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Invalidate cache */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Write data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_write_config_dword ( pci, ( cap + PCI_VPD_DATA ), data );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Initiate write */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_write_config_word ( pci, ( cap + PCI_VPD_ADDRESS ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait for write to complete */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( retries = 0 ; retries < PCI_VPD_MAX_WAIT_MS ; retries++ ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check if write has completed */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pci_read_config_word ( pci, ( cap + PCI_VPD_ADDRESS ), &flag );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait 1ms before retrying */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD %04x write via %02x timed out\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Read PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v address Starting address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v buf Data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint pci_vpd_read ( struct pci_vpd *vpd, unsigned int address, void *buf,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int i;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Calculate length to skip at start of data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read data, a dword at a time */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read whole dword */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_read_dword ( vpd, address, &data ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Copy data to buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( i = 4 ; i ; i-- ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync } else if ( len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Write PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v address Starting address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v buf Data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint pci_vpd_write ( struct pci_vpd *vpd, unsigned int address, const void *buf,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int i;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Calculate length to skip at start of data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Write data, a dword at a time */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read existing dword, if necessary */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync &data ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Copy data from buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( i = 4 ; i ; i-- ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync } else if ( len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Write whole dword */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_write_dword ( vpd, address, data ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Dump PCI VPD region (for debugging)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v address Starting address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void pci_vpd_dump ( struct pci_vpd *vpd, unsigned int address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Do nothing in non-debug builds */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( buf ) ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Locate PCI VPD tag
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v tag ISAPnP tag
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret address Address of tag body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret len Length of tag body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int pci_vpd_find_tag ( struct pci_vpd *vpd, unsigned int tag,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Scan through tags looking for a match */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read tag byte */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_read ( vpd, (*address)++, &read_tag,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( read_tag ) ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Extract tag and length */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_read ( vpd, *address, &read_len,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( read_len ) ) ) != 0)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for tag match */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Move to next tag */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Locate PCI VPD field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v field VPD field descriptor
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret address Address of field body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret len Length of field body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint pci_vpd_find ( struct pci_vpd *vpd, unsigned int field,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Locate containing tag */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_find_tag ( vpd, PCI_VPD_TAG ( field ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Return immediately if we are searching for a whole-tag field */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Scan through fields looking for a match */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Read field header */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_read ( vpd, *address, &read_field,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( read_field ) ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for keyword match */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( read_field.keyword == PCI_VPD_KEYWORD ( field ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Move to next field */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT " not found\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync PCI_ARGS ( vpd->pci ), PCI_VPD_FIELD_ARGS ( field ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Resize VPD field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v vpd PCI VPD
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v field VPD field descriptor
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len New length of field body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret address Address of field body
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint pci_vpd_resize ( struct pci_vpd *vpd, unsigned int field, size_t len,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int *address ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Sanity checks */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( PCI_VPD_TAG ( field ) == PCI_VPD_TAG_RW );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Locate 'RW' field */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_find ( vpd, PCI_VPD_FIELD_RW, &rw_address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Locate old field, if any */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_find ( vpd, field, &old_address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync &old_len ) ) == 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Field already exists */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync " at [%04x,%04zx) is after field "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync dst_address = ( old_address - sizeof ( old_field ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync copy_len = ( rw_address - sizeof ( rw_field ) - copy_address );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Calculate available length */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Field does not yet exist */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync dst_address = ( rw_address - sizeof ( rw_field ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Calculate available length */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync available_len = ( ( rw_len > sizeof ( new_field ) ) ?
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Dump region before changes */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD before resizing field " PCI_VPD_FIELD_FMT
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check available length */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync PCI_ARGS ( vpd->pci ), PCI_VPD_FIELD_ARGS ( field ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Preserve intermediate fields, if any */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_read ( vpd, copy_address, copy, copy_len ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Create new field, if applicable */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_write ( vpd, dst_address, &new_field,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( new_field ) ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT " is now "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Restore intermediate fields, if any */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_write ( vpd, dst_address, copy, copy_len ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Create 'RW' field */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync rw_field.keyword = PCI_VPD_KEYWORD ( PCI_VPD_FIELD_RW );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( rw_address - sizeof ( rw_field ) ) - dst_address );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = pci_vpd_write ( vpd, dst_address, &rw_field,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync sizeof ( rw_field ) ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD field " PCI_VPD_FIELD_FMT " is now "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync PCI_VPD_FIELD_ARGS ( PCI_VPD_FIELD_RW ), dst_address,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Dump region after changes */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( vpd, PCI_FMT " VPD after resizing field " PCI_VPD_FIELD_FMT