path: root/lib/avtp_pipeline/aem/openavb_aem.c

/*************************************************************************************************************
Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
Copyright (c) 2016-2017, Harman International Industries, Incorporated
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. 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.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "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 LISTED 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.

Attributions: The inih library portion of the source code is licensed from
Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt.
Complete license and copyright information can be found at
https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
*************************************************************************************************************/

/*
 ******************************************************************
 * MODULE : AEM - AVDECC Entity Model
 * MODULE SUMMARY : Implements the 1722.1 (AVDECC) Entity Model
 ******************************************************************
 */

#include "stdlib.h"

#define	AVB_LOG_COMPONENT	"AEM"
#include "openavb_log.h"

#include "openavb_avdecc.h"
#include "openavb_aem.h"

MUTEX_HANDLE(openavbAemMutex);
#define AEM_LOCK() { MUTEX_CREATE_ERR(); MUTEX_LOCK(openavbAemMutex); MUTEX_LOG_ERR("Mutex lock failure"); }
#define AEM_UNLOCK() { MUTEX_CREATE_ERR(); MUTEX_UNLOCK(openavbAemMutex); MUTEX_LOG_ERR("Mutex unlock failure"); }

static openavb_avdecc_entity_model_t *pAemEntityModel = NULL;

////////////////////////////////
// Private (internal) functions
////////////////////////////////
openavbRC openavbAemCreate(openavb_aem_descriptor_entity_t *pDescriptorEntity)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	MUTEX_ATTR_HANDLE(mta);
	MUTEX_ATTR_INIT(mta);
	MUTEX_ATTR_SET_TYPE(mta, MUTEX_ATTR_TYPE_DEFAULT);
	MUTEX_ATTR_SET_NAME(mta, "openavbAemMutex");
	MUTEX_CREATE_ERR();
	MUTEX_CREATE(openavbAemMutex, mta);
	MUTEX_LOG_ERR("Could not create/initialize 'openavbAemMutex' mutex");

	if (!pDescriptorEntity) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_ENTITY_MODEL_MISSING), AVB_TRACE_AEM);
	}

	if (!pAemEntityModel) {
		pAemEntityModel = calloc(1, sizeof(*pAemEntityModel));
	}

	if (!pAemEntityModel) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_OUT_OF_MEMORY), AVB_TRACE_AEM);
	}

	pAemEntityModel->pDescriptorEntity = pDescriptorEntity;
	pAemEntityModel->aemConfigurations = openavbArrayNewArray(sizeof(openavb_aem_configuration_t));
	memset(pAemEntityModel->aemNonTopLevelDescriptorsArray, 0, sizeof(pAemEntityModel->aemNonTopLevelDescriptorsArray));

	AVB_RC_TRACE_RET(OPENAVB_AVDECC_SUCCESS, AVB_TRACE_AEM);
}

openavbRC openavbAemDestroy()
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	// AVDECC_TODO all deallocations will occur here

	AVB_RC_TRACE_RET(OPENAVB_AVDECC_SUCCESS, AVB_TRACE_AEM);
}

bool openavbAemCheckModel(bool bLog)
{
	if (!pAemEntityModel || !pAemEntityModel->pDescriptorEntity) {
		if (bLog) {
			AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_ENTITY_MODEL_MISSING);
		}
		return FALSE;
	}
	return TRUE;
}

openavbRC openavbAemAddDescriptorToConfiguration(U16 descriptorType, U16 configIdx)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	int i1;

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(FALSE)) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_ENTITY_MODEL_MISSING), AVB_TRACE_AEM);
	}

	if (configIdx == OPENAVB_AEM_DESCRIPTOR_INVALID) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_INVALID_CONFIG_IDX), AVB_TRACE_AEM);
	}
	openavb_aem_configuration_t *pConfiguration = openavbArrayDataIdx(pAemEntityModel->aemConfigurations, configIdx);
	if (!pConfiguration) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_INVALID_CONFIG_IDX), AVB_TRACE_AEM);
	}

	openavb_aem_descriptor_configuration_t *pConfig = pConfiguration->pDescriptorConfiguration;
	if (!pConfig) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_INVALID_CONFIG_IDX), AVB_TRACE_AEM);
	}

	// Check if the new descriptor type is in the configuration array
	for (i1 = 0; i1 < pConfig->descriptor_counts_count; i1++) {
		if (pConfig->descriptor_counts[i1].descriptor_type == descriptorType) {
			// Found this descriptor type so just increase the count.
			pConfig->descriptor_counts[i1].count++; 
			AVB_RC_TRACE_RET(OPENAVB_AVDECC_SUCCESS, AVB_TRACE_AEM);
		}
	}

	// Update counts
	pConfig->descriptor_counts[pConfig->descriptor_counts_count].descriptor_type = descriptorType;
	pConfig->descriptor_counts[pConfig->descriptor_counts_count].count++; 
	pConfig->descriptor_counts_count++;

	AVB_RC_TRACE_RET(OPENAVB_AVDECC_SUCCESS, AVB_TRACE_AEM);
}

openavb_avdecc_entity_model_t *openavbAemGetModel()
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return pAemEntityModel;
}

openavb_array_t openavbAemGetDescriptorArray(U16 configIdx, U16 descriptorType)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	openavb_array_t retDescriptors = NULL;

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(TRUE)) {
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return NULL;
	}

	if (descriptorType == OPENAVB_AEM_DESCRIPTOR_ENTITY) {
		// There is always only a single Entity Descriptor and therefore there isn't an array. NULL will be returned.
	}
	else if (descriptorType == OPENAVB_AEM_DESCRIPTOR_CONFIGURATION) {
		// The configuration descriptor is a special descriptor and not return by this function. NULL will be returned.
	}
	else {
		if (configIdx != OPENAVB_AEM_DESCRIPTOR_INVALID) {
			openavb_aem_configuration_t *pConfig = openavbArrayDataIdx(pAemEntityModel->aemConfigurations, configIdx);
			if (pConfig) {
				retDescriptors = pConfig->descriptorsArray[descriptorType];
			}
		}

		// Search the alternate location for non-top-level descriptors.
		if (!retDescriptors) {
			retDescriptors = pAemEntityModel->aemNonTopLevelDescriptorsArray[descriptorType];
		}
	}

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return retDescriptors;
}

void *openavbAemFindDescriptor(U16 configIdx, U16 descriptorType, U16 descriptorIdx)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	void *retDescriptor = NULL;

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(TRUE)) {
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return NULL;
	}

	if (descriptorType == OPENAVB_AEM_DESCRIPTOR_ENTITY) {
		if (pAemEntityModel->pDescriptorEntity &&
				pAemEntityModel->pDescriptorEntity->descriptor_index == descriptorIdx) {
			retDescriptor = pAemEntityModel->pDescriptorEntity;
		}
	}
	else if (descriptorType == OPENAVB_AEM_DESCRIPTOR_CONFIGURATION) {
		if (configIdx != OPENAVB_AEM_DESCRIPTOR_INVALID) {
			openavb_aem_configuration_t *pConfig = openavbArrayDataIdx(pAemEntityModel->aemConfigurations, configIdx);
			if (pConfig &&
					pConfig->pDescriptorConfiguration &&
					pConfig->pDescriptorConfiguration->descriptor_index == descriptorIdx) {
				retDescriptor = pConfig->pDescriptorConfiguration;
			}
		}
	}
	else {
		openavb_array_t descriptors = NULL;
		if (configIdx != OPENAVB_AEM_DESCRIPTOR_INVALID) {
			openavb_aem_configuration_t *pConfig = openavbArrayDataIdx(pAemEntityModel->aemConfigurations, configIdx);
			if (pConfig) {
				descriptors = pConfig->descriptorsArray[descriptorType];
				if (descriptors) {
					retDescriptor = openavbArrayDataIdx(descriptors, descriptorIdx);
				}
			}
		}

		// Search the alternate location for non-top-level descriptors.
		if (!retDescriptor) {
			descriptors = pAemEntityModel->aemNonTopLevelDescriptorsArray[descriptorType];
			if (descriptors) {
				retDescriptor = openavbArrayDataIdx(descriptors, descriptorIdx);
			}
		}
	}

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return retDescriptor;
}

openavbRC openavbAemSerializeDescriptor(U16 configIdx, U16 descriptorType, U16 descriptorIdx, U16 bufSize, U8 *pBuf, U16 *descriptorSize)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(FALSE)) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_ENTITY_MODEL_MISSING), AVB_TRACE_AEM);
	}

	if (!pBuf || !descriptorSize) {
		AVB_RC_LOG_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_INVALID_ARGUMENT), AVB_TRACE_AEM);
	}

	*descriptorSize = 0;

	void *pDescriptor = openavbAemFindDescriptor(configIdx, descriptorType, descriptorIdx);
	if (pDescriptor) {
		openavb_aem_descriptor_common_t *pDescriptorCommon = pDescriptor;
		if (IS_OPENAVB_FAILURE(pDescriptorCommon->descriptorPvtPtr->update(pDescriptor))) {
			AVB_RC_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_STALE_DATA), AVB_TRACE_AEM);
		}
		if (IS_OPENAVB_FAILURE(pDescriptorCommon->descriptorPvtPtr->toBuf(pDescriptor, bufSize, pBuf, descriptorSize))) {
			AVB_RC_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_GENERIC), AVB_TRACE_AEM);
		}
		AVB_RC_TRACE_RET(OPENAVB_AVDECC_SUCCESS, AVB_TRACE_AEM);
	}

	AVB_RC_TRACE_RET(AVB_RC(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_UNKNOWN_DESCRIPTOR), AVB_TRACE_AEM);
}

bool openavbAemAddDescriptorConfiguration(openavb_aem_descriptor_configuration_t *pDescriptor, U16 *pResultIdx)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(TRUE)) {
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}

	if (!pDescriptor || !pResultIdx) {
		AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_INVALID_ARGUMENT);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}

	// Allocate the new configuration structure
	openavb_aem_configuration_t *pAemConfiguration = openavbArrayDataNew(pAemEntityModel->aemConfigurations);
	if (!pAemConfiguration) {
		AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_OUT_OF_MEMORY);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}

	// Assign the descriptor to the new configuration
	pAemConfiguration->pDescriptorConfiguration = pDescriptor;

	// Set to return descriptor index and increment the count
	S32 retIdx = openavbArrayFindData(pAemEntityModel->aemConfigurations, pAemConfiguration);
	if (retIdx  < 0) {
		return FALSE;
	}
	*pResultIdx = retIdx;

	pAemEntityModel->pDescriptorEntity->configurations_count++;

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return TRUE;
}

////////////////////////////////
// Public functions
////////////////////////////////
extern DLL_EXPORT U16 openavbAemGetConfigIdx()
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	// This function does NOT check for errors but at a minimum avoid a crash.
	if (!pAemEntityModel || !pAemEntityModel->pDescriptorEntity) {
		AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVBAVDECC_RC_ENTITY_MODEL_MISSING);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return 0;
	}
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return pAemEntityModel->pDescriptorEntity->current_configuration;
}


extern DLL_EXPORT bool openavbAemAddDescriptor(void *pDescriptor, U16 configIdx, U16 *pResultIdx)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	// Make sure Entity Model is created
	if (!openavbAemCheckModel(TRUE)) {
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}

	if (!pDescriptor || !pResultIdx) {
		AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_INVALID_ARGUMENT);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}

	openavb_aem_descriptor_common_t *pDescriptorCommon = pDescriptor;

	if (pDescriptorCommon->descriptor_type == OPENAVB_AEM_DESCRIPTOR_ENTITY) {
		// Entity Descriptors aren't handled in this function.
		AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_INVALID_ARGUMENT);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return FALSE;
	}
	if (pDescriptorCommon->descriptor_type == OPENAVB_AEM_DESCRIPTOR_CONFIGURATION) {
		// Configuration descriptors have special processing
		bool result = openavbAemAddDescriptorConfiguration(pDescriptor, pResultIdx);
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return result;
	}

	openavb_array_t descriptors = NULL;
	if (pDescriptorCommon->descriptorPvtPtr->bTopLevel) {
		openavb_aem_configuration_t *pConfig = openavbArrayDataIdx(pAemEntityModel->aemConfigurations, configIdx);
		if (!pConfig) {
			AVB_RC_LOG(OPENAVB_AVDECC_FAILURE | OPENAVB_RC_INVALID_ARGUMENT);
			AVB_LOGF_ERROR("Invalid configuration index %u", configIdx);
			AVB_TRACE_EXIT(AVB_TRACE_AEM);
			return FALSE;
		}
		descriptors = pConfig->descriptorsArray[pDescriptorCommon->descriptor_type];

		if (!descriptors) {
			// Create array for this type of descriptor in this configuration
			AVB_LOGF_DEBUG("Created description array for configuration %u, type 0x%04x", configIdx, pDescriptorCommon->descriptor_type);
			descriptors = openavbArrayNewArray(pDescriptorCommon->descriptorPvtPtr->size);
			pConfig->descriptorsArray[pDescriptorCommon->descriptor_type] = descriptors;
		}
	} else {
		descriptors = pAemEntityModel->aemNonTopLevelDescriptorsArray[pDescriptorCommon->descriptor_type];

		if (!descriptors) {
			// Create array for this type of descriptor in this configuration
			AVB_LOGF_DEBUG("Created non-top-level description array for type 0x%04x", pDescriptorCommon->descriptor_type);
			descriptors = openavbArrayNewArray(pDescriptorCommon->descriptorPvtPtr->size);
			pAemEntityModel->aemNonTopLevelDescriptorsArray[pDescriptorCommon->descriptor_type] = descriptors;
		}
	}

	if (descriptors) {
		if (openavbArrayFindData(descriptors, pDescriptor) >= 0) {
			AVB_LOGF_ERROR("Attempted to add same descriptor (type 0x%04x) twice", pDescriptorCommon->descriptor_type);
			AVB_TRACE_EXIT(AVB_TRACE_AEM);
			return FALSE;
		}

		openavb_array_elem_t elem = openavbArrayAdd(descriptors, pDescriptor);
		if (elem) {
			*pResultIdx = openavbArrayGetIdx(elem);
			pDescriptorCommon->descriptor_index = *pResultIdx;
			if (pDescriptorCommon->descriptorPvtPtr->bTopLevel) {
				if (!IS_OPENAVB_SUCCESS(openavbAemAddDescriptorToConfiguration(pDescriptorCommon->descriptor_type, configIdx))) {
					AVB_TRACE_EXIT(AVB_TRACE_AEM);
					return FALSE;
				}
			}
			AVB_TRACE_EXIT(AVB_TRACE_AEM);
			return TRUE;
		}
	}

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return FALSE;
}

extern DLL_EXPORT void *openavbAemGetDescriptor(U16 configIdx, U16 descriptorType, U16 descriptorIdx)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	void *retDescriptor = NULL;

	retDescriptor = openavbAemFindDescriptor(configIdx, descriptorType, descriptorIdx);

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return retDescriptor;
}

extern DLL_EXPORT U16 openavbAemGetDescriptorIndex(U16 configIdx, const void *pDescriptor)
{
	const openavb_aem_descriptor_common_t *pDescriptorCommon = pDescriptor;
	U16 descriptorIdx = 0;
	void * pTest;

	if (!pDescriptorCommon) { return OPENAVB_AEM_DESCRIPTOR_INVALID; }

	do {
		pTest = openavbAemFindDescriptor(configIdx, pDescriptorCommon->descriptor_type, descriptorIdx);
		if (pTest == pDescriptor) { return descriptorIdx; }
		descriptorIdx++;
	} while (pTest != NULL);

	return OPENAVB_AEM_DESCRIPTOR_INVALID;
}

extern DLL_EXPORT bool openavbAemSetString(U8 *pMem, const char *pString)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);

	if (pMem && pString) {
		U32 len = strlen(pString);
		if (len > OPENAVB_AEM_STRLEN_MAX) {
			len = OPENAVB_AEM_STRLEN_MAX;
		} else if (len < OPENAVB_AEM_STRLEN_MAX) {
			memset(pMem + len, 0, OPENAVB_AEM_STRLEN_MAX - len);
		}
		memcpy(pMem, pString, len);		// Per 1722.1 it is allowable that the AEM string may not be null terminated.
		AVB_TRACE_EXIT(AVB_TRACE_AEM);
		return TRUE;
	}

	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return FALSE;
}

extern DLL_EXPORT bool openavbAemIsAcquired()
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	AEM_LOCK();
	bool bResult = pAemEntityModel->entityAcquired;
	AEM_UNLOCK();
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return bResult;
}

extern DLL_EXPORT bool openavbAemIsLocked()
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	AEM_LOCK();
	bool bResult = pAemEntityModel->entityLocked;
	AEM_UNLOCK();
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return bResult;
}

extern DLL_EXPORT bool openavbAemAcquire(bool flag)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	AEM_LOCK();
	bool bResult = FALSE;
	if (flag) {
		if (!pAemEntityModel->entityAcquired) {
			*(pAemEntityModel->acquiredControllerId) = (U64)0x0000000000000000L;
			pAemEntityModel->entityAcquired = TRUE;
			bResult = TRUE;
		}
	}
	else {
		if (pAemEntityModel->entityAcquired) {
			if ((U64)*pAemEntityModel->acquiredControllerId == 0x0000000000000000L) {
				// Only unacquire if controller ID is zero. 
				pAemEntityModel->entityAcquired = FALSE;
				bResult = TRUE;
			}
		}
	}
	AEM_UNLOCK();
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return bResult;
}

extern DLL_EXPORT bool openavbAemLock(bool flag)
{
	AVB_TRACE_ENTRY(AVB_TRACE_AEM);
	AEM_LOCK();
	bool bResult = FALSE;
	if (flag) {
		if (!pAemEntityModel->entityLocked) {
			*(pAemEntityModel->lockedControllerId) = (U64)0x0000000000000000L;
			pAemEntityModel->entityLocked = TRUE;
			bResult = TRUE;
		}
	}
	else {
		if (pAemEntityModel->entityLocked) {
			if ((U64)*pAemEntityModel->lockedControllerId == 0x0000000000000000L) {
				// Only unlock if controller ID is zero. 
				pAemEntityModel->entityLocked = FALSE;
				bResult = TRUE;
			}
		}
	}
	AEM_UNLOCK();
	AVB_TRACE_EXIT(AVB_TRACE_AEM);
	return bResult;
}