/* $NoKeywords:$ */
/**
 * @file
 *
 * F1 table initialization
 *
 *
 *
 * @xrefitem bom "File Content Label" "Release Content"
 * @e project:     AGESA
 * @e sub-project: GNB
 * @e \$Revision: 84150 $   @e \$Date: 2012-12-12 15:46:25 -0600 (Wed, 12 Dec 2012) $
 *
 */
/*
*****************************************************************************
*
 * Copyright (c) 2008 - 2013, Advanced Micro Devices, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
 *       its contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ***************************************************************************
*
*/
#ifndef _GNBF1TABLEKB_H_
#define _GNBF1TABLEKB_H_

#pragma pack (push, 1)

/// F1 field entry
typedef struct {
  UINT8                    FieldOffset;              ///< Field offset in f1 register
  UINT8                    FieldWidth;               ///< Width of field
  UINT16                   F1Offset;               ///< destination offset in translation table
} F1_REGISTER_ENTRY_KB;

/// F1 register entry
typedef struct {
  UINT8                    RegisterSpaceType;        ///< Register type
  UINT32                   Register;                 ///< FCR register address
  UINT8                    F1RegisterTableLength;  ///< Length of field table for this register
  F1_REGISTER_ENTRY_KB   *F1RegisterTable;       ///< Pointer to field table
} F1_TABLE_ENTRY_KB;

/// F1 translation table
typedef struct {
  UINT8                    F1TableLength;          ///< Length of translation table
  F1_TABLE_ENTRY_KB      *F1Table;               ///< Pointer to register table
} F1_TABLE_KB;

#pragma pack (pop)

AGESA_STATUS
GnbLoadF1TableKB (
  IN      AMD_CONFIG_PARAMS   *StdHeader
  );

#endif