/* BEGIN_ICS_COPYRIGHT7 ****************************************

Copyright (c) 2015-2017, Intel Corporation

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 Intel Corporation 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.

** END_ICS_COPYRIGHT7   ****************************************/

/* [ICS VERSION STRING: unknown] */

#include "pm_topology.h"

// These functions are all oriented toward PortImage.  We could alternatively
// supply a PmPort_t and a imageIndex.  Right now the implementation of
// these routines does not need imageIndex (a couple ASSERTs could benefit
// from it).

// adds a port to a group. used by PmAddExtPort and PmAddIntPort
void PmAddPortToGroupIndex(PmPortImage_t * portImage, uint32 grpIndex,
			   					PmGroup_t *groupp, boolean internal)
{
	portImage->Groups[grpIndex] = groupp;
	if (internal)
		portImage->InternalBitMask |= (1<<grpIndex);
#if PM_COMPRESS_GROUPS
	portImage->numGroups++;
#endif
}

// removes a port from a group. used by other higher level routines
void PmRemovePortFromGroupIndex(PmPortImage_t *portImage, uint32 grpIndex,
			   						PmGroup_t *groupp, uint8 compress)
{
	if (PM_COMPRESS_GROUPS && compress) {
		// compress rest of list
		uint8 temp = (portImage->InternalBitMask & (0xff<<(grpIndex+1))) >> 1;
		portImage->InternalBitMask &= ~(0xff<<grpIndex);
		portImage->InternalBitMask |= (uint32)temp;
#if PM_COMPRESS_GROUPS
		for (; grpIndex<portImage->numGroups-1; grpIndex++) {
#else
		for (; grpIndex<PM_MAX_GROUPS_PER_PORT-1; grpIndex++) {
#endif
			portImage->Groups[grpIndex] = portImage->Groups[grpIndex+1];
		}
		portImage->Groups[grpIndex] = NULL;
#if PM_COMPRESS_GROUPS
		portImage->numGroups--;
#endif
	} else {
		portImage->Groups[grpIndex] = NULL;
		portImage->InternalBitMask &= ~(1<<grpIndex);
#if PM_COMPRESS_GROUPS
		portImage->numGroups--;
#endif
	}
}

static boolean PmIsPortImageInGroup(PmPortImage_t *portImage, PmGroup_t *groupp, boolean *isInternal)
{
    uint32 i;
    boolean isInGroup = FALSE;
#if PM_COMPRESS_GROUPS
    for (i = 0; i < portImage->numGroups; i++) {
#else
    for (i = 0; i < PM_MAX_GROUPS_PER_PORT; i++) {
#endif
        if (portImage->Groups[i] == groupp) {
            isInGroup = TRUE;
            break;
        }
    }
    if (isInternal && isInGroup) {
        *isInternal = (boolean)(portImage->InternalBitMask & (1<<i));
    }
    return isInGroup;
}

boolean PmIsPortInGroup(Pm_t *pm, PmPort_t *pmportp, PmPortImage_t *portImage,
    PmGroup_t *groupp, boolean sth, boolean *isInternal)
{
    // for non-Switch ports and switch port 0, active will be true
    // but for other switch ports could be not active
    // ports without a PMA are not tabulated
    if (!portImage->u.s.active)
        return FALSE;
    if (!sth) {
	if(isInternal)	{
		*isInternal = (groupp == pm->AllPorts);
	}
        return ((groupp == pm->AllPorts)
            || PmIsPortImageInGroup(portImage, groupp, isInternal));
    } else {
	if(isInternal)	{
		*isInternal = (groupp == pm->ShortTermHistory.LoadedImage.AllGroup);
	}
        return ((groupp == pm->ShortTermHistory.LoadedImage.AllGroup)
            || PmIsPortImageInGroup(portImage, groupp, isInternal));
    }
}

// adds a port to a group where the neighbor of the port WILL NOT be in
// the given group
void PmAddExtPortToGroupIndex(PmPortImage_t *portImage, uint32 grpIndex,
			   						PmGroup_t *groupp, uint32 imageIndex)
{
	PmAddPortToGroupIndex(portImage, grpIndex, groupp, FALSE);
	groupp->Image[imageIndex].NumExtPorts++;
}

// removes a port from a group. used by other higher level routines
void PmRemoveExtPortFromGroupIndex(PmPortImage_t *portImage, uint32 grpIndex,
			   						PmGroup_t *groupp, uint32 imageIndex,
									uint8 compress)
{
	PmRemovePortFromGroupIndex(portImage, grpIndex, groupp, compress);
	groupp->Image[imageIndex].NumExtPorts--;
}


// adds a port to a group where the neighbor of the port WILL be in
// the given group
// This DOES NOT add the neighbor.  Caller must do that separately.
void PmAddIntPortToGroupIndex(PmPortImage_t *portImage, uint32 grpIndex,
			   						PmGroup_t *groupp, uint32 imageIndex)
{
	PmAddPortToGroupIndex(portImage, grpIndex, groupp, TRUE);
	groupp->Image[imageIndex].NumIntPorts++;
}


// removes a port from a group. used by other higher level routines
void PmRemoveIntPortFromGroupIndex(PmPortImage_t *portImage, uint32 grpIndex,
			   							PmGroup_t *groupp, uint32 imageIndex,
										uint8 compress)
{
	PmRemovePortFromGroupIndex(portImage, grpIndex, groupp, compress);
	groupp->Image[imageIndex].NumIntPorts--;
}


#if 0 // not yet used
// adds both sides of a link to a group
// This also adds the neighbor (note SW Port 0 has no neighbor).
FSTATUS PmAddLinkToGroup(PmPortImage_t *portImage, PmPortImage_t *portImage2,
								PmGroup_t *groupp, uint32 imageIndex)
{
	FSTATUS status;

	status = PmAddIntPortToGroup(portImage, groupp, imageIndex);
	if (FSUCCESS != status)
		return status;
	if (portImage2) {
		status = PmAddIntPortToGroup(portImage2, groupp, imageIndex);
		if (FSUCCESS != status) {
			(void)PmRemovePortFromGroup(portImage, groupp, 0);	// no compress, at end
			return status;
		}
		groupp->Image[imageIndex].NumIntPorts++;
	}
	groupp->Image[imageIndex].NumIntPorts++;
	return status;
}

// removes both sides of a link from a group
// This also removes the neighbor (note SW Port 0 has no neighbor).
FSTATUS PmRemoveLinkFromGroup(PmPortImage_t *portImage,
			   	PmPortImage_t *portImage2, PmGroup_t *groupp, uint32 imageIndex)
{
	FSTATUS status;

	status = PmRemovePortFromGroup(portImage, groupp, PM_COMPRESS_GROUPS);
	if (FSUCCESS != status)
		return status;
	if (portImage2) {
		status = PmRemovePortFromGroup(portImage2, groupp, PM_COMPRESS_GROUPS);
		if (FSUCCESS != status) {
			(void)PmAddPortToGroup(portImage, groupp, TRUE);
			return status;
		}
		groupp->Image[imageIndex].NumIntPorts--;
	}
	groupp->Image[imageIndex].NumIntPorts--;
	return status;
}
#endif // not yet used
