diff options
Diffstat (limited to 'src/include/usr/targeting/attrsync.H')
| -rw-r--r-- | src/include/usr/targeting/attrsync.H | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/src/include/usr/targeting/attrsync.H b/src/include/usr/targeting/attrsync.H new file mode 100644 index 000000000..274674382 --- /dev/null +++ b/src/include/usr/targeting/attrsync.H @@ -0,0 +1,209 @@ +/* IBM_PROLOG_BEGIN_TAG + * This is an automatically generated prolog. + * + * $Source: src/include/usr/targeting/attrsync.H $ + * + * IBM CONFIDENTIAL + * + * COPYRIGHT International Business Machines Corp. 2012 + * + * p1 + * + * Object Code Only (OCO) source materials + * Licensed Internal Code Source Materials + * IBM HostBoot Licensed Internal Code + * + * The source code for this program is not published or other- + * wise divested of its trade secrets, irrespective of what has + * been deposited with the U.S. Copyright Office. + * + * Origin: 30 + * + * IBM_PROLOG_END_TAG + */ +#ifndef __ATTRSYNC_H_ +#define __ATTRSYNC_H_ +/** + * @file targeting/attsync.H + * + * @brief Interface to support syncing the targeting attributes between the + * FSP and Hostboot. Sync operations can be either direction, HB->FSP + * or FSP->HB however for sprint 7.12 only HB->FSP support will be + * added. + */ +//****************************************************************************** +// Includes +//****************************************************************************** +#include <mbox/mbox_queues.H> +#include <mbox/mboxif.H> +#include <errl/errlentry.H> +#include <sys/msg.h> +#include <pnortargeting.H> +#include <stddef.h> +#include <targeting/common/targetservice.H> +#include <targeting/common/attrsyncdefs.H> + + +namespace TARGETING +{ + + /** + * @class AttributeSync + * + * @brief Targeting attribute sync class + * + * @par Detailed Description: + * Provides all the functionality to synchronize the targetting + * attributes from the Hostboot area down to the FSP + */ + class AttributeSync + { + + public: + + /** + * @brief Initialize the attribute synchronization object + * + * @par Detailed Description + * Ensures member variables are initialized to sane values. + */ + AttributeSync(); + + /** + * @brief Destroy the attribute sync object resources + * + * @par Detailed Description: + * Frees any memory allocated by the attribute sync object + * + */ + ~AttributeSync(); + + /** + * @brief Setup the internal variables to point to the correct + * attribute section. + * + * @par Detailed Description: + * This funciton will call into the AttRP:: to have the + * correct attribute section paged into accessable memory. + * this function may be called multiple times with different + * section names. + * + * @pre None: + * + * @post The entire section from the HB attribute section + * passed in has been synchronized to the FSP memory area. + * + * @param[in] i_section_to_sync + * TARGETING::SECTION_TYPE is passed in to + * identify the section to be synced to the + * FSP. + * + * @return errlHndl_t + * return errl == NULL -> success + * return errl != NULL -> failure + * + */ + errlHndl_t syncSectionToFsp( + TARGETING::SECTION_TYPE i_section_to_sync ); + + private: + + /** + * @enum TARGETING::MBOX_MSG_TYPE + * + * @brief Message enum to determine if msg should be sent + * asynchronously or if the call should be synchronous + * + */ + enum MBOX_MSG_TYPE + { + ASYNCHRONOUS, + SYNCHRONOUS + }; + + /** + * @brief Setup the internal variables to point to the correct + * attribute section. + * + * @par Detailed Description: + * This funciton will call into the AttRP:: to have the + * correct attribute section paged into accessable memory + * + */ + void getSectionData(); + + /** + * @brief Uses the internal mailbox to send a message to the FSP + * + * + * @par Detailed Description: + * This funciton will call into mailboxsp code using the + * FSP_ATTR_SYNC_MSGQ as a target message queue.. + * + * @param[in] i_type + * TARGETING::MBOX_MSG_TYPE passed in to define the + * message sending policy. + * + * @param[in/out] i_msg + * This parameter is used as both input and an + * output parameter. If the message is sent + * synchronusly the response will be populated + * in an object pointed to by this pointer. If + * the message is asynchronus the object + * pointed to by this paramter will be sent to + * the fsp. + * + * @return errlHndl_t + * return errl == NULL -> success + * return errl != NULL -> failure + */ + errlHndl_t sendMboxMessage( MBOX_MSG_TYPE i_type, msg_t * i_msg ); + + /** + * @brief Sends the sync complete message to the FSP indicating + * the operation has completed. + * + * @return errlHndl_t + * return errl == NULL -> success + * return errl != NULL -> failure + */ + errlHndl_t sendSyncCompleteMessage(); + + private: + + // id of the section being updated + TARGETING::SECTION_TYPE iv_section_to_sync; + + + // count of total pages, calculated from data supplied by the + // attribute resource provider code; + uint16_t iv_total_pages; + + // maintiains the current page number being sync'ed. + uint16_t iv_current_page; + + // vector of structures to hold the location info for each section + // we would like to sync. Data is filled in by the attrrp code + // when we call AttRP::readSectionData(... + std::vector <TARGETING::sectionRefData>iv_pages; + + }; + + /** + * @brief Handles synchronization of all RW targeting attributes from + * hostboot to the fsp; the following section are are + * synchronized. + * + * 1). SECTION_TYPE_PNOR_RW + * 2). SECTION_TYPE_HEAP_PNOR_INIT + * 3). SECTION_TYPE_HEAP_PNOR_ZERO_INIT + * + * + * @return errlHndl_t + * return errl == NULL -> success + * return errl != NULL -> failure + */ + errlHndl_t syncAllAttributesToFsp(); + +} // namespace +#endif |
