/***********************************************************************
 *
 *  Copyright (c) 2020  Broadcom Ltd
 *  All Rights Reserved
 *
<:label-BRCM:2020:DUAL/GPL:standard

Unless you and Broadcom execute a separate written software license
agreement governing use of this software, this software is licensed
to you under the terms of the GNU General Public License version 2
(the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php,
with the following added to such license:

   As a special exception, the copyright holders of this software give
   you permission to link this software with independent modules, and
   to copy and distribute the resulting executable under terms of your
   choice, provided that you also meet, for each linked independent
   module, the terms and conditions of the license of that module.
   An independent module is a module which is not derived from this
   software.  The special exception does not apply to any modifications
   of the software.

Not withstanding the above, under no circumstances may you combine
this software in any way with any other Broadcom software provided
under a license other than the GPL, without Broadcom's express prior
written consent.

:>
 *
 ************************************************************************/


#ifndef __BCM_GENERIC_HAL_UTILS_H__
#define __BCM_GENERIC_HAL_UTILS_H__

/*!\file bcm_generic_hal_utils.h
 * \brief Utility functions associated with the BCM Generic HAL.  These
 *        are so useful that some code which do not use the Generic HAL
 *        will still want to use these functions.
 *
 */

#include "number_defs.h"
#include "bcm_generic_hal_defs.h"


/** Free an array of BcmGenericParamInfo.
 *
 *  The array and its internal pointers are allocated with cmsMem_alloc,
 *  so it is important that code use this function to free instead of trying
 *  to free with the standard libc free.  This function will also null out
 *  the pointer to the array to prevent accidental use after free.
 *
 *  @param address of the array pointer.
 *  @param number of elements in the array.
 */
void cmsUtl_freeParamInfoArray(BcmGenericParamInfo  **paramInfoArray,
                               UINT32                 numParamInfos);


/** Free an array of BcmGenericParamAttr.
 *  Same comments as cmsUtl_freeParamInfos.
 */
void cmsUtl_freeParamAttrArray(BcmGenericParamAttr  **paramAttrArray,
                               UINT32                 numParamAttrs);


/** Free all strings in the array, and then free the array itself.
 *  Set the pointer to NULL (that is why ***).  Note that the array and the
 *  string buffers are allocated with cmsMem_alloc, so it is important that
 *  code use this function to free instead of trying to free with the standard
 *  libc free.
 */
void cmsUtl_freeArrayOfStrings(char ***array, UINT32 len);


#endif /* __BCM_GENERIC_HAL_UTILS__ */