diff options
Diffstat (limited to 'src/import/hwpf/fapi2')
| -rw-r--r-- | src/import/hwpf/fapi2/include/array.H | 104 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/buffer.H | 32 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/buffer_traits.H | 8 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/error_info.H | 925 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/error_info_defs.H | 2 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/fapi2_attribute_service.H | 4 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/fapi2_chip_ec_feature.H | 2 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/fapi2_error_scope.H | 8 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/fapi2_hw_access.H | 30 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/fapi2_target.H | 20 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/utils.H | 4 | ||||
| -rw-r--r-- | src/import/hwpf/fapi2/include/variable_buffer.H | 14 |
12 files changed, 583 insertions, 570 deletions
diff --git a/src/import/hwpf/fapi2/include/array.H b/src/import/hwpf/fapi2/include/array.H index 1b976f2b8..e7bb8d95a 100644 --- a/src/import/hwpf/fapi2/include/array.H +++ b/src/import/hwpf/fapi2/include/array.H @@ -1,25 +1,19 @@ /* IBM_PROLOG_BEGIN_TAG */ /* This is an automatically generated prolog. */ /* */ -/* $Source: $ */ +/* $Source: hwpf/fapi2/include/array.H $ */ /* */ -/* OpenPOWER HostBoot Project */ -/* */ -/* Contributors Listed Below - COPYRIGHT 2012,2014 */ -/* [+] International Business Machines Corp. */ +/* IBM CONFIDENTIAL */ /* */ +/* EKB Project */ /* */ -/* Licensed under the Apache License, Version 2.0 (the "License"); */ -/* you may not use this file except in compliance with the License. */ -/* You may obtain a copy of the License at */ +/* COPYRIGHT 2012,2015 */ +/* [+] International Business Machines Corp. */ /* */ -/* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ -/* Unless required by applicable law or agreed to in writing, software */ -/* distributed under the License is distributed on an "AS IS" BASIS, */ -/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */ -/* implied. See the License for the specific language governing */ -/* permissions and limitations under the License. */ +/* The source code for this program is not published or otherwise */ +/* divested of its trade secrets, irrespective of what has been */ +/* deposited with the U.S. Copyright Office. */ /* */ /* IBM_PROLOG_END_TAG */ /** @@ -37,28 +31,28 @@ namespace fapi2 { - /// - /// @brief Class representing a FAPI2 array - /// FAPI2 arrays are defined to be very lightweight but support - /// c++ container operations (iterators, bounds checking, assignment, etc.) - /// To avoid the code-bloat associated with std::vector templates, - /// fapi2::array is presently limited to 64-bit elements. - /// - /// To construct an array, you can either pass in an existing chunk - /// of memory, or let the container allocate memory for you: - /// fapi2::array foo(3, &PIB_MEM_BLOCK); - /// creates an array 3 x uit64_t in size, located at &PIB_MEM_BLOCK. - /// The memory pointed to by the address passed in is untouched - /// during creation. This allows for a light-weight overlay on top - /// of existing memory. It also means you need to initialize the space - /// yourself. - /// fapi2_array foo(3); - /// creates an array 3 x uint64_t in size, and that memory will be - /// allocated by the constructor and initiaized to 0's. - /// - /// - class array - { +/// +/// @brief Class representing a FAPI2 array +/// FAPI2 arrays are defined to be very lightweight but support +/// c++ container operations (iterators, bounds checking, assignment, etc.) +/// To avoid the code-bloat associated with std::vector templates, +/// fapi2::array is presently limited to 64-bit elements. +/// +/// To construct an array, you can either pass in an existing chunk +/// of memory, or let the container allocate memory for you: +/// fapi2::array foo(3, &PIB_MEM_BLOCK); +/// creates an array 3 x uit64_t in size, located at &PIB_MEM_BLOCK. +/// The memory pointed to by the address passed in is untouched +/// during creation. This allows for a light-weight overlay on top +/// of existing memory. It also means you need to initialize the space +/// yourself. +/// fapi2_array foo(3); +/// creates an array 3 x uint64_t in size, and that memory will be +/// allocated by the constructor and initiaized to 0's. +/// +/// +class array +{ public: typedef uint64_t element_type; @@ -67,8 +61,8 @@ namespace fapi2 /// /// @brief Create an array - /// @param[in] the size of the array - /// @param[in] a pointer to memory of appropriate size + /// @param[in] i_size the size of the array + /// @param[in] i_data a pointer to memory of appropriate size /// defaults to nullptr which causes the platform to /// allocate memory of size * element_type /// @warning fapi2::arrays, like arrays, can not be re-sized after @@ -83,7 +77,7 @@ namespace fapi2 /// /// @brief operator[] - /// @param[in] the index of the element + /// @param[in] i_index the index of the element /// @return a reference to the element in question. /// @note array[0] = 0 works as well as foo = array[0] /// @@ -91,7 +85,7 @@ namespace fapi2 /// /// @brief operator=() - /// @param[in] the other array + /// @param[in] i_other the other array /// @return a reference to this, after the assignement /// array& operator=(const array& i_other); @@ -113,7 +107,9 @@ namespace fapi2 /// __attribute__ ((always_inline)) bool operator!=(const array& i_other) - { return ! operator==(i_other); } + { + return ! operator==(i_other); + } /// /// @brief Return an iterator the to beginning of the array @@ -121,7 +117,9 @@ namespace fapi2 /// __attribute__ ((always_inline)) iterator begin(void) - { return iv_data; } + { + return iv_data; + } /// /// @brief Return an iterator the to end of the array @@ -129,7 +127,9 @@ namespace fapi2 /// __attribute__ ((always_inline)) iterator end(void) - { return iv_data + size(); } + { + return iv_data + size(); + } /// /// @brief Return a const_iterator the to beginning of the array @@ -137,7 +137,9 @@ namespace fapi2 /// __attribute__ ((always_inline)) const_iterator begin(void) const - { return iv_data; } + { + return iv_data; + } /// /// @brief Return a const_iterator the to end of the array @@ -145,7 +147,9 @@ namespace fapi2 /// __attribute__ ((always_inline)) const_iterator end(void) const - { return iv_data + size(); } + { + return iv_data + size(); + } private: @@ -160,15 +164,19 @@ namespace fapi2 __attribute__ ((always_inline)) uint32_t size(void) - { return (iv_size & ~delete_bit); } + { + return (iv_size & ~delete_bit); + } __attribute__ ((always_inline)) uint32_t size(void) const - { return (iv_size & ~delete_bit); } + { + return (iv_size & ~delete_bit); + } uint32_t iv_size; element_type* iv_data; - }; +}; } #endif diff --git a/src/import/hwpf/fapi2/include/buffer.H b/src/import/hwpf/fapi2/include/buffer.H index 7e604d208..3701454d5 100644 --- a/src/import/hwpf/fapi2/include/buffer.H +++ b/src/import/hwpf/fapi2/include/buffer.H @@ -500,11 +500,11 @@ class buffer /// /// @brief Copy part of a OT into the DataBuffer /// @tparam OT the type of the incoming (origin) data - /// @param[in] i_datain OT value to copy into DataBuffer - /// - data is taken left aligned - /// @param[in] Start bit to insert into (target start) - /// @param[in] Length of bits to insert - /// @param[in] Start bit in source - defaults to bit 0 + /// @param[in] i_datain OT value to copy into DataBuffer + /// - data is taken left aligned + /// @param[in] i_targetStart bit to insert into (target start) + /// @param[in] i_len Length of bits to insert + /// @param[in] i_sourceStart Start bit in source - defaults to bit 0 /// @return FAPI2_RC_SUCCESS if successful /// @@ -599,10 +599,10 @@ class buffer /// /// @brief Copy in a right aligned value /// @tparam OT the type of the incoming (origin) data - /// @param[in] i_datain OT value to copy into DataBuffer - /// - data is taken right aligned - /// @param[in] Start bit to insert into - /// @param[in] Length of bits to insert + /// @param[in] i_datain OT value to copy into DataBuffer + /// - data is taken right aligned + /// @param[in] i_targetStart Start bit to insert into + /// @param[in] i_len Length of bits to insert /// @return FAPi2_RC_SUCCESS if no error /// @note Data is assumed to be aligned on the word boundary of L /// @@ -677,10 +677,10 @@ class buffer /// /// @brief Copy data from this buffer into an OT /// @tparam OT the type of the outgoing (target) - /// @param[out] o_out OT to copy into - data is placed left aligned - /// @param[in] Start bit in source - /// @param[in] Length of bits to extract - /// @param[in] Start bit to insert into (target start) + /// @param[out] o_out OT to copy into - data is placed left aligned + /// @param[in] i_sourceStart Start bit in source + /// @param[in] i_len Length of bits to extract + /// @param[in] i_targetStart Start bit to insert into (target start) /// @return FAPI2_RC_SUCCESS if ok /// template<typename OT> @@ -734,9 +734,9 @@ class buffer /// /// @brief Copy data from this buffer into an OT and right justify /// @tparam OT the type of the outgoing (target) - /// @param[out] o_out OT to copy into - data is placed right aligned - /// @param[in] Start bit to insert into (source start) - /// @param[in] Length of bits to insert + /// @param[out] o_out OT to copy into - data is placed right aligned + /// @param[in] i_sourceStart Start bit to insert into (source start) + /// @param[in] i_len Length of bits to insert /// @return FAPI2_RC_SUCCESS if ok /// template<typename OT> diff --git a/src/import/hwpf/fapi2/include/buffer_traits.H b/src/import/hwpf/fapi2/include/buffer_traits.H index 3fd78d681..64dbff7ec 100644 --- a/src/import/hwpf/fapi2/include/buffer_traits.H +++ b/src/import/hwpf/fapi2/include/buffer_traits.H @@ -76,7 +76,7 @@ class bufferTraits /// /// @brief Return the size of the buffer in E units /// @tparam E, the element size. - /// @param[in] io_buffer the buffer which to size + /// @param[in] i_buffer the buffer which to size /// @return The size of the buffer in E's rounded up /// template<typename E> @@ -89,7 +89,7 @@ class bufferTraits /// /// @brief Return the size of the buffer itself - /// @param[in] io_buffer the buffer which to size + /// @param[in] i_buffer the buffer which to size /// @return The size of the buffer in bits (not units) /// constexpr static B bit_length(const T&) @@ -191,7 +191,7 @@ class bufferTraits<bits_container, uint32_t> /// /// @brief Return the size of the buffer in E units /// @tparam E, the element size. - /// @param[in] io_buffer the buffer which to size + /// @param[in] i_buffer the buffer which to size /// @return The size of the buffer in E's rounded up /// template<typename E> @@ -204,7 +204,7 @@ class bufferTraits<bits_container, uint32_t> /// /// @brief Return the size of the buffer itself - /// @param[in,out] io_buffer the buffer which to size + /// @param[in] i_buffer the buffer which to size /// @return The size of the buffer in bits (not units) /// static inline uint32_t bit_length(const bits_container& i_buffer) diff --git a/src/import/hwpf/fapi2/include/error_info.H b/src/import/hwpf/fapi2/include/error_info.H index cc555b8c7..eb1d09e0c 100644 --- a/src/import/hwpf/fapi2/include/error_info.H +++ b/src/import/hwpf/fapi2/include/error_info.H @@ -1,25 +1,19 @@ /* IBM_PROLOG_BEGIN_TAG */ /* This is an automatically generated prolog. */ /* */ -/* $Source: $ */ +/* $Source: hwpf/fapi2/include/error_info.H $ */ /* */ -/* OpenPOWER HostBoot Project */ -/* */ -/* Contributors Listed Below - COPYRIGHT 2011,2015 */ -/* [+] International Business Machines Corp. */ +/* IBM CONFIDENTIAL */ /* */ +/* EKB Project */ /* */ -/* Licensed under the Apache License, Version 2.0 (the "License"); */ -/* you may not use this file except in compliance with the License. */ -/* You may obtain a copy of the License at */ +/* COPYRIGHT 2011,2015 */ +/* [+] International Business Machines Corp. */ /* */ -/* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ -/* Unless required by applicable law or agreed to in writing, software */ -/* distributed under the License is distributed on an "AS IS" BASIS, */ -/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */ -/* implied. See the License for the specific language governing */ -/* permissions and limitations under the License. */ +/* The source code for this program is not published or otherwise */ +/* divested of its trade secrets, irrespective of what has been */ +/* deposited with the U.S. Copyright Office. */ /* */ /* IBM_PROLOG_END_TAG */ @@ -39,16 +33,16 @@ namespace fapi2 { - // forward fapi2::Assert() - extern void Assert(bool); +// forward fapi2::Assert() +extern void Assert(bool); - /// - /// @class ErrorInfoFfdc - /// - /// This class contains a copy of some FFDC data - /// - class ErrorInfoFfdc - { +/// +/// @class ErrorInfoFfdc +/// +/// This class contains a copy of some FFDC data +/// +class ErrorInfoFfdc +{ public: /// /// @brief Constructor @@ -69,18 +63,20 @@ namespace fapi2 /// /// @return void *. Pointer to the FFDC /// - inline const void* getData(uint32_t & o_size) const - { - o_size = iv_size; - return iv_pFfdc.get(); - } + inline const void* getData(uint32_t& o_size) const + { + o_size = iv_size; + return iv_pFfdc.get(); + } /// /// @brief Get a pointer to the FfdcData /// @return void *. Pointer to the FFDC /// inline void* getData(void) const - { return iv_pFfdc.get(); } + { + return iv_pFfdc.get(); + } /// /// @brief Get the FFDC Identifier @@ -88,7 +84,9 @@ namespace fapi2 /// @return uint32_t The FFDC Identifier /// inline uint32_t getFfdcId(void) - { return iv_ffdcId; } + { + return iv_ffdcId; + } #ifdef FAPI_CUSTOM_MALLOC /// @@ -120,533 +118,540 @@ namespace fapi2 uint32_t iv_size; // Disabled - ErrorInfoFfdc(const ErrorInfoFfdc &) = delete; - ErrorInfoFfdc & operator=(const ErrorInfoFfdc &) = delete; - }; + ErrorInfoFfdc(const ErrorInfoFfdc&) = delete; + ErrorInfoFfdc& operator=(const ErrorInfoFfdc&) = delete; +}; +/// +/// @struct ErrorInfoHwCallout +/// +/// This struct contains hardware to callout +/// +struct ErrorInfoHwCallout +{ /// - /// @struct ErrorInfoHwCallout + /// @brief Constructor. /// - /// This struct contains hardware to callout + /// @param[in] i_hw Hardware to callout + /// @param[in] i_calloutPriority Priority of callout + /// @param[in] i_refTarget Reference to reference target /// - struct ErrorInfoHwCallout - { - /// - /// @brief Constructor. - /// - /// @param[in] i_hw Hardware to callout - /// @param[in] i_calloutPriority Priority of callout - /// @param[in] i_refTarget Reference to reference target - /// - ErrorInfoHwCallout( - const HwCallouts::HwCallout i_hw, - const CalloutPriorities::CalloutPriority i_calloutPriority, - const Target<TARGET_TYPE_ALL> & i_refTarget); + ErrorInfoHwCallout( + const HwCallouts::HwCallout i_hw, + const CalloutPriorities::CalloutPriority i_calloutPriority, + const Target<TARGET_TYPE_ALL>& i_refTarget); #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // The hw to callout - HwCallouts::HwCallout iv_hw; + // The hw to callout + HwCallouts::HwCallout iv_hw; - // The callout priority - CalloutPriorities::CalloutPriority iv_calloutPriority; + // The callout priority + CalloutPriorities::CalloutPriority iv_calloutPriority; - // The reference target (needed for some HW callouts to identify what to - // callout). The target handle is NULL if there is no reference target. - Target<TARGET_TYPE_ALL> iv_refTarget; - }; + // The reference target (needed for some HW callouts to identify what to + // callout). The target handle is NULL if there is no reference target. + Target<TARGET_TYPE_ALL> iv_refTarget; +}; +/// +/// @struct ErrorInfoProcedureCallout +/// +/// This struct contains a procedure to callout +/// +struct ErrorInfoProcedureCallout +{ /// - /// @struct ErrorInfoProcedureCallout + /// @brief Constructor. /// - /// This struct contains a procedure to callout + /// @param[in] i_procedure Procedure to callout + /// @param[in] i_calloutPriority Priority of callout /// - struct ErrorInfoProcedureCallout - { - /// - /// @brief Constructor. - /// - /// @param[in] i_procedure Procedure to callout - /// @param[in] i_calloutPriority Priority of callout - /// - ErrorInfoProcedureCallout( - const ProcedureCallouts::ProcedureCallout i_procedure, - const CalloutPriorities::CalloutPriority i_calloutPriority); + ErrorInfoProcedureCallout( + const ProcedureCallouts::ProcedureCallout i_procedure, + const CalloutPriorities::CalloutPriority i_calloutPriority); #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // The procedure to callout - ProcedureCallouts::ProcedureCallout iv_procedure; + // The procedure to callout + ProcedureCallouts::ProcedureCallout iv_procedure; - // The callout priority - CalloutPriorities::CalloutPriority iv_calloutPriority; - }; + // The callout priority + CalloutPriorities::CalloutPriority iv_calloutPriority; +}; +/// +/// @struct ErrorInfoBusCallout +/// +/// This struct contains a bus to callout +/// +struct ErrorInfoBusCallout +{ /// - /// @struct ErrorInfoBusCallout + /// @brief Constructor. /// - /// This struct contains a bus to callout + /// @param[in] i_target1 Reference to target on one end of the bus + /// @param[in] i_target2 Reference to target on other end of the bus + /// @param[in] i_calloutPriority Priority of callout /// - struct ErrorInfoBusCallout - { - /// - /// @brief Constructor. - /// - /// @param[in] i_target1 Reference to target on one end of the bus - /// @param[in] i_target2 Reference to target on other end of the bus - /// @param[in] i_calloutPriority Priority of callout - /// - ErrorInfoBusCallout( - const Target<TARGET_TYPE_ALL> & i_target1, - const Target<TARGET_TYPE_ALL> & i_target2, - const CalloutPriorities::CalloutPriority i_calloutPriority); + ErrorInfoBusCallout( + const Target<TARGET_TYPE_ALL>& i_target1, + const Target<TARGET_TYPE_ALL>& i_target2, + const CalloutPriorities::CalloutPriority i_calloutPriority); #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // The targets on each end of the bus to callout - Target<TARGET_TYPE_ALL> iv_target1; - Target<TARGET_TYPE_ALL> iv_target2; + // The targets on each end of the bus to callout + Target<TARGET_TYPE_ALL> iv_target1; + Target<TARGET_TYPE_ALL> iv_target2; - // The callout priority - CalloutPriorities::CalloutPriority iv_calloutPriority; - }; + // The callout priority + CalloutPriorities::CalloutPriority iv_calloutPriority; +}; +/// +/// @struct ErrorInfoCDG +/// +/// This struct contains a target to callout/deconfigure/GARD +/// +struct ErrorInfoCDG +{ /// - /// @struct ErrorInfoCDG + /// @brief Constructor. /// - /// This struct contains a target to callout/deconfigure/GARD + /// @param[in] i_target Reference to the target to c/d/g + /// @param[in] i_callout True if Target should be called out + /// @param[in] i_deconfigure True if Target should be deconfigured + /// @param[in] i_gard True if Target should be GARDed + /// @param[in] i_priority The priority of any callout /// - struct ErrorInfoCDG - { - /// - /// @brief Constructor. - /// - /// @param[in] i_target Reference to the target to c/d/g - /// @param[in] i_callout True if Target should be called out - /// @param[in] i_deconfigure True if Target should be deconfigured - /// @param[in] i_gard True if Target should be GARDed - /// @param[in] i_priority The priority of any callout - /// - ErrorInfoCDG(const Target<TARGET_TYPE_ALL> & i_target, - const bool i_callout, - const bool i_deconfigure, - const bool i_gard, - const CalloutPriorities::CalloutPriority i_priority); + ErrorInfoCDG(const Target<TARGET_TYPE_ALL>& i_target, + const bool i_callout, + const bool i_deconfigure, + const bool i_gard, + const CalloutPriorities::CalloutPriority i_priority); #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // The target to callout/deconfigure/GARD - Target<TARGET_TYPE_ALL> iv_target; + // The target to callout/deconfigure/GARD + Target<TARGET_TYPE_ALL> iv_target; - // Callout Information - bool iv_callout; - CalloutPriorities::CalloutPriority iv_calloutPriority; + // Callout Information + bool iv_callout; + CalloutPriorities::CalloutPriority iv_calloutPriority; - // Deconfigure Information - bool iv_deconfigure; + // Deconfigure Information + bool iv_deconfigure; - // GARD Information - bool iv_gard; - }; + // GARD Information + bool iv_gard; +}; +/// +/// @struct ErrorInfoChildrenCDG +/// +/// This struct contains children targets to callout/deconfigure/GARD +/// +/// Children by containment can be CDG (chiplets belonging to a parent chip) +/// e.g. +/// - PROC_CHIP -> EX_CHIPLET +/// - MEMBUF_CHIP -> MBA_CHIPLET +/// Children by affinity can be CDG. +/// Any from PROC_CHIP->MCS_CHIPLET->MEMBUF_CHIP->MBA_CHIPLET->DIMM e.g. +/// - PROC_CHIP->MEMBUF_CHIP +/// - MEMBUF_CHIP->DIMM +/// - MBA_CHIPLET->DIMM +/// Port and Number criteria can be applied to the child target as +/// detailed in the constructor +/// +struct ErrorInfoChildrenCDG +{ /// - /// @struct ErrorInfoChildrenCDG + /// @brief Constructor. + /// + /// @param[in] i_parentChip Reference to the parent target + /// @param[in] i_childType Child target type to c/d/g + /// @param[in] i_callout True if Target should be called out + /// @param[in] i_deconfigure True if Target should be deconfigured + /// @param[in] i_gard True if Target should be GARDed + /// @param[in] i_priority The priority of any callout + /// @param[in] i_childPort Child Port + /// For DIMM children, the MBA port number + /// @param[in] i_childNum Child Number + /// For DIMM children, the dimm socket number + /// For Chip children, the chip position + /// For Chiplet children, the chiplet unit pos + /// + ErrorInfoChildrenCDG(const Target<TARGET_TYPE_ALL>& i_parentChip, + const TargetType i_childType, + const bool i_callout, + const bool i_deconfigure, + const bool i_gard, + const CalloutPriorities::CalloutPriority i_priority, + const uint8_t i_childPort, const uint8_t i_childNum); + +#ifdef FAPI_CUSTOM_MALLOC /// - /// This struct contains children targets to callout/deconfigure/GARD + /// @brief Overload new operator to use platform-specific allocator /// - /// Children by containment can be CDG (chiplets belonging to a parent chip) - /// e.g. - /// - PROC_CHIP -> EX_CHIPLET - /// - MEMBUF_CHIP -> MBA_CHIPLET - /// Children by affinity can be CDG. - /// Any from PROC_CHIP->MCS_CHIPLET->MEMBUF_CHIP->MBA_CHIPLET->DIMM e.g. - /// - PROC_CHIP->MEMBUF_CHIP - /// - MEMBUF_CHIP->DIMM - /// - MBA_CHIPLET->DIMM - /// Port and Number criteria can be applied to the child target as - /// detailed in the constructor + /// @param[in] i_sz Size of memory to allocate in bytes /// - struct ErrorInfoChildrenCDG - { - /// - /// @brief Constructor. - /// - /// @param[in] i_parent Reference to the parent target - /// @oaram[in] i_childType Child target type to c/d/g - /// @param[in] i_callout True if Target should be called out - /// @param[in] i_deconfigure True if Target should be deconfigured - /// @param[in] i_gard True if Target should be GARDed - /// @param[in] i_priority The priority of any callout - /// @param[in] i_childPort Child Port - /// For DIMM children, the MBA port number - /// @param[in] i_childNum Child Number - /// For DIMM children, the dimm socket number - /// For Chip children, the chip position - /// For Chiplet children, the chiplet unit pos - /// - ErrorInfoChildrenCDG(const Target<TARGET_TYPE_ALL> & i_parentChip, - const TargetType i_childType, - const bool i_callout, - const bool i_deconfigure, - const bool i_gard, - const CalloutPriorities::CalloutPriority i_priority, - const uint8_t i_childPort, const uint8_t i_childNum); - -#ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // The parent chip - Target<TARGET_TYPE_ALL> iv_parent; + // The parent chip + Target<TARGET_TYPE_ALL> iv_parent; - // The child target types to c/d/g - TargetType iv_childType; + // The child target types to c/d/g + TargetType iv_childType; - // Callout Information - bool iv_callout; - CalloutPriorities::CalloutPriority iv_calloutPriority; + // Callout Information + bool iv_callout; + CalloutPriorities::CalloutPriority iv_calloutPriority; - // Deconfigure Information - bool iv_deconfigure; + // Deconfigure Information + bool iv_deconfigure; - // GARD Information - bool iv_gard; + // GARD Information + bool iv_gard; - // Child Port - static const uint8_t ALL_CHILD_PORTS = 0xff; - uint8_t iv_childPort; + // Child Port + static const uint8_t ALL_CHILD_PORTS = 0xff; + uint8_t iv_childPort; - // Child Number - static const uint8_t ALL_CHILD_NUMBERS = 0xff; - uint8_t iv_childNumber; - }; + // Child Number + static const uint8_t ALL_CHILD_NUMBERS = 0xff; + uint8_t iv_childNumber; +}; +/// +/// @struct ErrorInfoCollectTrace +/// +/// This struct contains trace ID to add to the error log +/// +struct ErrorInfoCollectTrace +{ /// - /// @struct ErrorInfoCollectTrace + /// @brief Constructor. /// - /// This struct contains trace ID to add to the error log + /// @param[in] i_traceId /// - struct ErrorInfoCollectTrace - { - /// - /// @brief Constructor. - /// - /// @param[in] i_trace - /// - ErrorInfoCollectTrace(CollectTraces::CollectTrace i_traceId); + ErrorInfoCollectTrace(CollectTraces::CollectTrace i_traceId); #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // trace - CollectTraces::CollectTrace iv_eiTraceId; - }; + // trace + CollectTraces::CollectTrace iv_eiTraceId; +}; - /// - /// @struct ErrorInfo - /// - /// This struct defines the error information associated with a fapi2::ffdc - /// Users are allowed to access the data directly - /// - struct ErrorInfo - { +/// +/// @struct ErrorInfo +/// +/// This struct defines the error information associated with a fapi2::ffdc +/// Users are allowed to access the data directly +/// +struct ErrorInfo +{ #ifdef FAPI_CUSTOM_MALLOC - /// - /// @brief Overload new operator to use platform-specific allocator - /// - /// @param[in] i_sz Size of memory to allocate in bytes - /// - /// @return Pointer to allocated memory - /// - static void* operator new(size_t i_sz); + /// + /// @brief Overload new operator to use platform-specific allocator + /// + /// @param[in] i_sz Size of memory to allocate in bytes + /// + /// @return Pointer to allocated memory + /// + static void* operator new(size_t i_sz); - /// - /// @brief Overload delete operator to use platform-specific deallocator - /// - /// @param[in] i_ptr Pointer to memory previously allocated with new - /// - static void operator delete(void* i_ptr); + /// + /// @brief Overload delete operator to use platform-specific deallocator + /// + /// @param[in] i_ptr Pointer to memory previously allocated with new + /// + static void operator delete(void* i_ptr); #endif - // Vector of FFDC Data - std::vector<std::shared_ptr<ErrorInfoFfdc> > iv_ffdcs; + // Vector of FFDC Data + std::vector<std::shared_ptr<ErrorInfoFfdc> > iv_ffdcs; - // Vector of Hardware to callout - std::vector<std::shared_ptr<ErrorInfoHwCallout> > iv_hwCallouts; + // Vector of Hardware to callout + std::vector<std::shared_ptr<ErrorInfoHwCallout> > iv_hwCallouts; - // Vector of procedures to callout - std::vector<std::shared_ptr<ErrorInfoProcedureCallout> > - iv_procedureCallouts; + // Vector of procedures to callout + std::vector<std::shared_ptr<ErrorInfoProcedureCallout> > + iv_procedureCallouts; - // Vector of buses to callout - std::vector<std::shared_ptr<ErrorInfoBusCallout> > iv_busCallouts; + // Vector of buses to callout + std::vector<std::shared_ptr<ErrorInfoBusCallout> > iv_busCallouts; - // Vector of targets to callout/deconfigure/GARD - std::vector<std::shared_ptr<ErrorInfoCDG> > iv_CDGs; + // Vector of targets to callout/deconfigure/GARD + std::vector<std::shared_ptr<ErrorInfoCDG> > iv_CDGs; - // Vector of children targets to callout/deconfigure/GARD - std::vector<std::shared_ptr<ErrorInfoChildrenCDG> > iv_childrenCDGs; + // Vector of children targets to callout/deconfigure/GARD + std::vector<std::shared_ptr<ErrorInfoChildrenCDG> > iv_childrenCDGs; - // Vector of traces to collect - std::vector<std::shared_ptr<ErrorInfoCollectTrace> > iv_traces; - }; + // Vector of traces to collect + std::vector<std::shared_ptr<ErrorInfoCollectTrace> > iv_traces; +}; - /// - /// @brief Structure representing a single ErrorInfo entry. - /// - /// An array of these is passed to the addErrorInfo function when a HWP - /// generates an error by calling the FAPI_SET_HWP_ERROR macro - // Why aren't these inherited classes? Saves on allocation overhead. - // We create an array of ErrorInfoEntries as automatics when we start - // FFDC collection. If we did this as inherited classes it would either - // be allocating and deallocating or we'd need to allocate an array of - // the largest and map each struct in to it. That's messy to do without - // unions (that's what they're for) so we do it like this. The inherited - // model would result in a jump table anyway, so we're basically doing - // all of that by hand to avoid the mess. - // - struct ErrorInfoEntryFfdc - { - uint8_t iv_ffdcObjIndex; - uint16_t iv_ffdcSize; - uint32_t iv_ffdcId; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; - }; +/// +/// @brief Structure representing a single ErrorInfo entry. +/// +/// An array of these is passed to the addErrorInfo function when a HWP +/// generates an error by calling the FAPI_SET_HWP_ERROR macro +// Why aren't these inherited classes? Saves on allocation overhead. +// We create an array of ErrorInfoEntries as automatics when we start +// FFDC collection. If we did this as inherited classes it would either +// be allocating and deallocating or we'd need to allocate an array of +// the largest and map each struct in to it. That's messy to do without +// unions (that's what they're for) so we do it like this. The inherited +// model would result in a jump table anyway, so we're basically doing +// all of that by hand to avoid the mess. +// +struct ErrorInfoEntryFfdc +{ + uint8_t iv_ffdcObjIndex; + uint16_t iv_ffdcSize; + uint32_t iv_ffdcId; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; - /// - /// @brief Structure representing a hardware callout - /// - struct ErrorInfoEntryHwCallout - { - uint8_t iv_hw; - uint8_t iv_calloutPriority; - uint8_t iv_refObjIndex; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; - }; +/// +/// @brief Structure representing a hardware callout +/// +struct ErrorInfoEntryHwCallout +{ + uint8_t iv_hw; + uint8_t iv_calloutPriority; + uint8_t iv_refObjIndex; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; - /// - /// @brief Structure representing a procedure callout - /// - struct ErrorInfoEntryProcCallout - { - uint8_t iv_procedure; - uint8_t iv_calloutPriority; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; +/// +/// @brief Structure representing a procedure callout +/// +struct ErrorInfoEntryProcCallout +{ + uint8_t iv_procedure; + uint8_t iv_calloutPriority; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; - ErrorInfoEntryProcCallout(uint8_t i_procedure, uint8_t i_calloutPriority): - iv_procedure(i_procedure), - iv_calloutPriority(i_calloutPriority) - {} + ErrorInfoEntryProcCallout(uint8_t i_procedure, uint8_t i_calloutPriority): + iv_procedure(i_procedure), + iv_calloutPriority(i_calloutPriority) + {} - ErrorInfoEntryProcCallout(void) = default; - }; + ErrorInfoEntryProcCallout(void) = default; +}; - /// - /// @brief Structure representing a bus callout - /// - struct ErrorInfoEntryBusCallout - { - uint8_t iv_endpoint1ObjIndex; - uint8_t iv_endpoint2ObjIndex; - uint8_t iv_calloutPriority; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; - }; +/// +/// @brief Structure representing a bus callout +/// +struct ErrorInfoEntryBusCallout +{ + uint8_t iv_endpoint1ObjIndex; + uint8_t iv_endpoint2ObjIndex; + uint8_t iv_calloutPriority; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; - /// - /// @brief Structure representing a target callout - /// - struct ErrorInfoEntryTargetCDG - { - uint8_t iv_targetObjIndex; - uint8_t iv_callout; - uint8_t iv_deconfigure; - uint8_t iv_gard; - uint8_t iv_calloutPriority; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; - }; +/// +/// @brief Structure representing a target callout +/// +struct ErrorInfoEntryTargetCDG +{ + uint8_t iv_targetObjIndex; + uint8_t iv_callout; + uint8_t iv_deconfigure; + uint8_t iv_gard; + uint8_t iv_calloutPriority; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; - /// - /// @brief Structure representing a child callout - /// - struct ErrorInfoEntryChildrenCDG - { - uint8_t iv_parentObjIndex; - uint8_t iv_callout; - uint8_t iv_deconfigure; - uint32_t iv_childType; - uint8_t iv_childPort; - uint8_t iv_childNumber; - uint8_t iv_gard; - uint8_t iv_calloutPriority; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; - }; +/// +/// @brief Structure representing a child callout +/// +struct ErrorInfoEntryChildrenCDG +{ + uint8_t iv_parentObjIndex; + uint8_t iv_callout; + uint8_t iv_deconfigure; + uint32_t iv_childType; + uint8_t iv_childPort; + uint8_t iv_childNumber; + uint8_t iv_gard; + uint8_t iv_calloutPriority; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; - /// - /// @brief Structure representing collected trace information - /// - struct ErrorInfoEntryCollectTrace +/// +/// @brief Structure representing collected trace information +/// +struct ErrorInfoEntryCollectTrace +{ + uint32_t iv_eieTraceId; + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const; +}; + +/// +/// @brief Union of all the error info types +/// +struct ErrorInfoEntry +{ + uint8_t iv_type; // Value from ErrorInfoType + union { - uint32_t iv_eieTraceId; - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const; + ErrorInfoEntryFfdc ffdc; + ErrorInfoEntryHwCallout hw_callout; + ErrorInfoEntryProcCallout proc_callout; + ErrorInfoEntryBusCallout bus_callout; + ErrorInfoEntryTargetCDG target_cdg; + ErrorInfoEntryChildrenCDG children_cdg; + ErrorInfoEntryCollectTrace collect_trace; }; /// - /// @brief Union of all the error info types + /// @brief Add error information to the FFDC object + /// @param[in] i_info a shared pointer to the error info + /// @param[in] i_object the list of ffdc objects being collected /// - struct ErrorInfoEntry + void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, + const void* const* i_object) const { - uint8_t iv_type; // Value from ErrorInfoType - union + // "unhandled error info type"); + fapi2::Assert(iv_type < EI_LAST_TYPE); + + switch(iv_type) { - ErrorInfoEntryFfdc ffdc; - ErrorInfoEntryHwCallout hw_callout; - ErrorInfoEntryProcCallout proc_callout; - ErrorInfoEntryBusCallout bus_callout; - ErrorInfoEntryTargetCDG target_cdg; - ErrorInfoEntryChildrenCDG children_cdg; - ErrorInfoEntryCollectTrace collect_trace; + case EI_TYPE_FFDC: + ffdc.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_HW_CALLOUT: + hw_callout.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_PROCEDURE_CALLOUT: + proc_callout.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_BUS_CALLOUT: + bus_callout.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_CDG: + target_cdg.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_CHILDREN_CDG: + children_cdg.addErrorInfo(i_info, i_object); + break; + + case EI_TYPE_COLLECT_TRACE: + collect_trace.addErrorInfo(i_info, i_object); + break; }; - /// - /// @brief Add error information to the FFDC object - /// @param[in] i_info a shared pointer to the error info - /// @param[in] i_object the list of ffdc objects being collected - /// - void addErrorInfo(std::shared_ptr<ErrorInfo> i_info, - const void* const* i_object) const - { - // "unhandled error info type"); - fapi2::Assert(iv_type < EI_LAST_TYPE); - - switch(iv_type) - { - case EI_TYPE_FFDC: - ffdc.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_HW_CALLOUT: - hw_callout.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_PROCEDURE_CALLOUT: - proc_callout.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_BUS_CALLOUT: - bus_callout.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_CDG: - target_cdg.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_CHILDREN_CDG: - children_cdg.addErrorInfo(i_info, i_object); - break; - case EI_TYPE_COLLECT_TRACE: - collect_trace.addErrorInfo(i_info, i_object); - break; - }; - return; - } - }; + return; + } +}; } #endif // FAPI2_ERRORINFO_H_ diff --git a/src/import/hwpf/fapi2/include/error_info_defs.H b/src/import/hwpf/fapi2/include/error_info_defs.H index 443f64b92..1f2e57f6e 100644 --- a/src/import/hwpf/fapi2/include/error_info_defs.H +++ b/src/import/hwpf/fapi2/include/error_info_defs.H @@ -184,7 +184,7 @@ enum CalloutPriority } /// -/// @enum Collect Trace +/// @enum CollectTrace /// /// This enumeration defines the possible firmware traces to collect /// diff --git a/src/import/hwpf/fapi2/include/fapi2_attribute_service.H b/src/import/hwpf/fapi2/include/fapi2_attribute_service.H index 768af2f4b..2ed0203fe 100644 --- a/src/import/hwpf/fapi2/include/fapi2_attribute_service.H +++ b/src/import/hwpf/fapi2/include/fapi2_attribute_service.H @@ -17,7 +17,7 @@ /* */ /* IBM_PROLOG_END_TAG */ /// -/// @file src/include/usr/hwpf/fapi2/fapi2_attribute_service.H +/// @file fapi2_attribute_service.H /// /// @brief Defines the FAPI_ATTR_GET and FAPI_ATTR_SET macros that a user /// calls to get/set attributes and a check function that the macros use to @@ -100,7 +100,7 @@ namespace fapi2 /// If there are ever attributes with more than 4 dimensions then this function /// will need to be updated. /// -/// @Tparam K template parameter, passed in target. +/// @tparam K template parameter, passed in target. /// @param[in] i_id AttributeID /// @param[in] i_target Reference to fapi2::Target (can be NULL for system) /// @param[out] o_val Reference to uint64_t where attribute value is set diff --git a/src/import/hwpf/fapi2/include/fapi2_chip_ec_feature.H b/src/import/hwpf/fapi2/include/fapi2_chip_ec_feature.H index 856cb6a79..7402ec652 100644 --- a/src/import/hwpf/fapi2/include/fapi2_chip_ec_feature.H +++ b/src/import/hwpf/fapi2/include/fapi2_chip_ec_feature.H @@ -17,7 +17,7 @@ /* */ /* IBM_PROLOG_END_TAG */ /// -/// @file src/include/usr/hwpf/fapi2/fapi2_chip_ec_feature.H +/// @file fapi2_chip_ec_feature.H /// /// @brief Defines the queryChipEcFeature function that allows HWPs to /// query if a particular chip has a feature determined by its EC level. diff --git a/src/import/hwpf/fapi2/include/fapi2_error_scope.H b/src/import/hwpf/fapi2/include/fapi2_error_scope.H index 71f8c5a47..c78bb0518 100644 --- a/src/import/hwpf/fapi2/include/fapi2_error_scope.H +++ b/src/import/hwpf/fapi2/include/fapi2_error_scope.H @@ -47,8 +47,8 @@ /// /// @brief Wrapper to check an operation for an error state -/// and jump to the label cleam_up if there is an error. -/// @param[in] __operation__ an operation which returns a fapi::ReturnCode +/// and jump to the label clean_up if there is an error. +/// @param[in] \__operation__ an operation which returns a fapi::ReturnCode /// @param[in] ... vararg format/agruments for trace output (optional) /// @note This implementation does not support PIB error masks or /// FSP operational states. @@ -63,8 +63,8 @@ /// @brief Assert a conditional is true. /// If it is not, the FFDC gathering function is called and the /// trace is output as a FAPI error trace. -/// @param[in] __conditional__ the condition to assert -/// @param[in] __ffdc__ the FFDC gathering function +/// @param[in] \__conditional__ the condition to assert +/// @param[in] \__ffdc__ the FFDC gathering function /// @param[in] ... varargs, as input to FAPI_ERR /// #define FAPI_ASSERT( __conditional__, __ffdc__, ... ) PLAT_FAPI_ASSERT( __conditional__, __ffdc__, __VA_ARGS__ ) diff --git a/src/import/hwpf/fapi2/include/fapi2_hw_access.H b/src/import/hwpf/fapi2/include/fapi2_hw_access.H index fe310df7d..5b0f95351 100644 --- a/src/import/hwpf/fapi2/include/fapi2_hw_access.H +++ b/src/import/hwpf/fapi2/include/fapi2_hw_access.H @@ -250,9 +250,9 @@ fapi2::ReturnCode multiScom (const Target<K>& i_target, #ifndef __PPE__ /// @brief Reads a spy from a chip. /// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy whose data to be read. -/// @param[out] o_data Buffer that holds data read from HW target. +/// @param[in] TARGET Target to operate on. +/// @param[in] ID Id of the spy whose data to be read. +/// @param[out] DATA Buffer that holds data read from HW target. /// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. /// /// @note: The string version is only supported for cronus. @@ -308,9 +308,9 @@ inline ReturnCode getSpy(const Target<K>& i_target, /// @brief Writes a spy on a chip. /// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy to write data to. -/// @param[out] i_data Buffer that holds data to write into spy. +/// @param[in] TARGET Target to operate on. +/// @param[in] ID Id of the spy to write data to. +/// @param[out] DATA Buffer that holds data to write into spy. /// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. /// /// @note: The string version is only supported for cronus. @@ -374,11 +374,11 @@ inline ReturnCode putSpy(const Target<K>& i_target, /// This API is used by L2/L3 repair to put column repair data /// into a ring buffer image. /// @tparam K template parameter, passed in target. -/// @param[in] i_target Target to operate on. -/// @param[in] i_spyId Id of the spy. -/// @param[in] i_data Buffer that holds spy data to write into ring +/// @param[in] TARGET Target to operate on. +/// @param[in] ID Id of the spy. +/// @param[in] DATA1 Buffer that holds spy data to write into ring /// image. -/// @param[out] o_data Buffer that holds updated ring image. +/// @param[out] DATA2 Buffer that holds updated ring image. /// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. /// /// @note: The string version is only supported for cronus. @@ -416,11 +416,11 @@ inline ReturnCode putSpyImage(const Target<K>& i_target, #endif /// @brief Reads spy data from a ring image buffer -/// @param[in] i_target Target to operate on -/// @param[in] i_spyId The spy's id -/// @param[out] o_data Buffer that holds data read from ring image. -/// @param[in] i_imageData Buffer that holds ring image to read data -/// from. +/// @param[in] TARGET Target to operate on +/// @param[in] ID The spy's id +/// @param[out] DATA1 Buffer that holds data read from ring image. +/// @param[in] DATA2 Buffer that holds ring image to read data +/// from. /// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code. /// /// @note: The string version is only supported for cronus. diff --git a/src/import/hwpf/fapi2/include/fapi2_target.H b/src/import/hwpf/fapi2/include/fapi2_target.H index 86568b4ba..372757749 100644 --- a/src/import/hwpf/fapi2/include/fapi2_target.H +++ b/src/import/hwpf/fapi2/include/fapi2_target.H @@ -297,8 +297,8 @@ class Target /// /// @brief Given a normal core thread id, translate this to /// a fused core thread id. (normal to fused) -/// @param[in] the ordinal number of the normal core this thread belongs to -/// @param[in] a normal core thread id - 0, ..., 3 +/// @param[in] i_ordinal the ordinal number of the normal core this thread belongs to +/// @param[in] i_thread_id a normal core thread id - 0, ..., 3 /// @return the fused core thread id /// inline uint8_t thread_id_n2f(const uint8_t i_ordinal, const uint8_t i_thread_id) @@ -309,7 +309,7 @@ inline uint8_t thread_id_n2f(const uint8_t i_ordinal, const uint8_t i_thread_id) /// /// @brief Given a fused core thread id, translate this to /// a normal core thread id. (fused to normal) -/// @param[in] a fused core thread id - 0, ..., 7 +/// @param[in] i_thread_id a fused core thread id - 0, ..., 7 /// @return the normal core thread id /// inline uint8_t thread_id_f2n(const uint8_t i_thread_id) @@ -320,7 +320,7 @@ inline uint8_t thread_id_f2n(const uint8_t i_thread_id) /// /// @brief Given a normal core thread id, translate this to a /// normal core bitset. -/// @param[in] a normal core thread id - 0, ..., 3 +/// @param[in] i_thread_id a normal core thread id - 0, ..., 3 /// @return the normal core bitset /// @note to got from a fused core id to a normal core bitset, /// translate from a fused core thread id first. @@ -343,8 +343,8 @@ inline uint8_t thread_id2bitset(const uint8_t i_thread_id) /// /// @brief Given a bitset of normal core thread ids, translate this to /// a bit mask of fused core thread id. (normal to fused) -/// @param[in] the ordinal number of the normal core this thread belongs to -/// @param[in] a normal core thread bitset - b0000, ..., b1111 +/// @param[in] i_ordinal the ordinal number of the normal core this thread belongs to +/// @param[in] i_threads a normal core thread bitset - b0000, ..., b1111 /// @return the corresponding fused core bitset /// inline uint8_t thread_bitset_n2f(const uint8_t i_ordinal, const uint8_t i_threads) @@ -377,8 +377,8 @@ inline uint8_t thread_bitset_n2f(const uint8_t i_ordinal, const uint8_t i_thread /// /// @brief Given a fused core thread bitset, translate this to /// a normal core thread bitset. (fused to normal) -/// @param[in] the ordinal number of the normal core this thread belongs to -/// @param[in] a fused core thread bitset - b00000000, ..., b11111111 +/// @param[in] i_ordinal the ordinal number of the normal core this thread belongs to +/// @param[in] i_threads a fused core thread bitset - b00000000, ..., b11111111 /// @return the corresponding normal core bitset /// inline uint8_t thread_bitset_f2n(const uint8_t i_ordinal, const uint8_t i_threads) @@ -421,9 +421,9 @@ inline void toString(const Target<T>& i_target, char* i_buffer, size_t i_bsize); /// @brief Return the string interpretation of this target /// @tparam T The type of the target /// @tparam B The type of the buffer -/// @param[in] A pointer to the Target<T> +/// @param[in] i_target A pointer to the Target<T> /// @param[in] i_buffer buffer to write in to -/// @param[in] i_bsize size of the buffer +/// @param[in] i_bsize size of the buffer /// @return void /// @post The contents of the buffer is replaced with the string /// representation of the target diff --git a/src/import/hwpf/fapi2/include/utils.H b/src/import/hwpf/fapi2/include/utils.H index 28a70a06f..ee15b50db 100644 --- a/src/import/hwpf/fapi2/include/utils.H +++ b/src/import/hwpf/fapi2/include/utils.H @@ -45,7 +45,7 @@ namespace fapi2 /// @note Implemented by platform code /// void logError( - fapi2::ReturnCode & io_rc, + fapi2::ReturnCode& io_rc, fapi2::errlSeverity_t i_sev = fapi2::FAPI2_ERRL_SEV_UNRECOVERABLE, bool i_unitTestError = false ); @@ -83,7 +83,7 @@ ReturnCode delay(uint64_t i_nanoSeconds, uint64_t i_simCycles, /// /// @brief Assert a condition, and halt /// -/// @param[in] a boolean representing the assertion +/// @param[in] i_expression a boolean representing the assertion /// void Assert(bool i_expression); }; diff --git a/src/import/hwpf/fapi2/include/variable_buffer.H b/src/import/hwpf/fapi2/include/variable_buffer.H index f8700f663..f69b4e2fb 100644 --- a/src/import/hwpf/fapi2/include/variable_buffer.H +++ b/src/import/hwpf/fapi2/include/variable_buffer.H @@ -607,8 +607,8 @@ class variable_buffer /// /// @brief Shift a buffer left a defined number of bits, from a start bit - /// @param[in] number of bits to shift - /// @param[in] offset from 0 to start shift, defaults to ~0 (see operator<<()) + /// @param[in] i_shiftNum number of bits to shift + /// @param[in] i_offset offset from 0 to start shift, defaults to ~0 (see operator<<()) /// @note an offset of ~(0) implies "end of the buffer" /// @warning there is no shiftLeftandResize - resizing the buffer is left to /// the caller to alight the operations with integral buffers. @@ -618,8 +618,8 @@ class variable_buffer /// /// @brief Shift a buffer right a defined number of bits, from a start bit - /// @param[in] number of bits to shift - /// @param[in] offset from 0 to start shift, defaults to 0 (see operator>>()) + /// @param[in] i_shiftNum number of bits to shift + /// @param[in] i_offset offset from 0 to start shift, defaults to 0 (see operator>>()) /// @warning there is no shiftRightandResize - resizing the buffer is left to /// the caller to alight the operations with integral buffers. /// @return FAPI2_RC_SUCCESS on success @@ -682,7 +682,7 @@ class variable_buffer /// /// @brief operator+() - /// @param[in] A variable_buffer to append to this + /// @param[in] rhs A variable_buffer to append to this /// inline variable_buffer& operator+(const variable_buffer& rhs) { @@ -693,7 +693,7 @@ class variable_buffer /// /// @brief operator+() - /// @param[in] A number of bits to add to this buffer + /// @param[in] rhs A number of bits to add to this buffer /// inline variable_buffer& operator+(const bits_type& rhs) { @@ -708,7 +708,7 @@ class variable_buffer /// /// @brief resize() - /// @param[in] Desired resulting size of the buffer, in bits + /// @param[in] rhs Desired resulting size of the buffer, in bits /// inline variable_buffer& resize(const bits_type& rhs) { |
