diff options
Diffstat (limited to 'src/usr/diag/prdf/common/framework/register')
8 files changed, 55 insertions, 39 deletions
diff --git a/src/usr/diag/prdf/common/framework/register/iipCaptureData.h b/src/usr/diag/prdf/common/framework/register/iipCaptureData.h index 76bcb1f48..4395ce38b 100755 --- a/src/usr/diag/prdf/common/framework/register/iipCaptureData.h +++ b/src/usr/diag/prdf/common/framework/register/iipCaptureData.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 1996,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -170,7 +172,7 @@ public: /** Clear out capture data <ul> - <br><b>Paramters:None + <br><b>Parameters:None <br><b>Returns:Nothing <br><b>Requirments:None. <br><b>Promises: All capture data cleared ( copy(...) == 0 ) @@ -182,10 +184,10 @@ public: /** Add scr & data to capture log <ul> - <br><b>Paramter: chipHandle target handle of chip object - <br><b>Paramter: scan comm id (unique one btye code representing scan comm address) - <br><b>Paramter: Scan comm register object - <br><b>Paramter: Optional location in capure vector [FRONT | BACK] def = BACK + <br><b>Parameter: chipHandle target handle of chip object + <br><b>Parameter: scan comm id (unique one btye code representing scan comm address) + <br><b>Parameter: Scan comm register object + <br><b>Parameter: Optional location in capure vector [FRONT | BACK] def = BACK <br><b>Returns: Nothing <br><b>Requires: Nothing <br><b>Promises: scr.Read() @@ -200,9 +202,9 @@ public: /* REMOVE for FSP Add scr & data to capture log <ul> - <br><b>Paramter: chipHandle target handle of chip object - <br><b>Paramter: Scan comm register object - <br><b>Paramter: Optional location in capure vector [FRONT | BACK] def = BACK + <br><b>Parameter: chipHandle target handle of chip object + <br><b>Parameter: Scan comm register object + <br><b>Parameter: Optional location in capure vector [FRONT | BACK] def = BACK <br><b>Returns: Nothing <br><b>Requires: Nothing <br><b>Promises: scr.Read() @@ -217,10 +219,10 @@ public: /** Add scr & data to capture log <ul> - <br><b>Paramter: i_pchipHandle Handle of chip object - <br><b>Paramter: scan comm id (unique one btye code representing scan comm address) - <br><b>Paramter: BIT_STRING_CLASS - <br><b>Paramter: Optional location in capure vector [FRONT | BACK] def = BACK + <br><b>Parameter: i_pchipHandle Handle of chip object + <br><b>Parameter: scan comm id (unique one btye code representing scan comm address) + <br><b>Parameter: BIT_STRING_CLASS + <br><b>Parameter: Optional location in capure vector [FRONT | BACK] def = BACK <br><b>Returns: Nothing <br><b>Requires: Nothing <br><b>Promises: @@ -236,7 +238,7 @@ public: /** Drop scr & data from capture log <ul> - <br><b>Paramter: Type of capture vector [PRIMARY | SECONDARY] def = PRIMARY. SECONDARIES dropped on connected. + <br><b>Parameter: Type of capture vector [PRIMARY | SECONDARY] def = PRIMARY. SECONDARIES dropped on connected. <br><b>Returns: Nothing <br><b>Requires: Nothing <br><b>Promises: @@ -248,8 +250,8 @@ void Drop(RegType type); //@jl04a /** Copy caputre data to buffer <ul> - <br><b>Paramter: ptr to buffer to place capture data - <br><b>Paramter: maxsize of buffer area + <br><b>Parameter: ptr to buffer to place capture data + <br><b>Parameter: maxsize of buffer area <br><b>Returns: Returns the number of bytes copied <br><b>Requirements: None <br><b>Promises: bytes copied <= bufferSize @@ -263,7 +265,7 @@ void Drop(RegType type); //@jl04a /** Reconstruct data from flat data <ul> - <br><b>Paramter: i_flatdata ptr to flat data + <br><b>Parameter: i_flatdata ptr to flat data <br><b>Returns: reference to the new capture data <br><b>Requirements: None <br><b>Promises: CaptureData created form flatdata @@ -278,7 +280,7 @@ private: // Notes ************************************************************* // - // Instead of maintaining an actual data buffer, an auxilliary data + // Instead of maintaining an actual data buffer, an auxiliary data // structure is used to maintain data in a specific order. The main // reason for this is that since data can be entered in the front or // back of the buffer, the data must be copied to maintain the order. diff --git a/src/usr/diag/prdf/common/framework/register/iipErrorRegisterMask.h b/src/usr/diag/prdf/common/framework/register/iipErrorRegisterMask.h index d10f83eaf..bf435153f 100755 --- a/src/usr/diag/prdf/common/framework/register/iipErrorRegisterMask.h +++ b/src/usr/diag/prdf/common/framework/register/iipErrorRegisterMask.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 1996,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -178,7 +180,7 @@ protected: /** - Reset the error register and set mask bit if sdc is at theshold + Reset the error register and set mask bit if sdc is at threshold <ul> <br><b>Parameters: </b> BitList <br><b>Returns: </b> return code diff --git a/src/usr/diag/prdf/common/framework/register/iipResetErrorRegister.h b/src/usr/diag/prdf/common/framework/register/iipResetErrorRegister.h index 18c16a32a..8699e298c 100755 --- a/src/usr/diag/prdf/common/framework/register/iipResetErrorRegister.h +++ b/src/usr/diag/prdf/common/framework/register/iipResetErrorRegister.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 1996,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -145,7 +147,7 @@ public: protected: // functions /** - Reset the error register and set mask bit if sdc is at theshold + Reset the error register and set mask bit if sdc is at threshold <ul> <br><b>Parameters: </b> BitList <br><b>Returns: </b> return code diff --git a/src/usr/diag/prdf/common/framework/register/iipXorResetErrorRegister.h b/src/usr/diag/prdf/common/framework/register/iipXorResetErrorRegister.h index a47e75261..8a0b37b91 100755 --- a/src/usr/diag/prdf/common/framework/register/iipXorResetErrorRegister.h +++ b/src/usr/diag/prdf/common/framework/register/iipXorResetErrorRegister.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 1997,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -107,7 +109,7 @@ protected: // functions // Requirements: None. // Promises: Hardware Registers modified // Bits in bit_list are turned off in SCR then SCR::Write() - // Mask bits set if theshold was reached (see parent class) + // Mask bits set if threshold was reached (see parent class) // Exceptions: None. // Concurrency: // Notes: bit_list.GetListLength() may be zero diff --git a/src/usr/diag/prdf/common/framework/register/iipscr.h b/src/usr/diag/prdf/common/framework/register/iipscr.h index 51a55e639..a51920aca 100755 --- a/src/usr/diag/prdf/common/framework/register/iipscr.h +++ b/src/usr/diag/prdf/common/framework/register/iipscr.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 1997,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -98,7 +100,7 @@ namespace PRDF // bits are used as the value to write. The current value of this // cached bit string can be accessed or modified by other objects via // the public interface. The physical address and bit length of the -// hardware register are set during intialization and used on all +// hardware register are set during initialization and used on all // acceses. // // The basic Read() and Write() functions are virtual. The @@ -154,11 +156,12 @@ class SCAN_COMM_REGISTER_CLASS <br><b>Requirements:</b> None. <br><b>Promises: </b> Internal bit string represents the value of the hardware register (if rc == SUCCESS) - <br><b>Sideaffects: </b> Value guarenteed to be read from hardware. + <br><b>Sideaffects: </b> Value guaranteed to be read from hardware. <br><b>Exceptions: </b> None. <br><b>Notes: </b> Default is to call Read(). If a child class cannot - guarantee hardware access everytime Read() is called - then the function ForceRead() should be overridden. + guarantee hardware access every time Read() is + called then the function ForceRead() should be + overridden. </ul><br> */ virtual uint32_t ForceRead(void) const { return Read(); } @@ -392,7 +395,7 @@ protected: /** Get modifiable reference to internal bit string (don't even thing about making this public!!!) <ul> - <br><b>Paramters: </b> None. + <br><b>Parameters: </b> None. <br><b>Returns </b> Reference to the internal bit string <br><b>Requirments </b> None. <br><b>Promises </b> None. diff --git a/src/usr/diag/prdf/common/framework/register/prdfHomRegisterAccess.C b/src/usr/diag/prdf/common/framework/register/prdfHomRegisterAccess.C index 403be1e48..7fa98bb29 100755 --- a/src/usr/diag/prdf/common/framework/register/prdfHomRegisterAccess.C +++ b/src/usr/diag/prdf/common/framework/register/prdfHomRegisterAccess.C @@ -5,7 +5,7 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* Contributors Listed Below - COPYRIGHT 2012,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ /* [+] International Business Machines Corp. */ /* */ /* */ @@ -229,7 +229,7 @@ errlHndl_t ScomAccessor::Access(TargetHandle_t i_target, if( NULL != errH ) break; // If register is in a EX chiplet, need to update PORE image. - // The PORE update is necessary to avoid loosing the FIR MASK + // The PORE update is necessary to avoid losing the FIR MASK // after the Core exits the sleep-winkle state. if( TYPE_EX == PlatServices::getTargetType(i_target) ) { diff --git a/src/usr/diag/prdf/common/framework/register/prdfScanFacility.H b/src/usr/diag/prdf/common/framework/register/prdfScanFacility.H index a0e407c73..b7589fa5d 100755 --- a/src/usr/diag/prdf/common/framework/register/prdfScanFacility.H +++ b/src/usr/diag/prdf/common/framework/register/prdfScanFacility.H @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 2002,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -116,7 +118,8 @@ public: * @brief Get a register that bitwise inverts the bitstring of a register * when read or written to * @param SCAN_COMM_REGISTER_CLASS source - * @post Only one instance of the register with this SCR paramter will exist + * @post Only one instance of the register with this SCR parameter will + * exist */ SCAN_COMM_REGISTER_CLASS & GetNotRegister(SCAN_COMM_REGISTER_CLASS & i_arg); @@ -124,8 +127,8 @@ public: * @brief Get a register that bitwise left shift the bitstring of a register * when read or written to * @param SCAN_COMM_REGISTER_CLASS source - * @post Only one instance of the register with this SCR paramter and amount - @ will exist + * @post Only one instance of the register with this SCR parameter and + * amount will exist */ SCAN_COMM_REGISTER_CLASS & GetLeftShiftRegister( SCAN_COMM_REGISTER_CLASS & i_arg, uint16_t i_amount); @@ -134,7 +137,7 @@ public: * @brief Get a register that bitwise right shift the bitstring of a register * when read or written to * @param SCAN_COMM_REGISTER_CLASS source - * @post Only one instance of the register with this SCR paramter and amount + * @post Only one instance of the register with this SCR parameter and amount * @ will exist */ SCAN_COMM_REGISTER_CLASS & GetRightShiftRegister( diff --git a/src/usr/diag/prdf/common/framework/register/xspprdAndResetErrorRegister.h b/src/usr/diag/prdf/common/framework/register/xspprdAndResetErrorRegister.h index 1bf985420..ce8869da9 100755 --- a/src/usr/diag/prdf/common/framework/register/xspprdAndResetErrorRegister.h +++ b/src/usr/diag/prdf/common/framework/register/xspprdAndResetErrorRegister.h @@ -5,7 +5,9 @@ /* */ /* OpenPOWER HostBoot Project */ /* */ -/* COPYRIGHT International Business Machines Corp. 2001,2014 */ +/* Contributors Listed Below - COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ +/* */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ @@ -37,7 +39,7 @@ // Description: Resets the bit(s) in an error register that were used to // Analyze an error. Intended to be used with hardware // registers that support SCOM AND-Write to reset bits. -// This has an advantage in that register is only writen +// This has an advantage in that register is only written // to reset the bits as opposted to a read-modify-write. // // Usage: See iipResetErrorRegister.h |
